Cloud

Build 25.0.9434
  • SAP Ariba Source
    • Getting Started
      • Establishing a Connection
      • Creating a Custom OAuth App
      • SSL Configuration
      • Firewall and Proxy
    • Data Model
      • Supplier Data API With Pagination V4 Data Model
        • Views
          • AddressEmailAddresses
          • Addresses
          • AddressFaxNumbers
          • AddressPhoneNumbers
          • AddressWebsites
          • BankAccounts
          • BankInfos
          • CompanyCodes
          • Contacts
          • Customers
          • CustomerSalesArrangements
          • Identifications
          • InactiveVendors
          • Qualifications
          • Questionnaires
          • SupplierAccounting
          • SupplierPurchasingArrangements
          • Suppliers
          • VendorContacts
          • VendorDetails
          • Vendors
        • Stored Procedures
      • Sourcing Project Management API V2 Data Model
        • Tables
          • Projects
          • Teams
          • TeamUsers
        • Views
          • Documents
          • History
          • TaskActiveApproverUsers
          • TaskApprovalRequests
          • TaskApproverGroups
          • TaskApprovers
          • TaskCommentAttachments
          • TaskComments
          • Tasks
          • TeamGroups
        • Stored Procedures
      • Contract API V1 Data Model
        • Views
          • AffectedParties
          • CreationSupplierClassifications
          • IntegrationSupplierClassifications
          • LineItemDocumentProperties
          • PublishingSupplierClassifications
          • Terms
          • Workspaces
        • Stored Procedures
      • Risk Category Information API For Supplier Risk Exposure V1 Data Model
        • Stored Procedures
          • AddComplianceData
          • AddCustomFieldValues
          • ReplaceComplianceData
      • System Tables
        • 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
    • Connection String Options
      • 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

Overview

CData Cloud offers access to SAP Ariba across several standard services and protocols, in a cloud-hosted solution. Any application that can connect to a SQL Server database can connect to SAP Ariba through CData Cloud.

CData Cloud allows you to standardize and configure connections to SAP Ariba as though it were any other OData endpoint or standard SQL Server.

Key Features

  • Full SQL Support: SAP Ariba appears as standard relational databases, allowing you to perform operations - Filter, Group, Join, etc. - using standard SQL, regardless of whether these operations are supported by the underlying API.
  • CRUD Support: Both read and write operations are supported, restricted only by security settings that you can configure in Cloud or downstream in the source itself.
  • Secure Access: The administrator can create users and define their access to specific databases and read-only operations or grant full read & write privileges.
  • Comprehensive Data Model & Dynamic Discovery: CData Cloud provides comprehensive access to all of the data exposed in the underlying data source, including full access to dynamic data and easily searchable metadata.

CData Cloud

Getting Started

This page provides a guide to Establishing a Connection to SAP Ariba in CData Cloud, as well as information on the available resources, and a reference to the available connection properties.

Connecting to SAP Ariba

Establishing a Connection shows how to authenticate to SAP Ariba and configure any necessary connection properties to create a database in CData Cloud

Accessing Data from CData Cloud Services

Accessing data from SAP Ariba through the available standard services and CData Cloud administration is documented in further details in the CData Cloud Documentation.

CData Cloud

Establishing a Connection

Connect to SAP Ariba by selecting the corresponding icon in the Database tab. Required properties are listed under Settings. The Advanced tab lists connection properties that are not typically required.

Connecting to SAP Ariba

Set the following to connect:

  • API: Specify which API you would like the Cloud to retrieve SAP Ariba data from. Select the Supplier, Sourcing Project Management, or Contract API based on your business role.
  • DataCenter: The data center where your account's data is hosted.
  • Realm: The name of the site you want to access.
  • Environment: Indicate whether you are connecting to a test, sandbox, or production environment.

If you are connecting to the Supplier Data API or the Contract API, additionally set the following:

  • User: Id of the user on whose behalf API calls are invoked.
  • PasswordAdapter: The password associated with the authenticating User.

Finally, if you're connecting to the Supplier API, set ProjectId to the Id of the sourcing project you want to retrieve data from.

Authenticating to SAP Ariba

Authentication to SAP Ariba APIs is handled via OAuth. SAP Ariba's OAuth flow requires no user interaction.

OAuthClient

Set the AuthScheme to OAuthClient.

You need to register an application with the service to obtain the APIKey, OAuthClientId and OAuthClientSecret.

See Creating a Custom OAuth App for information about creating an application.

InitiateOAuth defaults to GETANDREFRESH for the OAuthClient authentication scheme.

Automatic OAuth

Get and Refresh the OAuth Access Token

After setting the following, you are ready to connect:

  • APIKey: The Application key in your app settings.
  • OAuthClientId: The OAuth Client Id in your app settings.
  • OAuthClientSecret: The OAuth Secret in your app settings.

When you connect, the Cloud automatically completes the OAuth process:

  1. The Cloud obtains an access token from SAP Ariba and uses it to request data.
  2. The Cloud refreshes the access token automatically when it expires.
  3. The OAuth values are saved in memory relative to the location specified in OAuthSettingsLocation.

Manual OAuth

Get an OAuth Access Token

Set the following connection properties to obtain the OAuthAccessToken:

  • APIKey: The Application key in your app settings.
  • OAuthClientId: The OAuth Client Id in your app settings.
  • OAuthClientSecret: The OAuth Secret in your app settings.

Then call the GetOAuthAccessToken stored procedure. Set the GrantType input to client_credentials or openapi_2lo (available for legacy users). If not specified, GrantType defaults to client_credentials.

After you have obtained the access and refresh tokens, you can connect to data and refresh the OAuth access token either automatically or manually.

Automatic Refresh of the OAuth Access Token

To have the Cloud automatically refresh the OAuth access token, set the following on the first data connection.

  • InitiateOAuth: REFRESH.
  • APIKey: The Application key in your app settings.
  • OAuthClientId: The OAuth Client Id in your app settings.
  • OAuthClientSecret: The OAuth Secret in your app settings.
  • OAuthAccessToken: The access token returned by GetOAuthAccessToken.
  • OAuthRefreshToken: The refresh token returned by GetOAuthAccessToken.

Manual Refresh of the OAuth Access Token

The only value needed to manually refresh the OAuth access token when connecting to data is the OAuth refresh token. Use the RefreshOAuthAccessToken stored procedure to manually refresh the OAuthAccessToken after the ExpiresIn parameter value returned by GetOAuthAccessToken has elapsed, then set the following connection properties:

  • APIKey: The Application key in your app settings.
  • OAuthClientId: The OAuth Client Id in your app settings.
  • OAuthClientSecret: The OAuth Secret in your app settings.

Then call RefreshOAuthAccessToken with OAuthRefreshToken set to the OAuth refresh token returned by GetOAuthAccessToken. After the new tokens have been retrieved, open a new connection by setting the OAuthAccessToken property to the value returned by RefreshOAuthAccessToken.

Finally, store the OAuth refresh token so that you can use it to manually refresh the OAuth access token after it has expired.

CData Cloud

Creating a Custom OAuth App

Create a Custom OAuth App

Complete the following procedure to obtain the APIKey, OAuthClientId, and OAuthClientSecret.

  1. Go to https://developer.ariba.com and sign in.
  2. Click Manage (bottom icon on the left).
  3. Click the + button next to the search field.
  4. Fill in Application Name > Description, then click Submit.
  5. Click Actions then click Request API Access.
  6. Select the API you want to retrieve data from. This corresponds to the API connection property.
  7. Select your realm.
  8. Click Submit.
  9. Wait until the request is approved.
  10. Once approved, click Actions > Generate OAuth Secret.
  11. Save the values displayed for Application key, OAuth Client Id and OAuth Secret.

CData Cloud

SSL Configuration

Customizing the SSL Configuration

By default, the Cloud attempts to negotiate TLS with the server. The server certificate is validated against the default system trusted certificate store. You can override how the certificate gets validated using the SSLServerCert connection property.

To specify another certificate, see the SSLServerCert connection property.

CData Cloud

Firewall and Proxy

Connecting Through a Firewall or Proxy

HTTP Proxies

To authenticate to an HTTP proxy, set the following:

  • ProxyServer: the hostname or IP address of the proxy server that you want to route HTTP traffic through.
  • ProxyPort: the TCP port that the proxy server is running on.
  • ProxyAuthScheme: the authentication method the Cloud uses when authenticating to the proxy server.
  • ProxyUser: the username of a user account registered with the proxy server.
  • ProxyPassword: the password associated with the ProxyUser.

Other Proxies

Set the following properties:

  • To use a proxy-based firewall, set FirewallType, FirewallServer, and FirewallPort.
  • To tunnel the connection, set FirewallType to TUNNEL.
  • To authenticate, specify FirewallUser and FirewallPassword.
  • To authenticate to a SOCKS proxy, additionally set FirewallType to SOCKS5.

CData Cloud

Data Model

The CData Cloud models entities in the SAP Ariba API as views and stored procedures. These are defined in schema files, which are simple, text-based configuration files that are easy to customize.

Using Supplier Data API With Pagination V4

See Supplier Data API With Pagination V4 Data Model for the available entities in the Supplier Data API With Pagination V4.

Using Sourcing Project Management API V2

See Sourcing Project Management API V2 Data Model for the available entities in the Sourcing Project Management API V2.

Using Contract API V1

See Contract API V1 Data Model for the available entities in the Contract API V1.

Using Risk Category Information API For Supplier Risk Exposure V1

See Risk Category Information API For Supplier Risk Exposure V1 Data Model for the available procedures in the Risk Category Information API For Supplier Risk Exposure V1.

CData Cloud

Supplier Data API With Pagination V4 Data Model

Overview

This section shows the available objects in the Supplier Data API and provides more information about using SQL with it.

Key Features

  • The Cloud models SAP Ariba vendor entities such as suppliers, customers, and addresses as relational views, allowing you to write SQL to query SAP Ariba data.
  • Stored procedures allow you to execute operations to SAP Ariba.
  • Live connectivity to these objects means any changes to your account are immediately reflected when using the Cloud.

Views

Views are read-only tables that model SAP Ariba vendors.

Stored Procedures

Stored Procedures are function-like interfaces to the data source that perform tasks such as OAuth token management.

CData Cloud

Views

Views are similar to tables in the way that data is represented; however, views are read-only.

Queries can be executed against a view as if it were a normal table.

CData Cloud - SAP Ariba Source Views

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

Stored Procedures

Stored procedures are function-like interfaces that extend the functionality of the Cloud beyond simple SELECT/INSERT/UPDATE/DELETE operations with SAP Ariba.

Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from SAP Ariba, along with an indication of whether the procedure succeeded or failed.

CData Cloud - SAP Ariba Source Stored Procedures

Name Description

CData Cloud

Sourcing Project Management API V2 Data Model

Overview

This section shows the available objects in the Sourcing Project Management API and provides more information about using SQL with it.

Key Features

  • The Cloud models SAP Ariba entities like teams, projects, and documents as relational views, allowing you to write SQL to query SAP Ariba data.
  • Stored procedures allow you to execute operations to SAP Ariba.
  • Live connectivity to these objects means any changes to your account are immediately reflected when using the Cloud.

Tables

Tables describes the available tables. Tables are statically defined to model resources like Projects, Teams, and TeamUsers.

Views

Views are read-only tables that model resources such as Documents, Tasks, and TeamGroups.

Stored Procedures

Stored Procedures are function-like interfaces to the data source. They can be used to download documents, download task comment attachments, and perform OAuth token management

CData Cloud

Tables

The Cloud models the data in SAP Ariba as a list of tables in a relational database that can be queried using standard SQL statements.

CData Cloud - SAP Ariba Source Tables

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

Views

Views are similar to tables in the way that data is represented; however, views are read-only.

Queries can be executed against a view as if it were a normal table.

CData Cloud - SAP Ariba Source Views

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

Stored Procedures

Stored procedures are function-like interfaces that extend the functionality of the Cloud beyond simple SELECT/INSERT/UPDATE/DELETE operations with SAP Ariba.

Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from SAP Ariba, along with an indication of whether the procedure succeeded or failed.

CData Cloud - SAP Ariba Source Stored Procedures

Name Description

CData Cloud

Contract API V1 Data Model

Overview

This section shows the available objects in the Contract API and provides more information about using SQL with it.

Key Features

  • The Cloud models SAP Ariba contract entities like terms, workspaces, and document properties as relational views, allowing you to write SQL to query SAP Ariba data.
  • Stored procedures allow you to execute operations to SAP Ariba.
  • Live connectivity to these objects means any changes to your account are immediately reflected when using the Cloud.

Views

Views are read-only tables that model SAP Ariba contracts.

Stored Procedures

Stored Procedures are function-like interfaces to the data source. They can be used to search, update, and modify information in the data source.

CData Cloud

Views

Views are similar to tables in the way that data is represented; however, views are read-only.

Queries can be executed against a view as if it were a normal table.

CData Cloud - SAP Ariba Source Views

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

Stored Procedures

Stored procedures are function-like interfaces that extend the functionality of the Cloud beyond simple SELECT/INSERT/UPDATE/DELETE operations with SAP Ariba.

Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from SAP Ariba, along with an indication of whether the procedure succeeded or failed.

CData Cloud - SAP Ariba Source Stored Procedures

Name Description

CData Cloud

Risk Category Information API For Supplier Risk Exposure V1 Data Model

Overview

This section shows the available objects in the Risk Category Information API For Supplier Risk Exposure V1 and provides more information about using SQL with it.

Key Features

  • Stored procedures allow you to execute operations to SAP Ariba.

Stored Procedures

Stored Procedures are function-like interfaces to the data source. They can be used to modify information in the data source.

CData Cloud

Stored Procedures

Stored procedures are function-like interfaces that extend the functionality of the Cloud beyond simple SELECT/INSERT/UPDATE/DELETE operations with SAP Ariba.

Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from SAP Ariba, along with an indication of whether the procedure succeeded or failed.

CData Cloud - SAP Ariba Source Stored Procedures

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.

The allowed values are VIOLATION_FOUND, VIOLATION_NOT_FOUND, VIOLATION_EXPIRED, NOT_SCREENED.

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

The allowed values are 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.

The allowed values are VIOLATION_FOUND, VIOLATION_NOT_FOUND, VIOLATION_EXPIRED, NOT_SCREENED.

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

The allowed values are 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

System Tables

You can query the system tables described in this section to access schema information, information on data source functionality, and batch operation statistics.

Schema Tables

The following tables return database metadata for SAP Ariba:

  • sys_catalogs: Lists the available databases.
  • sys_schemas: Lists the available schemas.
  • sys_tables: Lists the available tables and views.
  • sys_tablecolumns: Describes the columns of the available tables and views.
  • sys_procedures: Describes the available stored procedures.
  • sys_procedureparameters: Describes stored procedure parameters.
  • sys_keycolumns: Describes the primary and foreign keys.
  • sys_indexes: Describes the available indexes.

Data Source Tables

The following tables return information about how to connect to and query the data source:

  • sys_connection_props: Returns information on the available connection properties.
  • sys_sqlinfo: Describes the SELECT queries that the Cloud can offload to the data source.

Query Information Tables

The following table returns query statistics for data modification queries:

  • sys_identity: Returns information about batch operations or single updates.

CData Cloud

sys_catalogs

Lists the available databases.

The following query retrieves all databases determined by the connection string:

SELECT * FROM sys_catalogs

Columns

Name Type Description
CatalogName String The database name.

CData Cloud

sys_schemas

Lists the available schemas.

The following query retrieves all available schemas:

          SELECT * FROM sys_schemas
          

Columns

Name Type Description
CatalogName String The database name.
SchemaName String The schema name.

CData Cloud

sys_tables

Lists the available tables.

The following query retrieves the available tables and views:

          SELECT * FROM sys_tables
          

Columns

Name Type Description
CatalogName String The database containing the table or view.
SchemaName String The schema containing the table or view.
TableName String The name of the table or view.
TableType String The table type (table or view).
Description String A description of the table or view.
IsUpdateable Boolean Whether the table can be updated.

CData Cloud

sys_tablecolumns

Describes the columns of the available tables and views.

The following query returns the columns and data types for the Vendors table:

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

Columns

Name Type Description
CatalogName String The name of the database containing the table or view.
SchemaName String The schema containing the table or view.
TableName String The name of the table or view containing the column.
ColumnName String The column name.
DataTypeName String The data type name.
DataType Int32 An integer indicating the data type. This value is determined at run time based on the environment.
Length Int32 The storage size of the column.
DisplaySize Int32 The designated column's normal maximum width in characters.
NumericPrecision Int32 The maximum number of digits in numeric data. The column length in characters for character and date-time data.
NumericScale Int32 The column scale or number of digits to the right of the decimal point.
IsNullable Boolean Whether the column can contain null.
Description String A brief description of the column.
Ordinal Int32 The sequence number of the column.
IsAutoIncrement String Whether the column value is assigned in fixed increments.
IsGeneratedColumn String Whether the column is generated.
IsHidden Boolean Whether the column is hidden.
IsArray Boolean Whether the column is an array.
IsReadOnly Boolean Whether the column is read-only.
IsKey Boolean Indicates whether a field returned from sys_tablecolumns is the primary key of the table.
ColumnType String The role or classification of the column in the schema. Possible values include SYSTEM, LINKEDCOLUMN, NAVIGATIONKEY, REFERENCECOLUMN, and NAVIGATIONPARENTCOLUMN.

CData Cloud

sys_procedures

Lists the available stored procedures.

The following query retrieves the available stored procedures:

          SELECT * FROM sys_procedures
          

Columns

Name Type Description
CatalogName String The database containing the stored procedure.
SchemaName String The schema containing the stored procedure.
ProcedureName String The name of the stored procedure.
Description String A description of the stored procedure.
ProcedureType String The type of the procedure, such as PROCEDURE or FUNCTION.

CData Cloud

sys_procedureparameters

Describes stored procedure parameters.

The following query returns information about all of the input parameters for the GetOAuthAccessToken stored procedure:

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

To include result set columns in addition to the parameters, set the IncludeResultColumns pseudo column to True:

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

Columns

Name Type Description
CatalogName String The name of the database containing the stored procedure.
SchemaName String The name of the schema containing the stored procedure.
ProcedureName String The name of the stored procedure containing the parameter.
ColumnName String The name of the stored procedure parameter.
Direction Int32 An integer corresponding to the type of the parameter: input (1), input/output (2), or output(4). input/output type parameters can be both input and output parameters.
DataType Int32 An integer indicating the data type. This value is determined at run time based on the environment.
DataTypeName String The name of the data type.
NumericPrecision Int32 The maximum precision for numeric data. The column length in characters for character and date-time data.
Length Int32 The number of characters allowed for character data. The number of digits allowed for numeric data.
NumericScale Int32 The number of digits to the right of the decimal point in numeric data.
IsNullable Boolean Whether the parameter can contain null.
IsRequired Boolean Whether the parameter is required for execution of the procedure.
IsArray Boolean Whether the parameter is an array.
Description String The description of the parameter.
Ordinal Int32 The index of the parameter.
Values String The values you can set in this parameter are limited to those shown in this column. Possible values are comma-separated.
SupportsStreams Boolean Whether the parameter represents a file that you can pass as either a file path or a stream.
IsPath Boolean Whether the parameter is a target path for a schema creation operation.
Default String The value used for this parameter when no value is specified.
SpecificName String A label that, when multiple stored procedures have the same name, uniquely identifies each identically-named stored procedure. If there's only one procedure with a given name, its name is simply reflected here.
IsCDataProvided Boolean Whether the procedure is added/implemented by CData, as opposed to being a native SAP Ariba procedure.

Pseudo-Columns

Name Type Description
IncludeResultColumns Boolean Whether the output should include columns from the result set in addition to parameters. Defaults to False.

CData Cloud

sys_keycolumns

Describes the primary and foreign keys.

The following query retrieves the primary key for the Vendors table:

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

Columns

Name Type Description
CatalogName String The name of the database containing the key.
SchemaName String The name of the schema containing the key.
TableName String The name of the table containing the key.
ColumnName String The name of the key column.
IsKey Boolean Whether the column is a primary key in the table referenced in the TableName field.
IsForeignKey Boolean Whether the column is a foreign key referenced in the TableName field.
PrimaryKeyName String The name of the primary key.
ForeignKeyName String The name of the foreign key.
ReferencedCatalogName String The database containing the primary key.
ReferencedSchemaName String The schema containing the primary key.
ReferencedTableName String The table containing the primary key.
ReferencedColumnName String The column name of the primary key.

CData Cloud

sys_foreignkeys

Describes the foreign keys.

The following query retrieves all foreign keys which refer to other tables:

         SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
          

Columns

Name Type Description
CatalogName String The name of the database containing the key.
SchemaName String The name of the schema containing the key.
TableName String The name of the table containing the key.
ColumnName String The name of the key column.
PrimaryKeyName String The name of the primary key.
ForeignKeyName String The name of the foreign key.
ReferencedCatalogName String The database containing the primary key.
ReferencedSchemaName String The schema containing the primary key.
ReferencedTableName String The table containing the primary key.
ReferencedColumnName String The column name of the primary key.
ForeignKeyType String Designates whether the foreign key is an import (points to other tables) or export (referenced from other tables) key.

CData Cloud

sys_primarykeys

Describes the primary keys.

The following query retrieves the primary keys from all tables and views:

         SELECT * FROM sys_primarykeys
          

Columns

Name Type Description
CatalogName String The name of the database containing the key.
SchemaName String The name of the schema containing the key.
TableName String The name of the table containing the key.
ColumnName String The name of the key column.
KeySeq String The sequence number of the primary key.
KeyName String The name of the primary key.

CData Cloud

sys_indexes

Describes the available indexes. By filtering on indexes, you can write more selective queries with faster query response times.

The following query retrieves all indexes that are not primary keys:

          SELECT * FROM sys_indexes WHERE IsPrimary='false'
          

Columns

Name Type Description
CatalogName String The name of the database containing the index.
SchemaName String The name of the schema containing the index.
TableName String The name of the table containing the index.
IndexName String The index name.
ColumnName String The name of the column associated with the index.
IsUnique Boolean True if the index is unique. False otherwise.
IsPrimary Boolean True if the index is a primary key. False otherwise.
Type Int16 An integer value corresponding to the index type: statistic (0), clustered (1), hashed (2), or other (3).
SortOrder String The sort order: A for ascending or D for descending.
OrdinalPosition Int16 The sequence number of the column in the index.

CData Cloud

sys_connection_props

Returns information on the available connection properties and those set in the connection string.

The following query retrieves all connection properties that have been set in the connection string or set through a default value:

SELECT * FROM sys_connection_props WHERE Value <> ''

Columns

Name Type Description
Name String The name of the connection property.
ShortDescription String A brief description.
Type String The data type of the connection property.
Default String The default value if one is not explicitly set.
Values String A comma-separated list of possible values. A validation error is thrown if another value is specified.
Value String The value you set or a preconfigured default.
Required Boolean Whether the property is required to connect.
Category String The category of the connection property.
IsSessionProperty String Whether the property is a session property, used to save information about the current connection.
Sensitivity String The sensitivity level of the property. This informs whether the property is obfuscated in logging and authentication forms.
PropertyName String A camel-cased truncated form of the connection property name.
Ordinal Int32 The index of the parameter.
CatOrdinal Int32 The index of the parameter category.
Hierarchy String Shows dependent properties associated that need to be set alongside this one.
Visible Boolean Informs whether the property is visible in the connection UI.
ETC String Various miscellaneous information about the property.

CData Cloud

sys_sqlinfo

Describes the SELECT query processing that the Cloud can offload to the data source.

See SQL Compliance for SQL syntax details.

Discovering the Data Source's SELECT Capabilities

Below is an example data set of SQL capabilities. Some aspects of SELECT functionality are returned in a comma-separated list if supported; otherwise, the column contains NO.

NameDescriptionPossible Values
AGGREGATE_FUNCTIONSSupported aggregation functions.AVG, COUNT, MAX, MIN, SUM, DISTINCT
COUNTWhether COUNT function is supported.YES, NO
IDENTIFIER_QUOTE_OPEN_CHARThe opening character used to escape an identifier.[
IDENTIFIER_QUOTE_CLOSE_CHARThe closing character used to escape an identifier.]
SUPPORTED_OPERATORSA list of supported SQL operators.=, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR
GROUP_BYWhether GROUP BY is supported, and, if so, the degree of support.NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE
OJ_CAPABILITIESThe supported varieties of outer joins supported.NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS
OUTER_JOINSWhether outer joins are supported.YES, NO
SUBQUERIESWhether subqueries are supported, and, if so, the degree of support.NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED
STRING_FUNCTIONSSupported 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_FUNCTIONSSupported 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_FUNCTIONSSupported date/time 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_TABLESIndicates tables skipped during replication.
REPLICATION_TIMECHECK_COLUMNSA string array containing a list of columns which will be used to check for (in the given order) to use as a modified column during replication.
IDENTIFIER_PATTERNString value indicating what string is valid for an identifier.
SUPPORT_TRANSACTIONIndicates if the provider supports transactions such as commit and rollback.YES, NO
DIALECTIndicates the SQL dialect to use.
KEY_PROPERTIESIndicates the properties which identify the uniform database.
SUPPORTS_MULTIPLE_SCHEMASIndicates if multiple schemas may exist for the provider.YES, NO
SUPPORTS_MULTIPLE_CATALOGSIndicates if multiple catalogs may exist for the provider.YES, NO
DATASYNCVERSIONThe CData Data Sync version needed to access this driver.Standard, Starter, Professional, Enterprise
DATASYNCCATEGORYThe CData Data Sync category of this driver.Source, Destination, Cloud Destination
SUPPORTSENHANCEDSQLWhether enhanced SQL functionality beyond what is offered by the API is supported.TRUE, FALSE
SUPPORTS_BATCH_OPERATIONSWhether batch operations are supported.YES, NO
SQL_CAPAll supported SQL capabilities for this driver.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_OPTIONSA string value specifies the preferred cacheOptions.
ENABLE_EF_ADVANCED_QUERYIndicates if the driver directly supports advanced queries coming from Entity Framework. If not, queries will be handled client side.YES, NO
PSEUDO_COLUMNSA string array indicating the available pseudo columns.
MERGE_ALWAYSIf the value is true, The Merge Mode is forcibly executed in Data Sync.TRUE, FALSE
REPLICATION_MIN_DATE_QUERYA select query to return the replicate start datetime.
REPLICATION_MIN_FUNCTIONAllows a provider to specify the formula name to use for executing a server side min.
REPLICATION_START_DATEAllows a provider to specify a replicate startdate.
REPLICATION_MAX_DATE_QUERYA select query to return the replicate end datetime.
REPLICATION_MAX_FUNCTIONAllows a provider to specify the formula name to use for executing a server side max.
IGNORE_INTERVALS_ON_INITIAL_REPLICATEA list of tables which will skip dividing the replicate into chunks on the initial replicate.
CHECKCACHE_USE_PARENTIDIndicates whether the CheckCache statement should be done against the parent key column.TRUE, FALSE
CREATE_SCHEMA_PROCEDURESIndicates stored procedures that can be used for generating schema files.

The following query retrieves the operators that can be used in the WHERE clause:

SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'
Note that individual tables may have different limitations or requirements on the WHERE clause; refer to the Data Model section for more information.

Columns

Name Type Description
NAME String A component of SQL syntax, or a capability that can be processed on the server.
VALUE String Detail on the supported SQL or SQL syntax.

CData Cloud

sys_identity

Returns information about attempted modifications.

The following query retrieves the Ids of the modified rows in a batch operation:

         SELECT * FROM sys_identity
          

Columns

Name Type Description
Id String The database-generated Id returned from a data modification operation.
Batch String An identifier for the batch. 1 for a single operation.
Operation String The result of the operation in the batch: INSERTED, UPDATED, or DELETED.
Message String SUCCESS or an error message if the update in the batch failed.

CData Cloud

sys_information

Describes the available system information.

The following query retrieves all columns:

SELECT * FROM sys_information

Columns

NameTypeDescription
ProductStringThe name of the product.
VersionStringThe version number of the product.
DatasourceStringThe name of the datasource the product connects to.
NodeIdStringThe unique identifier of the machine where the product is installed.
HelpURLStringThe URL to the product's help documentation.
LicenseStringThe license information for the product. (If this information is not available, the field may be left blank or marked as 'N/A'.)
LocationStringThe file path location where the product's library is stored.
EnvironmentStringThe version of the environment or rumtine the product is currently running under.
DataSyncVersionStringThe tier of CData Sync required to use this connector.
DataSyncCategoryStringThe category of CData Sync functionality (e.g., Source, Destination).

CData Cloud

Connection String Options

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.

For more information on establishing a connection, see Establishing a Connection.

Authentication


PropertyDescription
APISpecify which API you would like the provider to retrieve SAP Ariba data from.
APIKeyYour OAuth application key.
AuthSchemeSet the type of authentication to use when connecting to SAP Ariba.
EnvironmentThe environment to use when connecting to SAP Ariba.
DataCenterThe data center where your account's data is hosted.
RealmSpecify the realm from which you would like to access data.
ProjectIdThe Id of the sourcing project for which information will be retrieved.
UserThe user Id of a SAP Ariba user.
PasswordAdapterThe password associated with the selected User .

OAuth


PropertyDescription
OAuthClientIdSpecifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
OAuthClientSecretSpecifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).

SSL


PropertyDescription
SSLServerCertSpecifies the certificate to be accepted from the server when connecting using TLS/SSL.

Logging


PropertyDescription
VerbositySpecifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.

Schema


PropertyDescription
BrowsableSchemasOptional setting that restricts the schemas reported to a subset of all available schemas. For example, 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


PropertyDescription
IncludeCustomFieldsDetermines whether the provider exposes custom fields in SAP Ariba tables as columns.
MaxRowsSpecifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
MaxThreadsSpecifies the maximum number of concurrent requests the provider can execute to SAP Ariba.
PagesizeSpecifies the maximum number of records per page the provider returns when requesting data from SAP Ariba.
PseudoColumnsSpecifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
RowScanDepthThe maximum number of rows to scan to look for the columns available in a table.
TimeoutSpecifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
CData Cloud

Authentication

This section provides a complete list of the Authentication properties you can configure in the connection string for this provider.


PropertyDescription
APISpecify which API you would like the provider to retrieve SAP Ariba data from.
APIKeyYour OAuth application key.
AuthSchemeSet the type of authentication to use when connecting to SAP Ariba.
EnvironmentThe environment to use when connecting to SAP Ariba.
DataCenterThe data center where your account's data is hosted.
RealmSpecify the realm from which you would like to access data.
ProjectIdThe Id of the sourcing project for which information will be retrieved.
UserThe user Id of a SAP Ariba user.
PasswordAdapterThe password associated with the selected User .
CData Cloud

API

Specify which API you would like the provider to retrieve SAP Ariba data from.

Possible Values

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

Data Type

string

Default Value

"SupplierDataAPIWithPagination-V4"

Remarks

Specify which API you would like the Cloud to retrieve SAP Ariba data from.

CData Cloud

APIKey

Your OAuth application key.

Data Type

string

Default Value

""

Remarks

SAP Ariba OAuth application keys are generated when an OAuth application is first created. See Creating a Custom OAuth App for more information.

CData Cloud

AuthScheme

Set the type of authentication to use when connecting to SAP Ariba.

Possible Values

OAuthClient

Data Type

string

Default Value

"OAuthClient"

Remarks

  • OAuthClient: Set to this to perform OAuth 2.0 with client credentials grant type authentication.

CData Cloud

Environment

The environment to use when connecting to SAP Ariba.

Possible Values

PRODUCTION, TEST

Data Type

string

Default Value

"PRODUCTION"

Remarks

The production environment returns real data and is tied to your application.

The test environment returns mock data and is tied to your application.

CData Cloud

DataCenter

The data center where your account's data is hosted.

Possible Values

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

Data Type

string

Default Value

"US"

Remarks

The data center where your account's data is hosted.

CData Cloud

Realm

Specify the realm from which you would like to access data.

Data Type

string

Default Value

""

Remarks

Specify the realm from which you would like to access data.

CData Cloud

ProjectId

The Id of the sourcing project for which information will be retrieved.

Data Type

string

Default Value

""

Remarks

The id of the sourcing project for which information will be retrieved.

CData Cloud

User

The user Id of a SAP Ariba user.

Data Type

string

Default Value

""

Remarks

A user account must be included in requests to the Sourcing Project Management and Contract APIs.

This property specifies the user account the Cloud uses in API requests.

CData Cloud

PasswordAdapter

The password associated with the selected User .

Data Type

string

Default Value

""

Remarks

A user account must be included in requests to the Sourcing Project Management and Contract APIs.

This property authenticates the selected User account.

CData Cloud

OAuth

This section provides a complete list of the OAuth properties you can configure in the connection string for this provider.


PropertyDescription
OAuthClientIdSpecifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
OAuthClientSecretSpecifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).
CData Cloud

OAuthClientId

Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.

Data Type

string

Default Value

""

Remarks

This property is required in two cases:

  • When using a custom OAuth application, such as in web-based authentication flows, service-based authentication, or certificate-based flows that require application registration.
  • If the driver does not provide embedded OAuth credentials.

(When the driver provides embedded OAuth credentials, this value may already be provided by the Cloud and thus not require manual entry.)

OAuthClientId is generally used alongside other OAuth-related properties such as OAuthClientSecret and OAuthSettingsLocation when configuring an authenticated connection.

OAuthClientId is one of the key connection parameters that need to be set before users can authenticate via OAuth. You can usually find this value in your identity provider’s application registration settings. Look for a field labeled Client ID, Application ID, or Consumer Key.

While the client ID is not considered a confidential value like a client secret, it is still part of your application's identity and should be handled carefully. Avoid exposing it in public repositories or shared configuration files.

For more information on how this property is used when configuring a connection, see Establishing a Connection.

CData Cloud

OAuthClientSecret

Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).

Data Type

string

Default Value

""

Remarks

This property (sometimes called the application secret or consumer secret) is required when using a custom OAuth application in any flow that requires secure client authentication, such as web-based OAuth, service-based connections, or certificate-based authorization flows. It is not required when using an embedded OAuth application.

The client secret is used during the token exchange step of the OAuth flow, when the driver requests an access token from the authorization server. If this value is missing or incorrect, authentication fails with either an invalid_client or an unauthorized_client error.

OAuthClientSecret is one of the key connection parameters that need to be set before users can authenticate via OAuth. You can obtain this value from your identity provider when registering the OAuth application.

Notes:

  • This value should be stored securely and never exposed in public repositories, scripts, or unsecured environments.
  • Client secrets may also expire after a set period. Be sure to monitor expiration dates and rotate secrets as needed to maintain uninterrupted access.

For more information on how this property is used when configuring a connection, see Establishing a Connection

CData Cloud

SSL

This section provides a complete list of the SSL properties you can configure in the connection string for this provider.


PropertyDescription
SSLServerCertSpecifies the certificate to be accepted from the server when connecting using TLS/SSL.
CData Cloud

SSLServerCert

Specifies the certificate to be accepted from the server when connecting using TLS/SSL.

Data Type

string

Default Value

""

Remarks

If you are using a TLS/SSL connection, use this property to specify the TLS/SSL certificate to be accepted from the server. If you specify a value for this property, all other certificates that are not trusted by the machine are rejected.

This property can take the following forms:

Description Example
A full PEM Certificate (example shortened for brevity) -----BEGIN CERTIFICATE-----
MIIChTCCAe4CAQAwDQYJKoZIhv......Qw==
-----END CERTIFICATE-----
A path to a local file containing the certificate C:\cert.cer
The public key (example shortened for brevity) -----BEGIN RSA PUBLIC KEY-----
MIGfMA0GCSq......AQAB
-----END RSA PUBLIC KEY-----
The MD5 Thumbprint (hex values can also be either space- or colon-separated) ecadbdda5a1529c58a1e9e09828d70e4
The SHA1 Thumbprint (hex values can also be either space- or colon-separated) 34a929226ae0819f2ec14b4a3d904f801cbb150d

Note: It is possible to use '*' to signify that all certificates should be accepted, but due to security concerns this is not recommended.

CData Cloud

Logging

This section provides a complete list of the Logging properties you can configure in the connection string for this provider.


PropertyDescription
VerbositySpecifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.
CData Cloud

Verbosity

Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.

Data Type

string

Default Value

"1"

Remarks

This property defines the level of detail the Cloud includes in the log file. Higher verbosity levels increase the detail of the logged information, but may also result in larger log files and slower performance due to the additional data being captured.

The default verbosity level is 1, which is recommended for regular operation. Higher verbosity levels are primarily intended for debugging purposes. For more information on each level, refer to Logging.

When combined with the LogModules property, Verbosity can refine logging to specific categories of information.

CData Cloud

Schema

This section provides a complete list of the Schema properties you can configure in the connection string for this provider.


PropertyDescription
BrowsableSchemasOptional setting that restricts the schemas reported to a subset of all available schemas. For example, 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

Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .

Data Type

string

Default Value

""

Remarks

Listing all available database schemas can take extra time, thus degrading performance. Providing a list of schemas in the connection string saves time and improves performance.

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

Data Type

string

Default Value

"RowScan"

Remarks

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

This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.


PropertyDescription
IncludeCustomFieldsDetermines whether the provider exposes custom fields in SAP Ariba tables as columns.
MaxRowsSpecifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
MaxThreadsSpecifies the maximum number of concurrent requests the provider can execute to SAP Ariba.
PagesizeSpecifies the maximum number of records per page the provider returns when requesting data from SAP Ariba.
PseudoColumnsSpecifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
RowScanDepthThe maximum number of rows to scan to look for the columns available in a table.
TimeoutSpecifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
CData Cloud

IncludeCustomFields

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

Data Type

bool

Default Value

false

Remarks

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

CData Cloud

MaxRows

Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.

Data Type

int

Default Value

-1

Remarks

The default value for this property, -1, means that no row limit is enforced unless the query explicitly includes a LIMIT clause. (When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting.)

Setting MaxRows to a whole number greater than 0 ensures that queries do not return excessively large result sets by default.

This property is useful for optimizing performance and preventing excessive resource consumption when executing queries that could otherwise return very large datasets.

CData Cloud

MaxThreads

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

Data Type

string

Default Value

"5"

Remarks

This property allows you to issue multiple requests simultaneously, thereby improving performance.

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

CData Cloud

Pagesize

Specifies the maximum number of records per page the provider returns when requesting data from SAP Ariba.

Data Type

int

Default Value

500

Remarks

When processing a query, instead of requesting all of the queried data at once from SAP Ariba, the Cloud can request the queried data in pieces called pages.

This connection property determines the maximum number of results that the Cloud requests per page.

Note: Setting large page sizes may improve overall query execution time, but doing so causes the Cloud to use more memory when executing queries and risks triggering a timeout.

CData Cloud

PseudoColumns

Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.

Data Type

string

Default Value

""

Remarks

This property allows you to define which pseudocolumns the Cloud exposes as table columns.

To specify individual pseudocolumns, use the following format:

Table1=Column1;Table1=Column2;Table2=Column3

To include all pseudocolumns for all tables use:

*=*

CData Cloud

RowScanDepth

The maximum number of rows to scan to look for the columns available in a table.

Data Type

int

Default Value

100

Remarks

The columns in a table must be determined by scanning table rows. This value determines the maximum number of rows that will be scanned.

Setting a high value may decrease performance. Setting a low value may prevent the data type from being determined properly, especially when there is null data.

CData Cloud

Timeout

Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.

Data Type

int

Default Value

60

Remarks

The timeout applies to each individual communication with the server rather than the entire query or operation. For example, a query could continue running beyond 60 seconds if each paging call completes within the timeout limit.

Timeout is set to 60 seconds by default. To disable timeouts, set this property to 0.

Disabling the timeout allows operations to run indefinitely until they succeed or fail due to other conditions such as server-side timeouts, network interruptions, or resource limits on the server.

Note: Use this property cautiously to avoid long-running operations that could degrade performance or result in unresponsive behavior.

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