Cloud

Build 25.0.9434
  • SAP Ariba Source
    • はじめに
      • 接続の確立
      • カスタムOAuth アプリの作成
      • SSL の設定
      • ファイアウォールとプロキシ
    • データモデル
      • Supplier Data API With Pagination V4 データモデル
        • ビュー
          • AddressEmailAddresses
          • Addresses
          • AddressFaxNumbers
          • AddressPhoneNumbers
          • AddressWebsites
          • BankAccounts
          • BankInfos
          • CompanyCodes
          • Contacts
          • Customers
          • CustomerSalesArrangements
          • Identifications
          • InactiveVendors
          • Qualifications
          • Questionnaires
          • SupplierAccounting
          • SupplierPurchasingArrangements
          • Suppliers
          • VendorContacts
          • VendorDetails
          • Vendors
        • ストアドプロシージャ
      • Sourcing Project Management API V2 データモデル
        • テーブル
          • Projects
          • Teams
          • TeamUsers
        • ビュー
          • Documents
          • History
          • TaskActiveApproverUsers
          • TaskApprovalRequests
          • TaskApproverGroups
          • TaskApprovers
          • TaskCommentAttachments
          • TaskComments
          • Tasks
          • TeamGroups
        • ストアドプロシージャ
      • Contract API V1 データモデル
        • ビュー
          • AffectedParties
          • CreationSupplierClassifications
          • IntegrationSupplierClassifications
          • LineItemDocumentProperties
          • PublishingSupplierClassifications
          • Terms
          • Workspaces
        • ストアドプロシージャ
      • Risk Category Information API For Supplier Risk Exposure V1 データモデル
        • ストアドプロシージャ
          • AddComplianceData
          • AddCustomFieldValues
          • ReplaceComplianceData
      • システムテーブル
        • sys_catalogs
        • sys_schemas
        • sys_tables
        • sys_tablecolumns
        • sys_procedures
        • sys_procedureparameters
        • sys_keycolumns
        • sys_foreignkeys
        • sys_primarykeys
        • sys_indexes
        • sys_connection_props
        • sys_sqlinfo
        • sys_identity
        • sys_information
    • 接続文字列オプション
      • Authentication
        • API
        • APIKey
        • AuthScheme
        • Environment
        • DataCenter
        • Realm
        • ProjectId
        • User
        • PasswordAdapter
      • OAuth
        • OAuthClientId
        • OAuthClientSecret
      • SSL
        • SSLServerCert
      • Logging
        • Verbosity
      • Schema
        • BrowsableSchemas
        • TypeDetectionScheme
      • Miscellaneous
        • IncludeCustomFields
        • MaxRows
        • MaxThreads
        • Pagesize
        • PseudoColumns
        • RowScanDepth
        • Timeout
    • Third Party Copyrights

SAP Ariba Source - CData Cloud

概要

CData Cloud は、クラウドホスト型のソリューションで、複数の標準サービスやプロトコルにまたがるSAP Ariba へのアクセスを実現します。SQL Server データベースに接続できるアプリケーションであれば、CData Cloud を介してSAP Ariba に接続できます。

CData Cloud により、他のOData エンドポイントや標準SQL Server と同じように、SAP Ariba への接続を標準化し、構成することができます。

主要機能

  • SQL をフルサポート:SAP Ariba は、標準のリレーショナルデータベースとして表示され、Filter、Group、Join などの操作を実行できます。これらの操作は基盤となるAPI でサポートされているかどうかに関わらず、標準SQL を使用します。
  • CRUD サポート:読み取りと書き込みの両方の操作がサポートされており、Cloud またはデータソースのダウンストリームで設定できるセキュリティ設定によってのみ制限されます。
  • セキュアアクセス:管理者は、ユーザーを作成し、特定のデータベースへのアクセス、読み取り専用操作、または完全な読み書きの権限を定義することができます。
  • 包括的なデータモデルとダイナミックディスカバリー:CData Cloud は、動的データや検索可能なメタデータへのフルアクセスなど、基盤となるデータソースで公開されるすべてのデータへの包括的なアクセスを提供します。

CData Cloud

はじめに

このページでは、CData Cloud でのSAP Ariba への接続の確立 のガイド、利用可能なリソースに関する情報、および使用可能な接続プロパティのリファレンスについて説明します。

SAP Ariba への接続

接続の確立 は、CData Cloud にデータベースを作成するためのSAP Ariba への認証方法と必要な接続プロパティの設定方法について示します。

CData Cloud サービスからデータにアクセス

利用可能な標準サービスを経由してSAP Ariba からデータにアクセスする方法と、CData Cloud の管理については、CData Cloud ドキュメント で詳しく説明します。

CData Cloud

接続の確立

Database タブで対応するアイコンを選択して、SAP Ariba に接続します。必須プロパティはSettings にリストされています。Advanced タブには、通常は必要ない接続プロパティが表示されます。

SAP Ariba への接続

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

  • API:Cloud に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。

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

  1. Cloud はSAP Ariba からアクセストークンを取得し、それを使ってデータをリクエストします。
  2. Cloud はアクセストークンの期限が切れると自動的にリフレッシュします。
  3. 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 アクセストークンの自動リフレッシュ

Cloud が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 アクセストークンの有効期限が切れた後に手動でリフレッシュできるようにします。

CData Cloud

カスタムOAuth アプリの作成

カスタムOAuth アプリの作成

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

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

CData Cloud

SSL の設定

SSL 設定のカスタマイズ

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

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

CData Cloud

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

Firewall またはProxy 経由の接続

HTTP プロキシ

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

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

その他のプロキシ

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

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

CData Cloud

データモデル

CData Cloud は、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 データモデル を参照してください。

CData Cloud

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

概要

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

主要機能

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

ビュー

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

ストアドプロシージャ

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

CData Cloud

ビュー

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

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

CData Cloud - SAP Ariba Source ビュー

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.
InactiveVendors Retrieve all inactive vendors.
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.
VendorContacts Retrieve all vendors contacts.
VendorDetails Retrieve vendor details.
Vendors Retrieve all vendors.

CData Cloud

AddressEmailAddresses

Retrieve vendor address data email addresses.

View-Specific Information

Select

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

  • 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.

CData Cloud

Addresses

Retrieve vendor address data.

View-Specific Information

Select

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

  • 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.

CData Cloud

AddressFaxNumbers

Retrieve vendor address data fax numbers.

View-Specific Information

Select

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

  • 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.

CData Cloud

AddressPhoneNumbers

Retrieve vendor address data phone numbers.

View-Specific Information

Select

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

  • 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.

CData Cloud

AddressWebsites

Retrieve vendor address data websites.

View-Specific Information

Select

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

  • 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.

CData Cloud

BankAccounts

Retrieve vendor bank accounts.

View-Specific Information

Select

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

  • 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.

CData Cloud

BankInfos

Retrieve vendor bank related data.

View-Specific Information

Select

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

  • 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.

CData Cloud

CompanyCodes

Retrieve vendor company code related details.

View-Specific Information

Select

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

  • 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.

CData Cloud

Contacts

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

View-Specific Information

Select

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

  • 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.

CData Cloud

Customers

Retrieve vendor customer information.

View-Specific Information

Select

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

  • 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.

CData Cloud

CustomerSalesArrangements

Retrieve vendor customer information sales arrangements.

View-Specific Information

Select

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

  • 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.

CData Cloud

Identifications

Retrieve vendor identifications.

View-Specific Information

Select

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

  • 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.

CData Cloud

InactiveVendors

Retrieve all inactive vendors.

Columns

Name Type References Description
SMVendorId [KEY] String 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.
ANId String The Ariba Network ID.
ACMId String A unique ID assigned by SAP Ariba used for identification internally within SAP Ariba applications.
Name2 String Second name field.
Name3 String Third name field.
Name4 String Fourth name field.
IntegratedToERP String Indicator for integration with ERP.
RegistrationStatus String Registration status of the record.
QualificationStatus String Qualification status of the record.
SupplierName String Name of the supplier.
RecordCreatedDate Datetime The creation date of the record.
LastUpdateDate Datetime Date of the last update.

CData Cloud

Qualifications

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

View-Specific Information

Select

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

  • 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.

CData Cloud

Questionnaires

Retrieve vendor questionnaires.

View-Specific Information

Select

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

  • 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.

CData Cloud

SupplierAccounting

Retrieve vendor supplier accounting information.

View-Specific Information

Select

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

  • 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.

CData Cloud

SupplierPurchasingArrangements

Retrieve vendor supplier information purchasing arrangements.

View-Specific Information

Select

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

  • 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.

CData Cloud

Suppliers

Retrieve vendor supplier information.

View-Specific Information

Select

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

  • 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.

CData Cloud

VendorContacts

Retrieve all vendors contacts.

Columns

Name Type References Description
SupplierName String Name of the supplier.
SMVendorId 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.
ANId String The Ariba Network ID.
ACMId String A unique ID assigned by SAP Ariba used for identification internally within SAP Ariba applications.
FirstName String Contact First Name.
LastName String Contact Last Name.
MiddleName String Contact Middle Name.
Email String Contact Email.
Telephone String Contact Phone Number.
Title String Contact Title.
AODObjectId String AOD Id of the contact.
Categories String Contact Categories.
MobilePhone String Contact Mobile Phone.
Regions String Contact Regions.
S4UniqueName String Contact S4 Unique Name.
Type String Contact Type.
Locale String Contact Locale.
TimeZoneId String Contact Timezone Id.
Departments String Contact Departments.
MobileCountryName String Contact Mobile Country Name.
TelephoneCountryName String Contact Telephone Country Name.
Role String Contact Role.
LastUpdateDate Datetime Date of the last update.
RecordCreatedDate Datetime The creation date of the record.
IsPrimary Boolean Is Primary Contact.
IsActive Boolean Is Contact Active.

CData Cloud

VendorDetails

Retrieve vendor details.

View-Specific Information

Select

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

  • 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.

CData Cloud

Vendors

Retrieve all vendors.

View-Specific Information

Select

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

  • 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.

CData Cloud

ストアドプロシージャ

ストアドプロシージャはファンクションライクなインターフェースで、SAP Ariba の単純なSELECT/INSERT/UPDATE/DELETE 処理にとどまらずCloud の機能を拡張します。

ストアドプロシージャは、パラメータのリストを受け取り、目的の機能を実行し、プロシージャが成功したか失敗したかを示すとともにSAP Ariba から関連するレスポンスデータを返します。

CData Cloud - SAP Ariba Source ストアドプロシージャ

Name Description

CData Cloud

Sourcing Project Management API V2 データモデル

概要

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

主要機能

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

テーブル

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

ビュー

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

ストアドプロシージャ

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

CData Cloud

テーブル

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

CData Cloud - SAP Ariba Source テーブル

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.

CData Cloud

Projects

Retrieve details about the specified sourcing project.

View-Specific Information

Select

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

  • 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.

CData Cloud

Teams

Retrieve teams information specified in a sourcing project.

View-Specific Information

Select

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

  • 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.

CData Cloud

TeamUsers

Retrieve team user information specified in a sourcing project.

View-Specific Information

Select

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

  • 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.

CData Cloud

ビュー

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

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

CData Cloud - SAP Ariba Source ビュー

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.

CData Cloud

Documents

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

View-Specific Information

Select

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

  • 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.

CData Cloud

History

Gets all history specified in a sourcing project.

View-Specific Information

Select

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

  • 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.

CData Cloud

TaskActiveApproverUsers

Retrieve task active approver users.

View-Specific Information

Select

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

  • 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.

CData Cloud

TaskApprovalRequests

Retrieve task approval requests.

View-Specific Information

Select

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

  • 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.

CData Cloud

TaskApproverGroups

Retrieve task approver groups.

View-Specific Information

Select

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

  • 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.

CData Cloud

TaskApprovers

Retrieve all task approvers.

View-Specific Information

Select

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

  • 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.

CData Cloud

TaskCommentAttachments

Retrieve all task comments attachments.

View-Specific Information

Select

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

  • 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.

CData Cloud

TaskComments

Retrieve all tasks comments of a specified task.

View-Specific Information

Select

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

  • 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.

CData Cloud

Tasks

Retrieve all tasks specified in a sourcing project.

View-Specific Information

Select

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

  • 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.

CData Cloud

TeamGroups

Retrieve team group information specified in a sourcing project.

View-Specific Information

Select

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

  • 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.

CData Cloud

ストアドプロシージャ

ストアドプロシージャはファンクションライクなインターフェースで、SAP Ariba の単純なSELECT/INSERT/UPDATE/DELETE 処理にとどまらずCloud の機能を拡張します。

ストアドプロシージャは、パラメータのリストを受け取り、目的の機能を実行し、プロシージャが成功したか失敗したかを示すとともにSAP Ariba から関連するレスポンスデータを返します。

CData Cloud - SAP Ariba Source ストアドプロシージャ

Name Description

CData Cloud

Contract API V1 データモデル

概要

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

主要機能

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

ビュー

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

ストアドプロシージャ

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

CData Cloud

ビュー

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

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

CData Cloud - SAP Ariba Source ビュー

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.

CData Cloud

AffectedParties

Retrieve contract workspace affected parties.

View-Specific Information

Select

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

  • 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.

CData Cloud

CreationSupplierClassifications

Retrieve contract workspace creation supplier classifications.

View-Specific Information

Select

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

  • 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.

CData Cloud

IntegrationSupplierClassifications

Retrieve contract workspace integration supplier classifications.

View-Specific Information

Select

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

  • 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.

CData Cloud

LineItemDocumentProperties

Retrieve Contract Line Items Document metadata.

View-Specific Information

Select

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

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.

CData Cloud

PublishingSupplierClassifications

Retrieve contract workspace publishing supplier classifications.

View-Specific Information

Select

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

  • 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.

CData Cloud

Terms

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

View-Specific Information

Select

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

  • 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.

CData Cloud

Workspaces

Retrieve contract workspaces.

View-Specific Information

Select

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

  • 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.

CData Cloud

ストアドプロシージャ

ストアドプロシージャはファンクションライクなインターフェースで、SAP Ariba の単純なSELECT/INSERT/UPDATE/DELETE 処理にとどまらずCloud の機能を拡張します。

ストアドプロシージャは、パラメータのリストを受け取り、目的の機能を実行し、プロシージャが成功したか失敗したかを示すとともにSAP Ariba から関連するレスポンスデータを返します。

CData Cloud - SAP Ariba Source ストアドプロシージャ

Name Description

CData Cloud

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

概要

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

主要機能

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

ストアドプロシージャ

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

CData Cloud

ストアドプロシージャ

ストアドプロシージャはファンクションライクなインターフェースで、SAP Ariba の単純なSELECT/INSERT/UPDATE/DELETE 処理にとどまらずCloud の機能を拡張します。

ストアドプロシージャは、パラメータのリストを受け取り、目的の機能を実行し、プロシージャが成功したか失敗したかを示すとともにSAP Ariba から関連するレスポンスデータを返します。

CData Cloud - SAP Ariba Source ストアドプロシージャ

Name Description
AddComplianceData This operation will add compliance data for a single supplier. If the supplier does not already have compliance data, the new data is created. If the supplier already has compliance data, it is updated.
AddCustomFieldValues Adds values to custom fields configured for the specified supplier.
ReplaceComplianceData This operation will replace compliance data for a single supplier. To delete the existing compliance data for a specified supplier, send an empty request body. To replace the existing compliance data for a specified supplier, send the replacment data in the response body.

CData Cloud

AddComplianceData

This operation will add compliance data for a single supplier. If the supplier does not already have compliance data, the new data is created. If the supplier already has compliance data, it is updated.

Execute

This stored procedure includes a #TEMP table input. Below is an example execution.

The temporary table must be defined and used within the same connection. Closing the connection will clear out any temporary tables in memory.

INSERT INTO Evidences#TEMP (UniqueId, Source, Provider, PenaltyAmount, IsoCurrencyCode, Url, EffectiveStartDate, EffectiveEndDate, SupportingIndicatorStatus, Note) VALUES ('1', 'Test', 'providerName', '1000.5', 'USD', 'https://www.test.com', '2020-01-01', '2020-05-01', 'SANCTION', 'summary')
INSERT INTO Evidences#TEMP (UniqueId, Source, Provider, PenaltyAmount, IsoCurrencyCode, Url, EffectiveStartDate, EffectiveEndDate, SupportingIndicatorStatus, Note) VALUES ('2', 'example', 'anotherProvider', '750.25', 'EUR', 'https://www.test.com', '2021-03-15', '2021-08-15', 'WATCHLIST', 'description')

EXECUTE AddComplianceData
        SMVendorId               = 'S10666588',
        SanctionIndicatorStatus  = 'VIOLATION_FOUND',
        WatchlistIndicatorStatus = 'VIOLATION_NOT_FOUND',
        Note                     = 'Note.',
        Evidences                = 'Evidences#TEMP',

Evidences temporary table schema info:

Column NameTypeRequired Description
UniqueId stringFalse An ID that you provide to uniquely identify the evidence data. This isn't a mandatory field. You only need to provide this ID if you want to have the ability to update it later.
Source stringFalse The source is the origin of the evidence about the supplier. An example is when there are multiple articles supporting the evidence about the supplier, only the most relevant source is shown. You can use the information in the source to find articles from other sources. The URL for a source must start with https or http.
Provider stringFalse The provider of the compliance data for the supplier. Your provider can have evidence data from multiple sources.
PenaltyAmount decimalFalse The currency amount of any penalty applied to the supplier for the violation.
IsoCurrencyCode stringFalse The ISO 4217 currency code that represents the alphabetic currency for the penaltyAmount.
Url stringFalse The URL used to provide proof of the evidence. The URL is a clickable link. An example is a link to an article.
EffectiveStartDate dateFalse The date the compliance violation started.
EffectiveEndDate dateFalse The date the compliance violation ended.
SupportingIndicatorStatus stringFalse The fields from the risk configurations such as sanction and watchlist.
Note stringFalse Any note you add about the evidence of the supplier's violation. You can add a note of up to 3000 characters.

Input

Name Type Description
Realm String The requested realm.
SMVendorId String A unique ID that SAP Ariba assigns automatically.
SanctionIndicatorStatus String The status that tells you if a sanction was found for the supplier.

使用できる値は次のとおりです。VIOLATION_FOUND, VIOLATION_NOT_FOUND, VIOLATION_EXPIRED, NOT_SCREENED

WatchlistIndicatorStatus String The status that tells you if the supplier is on a watchlist.

使用できる値は次のとおりです。VIOLATION_FOUND, VIOLATION_NOT_FOUND, VIOLATION_EXPIRED, NOT_SCREENED

SupplierScreenedAt Date The date you screened the supplier for compliance data.
Note String Any note you add when you screen the supplier. You can add a note of up to 3000 characters.
Evidences String Evidence data.

Result Set Columns

Name Type Description
Success String Indicates whether or not the operation was successful.
Details String Any extra details on the operation's execution.

CData Cloud

AddCustomFieldValues

Adds values to custom fields configured for the specified supplier.

Execute

This stored procedure includes a #TEMP table input. Below is an example execution.

The temporary table must be defined and used within the same connection. Closing the connection will clear out any temporary tables in memory.

INSERT INTO CustomField#TEMP (FieldName, Value) VALUES ('TestRiskN', '12.4')
INSERT INTO CustomField#TEMP (FieldName, Value) VALUES ('TestRiskU', 'https://www.test.com')
INSERT INTO CustomField#TEMP (FieldName, Value) VALUES ('TestRiskD', '2022-01-01')
INSERT INTO CustomField#TEMP (FieldName, Value) VALUES ('TestRiskFT', 'Test')
INSERT INTO SupplierCustomFields#TEMP (SMVendorId, CustomFields) VALUES ('S10666490', 'CustomField#TEMP')

INSERT INTO CustomField1#TEMP (FieldName, Value) VALUES ('TestRiskT','Removed')
INSERT INTO CustomField1#TEMP (FieldName, Value) VALUES ('TestRiskN', '12.7')
INSERT INTO CustomField1#TEMP (FieldName, Value) VALUES ('TestRiskU', 'https://www.test.com')
INSERT INTO CustomField1#TEMP (FieldName, Value) VALUES ('TestRiskD', '2023-01-01')
INSERT INTO CustomField1#TEMP (FieldName, Value) VALUES ('TestRiskFT', 'Test2')
INSERT INTO SupplierCustomFields#TEMP (SMVendorId, CustomFields) VALUES ('S10667863', 'CustomField1#TEMP')

EXECUTE AddCustomFieldValues SupplierCustomFields = 'SupplierCustomFields#TEMP'

SupplierCustomFields temporary table schema info:

Column NameTypeRequired Description
SMVendorId stringFalse A unique ID that SAP Ariba assigns automatically.
CustomFields stringFalse The list of custom fields objects. Table reference: Internal_CustomField.rsd.

CustomField temporary table schema info:

Column NameTypeRequired Description
FieldName stringFalse The name of the custom field.
Value stringFalse The value for the custom field.
Url stringFalse The URL for the custom field.
Source stringFalse The source for the custom field.
Note stringFalse The note for the custom field.

Input

Name Type Description
Realm String The requested realm.
SupplierCustomFields String The list of suppliers and custom fields with values.

Result Set Columns

Name Type Description
Success String Indicates whether or not the operation was successful.
Details String Any extra details on the operation's execution.

CData Cloud

ReplaceComplianceData

This operation will replace compliance data for a single supplier. To delete the existing compliance data for a specified supplier, send an empty request body. To replace the existing compliance data for a specified supplier, send the replacment data in the response body.

Execute

This stored procedure includes a #TEMP table input. Below is an example execution.

The temporary table must be defined and used within the same connection. Closing the connection will clear out any temporary tables in memory.

INSERT INTO Evidences#TEMP (UniqueId, Source, Provider, PenaltyAmount, IsoCurrencyCode, Url, EffectiveStartDate, EffectiveEndDate, SupportingIndicatorStatus, Note) VALUES ('1', 'Test', 'providerName', '1000.5', 'USD', 'https://www.test.com', '2020-01-01', '2020-05-01', 'SANCTION', 'summary')
INSERT INTO Evidences#TEMP (UniqueId, Source, Provider, PenaltyAmount, IsoCurrencyCode, Url, EffectiveStartDate, EffectiveEndDate, SupportingIndicatorStatus, Note) VALUES ('2', 'example', 'anotherProvider', '750.25', 'EUR', 'https://www.test.com', '2021-03-15', '2021-08-15', 'WATCHLIST', 'description')

EXECUTE ReplaceComplianceData
        SMVendorId               = 'S10666588',
        SanctionIndicatorStatus  = 'VIOLATION_FOUND',
        WatchlistIndicatorStatus = 'VIOLATION_NOT_FOUND',
        Note                     = 'Note.',
        Evidences                = 'Evidences#TEMP',

To delete the existing compliance data for a specified supplier, only the SMVendorId needs to be specified.

EXECUTE ReplaceComplianceData SMVendorId = 'S10666588',

Evidences temporary table schema info:

Column NameTypeRequired Description
UniqueId stringFalse An ID that you provide to uniquely identify the evidence data. This isn't a mandatory field. You only need to provide this ID if you want to have the ability to update it later.
Source stringFalse The source is the origin of the evidence about the supplier. An example is when there are multiple articles supporting the evidence about the supplier, only the most relevant source is shown. You can use the information in the source to find articles from other sources. The URL for a source must start with https or http.
Provider stringFalse The provider of the compliance data for the supplier. Your provider can have evidence data from multiple sources.
PenaltyAmount decimalFalse The currency amount of any penalty applied to the supplier for the violation.
IsoCurrencyCode stringFalse The ISO 4217 currency code that represents the alphabetic currency for the penaltyAmount.
Url stringFalse The URL used to provide proof of the evidence. The URL is a clickable link. An example is a link to an article.
EffectiveStartDate dateFalse The date the compliance violation started.
EffectiveEndDate dateFalse The date the compliance violation ended.
SupportingIndicatorStatus stringFalse The fields from the risk configurations such as sanction and watchlist.
Note stringFalse Any note you add about the evidence of the supplier's violation. You can add a note of up to 3000 characters.

Input

Name Type Description
Realm String The requested realm.
SMVendorId String A unique ID that SAP Ariba assigns automatically.
SanctionIndicatorStatus String The status that tells you if a sanction was found for the supplier.

使用できる値は次のとおりです。VIOLATION_FOUND, VIOLATION_NOT_FOUND, VIOLATION_EXPIRED, NOT_SCREENED

WatchlistIndicatorStatus String The status that tells you if the supplier is on a watchlist.

使用できる値は次のとおりです。VIOLATION_FOUND, VIOLATION_NOT_FOUND, VIOLATION_EXPIRED, NOT_SCREENED

SupplierScreenedAt Date The date you screened the supplier for compliance data.
Note String Any note you add when you screen the supplier. You can add a note of up to 3000 characters.
Evidences String Evidence data.

Result Set Columns

Name Type Description
Success String Indicates whether or not the operation was successful.
Details String Any extra details on the operation's execution.

CData Cloud

システムテーブル

このセクションで説明されているシステムテーブルをクエリして、スキーマ情報、データソース機能に関する情報、およびバッチ操作の統計にアクセスできます。

スキーマテーブル

以下のテーブルは、SAP Ariba のデータベースメタデータを返します。

  • sys_catalogs:利用可能なデータベースをリスト。
  • sys_schemas:利用可能なスキーマをリスト。
  • sys_tables:利用可能なテーブルおよびビューをリスト。
  • sys_tablecolumns:利用可能なテーブルおよびビューのカラムについて説明。
  • sys_procedures:利用可能なストアドプロシージャについて説明。
  • sys_procedureparameters:ストアドプロシージャパラメータについて説明。
  • sys_keycolumns:主キーおよび外部キーについて説明。
  • sys_indexes:利用可能なインデックスについて説明。

データソーステーブル

以下のテーブルは、データソースへの接続方法およびクエリ方法についての情報を返します。

  • sys_connection_props:利用可能な接続プロパティについての情報を返す。
  • sys_sqlinfo:Cloud がデータソースにオフロードできるSELECT クエリについて説明。

クエリ情報テーブル

次のテーブルは、データ変更クエリのクエリ統計を返します。

  • sys_identity:バッチ処理または単一の更新に関する情報を返す。

CData Cloud

sys_catalogs

利用可能なデータベースをリストします。

次のクエリは、接続文字列で決定されるすべてのデータベースを取得します。

SELECT * FROM sys_catalogs

Columns

Name Type Description
CatalogName String データベース名。

CData Cloud

sys_schemas

利用可能なスキーマをリストします。

次のクエリは、すべての利用可能なスキーマを取得します。

          SELECT * FROM sys_schemas
          

Columns

Name Type Description
CatalogName String データベース名。
SchemaName String スキーマ名。

CData Cloud

sys_tables

利用可能なテーブルをリストします。

次のクエリは、利用可能なテーブルおよびビューを取得します。

          SELECT * FROM sys_tables
          

Columns

Name Type Description
CatalogName String テーブルまたはビューを含むデータベース。
SchemaName String テーブルまたはビューを含むスキーマ。
TableName String テーブル名またはビュー名。
TableType String テーブルの種類(テーブルまたはビュー)。
Description String テーブルまたはビューの説明。
IsUpdateable Boolean テーブルが更新可能かどうか。

CData Cloud

sys_tablecolumns

利用可能なテーブルおよびビューのカラムについて説明します。

次のクエリは、Vendors テーブルのカラムとデータ型を返します。

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Vendors' 

Columns

Name Type Description
CatalogName String テーブルまたはビューを含むデータベースの名前。
SchemaName String テーブルまたはビューを含むスキーマ。
TableName String カラムを含むテーブルまたはビューの名前。
ColumnName String カラム名。
DataTypeName String データ型の名前。
DataType Int32 データ型を示す整数値。この値は、実行時に環境に基づいて決定されます。
Length Int32 カラムのストレージサイズ。
DisplaySize Int32 指定されたカラムの通常の最大幅(文字数)。
NumericPrecision Int32 数値データの最大桁数。文字データおよび日時データの場合は、カラムの長さ(文字数)。
NumericScale Int32 カラムのスケール(小数点以下の桁数)。
IsNullable Boolean カラムがNull を含められるかどうか。
Description String カラムの簡単な説明。
Ordinal Int32 カラムのシーケンスナンバー。
IsAutoIncrement String カラムに固定増分値が割り当てられるかどうか。
IsGeneratedColumn String 生成されたカラムであるかどうか。
IsHidden Boolean カラムが非表示かどうか。
IsArray Boolean カラムが配列かどうか。
IsReadOnly Boolean カラムが読み取り専用かどうか。
IsKey Boolean sys_tablecolumns から返されたフィールドがテーブルの主キーであるかどうか。
ColumnType String スキーマ内のカラムの役割または分類。可能な値は、SYSTEM、LINKEDCOLUMN、NAVIGATIONKEY、REFERENCECOLUMN、およびNAVIGATIONPARENTCOLUMN が含まれます。

CData Cloud

sys_procedures

利用可能なストアドプロシージャをリストします。

次のクエリは、利用可能なストアドプロシージャを取得します。

          SELECT * FROM sys_procedures
          

Columns

Name Type Description
CatalogName String ストアドプロシージャを含むデータベース。
SchemaName String ストアドプロシージャを含むスキーマ。
ProcedureName String ストアドプロシージャの名前。
Description String ストアドプロシージャの説明。
ProcedureType String PROCEDURE やFUNCTION などのプロシージャのタイプ。

CData Cloud

sys_procedureparameters

ストアドプロシージャパラメータについて説明します。

次のクエリは、GetOAuthAccessToken ストアドプロシージャのすべての入力パラメータについての情報を返します。

SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'GetOAuthAccessToken' AND Direction = 1 OR Direction = 2

パラメータに加えて結果セットのカラムを含めるには、IncludeResultColumns 擬似カラムをTrue に設定します。

SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'GetOAuthAccessToken' AND IncludeResultColumns='True'

Columns

Name Type Description
CatalogName String ストアドプロシージャを含むデータベースの名前。
SchemaName String ストアドプロシージャを含むスキーマの名前。
ProcedureName String パラメータを含むストアドプロシージャの名前。
ColumnName String ストアドプロシージャパラメータの名前。
Direction Int32 パラメータのタイプに対応する整数値:input (1)。input/output (2)、またはoutput(4)。input/output タイプパラメータは、入力パラメータと出力パラメータの両方になれます。
DataType Int32 データ型を示す整数値。この値は、実行時に環境に基づいて決定されます。
DataTypeName String データ型の名前。
NumericPrecision Int32 数値データの場合は最大精度。文字データおよび日時データの場合は、カラムの長さ(文字数)。
Length Int32 文字データの場合は、許可される文字数。数値データの場合は、許可される桁数。
NumericScale Int32 数値データの小数点以下の桁数。
IsNullable Boolean パラメータがNull を含められるかどうか。
IsRequired Boolean プロシージャの実行にパラメータが必要かどうか。
IsArray Boolean パラメータが配列かどうか。
Description String パラメータの説明。
Ordinal Int32 パラメータのインデックス。
Values String このパラメータで設定できる値は、このカラムに表示されるものに限られます。指定できる値はカンマ区切りです。
SupportsStreams Boolean パラメータがファイルを表すかどうか。ファイルは、ファイルパスとして渡すことも、ストリームとして渡すこともできます。
IsPath Boolean パラメータがスキーマ作成操作のターゲットパスかどうか。
Default String 何も値が指定されていない場合に、このパラメータで使用される値。
SpecificName String 複数のストアドプロシージャが同じ名前を持つ場合、それぞれの同名のストアドプロシージャを一意に識別するラベル。特定の名前を持つプロシージャが1つだけの場合は、その名前がここに単純に反映されます。
IsCDataProvided Boolean プロシージャがネイティブのSAP Ariba プロシージャではなく、CData によって追加 / 実装されているかどうか。

Pseudo-Columns

Name Type Description
IncludeResultColumns Boolean 出力にパラメータに加えて結果セットのカラムを含めるかどうか。デフォルトはFalse です。

CData Cloud

sys_keycolumns

主キーおよび外部キーについて説明します。

次のクエリは、Vendors テーブルの主キーを取得します。

         SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Vendors' 
          

Columns

Name Type Description
CatalogName String キーを含むデータベースの名前。
SchemaName String キーを含むスキーマの名前。
TableName String キーを含むテーブルの名前。
ColumnName String キーカラムの名前
IsKey Boolean カラムがTableName フィールドで参照されるテーブル内の主キーかどうか。
IsForeignKey Boolean カラムがTableName フィールドで参照される外部キーかどうか。
PrimaryKeyName String 主キーの名前。
ForeignKeyName String 外部キーの名前。
ReferencedCatalogName String 主キーを含むデータベース。
ReferencedSchemaName String 主キーを含むスキーマ。
ReferencedTableName String 主キーを含むテーブル。
ReferencedColumnName String 主キーのカラム名。

CData Cloud

sys_foreignkeys

外部キーについて説明します。

次のクエリは、他のテーブルを参照するすべての外部キーを取得します。

         SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
          

カラム

名前 タイプ 説明
CatalogName String キーを含むデータベースの名前。
SchemaName String キーを含むスキーマの名前。
TableName String キーを含むテーブルの名前。
ColumnName String キーカラムの名前
PrimaryKeyName String 主キーの名前。
ForeignKeyName String 外部キーの名前。
ReferencedCatalogName String 主キーを含むデータベース。
ReferencedSchemaName String 主キーを含むスキーマ。
ReferencedTableName String 主キーを含むテーブル。
ReferencedColumnName String 主キーのカラム名。
ForeignKeyType String 外部キーがインポート(他のテーブルを指す)キーかエクスポート(他のテーブルから参照される)キーかを指定します。

CData Cloud

sys_primarykeys

主キーについて説明します。

次のクエリは、すべてのテーブルとビューから主キーを取得します。

         SELECT * FROM sys_primarykeys
          

Columns

Name Type Description
CatalogName String キーを含むデータベースの名前。
SchemaName String キーを含むスキーマの名前。
TableName String キーを含むテーブルの名前。
ColumnName String キーカラムの名前。
KeySeq String 主キーのシーケンス番号。
KeyName String 主キーの名前。

CData Cloud

sys_indexes

利用可能なインデックスについて説明します。インデックスをフィルタリングすることで、より高速なクエリ応答時間でセレクティブクエリを記述できます。

次のクエリは、主キーでないすべてのインデックスを取得します。

          SELECT * FROM sys_indexes WHERE IsPrimary='false'
          

Columns

Name Type Description
CatalogName String インデックスを含むデータベースの名前。
SchemaName String インデックスを含むスキーマの名前。
TableName String インデックスを含むテーブルの名前。
IndexName String インデックス名。
ColumnName String インデックスに関連付けられたカラムの名前。
IsUnique Boolean インデックスが固有の場合はTrue。そうでない場合はFalse。
IsPrimary Boolean インデックスが主キーの場合はTrue。そうでない場合はFalse。
Type Int16 インデックスタイプに対応する整数値:statistic (0)、clustered (1)、hashed (2)、またはother (3)。
SortOrder String 並べ替え順序:A が昇順、D が降順。
OrdinalPosition Int16 インデックスのカラムのシーケンスナンバー。

CData Cloud

sys_connection_props

利用可能な接続プロパティと、接続文字列に設定されている接続プロパティに関する情報を返します。

次のクエリは、接続文字列に設定されている、あるいはデフォルト値で設定されているすべての接続プロパティを取得します。

SELECT * FROM sys_connection_props WHERE Value <> ''

Columns

Name Type Description
Name String 接続プロパティ名。
ShortDescription String 簡単な説明。
Type String 接続プロパティのデータ型。
Default String 明示的に設定されていない場合のデフォルト値。
Values String 可能な値のカンマ区切りリスト。別な値が指定されていると、検証エラーがスローされます。
Value String 設定した値またはあらかじめ設定されたデフォルト。
Required Boolean プロパティが接続に必要かどうか。
Category String 接続プロパティのカテゴリ。
IsSessionProperty String プロパティが、現在の接続に関する情報を保存するために使用されるセッションプロパティかどうか。
Sensitivity String プロパティの機密度。これは、プロパティがロギングおよび認証フォームで難読化されているかどうかを通知します。
PropertyName String キャメルケースの短縮形の接続プロパティ名。
Ordinal Int32 パラメータのインデックス。
CatOrdinal Int32 パラメータカテゴリのインデックス。
Hierarchy String このプロパティと一緒に設定する必要がある、関連のある依存プロパティを表示します。
Visible Boolean プロパティが接続UI に表示されるかどうかを通知します。
ETC String プロパティに関するその他のさまざまな情報。

CData Cloud

sys_sqlinfo

Cloud がデータソースにオフロードできるSELECT クエリ処理について説明します。

SQL 構文の詳細については、SQL 準拠 を参照してください。

データソースのSELECT 機能

以下はSQL 機能のサンプルデータセットです。 SELECT 機能のいくつかの側面がサポートされている場合には、カンマ区切りのリストで返されます。サポートされていない場合、カラムにはNO が入ります。

名前説明有効な値
AGGREGATE_FUNCTIONSサポートされている集計関数。AVG, COUNT, MAX, MIN, SUM, DISTINCT
COUNTCOUNT 関数がサポートされているかどうか。YES, NO
IDENTIFIER_QUOTE_OPEN_CHAR識別子をエスケープするための開始文字。[
IDENTIFIER_QUOTE_CLOSE_CHAR識別子をエスケープするための終了文字。]
SUPPORTED_OPERATORSサポートされているSQL 演算子。=, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR
GROUP_BYGROUP BY がサポートされているかどうか。サポートされている場合、どのレベルでサポートされているか。NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE
OJ_CAPABILITIESサポートされている外部結合の種類。NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS
OUTER_JOINS外部結合がサポートされているかどうか。YES, NO
SUBQUERIESサブクエリがサポートされているかどうか。サポートされていれば、どのレベルでサポートされているか。NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED
STRING_FUNCTIONSサポートされている文字列関数。LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE
NUMERIC_FUNCTIONSサポートされている数値関数。ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE
TIMEDATE_FUNCTIONSサポートされている日付および時刻関数。NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT
REPLICATION_SKIP_TABLESレプリケーション中にスキップされたテーブルを示します。
REPLICATION_TIMECHECK_COLUMNSレプリケーション中に更新判断のカラムとして使用するかどうかを、(指定された順に)チェックするカラムのリストを含む文字列の配列。
IDENTIFIER_PATTERN識別子としてどの文字列が有効かを示す文字列値。
SUPPORT_TRANSACTIONプロバイダーが、コミットやロールバックなどのトランザクションをサポートしているかどうかを示します。YES, NO
DIALECT使用するSQL ダイアレクトを示します。
KEY_PROPERTIESUniform データベースを特定するプロパティを示します。
SUPPORTS_MULTIPLE_SCHEMASプロバイダー用に複数のスキームが存在するかどうかを示します。YES, NO
SUPPORTS_MULTIPLE_CATALOGSプロバイダー用に複数のカタログが存在するかどうかを示します。YES, NO
DATASYNCVERSIONこのドライバーにアクセスするために必要な、CData Sync のバージョン。Standard, Starter, Professional, Enterprise
DATASYNCCATEGORYこのドライバーのCData Sync カテゴリ。Source, Destination, Cloud Destination
SUPPORTSENHANCEDSQLAPI で提供されている以上の、追加SQL 機能がサポートされているかどうか。TRUE, FALSE
SUPPORTS_BATCH_OPERATIONSバッチ操作がサポートされているかどうか。YES, NO
SQL_CAPこのドライバーでサポートされているすべてのSQL 機能。SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX
PREFERRED_CACHE_OPTIONS使用したいcacheOptions を指定する文字列値。
ENABLE_EF_ADVANCED_QUERYドライバーがEntity Framework の高度なクエリをサポートしているかどうかを示します。サポートしていなければ、クエリはクライアントサイドで処理されます。YES, NO
PSEUDO_COLUMNS利用可能な疑似カラムを示す文字列の配列。
MERGE_ALWAYS値がtrue であれば、CData Sync 内でMerge Model が強制的に実行されます。TRUE, FALSE
REPLICATION_MIN_DATE_QUERYレプリケート開始日時を返すSELECT クエリ。
REPLICATION_MIN_FUNCTIONサーバーサイドでmin を実行するために使用する式名を、プロバイダーが指定できるようになります。
REPLICATION_START_DATEレプリケート開始日を、プロバイダーが指定できるようになります。
REPLICATION_MAX_DATE_QUERYレプリケート終了日時を返すSELECT クエリ。
REPLICATION_MAX_FUNCTIONサーバーサイドでmax を実行するために使用する式名を、プロバイダーが指定できるようになります。
IGNORE_INTERVALS_ON_INITIAL_REPLICATE初回のレプリケートで、レプリケートをチャンクに分割しないテーブルのリスト。
CHECKCACHE_USE_PARENTIDCheckCache 構文を親キーカラムに対して実行するかどうかを示します。TRUE, FALSE
CREATE_SCHEMA_PROCEDURESスキーマファイルの生成に使用できる、ストアドプロシージャを示します。

次のクエリは、WHERE 句で使用できる演算子を取得します。

SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'
WHERE 句では、個々のテーブルの制限や要件が異なる場合がありますので注意してください。詳しくは、データモデル セクションを参照してください。

Columns

Name Type Description
NAME String SQL 構文のコンポーネント、またはサーバー上で処理できる機能。
VALUE String サポートされるSQL またはSQL 構文の詳細。

CData Cloud

sys_identity

試行された変更に関する情報を返します。

次のクエリは、バッチ処理で変更された行のId を取得します。

         SELECT * FROM sys_identity
          

Columns

Name Type Description
Id String データ変更処理から返された、データベース生成Id。
Batch String バッチの識別子。1 は単一処理。
Operation String バッチ内の処理の結果:INSERTED、UPDATED、またはDELETED。
Message String SUCCESS、またはバッチ内の更新が失敗した場合のエラーメッセージ。

CData Cloud

sys_information

利用可能なシステム情報を説明します。

次のクエリは、すべてのカラムを取得します。

SELECT * FROM sys_information

Columns

NameTypeDescription
ProductString製品名。
VersionString製品のバージョン番号。
DatasourceString製品が接続するデータソースの名前。
NodeIdString製品がインストールされているマシンの固有識別子。
HelpURLString製品のヘルプドキュメントのURL。
LicenseString製品のライセンス情報。(この情報が利用できない場合、この項目は空白のままか「N/A」と表示されます。)
LocationString製品のライブラリが格納されているファイルパスの場所。
EnvironmentString製品が現在稼働している環境またはランタイムのバージョン。
DataSyncVersionString本コネクタを使用するために必要なCData Sync のティア。
DataSyncCategoryStringCData Sync 機能のカテゴリ(例:Source、Destination)。

CData Cloud

接続文字列オプション

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

Authentication


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

OAuth


プロパティ説明
OAuthClientIdカスタムOAuth アプリケーションに割り当てられたクライアントID(コンシューマーキーとも呼ばれます)を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。
OAuthClientSecretカスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。(カスタムOAuth アプリケーションのみ)

SSL


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

Logging


プロパティ説明
VerbosityログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。

Schema


プロパティ説明
BrowsableSchemasレポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
TypeDetectionSchemeDetermines how the data type of columns created from custom fields in the SupplierDataAPIWithPagination-V4 schema's Vendors view is determined.

Miscellaneous


プロパティ説明
IncludeCustomFieldsDetermines whether the provider exposes custom fields in SAP Ariba tables as columns.
MaxRows集計やGROUP BY を含まないクエリで返される最大行数を指定します。
MaxThreadsSpecifies the maximum number of concurrent requests the provider can execute to SAP Ariba.
Pagesizeprovider がSAP Ariba にデータをリクエストするときに返す、ページあたりの最大レコード数を指定します。
PseudoColumnsテーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。
RowScanDepthテーブルで利用可能なカラムを探すためにスキャンする行数の最大値。
Timeoutprovider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。
CData Cloud

Authentication

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


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

API

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

Possible Values

SupplierDataAPIWithPagination-V4, SourcingProjectManagementAPI-V2, ContractAPI-V1, RiskCategoryInformationAPIForSupplierRiskExposure-V1

データ型

string

デフォルト値

"SupplierDataAPIWithPagination-V4"

解説

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

CData Cloud

APIKey

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

データ型

string

デフォルト値

""

解説

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

CData Cloud

AuthScheme

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

Possible Values

OAuthClient

データ型

string

デフォルト値

"OAuthClient"

解説

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

CData Cloud

Environment

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

Possible Values

PRODUCTION, TEST

データ型

string

デフォルト値

"PRODUCTION"

解説

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

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

CData Cloud

DataCenter

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

Possible Values

US, EU, CN, UAE, KSA, AU, JP, RU

データ型

string

デフォルト値

"US"

解説

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

CData Cloud

Realm

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

データ型

string

デフォルト値

""

解説

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

CData Cloud

ProjectId

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

データ型

string

デフォルト値

""

解説

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

CData Cloud

User

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

データ型

string

デフォルト値

""

解説

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

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

CData Cloud

PasswordAdapter

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

データ型

string

デフォルト値

""

解説

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

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

CData Cloud

OAuth

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


プロパティ説明
OAuthClientIdカスタムOAuth アプリケーションに割り当てられたクライアントID(コンシューマーキーとも呼ばれます)を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。
OAuthClientSecretカスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。(カスタムOAuth アプリケーションのみ)
CData Cloud

OAuthClientId

カスタムOAuth アプリケーションに割り当てられたクライアントID(コンシューマーキーとも呼ばれます)を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。

データ型

string

デフォルト値

""

解説

このプロパティは2つのケースで必要となります:

  • カスタムOAuth アプリケーションを使用する場合。たとえば、Web ベースの認証フロー、サービスベースの認証、またはアプリケーションの登録が必要な証明書ベースのフローなどが該当します。
  • ドライバーが埋め込みOAuth 資格情報を提供しない場合。

(ドライバーが埋め込みOAuth 資格情報を提供する場合、この値はすでにCloud によって設定されており、手動で入力する必要がないことがあります。)

OAuthClientId は、認証付きの接続を構成する際に、OAuthClientSecret やOAuthSettingsLocation などの他のOAuth 関連プロパティと一緒に使用されるのが一般的です。

OAuthClientId は、ユーザーがOAuth 経由で認証を行う前に設定する必要がある、主要な接続パラメータの1つです。 この値は、通常、ID プロバイダーのアプリケーション登録設定で確認できます。 Client ID、Application ID、Consumer Key などとラベル付けされた項目を探してください。

クライアントID は、クライアントシークレットのような機密情報とは見なされませんが、アプリケーションの識別情報の一部であるため、慎重に取り扱う必要があります。公開リポジトリや共有設定ファイルでこの値を露出させないようにしてください。

接続設定時にこのプロパティを使用する方法の詳細については、接続の確立 を参照してください。

CData Cloud

OAuthClientSecret

カスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。(カスタムOAuth アプリケーションのみ)

データ型

string

デフォルト値

""

解説

このプロパティ(アプリケーションシークレットまたはコンシューマシークレットとも呼ばれます)は、安全なクライアント認証を必要とするすべてのフローでカスタムOAuth アプリケーションを使用する場合に必要です。たとえば、Web ベースのOAuth、サービスベースの接続、証明書ベースの認可フローなどが該当します。 組み込みOAuth アプリケーションを使用する場合は必要ありません。

クライアントシークレットは、OAuth フローのトークン交換ステップで使用されます。このステップでは、ドライバーが認可サーバーにアクセストークンを要求します。 この値が欠落しているか正しくない場合、認証はinvalid_client またはunauthorized_client エラーで失敗します。

OAuthClientSecret は、ユーザーがOAuth 経由で認証を行う前に設定する必要がある、主要な接続パラメータの1つです。この値は、OAuth アプリケーションを登録する際にID プロバイダーから取得できます。

Notes:

  • この値は安全に保管し、公開リポジトリやスクリプト、安全でない環境では決して公開しないようにしてください。
  • クライアントシークレットは、一定期間が経過すると有効期限が切れる場合もあります。 アクセスを中断させないために、有効期限を常に監視し、必要に応じてシークレットをローテーションするようにしてください。

接続設定時にこのプロパティを使用する方法の詳細については、接続の確立 を参照してください。

CData Cloud

SSL

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


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

SSLServerCert

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

データ型

string

デフォルト値

""

解説

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

Note:'*' を使用してすべての証明書を受け入れるように指定することも可能ですが、セキュリティ上の懸念があるため推奨されません。

CData Cloud

Logging

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


プロパティ説明
VerbosityログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。
CData Cloud

Verbosity

ログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。

データ型

string

デフォルト値

"1"

解説

このプロパティは、Cloud がログファイルに含める詳細レベルを定義します。 Verbosity レベルを高くするとログに記録される情報の詳細が増えますが、ログファイルが大きくなり取り込まれるデータが増えるためパフォーマンスが低下する可能性があります。

デフォルトのVerbosity レベルは1で、通常の運用にはこれが推奨されます。 より高いVerbosity レベルは主にデバッグを目的としています。 各レベルの詳細については、ログ を参照してください。

LogModules プロパティと組み合わせることで、Verbosity は特定の情報カテゴリに対するログの詳細度を調整できます。

CData Cloud

Schema

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


プロパティ説明
BrowsableSchemasレポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
TypeDetectionSchemeDetermines how the data type of columns created from custom fields in the SupplierDataAPIWithPagination-V4 schema's Vendors view is determined.
CData Cloud

BrowsableSchemas

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

データ型

string

デフォルト値

""

解説

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

CData Cloud

TypeDetectionScheme

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

Possible Values

None, RowScan

データ型

string

デフォルト値

"RowScan"

解説

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

CData Cloud

Miscellaneous

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


プロパティ説明
IncludeCustomFieldsDetermines whether the provider exposes custom fields in SAP Ariba tables as columns.
MaxRows集計やGROUP BY を含まないクエリで返される最大行数を指定します。
MaxThreadsSpecifies the maximum number of concurrent requests the provider can execute to SAP Ariba.
Pagesizeprovider がSAP Ariba にデータをリクエストするときに返す、ページあたりの最大レコード数を指定します。
PseudoColumnsテーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。
RowScanDepthテーブルで利用可能なカラムを探すためにスキャンする行数の最大値。
Timeoutprovider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。
CData Cloud

IncludeCustomFields

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

データ型

bool

デフォルト値

false

解説

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

CData Cloud

MaxRows

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

データ型

int

デフォルト値

-1

解説

このプロパティのデフォルト値である-1 は、クエリに明示的にLIMIT 句が含まれていない限り、行の制限が適用されないことを意味します。 (クエリにLIMIT 句が含まれている場合、クエリで指定された値がMaxRows 設定よりも優先されます。)

MaxRows を0より大きい整数に設定することで、クエリがデフォルトで過度に大きな結果セットを返さないようにします。

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

CData Cloud

MaxThreads

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

データ型

string

デフォルト値

"5"

解説

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

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

CData Cloud

Pagesize

provider がSAP Ariba にデータをリクエストするときに返す、ページあたりの最大レコード数を指定します。

データ型

int

デフォルト値

500

解説

クエリを処理する際、SAP Ariba でクエリされたデータすべてを一度にリクエストする代わりに、Cloud はクエリされたデータをページと呼ばれる部分ごとにリクエストすることができます。

この接続プロパティは、Cloud がページごとにリクエストする結果の最大数を決定します。

Note:大きなページサイズを設定すると全体的なクエリ実行時間が短縮される可能性がありますが、その場合、クエリ実行時にCloud がより多くのメモリを使用することになり、タイムアウトが発生するリスクがあります。

CData Cloud

PseudoColumns

テーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。

データ型

string

デフォルト値

""

解説

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

個々の擬似カラムを指定するには、以下の形式を使用します。

Table1=Column1;Table1=Column2;Table2=Column3

すべてのテーブルのすべての擬似カラムを含めるには、次を使用してください:

*=*

CData Cloud

RowScanDepth

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

データ型

int

デフォルト値

100

解説

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

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

CData Cloud

Timeout

provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。

データ型

int

デフォルト値

60

解説

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

タイムアウトはデフォルトで60秒に設定されています。タイムアウトを無効にするには、このプロパティを0に設定します。

タイムアウトを無効にすると、操作が成功するか、サーバー側のタイムアウト、ネットワークの中断、またはサーバーのリソース制限などの他の条件で失敗するまで無期限に実行されます。

Note: このプロパティは慎重に使用してください。長時間実行される操作がパフォーマンスを低下させたり、応答しなくなる可能性があるためです。

CData Cloud

Third Party Copyrights

LZMA from 7Zip LZMA SDK

LZMA SDK is placed in the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or distribute the original LZMA SDK code, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.

LZMA2 from XZ SDK

Version 1.9 and older are in the public domain.

Xamarin.Forms

Xamarin SDK

The MIT License (MIT)

Copyright (c) .NET Foundation Contributors

All rights reserved.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

NSIS 3.10

Copyright (C) 1999-2025 Contributors THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS COMMON PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.

1. DEFINITIONS

"Contribution" means:

a) in the case of the initial Contributor, the initial code and documentation distributed under this Agreement, and b) in the case of each subsequent Contributor:

i) changes to the Program, and

ii) additions to the Program;

where such changes and/or additions to the Program originate from and are distributed by that particular Contributor. A Contribution 'originates' from a Contributor if it was added to the Program by such Contributor itself or anyone acting on such Contributor's behalf. Contributions do not include additions to the Program which: (i) are separate modules of software distributed in conjunction with the Program under their own license agreement, and (ii) are not derivative works of the Program.

"Contributor" means any person or entity that distributes the Program.

"Licensed Patents " mean patent claims licensable by a Contributor which are necessarily infringed by the use or sale of its Contribution alone or when combined with the Program.

"Program" means the Contributions distributed in accordance with this Agreement.

"Recipient" means anyone who receives the Program under this Agreement, including all Contributors.

2. GRANT OF RIGHTS

a) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, distribute and sublicense the Contribution of such Contributor, if any, and such derivative works, in source code and object code form.

b) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free patent license under Licensed Patents to make, use, sell, offer to sell, import and otherwise transfer the Contribution of such Contributor, if any, in source code and object code form. This patent license shall apply to the combination of the Contribution and the Program if, at the time the Contribution is added by the Contributor, such addition of the Contribution causes such combination to be covered by the Licensed Patents. The patent license shall not apply to any other combinations which include the Contribution. No hardware per se is licensed hereunder.

c) Recipient understands that although each Contributor grants the licenses to its Contributions set forth herein, no assurances are provided by any Contributor that the Program does not infringe the patent or other intellectual property rights of any other entity. Each Contributor disclaims any liability to Recipient for claims brought by any other entity based on infringement of intellectual property rights or otherwise. As a condition to exercising the rights and licenses granted hereunder, each Recipient hereby assumes sole responsibility to secure any other intellectual property rights needed, if any. For example, if a third party patent license is required to allow Recipient to distribute the Program, it is Recipient's responsibility to acquire that license before distributing the Program.

d) Each Contributor represents that to its knowledge it has sufficient copyright rights in its Contribution, if any, to grant the copyright license set forth in this Agreement.

3. REQUIREMENTS

A Contributor may choose to distribute the Program in object code form under its own license agreement, provided that:

a) it complies with the terms and conditions of this Agreement; and

b) its license agreement:

i) effectively disclaims on behalf of all Contributors all warranties and conditions, express and implied, including warranties or conditions of title and non-infringement, and implied warranties or conditions of merchantability and fitness for a particular purpose;

ii) effectively excludes on behalf of all Contributors all liability for damages, including direct, indirect, special, incidental and consequential damages, such as lost profits;

iii) states that any provisions which differ from this Agreement are offered by that Contributor alone and not by any other party; and

iv) states that source code for the Program is available from such Contributor, and informs licensees how to obtain it in a reasonable manner on or through a medium customarily used for software exchange.

When the Program is made available in source code form:

a) it must be made available under this Agreement; and

b) a copy of this Agreement must be included with each copy of the Program.

Contributors may not remove or alter any copyright notices contained within the Program.

Each Contributor must identify itself as the originator of its Contribution, if any, in a manner that reasonably allows subsequent Recipients to identify the originator of the Contribution.

4. COMMERCIAL DISTRIBUTION

Commercial distributors of software may accept certain responsibilities with respect to end users, business partners and the like. While this license is intended to facilitate the commercial use of the Program, the Contributor who includes the Program in a commercial product offering should do so in a manner which does not create potential liability for other Contributors. Therefore, if a Contributor includes the Program in a commercial product offering, such Contributor ("Commercial Contributor") hereby agrees to defend and indemnify every other Contributor ("Indemnified Contributor") against any losses, damages and costs (collectively "Losses") arising from claims, lawsuits and other legal actions brought by a third party against the Indemnified Contributor to the extent caused by the acts or omissions of such Commercial Contributor in connection with its distribution of the Program in a commercial product offering. The obligations in this section do not apply to any claims or Losses relating to any actual or alleged intellectual property infringement. In order to qualify, an Indemnified Contributor must: a) promptly notify the Commercial Contributor in writing of such claim, and b) allow the Commercial Contributor to control, and cooperate with the Commercial Contributor in, the defense and any related settlement negotiations. The Indemnified Contributor may participate in any such claim at its own expense.

For example, a Contributor might include the Program in a commercial product offering, Product X. That Contributor is then a Commercial Contributor. If that Commercial Contributor then makes performance claims, or offers warranties related to Product X, those performance claims and warranties are such Commercial Contributor's responsibility alone. Under this section, the Commercial Contributor would have to defend claims against the other Contributors related to those performance claims and warranties, and if a court requires any other Contributor to pay any damages as a result, the Commercial Contributor must pay those damages.

5. NO WARRANTY

EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is solely responsible for determining the appropriateness of using and distributing the Program and assumes all risks associated with its exercise of rights under this Agreement, including but not limited to the risks and costs of program errors, compliance with applicable laws, damage to or loss of data, programs or equipment, and unavailability or interruption of operations.

6. DISCLAIMER OF LIABILITY

EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

7. GENERAL

If any provision of this Agreement is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this Agreement, and without further action by the parties hereto, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.

If Recipient institutes patent litigation against a Contributor with respect to a patent applicable to software (including a cross-claim or counterclaim in a lawsuit), then any patent licenses granted by that Contributor to such Recipient under this Agreement shall terminate as of the date such litigation is filed. In addition, if Recipient institutes patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Program itself (excluding combinations of the Program with other software or hardware) infringes such Recipient's patent(s), then such Recipient's rights granted under Section 2(b) shall terminate as of the date such litigation is filed.

All Recipient's rights under this Agreement shall terminate if it fails to comply with any of the material terms or conditions of this Agreement and does not cure such failure in a reasonable period of time after becoming aware of such noncompliance. If all Recipient's rights under this Agreement terminate, Recipient agrees to cease use and distribution of the Program as soon as reasonably practicable. However, Recipient's obligations under this Agreement and any licenses granted by Recipient relating to the Program shall continue and survive.

Everyone is permitted to copy and distribute copies of this Agreement, but in order to avoid inconsistency the Agreement is copyrighted and may only be modified in the following manner. The Agreement Steward reserves the right to publish new versions (including revisions) of this Agreement from time to time. No one other than the Agreement Steward has the right to modify this Agreement. IBM is the initial Agreement Steward. IBM may assign the responsibility to serve as the Agreement Steward to a suitable separate entity. Each new version of the Agreement will be given a distinguishing version number. The Program (including Contributions) may always be distributed subject to the version of the Agreement under which it was received. In addition, after a new version of the Agreement is published, Contributor may elect to distribute the Program (including its Contributions) under the new version. Except as expressly stated in Sections 2(a) and 2(b) above, Recipient receives no rights or licenses to the intellectual property of any Contributor under this Agreement, whether expressly, by implication, estoppel or otherwise. All rights in the Program not expressly granted under this Agreement are reserved.

This Agreement is governed by the laws of the State of New York and the intellectual property laws of the United States of America. No party to this Agreement will bring a legal action under this Agreement more than one year after the cause of action arose. Each party waives its rights to a jury trial in any resulting litigation.

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 25.0.9434