接続の確立

SAP Ariba への接続を追加

SAP Ariba への接続を追加するには：

アプリケーションコンソールで、接続ページに移動します。
接続の追加パネルで、追加したい接続のアイコンを選択します。
SAP Ariba アイコンが利用できない場合は、Add More アイコンをクリックしてCData サイトからSAP Ariba コネクタをダウンロードおよびインストールします。

必須プロパティについては、設定タブを参照してください。

通常必須ではない接続プロパティについては、高度な設定タブを参照してください。

SAP Ariba への接続

接続するには以下を設定します。

API：Sync App にSAP Ariba データを取得させたいAPI を指定。ビジネスロールに基づき、Supplier、Sourcing Project Management、またはContract API を選択します。
DataCenter：アカウントのデータがホストされているデータセンター。
Realm：アクセスしたいサイト名。
Environment：テスト環境、サンドボックス環境、本番環境のどれに接続するかを指定。

Supplier Data API またはContract API に接続する場合は、さらに以下を設定します。

User：API 呼び出しを行うユーザーのId。
PasswordAdapter：認証するUser に関連付けられたパスワード。

最後に、Supplier API に接続している場合は、ProjectId をデータを取得したいソーシングプロジェクトのId に設定します。

SAP Ariba への認証

SAP Ariba API への認証はOAuth 経由で行われます。SAP Ariba のOAuth フローは、ユーザーインタラクションを必要としません。

OAuthClient

AuthScheme をOAuthClient に設定します。

サービスにアプリケーションを登録し、APIKey、OAuthClientId、およびOAuthClientSecret を取得する必要があります。

アプリケーションの作成については、カスタムOAuth アプリの作成を参照してください。

InitiateOAuth のデフォルトは、OAuthClient 認証スキームのGETANDREFRESH です。

OAuth の自動リフレッシュ

OAuth アクセストークンの取得およびリフレッシュ

以下を設定して、接続してください。

APIKey：アプリケーション設定のApplication key。
OAuthClientId：アプリケーション設定のOAuth Client Id。
OAuthClientSecret：アプリケーション設定のOAuth Secret。

接続すると、Sync App は自動でOAuth プロセスを完了します。

Sync App はSAP Ariba からアクセストークンを取得し、それを使ってデータをリクエストします。
Sync App はアクセストークンの期限が切れると自動的にリフレッシュします。
OAuth 値はOAuthSettingsLocation で指定された場所に基づいてメモリに保存されます。

OAuth の手動リフレッシュ

OAuth アクセストークンの取得

次の接続プロパティを設定し、OAuthAccessToken を取得します。

APIKey：アプリケーション設定のApplication key。
OAuthClientId：アプリケーション設定のOAuth Client Id。
OAuthClientSecret：アプリケーション設定のOAuth Secret。

次に、GetOAuthAccessToken ストアドプロシージャを呼び出します。GrantType インプットをclient_credentials またはopenapi_2lo（レガシーユーザーで利用可能）に設定します。指定されていない場合、GrantType のデフォルトはclient_credentials になります。

アクセストークンとリフレッシュトークンを取得した後、データに接続し、OAuth アクセストークンを自動または手動でリフレッシュすることが可能です。

OAuth アクセストークンの自動リフレッシュ

Sync App がOAuth アクセストークンを自動的にリフレッシュするようにするには、最初のデータ接続で次のように設定します。

InitiateOAuth：REFRESH。
APIKey：アプリケーション設定のApplication key。
OAuthClientId：アプリケーション設定のOAuth Client Id。
OAuthClientSecret：アプリケーション設定のOAuth Secret。
OAuthAccessToken：GetOAuthAccessToken によって返されたアクセストークン。
OAuthRefreshToken：GetOAuthAccessToken によって返されたリフレッシュトークン。

OAuth アクセストークンの手動リフレッシュ

データ接続時に手動でOAuth アクセストークンをリフレッシュするために必要な値は、OAuth リフレッシュトークンのみです。 GetOAuthAccessToken によって返されたExpiresIn パラメータ値が経過した後に、RefreshOAuthAccessToken ストアドプロシージャを使用し、手動でOAuthAccessToken をリフレッシュします。次の接続プロパティを設定します。

APIKey：アプリケーション設定のApplication key。
OAuthClientId：アプリケーション設定のOAuth Client Id。
OAuthClientSecret：アプリケーション設定のOAuth Secret。

次に、RefreshOAuthAccessToken を呼び出し、OAuthRefreshToken にGetOAuthAccessToken によって返されたOAuth リフレッシュトークンを指定します。新しいトークンが取得できたら、OAuthAccessToken プロパティにRefreshOAuthAccessToken によって返された値を設定し、新しい接続をオープンします。

最後に、OAuth リフレッシュトークンを保存し、OAuth アクセストークンの有効期限が切れた後に手動でリフレッシュできるようにします。

カスタムOAuth アプリの作成

APIKey、OAuthClientId、およびOAuthClientSecret を取得するには、次の手順を実行してください。

https://developer.ariba.com に移動してサインインします。
Manage（左下のアイコン）をクリックします。
検索フィールドの隣にある+ ボタンをクリックします。
Application Name、Description を入力し、Submit をクリックします。
Actions をクリックし、続けてRequest API Access をクリックします。
データを取得したいAPI を選択します。これはAPI 接続プロパティに対応します。
レルムを選択します。
Submit をクリックします。
リクエストが承認されるのを待ちます。
承認されたら、Actions -> Generate OAuth Secret をクリックします。
表示されるApplication key、OAuth Client Id、およびOAuth Secret を保存します。

高度な機能

このセクションでは、SAP Ariba Sync App の高度な機能を厳選して説明します。

ユーザー定義ビュー

Sync App はユーザー定義ビューの使用をサポートします。これは事前設定されたユーザー定義クエリによって内容が決定される仮想テーブルです。このビューは、ドライバーに発行されるクエリを直接制御できない場合に有効です。カスタムビューの作成と設定の概要については、ユーザー定義ビューを参照してください。

SSL の設定

SSL の設定を使用して、Sync App が証明書のネゴシエーションをどのように扱うかを調整します。さまざまな証明書形式を選択できます。詳しくは、「接続文字列オプション」にあるSSLServerCert プロパティを参照してください。

ファイアウォールとプロキシ

Windows プロキシとHTTP プロキシを含むファイアウォールとプロキシに合致するようSync App を設定します。トンネル接続を設定することもできます。

クエリ処理

Sync App は、SAP Ariba にできるだけ多くのSELECT ステートメント処理をオフロードし、残りのクエリをクライアント側のインメモリで処理します。

詳しくは、クエリ処理を参照してください。

ログ

CData ログを調整するために使用可能な設定の概要については、ログを参照してください。基本的なロギングに必要なのは2つの接続プロパティだけですが、より詳細なロギングをサポートする多くの機能があり、LogModules 接続プロパティを使用してロギングする情報のサブセットを指定することができます。

SSL の設定

SSL 設定のカスタマイズ

デフォルトでは、Sync App はサーバーとのTLS のネゴシエーションを試みます。サーバー証明書は、デフォルトのシステム信頼済み証明書ストアで検証されます。SSLServerCert 接続プロパティを使用して、証明書の検証方法をオーバーライドできます。

別の証明書を指定するには、SSLServerCert 接続プロパティを参照してください。

ファイアウォールとプロキシ

Firewall またはProxy 経由の接続

HTTP プロキシ

HTTP プロキシへの認証には、以下のように設定します。

ProxyServer：HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。
ProxyPort：プロキシサーバーが起動しているTCP ポート。
ProxyAuthScheme：プロキシサーバーに対して認証する際にSync App が使用する認証方法。
ProxyUser：プロキシサーバーに登録されているユーザーアカウントのユーザー名。
ProxyPassword：ProxyUser に紐付けられたパスワード。

その他のプロキシ

次のプロパティを設定します。

プロキシベースのファイヤーウォールを使用するには、FirewallType、FirewallServer、およびFirewallPort を設定します。
接続をトンネルするには、FirewallType をTUNNEL に設定します。
認証するには、FirewallUser とFirewallPassword を設定します。
SOCKS プロキシへの認証には、さらにFirewallType をSOCKS5 に設定します。

データモデル

CData Sync App は、SAP Ariba API のエンティティをビューおよびストアドプロシージャにモデル化します。これらはスキーマファイルにて定義されます。スキーマファイルは、簡単にカスタマイズできるシンプルなテキストベースのコンフィギュレーションファイルです。

Supplier Data API With Pagination V4 の利用

Supplier Data API With Pagination V4 で利用可能なエンティティについては、Supplier Data API With Pagination V4 データモデルを参照してください。

Sourcing Project Management API V2の利用

Sourcing Project Management API V2 で利用可能なエンティティについては、Sourcing Project Management API V2 データモデルを参照してください。

Contract API V1 の利用

Contract API V1 で利用可能なエンティティについては、Contract API V1 データモデルを参照してください。

Risk Category Information API For Supplier Risk Exposure V1 の利用

Risk Category Information API For Supplier Risk Exposure V1 で利用可能なプロシージャについては、Risk Category Information API For Supplier Risk Exposure V1 データモデルを参照してください。

Supplier Data API With Pagination V4 データモデル

概要

このセクションでは、Supplier Data API で利用可能なオブジェクトを示し、SQL の使用についての詳細を説明します。

主要機能

Sync App は、サプライヤー、カスタマー、住所などのSAP Ariba ベンダーエンティティをリレーショナルテーブルやビューとしてモデル化し、SQL を記述してSAP Ariba データをクエリできるようにします。
ストアドプロシージャを使用するとSAP Ariba の操作を実行できます。
これらのオブジェクトへのライブ接続により、Sync App を使用するとアカウントへのあらゆる変更が即座に反映されます。

ビュー

ビューは、SAP Ariba ベンダーをモデル化する読み取り専用のテーブルです。

ストアドプロシージャ

ストアドプロシージャは、OAuth トークン管理などのタスクを実行する、データソースのファンクションライクなインターフェースです。

ビュー

ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。

クエリは、ビューに対して通常のテーブルと同様に実行することができます。

SAP Ariba Source Connector for CData Sync ビュー


Name	Description
AddressEmailAddresses	Retrieve vendor address data email addresses.
Addresses	Retrieve vendor address data.
AddressFaxNumbers	Retrieve vendor address data fax numbers.
AddressPhoneNumbers	Retrieve vendor address data phone numbers.
AddressWebsites	Retrieve vendor address data websites.
BankAccounts	Retrieve vendor bank accounts.
BankInfos	Retrieve vendor bank related data.
CompanyCodes	Retrieve vendor company code related details.
Contacts	Fetch all the vendor contact details for the given vendors Ids.
Customers	Retrieve vendor customer information.
CustomerSalesArrangements	Retrieve vendor customer information sales arrangements.
Identifications	Retrieve vendor identifications.
Qualifications	Fetch vendor qualifications. Qualifications covers both qualifications (either supplier qualifications or process qualifications) and preferred category statuses.
Questionnaires	Retrieve vendor questionnaires.
SupplierAccounting	Retrieve vendor supplier accounting information.
SupplierPurchasingArrangements	Retrieve vendor supplier information purchasing arrangements.
Suppliers	Retrieve vendor supplier information.
VendorDetails	Retrieve vendor details.
Vendors	Retrieve all vendors.

AddressEmailAddresses

Retrieve vendor address data email addresses.

View-Specific Information

Select

The Sync App uses the SAP Ariba API to process WHERE clause conditions built with the following columns and operators. The Sync App processes other filters client-side within the Sync App.

SMVendorId supports the '=' comparison operator.

For example, the following query is processed server side:

SELECT * FROM AddressEmailAddresses WHERE SMVendorId = 'S123456'

Columns


Name	Type	References	Description
SMVendorId [KEY]	String	Vendors.SMVendorId	A unique ID that SAP Ariba assigns automatically.
AddressNumberInCollection [KEY]	Int		Position of the address object in the response collection.
NumberInCollection [KEY]	Int		Position of the address email address object in the response collection.
AddressId	String		The ID of the address, or the position of the address object in the response collection
Id	String		The ID of the email address.
ValidFrom	Date		Validity for email address start date.
ValidTo	Date		Validity for email address end date.
Address	String		The email address.
IsDefault	Bool		Indicator for whether this is the default email address.
UsageDeniedIndicator	Bool		Signifies whether of not the email address can be used for communication.

Addresses

Retrieve vendor address data.

View-Specific Information

Select

The Sync App uses the SAP Ariba API to process WHERE clause conditions built with the following columns and operators. The Sync App processes other filters client-side within the Sync App.

SMVendorId supports the '=' comparison operator.

For example, the following query is processed server side:

SELECT * FROM Addresses WHERE SMVendorId = 'S123456'

Columns


Name	Type	References	Description
SMVendorId [KEY]	String	Vendors.SMVendorId	A unique ID that SAP Ariba assigns automatically.
NumberInCollection [KEY]	Int		Position of the object in the response collection.
Id	String		The ID of the address.
ValidFrom	Date		Validity for address start date.
ValidTo	Date		Validity for address end date.
PostalAddressType	String		The type of the postal address.
IsIndependent	Bool		Indicator for whether this address data is independent.
Usages	String		The vendor address usages.
EmailAddresses	String		Email addresses associated with the vendor.
PhoneNumbers	String		Phone numbers associated with the vendor.
FaxNumbers	String		Fax numbers associated with the vendor.
Websites	String		Websites associated with the vendor.
CommunicationPreferencesCommunicationMethodCode	String		The preferred communication method code.
CommunicationPreferencesNonVerbalCommunicationLanguageCode	String		The preferred non verbal communication code.
OrganizationPostalAddressCareOf	String		Care of information for the organization's postal address.
OrganizationPostalAddressFormattedOrgName	String		The formatted organizational name associated with the postal address.
OrganizationPostalAddressFormattedOrgNameLine1	String		The formatted organizational name associated with the postal address line one.
OrganizationPostalAddressFormattedOrgNameLine2	String		The formatted organizational name associated with the postal address line two.
OrganizationPostalAddressFormattedOrgNameLine3	String		The formatted organizational name associated with the postal address line three.
OrganizationPostalAddressFormattedOrgNameLine4	String		The formatted organizational name associated with the postal address line four.
OrganizationPostalAddressScriptVariants	String		Variations in postal address formats.
OrganizationPostalAddressCoordinatesLatitude	Int		Latitude coordinates in the organization's postal address.
OrganizationPostalAddressCoordinatesLongitude	Int		Longitude coordinates in the organization's postal address.
OrganizationPostalAddressCoordinatesAltitude	Int		Altitude coordinates in the+ organization's postal address.
OrganizationPostalAddressTimeZoneCode	String		The code of the postal address' specific time zone.
OrganizationPostalAddressCountryCode	String		The country code in the organization's postal address.
OrganizationPostalAddressAlternativeCountryCode	String		Alternative country code in the organization's postal address.
OrganizationPostalAddressPrimaryRegionCode	String		Primary region code in the organization's postal address.
OrganizationPostalAddressSecondaryRegionName	String		Secondary region name in the organization's postal address.
OrganizationPostalAddressSecondaryRegionRefCode	String		Secondary region reference code in the organization's postal address.
OrganizationPostalAddressTertiaryRegionName	String		Tertiary region name in the organization's postal address.
OrganizationPostalAddressTertiaryRegionRefCode	String		Tertiary region reference code in the organization's postal address.
OrganizationPostalAddressAlternativePrimaryRegionCode	String		Primary region code in the organization's alternative postal address.
OrganizationPostalAddressAlternativeSecondaryRegionName	String		Secondary region name in the organization's alternative postal address.
OrganizationPostalAddressAlternativeSecondaryRegionRefCode	String		Secondary region reference code in the organization's alternative postal address.
OrganizationPostalAddressAlternativeTertiaryRegionName	String		Tertiary region name in the organization's alternative postal address.
OrganizationPostalAddressAlternativeTertiaryRegionRefCode	String		Tertiary region reference code in the organization's alternative postal address.
OrganizationPostalAddressDistrictName	String		District name in the organization?s postal address.
OrganizationPostalAddressDistrictRefCode	String		District reference code in the organization?s postal address.
OrganizationPostalAddressAlternativeDistrictName	String		Alternative district name in the organization?s postal address.
OrganizationPostalAddressAlternativeDistrictRefCode	String		Alternative district reference code in the organization?s postal address.
OrganizationPostalAddressTownName	String		Town name in the organization's postal address.
OrganizationPostalAddressTownRefCode	String		Town reference code in the organization's postal address.
OrganizationPostalAddressAdditionalCityName	String		Additional city name in the organization's postal address.
OrganizationPostalAddressAlternativeTownName	String		Alternative town name in the organization's postal address.
OrganizationPostalAddressAlternativeTownRefCode	String		Alternative town reference code in the organization's postal address.
OrganizationPostalAddressStreetName	String		Street name in the organization's postal address.
OrganizationPostalAddressStreetRefCode	String		Reference code for the street in the organization's postal address.
OrganizationPostalAddressStreetPrefix1	String		First prefix of the street in the organization's postal address.
OrganizationPostalAddressStreetPrefix2	String		Second prefix of the street in the organization's postal address.
OrganizationPostalAddressStreetSuffix1	String		First suffix of the street in the organization's postal address.
OrganizationPostalAddressStreetSuffix2	String		Second suffix of the street in the organization's postal address.
OrganizationPostalAddressHouseNumber	String		House number in the organization's postal address.
OrganizationPostalAddressHouseNumberSupplement	String		Supplemental house number in the organization's postal address.
OrganizationPostalAddressDoor	String		Door number in the organization's postal address.
OrganizationPostalAddressFloor	String		Floor number in the organization's postal address.
OrganizationPostalAddressPostCode	String		Postal code in the organization's postal address.
OrganizationPostalAddressCompanyPostalCode	String		Company code in the organization's postal address.
OrganizationPostalAddressPostBoxIsWithoutNumber	Bool		Post box without number in the organization's postal address.
OrganizationPostalAddressDeliveryServiceNumber	String		Delivery service number in the organization's postal address.
OrganizationPostalAddressAlternativePostCode	String		Alternative postal code in the organization's postal address.
OrganizationPostalAddressAlternativeDeliveryServiceIdentifier	String		Identifier for alternative delivery service in the organization's postal address.
OrganizationPostalAddressAlternativeDeliveryServiceQualifier	String		Qualifier for alternative delivery service in the organization's postal address.
OrganizationPostalAddressAlternativeDeliveryServiceType	String		Type of alternative delivery service in the organization's postal address.
OrganizationPostalAddressAlternativeDeliveryTypeCode	String		Code for alternative delivery type in the organization's postal address.
PersonPostalAddressInitials	String		Initials of the person's postal address.
PersonPostalAddressAcademicTitleCode	String		Academic title code in the person's postal address.
PersonPostalAddressAdditionalAcademicTitleCode	String		Additional academic title code in the person's postal address.
PersonPostalAddressFormOfAddressCode	String		Code representing the form of address in the person's postal address.
PersonPostalAddressFormattedPersonName	String		Formatted name in the person's postal address.
PersonPostalAddressFirstName	String		First name in the person's postal address.
PersonPostalAddressMiddleName	String		Middle name in the person's postal address.
PersonPostalAddressLastName	String		Last name in the person's postal address.
PersonPostalAddressSecondLastName	String		Second last name in the person's postal address.
PersonPostalAddressNamePrefixCode	String		Name prefix code in the person's postal address.
PersonPostalAddressAdditionalNamePrefixCode	String		Additional name prefix code in the person's postal address.
PersonPostalAddressNameSuffixCode	String		Name suffix code in the person's postal address.
PersonPostalAddressScriptVariants	String		Script variants in the person's postal address.
PersonPostalAddressCareOf	String		Care of information for the person's postal address.
PersonPostalAddressCoordinatesLatitude	Int		Latitude coordinates in the person's postal address.
PersonPostalAddressCoordinatesLongitude	Int		Longitude coordinates in the person's postal address.
PersonPostalAddressCoordinatesAltitude	Int		Altitude coordinates in the person's postal address.
PersonPostalAddressTimeZoneCode	String		Time zone code in the person's postal address.
PersonPostalAddressCountryCode	String		Country code in the person's postal address.
PersonPostalAddressAlternativeCountryCode	String		Alternative country code in the person's postal address.
PersonPostalAddressPrimaryRegionCode	String		Primary region code in the person's postal address.
PersonPostalAddressSecondaryRegionName	String		Secondary region name in the person's postal address.
PersonPostalAddressSecondaryRegionRefCode	String		Secondary region reference code in the person's postal address.
PersonPostalAddressTertiaryRegionName	String		Tertiary region name in the person's postal address.
PersonPostalAddressTertiaryRegionRefCode	String		Tertiary region reference code in the person's postal address.
PersonPostalAddressAlternativePrimaryRegionCode	String		Alternative primary region code in the person's postal address.
PersonPostalAddressAlternativeSecondaryRegionName	String		Alternative secondary region name in the person's postal address.
PersonPostalAddressAlternativeSecondaryRegionRefCode	String		Alternative secondary region reference code in the person's postal address.
PersonPostalAddressAlternativeTertiaryRegionName	String		Alternative tertiary region name in the person's postal address.
PersonPostalAddressAlternativeTertiaryRegionRefCode	String		Alternative tertiary region reference code in the person's postal address.
PersonPostalAddressDistrictName	String		District name in the person's postal address.
PersonPostalAddressDistrictRefCode	String		District reference code in the person's postal address.
PersonPostalAddressAlternativeDistrictName	String		Alternative district name in the person's postal address.
PersonPostalAddressAlternativeDistrictRefCode	String		Alternative district reference code in the person's postal address.
PersonPostalAddressTownName	String		Town name in the person's postal address.
PersonPostalAddressTownRefCode	String		Town reference code in the person's postal address.
PersonPostalAddressAdditionalCityName	String		Additional city name in the person's postal address.
PersonPostalAddressAlternativeTownName	String		Alternative town name in the person's postal address.
PersonPostalAddressAlternativeTownRefCode	String		Alternative town reference code in the person's postal address.
PersonPostalAddressStreetName	String		Street name in the person's postal address.
PersonPostalAddressStreetRefCode	String		Street reference code in the person's postal address.
PersonPostalAddressStreetPrefix1	String		First prefix of the street in the person's postal address.
PersonPostalAddressStreetPrefix2	String		Second prefix of the street in the person's postal address.
PersonPostalAddressStreetSuffix1	String		First suffix of the street in the person's postal address.
PersonPostalAddressStreetSuffix2	String		Second suffix of the street in the person's postal address.
PersonPostalAddressHouseNumber	String		House number in the person's postal address.
PersonPostalAddressHouseNumberSupplement	String		Supplemental house number in the person's postal address.
PersonPostalAddressDoor	String		Door number in the person's postal address.
PersonPostalAddressFloor	String		Floor number in the person's postal address.
PersonPostalAddressPostCode	String		Postal code in the person's postal address.
PersonPostalAddressAlternativePostCode	String		Alternative postal code in the person's postal address.
PersonPostalAddressCompanyPostalCode	String		Company code in the person's postal address.
PersonPostalAddressPostBoxIsWithoutNumber	Bool		Post box without number in the person's postal address.
PersonPostalAddressDeliveryServiceNumber	String		Delivery service number in the person's postal address.
PersonPostalAddressAlternativeDeliveryServiceIdentifier	String		Identifier for alternative delivery service in the person's postal address.
PersonPostalAddressAlternativeDeliveryServiceQualifier	String		Qualifier for alternative delivery service in the person's postal address.
PersonPostalAddressAlternativeDeliveryServiceType	String		Type of alternative delivery service in the person's postal address.
PersonPostalAddressAlternativeDeliveryTypeCode	String		Code for alternative delivery type in the person's postal address.

AddressFaxNumbers

Retrieve vendor address data fax numbers.

View-Specific Information

Select

The Sync App uses the SAP Ariba API to process WHERE clause conditions built with the following columns and operators. The Sync App processes other filters client-side within the Sync App.

SMVendorId supports the '=' comparison operator.

For example, the following query is processed server side:

SELECT * FROM AddressFaxNumbers WHERE SMVendorId = 'S123456'

Columns


Name	Type	References	Description
SMVendorId [KEY]	String	Vendors.SMVendorId	A unique ID that SAP Ariba assigns automatically.
AddressNumberInCollection [KEY]	Int		Position of the address object in the response collection.
NumberInCollection [KEY]	Int		Position of the address fax number object in the response collection.
AddressId	String		The ID of the address.
Id	String		The ID of the fax number.
ValidFrom	Date		Validity for fax number start date.
ValidTo	Date		Validity for fax number end date.
Number	String		The fax number.
IsDefault	Bool		Indicator for whether this is the default fax number.
NumberExtension	String		Extension number for the fax number.
UsageDeniedIndicator	Bool		Signifies whether of not the fax number can be used for communication.
CountryCode	String		The country code of the fax number.

AddressPhoneNumbers

Retrieve vendor address data phone numbers.

View-Specific Information

Select

The Sync App uses the SAP Ariba API to process WHERE clause conditions built with the following columns and operators. The Sync App processes other filters client-side within the Sync App.

SMVendorId supports the '=' comparison operator.

For example, the following query is processed server side:

SELECT * FROM AddressPhoneNumbers WHERE SMVendorId = 'S123456'

Columns


Name	Type	References	Description
SMVendorId [KEY]	String	Vendors.SMVendorId	A unique ID that SAP Ariba assigns automatically.
AddressNumberInCollection [KEY]	Int		Position of the address object in the response collection.
NumberInCollection [KEY]	Int		Position of the address phone number object in the response collection.
AddressId	String		The ID of the address.
Id	String		The ID of the phone number.
ValidFrom	Date		Validity for phone number start date.
ValidTo	Date		Validity for phone number end date.
Number	String		The phone number.
IsDefault	Bool		Indicator for whether this is the default phone number.
NumberExtension	String		Extension number for the phone number.
IsMobile	Bool		Indicator for whether the phone number is of a mobile.
UsageDeniedIndicator	Bool		Signifies whether of not the phone number can be used for communication.
SmsEnabledIndicator	Bool		Signifies whether of not the phone number can be used for SMS communication.
CountryCode	String		The country code of the phone number.

AddressWebsites

Retrieve vendor address data websites.

View-Specific Information

Select

The Sync App uses the SAP Ariba API to process WHERE clause conditions built with the following columns and operators. The Sync App processes other filters client-side within the Sync App.

SMVendorId supports the '=' comparison operator.

For example, the following query is processed server side:

SELECT * FROM AddressWebsites WHERE SMVendorId = 'S123456'

Columns


Name	Type	References	Description
SMVendorId [KEY]	String	Vendors.SMVendorId	A unique ID that SAP Ariba assigns automatically.
AddressNumberInCollection [KEY]	Int		Position of the address object in the response collection.
NumberInCollection [KEY]	Int		Position of the address website object in the response collection.
AddressId	String		The ID of the address.
Id	String		The ID of the website.
ValidFrom	Date		Validity for website start date.
ValidTo	Date		Validity for website end date.
Url	String		The website's URL.
UriType	String		The type of the URI.
IsDefault	Bool		Indicator for whether this is the default website.

BankAccounts

Retrieve vendor bank accounts.

View-Specific Information

Select

The Sync App uses the SAP Ariba API to process WHERE clause conditions built with the following columns and operators. The Sync App processes other filters client-side within the Sync App.

SMVendorId supports the '=' comparison operator.

For example, the following query is processed server side:

SELECT * FROM BankAccounts WHERE SMVendorId = 'S123456'

Columns


Name	Type	References	Description
SMVendorId [KEY]	String	Vendors.SMVendorId	A unique ID that SAP Ariba assigns automatically.
Id [KEY]	String		The ID of the bank account.
ValidFrom	Date		Validity for bank account start date.
ValidTo	Date		Validity for bank account end date.
IBAN	String		The bank account's International Bank Account Number.
BankAccount	String		This field contains the number under which the account is managed at the bank.
BankNumber	String		The bank key under which the bank data is stored in the appropriate country.
BankAccountName	String		Name of the bank account.
BankAccountHolderName	String		The name of the bank account holder.
BankAccountReference	String		Reference details for the bank account.
AlternatePaymentAccount	String		Alternate payment account.
AdditionalPaymentReference	String		Additional reference details for payments.
BankControlKey	String		A check key for the combination bank number and bank account number.
BankCountryCode	String		The country code of the bank account.
BankAccountCurrencyCode	String		The currency code of the bank account.

BankInfos

Retrieve vendor bank related data.

View-Specific Information

Select

The Sync App uses the SAP Ariba API to process WHERE clause conditions built with the following columns and operators. The Sync App processes other filters client-side within the Sync App.

SMVendorId supports the '=,IN' comparison operators.
ERPVendorId supports the '=,IN' comparison operators.
VendorLastUpdateDate supports the '<=,<,=,>,>=' comparison operators.
VendorRegistrationStatus supports the '=,IN' comparison operators.
VendorQualificationStatus supports the '=,IN' comparison operators.
VendorPreferredLevel supports the '=,IN' comparison operators.
VendorBusinessUnit supports the '=,IN' comparison operators.
VendorCategory supports the '=,IN' comparison operators.
VendorRegion supports the '=,IN' comparison operators.

For example, the following queries are processed server side:

SELECT * FROM BankInfos WHERE SMVendorID = 'S123456'

SELECT * FROM BankInfos WHERE ERPVendorId = '1000003560'

SELECT * FROM BankInfos WHERE VendorRegistrationStatus = 'Registered'

SELECT * FROM BankInfos WHERE VendorQualificationStatus = 'Qualified'

SELECT * FROM BankInfos WHERE VendorPreferredLevel = 1

SELECT * FROM BankInfos WHERE VendorBusinessUnit = '408'

SELECT * FROM BankInfos WHERE VendorCategory = '51'

SELECT * FROM BankInfos WHERE VendorRegion = 'USA'

Columns


Name	Type	References	Description
SMVendorId [KEY]	String	Vendors.SMVendorId	A unique ID that SAP Ariba assigns automatically.
ERPVendorId	String		A mandatory ID, which must be unique in combination with the supplier's source system.
NumberInCollection [KEY]	Int		Position of the object in the response collection.
BankAccountInternalId	String		The internal ID of the bank account.
BankAccountStandardId	String		The standard ID of the bank account.
BankAccountExternalId	String		The external ID of the bank account.
AccountName	String		The name of the account.
AccountNumber	String		The number of the account.
BankBranch	String		The associated bank branch.
Country	String		The country code.
Address	String		Address related data.
VendorLastUpdateDate	Datetime		Date of the last update.
VendorRegistrationStatus	String		Registration status of the record.
VendorQualificationStatus	String		Qualification status of the record.
VendorPreferredLevel	Int		Preferred status. A number between 1 and 5. 1 is the highest preferred level and 5 is the lowest.
VendorBusinessUnit	String		A business unit or department ID loaded in your site as master data and used in supplier management projects.
VendorCategory	String		A category ID loaded in your site as master data and used in supplier management projects.
VendorRegion	String		A region code loaded in your site as master data and used in supplier management projects.

CompanyCodes

Retrieve vendor company code related details.

View-Specific Information

Select

The Sync App uses the SAP Ariba API to process WHERE clause conditions built with the following columns and operators. The Sync App processes other filters client-side within the Sync App.

SMVendorId supports the '=,IN' comparison operators.
ERPVendorId supports the '=,IN' comparison operators.
VendorLastUpdateDate supports the '<=,<,=,>,>=' comparison operators.
VendorRegistrationStatus supports the '=,IN' comparison operators.
VendorQualificationStatus supports the '=,IN' comparison operators.
VendorPreferredLevel supports the '=,IN' comparison operators.
VendorBusinessUnit supports the '=,IN' comparison operators.
VendorCategory supports the '=,IN' comparison operators.
VendorRegion supports the '=,IN' comparison operators.

For example, the following queries are processed server side:

SELECT * FROM CompanyCodes WHERE SMVendorID = 'S123456'

SELECT * FROM CompanyCodes WHERE ERPVendorId = '1000003560'

SELECT * FROM CompanyCodes WHERE VendorRegistrationStatus = 'Registered'

SELECT * FROM CompanyCodes WHERE VendorQualificationStatus = 'Qualified'

SELECT * FROM CompanyCodes WHERE VendorPreferredLevel = 1

SELECT * FROM CompanyCodes WHERE VendorBusinessUnit = '408'

SELECT * FROM CompanyCodes WHERE VendorCategory = '51'

SELECT * FROM CompanyCodes WHERE VendorRegion = 'USA'

Columns


Name	Type	References	Description
SMVendorId [KEY]	String	Vendors.SMVendorId	A unique ID that SAP Ariba assigns automatically.
ERPVendorId	String		A mandatory ID, which must be unique in combination with the supplier's source system.
CompanyCode [KEY]	String		The company code.
PaymentMethodsCode	String		The code of the payment method.
PlanningGroupCode	String		The code of the planning group.
CashDiscountTermsCode	String		The code of the cash discount terms.
GeneralLedgerAccountReferenceId	String		The reference id of the general ledger account.
WithHoldingTaxes	String		Tax details.
VendorLastUpdateDate	Datetime		Date of the last update.
VendorRegistrationStatus	String		Registration status of the record.
VendorQualificationStatus	String		Qualification status of the record.
VendorPreferredLevel	Int		Preferred status. A number between 1 and 5. 1 is the highest preferred level and 5 is the lowest.
VendorBusinessUnit	String		A business unit or department ID loaded in your site as master data and used in supplier management projects.
VendorCategory	String		A category ID loaded in your site as master data and used in supplier management projects.
VendorRegion	String		A region code loaded in your site as master data and used in supplier management projects.

Contacts

Fetch all the vendor contact details for the given vendors Ids.

View-Specific Information

Select

The Sync App uses the SAP Ariba API to process WHERE clause conditions built with the following columns and operators. The Sync App processes other filters client-side within the Sync App.

SMVendorId supports the '=,IN' comparison operators.
ERPVendorId supports the '=,IN' comparison operators.
ACMId supports the '=,IN' comparison operators.

For example, the following queries are processed server side:

SELECT * FROM Contacts WHERE SMVendorId = 'S123456'

SELECT * FROM Contacts WHERE ERPVendorId = '1000005002'

SELECT * FROM Contacts WHERE ACMId = '1000005002'

Columns


Name	Type	References	Description
SMVendorId [KEY]	String	Vendors.SMVendorId	The ID that SAP Ariba assigns to the supplier.
ERPVendorId	String		The ID of the supplier in the integrated ERP system.
ANId	String		An ID that SAP Business Network automatically assigns to suppliers when they create accounts.
ACMId	String		A unique ID assigned by SAP Ariba that identifies suppliers internally within SAP Ariba applications.
SupplierName	String		The name of the supplier. In general, erpVendorId associates a contact with a contact with a supplier.
S4UniqueName [KEY]	String		The unique name of the supplier contact in SAP Ariba Strategic Sourcing Suite.
FirstName	String		The first name of the supplier contact.
LastName	String		The last name of the supplier contact.
MiddleName	String		The middle name of the supplier contact.
Email	String		The supplier contact's email address.
Telephone	String		The supplier contact's land line telephone number.
Title	String		The supplier contact's title.
AodObjectId	String		Indicates whether a supplier is private or public.
Categories	String		The commodities for which the supplier contact is responsible.
MobilePhone	String		The supplier contact's mobile telephone number.
Regions	String		The regions for which the supplier contact is responsible.
SourceSystem	String		The source system.
Type	String		The type of the supplier contact that matches one of the types defined for your site.
Locale	String		The ISO code for the supplier contact's language.
TimeZoneId	String		The ID of the timezone where the supplier contact is located.
Departments	String		The departments associated with the contact, if any.
MobileCountryName	String		The country/region of the supplier contact's mobile telephone number. SAP Ariba Supplier Management solutions automatically insert a plus sign (+) before of the country/region code in user interface display and JSON response.
TelephoneCountryName	String		The country/region of the supplier contact's land line telephone number.
Role	String		The role.
TimeUpdated	Datetime		The date and time when the contact was last updated.
TimeCreated	Datetime		The date and time when the contact was created.
Primary	Bool		A Boolean value that specifies whether or not the supplier contact is the primary contact for the supplier.
Active	Bool		A Boolean value that specifies whether the contact is active or deactivated.

Customers

Retrieve vendor customer information.

View-Specific Information

Select

The Sync App uses the SAP Ariba API to process WHERE clause conditions built with the following columns and operators. The Sync App processes other filters client-side within the Sync App.

SMVendorId supports the '=' comparison operator.

For example, the following query is processed server side:

SELECT * FROM Customers WHERE SMVendorId = 'S123456'

Columns


Name	Type	References	Description
SMVendorId [KEY]	String	Vendors.SMVendorId	A unique ID that SAP Ariba assigns automatically.
IsMarkedForDeletion	Bool		Indicator for whether this customer information is marked for deletion.
RepresentativeName	String		The name of the representative.
CustomerTradingPartnerId	String		The customer trading partner ID.
CustomerCorporateGroup	String		The customer corporate group.
ExpressTrainStationName	String		The name of the train station that the customer uses to receive express deliveries.
AlternativePayerIsAllowed	Bool		Indicator for whether an alternative payer is allowed.
SalesArrangements	String		Data on sales arrangements.
SalesBlockForCustomer	Bool		Sales block status for the customer.
IsOrderBlocked	Bool		Indicator for whether the order is currently blocked.
OrderBlockedReasonCode	String		Reason code for the blocked order.
IsBillingBlocked	Bool		Indicator for whether billing is currently blocked.
BillingBlockedReasonCode	String		Reason code for the blocked billing.
IsDeliveryBlocked	Bool		Indicator for whether delivery is currently blocked.
DeliveryBlockedReasonCode	String		Reason code for the blocked delivery.
PostingIsBlocked	Bool		Indicator for whether posting is currently blocked.
NielsenRegionCode	String		Nielsen region code.
InternationalLocationNumber1	String		First international location number.
InternationalLocationNumber2	String		Second international location number.
InternationalLocationNumber3	String		Third international location number.
FiscalAddress	String		An additional master record in which the official address is stored.
FiscalYearVariant	String		The fiscal year represents the accounting year or annual accounting period. A fiscal year variant defines your company's accounting posting periods.
PlannedAnnualSalesYear	String		Planned annual sales year.
PlannedAnnualSalesAmount	Decimal		The planned annual sales amount.
PlannedAnnualSalesCurrency	String		The planned annual sales currency.
CfopCategoryCode	String		The CFOP category code. The CFOP is a code defined by the Brazilian tax authorities that describes the type of business transaction.
VatLiability	Bool		Indicator for whether liable for VAT.
AccountTaxTypeCode	String		The account's tax type code.
TaxClassifications	String		Classifications for tax.
IsEqualizationTaxSubject	Bool		Indicator for whether tax is applicable to equalization for the subject.
CustomerAccountGroupCode	String		Code for customer account group.
CustomerClassificationCode	String		Code for customer classification.
CustomerExtensionCode01	String		Code 01 for customer extension.
CustomerExtensionCode02	String		Code 02 for customer extension.
CustomerExtensionCode03	String		Code 03 for customer extension.
CustomerExtensionCode04	String		Code 04 for customer extension.
CustomerExtensionCode05	String		Code 05 for customer extension.
CustomerExtensionCode06	String		Code 06 for customer extension.
CustomerExtensionCode07	String		Code 07 for customer extension.
CustomerExtensionCode08	String		Code 08 for customer extension.
CustomerExtensionCode09	String		Code 09 for customer extension.
CustomerExtensionCode10	String		Code 10 for customer extension.
CustomerConditionGroup1Code	String		Code 1 for customer condition group.
CustomerConditionGroup2Code	String		Code 2 for customer condition group.
CustomerConditionGroup3Code	String		Code 3 for customer condition group.
CustomerConditionGroup4Code	String		Code 4 for customer condition group.
CustomerConditionGroup5Code	String		Code 5 for customer condition group.
DataExchangeInstructionCode	String		Instruction code for data medium exchange.
DataMediumExchangeIndicatorCode	String		Indicator code for data medium exchange.
BusinessType	String		The type of business.
IndustryType	String		The type of industry.
IndustryCode1Code	String		Code 1 for the industry type.
IndustryCode2Code	String		Code 2 for the industry type.
IndustryCode3Code	String		Code 3 for the industry type.
IndustryCode4Code	String		Code 4 for the industry type.
IndustryCode5Code	String		Code 5 for the industry type.

CustomerSalesArrangements

Retrieve vendor customer information sales arrangements.

View-Specific Information

Select

The Sync App uses the SAP Ariba API to process WHERE clause conditions built with the following columns and operators. The Sync App processes other filters client-side within the Sync App.

SMVendorId supports the '=' comparison operator.

For example, the following query is processed server side:

SELECT * FROM CustomerSalesArrangements WHERE SMVendorId = 'S123456'

Columns


Name	Type	References	Description
SMVendorId [KEY]	String	Vendors.SMVendorId	A unique ID that SAP Ariba assigns automatically.
NumberInCollection [KEY]	Int		Position of the object in the response collection.
SalesGroupDisplayId	String		Display identifier for the sales group.
SalesOfficeDisplayId	String		Display identifier for the sales office.
Functions	String		Functions associated with the record.
IsMarkedForDeletion	Bool		Indicator for whether this record is marked for deletion.
SalesAreaRefSalesOrganizationDisplayId	String		Display identifier for the organization in the sales area reference.
SalesAreaRefDivision	String		Division in the sales area reference.
SalesAreaRefDistributionChannel	String		Distribution channel in the sales area reference.
SalesArrangementGroupCode	String		Code for the sales arrangement group.
SalesArrangementPriceGroupCode	String		Code for the sales arrangement price group.
CurrencyCode	String		Code for the currency.
IncotermsTransferLocationName	String		Name of the Incoterms transfer location.
IncotermsClassificationCode	String		Code for the Incoterms classification.
SalesBlockForCustomer	Bool		Sales block information for the customer.
DeliveryPriorityCode	String		Code indicating delivery priority.
IsDeliveryBlocked	Bool		Indicator for whether delivery is blocked.
DeliveryBlockedReasonCode	String		Code indicating the reason for delivery being blocked.
IsDeliveryCombinationAllowed	Bool		Indicator for whether delivery combination is allowed.
IsDeliveryInChunksAllowed	Bool		Indicator for whether delivery in chunks is allowed.
MaxCountDeliveryChunks	Int		Maximum count of delivery chunks allowed.
CompleteDeliveryIsDefined	Bool		Indicator for whether complete delivery is defined.
IsBillingBlocked	Bool		Indicator for whether billing is blocked.
BillingBlockedReasonCode	String		Code indicating the reason for billing being blocked.
IsOrderBlocked	Bool		Indicator for whether the order is blocked.
OrderBlockedReasonCode	String		Code indicating the reason for the order being blocked.

Identifications

Retrieve vendor identifications.

View-Specific Information

Select

The Sync App uses the SAP Ariba API to process WHERE clause conditions built with the following columns and operators. The Sync App processes other filters client-side within the Sync App.

SMVendorId supports the '=' comparison operator.

For example, the following query is processed server side:

SELECT * FROM Identifications WHERE SMVendorId = 'S123456'

Columns


Name	Type	References	Description
SMVendorId [KEY]	String	Vendors.SMVendorId	A unique ID that SAP Ariba assigns automatically.
NumberInCollection [KEY]	Int		Position of the identification object in the response collection.
IdentificationNumber	String		Identification number.
ValidFrom	Date		Validity for identification start date.
ValidTo	Date		Validity for identification end date.
EntryDate	Date		Entry date of the record.
Institute	String		Institute associated with the identification.
IdentificationTypeCode	String		Code for the type of identification.
CountryCode	String		Code for the country of the identification.
RegionCode	String		Code for the region of the identification.

Qualifications

Fetch vendor qualifications. Qualifications covers both qualifications (either supplier qualifications or process qualifications) and preferred category statuses.

View-Specific Information

Select

The Sync App uses the SAP Ariba API to process WHERE clause conditions built with the following columns and operators. The Sync App processes other filters client-side within the Sync App.

SMVendorId supports the '=,IN' comparison operators.
ERPVendorId supports the '=,IN' comparison operators.
VendorLastUpdateDate supports the '<=,<,=,>,>=' comparison operators.
VendorRegistrationStatus supports the '=,IN' comparison operators.
VendorQualificationStatus supports the '=,IN' comparison operators.
VendorPreferredLevel supports the '=,IN' comparison operators.
VendorBusinessUnit supports the '=,IN' comparison operators.
VendorCategory supports the '=,IN' comparison operators.
VendorRegion supports the '=,IN' comparison operators.

For example, the following queries are processed server side:

SELECT * FROM Qualifications WHERE SMVendorID = 'S123456'

SELECT * FROM Qualifications WHERE ERPVendorId = '1000003560'

SELECT * FROM Qualifications WHERE VendorRegistrationStatus = 'Registered'

SELECT * FROM Qualifications WHERE VendorQualificationStatus = 'Qualified'

SELECT * FROM Qualifications WHERE VendorPreferredLevel = 1

SELECT * FROM Qualifications WHERE VendorBusinessUnit = '408'

SELECT * FROM Qualifications WHERE VendorCategory = '51'

SELECT * FROM Qualifications WHERE VendorRegion = 'USA'

Columns


Name	Type	References	Description
SMVendorId [KEY]	String	Vendors.SMVendorId	A unique ID that SAP Ariba assigns automatically.
ERPVendorId	String		A mandatory ID, which must be unique in combination with the supplier's source system.
NumberInCollection [KEY]	Int		Position of the object in the response collection.
MaterialID	String		Material id.
Category	String		A category ID loaded in your site as master data and used in supplier management projects.
Region	String		A region code loaded in your site as master data and used in supplier management projects.
QualificationStatus	String		Qualification status.
PreferredStatus	Int		Preferred status. A number between 1 and 5. 1 is the highest preferred level and 5 is the lowest.
BusinessUnit	String		A business unit or department ID loaded in your site as master data and used in supplier management projects.
ProcessType	String		Process type. For process qualifications, the Process Type field includes the type of the qualification process as defined by process type data in your site.
VendorLastUpdateDate	Datetime		Date of the last update.
VendorRegistrationStatus	String		Registration status of the record.
VendorQualificationStatus	String		Qualification status of the record.
VendorPreferredLevel	Int		Preferred status. A number between 1 and 5. 1 is the highest preferred level and 5 is the lowest.
VendorBusinessUnit	String		A business unit or department ID loaded in your site as master data and used in supplier management projects.
VendorCategory	String		A category ID loaded in your site as master data and used in supplier management projects.
VendorRegion	String		A region code loaded in your site as master data and used in supplier management projects.

Questionnaires

Retrieve vendor questionnaires.

View-Specific Information

Select

The Sync App uses the SAP Ariba API to process WHERE clause conditions built with the following columns and operators. The Sync App processes other filters client-side within the Sync App.

SMVendorId supports the '=,IN' comparison operators.
ERPVendorId supports the '=,IN' comparison operators.
VendorLastUpdateDate supports the '<=,<,=,>,>=' comparison operators.
VendorRegistrationStatus supports the '=,IN' comparison operators.
VendorQualificationStatus supports the '=,IN' comparison operators.
VendorPreferredLevel supports the '=,IN' comparison operators.
VendorBusinessUnit supports the '=,IN' comparison operators.
VendorCategory supports the '=,IN' comparison operators.
VendorRegion supports the '=,IN' comparison operators.

For example, the following queries are processed server side:

SELECT * FROM Questionnaires WHERE SMVendorID = 'S123456'

SELECT * FROM Questionnaires WHERE ERPVendorId = '1000003560'

SELECT * FROM Questionnaires WHERE VendorRegistrationStatus = 'Registered'

SELECT * FROM Questionnaires WHERE VendorQualificationStatus = 'Qualified'

SELECT * FROM Questionnaires WHERE VendorPreferredLevel = 1

SELECT * FROM Questionnaires WHERE VendorBusinessUnit = '408'

SELECT * FROM Questionnaires WHERE VendorCategory = '51'

SELECT * FROM Questionnaires WHERE VendorRegion = 'USA'

Columns


Name	Type	References	Description
SMVendorId [KEY]	String	Vendors.SMVendorId	A unique ID that SAP Ariba assigns automatically.
ERPVendorId	String		A mandatory ID, which must be unique in combination with the supplier's source system.
QuestionnaireId [KEY]	String		The document ID for the questionnaire.
QuestionnaireTitle	String		The title of the questionnaire.
WorkspaceId	String		The ID of the workspace.
WorkspaceType	String		The type of the workspace.
MatrixInfo	String		Information about the questionnaire matrix.
VendorLastUpdateDate	Datetime		Date of the last update.
VendorRegistrationStatus	String		Registration status of the record.
VendorQualificationStatus	String		Qualification status of the record.
VendorPreferredLevel	Int		Preferred status. A number between 1 and 5. 1 is the highest preferred level and 5 is the lowest.
VendorBusinessUnit	String		A business unit or department ID loaded in your site as master data and used in supplier management projects.
VendorCategory	String		A category ID loaded in your site as master data and used in supplier management projects.
VendorRegion	String		A region code loaded in your site as master data and used in supplier management projects.

SupplierAccounting

Retrieve vendor supplier accounting information.

View-Specific Information

Select

The Sync App uses the SAP Ariba API to process WHERE clause conditions built with the following columns and operators. The Sync App processes other filters client-side within the Sync App.

SMVendorId supports the '=' comparison operator.

For example, the following query is processed server side:

SELECT * FROM SupplierAccounting WHERE SMVendorID = 'S123456'

Columns


Name	Type	References	Description
SMVendorId [KEY]	String	Vendors.SMVendorId	A unique ID that SAP Ariba assigns automatically.
AccountNumberAtSupplier	String		Account number at the supplier.
ReconciliationAccountNumber [KEY]	String		Reconciliation account number.
CompanyCodeDisplayId	String		Display ID for the company code.
HouseBank	String		House bank information.
CashPlanningGroup	String		Cash planning group.
PaymentMethods	String		Payment methods associated with the record.
WithholdingTaxes	String		Withholding taxes information.
IsMarkedForDeletion	Bool		Indicator for whether the record is marked for deletion.
ModifiedAt	Datetime		Date and time of last modification.
CreatedAt	Datetime		Date and time of creation.
AccountingClerkId	String		ID of the accounting clerk.
AccountingClerkInternetAddress	String		Internet address of the accounting clerk.
InvoiceSortingOrderCode	String		Code for the invoice sorting order.
MinorityGroupCode	String		Code for the minority group.
IsAlternativePayeeUsed	Bool		Indicator for whether alternative payee is used.
AlternativePayees	String		List of alternative payees.
IsDoubleInvoice	Bool		Indicator for whether a double invoice is used.
IsPaymentBlocked	Bool		Indicator for whether payment is blocked.
PaymentBlockingReasonCode	String		Reason code for payment blocking.
IsPostingBlocked	Bool		Indicator for whether posting is blocked.
PostingBlockingReasonCode	String		Reason code for posting blocking.

SupplierPurchasingArrangements

Retrieve vendor supplier information purchasing arrangements.

View-Specific Information

Select

The Sync App uses the SAP Ariba API to process WHERE clause conditions built with the following columns and operators. The Sync App processes other filters client-side within the Sync App.

SMVendorId supports the '=' comparison operator.

For example, the following query is processed server side:

SELECT * FROM SupplierPurchasingArrangements WHERE SMVendorId = 'S123456'

Columns


Name	Type	References	Description
SMVendorId [KEY]	String	Vendors.SMVendorId	A unique ID that SAP Ariba assigns automatically.
NumberInCollection [KEY]	Int		Position of the object in the response collection.
PurchasingGroupDisplayId	String		Purchasing group display id.
PurchasingOrganizationDisplayId	String		Purchasing organization display id.
Functions	String		Functions.
IsMarkedForDeletion	Bool		Is marked for deletion.
CurrencyCode	String		Currency code.
CalculationSchemaCode	String		Calculation schema code.
ClassificationCode	String		Classification code.
IncotermsClassificationCode	String		Incoterms classification code.
IncotermsTransferLocationName	String		Incoterms transfer location name.
IsPurchasingBlocked	Bool		Is purchasing blocked.
PurchasingBlockingReasonCode	String		Purchasing blocking reason code.
IsAutoGenerationOfPurchaseOrdersAllowed	Bool		Is auto generation of purchase orders allowed.

Suppliers

Retrieve vendor supplier information.

View-Specific Information

Select

The Sync App uses the SAP Ariba API to process WHERE clause conditions built with the following columns and operators. The Sync App processes other filters client-side within the Sync App.

SMVendorId supports the '=' comparison operator.

For example, the following query is processed server side:

SELECT * FROM Suppliers WHERE SMVendorId = 'S123456'

Columns


Name	Type	References	Description
SMVendorId [KEY]	String	Vendors.SMVendorId	A unique ID that SAP Ariba assigns automatically.
DeletionIndicator	Bool		Indicator for deletion.
VatLiability	Bool		VAT liability information.
BpKeyMappings	String		Business partner key mappings.
ResponsibleTypeCode	String		Code for the responsible type.
AccountingInformation	String		Accounting information.
PurchasingArrangements	String		Purchasing arrangements information.
IsPurchasingBlocked	Bool		Indicator for whether purchasing is blocked.
PurchasingBlockingReasonCode	String		Reason code for purchasing blocking.
IsPaymentBlocked	Bool		Indicator for whether payment is blocked.
PaymentBlockingReasonCode	String		Reason code for payment blocking.
IsPostingBlocked	Bool		Indicator for whether posting is blocked.
PostingBlockingReasonCode	String		Reason code for posting blocking.

VendorDetails

Retrieve vendor details.

View-Specific Information

Select

The Sync App uses the SAP Ariba API to process WHERE clause conditions built with the following columns and operators. The Sync App processes other filters client-side within the Sync App.

SMVendorId supports the '=' comparison operator.

For example, the following query is processed server side:

SELECT * FROM VendorDetails WHERE SMVendorId = 'S123456'

Columns


Name	Type	References	Description
SMVendorId [KEY]	String	Vendors.SMVendorId	A unique ID that SAP Ariba assigns automatically.
InternalId	String		The internal identifier.
DisplayId	String		Display identifier.
IsBlocked	Bool		Indicator for whether the record is blocked.
Roles	String		Roles associated with the record.
Purposes	String		Purposes associated with the record.
Identifications	String		Identifications associated with the record.
BankAccounts	String		Bank accounts associated with the record.
TaxNumbers	String		Tax numbers associated with the record.
AddressData	String		Address data associated with the record.
CustomerInformation	String		Customer information associated with the record.
SupplierInformation	String		Supplier information associated with the record.
BpKeyMappings	String		Business partner key mappings.
BusinessPartnerType	String		Type of business partner.
BusinessPartnerGroupGroupTypeCode	String		Code for the type of business partner group.
BusinessPartnerGroupPrimaryGroupName	String		Primary name of the business partner group.
BusinessPartnerGroupPrimaryGroupNameScriptVariants	String		Script variants for the primary name of the business partner group.
BusinessPartnerGroupSecondaryGroupName	String		Secondary name of the business partner group.
BusinessPartnerGroupSecondaryGroupNameScriptVariants	String		Script variants for the secondary name of the business partner group.
GroupingCode	String		The vendor's grouping code.
LifecycleStatusCode	String		Code indicating the lifecycle status.
OrganizationFoundationDate	Date		Foundation date of the organization.
OrganizationLiquidationDate	Date		Liquidation date of the organization.
OrganizationTradingPartnerId	String		Trading partner identifier of the organization.
OrganizationGlobalLocationNumber	String		Global Location Number (GLN) of the organization.
OrganizationIndustries	String		Industries associated with the organization.
OrganizationLegalFormCode	String		Code for the legal form of the organization.
OrganizationNameDetailsNameFormat	String		Name format in the organization name details.
OrganizationNameDetailsFormattedPersonName	String		Formatted person name in the organization details.
OrganizationNameDetailsInitials	String		Initials associated with the organization name details.
OrganizationNameDetailsFirstName	String		First name in the name details of the organization.
OrganizationNameDetailsBirthName	String		Birth name in the organization name details.
OrganizationNameDetailsNickName	String		Nickname in the organization name details.
OrganizationNameDetailsMiddleName	String		Middle name in the name details of the organization.
OrganizationNameDetailsLastName	String		Last name in the name details of the organization.
OrganizationNameDetailsSecondLastName	String		Second last name in the name details of the organization.
OrganizationNameDetailsScriptVariants	String		Script variants in the organization name details.
OrganizationNameDetailsAcademicTitle	String		Academic title associated with the organization name details.
OrganizationNameDetailsAdditionalAcademicTitle	String		Additional academic title associated with the organization name details.
OrganizationNameDetailsNamePrefix	String		Name prefix used in the organization name details.
OrganizationNameDetailsAdditionalNamePrefix	String		Additional name prefix in the organization name details.
OrganizationNameDetailsNameSuffix	String		Name suffix in the organization name details.
OrganizationNameDetailsNameCountry	String		Country associated with the organization name details.
OrganizationNameDetailsFormattedOrgName	String		Formatted organization name details.
OrganizationNameDetailsFormattedOrgNameLine1	String		Line 1 of the formatted organization name details.
OrganizationNameDetailsFormattedOrgNameLine2	String		Line 2 of the formatted organization name details.
OrganizationNameDetailsFormattedOrgNameLine3	String		Line 3 of the formatted organization name details.
OrganizationNameDetailsFormattedOrgNameLine4	String		Line 4 of the formatted organization name details.
OrganizationNameDetailsFormOfAddressCode	String		Code representing the form of address for the organization name.
PersonEmployerName	String		The person's employer's name.
PersonBirthDate	Date		Birth date of the person.
PersonBirthplaceName	String		The birthplace name of the person.
PersonOccupationCode	String		The occupation code of the person.
PersonNationalityCode	String		Code for the nationality of the person.
PersonLanguageCode	String		Code for the language of the person.
PersonCorrespondenceLanguageCode	String		Code for the correspondence language of the person.
PersonGenderCode	String		Code for the gender of the person.
PersonMaritalStatusCode	String		The marital status code of the person.
PersonNameDetailsInitials	String		Initials in the name details of the person.
PersonNameDetailsFormattedPersonName	String		Formatted name details of the person.
PersonNameDetailsFirstName	String		First name in the name details of the person.
PersonNameDetailsMiddleName	String		Middle name in the name details of the person.
PersonNameDetailsLastName	String		Last name in the name details of the person.
PersonNameDetailsSecondLastName	String		Second last name in the name details of the person.
PersonNameDetailsScriptVariants	String		Script variants in the name details of the person.
PersonNameDetailsAcademicTitleCode	String		Academic title code in the name details of the person.
PersonNameDetailsAdditionalAcademicTitleCode	String		Additional academic title code in the name details of the person.
PersonNameDetailsNamePrefixCode	String		Prefix code in the name details of the person.
PersonNameDetailsAdditionalNamePrefixCode	String		Additional prefix code in the name details of the person.
PersonNameDetailsNameSuffixCode	String		Suffix code in the name details of the person.
PersonNameDetailsFormOfAddressCode	String		Code for the form of address in the name details of the person.
SearchTermsSearchTerm1	String		Search term 1 for the vendor.
SearchTermsSearchTerm2	String		Search term 2 for the vendor.

Vendors

Retrieve all vendors.

View-Specific Information

Select

The Sync App uses the SAP Ariba API to process WHERE clause conditions built with the following columns and operators. The Sync App processes other filters client-side within the Sync App.

SMVendorId supports the '=,IN' comparison operators.
ERPVendorId supports the '=,IN' comparison operators.
RegistrationStatus supports the '=,IN' comparison operators.
QualificationStatus supports the '=,IN' comparison operators.
LastUpdateDate supports the '<=,<,=,>,>=' comparison operators.
PreferredLevel supports the '=,IN' comparison operators.
BusinessUnit supports the '=,IN' comparison operators.
Category supports the '=,IN' comparison operators.
Region supports the '=,IN' comparison operators.

For example, the following queries are processed server side:

SELECT * FROM Vendors WHERE SMVendorId = 'S123456'

SELECT * FROM Vendors WHERE RegistrationStatus = 'Registered'

SELECT * FROM Vendors WHERE QualificationStatus = 'Qualified'

SELECT * FROM Vendors WHERE LastUpdateDate > '2018-09-29T12:20:51Z' AND LastUpdateDate < '2019-10-04T12:20:51Z' 

SELECT * FROM Vendors WHERE PreferredLevel = 1

SELECT * FROM Vendors WHERE BusinessUnit = '408'

SELECT * FROM Vendors WHERE Category = '51'

SELECT * FROM Vendors WHERE Region = 'USA'

Columns


Name	Type	References	Description
SMVendorId [KEY]	String		A unique ID that SAP Ariba assigns automatically.
DuplicateSMVendorId	String		Duplicate vendor ID.
ERPVendorId	String		A mandatory ID, which must be unique in combination with the supplier's source system.
ANId	String		The Ariba Network ID.
ACMId	String		A unique ID assigned by SAP Ariba used for identification internally within SAP Ariba applications.
DUNSId	String		Data Universal Numbering System ID.
MasterVendorId	String		The master vendor ID.
Name2	String		Second name field.
Name3	String		Third name field.
Name4	String		Fourth name field.
Creator	String		Creator of the record.
Approved	Bool		Approval status of the record.
SourceSystem	String		Source system of the record.
IndustryCode	String		Code for the industry of the record.
BlockedStatus	String		Blocked status of the record.
RelationshipEstablishedType	String		Type of relationship established.
MainVendorType	Bool		Main vendor type in the record.
IntegratedToERP	String		Indicator for integration with ERP.
RegistrationStatus	String		Registration status of the record.
Qualifications	String		Qualifications associated with the record.
QualificationStatus	String		Qualification status of the record.
TaxInfos	String		Taxation related data.
BankInfos	String		Bank related data.
CompanyCodes	String		Company code related details.
SupplierName	String		Name of the supplier.
PrimarySupplierManager	String		Primary supplier manager.
AlternateSupplierManager	String		Alternate supplier manager.
TransactionalSupplier	Bool		Transactional supplier.
TransactionalSupplierRequestStatus	String		Status of transactional supplier request.
PrimaryContactFirstName	String		First name of the primary contact.
PrimaryContactMiddleName	String		Middle name of the primary contact.
PrimaryContactLastName	String		Last name of the primary contact.
PrimaryContactEmail	String		Email of the primary contact.
AddressLine1	String		Line 1 of the address.
AddressLine2	String		Line 2 of the address.
AddressLine3	String		Line 3 of the address.
AddressCity	String		City in the address.
AddressPOBox	String		PO Box in the address.
AddressRegionCode	String		Region code in the address.
AddressCountryCode	String		Country code in the address.
AddressPostalCode	String		Postal code in the address.
FormOfAddressCode	String		Code for the form of address.
RecordCreatedDate	Datetime		The creation date of the record.
LastIntegrationState	String		Last integration state of the record.
LastConfirmationState	String		Last confirmation state of the record.
LastReviewDate	Datetime		Date of the last review.
LastStatusChangeDate	Datetime		Date of the last status change.
LastUpdateDate	Datetime		Date of the last update.
PreferredLevel	Int		Preferred status. A number between 1 and 5. 1 is the highest preferred level and 5 is the lowest.
BusinessUnit	String		A business unit or department ID loaded in your site as master data and used in supplier management projects.
Category	String		A category ID loaded in your site as master data and used in supplier management projects.
Region	String		A region code loaded in your site as master data and used in supplier management projects.

Sourcing Project Management API V2 データモデル

概要

このセクションでは、Sourcing Project Management API で利用可能なオブジェクトを示し、SQL の使用についての詳細を説明します。

主要機能

Sync App は、条件、プロジェクト、ドキュメントなどのSAP Ariba エンティティをリレーショナルビューとしてモデル化し、SQL を記述してSAP Ariba データをクエリできるようにします。
ストアドプロシージャを使用するとSAP Ariba の操作を実行できます。
これらのオブジェクトへのライブ接続により、Sync App を使用するとアカウントへのあらゆる変更が即座に反映されます。

テーブル

テーブルでは、利用可能なテーブルを説明します。テーブルは、Projects、Teams、TeamUsers のようなリソースを静的にモデル化するように定義されています。

ビュー

ビューは、Documents、Tasks、TeamGroups のようなリソースをモデル化する読み取り専用のテーブルです。

ストアドプロシージャ

ストアドプロシージャは、データソースのファンクションライクなインターフェースです。ドキュメントのダウンロード、タスクコメントの添付ファイルのダウンロード、OAuth トークン管理の実行に使用できます。

テーブル

Sync App はSAP Ariba のデータを、標準のSQL ステートメントを使用してクエリできるリレーショナルデータベースのテーブルのリストとしてモデル化します。

SAP Ariba Source Connector for CData Sync テーブル


Name	Description
Projects	Retrieve details about the specified sourcing project.
Teams	Retrieve teams information specified in a sourcing project.
TeamUsers	Retrieve team user information specified in a sourcing project.

Projects

Retrieve details about the specified sourcing project.

View-Specific Information

Select

The Sync App uses the SAP Ariba API to process WHERE clause conditions built with the following columns and operators. The Sync App processes other filters client-side within the Sync App.

ProjectId supports the '=' comparison operator.

For example, the following query is processed server side:

SELECT * FROM Projects WHERE ProjectId = 'WS12345'

Update

You can update projects by executing UPDATE statements with a Project Id. For example:

UPDATE Projects SET Title='Sourcing Project',Status='Gray',State='Active',Currency='USD',Description='Sourcing Project' WHERE ProjectId = 'WS12345'

Columns


Name	Type	ReadOnly	References	Description
ProjectId [KEY]	String	False		Specifies the internal Id of the sourcing project.
DisplayVersion	String	False		Specifies the sourcing project version. Ignored for POST and PUT requests.
ParentProjectId	String	False		Specifies the internal ID of the parent project. A value in this field indicates that the project is a subproject.
ParentProjectTitle	String	False		Specifies the title of the parent project. Value is present when it is a subproject.
LocalizedParentProjectTitle	String	False		Indicates that internationalization is supported.
ParentDocumentId	String	False		Specifies the internal ID of the parent project. Value is present when sourcing project is a subproject.
ParentIdsTitlesMap	String	False		Specifies the custom data type that contains keys and values to represent different objects.
PredecessorProjectId	String	False		Specifies the internal ID of the predecessor project. Present only for follow-on projects.
PredecessorProjectName	String	False		Specifies the title of the predecessor project. Present only for follow-on projects.
PredecessorProjectsMap	String	False		Predecessor projects map.
FollowOnProjectsMap	String	False		Indicates a follow on project. Value is present only when you create a sourcing project using a guided sourcing template.
CopyFromProjectId	String	False		Copy from project id.
TemplateProjectTitle	String	False		Specifies the template name used when creating this full sourcing project.
TemplateProjectInternalId	String	False		Specifies the internal ID of the sourcing template to use or used when creating this sourcing project. Required for POST requests; ignored in all other requests. Example, Try it out with: SYS0208.
TemplateQuestions	String	False		Specifies questions defined within a template.
HasEditTemplatePermission	Bool	False		Has edit template permission.
ProcessId	String	False		Indicates a unique process ID for the template that was used to create the project. Example: PI26620833.
ProcessStatus	String	False		Process Status. By default, this field has the \\'Enable for template Field Setter\\' option enabled, and a template can be configured to set the field value based on the response to a template question or when a task is completed.
State	String	False		Specifies the project state. When creating a project, the only valid values are Active and Planned. Planned indicates the project has not begun; if you set this to Planned, you can also specify a Planned Start Date and Planned End Date. The states 'On Hold', 'Completed' and 'Cancelled' are available while editing the project. Required for PUT requests.
Status	String	False		Indicates the status of the sourcing project. Possible values: Gray: New project, Green: On track, Yellow: At-risk, Red: Off track. Required for PUT requests.
Title	String	False		Specifies the title (name) of the sourcing project. Required for PUT requests. Example, Try it out with: title.
LocalizedTitle	String	False		Indicates that internationalization is supported.
BaseLanguage	String	False		Specifies the language used in the sourcing project if there is no translated text for the user's language.
Description	String	False		Specifies the description of the sourcing project.
Origin	String	False		Specifies the sourcing project origin. Ignored for POST and PUT requests. Possible values: 0: OriginAriba, 1: OriginExternal, 2: OriginProcurement, 3: OriginGuidedBuying, 4: OriginSpendVisibility, 5: OriginProductSourcing, 6: OriginCategoryBuyer, 7: OriginS4HANA, 8: OriginCentralProcurement.
Regions	String	False		Specifies the geographic regions for the project or event. The values for this field can be used to pre-populate projects and events with team members, content, and approvers specific to the region.
Departments	String	False		The departments or internal business units in your organization involved in the event.
Commodities	String	False		Specifies the commodities for the project or event. Your company might refer to commodities as categories, UNSPSC codes, or by another term. An example of a commodity is office supplies. The values for this field can be used to pre-populate projects with team members, content, and approvers specific to the commodity.
Permissions	String	False		Permissions.
AllowedTasks	String	False		Allowed tasks.
ProjectReason	String	False		Specifies the reason for the project execution. It is used for reporting purposes only.
ExecutionStrategy	String	False		Specifies the strategy planned to be used to execute the project. An offline project is executed outside of Ariba Sourcing. Supplier Performance refers to an SPM project. Low-cost country sourcing refers to acquiring materials from countries with lower labor and production costs. This field is populated from the project header. This field is used only for reporting.
GettingStarted	String	False		Getting started.
PlannedEventType	String	False		Specifies the type of event planned to be used in the project. Possible values: RFI, RFP, Auction, and Forward Auction. This field is used only for reporting. This field is present if the project state is Planned.
IsProjectWatched	Bool	False		Is project watched.
IsSourcingRequest	Bool	False		Is sourcing request.
SourcingMechanism	String	False		Specifies the system from which this project originated. Example: Ariba (indicates Ariba sourcing services), Internal (indicates SAP Ariba Sourcing resources that are internal to your company), Other (a sourcing resource that is neither internal to your company nor Ariba sourcing services).
Currency	String	False		Project currency. Required for PUT requests. Example, Try it out with: USD.
ContractMonths	Double	False		Contract months.
MessageBoardId	String	False		Specifies the internal ID of the NoteBox, which contains the threads and posts of a given workspace.
IsTest	Bool	False		Is test.
LastModified	Datetime	False		Last modified.
CreateDate	Datetime	False		Create date.
BeginDate	Datetime	False		Specifies the start date for the sourcing project.
DueDate	Datetime	False		Due date.
EndDate	Datetime	False		End date.
PlannedStartDate	Datetime	False		Specifies the planned start date and time for the sourcing project.
PlannedEndDate	Datetime	False		Specifies the planned end date and time for the sourcing project.
ContractEffectiveDate	Datetime	False		Contract effective date.
TargetSavingPct	Double	False		Specifies the percentage of target savings you want to obtain as a result of the project.
ActualSavingPct	Double	False		Specifies the percentage of savings you want to obtain as a result of the project.
ActualSavingAmount	Decimal	False		Actual saving amount.
ActualSavingCurrency	String	False		Actual saving currency.
BaselineSpendAmount	Decimal	False		Indicates the spend amount expected to be covered by this project.
BaselineSpendCurrency	String	False		Indicates the spend amount expected to be covered by this project.
BusinessSystemBusinessSystemId	String	False		Name of the external system (ERP) that the project is integrated with.
BusinessSystemBusinessSystemName	String	False		Name of the external system (ERP) that the project is integrated with.
BusinessSystemBusinessSystemType	String	False		Name of the external system (ERP) that the project is integrated with.
BusinessSystemCompanyCode	String	False		Name of the external system (ERP) that the project is integrated with. Specifies the custom data type that contains keys and values to represent different objects.
BusinessSystemDocumentCategory	String	False		Name of the external system (ERP) that the project is integrated with. Specifies the custom data type that contains keys and values to represent different objects.
BusinessSystemDocumentType	String	False		Name of the external system (ERP) that the project is integrated with. Specifies the custom data type that contains keys and values to represent different objects.
BusinessSystemPurchasingGroup	String	False		Name of the external system (ERP) that the project is integrated with. Specifies the custom data type that contains keys and values to represent different objects.
BusinessSystemPurchasingOrganization	String	False		Name of the external system (ERP) that the project is integrated with. Specifies the custom data type that contains keys and values to represent different objects.
BusinessSystemPaymentTerms	String	False		Name of the external system (ERP) that the project is integrated with. Specifies the custom data type that contains keys and values to represent different objects.
OwnerOrganization	String	False		Owner organization.
OwnerOrgANId	String	False		Specifies the Ariba Network ID for a user's organization.
OwnerOrgName	String	False		Specifies the organization name of the user.
OwnerTimeZoneID	String	False		Specifies the user's time zone.
OwnerEmailAddress	String	False		Specifies the email address for the user.
OwnerName	String	False		Specifies the user's full name (for GET responses).
OwnerUniqueName	String	False		Specifies the unique name for the user; used as a login ID.
OwnerPasswordAdapter	String	False		Specifies the password adapter to authenticate the user. Example: PasswordAdapter1 or SourcingSupplierUser.
OwnerIsRecommended	Bool	False		Owner is recommended.
FlattenedOwnerUsers	String	False		Flattened owner users.

Teams

Retrieve teams information specified in a sourcing project.

View-Specific Information

Select

The Sync App uses the SAP Ariba API to process WHERE clause conditions built with the following columns and operators. The Sync App processes other filters client-side within the Sync App.

Id supports the '=' comparison operator.
ProjectId supports the '=' comparison operator.

For example, the following queries are processed server side:

SELECT * FROM Teams WHERE Id = 'PG17371157'

SELECT * FROM Teams WHERE ProjectId = 'WS12345'

Update

The list of users and groups in a project team can be updated by executing UPDATE statements. Note that this Replaces all users or groups in the team with the users or groups specified in the request body.

Users and groups cannot be updated in the same statement.

For example:

UPDATE Teams SET Users='[{"uniqueName":"test","passwordAdapter":"pass"}]' WHERE ProjectId='WS12345' AND Id='PG14510'
UPDATE Teams SET ChildGroups='[{"uniqueName":"testGroup"}]' WHERE ProjectId='WS12345' AND Id='PG14510'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	String	False		Specifies the unique name for the project group.
Name	String	False		Specifies the name for the project group.
NameDefaultTranslation	String	False		Specifies the default translation for project group's name.
Type	String	False		Specifies if team is of type ProjectGroup or GlobalGroup.
Roles	String	False		Specifies the roles assigned to this project group.
IsGlobal	Bool	False		Indicates whether the group is a global group defined for the entire site. If true, this is a global group.
IsDeletable	Bool	False		Indicates whether the group can be deleted. If true, this group can be deleted.
IsEditable	Bool	False		Indicates whether the group can be edited. If true, this group can be edited.
IsOwner	Bool	False		Indicates whether the group has Project Owner capabilities. If true, this group has Project Owner capabilities.
Users	String	False		Specifies the users in this project group.
ChildGroups	String	False		Specifies the child groups defined for this project group.
ProjectId [KEY]	String	False	Projects.InternalId	Specify the unique identifier of the sourcing project for which you want to fetch task details. Example, Try it out with: WS17371155.

TeamUsers

Retrieve team user information specified in a sourcing project.

View-Specific Information

Select

The Sync App uses the SAP Ariba API to process WHERE clause conditions built with the following columns and operators. The Sync App processes other filters client-side within the Sync App.

TeamId supports the '=' comparison operator.
ProjectId supports the '=' comparison operator.

For example, the following queries are processed server side:

SELECT * FROM TeamUsers WHERE TeamId = 'PG17371157'

SELECT * FROM TeamUsers WHERE ProjectId = 'WS12345'

Insert

Users can be added to a specific project team by executing INSERT statements. A user is uniquely identified by a combination of uniqueName and passwordAdapter. For example:

INSERT INTO TeamUsers (UniqueName,PasswordAdapter, TeamId) VALUES ('testName','1234','100')

Columns


Name	Type	ReadOnly	References	Description
TeamId [KEY]	String	False	Teams.Id	Specifies the unique identifier of the project group.
TeamName	String	False		Specifies the name of the project group.
TeamType	String	False		Specifies the type of the project group. Possible values- ProjectGroup, GlobalGroup.
Type	String	False		Specifies the user type.
Name	String	False		Specifies the full name of the user.
UniqueName [KEY]	String	False		Specifies the unique name of the user.
PasswordAdapter	String	False		Specifies the password adapter of the user.
EmailAddress	String	False		Specifies the email address of the user.
TimeZoneId	String	False		Specifies time zone for the user. Example: Asia/Kolkata.
Organization	String	False		Specifies the organization name of the user.
ProjectId [KEY]	String	False	Projects.InternalId	Specify the unique identifier of the sourcing project for which you want to fetch task details. Example, Try it out with: WS17371155.

ビュー

ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。

クエリは、ビューに対して通常のテーブルと同様に実行することができます。

SAP Ariba Source Connector for CData Sync ビュー


Name	Description
Documents	Gets IDs and header information for all documents in a specified sourcing project.
History	Gets all history specified in a sourcing project.
TaskActiveApproverUsers	Retrieve task active approver users.
TaskApprovalRequests	Retrieve task approval requests.
TaskApproverGroups	Retrieve task approver groups.
TaskApprovers	Retrieve all task approvers.
TaskCommentAttachments	Retrieve all task comments attachments.
TaskComments	Retrieve all tasks comments of a specified task.
Tasks	Retrieve all tasks specified in a sourcing project.
TeamGroups	Retrieve team group information specified in a sourcing project.

Documents

Gets IDs and header information for all documents in a specified sourcing project.

View-Specific Information

Select

The Sync App uses the SAP Ariba API to process WHERE clause conditions built with the following columns and operators. The Sync App processes other filters client-side within the Sync App.

InternalId supports the '=' comparison operator.
ProjectId supports the '=' comparison operator.

For example, the following queries are processed server side:

SELECT * FROM Documents WHERE InternalId = 'Doc17975275'

SELECT * FROM Documents WHERE ProjectId = 'WS12345'

Columns


Name	Type	References	Description
InternalId [KEY]	String		Specifies the internal ID of the document, assigned by SAP Ariba.
DocVersion	String		Specifies the document version. Ignored for POST and PUT requests.
VersionComment	String		Specifies comments given for the document version. Ignored for POST and PUT requests.
AvailableDocumentActions	String		Specifies actions associated with documents. Possible actions are - Create Folder, Upload Document, Delete Document, Edit Document, Copy Document, Move Document, Publish Document, Lock Document, Unlock Document, Add Document, Save As New Version, Delete Old Version, Revert Version, Replace Document, Delete Document Old Version.
Title	String		Specifies the title (name) of the document.
LocalizedTitle	String		Specifies the locale ID and title of the document.
BaseLanguage	String		Specifies the language used in the sourcing project if there is no translated text for the user's language.
Description	String		Specifies the description of the document.
Type	String		Specifies the document's type. (doc/Choice/Workspace).
Status	String		Specifies the status of the document. Possible values: Pending Selection, Draft, Complete.
AllowedTasks	String		Specifies the tasks allowed for the documents. Possible values: Todo, Review, Approval.
IconType	String		Specifies the document's type. (doc/Choice/Sourcing Project).
DocType	String		Specifies the document type - UI name of the document type. . Possible values: Document, Choice, Sourcing Project.
DocumentCreateType	String		Specifies the document type. This value is available only when the type is choice. Example: ariba. sourcing. rfx. RFXDocument.
FlattenedOwnerUsers	String		Flattened owner users.
LastModified	Datetime		Specifies the date and time the event was last modified. Example: 2022-03-30T06: 55: 08. 978+0000.
CreateDate	Datetime		Specifies the date and time the sourcing project was created. Example: 2022-03-24T16: 50: 16. 242+0000.
IsLocked	Bool		Whether this is locked.
ProcessId	String		A unique process ID.
InternalStatus	String		The internal status of the document.
ParentId	String		Specifies the internal ID of the document's parent folder, assigned by SAP Ariba. Ignored for POST requests.
ParentProjectId	String		Internal ID of the sourcing project, assigned by SAP Ariba. Ignored for POST requests.
ParentIdsTitlesMap	String		Specifies the list of parent project details id and name.
ParentProjectTitle	String		Specifies the parent project title. Example: Sourcing Full Project.
LocalizedParentProjectTitle	String		Specifies the locale ID and title of the parent document.
ParentProjectType	String		Specifies the parent project type. Possible values: CLASSIC_FULL_PROJECT, CLASSIC_QUICK_PROJECT.
LastModifiedByOrgANId	String		Specifies the Ariba Network ID for a user's organization.
LastModifiedByTimeZoneID	String		Specifies the user's time zone.
LastModifiedByLocaleID	String		Specifies the user's locale.
LastModifiedByName	String		Specifies the user's full name (for GET responses).
LastModifiedByOrgName	String		Specifies the organization name of the user.
LastModifiedByUniqueName	String		Specifies the unique name for the user; used as a login ID.
LastModifiedByOrganization	String		Last modified by organization.
LastModifiedByEmailAddress	String		Specifies the email address for the user.
LastModifiedByPasswordAdapter	String		Specifies the password adapter to authenticate the user. Example: PasswordAdapter1 or SourcingSupplierUser.
LastModifiedByIsRecommended	Bool		Last modified by is recommended.
OwnerName	String		User's full name (for GET responses).
OwnerUniqueName	String		Unique name for the user; used as a login ID.
OwnerPasswordAdapter	String		Password adapter to authenticate the user. Example: PasswordAdapter1 or SourcingSupplierUser.
OwnerIsRecommended	Bool		Owner is recommended.
ProjectId [KEY]	String	Projects.InternalId	Specify the unique identifier of the sourcing project for which you want to fetch task details. Example, Try it out with: WS17371155.

History

Gets all history specified in a sourcing project.

View-Specific Information

Select

The Sync App uses the SAP Ariba API to process WHERE clause conditions built with the following columns and operators. The Sync App processes other filters client-side within the Sync App.

ProjectId supports the '=' comparison operator.

For example, the following query is processed server side:

SELECT * FROM History WHERE ProjectId = 'WS12345'

Columns


Name	Type	References	Description
Id [KEY]	Long		Specifies ID of the history record of the sourcing project.
Title	String		Specifies the title of the respective history record.
Details	String		Specifies the sourcing project details. Possible values: active, inactive.
Type	String		Specifies the type of object for the history record. Possible values: Document, Workspace, Folder.
Description	String		Specifies the description related to the sourcing project. Possible values: startDate, status,owner.
Timestamp	Datetime		Specifies the date and time of the respective history record.
EffectiveUserName	String		Specifies the name of the user.
EffectiveUserUniqueName	String		Specifies the unique name of the user.
EffectiveUserEmailAddress	String		Specifies the email address of the user.
RealUserName	String		Specifies the name of the user.
RealUserUniqueName	String		Specifies the unique name of the user.
RealUserEmailAddress	String		Specifies the email address of the user.
ProjectId [KEY]	String	Projects.InternalId	Specify the unique identifier of the sourcing project for which you want to fetch task details. Example, Try it out with: WS17371155.

TaskActiveApproverUsers

Retrieve task active approver users.

View-Specific Information

Select

The Sync App uses the SAP Ariba API to process WHERE clause conditions built with the following columns and operators. The Sync App processes other filters client-side within the Sync App.

ProjectId supports the '=' comparison operator.

For example, the following query is processed server side:

SELECT * FROM TaskActiveApproverUsers WHERE ProjectId = 'WS12345'

Columns


Name	Type	References	Description
TaskId [KEY]	String	Tasks.InternalId	Specifies the internal ID of the task. Example: TSK13758.
Name	String		User's full name (for GET responses).
UniqueName [KEY]	String		Unique name for the user; used as a login ID.
PasswordAdapter	String		Password adapter to authenticate the user. Example: PasswordAdapter1 or SourcingSupplierUser.
IsRecommended	Bool		Is recommended.
ProjectId [KEY]	String	Projects.InternalId	Specify the unique identifier of the sourcing project for which you want to fetch task details. Example, Try it out with: WS17371155.

TaskApprovalRequests

Retrieve task approval requests.

View-Specific Information

Select

The Sync App uses the SAP Ariba API to process WHERE clause conditions built with the following columns and operators. The Sync App processes other filters client-side within the Sync App.

ProjectId supports the '=' comparison operator.

For example, the following query is processed server side:

SELECT * FROM TaskApprovalRequests WHERE ProjectId = 'WS12345'

Columns


Name	Type	References	Description
TaskId [KEY]	String	Tasks.InternalId	Specifies the internal ID of the task. Example: TSK13758.
ApprovalReqId [KEY]	String		Specifies the user ID of the approval requester. Example: useraaa.
Dependencies	String		Specifies the internal ID of the task that was chosen as a predecessor while creating a todo task.
Reason	String		Specifies if a task action is required or optional. Optional tasks can be canceled to dismiss them with no further action. Example: Action is Required.
Status	String		Specifies the status of the task. When approver performs approval, the possible values are: Approved, Rejected, Denied, Ready for approval, Pending for approval.
ApprovalRequired	Bool		Indicates whether approval is required.
UserApprovers	String		Lists users, who are approvers specified during the creation of approval task.
ApproverUsers	String		Lists all the active approver users expanded from groups in the approval flow.
ApproverGroups	String		Lists all groups.
ReadOnly	Bool		Indicates read-only task.
Dependency	String		Specifies the internal ID of the predecessor phase for the task. Example: AAP8AGSUT9UgV. Specifies the internal ID of the predecessor phase for the task. Example: AAP8AGSUT9UgV.
DependencyDependencies	String		Specifies the internal ID of the predecessor phase for the task. Example: AAP8AGSUT9UgV. Specifies the internal ID of the task that was chosen as a predecessor while creating a todo task.
DependencyApprovalReqId	String		Specifies the internal ID of the predecessor phase for the task. Example: AAP8AGSUT9UgV. Specifies the user ID of the approval requester. Example: useraaa.
DependencyReason	String		Specifies the internal ID of the predecessor phase for the task. Example: AAP8AGSUT9UgV. Specifies if a task action is required or optional. Optional tasks can be canceled to dismiss them with no further action. Example: Action is Required.
DependencyStatus	String		Specifies the internal ID of the predecessor phase for the task. Example: AAP8AGSUT9UgV. Specifies the status of the task. When approver performs approval, the possible values are: Approved, Rejected, Denied, Ready for approval, Pending for approval.
DependencyApprovalRequired	Bool		Specifies the internal ID of the predecessor phase for the task. Example: AAP8AGSUT9UgV. Indicates whether approval is required.
DependencyUserApprovers	String		Specifies the internal ID of the predecessor phase for the task. Example: AAP8AGSUT9UgV. Lists users, who are approvers specified during the creation of approval task.
DependencyApproverUsers	String		Specifies the internal ID of the predecessor phase for the task. Example: AAP8AGSUT9UgV. Lists all the active approver users expanded from groups in the approval flow.
DependencyApproverGroups	String		Specifies the internal ID of the predecessor phase for the task. Example: AAP8AGSUT9UgV. Lists all groups.
DependencyReadOnly	Bool		Specifies the internal ID of the predecessor phase for the task. Example: AAP8AGSUT9UgV. Indicates read-only task.
ProjectId [KEY]	String	Projects.InternalId	Specify the unique identifier of the sourcing project for which you want to fetch task details. Example, Try it out with: WS17371155.

TaskApproverGroups

Retrieve task approver groups.

View-Specific Information

Select

The Sync App uses the SAP Ariba API to process WHERE clause conditions built with the following columns and operators. The Sync App processes other filters client-side within the Sync App.

ProjectId supports the '=' comparison operator.

For example, the following query is processed server side:

SELECT * FROM TaskApproverGroups WHERE ProjectId = 'WS12345'

Columns


Name	Type	References	Description
TaskId [KEY]	String	Tasks.InternalId	Specifies the internal ID of the task. Example: TSK13758.
Name	String		Specifies the name for the project group.
UniqueName [KEY]	String		Specifies the unique name for the project group.
Roles	String		Specifies the roles assigned to this project group.
Users	String		Specifies users in this project group.
ChildGroups	String		Specifies the child groups defined for this project group.
IsGlobal	Bool		Indicates whether the group is a global group. If true, this is a global group (defined for the entire site). If false, this is a project group.
IsDeletable	Bool		Indicates whether the group can be deleted. If true, this group can be deleted.
IsEditable	Bool		Indicates whether the group can be edited. If true, this group can be edited.
IsOwner	Bool		Indicates whether the group has Project Owner capabilities. If true, this group has Project Owner capabilities.
ProjectId [KEY]	String	Projects.InternalId	Specify the unique identifier of the sourcing project for which you want to fetch task details. Example, Try it out with: WS17371155.

TaskApprovers

Retrieve all task approvers.

View-Specific Information

Select

The Sync App uses the SAP Ariba API to process WHERE clause conditions built with the following columns and operators. The Sync App processes other filters client-side within the Sync App.

ProjectId supports the '=' comparison operator.

For example, the following query is processed server side:

SELECT * FROM TaskApprovers WHERE ProjectId = 'WS12345'

Columns


Name	Type	References	Description
TaskId [KEY]	String	Tasks.InternalId	Specifies the internal ID of the task. Example: TSK13758.
Name	String		User's full name (for GET responses).
UniqueName [KEY]	String		Unique name for the user; used as a login ID.
PasswordAdapter	String		Password adapter to authenticate the user. Example: PasswordAdapter1 or SourcingSupplierUser.
IsRecommended	Bool		Is recommended.
ProjectId [KEY]	String	Projects.InternalId	Specify the unique identifier of the sourcing project for which you want to fetch task details. Example, Try it out with: WS17371155.

TaskCommentAttachments

Retrieve all task comments attachments.

View-Specific Information

Select

The Sync App uses the SAP Ariba API to process WHERE clause conditions built with the following columns and operators. The Sync App processes other filters client-side within the Sync App.

TaskId supports the '=' comparison operator.
ProjectId supports the '=' comparison operator.

For example, the following queries are processed server side:

SELECT * FROM TaskCommentAttachments WHERE TaskId = 'TSK17371161'

SELECT * FROM TaskCommentAttachments WHERE ProjectId = 'WS12345'

Columns


Name	Type	References	Description
TaskId [KEY]	String	Tasks.InternalId	Specifies internal Id of specified task.
CommentId [KEY]	String	TaskComments.Id	Specifies unique Id genarated for each task history record.
Id [KEY]	String		Specifies internal ID for the attachment, assigned by SAP Ariba.
FileName	String		Specifies name of the file.
DocumentType	String		Specifies the document's type. (doc/Choice/Workspace).
DocumentTypeUiName	String		Specifies the Document type. (Document/Choice/Sourcing Project) - UI name of the document type.
ContentType	String		Specifies MIME content type such as text/csv or image/png , this value is set based on the type of file.
Size	Long		Specifies length of the attachment, in bytes. Ignored in POST requests.
CanDownload	Bool		Set to true, when attachment/document is downloadable, otherwise false.
ProjectId [KEY]	String	Projects.InternalId	Specify the unique identifier of the sourcing project for which you want to fetch task details. Example, Try it out with: WS17371155.

TaskComments

Retrieve all tasks comments of a specified task.

View-Specific Information

Select

The Sync App uses the SAP Ariba API to process WHERE clause conditions built with the following columns and operators. The Sync App processes other filters client-side within the Sync App.

TaskId supports the '=' comparison operator.
IncludePreviousRounds supports the '=' comparison operator.
ProjectId supports the '=' comparison operator.

For example, the following queries areare processed server side:

SELECT * FROM TaskComments WHERE TaskId = 'TSK17371161'

SELECT * FROM TaskComments WHERE IncludePreviousRounds = 'true'

SELECT * FROM TaskComments WHERE ProjectId = 'WS12345'

Columns


Name	Type	References	Description
TaskId [KEY]	String	Tasks.InternalId	Specifies internal Id of specified task.
Id [KEY]	String		Specifies unique Id genarated for each task history record.
Comment	String		Comment.
Round	String		Specifies round number of the task.
User	String		User.
Attachments	String		Project TaskComment Attachment Details, Attachment which are downloadable or non-dowloadable can be identified by a flag canDownload.
AvailableActions	String		Available actions.
AccessControl	String		Access Control values can either allow or restrict the users who can view the content.
CreateDate	String		Specified the date on which comment is added to a specified task.
IncludePreviousRounds	Bool		If the value is set to true, comments from all the current and previous rounds are listed. If the value is set to false, only the current comments are retrieved. The default value is false.
ProjectId [KEY]	String	Projects.InternalId	Specify the unique identifier of the sourcing project for which you want to fetch task details. Example, Try it out with: WS17371155.

Tasks

Retrieve all tasks specified in a sourcing project.

View-Specific Information

Select

The Sync App uses the SAP Ariba API to process WHERE clause conditions built with the following columns and operators. The Sync App processes other filters client-side within the Sync App.

ProjectId supports the '=' comparison operator.

For example, the following query is processed server side:

SELECT * FROM Tasks WHERE ProjectId = 'WS12345'

Columns


Name	Type	References	Description
InternalId [KEY]	String		Specifies the internal ID of the task. Example: TSK13758.
ParentId	String		Specifies the parent ID of the task. Sets the phase ID only for the task created in a phase.
PreviousId	String		Specifies the internal ID of the previous task when there are multiple tasks associated with a project. For example, if three tasks are created in a sequence: Task1, Task2 and Task3, then Task2 will have the internal ID of Task1 as the previous ID. Similarly, Task3 will have the internal ID of Task2 as the previous ID.
Title	String		Specifies the title of the task.
LocalizedTaskName	String		Specifies the locale ID and task name of the task.
Status	String		Specifies the status of the task. For example: active, inactive.
AltStatus	String		Specifies the status of the task. Example: In Progress, Not Started.
InternalStatus	String		Specifies the internal task status. Example: InActive, Active.
Description	String		Specifies the task description.
Type	String		Specifies the task type.
InternalType	String		Specifies the internal task type. Example: ToDo, Approval.
Rank	Int		Specifies the rank given to a task.
Dependencies	String		Dependencies.
StartWhenDependenciesComplete	Bool		Start when dependencies complete.
AreDependenciesCompleted	Bool		If true, there are no predecessor tasks or all predecessor tasks are completed. If false, there are one or more predecessor tasks that must be completed before this task can be started.
AvailableTaskActions	String		Specifies actions task owners can perform on the task. Possible values: markStartedAction, markCompletedAction, editTaskAction, deleteTaskAction, associateDocumentAction, editTaskNotification, removeTaskDocumentAction, editTaskAction, deleteTaskAction.
Operation	String		Specifies the current operation being performed on task. Example: Launch Approval, Award Approval, Approval, review.
ReviewerCanEdit	Bool		Reviewer can edit.
ShowPerDocumentDraft	Bool		Show per document draft.
Alert	String		Specify the task priority to indicate a task with a particular risk. You can set the alert manually while creating a task. An icon is added to the right of the task, indicating that the task requires special attention. Possible values: Green: Not yet reached the due date, Yellow: At-risk and needs action, Red: Due date crossed and needs immediate action.
FromSomeTemplate	Bool		Indicates whether the item is created from a template item or a template prototype. It is true if an item was inherited from a project template. It is false if an item was not inherited from a project template.
IsRecurrenceWithOccurence	Bool		If true, this is a recurring phase plan.
ScheduledFrom	String		Specifies the internal ID of the previous schedule of a recurring phase to which the phase for the task belongs. Example: AAP8AGSUT9UgV.
CanSubmitWithoutApprover	Bool		Decides whether approver is required for task submission. If true, the task can be submitted with an empty approval flow. If false, the task cannot be submitted with an empty approval flow.
HasSchedule	Bool		Has schedule.
IsPhase	Bool		Indicates whether the task is a phase. If true, this is a phase.
IsMilestone	Bool		Select Yes to enable the milestone flag to appear next to the task. Use this to communicate the importance of specific tasks to your team.
IsRequired	Bool		Is required.
BeginDate	Datetime		Specifies the date and time the task was created.
PlannedBeginDate	Datetime		Specifies the date and time the task was created.
PlannedBeginDateOffset	Int		Specifies the date and time the task was created.
EndDate	Datetime		Specifies the date and time a task was completed or canceled. Example: 2022-05-31T00: 00: 00. 000+0000.
DueDate	Datetime		Specifies due date and time of the task. Example: 2022-03-31T00: 00: 00. 000+0000.
DueDateOffset	Int		Due date offset.
DueDateFieldPath	String		Due date field path.
LastModified	Datetime		Specifies the date and time the respective task is modified.
TimeCreated	Datetime		Time created.
ParentProjectId	String		Specifies parent project ID of the task.
ParentProjectTitle	String		Specifies the parent project title of the task.
ParentProjectType	String		Specifies the parent project type of the task.
LocalizedParentProjectTitle	String		Specifies the locale ID and title of the parent document.
ParentIdsTitlesMap	String		Specifies the ID and name of parent projects.
DocumentId	String		Specifies the internal ID of the document associated with the task. It is returned in the GET response if there is an associated document. Example: Doc1234.
DocumentProcessId	String		Specifies the process ID of the document associated with the task. It is returned in the GET response if there is an associated document.
DocumentName	String		Specifies the name of the document associated with the task. It is returned in the GET response if there is an associated document.
LocalizedDocumentName	String		Specifies the locale ID and document name of the task.
DocumentType	String		Specifies documents type. Example: doc, Choice, Workspace.
LockDocument	Bool		Lock document.
PerDocumentDraft	Bool		Per document draft.
ProcessId	String		Unique process ID of the task.
FlattenedOwnerUsers	String		Flattened owner users.
Approvers	String		Approvers.
ActiveApproverUsers	String		Specifies user details such as unique name, name, and password adapter for the active approvers.
ApproverGroups	String		Approver groups.
ApprovalRequests	String		Approval requests.
ExternalApprovalEnabled	Bool		Enable or disable external system approval. Possible values: Yes, No.
Observers	String		Specifies users who are assigned as observers for the task.
ObserverGroups	String		Observer groups.
Recipients	String		Specifies the recipients. Values are assigned if the task is of type NotifyTask or notification task.
RecipientGroups	String		Specifies the recipient groups. Values are assigned for notification tasks only (the task type is NotifyTask).
TaskNotificationProfiles	String		Task notification profiles.
OwnerGroupName	String		Specifies the name for the project group.
OwnerGroupUniqueName	String		Specifies the unique name for the project group.
OwnerGroupRoles	String		Specifies the roles assigned to this project group.
OwnerGroupUsers	String		Specifies users in this project group.
OwnerGroupChildGroups	String		Specifies the child groups defined for this project group.
OwnerGroupIsOwner	Bool		Indicates whether the group has Project Owner capabilities. If true, this group has Project Owner capabilities.
OwnerGroupIsGlobal	Bool		Indicates whether the group is a global group. If true, this is a global group (defined for the entire site). If false, this is a project group.
OwnerGroupIsEditable	Bool		Indicates whether the group can be edited. If true, this group can be edited.
OwnerGroupIsDeletable	Bool		Indicates whether the group can be deleted. If true, this group can be deleted.
OwnerUserName	String		User's full name (for GET responses).
OwnerUserUniqueName	String		Unique name for the user; used as a login ID.
OwnerUserPasswordAdapter	String		Password adapter to authenticate the user. Example: PasswordAdapter1 or SourcingSupplierUser.
OwnerUserIsRecommended	Bool		Owner user is recommended.
EnableNotificationOnComment	Bool		If true, SAP Ariba sends email notifications each time someone adds a comment to a task. SAP Ariba sends notifications to all users in the approval (or review) flow except pending approvers (or reviewers).
NotificationProfileInternalId	String		Specifies the internal ID of the task notification profile.
NotificationProfileName	String		Specifies the name of the task notification profile.
NotificationProfileType	Int		Specifies the task notification profile type.
NotificationProfileCompleteRecipients	String		Lists recipients who receive the task completion notifications.
NotificationProfileOverdueRecipients	String		Recipients to get notified for overdue.
NotificationProfileOverdueBegin	Int		Specifies the number of days after the task due date that must elapse before overdue notifications are sent.
NotificationProfileOverdueReminder	Int		Specifies the interval between overdue notifications (the frequency), in days.
NotificationProfilePendingRecipients	String		Specifies the recipients for pending notifications.
NotificationProfilePendingBegin	Int		Specifies the number of days before the task due date when pending notifications are sent.
NotificationProfilePendingReminder	Int		Specifies the interval between pending notifications (the frequency), in days.
NotificationProfileSendComplete	Bool		Indicates whether the notification is sent to the recipients.
NotificationProfileSendOverdue	Bool		Indicates whether the ontime status of the task is overdue. If true, the overdue notifications will be sent when the task is overdue. If false, the task overdue notifications will not be sent.
NotificationProfileSendPending	Bool		Indicates whether the notification is pending. If true, the task due date is within the period for sending pending notifications. If false, the task due date is not within the period for sending pending notifications.
NotificationScheduleFrequency	String		Specifies the frequency at which a notification task sends the notification.
NotificationScheduleOffset	Int		Specifies the day of a month on which the notification must be scheduled for a recurring task. Possible value: 1 - 31.
NotificationScheduleMultiple	Int		Specifies the number of units for the task schedule.
NotificationScheduleNeedsManualCompletion	Bool		Indicates whether the manual completion is required.
NotificationScheduleShouldAutoStartSchedule	Bool		Specifies whether a notification task or phase in a full project should start after predecessor tasks or phases are completed, rather than requiring a project owner or task owner to start it manually. Templates cannot be modified using the API. This field can only be set at the template and project levels for full projects.
NotificationScheduleFirstSendDate	Datetime		Indicates the date and time a notification task sends the first notification. It is calculated based on the values in the Notification schedule fields.
NotificationScheduleFinalSendDate	Datetime		Indicates the date and time a notification task sends the final notification. It is calculated based on the values in the Notification schedule fields.
NotificationScheduleFinalSendDateFieldPath	String		Notification schedule final send date field path.
NotificationScheduleBeforeOrAfter	Int		Indicates the number of days before or after the due date. For example, the value -1 indicates that this is a schedule for pending notifications (notifications sent before a task is due) and 1 indicates that this is a schedule for overdue notifications (notifications sent after a task is due).
ScheduleFrequency	String		Specifies the unit of time for the task schedule. Possible values: Once, Month, Week, Day.
ScheduleOffset	Int		Specifies the day of a month on which the notification must be scheduled for a recurring task. Possible value: 1 - 31.
ScheduleMultiple	Int		Specifies the number of units for the task schedule.
ProjectId [KEY]	String	Projects.InternalId	Specify the unique identifier of the sourcing project for which you want to fetch task details. Example, Try it out with: WS17371155.

TeamGroups

Retrieve team group information specified in a sourcing project.

View-Specific Information

Select

The Sync App uses the SAP Ariba API to process WHERE clause conditions built with the following columns and operators. The Sync App processes other filters client-side within the Sync App.

TeamId supports the '=' comparison operator.
ProjectId supports the '=' comparison operator.

For example, the following queries are processed server side:

SELECT * FROM TeamGroups WHERE TeamId = 'PG17371157'

SELECT * FROM TeamGroups WHERE ProjectId = 'WS12345'

Columns


Name	Type	References	Description
TeamId [KEY]	String	Teams.Id	Specifies the unique identifier of the project group.
TeamName	String		Specifies the name of the project group.
TeamType	String		Specifies the type of the project group. Possible values- ProjectGroup, GlobalGroup.
Id [KEY]	String		Specifies the unique identifier for the project group.
Name	String		Specifies the name of the project group.
Type	String		Specifies the type of the project group. Possible values- ProjectGroup, GlobalGroup.
ProjectId [KEY]	String	Projects.InternalId	Specify the unique identifier of the sourcing project for which you want to fetch task details. Example, Try it out with: WS17371155.

Contract API V1 データモデル

概要

このセクションでは、Contract API で利用可能なオブジェクトを示し、SQL の使用についての詳細を説明します。

主要機能

Sync App は、条件、ワークスペース、ドキュメントプロパティなどのSAP Ariba 契約エンティティをリレーショナルビューとしてモデル化し、SQL を記述してSAP Ariba データをクエリできるようにします。
ストアドプロシージャを使用するとSAP Ariba の操作を実行できます。
これらのオブジェクトへのライブ接続により、Sync App を使用するとアカウントへのあらゆる変更が即座に反映されます。

ビュー

ビューは、SAP Ariba 契約をモデル化する読み取り専用のテーブルです。

ストアドプロシージャ

ストアドプロシージャは、データソースのファンクションライクなインターフェースです。これらを使用して、データソース内の情報を検索、更新、および変更できます。

ビュー

ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。

クエリは、ビューに対して通常のテーブルと同様に実行することができます。

SAP Ariba Source Connector for CData Sync ビュー


Name	Description
AffectedParties	Retrieve contract workspace affected parties.
CreationSupplierClassifications	Retrieve contract workspace creation supplier classifications.
IntegrationSupplierClassifications	Retrieve contract workspace integration supplier classifications.
LineItemDocumentProperties	Retrieve Contract Line Items Document metadata.
PublishingSupplierClassifications	Retrieve contract workspace publishing supplier classifications.
Terms	Retrieve the contract terms document details and the associated compliance contract details.
Workspaces	Retrieve contract workspaces.

AffectedParties

Retrieve contract workspace affected parties.

View-Specific Information

Select

The Sync App uses the SAP Ariba API to process WHERE clause conditions built with the following columns and operators. The Sync App processes other filters client-side within the Sync App.

ContractId supports the '=' comparison operator.

For example, the following query is processed server side:

SELECT * FROM AffectedParties WHERE ContractId = 'CW0001'

Columns


Name	Type	References	Description
ContractId [KEY]	String	Workspaces.ContractId	ID of the contract.
SystemID [KEY]	String		The System ID of the affected party.
SmVendorID	String		A unique ID that SAP Ariba assigns automatically.
Name	String		The name of the affected party.
IsBlocked	Bool		Whether this record is blocked.
OrganizationIDs	String		The organization IDs for the affected party.
AddressName	String		Name associated with the address.
AddressUniqueName	String		Unique name associated with the address.
AddressPhone	String		Phone number associated with the address.
AddressFax	String		Fax number associated with the address.
AddressLines	String		Lines in the address.
AddressCity	String		City in the address.
AddressState	String		State in the address.
AddressCountry	String		Country in the address.
AddressPostalCode	String		Postal code in the address.

CreationSupplierClassifications

Retrieve contract workspace creation supplier classifications.

View-Specific Information

Select

The Sync App uses the SAP Ariba API to process WHERE clause conditions built with the following columns and operators. The Sync App processes other filters client-side within the Sync App.

ContractId supports the '=' comparison operator.

For example, the following query is processed server side:

SELECT * FROM CreationSupplierClassifications WHERE ContractId = 'CW0001'

Columns


Name	Type	References	Description
ContractId [KEY]	String	Workspaces.ContractId	ID of the contract.
Name	String		Name.
ClassName	String		Class name.
UniqueName [KEY]	String		Unique name.
ProcessTypeUniquename	String		Unique name of the process type.
Value	String		Value associated with the record.
Key	String		Key associated with the record.
Active	Bool		Indicator for record activity.
Disabled	Bool		Indicator for record disablement.
ProjectStatus	String		Status of the project.

IntegrationSupplierClassifications

Retrieve contract workspace integration supplier classifications.

View-Specific Information

Select

The Sync App uses the SAP Ariba API to process WHERE clause conditions built with the following columns and operators. The Sync App processes other filters client-side within the Sync App.

ContractId supports the '=' comparison operator.

For example, the following query is processed server side:

SELECT * FROM IntegrationSupplierClassifications WHERE ContractId = 'CW0001'

Columns


Name	Type	References	Description
ContractId [KEY]	String	Workspaces.ContractId	ID of the contract.
Name	String		Name.
ClassName	String		Class name.
UniqueName [KEY]	String		Unique name.
ProcessTypeUniquename	String		Unique name of the process type.
Value	String		Value associated with the record.
Key	String		Key associated with the record.
Active	Bool		Indicator for record activity.
Disabled	Bool		Indicator for record disablement.
ProjectStatus	String		Status of the project.

LineItemDocumentProperties

Retrieve Contract Line Items Document metadata.

View-Specific Information

Select

The Sync App uses the SAP Ariba API to process WHERE clause conditions built with the following columns and operators. The Sync App processes other filters client-side within the Sync App.

The line item document's ID can be found in the user interface.

Id supports the '=' comparison operator.
ContractId supports the '=' comparison operator.

For example, the following queries are processed server side:

SELECT * FROM LineItemDocumentProperties WHERE Id = 'Doc27061'

SELECT * FROM LineItemDocumentProperties WHERE ContractId = 'CW0001'

Columns


Name	Type	References	Description
Id [KEY]	String	Terms.DocumentId	Specifies the document id of the CLID.
ContractId [KEY]	String	Workspaces.ContractId	Specify the ID of the contract workspace from where you want to search the metadata of the associated CLID. This is a required parameter. Try it out on Sandbox with: CW3150.
ParentFolderId	String		Specifies the contract workspace ID associated with the document ID of the CLID.
ProjectId	String		Specifies the contract workspace ID associated with the document ID of the CLID.
Version	Decimal		Specifies the current version of the CLID.
OtherVersion	String		Lists all the versions of the CLID.
Name	String		Specifies the document id of the CLID.
Owner	String		Specifies the name of the author of the CLID.
Size	Decimal		Specifies the size of the CLID.
Active	Bool		Specifies whether the CLID is active.
Status	String		Specifies the current status of the CLID.
Description	String		Provides a short description of the CLID.
Permissions	String		Specifies the access control values selected in the CLID.
DocumentType	String		Specifies the document type of the CLID.
BaseLanguage	String		Specifies the base language of the CLID.
ContentType	String		Specifies the content type of the CLID.
PublishRequiresApproval	Bool		Specifies whether an approval is required before publishing the CLID.
AllowAdvancedPricingConditions	Bool		Specifies whether the CLID is configured to allow advanced pricing conditions.
IsPublishRequired	Bool		Specifies whether the CLID must be published.
LastModifiedDate	String		Specifies the date when the CLID was last modified.
CreationDate	String		Specifies the date when the CLID was created.
ParticipantName	String		This is participant of the CLID. Specifies the name of the participant.
ParticipantUniqueName	String		This is participant of the CLID. Specifies the unique name of the participant.
ParticipantType	String		This is participant of the CLID. Specifies the type of the participant.
ParticipantPasswordAdapter	String		This is participant of the CLID. Specifies the mode of authentication used by the participant to login.

PublishingSupplierClassifications

Retrieve contract workspace publishing supplier classifications.

View-Specific Information

Select

The Sync App uses the SAP Ariba API to process WHERE clause conditions built with the following columns and operators. The Sync App processes other filters client-side within the Sync App.

ContractId supports the '=' comparison operator.

For example, the following query is processed server side:

SELECT * FROM PublishingSupplierClassifications WHERE ContractId = 'CW0001'

Columns


Name	Type	References	Description
ContractId [KEY]	String	Workspaces.ContractId	ID of the contract.
Name	String		Name.
ClassName	String		Class name.
UniqueName [KEY]	String		Unique name.
ProcessTypeUniquename	String		Unique name of the process type.
Value	String		Value associated with the record.
Key	String		Key associated with the record.
Active	Bool		Indicator for record activity.
Disabled	Bool		Indicator for record disablement.
ProjectStatus	String		Status of the project.

Terms

Retrieve the contract terms document details and the associated compliance contract details.

View-Specific Information

Select

The Sync App uses the SAP Ariba API to process WHERE clause conditions built with the following columns and operators. The Sync App processes other filters client-side within the Sync App.

ContractId supports the '=' comparison operator.

For example, the following query is processed server side:

SELECT * FROM Terms WHERE ContractId = 'CW0001'

Columns


Name	Type	References	Description
ContractId [KEY]	String	Workspaces.ContractId	ID of the contract.
DocumentId [KEY]	String		ID of the contract terms document in the contract workspace.
Version	String		Version of the contract terms document in the contract workspace.
Title	String		Title of the contract terms document in the contract workspace.
Owner	String		Owner of the contract terms document in the contract workspace.
Status	String		Status of the contract terms document in the contract workspace.
SspContractId	String		Contract ID (CID) of the compliance contract associated with the contract terms document.
SspContractRequestId	String		The contract request ID (CRID) of the compliance contract request associated with the contract terms document.
SspContractStatus	String		The status of the compliance contract associated with the contract terms document.
SspContractRequestStatus	String		The status of the compliance contract request associated with the contract terms document.
CreationDate	Datetime		The creation date of the contract terms document in the contract workspace.
LastModifiedDate	Datetime		The last modified date of the contract terms document in the contract workspace.

Workspaces

Retrieve contract workspaces.

View-Specific Information

Select

The Sync App uses the SAP Ariba API to process WHERE clause conditions built with the following columns and operators. The Sync App processes other filters client-side within the Sync App.

ContractId supports the '=' comparison operator.
ContractStatus supports the '=,IN' comparison operator.
LastModified supports the '<=,<,=,>,>=' comparison operators.

For example, the following queries are processed server side:

SELECT * FROM Workspaces WHERE ContractId = 'CW0001'

SELECT * FROM Workspaces WHERE ContractStatus = 'EXAMPLE'

SELECT * FROM Workspaces WHERE LastModified = 'Sat May 20 15:00:00 GMT 2020'

Columns


Name	Type	References	Description
ContractId [KEY]	String		ID of the contract.
InternalId	String		Internal ID of the contract.
Version	Long		Version of the contract.
TemplateId	String		Template ID of the contract.
RelatedId	String		Related ID of the contract.
EventInternalId	String		Internal ID of the event.
BusinessSystemId	String		Business system ID associated with the contract.
Title	String		Title of the contract.
EventTitle	String		Title of the event associated with the contract.
Description	String		Description of the contract.
Commodities	String		Commodities covered by the contract.
Regions	String		Regions covered by the contract.
Departments	String		Departments involved in the contract.
Questions	String		Questions related to the contract.
Active	Bool		Indicator for contract activity.
Origin	Int		Origin of the contract.
ContractStatus	String		Status of the contract.
AffectedParties	String		Parties affected by the contract.
HierarchicalType	String		Type of hierarchical relationship in the contract.
ParentAgreement	String		ID of the parent agreement.
BlockPublish	Bool		Indicator for blocking contract publishing.
AmendmentType	String		Type of amendment in the contract.
AmendmentReason	String		Reason for the amendment in the contract.
AccessControl	String		Access control information for the contract.
IsTestProject	Bool		Indicator for whether the contract is a test project.
ExpirationTermType	String		Type of expiration term in the contract.
AutoRenewalInterval	Long		Interval for auto-renewal of the contract.
MaximumNumberOfRenewals	Long		Maximum number of renewals allowed for the contract.
ContractCreationSupplierClassification	String		Supplier classification at contract creation.
ContractPublishingSupplierClassification	String		Supplier classification for contract publishing.
ContractIntegrationSupplierClassification	String		Supplier classification for contract integration.
AgreementDate	Datetime		Date when the agreement was established.
EffectiveDate	Datetime		Effective date of the contract.
ExpirationDate	Datetime		Expiration date of the contract.
CreationDate	Datetime		Date of contract creation.
LastModified	Datetime		Date of the last modification to the contract.
ContractAmount	Decimal		Amount associated with the contract.
ContractAmountCurrency	String		Currency of the contract amount.
OwnerUniqueName	String		Unique name of the owner.
OwnerPasswordAdapter	String		Password adapter for the owner.
OwnerNetworkUserId	String		Network user ID of the owner.
OwnerNetworkPersonId	String		Network person ID of the owner.
OwnerOrganization	String		Organization associated with the owner.
OwnerOrgName	String		Organization name of the owner.
OwnerOrgANId	String		Organization Ariba Network ID of the owner.
OwnerName	String		Name of the owner.
OwnerPhone	String		Phone number of the owner.
OwnerEmailAddress	String		Email address of the owner.
OwnerTimeZoneId	String		The time zone ID of the owner.
OwnerLocaleId	String		The locale ID of the owner.
OwnerActive	Bool		If the owner is active.
OwnerIsSupportAdmin	Bool		Whether the owner is a support admin.
ProposedContractAmount	Decimal		Proposed amount for the contract.
ProposedContractAmountCurrency	String		Currency of the proposed contract amount.
RelatedFactoriesFactoriesList	String		List of related factories.
RelatedFactoriesIsRetrievalSuccessful	Bool		Indicator for the successful retrieval of related factories.
SupplierSystemID	String		System ID of the supplier.
SupplierOrganizationIDs	String		Organization IDs associated with the supplier.
SupplierSmVendorID	String		SM vendor ID of the supplier.
SupplierName	String		Name of the supplier.
SupplierIsBlocked	Bool		Whether the supplier is blocked.
SupplierAddressName	String		Name associated with the supplier's address.
SupplierAddressUniqueName	String		Unique name associated with the supplier's address.
SupplierAddressPhone	String		Phone number associated with the supplier's address.
SupplierAddressFax	String		Fax number associated with the supplier's address.
SupplierAddressLines	String		Lines in the supplier's address.
SupplierAddressCity	String		City in the supplier's address.
SupplierAddressState	String		State in the supplier's address.
SupplierAddressCountry	String		Country in the supplier's address.
SupplierAddressPostalCode	String		Postal code in the supplier's address.

Risk Category Information API For Supplier Risk Exposure V1 データモデル

概要

このセクションでは、Risk Category Information API For Supplier Risk Exposure V1 で利用可能なオブジェクトを示し、SQL の使用についての詳細を説明します。

主要機能

ストアドプロシージャを使用するとSAP Ariba の操作を実行できます。

ストアドプロシージャ

ストアドプロシージャは、データソースのファンクションライクなインターフェースです。これらを使用して、データソース内の情報を変更できます。

接続文字列オプション

接続文字列プロパティは、接続を確立するために使用できるさまざまなオプションです。このセクションでは、本プロバイダーの接続文字列で設定できるオプションの一覧を示します。詳細については各リンクをクリックしてください。

接続を確立する方法について詳しくは、接続の確立を参照してください。

Authentication

プロパティ	説明
API	provider にSAP Ariba データを取得させたいAPI を指定。
APIKey	使用するOAuth アプリケーションキー。
AuthScheme	SAP Ariba に接続する際に使用する認証の種類に設定。
Environment	SAP Ariba への接続に使用する環境。
DataCenter	アカウントのデータがホストされているデータセンター。
Realm	データにアクセスするレルムを指定。
ProjectId	情報を取得するソーシングプロジェクトのId。
User	SAP Ariba ユーザーのユーザーId。
PasswordAdapter	選択された User に紐付けられたパスワード。

OAuth

プロパティ	説明
OAuthClientId	カスタムOAuth アプリケーションの作成時に割り当てられたクライアントId を指定します。（コンシューマーキーとも呼ばれます。）このID は、カスタムアプリケーションをOAuth 認可サーバーに登録します。
OAuthClientSecret	カスタムOAuth アプリケーションの作成時に割り当てられたクライアントシークレットを指定します。（コンシューマーシークレットとも呼ばれます。）このシークレットは、カスタムアプリケーションをOAuth 認可サーバーに登録します。

SSL

プロパティ	説明
SSLServerCert	TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。

Firewall

プロパティ	説明
FirewallType	provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。
FirewallServer	ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。
FirewallPort	プロキシベースのファイアウォールで使用するTCP ポートを指定します。
FirewallUser	プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。
FirewallPassword	プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。

Proxy

プロパティ	説明
ProxyAutoDetect	provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。
ProxyServer	HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。
ProxyPort	クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバー（ProxyServer 接続プロパティで設定）のTCP ポート。
ProxyAuthScheme	ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。
ProxyUser	ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名。
ProxyPassword	ProxyUser 接続プロパティで指定されたユーザーに紐付けられたパスワード。
ProxySSLType	ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプ。
ProxyExceptions	ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。

Logging

プロパティ	説明
LogModules	ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。

Schema

プロパティ	説明
Location	テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。
BrowsableSchemas	レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
Tables	レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。
Views	レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。
TypeDetectionScheme	Determines how the data type of columns created from custom fields in the SupplierDataAPIWithPagination-V4 schema's Vendors view is determined.

Miscellaneous

プロパティ	説明
IncludeCustomFields	Determines whether the provider exposes custom fields in SAP Ariba tables as columns.
MaxRows	集計やGROUP BY を使用しないクエリで返される最大行数を指定します。
MaxThreads	Specifies the maximum number of concurrent requests the provider can execute to SAP Ariba.
Other	特定のユースケースに対して追加の隠しプロパティを指定します。これらは通常のprovider の機能では必要ありません。複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。
Pagesize	SAP Ariba から返される、1ページあたりの結果の最大数を指定します。この設定は、ほとんどのユースケースに最適化されている、データソースによって設定されたデフォルトのページサイズをオーバーライドします。
PseudoColumns	テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。
RowScanDepth	テーブルで利用可能なカラムを探すためにスキャンする行数の最大値。
Timeout	provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。
UserDefinedViews	カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。

Authentication

このセクションでは、本プロバイダーの接続文字列で設定可能なAuthentication プロパティの全リストを提供します。

プロパティ	説明
API	provider にSAP Ariba データを取得させたいAPI を指定。
APIKey	使用するOAuth アプリケーションキー。
AuthScheme	SAP Ariba に接続する際に使用する認証の種類に設定。
Environment	SAP Ariba への接続に使用する環境。
DataCenter	アカウントのデータがホストされているデータセンター。
Realm	データにアクセスするレルムを指定。
ProjectId	情報を取得するソーシングプロジェクトのId。
User	SAP Ariba ユーザーのユーザーId。
PasswordAdapter	選択された User に紐付けられたパスワード。

API

provider にSAP Ariba データを取得させたいAPI を指定。

解説

Sync App にSAP Ariba データを取得させたいAPI を指定。

APIKey

使用するOAuth アプリケーションキー。

解説

SAP Ariba OAuth アプリケーションキーは、OAuth アプリケーションが最初に作成されたときに生成されます。詳しくは、カスタムOAuth アプリの作成を参照してください。

AuthScheme

SAP Ariba に接続する際に使用する認証の種類に設定。

解説

OAuthClient：OAuth 2.0 クライアントクレデンシャルグラントタイプ認証を実行する場合に設定。

Environment

SAP Ariba への接続に使用する環境。

解説

PRODUCTION 環境は実際のデータを返し、アプリケーションに関連付けられます。

TEST 環境はモックデータを返し、アプリケーションに関連付けられます。

DataCenter

アカウントのデータがホストされているデータセンター。

解説

アカウントのデータがホストされているデータセンター。

Realm

データにアクセスするレルムを指定。

解説

データにアクセスするレルムを指定。

ProjectId

情報を取得するソーシングプロジェクトのId。

解説

情報を取得するソーシングプロジェクトのId。

User

SAP Ariba ユーザーのユーザーId。

解説

Sourcing Project Management API およびContract API へのリクエストには、ユーザーアカウントを含める必要があります。

このプロパティは、Sync App がAPI リクエストで使用するユーザーアカウントを指定します。

PasswordAdapter

選択された User に紐付けられたパスワード。

解説

Sourcing Project Management API およびContract API へのリクエストには、ユーザーアカウントを含める必要があります。

このプロパティは、選択されたUser アカウントを認証します。

OAuth

このセクションでは、本プロバイダーの接続文字列で設定可能なOAuth プロパティの全リストを提供します。

プロパティ	説明
OAuthClientId	カスタムOAuth アプリケーションの作成時に割り当てられたクライアントId を指定します。（コンシューマーキーとも呼ばれます。）このID は、カスタムアプリケーションをOAuth 認可サーバーに登録します。
OAuthClientSecret	カスタムOAuth アプリケーションの作成時に割り当てられたクライアントシークレットを指定します。（コンシューマーシークレットとも呼ばれます。）このシークレットは、カスタムアプリケーションをOAuth 認可サーバーに登録します。

OAuthClientId

カスタムOAuth アプリケーションの作成時に割り当てられたクライアントId を指定します。（コンシューマーキーとも呼ばれます。）このID は、カスタムアプリケーションをOAuth 認可サーバーに登録します。

解説

OAuthClientId は、ユーザーがOAuth 経由で認証を行う前に設定する必要があるいくつかの接続パラメータの1つです。詳細は接続の確立を参照してください。

OAuthClientSecret

カスタムOAuth アプリケーションの作成時に割り当てられたクライアントシークレットを指定します。（コンシューマーシークレットとも呼ばれます。）このシークレットは、カスタムアプリケーションをOAuth 認可サーバーに登録します。

解説

OAuthClientSecret は、ユーザーがOAuth 経由で認証を行う前に設定する必要があるいくつかの接続パラメータの1つです。詳細は接続の確立を参照してください。

SSL

このセクションでは、本プロバイダーの接続文字列で設定可能なSSL プロパティの全リストを提供します。

プロパティ	説明
SSLServerCert	TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。

SSLServerCert

TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。

解説

TLS/SSL 接続を使用する場合は、このプロパティを使用して、サーバーが受け入れるTLS/SSL 証明書を指定できます。コンピュータによって信頼されていない他の証明書はすべて拒否されます。

このプロパティは、次のフォームを取ります：


説明	例
フルPEM 証明書（例では省略されています）	-----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----
証明書を保有するローカルファイルへのパス。	C:\cert.cer
公開鍵（例では省略されています）	-----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----
MD5 Thumbprint （hex 値はスペースおよびコロン区切り）	ecadbdda5a1529c58a1e9e09828d70e4
SHA1 Thumbprint （hex 値はスペースおよびコロン区切り）	34a929226ae0819f2ec14b4a3d904f801cbb150d

これを指定しない場合は、マシンが信用するすべての証明書が受け入れられます。

すべての証明書の受け入れを示すには、'*'を使用します。セキュリティ上の理由から、これはお勧めできません。

Firewall

このセクションでは、本プロバイダーの接続文字列で設定可能なFirewall プロパティの全リストを提供します。

プロパティ	説明
FirewallType	provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。
FirewallServer	ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。
FirewallPort	プロキシベースのファイアウォールで使用するTCP ポートを指定します。
FirewallUser	プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。
FirewallPassword	プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。

FirewallType

provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。

解説

プロキシベースのファイアウォール（またはプロキシファイアウォール）は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

Note：デフォルトでは、Sync App はシステムプロキシに接続します。この動作を無効化し、次のプロキシタイプのいずれかに接続するには、ProxyAutoDetect をfalse に設定します。

次の表は、サポートされている各プロトコルのポート番号情報です。


プロトコル	デフォルトポート	説明
TUNNEL	80	Sync App がSAP Ariba への接続を開くポート。トラフィックはこの場所のプロキシを経由して行き来します。
SOCKS4	1080	Sync App がSAP Ariba への接続を開くポート。SOCKS 4 は次にFirewallUser 値をプロキシに渡し、接続リクエストが許容されるかどうかを決定します。
SOCKS5	1080	Sync App がSAP Ariba にデータを送信するポート。SOCKS 5 プロキシに認証が必要な場合には、FirewallUser およびFirewallPassword をプロキシが認識する認証情報に設定します。

HTTP プロキシへの接続には、ProxyServer およびProxyPort ポートを使ってください。HTTP プロキシへの認証には、ProxyAuthScheme、ProxyUser、およびProxyPassword を使ってください。

FirewallServer

ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。

解説

プロキシベースのファイアウォール（またはプロキシファイアウォール）は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

FirewallPort

プロキシベースのファイアウォールで使用するTCP ポートを指定します。

解説

プロキシベースのファイアウォール（またはプロキシファイアウォール）は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

FirewallUser

プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。

解説

プロキシベースのファイアウォール（またはプロキシファイアウォール）は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

FirewallPassword

プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。

解説

プロキシベースのファイアウォール（またはプロキシファイアウォール）は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

Proxy

このセクションでは、本プロバイダーの接続文字列で設定可能なProxy プロパティの全リストを提供します。

プロパティ	説明
ProxyAutoDetect	provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。
ProxyServer	HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。
ProxyPort	クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバー（ProxyServer 接続プロパティで設定）のTCP ポート。
ProxyAuthScheme	ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。
ProxyUser	ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名。
ProxyPassword	ProxyUser 接続プロパティで指定されたユーザーに紐付けられたパスワード。
ProxySSLType	ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプ。
ProxyExceptions	ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。

ProxyAutoDetect

provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。

解説

この接続プロパティをTrue に設定すると、Sync App は既存のプロキシサーバー構成についてシステムプロキシ設定をチェックします（プロキシサーバーの詳細を手動で入力する必要はありません）。

この接続プロパティは他のプロキシ設定より優先されます。特定のプロキシサーバーに接続するためにSync App を手動で構成する場合は、False に設定します。

HTTP プロキシへの接続には、ProxyServer を参照してください。SOCKS やトンネリングなどの他のプロキシには、FirewallType を参照してください。

ProxyServer

HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。

解説

ProxyAutoDetect がFalse に設定されている場合、Sync App はこの接続プロパティで指定されたプロキシサーバーを通じてのみHTTP トラフィックをルーティングします。ProxyAutoDetect がTrue に設定されている場合（デフォルト）、Sync App は代わりにシステムプロキシ設定で指定されたプロキシサーバーを介してHTTP トラフィックをルーティングします。

ProxyPort

クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバー（ProxyServer 接続プロパティで設定）のTCP ポート。

解説

ProxyAutoDetect がFalse に設定されている場合、Sync App はこの接続プロパティで指定されたプロキシサーバーポートを通じてのみHTTP トラフィックをルーティングします。ProxyAutoDetect がTrue に設定されている場合（デフォルト）、Sync App は代わりにシステムプロキシ設定で指定されたプロキシサーバーポートを介してHTTP トラフィックをルーティングします。

その他のプロキシタイプについては、FirewallType を参照してください。

ProxyAuthScheme

ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。

解説

認証タイプは次のいずれかです。

BASIC：Sync App はHTTP BASIC 認証を行います。
DIGEST：Sync App はHTTP DIGEST 認証を行います。
NTLM：Sync App はNTLM トークンを取得します。
NEGOTIATE：Sync App は認証において有効なプロトコルに応じて、NTLM もしくはKerberos トークンを取得します。
NONE：ProxyServer が認証を必要としない場合に設定します。

"NONE" 以外のすべての値については、ProxyUser およびProxyPassword 接続プロパティも設定する必要があります。

SOCKS 5 認証のような他の認証タイプを使用するには、FirewallType を参照してください。

ProxyUser

ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名。

解説

ProxyUser および ProxyPassword 接続プロパティは、ProxyServer で指定されたHTTP プロキシに対して接続よび認証するために使用されます。

ProxyAuthScheme で利用可能な認証タイプを1つ選択した後、このプロパティを以下のように設定します。


ProxyAuthScheme の値	ProxyUser に設定する値
BASIC	プロキシサーバーに登録されているユーザーのユーザー名。
DIGEST	プロキシサーバーに登録されているユーザーのユーザー名。
NEGOTIATE	プロキシサーバーが属するドメインまたは信頼されたドメイン内の有効なユーザーであるWindows ユーザーのユーザー名。`user@domain` または`domain\user` の形式で指定。
NTLM	プロキシサーバーが属するドメインまたは信頼されたドメイン内の有効なユーザーであるWindows ユーザーのユーザー名。`user@domain` または`domain\user` の形式で指定。
NONE	ProxyPassword 接続プロパティは設定しないでください。

Sync App は、ProxyAutoDetect がFalse に設定されている場合にのみ、このユーザー名を使用します。ProxyAutoDetect がTrue に設定されている場合（デフォルト）、Sync App は代わりにシステムのプロキシ設定で指定されているユーザー名を使用します。

ProxyPassword

ProxyUser 接続プロパティで指定されたユーザーに紐付けられたパスワード。

解説

ProxyUser および ProxyPassword 接続プロパティは、ProxyServer で指定されたHTTP プロキシに対して接続よび認証するために使用されます。

ProxyAuthScheme で利用可能な認証タイプを1つ選択した後、このプロパティを以下のように設定します。


ProxyAuthScheme の値	ProxyPassword に設定する値
BASIC	ProxyUser で指定したプロキシサーバーユーザーに紐付けられたパスワード。
DIGEST	ProxyUser で指定したプロキシサーバーユーザーに紐付けられたパスワード。
NEGOTIATE	ProxyUser で指定したWindows ユーザーアカウントに紐付けられたパスワード。
NTLM	ProxyUser で指定したWindows ユーザーアカウントに紐付けられたパスワード。
NONE	ProxyPassword 接続プロパティは設定しないでください。

SOCKS 5 認証もしくは、トンネリングは、FirewallType を参照してください。

Sync App は、ProxyAutoDetect がFalse に設定されている場合にのみ、このパスワードを使用します。ProxyAutoDetect がTrue に設定されている場合（デフォルト）、Sync App は代わりにシステムのプロキシ設定で指定されているパスワードを使用します。

ProxySSLType

ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプ。

解説

このプロパティは、ProxyServer で指定されたHTTP プロキシへの接続にSSL を使用するかどうかを決定します。この接続プロパティには、以下の値を設定できます。


AUTO	デフォルト設定。ProxyServer がHTTPS URL に設定されている場合、Sync App は、TUNNEL オプションを使用します。ProxyServer がHTTP URL に設定されている場合、コンポーネントはNEVER オプションを使用します。
ALWAYS	接続は、常にSSL 有効となります。
NEVER	接続は、SSL 有効になりません。
TUNNEL	接続はトンネリングプロキシ経由で行われます。プロキシサーバーがリモートホストへの接続を開き、プロキシを経由して通信が行われます。

ProxyExceptions

ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。

解説

ProxyServer は、このプロパティで定義されたアドレスを除くすべてのアドレスに使用されます。セミコロンを使用してエントリを区切ります。

Sync App はデフォルトでシステムプロキシ設定を使用するため、それ以上の設定は必要ありません。この接続にプロキシ例外を明示的に設定する場合は、ProxyAutoDetect をFalse に設定します。

Logging

このセクションでは、本プロバイダーの接続文字列で設定可能なLogging プロパティの全リストを提供します。

プロパティ	説明
LogModules	ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。

LogModules

ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。

解説

このプロパティは、含めるログモジュールを指定することでログファイルの内容をカスタマイズすることができます。ログモジュールは、クエリ実行、メタデータ、SSL 通信などの異なる領域にログ情報を分類します。各モジュールは4文字のコードで表され、文字の名前の場合は末尾にスペースが必要なものもあります。

例えば、EXEC はクエリ実行をログに記録し、INFO は一般的なプロバイダーメッセージをログに記録します。複数のモジュールを含めるには、次のように名前をセミコロンで区切ります：INFO;EXEC;SSL。

Verbosity 接続プロパティは、このプロパティで指定されたモジュールベースのフィルタリングよりも優先されます。 Verbosity レベルを満たし、指定されたモジュールに属するログエントリのみが記録されます。利用可能なすべてのモジュールをログファイルに含めるには、このプロパティを空白のままにします。

利用可能なモジュールの完全なリストとログの設定に関する詳細な手引きについては、ログの「高度なログの記録」セクションを参照してください。

Schema

このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。

プロパティ	説明
Location	テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。
BrowsableSchemas	レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
Tables	レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。
Views	レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。
TypeDetectionScheme	Determines how the data type of columns created from custom fields in the SupplierDataAPIWithPagination-V4 schema's Vendors view is determined.

Location

テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。

解説

Location プロパティは、定義をカスタマイズしたり（例えば、カラム名を変更する、カラムを無視するなど）、新しいテーブル、ビュー、またはストアドプロシージャでデータモデルを拡張する場合にのみ必要です。

指定しない場合、デフォルトの場所は%APPDATA%\\CData\\SAPAribaSource Data Provider\\Schema となり、%APPDATA%はユーザーのコンフィギュレーションディレクトリに設定されます：


プラットフォーム	%APPDATA%
Windows	APPDATA 環境変数の値
Linux	~/.config

BrowsableSchemas

レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。

解説

利用可能なデータベーススキーマをすべてリストすると余分な時間がかかり、パフォーマンスが低下します。接続文字列にスキーマのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。

Tables

レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。

解説

データベースによっては、利用可能なすべてのテーブルをリストするのに時間がかかり、パフォーマンスが低下する場合があります。接続文字列にテーブルのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。

利用可能なテーブルがたくさんあり、すでに作業したいテーブルが決まっている場合、このプロパティを使用して対象のテーブルのみに表示を制限することができます。これを行うには、カンマ区切りのリストで使用したいテーブルを指定します。各テーブルは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。例えば、Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space` です。

Note：複数のスキーマまたはカタログを持つデータソースに接続する場合は、表示する各テーブルを完全修飾名で指定する必要があります。これにより、複数のカタログやスキーマに存在するテーブルが混同されることを防ぎます。

Views

レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。

解説

データベースによっては、利用可能なすべてのビューをリストするのに時間がかかり、パフォーマンスが低下する場合があります。接続文字列にビューのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。

利用可能なビューがたくさんあり、すでに作業したいビューが決まっている場合、このプロパティを使用して対象のビューのみに表示を制限することができます。これを行うには、カンマ区切りのリストで使用したいビューを指定します。各ビューは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。例えば、Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space` です。

Note：複数のスキーマまたはカタログを持つデータソースに接続する場合は、確認する各ビューを完全修飾名で指定する必要があります。これにより、複数のカタログやスキーマに存在するビューが混同されることを防ぎます。

TypeDetectionScheme

Determines how the data type of columns created from custom fields in the SupplierDataAPIWithPagination-V4 schema's Vendors view is determined.

解説


None	Setting TypeDetectionScheme to None will return all columns as the string type.
RowScan	Setting TypeDetectionScheme to RowScan will scan rows to heuristically determine the data type. The RowScanDepth determines the number of rows to be scanned.

Miscellaneous

このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。

プロパティ	説明
IncludeCustomFields	Determines whether the provider exposes custom fields in SAP Ariba tables as columns.
MaxRows	集計やGROUP BY を使用しないクエリで返される最大行数を指定します。
MaxThreads	Specifies the maximum number of concurrent requests the provider can execute to SAP Ariba.
Other	特定のユースケースに対して追加の隠しプロパティを指定します。これらは通常のprovider の機能では必要ありません。複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。
Pagesize	SAP Ariba から返される、1ページあたりの結果の最大数を指定します。この設定は、ほとんどのユースケースに最適化されている、データソースによって設定されたデフォルトのページサイズをオーバーライドします。
PseudoColumns	テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。
RowScanDepth	テーブルで利用可能なカラムを探すためにスキャンする行数の最大値。
Timeout	provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。
UserDefinedViews	カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。

IncludeCustomFields

Determines whether the provider exposes custom fields in SAP Ariba tables as columns.

解説

Determines whether the Sync App exposes custom fields in SAP Ariba tables as columns.

MaxRows

集計やGROUP BY を使用しないクエリで返される最大行数を指定します。

解説

このプロパティは、集計やGROUP BY 句を含まないクエリに対してSync App が返す行数の上限を設定します。この制限により、クエリがデフォルトで過度に大きな結果セットを返さないようにします。

クエリにLIMIT 句が含まれている場合、クエリで指定された値がMaxRows 設定よりも優先されます。 MaxRows が"-1" に設定されている場合、LIMIT 句が明示的にクエリに含まれていない限り、行の制限は行われません。

このプロパティは、非常に大きなデータセットを返す可能性のあるクエリを実行する際に、パフォーマンスを最適化し過剰なリソース消費を防ぐのに役立ちます。

MaxThreads

Specifies the maximum number of concurrent requests the provider can execute to SAP Ariba.

解説

このプロパティを使用すると、複数のリクエストを同時に発行することができパフォーマンスが向上します。

Using more concurrent threads improves performance at the cost of additional memory usage.

Other

特定のユースケースに対して追加の隠しプロパティを指定します。これらは通常のprovider の機能では必要ありません。複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。

解説

このプロパティは、シニアユーザーが特定のシナリオに対して隠しプロパティを設定できるようにします。これらの設定は通常のユースケースには必要ありませんが、特定の要件に対応したり、追加の機能を提供したりすることができます。複数のプロパティをセミコロン区切りのリストで定義できます。

Note： 特定のシナリオや問題に対処するためにサポートチームから助言があった場合にのみ、これらのプロパティを設定することを強く推奨します。

複数のプロパティをセミコロン区切りリストで指定します。

統合およびフォーマット


DefaultColumnSize	データソースがメタデータにカラムの長さを提供しない場合に、文字列フィールドのデフォルトの長さを設定します。デフォルト値は2000です。
ConvertDateTimeToGMT	日時の値を、マシンのローカルタイムではなくGMT グリニッジ標準時に変換するかどうかを決定します。
RecordToFile=filename	基底のソケットデータ転送を指定のファイルに記録します。

Pagesize

SAP Ariba から返される、1ページあたりの結果の最大数を指定します。この設定は、ほとんどのユースケースに最適化されている、データソースによって設定されたデフォルトのページサイズをオーバーライドします。

解説

クエリする特定のオブジェクトやサービスエンドポイントの結果を最適化するために、デフォルトのページサイズを調整したい場合があります。ページサイズを大きくするとパフォーマンスが向上するかもしれませんが、ページあたりのメモリ消費量が増える可能性もあることに注意してください。

PseudoColumns

テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。

解説

このプロパティを使用すると、Sync App がテーブルカラムとして公開する擬似カラムを定義できます。

個々の擬似カラムを指定するには、以下の形式を使用します。"Table1=Column1;Table1=Column2;Table2=Column3"

すべてのテーブルのすべての擬似カラムを含めるには、次のようにします："*=*"

RowScanDepth

テーブルで利用可能なカラムを探すためにスキャンする行数の最大値。

解説

テーブルのカラムはテーブル行をスキャンすることで決定される必要があります。この値はスキャンされる行数の最大値を設定します。

大きい値を設定すると、パフォーマンスが低下する場合があります。小さい値を設定すると、特にnull データがある場合には、データ型を正しく判定できない場合があります。

Timeout

provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。

解説

このプロパティは、Sync App が操作をキャンセルする前に操作の完了を待機する最大時間を秒単位で制御します。操作の完了前にタイムアウト時間が経過すると、Sync App は操作をキャンセルして例外をスローします。

タイムアウトは、クエリや操作全体ではなくサーバーとの個々の通信に適用されます。例えば、各ページング呼び出しがタイムアウト制限内に完了する場合、クエリは60秒を超えて実行を続けることができます。

このプロパティを0に設定するとタイムアウトが無効になり、操作が成功するか、サーバー側のタイムアウト、ネットワークの中断、またはサーバーのリソース制限などの他の条件で失敗するまで無期限に実行されます。このプロパティは慎重に使用してください。長時間実行される操作がパフォーマンスを低下させたり、応答しなくなる可能性があるためです。

UserDefinedViews

カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。

解説

このプロパティを使用すると、UserDefinedViews.json というJSON 形式の構成ファイルを通じてカスタムビューを定義および管理できます。これらのビューはSync App によって自動的に認識され、標準のデータベースビューのようにカスタムSQL クエリを実行できるようになります。 JSON ファイルは、各ビューをルート要素として定義し、その子要素として"query" を持ちます。この"query" にはビューのSQL クエリが含まれています。次に例を示します。

{
	"MyView": {
		"query": "SELECT * FROM Vendors WHERE MyColumn = 'value'"
	},
	"MyView2": {
		"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
	}
}

このプロパティを使用して、1つのファイルに複数のビューを定義し、ファイルパスを指定できます。例：UserDefinedViews=C:\Path\To\UserDefinedViews.json。このプロパティを使用すると、指定されたビューのみがSync App によって検知されます。

詳しくは、ユーザー定義ビューを参照してください。

SAP Ariba Source Connector for CData Sync

SAP Ariba Source Connector for CData Sync

概要

SAP Ariba バージョンサポート

接続の確立

SAP Ariba への接続を追加

SAP Ariba への接続

SAP Ariba への認証

OAuthClient

OAuth の自動リフレッシュ

OAuth の手動リフレッシュ

カスタムOAuth アプリの作成

カスタムOAuth アプリの作成

高度な機能

ユーザー定義ビュー

SSL の設定

ファイアウォールとプロキシ

クエリ処理

ログ

SSL の設定

SSL 設定のカスタマイズ

ファイアウォールとプロキシ

Firewall またはProxy 経由の接続

HTTP プロキシ

その他のプロキシ

データモデル

Supplier Data API With Pagination V4 の利用

Sourcing Project Management API V2の利用

Contract API V1 の利用

Risk Category Information API For Supplier Risk Exposure V1 の利用

Supplier Data API With Pagination V4 データモデル

概要

主要機能

ビュー

ストアドプロシージャ

ビュー

SAP Ariba Source Connector for CData Sync ビュー

AddressEmailAddresses

View-Specific Information

Select

Columns

Addresses

View-Specific Information

Select

Columns

AddressFaxNumbers

View-Specific Information

Select

Columns

AddressPhoneNumbers

View-Specific Information

Select

Columns

AddressWebsites

View-Specific Information

Select

Columns

BankAccounts

View-Specific Information

Select

Columns

BankInfos

View-Specific Information

Select

Columns

CompanyCodes

View-Specific Information

Select

Columns

Contacts

View-Specific Information

Select

Columns

Customers

View-Specific Information

Select

Columns

CustomerSalesArrangements

View-Specific Information

Select