Establishing a Connection

Adding a Connection to SAP Ariba

To add a connection to SAP Ariba:

In the application console, navigate to the Connections page.
At the Add Connections panel, select the icon for the connection you want to add.
If the SAP Ariba icon is not available, click the Add More icon to download and install the SAP Ariba connector from the CData site.

For required properties, see the Settings tab.

For connection properties that are not typically required, see the Advanced tab.

Connecting to SAP Ariba

Set the following to connect:

API: Specify which API you would like the Sync App 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 Sync App automatically completes the OAuth process:

The Sync App obtains an access token from SAP Ariba and uses it to request data.
The Sync App refreshes the access token automatically when it expires.
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 Sync App 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.

Creating a Custom OAuth App

Create a Custom OAuth App

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

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

Advanced Features

This section details a selection of advanced features of the SAP Ariba Sync App.

User Defined Views

The Sync App supports the use of user defined views, virtual tables whose contents are decided by a pre-configured user defined query. These views are useful when you cannot directly control queries being issued to the drivers. For an overview of creating and configuring custom views, see User Defined Views .

SSL Configuration

Use SSL Configuration to adjust how Sync App handles TLS/SSL certificate negotiations. You can choose from various certificate formats;. For further information, see the SSLServerCert property under "Connection String Options" .

Firewall and Proxy

Configure the Sync App for compliance with Firewall and Proxy, including Windows proxies and HTTP proxies. You can also set up tunnel connections.

Query Processing

The Sync App offloads as much of the SELECT statement processing as possible to SAP Ariba and then processes the rest of the query in memory (client-side).

For further information, see Query Processing.

Logging

For an overview of configuration settings that can be used to refine CData logging, see Logging. Only two connection properties are required for basic logging, but there are numerous features that support more refined logging, which enables you to use the LogModules connection property to specify subsets of information to be logged.

SSL Configuration

Customizing the SSL Configuration

By default, the Sync App 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.

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 Sync App 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.

Data Model

The CData Sync App 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.

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 Sync App 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 Sync App.

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.

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.

SAP Ariba Source Connector for CData Sync 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.
Qualifications	Fetch vendor qualifications. Qualifications covers both qualifications (either supplier qualifications or process qualifications) and preferred category statuses.
Questionnaires	Retrieve vendor questionnaires.
SupplierAccounting	Retrieve vendor supplier accounting information.
SupplierPurchasingArrangements	Retrieve vendor supplier information purchasing arrangements.
Suppliers	Retrieve vendor supplier information.
VendorDetails	Retrieve vendor details.
Vendors	Retrieve all vendors.

AddressEmailAddresses

Retrieve vendor address data email addresses.

View-Specific Information

Select

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

SMVendorId supports the '=' comparison operator.

For example, the following query is processed server side:

SELECT * FROM AddressEmailAddresses WHERE SMVendorId = 'S123456'

Columns


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

Addresses

Retrieve vendor address data.

View-Specific Information

Select

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

SMVendorId supports the '=' comparison operator.

For example, the following query is processed server side:

SELECT * FROM Addresses WHERE SMVendorId = 'S123456'

Columns


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

AddressFaxNumbers

Retrieve vendor address data fax numbers.

View-Specific Information

Select

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

SMVendorId supports the '=' comparison operator.

For example, the following query is processed server side:

SELECT * FROM AddressFaxNumbers WHERE SMVendorId = 'S123456'

Columns


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

AddressPhoneNumbers

Retrieve vendor address data phone numbers.

View-Specific Information

Select

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

SMVendorId supports the '=' comparison operator.

For example, the following query is processed server side:

SELECT * FROM AddressPhoneNumbers WHERE SMVendorId = 'S123456'

Columns


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

AddressWebsites

Retrieve vendor address data websites.

View-Specific Information

Select

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

SMVendorId supports the '=' comparison operator.

For example, the following query is processed server side:

SELECT * FROM AddressWebsites WHERE SMVendorId = 'S123456'

Columns


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

BankAccounts

Retrieve vendor bank accounts.

View-Specific Information

Select

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

SMVendorId supports the '=' comparison operator.

For example, the following query is processed server side:

SELECT * FROM BankAccounts WHERE SMVendorId = 'S123456'

Columns


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

BankInfos

Retrieve vendor bank related data.

View-Specific Information

Select

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

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

For example, the following queries are processed server side:

SELECT * FROM BankInfos WHERE SMVendorID = 'S123456'

SELECT * FROM BankInfos WHERE ERPVendorId = '1000003560'

SELECT * FROM BankInfos WHERE VendorRegistrationStatus = 'Registered'

SELECT * FROM BankInfos WHERE VendorQualificationStatus = 'Qualified'

SELECT * FROM BankInfos WHERE VendorPreferredLevel = 1

SELECT * FROM BankInfos WHERE VendorBusinessUnit = '408'

SELECT * FROM BankInfos WHERE VendorCategory = '51'

SELECT * FROM BankInfos WHERE VendorRegion = 'USA'

Columns


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

CompanyCodes

Retrieve vendor company code related details.

View-Specific Information

Select

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

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

For example, the following queries are processed server side:

SELECT * FROM CompanyCodes WHERE SMVendorID = 'S123456'

SELECT * FROM CompanyCodes WHERE ERPVendorId = '1000003560'

SELECT * FROM CompanyCodes WHERE VendorRegistrationStatus = 'Registered'

SELECT * FROM CompanyCodes WHERE VendorQualificationStatus = 'Qualified'

SELECT * FROM CompanyCodes WHERE VendorPreferredLevel = 1

SELECT * FROM CompanyCodes WHERE VendorBusinessUnit = '408'

SELECT * FROM CompanyCodes WHERE VendorCategory = '51'

SELECT * FROM CompanyCodes WHERE VendorRegion = 'USA'

Columns


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

Contacts

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

View-Specific Information

Select

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

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

For example, the following queries are processed server side:

SELECT * FROM Contacts WHERE SMVendorId = 'S123456'

SELECT * FROM Contacts WHERE ERPVendorId = '1000005002'

SELECT * FROM Contacts WHERE ACMId = '1000005002'

Columns


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

Customers

Retrieve vendor customer information.

View-Specific Information

Select

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

SMVendorId supports the '=' comparison operator.

For example, the following query is processed server side:

SELECT * FROM Customers WHERE SMVendorId = 'S123456'

Columns


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

CustomerSalesArrangements

Retrieve vendor customer information sales arrangements.

View-Specific Information

Select

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

SMVendorId supports the '=' comparison operator.

For example, the following query is processed server side:

SELECT * FROM CustomerSalesArrangements WHERE SMVendorId = 'S123456'

Columns


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

Identifications

Retrieve vendor identifications.

View-Specific Information

Select

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

SMVendorId supports the '=' comparison operator.

For example, the following query is processed server side:

SELECT * FROM Identifications WHERE SMVendorId = 'S123456'

Columns


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

Qualifications

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

View-Specific Information

Select

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

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

For example, the following queries are processed server side:

SELECT * FROM Qualifications WHERE SMVendorID = 'S123456'

SELECT * FROM Qualifications WHERE ERPVendorId = '1000003560'

SELECT * FROM Qualifications WHERE VendorRegistrationStatus = 'Registered'

SELECT * FROM Qualifications WHERE VendorQualificationStatus = 'Qualified'

SELECT * FROM Qualifications WHERE VendorPreferredLevel = 1

SELECT * FROM Qualifications WHERE VendorBusinessUnit = '408'

SELECT * FROM Qualifications WHERE VendorCategory = '51'

SELECT * FROM Qualifications WHERE VendorRegion = 'USA'

Columns


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

Questionnaires

Retrieve vendor questionnaires.

View-Specific Information

Select

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

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

For example, the following queries are processed server side:

SELECT * FROM Questionnaires WHERE SMVendorID = 'S123456'

SELECT * FROM Questionnaires WHERE ERPVendorId = '1000003560'

SELECT * FROM Questionnaires WHERE VendorRegistrationStatus = 'Registered'

SELECT * FROM Questionnaires WHERE VendorQualificationStatus = 'Qualified'

SELECT * FROM Questionnaires WHERE VendorPreferredLevel = 1

SELECT * FROM Questionnaires WHERE VendorBusinessUnit = '408'

SELECT * FROM Questionnaires WHERE VendorCategory = '51'

SELECT * FROM Questionnaires WHERE VendorRegion = 'USA'

Columns


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

SupplierAccounting

Retrieve vendor supplier accounting information.

View-Specific Information

Select

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

SMVendorId supports the '=' comparison operator.

For example, the following query is processed server side:

SELECT * FROM SupplierAccounting WHERE SMVendorID = 'S123456'

Columns


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

SupplierPurchasingArrangements

Retrieve vendor supplier information purchasing arrangements.

View-Specific Information

Select

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

SMVendorId supports the '=' comparison operator.

For example, the following query is processed server side:

SELECT * FROM SupplierPurchasingArrangements WHERE SMVendorId = 'S123456'

Columns


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

Suppliers

Retrieve vendor supplier information.

View-Specific Information

Select

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

SMVendorId supports the '=' comparison operator.

For example, the following query is processed server side:

SELECT * FROM Suppliers WHERE SMVendorId = 'S123456'

Columns


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

VendorDetails

Retrieve vendor details.

View-Specific Information

Select

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

SMVendorId supports the '=' comparison operator.

For example, the following query is processed server side:

SELECT * FROM VendorDetails WHERE SMVendorId = 'S123456'

Columns


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

Vendors

Retrieve all vendors.

View-Specific Information

Select

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

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

For example, the following queries are processed server side:

SELECT * FROM Vendors WHERE SMVendorId = 'S123456'

SELECT * FROM Vendors WHERE RegistrationStatus = 'Registered'

SELECT * FROM Vendors WHERE QualificationStatus = 'Qualified'

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

SELECT * FROM Vendors WHERE PreferredLevel = 1

SELECT * FROM Vendors WHERE BusinessUnit = '408'

SELECT * FROM Vendors WHERE Category = '51'

SELECT * FROM Vendors WHERE Region = 'USA'

Columns


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

Sourcing Project Management API V2 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 Sync App 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 Sync App.

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

Tables

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

SAP Ariba Source Connector for CData Sync 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.

Projects

Retrieve details about the specified sourcing project.

View-Specific Information

Select

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

ProjectId supports the '=' comparison operator.

For example, the following query is processed server side:

SELECT * FROM Projects WHERE ProjectId = 'WS12345'

Update

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

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

Columns


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

Teams

Retrieve teams information specified in a sourcing project.

View-Specific Information

Select

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

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

For example, the following queries are processed server side:

SELECT * FROM Teams WHERE Id = 'PG17371157'

SELECT * FROM Teams WHERE ProjectId = 'WS12345'

Update

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

Users and groups cannot be updated in the same statement.

For example:

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

Columns


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

TeamUsers

Retrieve team user information specified in a sourcing project.

View-Specific Information

Select

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

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

For example, the following queries are processed server side:

SELECT * FROM TeamUsers WHERE TeamId = 'PG17371157'

SELECT * FROM TeamUsers WHERE ProjectId = 'WS12345'

Insert

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

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

Columns


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

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.

SAP Ariba Source Connector for CData Sync 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.

Documents

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

View-Specific Information

Select

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

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

For example, the following queries are processed server side:

SELECT * FROM Documents WHERE InternalId = 'Doc17975275'

SELECT * FROM Documents WHERE ProjectId = 'WS12345'

Columns


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

History

Gets all history specified in a sourcing project.

View-Specific Information

Select

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

ProjectId supports the '=' comparison operator.

For example, the following query is processed server side:

SELECT * FROM History WHERE ProjectId = 'WS12345'

Columns


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

TaskActiveApproverUsers

Retrieve task active approver users.

View-Specific Information

Select

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

ProjectId supports the '=' comparison operator.

For example, the following query is processed server side:

SELECT * FROM TaskActiveApproverUsers WHERE ProjectId = 'WS12345'

Columns


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

TaskApprovalRequests

Retrieve task approval requests.

View-Specific Information

Select

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

ProjectId supports the '=' comparison operator.

For example, the following query is processed server side:

SELECT * FROM TaskApprovalRequests WHERE ProjectId = 'WS12345'

Columns


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

TaskApproverGroups

Retrieve task approver groups.

View-Specific Information

Select

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

ProjectId supports the '=' comparison operator.

For example, the following query is processed server side:

SELECT * FROM TaskApproverGroups WHERE ProjectId = 'WS12345'

Columns


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

TaskApprovers

Retrieve all task approvers.

View-Specific Information

Select

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

ProjectId supports the '=' comparison operator.

For example, the following query is processed server side:

SELECT * FROM TaskApprovers WHERE ProjectId = 'WS12345'

Columns


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

TaskCommentAttachments

Retrieve all task comments attachments.

View-Specific Information

Select

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

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

For example, the following queries are processed server side:

SELECT * FROM TaskCommentAttachments WHERE TaskId = 'TSK17371161'

SELECT * FROM TaskCommentAttachments WHERE ProjectId = 'WS12345'

Columns


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

TaskComments

Retrieve all tasks comments of a specified task.

View-Specific Information

Select

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

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

For example, the following queries areare processed server side:

SELECT * FROM TaskComments WHERE TaskId = 'TSK17371161'

SELECT * FROM TaskComments WHERE IncludePreviousRounds = 'true'

SELECT * FROM TaskComments WHERE ProjectId = 'WS12345'

Columns


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

Tasks

Retrieve all tasks specified in a sourcing project.

View-Specific Information

Select

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

ProjectId supports the '=' comparison operator.

For example, the following query is processed server side:

SELECT * FROM Tasks WHERE ProjectId = 'WS12345'

Columns


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

TeamGroups

Retrieve team group information specified in a sourcing project.

View-Specific Information

Select

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

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

For example, the following queries are processed server side:

SELECT * FROM TeamGroups WHERE TeamId = 'PG17371157'

SELECT * FROM TeamGroups WHERE ProjectId = 'WS12345'

Columns


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

Contract API V1 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 Sync App 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 Sync App.

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.

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.

SAP Ariba Source Connector for CData Sync 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.

AffectedParties

Retrieve contract workspace affected parties.

View-Specific Information

Select

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

ContractId supports the '=' comparison operator.

For example, the following query is processed server side:

SELECT * FROM AffectedParties WHERE ContractId = 'CW0001'

Columns


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

CreationSupplierClassifications

Retrieve contract workspace creation supplier classifications.

View-Specific Information

Select

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

ContractId supports the '=' comparison operator.

For example, the following query is processed server side:

SELECT * FROM CreationSupplierClassifications WHERE ContractId = 'CW0001'

Columns


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

IntegrationSupplierClassifications

Retrieve contract workspace integration supplier classifications.

View-Specific Information

Select

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

ContractId supports the '=' comparison operator.

For example, the following query is processed server side:

SELECT * FROM IntegrationSupplierClassifications WHERE ContractId = 'CW0001'

Columns


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

LineItemDocumentProperties

Retrieve Contract Line Items Document metadata.

View-Specific Information

Select

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

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

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

For example, the following queries are processed server side:

SELECT * FROM LineItemDocumentProperties WHERE Id = 'Doc27061'

SELECT * FROM LineItemDocumentProperties WHERE ContractId = 'CW0001'

Columns


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

PublishingSupplierClassifications

Retrieve contract workspace publishing supplier classifications.

View-Specific Information

Select

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

ContractId supports the '=' comparison operator.

For example, the following query is processed server side:

SELECT * FROM PublishingSupplierClassifications WHERE ContractId = 'CW0001'

Columns


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

Terms

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

View-Specific Information

Select

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

ContractId supports the '=' comparison operator.

For example, the following query is processed server side:

SELECT * FROM Terms WHERE ContractId = 'CW0001'

Columns


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

Workspaces

Retrieve contract workspaces.

View-Specific Information

Select

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

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

For example, the following queries are processed server side:

SELECT * FROM Workspaces WHERE ContractId = 'CW0001'

SELECT * FROM Workspaces WHERE ContractStatus = 'EXAMPLE'

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

Columns


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

Risk Category Information API For Supplier Risk Exposure V1 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.

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

Property	Description
API	Specify which API you would like the provider to retrieve SAP Ariba data from.
APIKey	Your OAuth application key.
AuthScheme	Set the type of authentication to use when connecting to SAP Ariba.
Environment	The environment to use when connecting to SAP Ariba.
DataCenter	The data center where your account's data is hosted.
Realm	Specify the realm from which you would like to access data.
ProjectId	The Id of the sourcing project for which information will be retrieved.
User	The user Id of a SAP Ariba user.
PasswordAdapter	The password associated with the selected User .

OAuth

Property	Description
OAuthClientId	Specifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server.
OAuthClientSecret	Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server.

SSL

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

Firewall

Property	Description
FirewallType	Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.
FirewallServer	Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.
FirewallPort	Specifies the TCP port to be used for a proxy-based firewall.
FirewallUser	Identifies the user ID of the account authenticating to a proxy-based firewall.
FirewallPassword	Specifies the password of the user account authenticating to a proxy-based firewall.

Proxy

Property	Description
ProxyAutoDetect	Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.
ProxyServer	The hostname or IP address of the proxy server that you want to route HTTP traffic through.
ProxyPort	The TCP port on your specified proxy server (set in the ProxyServer connection property) that has been reserved for routing HTTP traffic to and from the client.
ProxyAuthScheme	Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.
ProxyUser	The username of a user account registered with the proxy server specified in the ProxyServer connection property.
ProxyPassword	The password associated with the user specified in the ProxyUser connection property.
ProxySSLType	The SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
ProxyExceptions	A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.

Logging

Property	Description
LogModules	Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.

Schema

Property	Description
Location	Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.
BrowsableSchemas	Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
Tables	Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .
Views	Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .
TypeDetectionScheme	Determines how the data type of columns created from custom fields in the SupplierDataAPIWithPagination-V4 schema's Vendors view is determined.

Miscellaneous

Property	Description
IncludeCustomFields	Determines whether the provider exposes custom fields in SAP Ariba tables as columns.
MaxRows	Specifies the maximum rows returned for queries without aggregation or GROUP BY.
MaxThreads	Specifies the maximum number of concurrent requests the provider can execute to SAP Ariba.
Other	Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.
Pagesize	Specifies the maximum number of results to return from SAP Ariba, per page. This setting overrides the default page size set by the datasource, which is optimized for most use cases.
PseudoColumns	Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.
RowScanDepth	The maximum number of rows to scan to look for the columns available in a table.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.
UserDefinedViews	Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.

Authentication

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

Property	Description
API	Specify which API you would like the provider to retrieve SAP Ariba data from.
APIKey	Your OAuth application key.
AuthScheme	Set the type of authentication to use when connecting to SAP Ariba.
Environment	The environment to use when connecting to SAP Ariba.
DataCenter	The data center where your account's data is hosted.
Realm	Specify the realm from which you would like to access data.
ProjectId	The Id of the sourcing project for which information will be retrieved.
User	The user Id of a SAP Ariba user.
PasswordAdapter	The password associated with the selected User .

API

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

Remarks

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

APIKey

Your OAuth application key.

Remarks

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

AuthScheme

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

Remarks

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

Environment

The environment to use when connecting to SAP Ariba.

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.

DataCenter

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

Remarks

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

Realm

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

Remarks

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

ProjectId

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

Remarks

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

User

The user Id of a SAP Ariba user.

Remarks

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

This property specifies the user account the Sync App uses in API requests.

PasswordAdapter

The password associated with the selected User .

Remarks

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

This property authenticates the selected User account.

OAuth

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

Property	Description
OAuthClientId	Specifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server.
OAuthClientSecret	Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server.

OAuthClientId

Specifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server.

Remarks

OAuthClientId is one of a handful of connection parameters that need to be set before users can authenticate via OAuth. For details, see Establishing a Connection.

OAuthClientSecret

Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server.

Remarks

OAuthClientSecret is one of a handful of connection parameters that need to be set before users can authenticate via OAuth. For details, see Establishing a Connection.

SSL

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

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

SSLServerCert

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

Remarks

If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is 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

If not specified, any certificate trusted by the machine is accepted.

Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.

Firewall

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

Property	Description
FirewallType	Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.
FirewallServer	Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.
FirewallPort	Specifies the TCP port to be used for a proxy-based firewall.
FirewallUser	Identifies the user ID of the account authenticating to a proxy-based firewall.
FirewallPassword	Specifies the password of the user account authenticating to a proxy-based firewall.

FirewallType

Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

Note: By default, the Sync App connects to the system proxy. To disable this behavior and connect to one of the following proxy types, set ProxyAutoDetect to false.

The following table provides port number information for each of the supported protocols.


Protocol	Default Port	Description
TUNNEL	80	The port where the Sync App opens a connection to SAP Ariba. Traffic flows back and forth via the proxy at this location.
SOCKS4	1080	The port where the Sync App opens a connection to SAP Ariba. SOCKS 4 then passes theFirewallUser value to the proxy, which determines whether the connection request should be granted.
SOCKS5	1080	The port where the Sync App sends data to SAP Ariba. If the SOCKS 5 proxy requires authentication, set FirewallUser and FirewallPassword to credentials the proxy recognizes.

To connect to HTTP proxies, use ProxyServer and ProxyPort. To authenticate to HTTP proxies, use ProxyAuthScheme, ProxyUser, and ProxyPassword.

FirewallServer

Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

FirewallPort

Specifies the TCP port to be used for a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

FirewallUser

Identifies the user ID of the account authenticating to a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

FirewallPassword

Specifies the password of the user account authenticating to a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

Proxy

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

Property	Description
ProxyAutoDetect	Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.
ProxyServer	The hostname or IP address of the proxy server that you want to route HTTP traffic through.
ProxyPort	The TCP port on your specified proxy server (set in the ProxyServer connection property) that has been reserved for routing HTTP traffic to and from the client.
ProxyAuthScheme	Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.
ProxyUser	The username of a user account registered with the proxy server specified in the ProxyServer connection property.
ProxyPassword	The password associated with the user specified in the ProxyUser connection property.
ProxySSLType	The SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
ProxyExceptions	A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.

ProxyAutoDetect

Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.

Remarks

When this connection property is set to True, the Sync App checks your system proxy settings for existing proxy server configurations (no need to manually supply proxy server details).

This connection property takes precedence over other proxy settings. Set to False if you want to manually configure the Sync App to connect to a specific proxy server.

To connect to an HTTP proxy, see ProxyServer. For other proxies, such as SOCKS or tunneling, see FirewallType.

ProxyServer

The hostname or IP address of the proxy server that you want to route HTTP traffic through.

Remarks

The Sync App only routes HTTP traffic through the proxy server specified in this connection property when ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead routes HTTP traffic through the proxy server specified in your system proxy settings.

ProxyPort

The TCP port on your specified proxy server (set in the ProxyServer connection property) that has been reserved for routing HTTP traffic to and from the client.

Remarks

The Sync App only routes HTTP traffic through the proxy server port specified in this connection property when ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead routes HTTP traffic through the proxy server port specified in your system proxy settings.

For other proxy types, see FirewallType.

ProxyAuthScheme

Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.

Remarks

The authentication type can be one of the following:

BASIC: The Sync App performs HTTP BASIC authentication.
DIGEST: The Sync App performs HTTP DIGEST authentication.
NTLM: The Sync App retrieves an NTLM token.
NEGOTIATE: The Sync App retrieves an NTLM or Kerberos token based on the applicable protocol for authentication.
NONE: Set this when the ProxyServer does not require authentication.

For all values other than "NONE", you must also set the ProxyUser and ProxyPassword connection properties.

If you need to use another authentication type, such as SOCKS 5 authentication, see FirewallType.

ProxyUser

The username of a user account registered with the proxy server specified in the ProxyServer connection property.

Remarks

The ProxyUser and ProxyPassword connection properties are used to connect and authenticate against the HTTP proxy specified in ProxyServer.

After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:


ProxyAuthScheme Value	Value to set for ProxyUser
BASIC	The user name of a user registered with the proxy server.
DIGEST	The user name of a user registered with the proxy server.
NEGOTIATE	The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format `user@domain` or `domain\user`.
NTLM	The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format `user@domain` or `domain\user`.
NONE	Do not set the ProxyPassword connection property.

The Sync App only uses this username if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead uses the username specified in your system proxy settings.

ProxyPassword

The password associated with the user specified in the ProxyUser connection property.

Remarks

The ProxyUser and ProxyPassword connection properties are used to connect and authenticate against the HTTP proxy specified in ProxyServer.

After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:


ProxyAuthScheme Value	Value to set for ProxyPassword
BASIC	The password associated with the proxy server user specified in ProxyUser.
DIGEST	The password associated with the proxy server user specified in ProxyUser.
NEGOTIATE	The password associated with the Windows user account specified in ProxyUser.
NTLM	The password associated with the Windows user account specified in ProxyUser.
NONE	Do not set the ProxyPassword connection property.

For SOCKS 5 authentication or tunneling, see FirewallType.

The Sync App only uses this password if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead uses the password specified in your system proxy settings.

ProxySSLType

The SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.

Remarks

This property determines when to use SSL for the connection to the HTTP proxy specified by ProxyServer. You can set this connection property to the following values :


AUTO	Default setting. If ProxyServer is set to an HTTPS URL, the Sync App uses the TUNNEL option. If ProxyServer is set to an HTTP URL, the component uses the NEVER option.
ALWAYS	The connection is always SSL enabled.
NEVER	The connection is not SSL enabled.
TUNNEL	The connection is made through a tunneling proxy. The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy.

ProxyExceptions

A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.

Remarks

The ProxyServer is used for all addresses, except for addresses defined in this property. Use semicolons to separate entries.

Note that the Sync App uses the system proxy settings by default, without further configuration needed. If you want to explicitly configure proxy exceptions for this connection, set ProxyAutoDetect to False.

Logging

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

Property	Description
LogModules	Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.

LogModules

Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.

Remarks

This property lets you customize the log file content by specifying the logging modules to include. Logging modules categorize logged information into distinct areas, such as query execution, metadata, or SSL communication. Each module is represented by a four-character code, with some requiring a trailing space for three-letter names.

For example, EXEC logs query execution, and INFO logs general provider messages. To include multiple modules, separate their names with semicolons as follows: INFO;EXEC;SSL.

The Verbosity connection property takes precedence over the module-based filtering specified by this property. Only log entries that meet the verbosity level and belong to the specified modules are logged. Leave this property blank to include all available modules in the log file.

For a complete list of available modules and detailed guidance on configuring logging, refer to the Advanced Logging section in Logging.

Schema

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

Property	Description
Location	Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.
BrowsableSchemas	Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
Tables	Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .
Views	Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .
TypeDetectionScheme	Determines how the data type of columns created from custom fields in the SupplierDataAPIWithPagination-V4 schema's Vendors view is determined.

Location

Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.

Remarks

The Location property is only needed if you want to either customize definitions (for example, change a column name, ignore a column, etc.) or extend the data model with new tables, views, or stored procedures.

If left unspecified, the default location is %APPDATA%\\CData\\SAPAribaSource Data Provider\\Schema, where %APPDATA% is set to the user's configuration directory:


Platform	%APPDATA%
Windows	The value of the APPDATA environment variable
Linux	~/.config

BrowsableSchemas

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

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.

Tables

Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .

Remarks

Listing all available tables from some databases can take extra time, thus degrading performance. Providing a list of tables in the connection string saves time and improves performance.

If there are lots of tables available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those tables. To do this, specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.

Note: If you are connecting to a data source with multiple schemas or catalogs, you must specify each table you want to view by its fully qualified name. This avoids ambiguity between tables that may exist in multiple catalogs or schemas.

Views

Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .

Remarks

Listing all available views from some databases can take extra time, thus degrading performance. Providing a list of views in the connection string saves time and improves performance.

If there are lots of views available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those views. To do this, specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.

Note: If you are connecting to a data source with multiple schemas or catalogs, you must specify each view you want to examine by its fully qualified name. This avoids ambiguity between views that may exist in multiple catalogs or schemas.

TypeDetectionScheme

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

Remarks


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

Miscellaneous

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

Property	Description
IncludeCustomFields	Determines whether the provider exposes custom fields in SAP Ariba tables as columns.
MaxRows	Specifies the maximum rows returned for queries without aggregation or GROUP BY.
MaxThreads	Specifies the maximum number of concurrent requests the provider can execute to SAP Ariba.
Other	Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.
Pagesize	Specifies the maximum number of results to return from SAP Ariba, per page. This setting overrides the default page size set by the datasource, which is optimized for most use cases.
PseudoColumns	Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.
RowScanDepth	The maximum number of rows to scan to look for the columns available in a table.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.
UserDefinedViews	Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.

IncludeCustomFields

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

Remarks

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

MaxRows

Specifies the maximum rows returned for queries without aggregation or GROUP BY.

Remarks

This property sets an upper limit on the number of rows the Sync App returns for queries that do not include aggregation or GROUP BY clauses. This limit ensures that queries do not return excessively large result sets by default.

When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting. If MaxRows is set to "-1", no row limit is enforced unless a LIMIT clause is explicitly included in the query.

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

MaxThreads

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

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.

Other

Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.

Remarks

This property allows advanced users to configure hidden properties for specialized scenarios. These settings are not required for normal use cases but can address unique requirements or provide additional functionality. Multiple properties can be defined in a semicolon-separated list.

Note: It is strongly recommended to set these properties only when advised by the support team to address specific scenarios or issues.

Specify multiple properties in a semicolon-separated list.

Integration and Formatting


DefaultColumnSize	Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000.
ConvertDateTimeToGMT	Determines whether to convert date-time values to GMT, instead of the local time of the machine.
RecordToFile=filename	Records the underlying socket data transfer to the specified file.

Pagesize

Specifies the maximum number of results to return from SAP Ariba, per page. This setting overrides the default page size set by the datasource, which is optimized for most use cases.

Remarks

You may want to adjust the default pagesize to optimize results for a particular object or service endpoint you are querying. Be aware that increasing the page size may improve performance, but it could also result in higher memory consumption per page.

PseudoColumns

Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.

Remarks

This property allows you to define which pseudocolumns the Sync App 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: "*=*"

RowScanDepth

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

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.

Timeout

Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.

Remarks

This property controls the maximum time, in seconds, that the Sync App waits for an operation to complete before canceling it. If the timeout period expires before the operation finishes, the Sync App cancels the operation and throws an exception.

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.

Setting this property to 0 disables the timeout, allowing 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. Use this property cautiously to avoid long-running operations that could degrade performance or result in unresponsive behavior.

UserDefinedViews

Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.

Remarks

This property allows you to define and manage custom views through a JSON-formatted configuration file called UserDefinedViews.json. These views are automatically recognized by the Sync App and enable you to execute custom SQL queries as if they were standard database views. The JSON file defines each view as a root element with a child element called "query", which contains the SQL query for the view. For example:

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

You can define multiple views in a single file and specify the filepath using this property. For example: UserDefinedViews=C:\Path\To\UserDefinedViews.json. When you use this property, only the specified views are seen by the Sync App.

Refer to User Defined Views for more information.

SAP Ariba Source Connector for CData Sync

SAP Ariba Source Connector for CData Sync

Overview

SAP Ariba Version Support

Establishing a Connection

Adding a Connection to SAP Ariba

Connecting to SAP Ariba

Authenticating to SAP Ariba

OAuthClient

Automatic OAuth

Manual OAuth

Creating a Custom OAuth App

Create a Custom OAuth App

Advanced Features

User Defined Views

SSL Configuration

Firewall and Proxy

Query Processing

Logging

SSL Configuration

Customizing the SSL Configuration

Firewall and Proxy

Connecting Through a Firewall or Proxy

HTTP Proxies

Other Proxies

Data Model

Using Supplier Data API With Pagination V4

Using Sourcing Project Management API V2

Using Contract API V1

Using Risk Category Information API For Supplier Risk Exposure V1

Supplier Data API With Pagination V4 Data Model

Overview

Key Features

Views

Stored Procedures

Views

SAP Ariba Source Connector for CData Sync Views

AddressEmailAddresses

View-Specific Information

Select

Columns

Addresses

View-Specific Information

Select

Columns

AddressFaxNumbers

View-Specific Information

Select

Columns

AddressPhoneNumbers

View-Specific Information

Select

Columns

AddressWebsites

View-Specific Information

Select

Columns

BankAccounts

View-Specific Information

Select

Columns

BankInfos

View-Specific Information

Select

Columns

CompanyCodes

View-Specific Information

Select

Columns

Contacts

View-Specific Information

Select

Columns

Customers

View-Specific Information

Select

Columns

CustomerSalesArrangements

View-Specific Information

Select