CData Sync App は、SAP Ariba Procurement データをデータベース、データレイク、またはデータウェアハウスに継続的にパイプライン化する簡単な方法を提供し、分析、レポート、AI、および機械学習で簡単に利用できるようにします。
SAP Ariba コネクタはCData Sync アプリケーションから使用可能で、SAP Ariba からデータを取得して、サポートされている任意の同期先に移動できます。
Sync App は、SAP Ariba Purchase Orders Buyer API およびPurchase Orders Supplier API のV1 を活用し、SAP Ariba データへのアクセスを可能にします。
必須プロパティについては、設定タブを参照してください。
通常必須ではない接続プロパティについては、高度な設定タブを参照してください。
接続するには以下を設定します。
SAP Ariba API への認証はOAuth 経由で行われます。SAP Ariba のOAuth フローは、ユーザーインタラクションを必要としません。
AuthScheme をOAuthClient に設定します。
サービスにアプリケーションを登録し、APIKey、OAuthClientId、およびOAuthClientSecret を取得する必要があります。
アプリケーションの作成については、カスタムOAuth アプリの作成 を参照してください。
InitiateOAuth のデフォルトは、OAuthClient 認証スキームのGETANDREFRESH です。
OAuth アクセストークンの取得およびリフレッシュ
以下を設定して、接続してください。
接続すると、Sync App は自動でOAuth プロセスを完了します。
OAuth アクセストークンの取得
次の接続プロパティを設定し、OAuthAccessToken を取得します。
次に、GetOAuthAccessToken ストアドプロシージャを呼び出します。GrantType インプットをclient_credentials またはopenapi_2lo(レガシーユーザーで利用可能)に設定します。指定されていない場合、GrantType のデフォルトはclient_credentials になります。
アクセストークンとリフレッシュトークンを取得した後、データに接続し、OAuth アクセストークンを自動または手動でリフレッシュすることが可能です。
OAuth アクセストークンの自動リフレッシュ
Sync App がOAuth アクセストークンを自動的にリフレッシュするようにするには、最初のデータ接続で次のように設定します。
OAuth アクセストークンの手動リフレッシュ
データ接続時に手動でOAuth アクセストークンをリフレッシュするために必要な値は、OAuth リフレッシュトークンのみです。 GetOAuthAccessToken によって返されたExpiresIn パラメータ値が経過した後に、RefreshOAuthAccessToken ストアドプロシージャを使用し、手動でOAuthAccessToken をリフレッシュします。次の接続プロパティを設定します。
次に、RefreshOAuthAccessToken を呼び出し、OAuthRefreshToken にGetOAuthAccessToken によって返されたOAuth リフレッシュトークンを指定します。新しいトークンが取得できたら、OAuthAccessToken プロパティにRefreshOAuthAccessToken によって返された値を設定し、新しい接続をオープンします。
最後に、OAuth リフレッシュトークンを保存し、OAuth アクセストークンの有効期限が切れた後に手動でリフレッシュできるようにします。
APIKey、OAuthClientId、およびOAuthClientSecret を取得するには、次の手順を実行してください。
このセクションでは、SAP Ariba Sync App の高度な機能を厳選して説明します。
Sync App はユーザー定義ビューの使用をサポートします。これは事前設定されたユーザー定義クエリによって内容が決定される仮想テーブルです。 このビューは、ドライバーに発行されるクエリを直接制御できない場合に有効です。 カスタムビューの作成と設定の概要については、ユーザー定義ビュー を参照してください。
SSL の設定 を使用して、Sync App が証明書のネゴシエーションをどのように扱うかを調整します。さまざまな証明書形式を選択できます。詳しくは、「接続文字列オプション」にあるSSLServerCert プロパティを参照してください。
Windows プロキシとHTTP プロキシを含むファイアウォールとプロキシ に合致するようSync App を設定します。トンネル接続を設定することもできます。
詳しくは、クエリ処理 を参照してください。
デフォルトでは、Sync App はサーバーとのTLS のネゴシエーションを試みます。サーバー証明書は、デフォルトのシステム信頼済み証明書ストアで検証されます。SSLServerCert 接続プロパティを使用して、証明書の検証方法をオーバーライドできます。
別の証明書を指定するには、SSLServerCert 接続プロパティを参照してください。
HTTP プロキシへの認証には、以下のように設定します。
次のプロパティを設定します。
CData Sync App は、SAP Ariba API のエンティティをビューおよびストアドプロシージャにモデル化します。これらはスキーマファイルにて定義されます。スキーマファイルは、簡単にカスタマイズできるシンプルなテキストベースのコンフィギュレーションファイルです。
Purchase Orders Buyer API V1 で利用可能なエンティティについては、Purchase Orders Buyer API V1 データモデル を参照してください。
Purchase Orders Supplier API V1 で利用可能なエンティティについては、Purchase Orders Supplier API V1 データモデル を参照してください。
Operational Reporting API For Procurement V2 で利用可能なエンティティおよびビューテンプレート例については、Operational Reporting API For Procurement V2 データモデル を参照してください。
このセクションでは、Purchase Orders Buyer API で利用可能なオブジェクトを示し、SQL の使用についての詳細を説明します。
ビュー は、SAP Ariba オーダーをモデル化する読み取り専用のテーブルです。
ストアドプロシージャ は、OAuth トークン管理などのタスクを実行する、データソースのファンクションライクなインターフェースです。
Retrieves line-item information from purchase orders.
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.
SELECT * FROM LineItems WHERE DocumentNumber = 'DO240'
SELECT * FROM LineItems WHERE OrderStatus = 'CHANGED'
SELECT * FROM LineItems WHERE RoutingStatus = 'Sent'
SELECT * FROM LineItems WHERE StartDate = '2000-01-01T00:00:00' AND EndDate = '2000-01-15T01:00:00'
| Name | Type | References | Description |
| LineNumber [KEY] | Int | Position (counting from 1) of this item in an order. Used to maintain a reference between items in create and update OrderRequest documents. | |
| DocumentNumber [KEY] | String |
Orders.DocumentNumber | Same as the orderID. The documentNumber is an identifier for a particular order, similar to the purchase order number. |
| Eanid | String | The European Article Number, EAN, barcode. | |
| Unspsc | String | The United Nations Standard Products and Services Code, UNSPSC, classification. | |
| Priority | Int | Priority indicator, used to drive the priority of the orders for the suppliers. | |
| ProductIdentifier | String | Reference product number. | |
| LineOfBusiness | String | Line of business. | |
| ProductFamily | String | Product family. | |
| ProductSubFamily | String | Product sub family. | |
| ProductCode | String | Product code. | |
| PartCategory | String | Part category. | |
| PartType | String | Part type. | |
| Category | String | Category. | |
| SupplierPart | String | SupplierPartID is how the supplier identifies an item. | |
| SupplierBatchId | String | An identifier from supplier to identify the material/goods produced in a single manufacturing run. | |
| BuyerPartId | String | It represents a product in buyer system. This identifier is specified by the buyer. | |
| BuyerBatchId | String | An identifier from buyer to identify the material/goods produced in a single manufacturing run. | |
| ManufacturerName | String | The manufacturer's name. | |
| ManufacturerPartId | String | The manufacturer's part number. | |
| PlannerCode | String | Planner code. | |
| PlannerDescription | String | Planner description. | |
| Description | String | Description of the items. | |
| MaterialGoAheadEndDate | Datetime | Date denoting the end of the material go-ahead period (go-ahead for purchase of input materials). | |
| ProductionGoAheadEndDate | Datetime | Date denoting the end of the production go-ahead period. | |
| AgreementId | String | The procurement system agreement ID for this request. | |
| AgreementDate | Datetime | The date and time the agreement request was created. This is different from the effective and expiry date of the agreement. | |
| NeedBy | Datetime | The date this item was requested for delivery. | |
| RequestedDeliveryDate | Datetime | The date this item was requested for delivery. | |
| RequestedShipmentDate | Datetime | The ship date requested by the buyer for the item. | |
| PreviousAsnId | String | Previous ship notice ID. | |
| PreviousAsnDate | Datetime | Previous ship notice date. | |
| IsoCountryCode | String | The International Organization for Standardization (ISO) country code for the country in the shipping address. | |
| ItemShipToStreet | String | The Street element is the street address of the ShipTo location where ordered products are to be delivered. | |
| ItemShipToCity | String | The City element is the city where ordered products are to be shipped. | |
| ItemShipToState | String | The State element is a two-letter state, province, or territory code for the location where the goods are to be shipped. | |
| ItemShipToCountry | String | The Country element is the country where goods are to be shipped. | |
| ItemShipToCode | String | Item ship to code. | |
| ItemShipToPostalCode | String | The PostalCode element is the postal or zip code where goods are to be shipped. | |
| ItemShipToName | String | For ship to, the Name element value should be the company or organization of the employee receiving ordered products. | |
| ItemReturnAuthorizationNumber | String | Return Authorization Number information for a line item. | |
| ReleaseType | String | A string value to identify the type of release. The value will be either jit or forecast. | |
| ItemLocation | String | Item location. | |
| StorageLocation | String | Storage location. | |
| Quantity | Double | How many items are desired. Supplier and Commodity level items in an order of type 'blanket' will use a default value of '1'. The quantity in this case will not be used to compute the sub total. The MaxAmount in the BlanketItemDetail will be used to indicate any line level amounts. | |
| UnitOfMeasure | String | The UnitOfMeasure element contains the item Unit of Measure code as defined by the United Nations UOM standard. | |
| PbqQuantity | Double | The PriceBasisQuantity element contains the quantity-based pricing for a line item. Quantity-based Pricing is commonly also referred to as Price-Based Quantity or PBQ. Quantity-based pricing allows the unit price of an item to be based on a different price unit quantity than 1. | |
| PbqUOM | String | Unit of measure for the PriceBasisQuantity. | |
| PbqConversionFactor | Double | Conversion factor for the PriceBasisQuantity. | |
| ConfirmedQuantity | Double | Confirmed quantity. | |
| PreviousReceivedQuantity | Double | Previous received quantity. | |
| PreviousReceivedQuantityUom | String | Unit of measure for the previous received quantity. | |
| CumulativeShipQuantity | Double | A number value to identify the cumulative quantity of all goods shipped against the scheduling agreement release over a period up to a certain date. | |
| CumulativeReceivedQuantity | Double | A number value to identify the cumulative quantity of all goods received against the scheduling agreement released over a period up to a certain date. | |
| CumulativeReceivedUom | String | Unit of measure for the cumulative received quantity. | |
| UnitPriceConversionDate | Datetime | Price per unit of item conversion date. | |
| UnitPriceAmount | Decimal | Price per unit of item amount. | |
| UnitPriceApprox | Decimal | Price per unit of item approx. | |
| UnitPriceCurrencyCode | String | Price per unit of item currency code. | |
| AccountingDistributionAccountingName | String | The accounting distribution identifier. An accounting distribution divides the cost of an item among multiple parties. Suppliers return this identifier on invoices to facilitate the buyer's reconciliation process. Name. | |
| AccountingDistributionAccountingSegments | String | The accounting distribution identifier. An accounting distribution divides the cost of an item among multiple parties. Suppliers return this identifier on invoices to facilitate the buyer's reconciliation process. Segments. | |
| AccountingDistributionChargeConversionDate | Datetime | The accounting distribution identifier. An accounting distribution divides the cost of an item among multiple parties. Suppliers return this identifier on invoices to facilitate the buyer's reconciliation process. Charge conversion date. | |
| AccountingDistributionChargeAmount | Decimal | The accounting distribution identifier. An accounting distribution divides the cost of an item among multiple parties. Suppliers return this identifier on invoices to facilitate the buyer's reconciliation process. Charge amount. | |
| AccountingDistributionChargeApprox | Decimal | The accounting distribution identifier. An accounting distribution divides the cost of an item among multiple parties. Suppliers return this identifier on invoices to facilitate the buyer's reconciliation process. Charge approx. | |
| AccountingDistributionChargeCurrencyCode | String | The accounting distribution identifier. An accounting distribution divides the cost of an item among multiple parties. Suppliers return this identifier on invoices to facilitate the buyer's reconciliation process. Charge currency code. | |
| SerialNumberInfoMaximum | Double | The buyer's instructions on acceptable serial number values to be sent in an Advance Ship Notice (ASN). Maximum. | |
| SerialNumberInfoMinimum | Double | The buyer's instructions on acceptable serial number values to be sent in an Advance Ship Notice (ASN). Minimum. | |
| SerialNumberInfoProfile | String | The buyer's instructions on acceptable serial number values to be sent in an Advance Ship Notice (ASN). Profile. Can be profile, range, or list. | |
| SerialNumberInfoValues | String | The buyer's instructions on acceptable serial number values to be sent in an Advance Ship Notice (ASN). Values. | |
| SerialNumberInfoProfileType | String | The buyer's instructions on acceptable serial number values to be sent in an Advance Ship Notice (ASN). Profile type. Can be numeric or null. | |
| SupplierANID | String | The supplier's ANID. | |
| OrderStatus | String | Indicates what state of processing the order has reached. | |
| RoutingStatus | String | Routing Status indicates whether a purchase order or service order is queued, sent, acknowledged, or if routing failed. | |
| StartDate | Datetime | Searches by the date on which SAP Business Network receives the purchase order. The maximum date range is 31 days. These two parameters startDate and endDate must exist together or neither. | |
| EndDate | Datetime | Searches by the date on which SAP Business Network receives the purchase order. The maximum date range is 31 days. These two parameters startDate and endDate must exist together or neither. |
Retrieves purchase-order header information.
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 Sync App uses the SAP Ariba API to process ORDER BY clause conditions built with the following columns. The Sync App processes ordering by other columns client-side within the Sync App.
SELECT * FROM Orders WHERE DocumentNumber = 'DO240'
SELECT * FROM Orders WHERE RoutingStatus = 'Sent'
SELECT * FROM Orders WHERE OrderStatus = 'CHANGED'
SELECT * FROM Orders WHERE StartDate = '2000-01-01T00:00:00' AND EndDate = '2000-01-15T01:00:00'
SELECT * FROM Orders ORDER BY BuyerANID ASC
SELECT * FROM Orders ORDER BY SupplierANID DESC
| Name | Type | References | Description |
| VendorId | String | The supplier's vendor ID. | |
| SupplierANID | String | The supplier's ANID. | |
| SupplierName | String | The supplier's name. | |
| ServiceId | Double | Service id. | |
| DisputeId | Double | Dispute id. | |
| DocumentNumber [KEY] | String | Same as the orderID. The documentNumber is an identifier for a particular order, similar to the purchase order number. | |
| PayloadId | String | An unique identifier for the document. This is copied directly from the cXML element of the original document. | |
| PoVersion | Double | Specifies the order version number of change orders, starting with 1 for the original order. | |
| Revision | String | Revision. | |
| PoClosed | Bool | Po closed. | |
| Settlement | String | Method of PO settlement. | |
| IsRelease | Bool | Indicates whether the orderType is Release. | |
| AttachmentCount | Int | Attachment count. | |
| SystemId | String | The customer's system ID. | |
| CustomerANID | String | The customer's ANID. | |
| CustomerName | String | The customer's name. | |
| EndPointId | String | The customer's endpoint ID. | |
| PurchasingOrgCode | String | The customer's purchasing organization. | |
| PurchasingGroupCode | String | The customer's purchasing group. | |
| CompanyCode | String | The customer's buying entity. | |
| BuyerANID | String | The buyer's ANID. | |
| PurchasingAgentName | String | Name of contact whose role is purchasing agent. | |
| Blanket | Bool | Blanket. | |
| BlanketPoId | Double | Blanket po id. | |
| ReleaseRequired | Bool | Used only if orderType is blanket, to indicate whether the blanket order requires releases (purchase orders). If yes, is specified, then the blanket order requires separate release orders before the supplier can act. If no, then the supplier can act on the blanket order itself. By default this value is unspecified. | |
| NumberOfInvoices | Int | Number of invoices. | |
| PaymentTerms | String | Net Terms or Payment Terms. | |
| PaymentTermsExplanation | String | Free-form text describing the payment terms for information purposes. | |
| SchedulingAgreement | Bool | Scheduling agreement. | |
| TransportTerms | String | The transport information for the shipment described by the order and the ship notice. This information comes from the order specified by the buyer and has to be included in the ship notice, so that these can be edited by the supplier, if required. This information and possible changes have to be carried back to the buyer. | |
| TransportTermsDesc | String | Transport terms description. | |
| IsoCountryCode | String | The International Organization for Standardization (ISO) country code for the country in the shipping address. | |
| PoShipToState | String | The State element is a two-letter state, province, or territory code for the location where the goods are to be shipped. | |
| PoShipToCountry | String | The Country element is the country where goods are to be shipped. | |
| PoShipToCity | String | The City element is the city where ordered products are to be shipped. | |
| PoShipToStreet | String | The Street element is the street address of the ShipTo location where ordered products are to be delivered. | |
| PoShipToCode | String | Po ship to code. | |
| PoShipToPostalCode | String | The PostalCode element is the postal or zip code where goods are to be shipped. | |
| DocumentStatus | String | Document status. | |
| DashboardStatus | String | Order Status indicates where the order stands with regards to your processing of the order. | |
| RoutingStatus | String | Routing Status indicates whether a purchase order or service order is queued, sent, acknowledged, or if routing failed. | |
| OrderDate | Datetime | The date and time the order was created. | |
| Created | Datetime | Date the order was created. | |
| HideAmount | Bool | An extrinsic that allows you to mask values for the amount. | |
| AmountAvailableConversionDate | Datetime | Amount available conversion date. | |
| AmountAvailableAmount | Decimal | Amount available. | |
| AmountAvailableApprox | Decimal | Amount available approx. | |
| AmountAvailableCurrencyCode | String | Amount available currency code. | |
| BalanceConversionDate | Datetime | In case of partially invoiced PO, the balance left on the PO to be invoiced conversion date. | |
| BalanceAmount | Decimal | In case of partially invoiced PO, the balance left on the PO to be invoiced amount. | |
| BalanceApprox | Decimal | In case of partially invoiced PO, the balance left on the PO to be invoiced approx. | |
| BalanceCurrencyCode | String | In case of partially invoiced PO, the balance left on the PO to be invoiced currency code. | |
| InvoicedAmountConversionDate | Datetime | Invoiced amount conversion date. | |
| InvoicedAmountAmount | Decimal | Invoiced amount. | |
| InvoicedAmountApprox | Decimal | Invoiced amount approx. | |
| InvoicedAmountCurrencyCode | String | Invoiced amount currency code. | |
| PoAmountConversionDate | Datetime | Total cost of the order conversion date. | |
| PoAmountAmount | Decimal | Total cost of the order amount. | |
| PoAmountApprox | Decimal | Total cost of the order approx. | |
| PoAmountCurrencyCode | String | Total cost of the order currency code. | |
| PoShipToNameKid | String | For ship to, the Name element value should be the company or organization of the employee receiving ordered products. Kid. | |
| PoShipToNameValue | String | For ship to, the Name element value should be the company or organization of the employee receiving ordered products. Value. | |
| PoShipToNameEncryptedValue | String | For ship to, the Name element value should be the company or organization of the employee receiving ordered products. Encrypted value. | |
| OrderStatus | String | Indicates what state of processing the order has reached. | |
| StartDate | Datetime | Searches by the date on which SAP Business Network receives the purchase order. The maximum date range is 31 days. These two parameters startDate and endDate must exist together or neither. | |
| EndDate | Datetime | Searches by the date on which SAP Business Network receives the purchase order. The maximum date range is 31 days. These two parameters startDate and endDate must exist together or neither. |
このセクションでは、Purchase Orders Supplier API で利用可能なオブジェクトを示し、SQL の使用についての詳細を説明します。
ビュー は、SAP Ariba オーダーをモデル化する読み取り専用のテーブルです。
ストアドプロシージャ は、OAuth トークン管理などのタスクを実行する、データソースのファンクションライクなインターフェースです。
Retrieves line-item information from purchase orders.
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.
SELECT * FROM LineItems WHERE DocumentNumber = 'DO240'
SELECT * FROM LineItems WHERE OrderStatus = 'CHANGED'
SELECT * FROM LineItems WHERE RoutingStatus = 'Sent'
SELECT * FROM LineItems WHERE StartDate = '2000-01-01T00:00:00' AND EndDate = '2000-01-15T01:00:00'
| Name | Type | References | Description |
| LineNumber [KEY] | Int | Position (counting from 1) of this item in an order. Used to maintain a reference between items in create and update OrderRequest documents. | |
| DocumentNumber [KEY] | String |
Orders.DocumentNumber | Same as the orderID. The documentNumber is an identifier for a particular order, similar to the purchase order number. |
| Eanid | String | The European Article Number, EAN, barcode. | |
| Unspsc | String | The United Nations Standard Products and Services Code, UNSPSC, classification. | |
| Priority | Int | Priority indicator, used to drive the priority of the orders for the suppliers. | |
| ProductIdentifier | String | Reference product number. | |
| LineOfBusiness | String | Line of business. | |
| ProductFamily | String | Product family. | |
| ProductSubFamily | String | Product sub family. | |
| ProductCode | String | Product code. | |
| PartCategory | String | Part category. | |
| PartType | String | Part type. | |
| Category | String | Category. | |
| SupplierPart | String | SupplierPartID is how the supplier identifies an item. | |
| SupplierBatchId | String | An identifier from supplier to identify the material/goods produced in a single manufacturing run. | |
| BuyerPartId | String | It represents a product in buyer system. This identifier is specified by the buyer. | |
| BuyerBatchId | String | An identifier from buyer to identify the material/goods produced in a single manufacturing run. | |
| ManufacturerName | String | The manufacturer's name. | |
| ManufacturerPartId | String | The manufacturer's part number. | |
| PlannerCode | String | Planner code. | |
| PlannerDescription | String | Planner description. | |
| Description | String | Description of the items. | |
| MaterialGoAheadEndDate | Datetime | Date denoting the end of the material go-ahead period (go-ahead for purchase of input materials). | |
| ProductionGoAheadEndDate | Datetime | Date denoting the end of the production go-ahead period. | |
| AgreementId | String | The procurement system agreement ID for this request. | |
| AgreementDate | Datetime | The date and time the agreement request was created. This is different from the effective and expiry date of the agreement. | |
| NeedBy | Datetime | The date this item was requested for delivery. | |
| RequestedDeliveryDate | Datetime | The date this item was requested for delivery. | |
| RequestedShipmentDate | Datetime | The ship date requested by the buyer for the item. | |
| PreviousAsnId | String | Previous ship notice ID. | |
| PreviousAsnDate | Datetime | Previous ship notice date. | |
| IsoCountryCode | String | The International Organization for Standardization (ISO) country code for the country in the shipping address. | |
| ItemShipToStreet | String | The Street element is the street address of the ShipTo location where ordered products are to be delivered. | |
| ItemShipToCity | String | The City element is the city where ordered products are to be shipped. | |
| ItemShipToState | String | The State element is a two-letter state, province, or territory code for the location where the goods are to be shipped. | |
| ItemShipToCountry | String | The Country element is the country where goods are to be shipped. | |
| ItemShipToCode | String | Item ship to code. | |
| ItemShipToPostalCode | String | The PostalCode element is the postal or zip code where goods are to be shipped. | |
| ItemShipToName | String | For ship to, the Name element value should be the company or organization of the employee receiving ordered products. | |
| ItemReturnAuthorizationNumber | String | Return Authorization Number information for a line item. | |
| ReleaseType | String | A string value to identify the type of release. The value will be either jit or forecast. | |
| ItemLocation | String | Item location. | |
| StorageLocation | String | Storage location. | |
| Quantity | Double | How many items are desired. Supplier and Commodity level items in an order of type 'blanket' will use a default value of '1'. The quantity in this case will not be used to compute the sub total. The MaxAmount in the BlanketItemDetail will be used to indicate any line level amounts. | |
| UnitOfMeasure | String | The UnitOfMeasure element contains the item Unit of Measure code as defined by the United Nations UOM standard. | |
| PbqQuantity | Double | The PriceBasisQuantity element contains the quantity-based pricing for a line item. Quantity-based Pricing is commonly also referred to as Price-Based Quantity or PBQ. Quantity-based pricing allows the unit price of an item to be based on a different price unit quantity than 1. | |
| PbqUOM | String | Unit of measure for the PriceBasisQuantity. | |
| PbqConversionFactor | Double | Conversion factor for the PriceBasisQuantity. | |
| ConfirmedQuantity | Double | Confirmed quantity. | |
| PreviousReceivedQuantity | Double | Previous received quantity. | |
| PreviousReceivedQuantityUom | String | Unit of measure for the previous received quantity. | |
| CumulativeShipQuantity | Double | A number value to identify the cumulative quantity of all goods shipped against the scheduling agreement release over a period up to a certain date. | |
| CumulativeReceivedQuantity | Double | A number value to identify the cumulative quantity of all goods received against the scheduling agreement released over a period up to a certain date. | |
| CumulativeReceivedUom | String | Unit of measure for the cumulative received quantity. | |
| UnitPriceConversionDate | Datetime | Price per unit of item conversion date. | |
| UnitPriceAmount | Decimal | Price per unit of item amount. | |
| UnitPriceApprox | Decimal | Price per unit of item approx. | |
| UnitPriceCurrencyCode | String | Price per unit of item currency code. | |
| AccountingDistributionAccountingName | String | The accounting distribution identifier. An accounting distribution divides the cost of an item among multiple parties. Suppliers return this identifier on invoices to facilitate the buyer's reconciliation process. Name. | |
| AccountingDistributionAccountingSegments | String | The accounting distribution identifier. An accounting distribution divides the cost of an item among multiple parties. Suppliers return this identifier on invoices to facilitate the buyer's reconciliation process. Segments. | |
| AccountingDistributionChargeConversionDate | Datetime | The accounting distribution identifier. An accounting distribution divides the cost of an item among multiple parties. Suppliers return this identifier on invoices to facilitate the buyer's reconciliation process. Charge conversion date. | |
| AccountingDistributionChargeAmount | Decimal | The accounting distribution identifier. An accounting distribution divides the cost of an item among multiple parties. Suppliers return this identifier on invoices to facilitate the buyer's reconciliation process. Charge amount. | |
| AccountingDistributionChargeApprox | Decimal | The accounting distribution identifier. An accounting distribution divides the cost of an item among multiple parties. Suppliers return this identifier on invoices to facilitate the buyer's reconciliation process. Charge approx. | |
| AccountingDistributionChargeCurrencyCode | String | The accounting distribution identifier. An accounting distribution divides the cost of an item among multiple parties. Suppliers return this identifier on invoices to facilitate the buyer's reconciliation process. Charge currency code. | |
| SerialNumberInfoMaximum | Double | The buyer's instructions on acceptable serial number values to be sent in an Advance Ship Notice (ASN). Maximum. | |
| SerialNumberInfoMinimum | Double | The buyer's instructions on acceptable serial number values to be sent in an Advance Ship Notice (ASN). Minimum. | |
| SerialNumberInfoProfile | String | The buyer's instructions on acceptable serial number values to be sent in an Advance Ship Notice (ASN). Profile. Can be profile, range, or list. | |
| SerialNumberInfoValues | String | The buyer's instructions on acceptable serial number values to be sent in an Advance Ship Notice (ASN). Values. | |
| SerialNumberInfoProfileType | String | The buyer's instructions on acceptable serial number values to be sent in an Advance Ship Notice (ASN). Profile type. Can be numeric or null. | |
| BuyerANID | String | The buyer's ANID. | |
| OrderStatus | String | Indicates what state of processing the order has reached. | |
| RoutingStatus | String | Routing Status indicates whether a purchase order or service order is queued, sent, acknowledged, or if routing failed. | |
| StartDate | Datetime | Searches by the date on which SAP Business Network receives the purchase order. The maximum date range is 31 days. These two parameters startDate and endDate must exist together or neither. | |
| EndDate | Datetime | Searches by the date on which SAP Business Network receives the purchase order. The maximum date range is 31 days. These two parameters startDate and endDate must exist together or neither. |
Retrieves purchase-order header information.
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 Sync App uses the SAP Ariba API to process ORDER BY clause conditions built with the following columns. The Sync App processes ordering by other columns client-side within the Sync App.
SELECT * FROM Orders WHERE DocumentNumber = 'DO240'
SELECT * FROM Orders WHERE RoutingStatus = 'Sent'
SELECT * FROM Orders WHERE OrderStatus = 'CHANGED'
SELECT * FROM Orders WHERE StartDate = '2000-01-01T00:00:00' AND EndDate = '2000-01-15T01:00:00'
SELECT * FROM Orders ORDER BY BuyerANID ASC
SELECT * FROM Orders ORDER BY SupplierANID DESC
| Name | Type | References | Description |
| VendorId | String | The supplier's vendor ID. | |
| SupplierANID | String | The supplier's ANID. | |
| SupplierName | String | The supplier's name. | |
| ServiceId | Double | Service id. | |
| DisputeId | Double | Dispute id. | |
| DocumentNumber [KEY] | String | Same as the orderID. The documentNumber is an identifier for a particular order, similar to the purchase order number. | |
| PayloadId | String | An unique identifier for the document. This is copied directly from the cXML element of the original document. | |
| PoVersion | Double | Specifies the order version number of change orders, starting with 1 for the original order. | |
| Revision | String | Revision. | |
| PoClosed | Bool | Po closed. | |
| Settlement | String | Method of PO settlement. | |
| IsRelease | Bool | Indicates whether the orderType is Release. | |
| AttachmentCount | Int | Attachment count. | |
| SystemId | String | The customer's system ID. | |
| CustomerANID | String | The customer's ANID. | |
| CustomerName | String | The customer's name. | |
| EndPointId | String | The customer's endpoint ID. | |
| PurchasingOrgCode | String | The customer's purchasing organization. | |
| PurchasingGroupCode | String | The customer's purchasing group. | |
| CompanyCode | String | The customer's buying entity. | |
| BuyerANID | String | The buyer's ANID. | |
| PurchasingAgentName | String | Name of contact whose role is purchasing agent. | |
| Blanket | Bool | Blanket. | |
| BlanketPoId | Double | Blanket po id. | |
| ReleaseRequired | Bool | Used only if orderType is blanket, to indicate whether the blanket order requires releases (purchase orders). If yes, is specified, then the blanket order requires separate release orders before the supplier can act. If no, then the supplier can act on the blanket order itself. By default this value is unspecified. | |
| NumberOfInvoices | Int | Number of invoices. | |
| PaymentTerms | String | Net Terms or Payment Terms. | |
| PaymentTermsExplanation | String | Free-form text describing the payment terms for information purposes. | |
| SchedulingAgreement | Bool | Scheduling agreement. | |
| TransportTerms | String | The transport information for the shipment described by the order and the ship notice. This information comes from the order specified by the buyer and has to be included in the ship notice, so that these can be edited by the supplier, if required. This information and possible changes have to be carried back to the buyer. | |
| TransportTermsDesc | String | Transport terms description. | |
| IsoCountryCode | String | The International Organization for Standardization (ISO) country code for the country in the shipping address. | |
| PoShipToState | String | The State element is a two-letter state, province, or territory code for the location where the goods are to be shipped. | |
| PoShipToCountry | String | The Country element is the country where goods are to be shipped. | |
| PoShipToCity | String | The City element is the city where ordered products are to be shipped. | |
| PoShipToStreet | String | The Street element is the street address of the ShipTo location where ordered products are to be delivered. | |
| PoShipToCode | String | Po ship to code. | |
| PoShipToPostalCode | String | The PostalCode element is the postal or zip code where goods are to be shipped. | |
| DocumentStatus | String | Document status. | |
| DashboardStatus | String | Order Status indicates where the order stands with regards to your processing of the order. | |
| RoutingStatus | String | Routing Status indicates whether a purchase order or service order is queued, sent, acknowledged, or if routing failed. | |
| OrderDate | Datetime | The date and time the order was created. | |
| Created | Datetime | Date the order was created. | |
| HideAmount | Bool | An extrinsic that allows you to mask values for the amount. | |
| AmountAvailableConversionDate | Datetime | Amount available conversion date. | |
| AmountAvailableAmount | Decimal | Amount available. | |
| AmountAvailableApprox | Decimal | Amount available approx. | |
| AmountAvailableCurrencyCode | String | Amount available currency code. | |
| BalanceConversionDate | Datetime | In case of partially invoiced PO, the balance left on the PO to be invoiced conversion date. | |
| BalanceAmount | Decimal | In case of partially invoiced PO, the balance left on the PO to be invoiced amount. | |
| BalanceApprox | Decimal | In case of partially invoiced PO, the balance left on the PO to be invoiced approx. | |
| BalanceCurrencyCode | String | In case of partially invoiced PO, the balance left on the PO to be invoiced currency code. | |
| InvoicedAmountConversionDate | Datetime | Invoiced amount conversion date. | |
| InvoicedAmountAmount | Decimal | Invoiced amount. | |
| InvoicedAmountApprox | Decimal | Invoiced amount approx. | |
| InvoicedAmountCurrencyCode | String | Invoiced amount currency code. | |
| PoAmountConversionDate | Datetime | Total cost of the order conversion date. | |
| PoAmountAmount | Decimal | Total cost of the order amount. | |
| PoAmountApprox | Decimal | Total cost of the order approx. | |
| PoAmountCurrencyCode | String | Total cost of the order currency code. | |
| PoShipToNameKid | String | For ship to, the Name element value should be the company or organization of the employee receiving ordered products. Kid. | |
| PoShipToNameValue | String | For ship to, the Name element value should be the company or organization of the employee receiving ordered products. Value. | |
| PoShipToNameEncryptedValue | String | For ship to, the Name element value should be the company or organization of the employee receiving ordered products. Encrypted value. | |
| OrderStatus | String | Indicates what state of processing the order has reached. | |
| StartDate | Datetime | Searches by the date on which SAP Business Network receives the purchase order. The maximum date range is 31 days. These two parameters startDate and endDate must exist together or neither. | |
| EndDate | Datetime | Searches by the date on which SAP Business Network receives the purchase order. The maximum date range is 31 days. These two parameters startDate and endDate must exist together or neither. |
このセクションでは、Operational Reporting API For Procurement で利用可能なオブジェクト例を示し、SQL の使用についての詳細を説明します。
これは動的スキーマです。ここに挙げたビューテンプレートは、ドキュメント用の例です。
テーブル では、利用可能なテーブルを説明します。テーブルは、Views のようなリソースを静的にモデル化するように定義されています。
ビュー は、SAP Ariba のトランザクションデータをモデル化する読み取り専用のテーブルです。
ストアドプロシージャ は、OAuth トークン管理などのタスクを実行する、データソースのファンクションライクなインターフェースです。
Sync App はSAP Ariba のデータを、標準のSQL ステートメントを使用してクエリできるリレーショナルデータベースのテーブルのリストとしてモデル化します。
| Name | Description |
| Views | Get all view templates for a realm. |
Get all view templates for a realm.
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.
SELECT * FROM Views WHERE ViewTemplateName='Contract_SAP_createdRange_v1'
SELECT * FROM Views WHERE Status='published'
SELECT * FROM Views WHERE DocumentType='DirectOrder'
You can create views by executing INSERT statements and specifying the ViewTemplateName, Status, DocumentType, SelectAttributes and FilterExpressions. For example:
INSERT INTO Views (ViewTemplateName, Status, DocumentType, SelectAttributes, FilterExpressions) VALUES ('TestView','published','DirectOrder', '["SubmitDate"]','[{"name":"ExampleFilter","field":"UniqueName","op":"IN","defaultValue":["P011"]}]')
You can update the status of views by executing UPDATE statements and specifying the ViewTemplateName and Status. For example:
UPDATE Views SET Status='published' WHERE ViewTemplateName='TestView'
| Name | Type | ReadOnly | References | Description |
| ViewTemplateName [KEY] | String | False |
The name of the view. | |
| Type | String | False |
The type of view template. | |
| Status | String | False |
Status of the view template. | |
| DocumentType | String | False |
The type of transaction data this view template queries. | |
| SelectAttributes | String | False |
The fields that will be included in the response to queries using this view template. | |
| FilterExpressions | String | False |
A collection of objects that defines filters for the view template. |
ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。
クエリは、ビューに対して通常のテーブルと同様に実行することができます。
| Name | Description |
| ContractSAPcreatedRangev1 | A 'system vsap' view template that queries 'Contract' transaction data. |
| ContractSAPupdatedRangev1 | A 'system vsap' view template that queries 'Contract' transaction data. |
| CopyOrderSAPcreatedRange | A 'system vsap' view template that queries 'CopyOrder' transaction data. |
| CopyOrderSAPupdatedRange | A 'system vsap' view template that queries 'CopyOrder' transaction data. |
| DirectOrderSAPcreatedRange | A 'system vsap' view template that queries 'DirectOrder' transaction data. |
| DirectOrderSAPupdatedRange | A 'system vsap' view template that queries 'DirectOrder' transaction data. |
| ERPOrderSAPcreatedRange | A 'system vsap' view template that queries 'ERPOrder' transaction data. |
| ERPOrderSAPupdatedRange | A 'system vsap' view template that queries 'ERPOrder' transaction data. |
| InvoiceReconciliationSAPcreatedRange | A 'system vsap' view template that queries 'InvoiceReconciliation' transaction data. |
| InvoiceReconciliationSAPupdatedRange | A 'system vsap' view template that queries 'InvoiceReconciliation' transaction data. |
| ReceiptSAPcreatedRange | A 'system vsap' view template that queries 'Receipt' transaction data. |
| ReceiptSAPupdatedRange | A 'system vsap' view template that queries 'Receipt' transaction data. |
| ViewChildElements | Get all child elements for a specific view template. |
| ViewFields | Request a list of all supported document types or a list of all filter and selection fields, either for a single document type or for all document types, that can be used to create custom view templates. |
A 'system vsap' view template that queries 'Contract' transaction data.
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.
SELECT * FROM ContractSAPcreatedRange WHERE createdDateFrom='2024-01-01 00:00:00.0' AND createdDateTo='2024-02-01 00:00:00.0'
SELECT * FROM ContractSAPcreatedRange WHERE IncludeInactive='True'
| Name | Type | References | Description |
| ForecastedSpend_TotalAmount_AmountInReportingCurrency | Decimal | ||
| ForecastedSpend_TotalAmount_ApproxAmountInBaseCurrency | Decimal | ||
| ForecastedSpend_TotalAmount_Amount | Decimal | ||
| ForecastedSpend_TotalAmount_ConversionDate | Datetime | ||
| ForecastedSpend_TotalAmount_Currency_UniqueName | String | ||
| Description | String | Description associated with the contract. | |
| IsAutoRelease | Bool | This denotes if this contract is an Auto Release Contract. | |
| InitialUniqueName | String | The ID of the contract when it was first created. This field is used for internal purpose only. | |
| ForecastedSpend_Frequency_UniqueName | String | ||
| ExternalID | String | ExternalID is an Id from external system used while generating the UniqueName for the MA | |
| SupplierLocation_State | String | ||
| SupplierLocation_Phone | String | ||
| SupplierLocation_Country_UniqueName | String | ||
| SupplierLocation_PostalCode | String | ||
| SupplierLocation_City | String | ||
| SupplierLocation_Fax | String | ||
| SupplierLocation_UniqueName | String | ||
| SupplierLocation_Lines | String | ||
| SupplierLocation_Name | String | ||
| SubPreloadAmount_AmountInReportingCurrency | Decimal | ||
| SubPreloadAmount_ApproxAmountInBaseCurrency | Decimal | ||
| SubPreloadAmount_Amount | Decimal | ||
| SubPreloadAmount_ConversionDate | Datetime | ||
| SubPreloadAmount_Currency_UniqueName | String | ||
| PaymentTerms_UniqueName | String | ||
| CreateDate | Datetime | The date when a contract is created. | |
| Attachments | String | ||
| TermType | String | The term type of a contract. | |
| MaxAmount_AmountInReportingCurrency | Decimal | ||
| MaxAmount_ApproxAmountInBaseCurrency | Decimal | ||
| MaxAmount_Amount | Decimal | ||
| MaxAmount_ConversionDate | Datetime | ||
| MaxAmount_Currency_UniqueName | String | ||
| Name | String | The title of a contract. | |
| TimeCreated | Datetime | The time when a contract is created. | |
| ParentAgreement_UniqueName | String | ||
| Requester_UniqueName | String | The user on behalf of whom a requisition is created. Typically, the preparer and requester of a requisition are the same user. If a preparer creates a requisition for someone else, the requester is the user for whom the requisition is created. | |
| ExternalSourcingId | String | The ID of the contract request in the sourcing system. | |
| MinAmount_AmountInReportingCurrency | Decimal | ||
| MinAmount_ApproxAmountInBaseCurrency | Decimal | ||
| MinAmount_Amount | Decimal | ||
| MinAmount_ConversionDate | Datetime | ||
| MinAmount_Currency_UniqueName | String | ||
| Currency_UniqueName | String | ||
| Supplier_UniqueName | String | ||
| Supplier_Name | String | ||
| Items | String | ||
| MaxAmountTolerancePercent | Decimal | This denotes the amount above the MaxAmount allowing users to create releases against the contract. The Master Agreement will move to the Closed state when the tolerance is reached. A null value means the tolerance or the MaxAmount has not been set and the contract will stay Open until the Expiration Date or a user explicitly closes the contract. | |
| ReleaseType | String | This determines the type of releases associated with the contract. | |
| LineItems | String | ||
| StatusString | String | The approval state of a contract. Example: Processed, Open, or Closed. | |
| SubAgreements | String | ||
| IsBlanketPurchaseOrder | Bool | This denotes if the created contract is a blanket purchase order. | |
| PurchaseOrg_UniqueName | String | ||
| ReleaseMinAmount_AmountInReportingCurrency | Decimal | ||
| ReleaseMinAmount_ApproxAmountInBaseCurrency | Decimal | ||
| ReleaseMinAmount_Amount | Decimal | ||
| ReleaseMinAmount_ConversionDate | Datetime | ||
| ReleaseMinAmount_Currency_UniqueName | String | ||
| TimeUpdated | Datetime | The time when a contract was last updated. | |
| ReleaseMaxAmount_AmountInReportingCurrency | Decimal | ||
| ReleaseMaxAmount_ApproxAmountInBaseCurrency | Decimal | ||
| ReleaseMaxAmount_Amount | Decimal | ||
| ReleaseMaxAmount_ConversionDate | Datetime | ||
| ReleaseMaxAmount_Currency_UniqueName | String | ||
| PreloadAmount_AmountInReportingCurrency | Decimal | ||
| PreloadAmount_ApproxAmountInBaseCurrency | Decimal | ||
| PreloadAmount_Amount | Decimal | ||
| PreloadAmount_ConversionDate | Datetime | ||
| PreloadAmount_Currency_UniqueName | String | ||
| ForecastedSpend_SavingPercentage | Decimal | This denotes the saving percent in spend forecast of a contract. | |
| Active | Bool | Indicates whether a contract is currently in use in the buying solution. This field can contain the values as True or False. False indicates inactive contracts. Inactive contracts are considered as those that are deleted and do not appear in search results and contract choosers. | |
| GlobalReleaseFlag | Bool | This denotes if releases can be made against this contract from partitions other than the partition where the contract was created in. If this flag is set to false, then only users in the same partition can create releases against the contract. If the flag is set to true then users in all of the partitions can create releases against this contract. | |
| ProcurementUnit_UniqueName | String | ||
| ExpirationDate | Datetime | This denotes the date on which contract is expired and no longer available for ordering. | |
| ReleaseTolerancePercent | Decimal | This denotes the percentage amount under which and over which a release can exceed the MinReleaseAmount and the MaxReleaseAmount before DefaultApprovers is added as an Approver. If the release exceeds those values within the tolerance, DefaultApprovers is added as a watcher. | |
| UniqueName | String | The unique ID of a contract. Example: C123. | |
| CompanyCode_UniqueName | String | The unique internal identifier for the SAP company code. | |
| HierarchicalType | String | This denotes the hierarchical type of this contract. | |
| Evergreen | Bool | This denotes if contract is in effect for ever. | |
| Preparer_UniqueName | String | The user who creates a requisition and submits it for approval. | |
| EffectiveDate | Datetime | This denotes the date from which contract is available for release. | |
| IncludeInactive | Bool | By default, API responses do not include inactive transactions. You can set this query parameter to true to include inactive transactions in the responses. | |
| createdDateFrom | Datetime | This filter corresponds to the 'TimeCreated' field. The operation is '>' and the default value is '2018-03-01T23:59:59Z'. | |
| createdDateTo | Datetime | This filter corresponds to the 'TimeCreated' field. The operation is '<=' and the default value is '2018-03-29T23:59:59Z'. |
A 'system vsap' view template that queries 'Contract' transaction data.
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.
SELECT * FROM ContractSAPupdatedRange WHERE updatedDateFrom='2024-01-01 00:00:00.0' AND updatedDateTo='2024-02-01 00:00:00.0'
SELECT * FROM ContractSAPupdatedRange WHERE IncludeInactive='True'
| Name | Type | References | Description |
| ForecastedSpend_TotalAmount_AmountInReportingCurrency | Decimal | ||
| ForecastedSpend_TotalAmount_ApproxAmountInBaseCurrency | Decimal | ||
| ForecastedSpend_TotalAmount_Amount | Decimal | ||
| ForecastedSpend_TotalAmount_ConversionDate | Datetime | ||
| ForecastedSpend_TotalAmount_Currency_UniqueName | String | ||
| Description | String | Description associated with the contract. | |
| IsAutoRelease | Bool | This denotes if this contract is an Auto Release Contract. | |
| InitialUniqueName | String | The ID of the contract when it was first created. This field is used for internal purpose only. | |
| ForecastedSpend_Frequency_UniqueName | String | ||
| ExternalID | String | ExternalID is an Id from external system used while generating the UniqueName for the MA | |
| SupplierLocation_State | String | ||
| SupplierLocation_Phone | String | ||
| SupplierLocation_Country_UniqueName | String | ||
| SupplierLocation_PostalCode | String | ||
| SupplierLocation_City | String | ||
| SupplierLocation_Fax | String | ||
| SupplierLocation_UniqueName | String | ||
| SupplierLocation_Lines | String | ||
| SupplierLocation_Name | String | ||
| SubPreloadAmount_AmountInReportingCurrency | Decimal | ||
| SubPreloadAmount_ApproxAmountInBaseCurrency | Decimal | ||
| SubPreloadAmount_Amount | Decimal | ||
| SubPreloadAmount_ConversionDate | Datetime | ||
| SubPreloadAmount_Currency_UniqueName | String | ||
| PaymentTerms_UniqueName | String | ||
| CreateDate | Datetime | The date when a contract is created. | |
| Attachments | String | ||
| TermType | String | The term type of a contract. | |
| MaxAmount_AmountInReportingCurrency | Decimal | ||
| MaxAmount_ApproxAmountInBaseCurrency | Decimal | ||
| MaxAmount_Amount | Decimal | ||
| MaxAmount_ConversionDate | Datetime | ||
| MaxAmount_Currency_UniqueName | String | ||
| Name | String | The title of a contract. | |
| TimeCreated | Datetime | The time when a contract is created. | |
| ParentAgreement_UniqueName | String | ||
| Requester_UniqueName | String | The user on behalf of whom a requisition is created. Typically, the preparer and requester of a requisition are the same user. If a preparer creates a requisition for someone else, the requester is the user for whom the requisition is created. | |
| ExternalSourcingId | String | The ID of the contract request in the sourcing system. | |
| MinAmount_AmountInReportingCurrency | Decimal | ||
| MinAmount_ApproxAmountInBaseCurrency | Decimal | ||
| MinAmount_Amount | Decimal | ||
| MinAmount_ConversionDate | Datetime | ||
| MinAmount_Currency_UniqueName | String | ||
| Currency_UniqueName | String | ||
| Supplier_UniqueName | String | ||
| Supplier_Name | String | ||
| Items | String | ||
| MaxAmountTolerancePercent | Decimal | This denotes the amount above the MaxAmount allowing users to create releases against the contract. The Master Agreement will move to the Closed state when the tolerance is reached. A null value means the tolerance or the MaxAmount has not been set and the contract will stay Open until the Expiration Date or a user explicitly closes the contract. | |
| ReleaseType | String | This determines the type of releases associated with the contract. | |
| LineItems | String | ||
| StatusString | String | The approval state of a contract. Example: Processed, Open, or Closed. | |
| SubAgreements | String | ||
| IsBlanketPurchaseOrder | Bool | This denotes if the created contract is a blanket purchase order. | |
| PurchaseOrg_UniqueName | String | ||
| ReleaseMinAmount_AmountInReportingCurrency | Decimal | ||
| ReleaseMinAmount_ApproxAmountInBaseCurrency | Decimal | ||
| ReleaseMinAmount_Amount | Decimal | ||
| ReleaseMinAmount_ConversionDate | Datetime | ||
| ReleaseMinAmount_Currency_UniqueName | String | ||
| TimeUpdated | Datetime | The time when a contract was last updated. | |
| ReleaseMaxAmount_AmountInReportingCurrency | Decimal | ||
| ReleaseMaxAmount_ApproxAmountInBaseCurrency | Decimal | ||
| ReleaseMaxAmount_Amount | Decimal | ||
| ReleaseMaxAmount_ConversionDate | Datetime | ||
| ReleaseMaxAmount_Currency_UniqueName | String | ||
| PreloadAmount_AmountInReportingCurrency | Decimal | ||
| PreloadAmount_ApproxAmountInBaseCurrency | Decimal | ||
| PreloadAmount_Amount | Decimal | ||
| PreloadAmount_ConversionDate | Datetime | ||
| PreloadAmount_Currency_UniqueName | String | ||
| ForecastedSpend_SavingPercentage | Decimal | This denotes the saving percent in spend forecast of a contract. | |
| Active | Bool | Indicates whether a contract is currently in use in the buying solution. This field can contain the values as True or False. False indicates inactive contracts. Inactive contracts are considered as those that are deleted and do not appear in search results and contract choosers. | |
| GlobalReleaseFlag | Bool | This denotes if releases can be made against this contract from partitions other than the partition where the contract was created in. If this flag is set to false, then only users in the same partition can create releases against the contract. If the flag is set to true then users in all of the partitions can create releases against this contract. | |
| ProcurementUnit_UniqueName | String | ||
| ExpirationDate | Datetime | This denotes the date on which contract is expired and no longer available for ordering. | |
| ReleaseTolerancePercent | Decimal | This denotes the percentage amount under which and over which a release can exceed the MinReleaseAmount and the MaxReleaseAmount before DefaultApprovers is added as an Approver. If the release exceeds those values within the tolerance, DefaultApprovers is added as a watcher. | |
| UniqueName | String | The unique ID of a contract. Example: C123. | |
| CompanyCode_UniqueName | String | The unique internal identifier for the SAP company code. | |
| HierarchicalType | String | This denotes the hierarchical type of this contract. | |
| Evergreen | Bool | This denotes if contract is in effect for ever. | |
| Preparer_UniqueName | String | The user who creates a requisition and submits it for approval. | |
| EffectiveDate | Datetime | This denotes the date from which contract is available for release. | |
| IncludeInactive | Bool | By default, API responses do not include inactive transactions. You can set this query parameter to true to include inactive transactions in the responses. | |
| updatedDateFrom | Datetime | This filter corresponds to the 'TimeUpdated' field. The operation is '>' and the default value is '2018-03-01T23:59:59Z'. | |
| updatedDateTo | Datetime | This filter corresponds to the 'TimeUpdated' field. The operation is '<=' and the default value is '2018-03-29T23:59:59Z'. |
A 'system vsap' view template that queries 'CopyOrder' transaction data.
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.
SELECT * FROM CopyOrderSAPcreatedRange WHERE createdDateFrom='2024-01-01 00:00:00.0' AND createdDateTo='2024-02-01 00:00:00.0'
SELECT * FROM CopyOrderSAPcreatedRange WHERE IncludeInactive='True'
| Name | Type | References | Description |
| ApprovedState | String | An integer value representing the current approval state of a purchase order. This field is used for internal purpose only. | |
| InitialUniqueName | String | The ID of the purchase order when it was first created. This field is used for internal purpose only. | |
| InvoicedState | String | The status indicating whether a line item is invoiced (fully or partially) or not invoiced. | |
| SubmitDate | Datetime | The date when a purchase order is successfully submitted for approval. | |
| ReceivedState | String | The status indicating whether a line item is received (either fully or partially) or not received. | |
| HoldTillDate | Datetime | The date until which processing of a fully approved requisition is withheld. | |
| SupplierLocation_State | String | ||
| SupplierLocation_Phone | String | ||
| SupplierLocation_Country_UniqueName | String | ||
| SupplierLocation_PostalCode | String | ||
| SupplierLocation_City | String | ||
| SupplierLocation_Fax | String | ||
| SupplierLocation_UniqueName | String | ||
| SupplierLocation_Lines | String | ||
| SupplierLocation_Name | String | ||
| NumberReceivableOrders | Int | The number of orders that are not fully received. | |
| OrderID | String | The unique ID of a purchase order. Example: PO456. | |
| OrderStatusPunchOutDisabled | Bool | Indicates whether the punchout link on a purchase order is disabled. | |
| ChargeAmount_AmountInReportingCurrency | Decimal | ||
| ChargeAmount_ApproxAmountInBaseCurrency | Decimal | ||
| ChargeAmount_Amount | Decimal | ||
| ChargeAmount_ConversionDate | Datetime | ||
| ChargeAmount_Currency_UniqueName | String | ||
| CreateDate | Datetime | The date when a purchase order is created. | |
| Conditions_UniqueName | String | ||
| Conditions_TAndCVersion | Int | ||
| Name | String | The title of a purchase order. | |
| TotalCost_AmountInReportingCurrency | Decimal | ||
| TotalCost_ApproxAmountInBaseCurrency | Decimal | ||
| TotalCost_Amount | Decimal | ||
| TotalCost_ConversionDate | Datetime | ||
| TotalCost_Currency_UniqueName | String | ||
| OrderConfirmationState | String | The status of the order confirmation for a purchase order. | |
| LastModified | Datetime | The date when a purchase order was last modified. Actions that lead to updates to the history record of a purchase order trigger changes to the last modified date. | |
| TimeCreated | Datetime | The time when a purchase order is created. | |
| AdvancedShipNoticeState | String | The status of the ship notice for an order. | |
| Requester_UniqueName | String | The user on behalf of whom a requisition is created. Typically, the preparer and requester of a requisition are the same user. If a preparer creates a requisition for someone else, the requester is the user for whom the requisition is created. | |
| Version | Int | The internal version number assigned to an approvable document. This field is used for optimistic locking and ensures that changes to the document are followed in an appropriate sequence. This field is used for internal purposes only. | |
| InvoicedDate | Datetime | The date when an order was last invoiced. | |
| UsePOLineNumberForIntegration | Bool | Determines how a line number is assigned to an item on the purchase order. Depending on the settings for the Application.Procure.UsePOLineNumberForExternalIntegration parameter, this field can contain the line number assigned to it in the buying solution or retain the line number assigned in the external ERP system. | |
| AmountAccepted_AmountInReportingCurrency | Decimal | ||
| AmountAccepted_ApproxAmountInBaseCurrency | Decimal | ||
| AmountAccepted_Amount | Decimal | ||
| AmountAccepted_ConversionDate | Datetime | ||
| AmountAccepted_Currency_UniqueName | String | ||
| LineItems | String | ||
| OrderConfirmationStatusString | String | The status of the order confirmation associated with a purchase order. | |
| ChangedBy_UniqueName | String | ||
| OrderedState | String | The status of an order. This field can contain one of the following values: Ordering, Ordered, Canceled, Ordered with Errors or Unordered. | |
| ApprovedDate | Datetime | The date when a purchase order is fully approved. | |
| PreviousApprovalRequestsVersion | Int | The version number for the previous version of the approval request. This field is used for internal purpose only. | |
| ResubmitDate | Datetime | The date when a purchase order is resubmitted for approval. A purchase order is considered as resubmitted if a user edits a denied purchase order and resubmits it for approval. Note: Purchase orders that are withdrawn by the preparer and submitted again are not considered as resubmitted purchase orders. | |
| NumberCleared | Decimal | The number of invoiced items on an order that have been cleared after invoices are reconciled. | |
| OrderMethodCategory | String | The ordering method configured for a customer site. This field contains one of the following values: Direct, PCard, or ERP. | |
| RejectionReason | String | The reason provided by a supplier on Ariba Network while rejecting an order. | |
| Active | Bool | Indicates whether a purchase order is currently in use in the buying solution. This field can contain the values as True or False. False indicates inactive purchase orders. Inactive purchase orders are considered as those that are deleted and do not appear in search results and purchase order choosers. | |
| ReceivedDate | Datetime | The date when a shipment of an item was last received. | |
| AmountBilled_AmountInReportingCurrency | Decimal | ||
| AmountBilled_ApproxAmountInBaseCurrency | Decimal | ||
| AmountBilled_Amount | Decimal | ||
| AmountBilled_ConversionDate | Datetime | ||
| AmountBilled_Currency_UniqueName | String | ||
| NextVersion | String | ||
| NumberBilled | Decimal | The total number of invoiced items on an order. | |
| UniqueName | String | The unique ID of a purchase order. Example: PO456. | |
| ReportingCurrency_UniqueName | String | ||
| OrderedDate | Datetime | The date when an order is sent to the supplier. | |
| ManuallyOrdered | Bool | Indicates whether an order needs to be processed manually. | |
| IsFromExternalReq | Bool | Indicates whether an order originated from Fieldglass. Fieldglass orders are not included in order choosers when users select orders to create PO-based invoices. | |
| MasterAgreement_UniqueName | String | ||
| AmountCleared_AmountInReportingCurrency | Decimal | ||
| AmountCleared_ApproxAmountInBaseCurrency | Decimal | ||
| AmountCleared_Amount | Decimal | ||
| AmountCleared_ConversionDate | Datetime | ||
| AmountCleared_Currency_UniqueName | String | ||
| OriginatingSystem | String | The external system from which a order is imported. This field contains the value Imported if the ID of the external system is not available. | |
| PaymentTerms_UniqueName | String | ||
| NumberReceivableLineItems | Int | The number of line items on a purchase order that are not fully received. | |
| Attachments | String | ||
| AmountReconciled_AmountInReportingCurrency | Decimal | ||
| AmountReconciled_ApproxAmountInBaseCurrency | Decimal | ||
| AmountReconciled_Amount | Decimal | ||
| AmountReconciled_ConversionDate | Datetime | ||
| AmountReconciled_Currency_UniqueName | String | ||
| Supplier_UniqueName | String | ||
| Supplier_Name | String | ||
| AmountRejected_AmountInReportingCurrency | Decimal | ||
| AmountRejected_ApproxAmountInBaseCurrency | Decimal | ||
| AmountRejected_Amount | Decimal | ||
| AmountRejected_ConversionDate | Datetime | ||
| AmountRejected_Currency_UniqueName | String | ||
| StatusString | String | The status of a purchase order. Example: Ordering or Ordered. | |
| PreOrdered | Bool | Indicates whether a purchasing card order originated from the buying solution and not an external system. | |
| IsBlanketOrder | Bool | Indicates whether an order is a blanket purchase order. | |
| PreviousVersion | String | ||
| ApprovalRequestsVersion | Int | The version of an approval request when it was generated. This field is used for internal purpose only. | |
| AmountInvoiced_AmountInReportingCurrency | Decimal | ||
| AmountInvoiced_ApproxAmountInBaseCurrency | Decimal | ||
| AmountInvoiced_Amount | Decimal | ||
| AmountInvoiced_ConversionDate | Datetime | ||
| AmountInvoiced_Currency_UniqueName | String | ||
| TimeUpdated | Datetime | The time when a purchase order was last updated. | |
| OriginatingSystemReferenceID | String | The external system ID of an order associated with an imported requisition. | |
| VersionNumber | Int | The version number of an order. | |
| Type | String | The internal name for the approvable document. For example, the internal name for purchase order is ariba.purchasing.core.PurchaseOrder. | |
| ExpirationDate | Datetime | The expiration date of a purchase order. | |
| Closed | String | Indicates whether an order is closed for invoicing. This field can contain one of these values: 1 - The purchase order is in an Open state, 2 - The purchase order is closed for change, 3 - The purchase order is closed for receiving, 4 - The purchase order is closed for invoicing, 5 - The purchase order is closed for all actions, 6 - The purchase order is adjusted and closed for receiving, 7 - The purchase order is closed for receiving and invoicing, or -1 - The purchase order is closed for various actions. | |
| IsServiceOrder | Bool | Indicates whether a purchase order is a service purchase order. Note: Service purchase orders are orders consisting of service items that follow the service sheet process. | |
| Requisition_UniqueName | String | ||
| Preparer_UniqueName | String | The user who creates a requisition and submits it for approval. | |
| CompanyCode_UniqueName | String | The unique name for the SAP company code. | |
| IncludeInactive | Bool | By default, API responses do not include inactive transactions. You can set this query parameter to true to include inactive transactions in the responses. | |
| createdDateFrom | Datetime | This filter corresponds to the 'TimeCreated' field. The operation is '>' and the default value is '2018-03-01T23:59:59Z'. | |
| createdDateTo | Datetime | This filter corresponds to the 'TimeCreated' field. The operation is '<=' and the default value is '2018-03-29T23:59:59Z'. |
A 'system vsap' view template that queries 'CopyOrder' transaction data.
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.
SELECT * FROM CopyOrderSAPupdatedRange WHERE updatedDateFrom='2024-01-01 00:00:00.0' AND updatedDateTo='2024-02-01 00:00:00.0'
SELECT * FROM CopyOrderSAPupdatedRange WHERE IncludeInactive='True'
| Name | Type | References | Description |
| ApprovedState | String | An integer value representing the current approval state of a purchase order. This field is used for internal purpose only. | |
| InitialUniqueName | String | The ID of the purchase order when it was first created. This field is used for internal purpose only. | |
| InvoicedState | String | The status indicating whether a line item is invoiced (fully or partially) or not invoiced. | |
| SubmitDate | Datetime | The date when a purchase order is successfully submitted for approval. | |
| ReceivedState | String | The status indicating whether a line item is received (either fully or partially) or not received. | |
| HoldTillDate | Datetime | The date until which processing of a fully approved requisition is withheld. | |
| SupplierLocation_State | String | ||
| SupplierLocation_Phone | String | ||
| SupplierLocation_Country_UniqueName | String | ||
| SupplierLocation_PostalCode | String | ||
| SupplierLocation_City | String | ||
| SupplierLocation_Fax | String | ||
| SupplierLocation_UniqueName | String | ||
| SupplierLocation_Lines | String | ||
| SupplierLocation_Name | String | ||
| NumberReceivableOrders | Int | The number of orders that are not fully received. | |
| OrderID | String | The unique ID of a purchase order. Example: PO456. | |
| OrderStatusPunchOutDisabled | Bool | Indicates whether the punchout link on a purchase order is disabled. | |
| ChargeAmount_AmountInReportingCurrency | Decimal | ||
| ChargeAmount_ApproxAmountInBaseCurrency | Decimal | ||
| ChargeAmount_Amount | Decimal | ||
| ChargeAmount_ConversionDate | Datetime | ||
| ChargeAmount_Currency_UniqueName | String | ||
| CreateDate | Datetime | The date when a purchase order is created. | |
| Conditions_UniqueName | String | ||
| Conditions_TAndCVersion | Int | ||
| Name | String | The title of a purchase order. | |
| TotalCost_AmountInReportingCurrency | Decimal | ||
| TotalCost_ApproxAmountInBaseCurrency | Decimal | ||
| TotalCost_Amount | Decimal | ||
| TotalCost_ConversionDate | Datetime | ||
| TotalCost_Currency_UniqueName | String | ||
| OrderConfirmationState | String | The status of the order confirmation for a purchase order. | |
| LastModified | Datetime | The date when a purchase order was last modified. Actions that lead to updates to the history record of a purchase order trigger changes to the last modified date. | |
| TimeCreated | Datetime | The time when a purchase order is created. | |
| AdvancedShipNoticeState | String | The status of the ship notice for an order. | |
| Requester_UniqueName | String | The user on behalf of whom a requisition is created. Typically, the preparer and requester of a requisition are the same user. If a preparer creates a requisition for someone else, the requester is the user for whom the requisition is created. | |
| Version | Int | The internal version number assigned to an approvable document. This field is used for optimistic locking and ensures that changes to the document are followed in an appropriate sequence. This field is used for internal purposes only. | |
| InvoicedDate | Datetime | The date when an order was last invoiced. | |
| UsePOLineNumberForIntegration | Bool | Determines how a line number is assigned to an item on the purchase order. Depending on the settings for the Application.Procure.UsePOLineNumberForExternalIntegration parameter, this field can contain the line number assigned to it in the buying solution or retain the line number assigned in the external ERP system. | |
| AmountAccepted_AmountInReportingCurrency | Decimal | ||
| AmountAccepted_ApproxAmountInBaseCurrency | Decimal | ||
| AmountAccepted_Amount | Decimal | ||
| AmountAccepted_ConversionDate | Datetime | ||
| AmountAccepted_Currency_UniqueName | String | ||
| LineItems | String | ||
| OrderConfirmationStatusString | String | The status of the order confirmation associated with a purchase order. | |
| ChangedBy_UniqueName | String | ||
| OrderedState | String | The status of an order. This field can contain one of the following values: Ordering, Ordered, Canceled, Ordered with Errors or Unordered. | |
| ApprovedDate | Datetime | The date when a purchase order is fully approved. | |
| PreviousApprovalRequestsVersion | Int | The version number for the previous version of the approval request. This field is used for internal purpose only. | |
| ResubmitDate | Datetime | The date when a purchase order is resubmitted for approval. A purchase order is considered as resubmitted if a user edits a denied purchase order and resubmits it for approval. Note: Purchase orders that are withdrawn by the preparer and submitted again are not considered as resubmitted purchase orders. | |
| NumberCleared | Decimal | The number of invoiced items on an order that have been cleared after invoices are reconciled. | |
| OrderMethodCategory | String | The ordering method configured for a customer site. This field contains one of the following values: Direct, PCard, or ERP. | |
| RejectionReason | String | The reason provided by a supplier on Ariba Network while rejecting an order. | |
| Active | Bool | Indicates whether a purchase order is currently in use in the buying solution. This field can contain the values as True or False. False indicates inactive purchase orders. Inactive purchase orders are considered as those that are deleted and do not appear in search results and purchase order choosers. | |
| ReceivedDate | Datetime | The date when a shipment of an item was last received. | |
| AmountBilled_AmountInReportingCurrency | Decimal | ||
| AmountBilled_ApproxAmountInBaseCurrency | Decimal | ||
| AmountBilled_Amount | Decimal | ||
| AmountBilled_ConversionDate | Datetime | ||
| AmountBilled_Currency_UniqueName | String | ||
| NextVersion | String | ||
| NumberBilled | Decimal | The total number of invoiced items on an order. | |
| UniqueName | String | The unique ID of a purchase order. Example: PO456. | |
| ReportingCurrency_UniqueName | String | ||
| OrderedDate | Datetime | The date when an order is sent to the supplier. | |
| ManuallyOrdered | Bool | Indicates whether an order needs to be processed manually. | |
| IsFromExternalReq | Bool | Indicates whether an order originated from Fieldglass. Fieldglass orders are not included in order choosers when users select orders to create PO-based invoices. | |
| MasterAgreement_UniqueName | String | ||
| AmountCleared_AmountInReportingCurrency | Decimal | ||
| AmountCleared_ApproxAmountInBaseCurrency | Decimal | ||
| AmountCleared_Amount | Decimal | ||
| AmountCleared_ConversionDate | Datetime | ||
| AmountCleared_Currency_UniqueName | String | ||
| OriginatingSystem | String | The external system from which a order is imported. This field contains the value Imported if the ID of the external system is not available. | |
| PaymentTerms_UniqueName | String | ||
| NumberReceivableLineItems | Int | The number of line items on a purchase order that are not fully received. | |
| Attachments | String | ||
| AmountReconciled_AmountInReportingCurrency | Decimal | ||
| AmountReconciled_ApproxAmountInBaseCurrency | Decimal | ||
| AmountReconciled_Amount | Decimal | ||
| AmountReconciled_ConversionDate | Datetime | ||
| AmountReconciled_Currency_UniqueName | String | ||
| Supplier_UniqueName | String | ||
| Supplier_Name | String | ||
| AmountRejected_AmountInReportingCurrency | Decimal | ||
| AmountRejected_ApproxAmountInBaseCurrency | Decimal | ||
| AmountRejected_Amount | Decimal | ||
| AmountRejected_ConversionDate | Datetime | ||
| AmountRejected_Currency_UniqueName | String | ||
| StatusString | String | The status of a purchase order. Example: Ordering or Ordered. | |
| PreOrdered | Bool | Indicates whether a purchasing card order originated from the buying solution and not an external system. | |
| IsBlanketOrder | Bool | Indicates whether an order is a blanket purchase order. | |
| PreviousVersion | String | ||
| ApprovalRequestsVersion | Int | The version of an approval request when it was generated. This field is used for internal purpose only. | |
| AmountInvoiced_AmountInReportingCurrency | Decimal | ||
| AmountInvoiced_ApproxAmountInBaseCurrency | Decimal | ||
| AmountInvoiced_Amount | Decimal | ||
| AmountInvoiced_ConversionDate | Datetime | ||
| AmountInvoiced_Currency_UniqueName | String | ||
| TimeUpdated | Datetime | The time when a purchase order was last updated. | |
| OriginatingSystemReferenceID | String | The external system ID of an order associated with an imported requisition. | |
| VersionNumber | Int | The version number of an order. | |
| Type | String | The internal name for the approvable document. For example, the internal name for purchase order is ariba.purchasing.core.PurchaseOrder. | |
| ExpirationDate | Datetime | The expiration date of a purchase order. | |
| Closed | String | Indicates whether an order is closed for invoicing. This field can contain one of these values: 1 - The purchase order is in an Open state, 2 - The purchase order is closed for change, 3 - The purchase order is closed for receiving, 4 - The purchase order is closed for invoicing, 5 - The purchase order is closed for all actions, 6 - The purchase order is adjusted and closed for receiving, 7 - The purchase order is closed for receiving and invoicing, or -1 - The purchase order is closed for various actions. | |
| IsServiceOrder | Bool | Indicates whether a purchase order is a service purchase order. Note: Service purchase orders are orders consisting of service items that follow the service sheet process. | |
| Requisition_UniqueName | String | ||
| Preparer_UniqueName | String | The user who creates a requisition and submits it for approval. | |
| CompanyCode_UniqueName | String | The unique name for the SAP company code. | |
| IncludeInactive | Bool | By default, API responses do not include inactive transactions. You can set this query parameter to true to include inactive transactions in the responses. | |
| updatedDateFrom | Datetime | This filter corresponds to the 'TimeUpdated' field. The operation is '>' and the default value is '2018-03-01T23:59:59Z'. | |
| updatedDateTo | Datetime | This filter corresponds to the 'TimeUpdated' field. The operation is '<=' and the default value is '2018-03-29T23:59:59Z'. |
A 'system vsap' view template that queries 'DirectOrder' transaction data.
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.
SELECT * FROM DirectOrderSAPcreatedRange WHERE createdDateFrom='2024-01-01 00:00:00.0' AND createdDateTo='2024-02-01 00:00:00.0'
SELECT * FROM DirectOrderSAPcreatedRange WHERE IncludeInactive='True'
| Name | Type | References | Description |
| ApprovedState | String | An integer value representing the current approval state of a purchase order. This field is used for internal purpose only. | |
| InitialUniqueName | String | The ID of the purchase order when it was first created. This field is used for internal purpose only. | |
| InvoicedState | String | The status indicating whether a line item is invoiced (fully or partially) or not invoiced. | |
| SubmitDate | Datetime | The date when a purchase order is successfully submitted for approval. | |
| ReceivedState | String | The status indicating whether a line item is received (either fully or partially) or not received. | |
| HoldTillDate | Datetime | The date until which processing of a fully approved requisition is withheld. | |
| SupplierLocation_State | String | ||
| SupplierLocation_Phone | String | ||
| SupplierLocation_Country_UniqueName | String | ||
| SupplierLocation_PostalCode | String | ||
| SupplierLocation_City | String | ||
| SupplierLocation_Fax | String | ||
| SupplierLocation_UniqueName | String | ||
| SupplierLocation_Lines | String | ||
| SupplierLocation_Name | String | ||
| NumberReceivableOrders | Int | The number of orders that are not fully received. | |
| OrderID | String | The unique ID of a purchase order. Example: PO456. | |
| OrderStatusPunchOutDisabled | Bool | Indicates whether the punchout link on a purchase order is disabled. | |
| ChargeAmount_AmountInReportingCurrency | Decimal | ||
| ChargeAmount_ApproxAmountInBaseCurrency | Decimal | ||
| ChargeAmount_Amount | Decimal | ||
| ChargeAmount_ConversionDate | Datetime | ||
| ChargeAmount_Currency_UniqueName | String | ||
| CreateDate | Datetime | The date when a purchase order is created. | |
| Conditions_UniqueName | String | ||
| Conditions_TAndCVersion | Int | ||
| Name | String | The title of a purchase order. | |
| TotalCost_AmountInReportingCurrency | Decimal | ||
| TotalCost_ApproxAmountInBaseCurrency | Decimal | ||
| TotalCost_Amount | Decimal | ||
| TotalCost_ConversionDate | Datetime | ||
| TotalCost_Currency_UniqueName | String | ||
| OrderConfirmationState | String | The status of the order confirmation for a purchase order. | |
| LastModified | Datetime | The date when a purchase order was last modified. Actions that lead to updates to the history record of a purchase order trigger changes to the last modified date. | |
| TimeCreated | Datetime | The time when a purchase order is created. | |
| AdvancedShipNoticeState | String | The status of the ship notice for an order. | |
| Requester_UniqueName | String | The user on behalf of whom a requisition is created. Typically, the preparer and requester of a requisition are the same user. If a preparer creates a requisition for someone else, the requester is the user for whom the requisition is created. | |
| Version | Int | The internal version number assigned to an approvable document. This field is used for optimistic locking and ensures that changes to the document are followed in an appropriate sequence. This field is used for internal purposes only. | |
| InvoicedDate | Datetime | The date when an order was last invoiced. | |
| UsePOLineNumberForIntegration | Bool | Determines how a line number is assigned to an item on the purchase order. Depending on the settings for the Application.Procure.UsePOLineNumberForExternalIntegration parameter, this field can contain the line number assigned to it in the buying solution or retain the line number assigned in the external ERP system. | |
| AmountAccepted_AmountInReportingCurrency | Decimal | ||
| AmountAccepted_ApproxAmountInBaseCurrency | Decimal | ||
| AmountAccepted_Amount | Decimal | ||
| AmountAccepted_ConversionDate | Datetime | ||
| AmountAccepted_Currency_UniqueName | String | ||
| LineItems | String | ||
| OrderConfirmationStatusString | String | The status of the order confirmation associated with a purchase order. | |
| ChangedBy_UniqueName | String | ||
| OrderedState | String | The status of an order. This field can contain one of the following values: Ordering, Ordered, Canceled, Ordered with Errors or Unordered. | |
| ApprovedDate | Datetime | The date when a purchase order is fully approved. | |
| PreviousApprovalRequestsVersion | Int | The version number for the previous version of the approval request. This field is used for internal purpose only. | |
| ResubmitDate | Datetime | The date when a purchase order is resubmitted for approval. A purchase order is considered as resubmitted if a user edits a denied purchase order and resubmits it for approval. Note: Purchase orders that are withdrawn by the preparer and submitted again are not considered as resubmitted purchase orders. | |
| NumberCleared | Decimal | The number of invoiced items on an order that have been cleared after invoices are reconciled. | |
| OrderMethodCategory | String | The ordering method configured for a customer site. This field contains one of the following values: Direct, PCard, or ERP. | |
| RejectionReason | String | The reason provided by a supplier on Ariba Network while rejecting an order. | |
| Active | Bool | Indicates whether a purchase order is currently in use in the buying solution. This field can contain the values as True or False. False indicates inactive purchase orders. Inactive purchase orders are considered as those that are deleted and do not appear in search results and purchase order choosers. | |
| ReceivedDate | Datetime | The date when a shipment of an item was last received. | |
| AmountBilled_AmountInReportingCurrency | Decimal | ||
| AmountBilled_ApproxAmountInBaseCurrency | Decimal | ||
| AmountBilled_Amount | Decimal | ||
| AmountBilled_ConversionDate | Datetime | ||
| AmountBilled_Currency_UniqueName | String | ||
| NextVersion | String | ||
| NumberBilled | Decimal | The total number of invoiced items on an order. | |
| UniqueName | String | The unique ID of a purchase order. Example: PO456. | |
| ReportingCurrency_UniqueName | String | ||
| OrderedDate | Datetime | The date when an order is sent to the supplier. | |
| ManuallyOrdered | Bool | Indicates whether an order needs to be processed manually. | |
| IsFromExternalReq | Bool | Indicates whether an order originated from Fieldglass. Fieldglass orders are not included in order choosers when users select orders to create PO-based invoices. | |
| MasterAgreement_UniqueName | String | ||
| AmountCleared_AmountInReportingCurrency | Decimal | ||
| AmountCleared_ApproxAmountInBaseCurrency | Decimal | ||
| AmountCleared_Amount | Decimal | ||
| AmountCleared_ConversionDate | Datetime | ||
| AmountCleared_Currency_UniqueName | String | ||
| OriginatingSystem | String | The external system from which a order is imported. This field contains the value Imported if the ID of the external system is not available. | |
| PaymentTerms_UniqueName | String | ||
| NumberReceivableLineItems | Int | The number of line items on a purchase order that are not fully received. | |
| Attachments | String | ||
| AmountReconciled_AmountInReportingCurrency | Decimal | ||
| AmountReconciled_ApproxAmountInBaseCurrency | Decimal | ||
| AmountReconciled_Amount | Decimal | ||
| AmountReconciled_ConversionDate | Datetime | ||
| AmountReconciled_Currency_UniqueName | String | ||
| Supplier_UniqueName | String | ||
| Supplier_Name | String | ||
| AmountRejected_AmountInReportingCurrency | Decimal | ||
| AmountRejected_ApproxAmountInBaseCurrency | Decimal | ||
| AmountRejected_Amount | Decimal | ||
| AmountRejected_ConversionDate | Datetime | ||
| AmountRejected_Currency_UniqueName | String | ||
| StatusString | String | The status of a purchase order. Example: Ordering or Ordered. | |
| PreOrdered | Bool | Indicates whether a purchasing card order originated from the buying solution and not an external system. | |
| IsBlanketOrder | Bool | Indicates whether an order is a blanket purchase order. | |
| PreviousVersion | String | ||
| ApprovalRequestsVersion | Int | The version of an approval request when it was generated. This field is used for internal purpose only. | |
| AmountInvoiced_AmountInReportingCurrency | Decimal | ||
| AmountInvoiced_ApproxAmountInBaseCurrency | Decimal | ||
| AmountInvoiced_Amount | Decimal | ||
| AmountInvoiced_ConversionDate | Datetime | ||
| AmountInvoiced_Currency_UniqueName | String | ||
| TimeUpdated | Datetime | The time when a purchase order was last updated. | |
| OriginatingSystemReferenceID | String | The external system ID of an order associated with an imported requisition. | |
| VersionNumber | Int | The version number of an order. | |
| Type | String | The internal name for the approvable document. For example, the internal name for purchase order is ariba.purchasing.core.PurchaseOrder. | |
| ExpirationDate | Datetime | The expiration date of a purchase order. | |
| Closed | String | Indicates whether an order is closed for invoicing. This field can contain one of these values: 1 - The purchase order is in an Open state, 2 - The purchase order is closed for change, 3 - The purchase order is closed for receiving, 4 - The purchase order is closed for invoicing, 5 - The purchase order is closed for all actions, 6 - The purchase order is adjusted and closed for receiving, 7 - The purchase order is closed for receiving and invoicing, or -1 - The purchase order is closed for various actions. | |
| IsServiceOrder | Bool | Indicates whether a purchase order is a service purchase order. Note: Service purchase orders are orders consisting of service items that follow the service sheet process. | |
| Requisition_UniqueName | String | ||
| Preparer_UniqueName | String | The user who creates a requisition and submits it for approval. | |
| CompanyCode_UniqueName | String | The unique name for the SAP company code. | |
| IncludeInactive | Bool | By default, API responses do not include inactive transactions. You can set this query parameter to true to include inactive transactions in the responses. | |
| createdDateFrom | Datetime | This filter corresponds to the 'TimeCreated' field. The operation is '>' and the default value is '2018-03-01T23:59:59Z'. | |
| createdDateTo | Datetime | This filter corresponds to the 'TimeCreated' field. The operation is '<=' and the default value is '2018-03-29T23:59:59Z'. |
A 'system vsap' view template that queries 'DirectOrder' transaction data.
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.
SELECT * FROM DirectOrderSAPupdatedRange WHERE updatedDateFrom='2024-01-01 00:00:00.0' AND updatedDateTo='2024-02-01 00:00:00.0'
SELECT * FROM DirectOrderSAPupdatedRange WHERE IncludeInactive='True'
| Name | Type | References | Description |
| ApprovedState | String | An integer value representing the current approval state of a purchase order. This field is used for internal purpose only. | |
| InitialUniqueName | String | The ID of the purchase order when it was first created. This field is used for internal purpose only. | |
| InvoicedState | String | The status indicating whether a line item is invoiced (fully or partially) or not invoiced. | |
| SubmitDate | Datetime | The date when a purchase order is successfully submitted for approval. | |
| ReceivedState | String | The status indicating whether a line item is received (either fully or partially) or not received. | |
| HoldTillDate | Datetime | The date until which processing of a fully approved requisition is withheld. | |
| SupplierLocation_State | String | ||
| SupplierLocation_Phone | String | ||
| SupplierLocation_Country_UniqueName | String | ||
| SupplierLocation_PostalCode | String | ||
| SupplierLocation_City | String | ||
| SupplierLocation_Fax | String | ||
| SupplierLocation_UniqueName | String | ||
| SupplierLocation_Lines | String | ||
| SupplierLocation_Name | String | ||
| NumberReceivableOrders | Int | The number of orders that are not fully received. | |
| OrderID | String | The unique ID of a purchase order. Example: PO456. | |
| OrderStatusPunchOutDisabled | Bool | Indicates whether the punchout link on a purchase order is disabled. | |
| ChargeAmount_AmountInReportingCurrency | Decimal | ||
| ChargeAmount_ApproxAmountInBaseCurrency | Decimal | ||
| ChargeAmount_Amount | Decimal | ||
| ChargeAmount_ConversionDate | Datetime | ||
| ChargeAmount_Currency_UniqueName | String | ||
| CreateDate | Datetime | The date when a purchase order is created. | |
| Conditions_UniqueName | String | ||
| Conditions_TAndCVersion | Int | ||
| Name | String | The title of a purchase order. | |
| TotalCost_AmountInReportingCurrency | Decimal | ||
| TotalCost_ApproxAmountInBaseCurrency | Decimal | ||
| TotalCost_Amount | Decimal | ||
| TotalCost_ConversionDate | Datetime | ||
| TotalCost_Currency_UniqueName | String | ||
| OrderConfirmationState | String | The status of the order confirmation for a purchase order. | |
| LastModified | Datetime | The date when a purchase order was last modified. Actions that lead to updates to the history record of a purchase order trigger changes to the last modified date. | |
| TimeCreated | Datetime | The time when a purchase order is created. | |
| AdvancedShipNoticeState | String | The status of the ship notice for an order. | |
| Requester_UniqueName | String | The user on behalf of whom a requisition is created. Typically, the preparer and requester of a requisition are the same user. If a preparer creates a requisition for someone else, the requester is the user for whom the requisition is created. | |
| Version | Int | The internal version number assigned to an approvable document. This field is used for optimistic locking and ensures that changes to the document are followed in an appropriate sequence. This field is used for internal purposes only. | |
| InvoicedDate | Datetime | The date when an order was last invoiced. | |
| UsePOLineNumberForIntegration | Bool | Determines how a line number is assigned to an item on the purchase order. Depending on the settings for the Application.Procure.UsePOLineNumberForExternalIntegration parameter, this field can contain the line number assigned to it in the buying solution or retain the line number assigned in the external ERP system. | |
| AmountAccepted_AmountInReportingCurrency | Decimal | ||
| AmountAccepted_ApproxAmountInBaseCurrency | Decimal | ||
| AmountAccepted_Amount | Decimal | ||
| AmountAccepted_ConversionDate | Datetime | ||
| AmountAccepted_Currency_UniqueName | String | ||
| LineItems | String | ||
| OrderConfirmationStatusString | String | The status of the order confirmation associated with a purchase order. | |
| ChangedBy_UniqueName | String | ||
| OrderedState | String | The status of an order. This field can contain one of the following values: Ordering, Ordered, Canceled, Ordered with Errors or Unordered. | |
| ApprovedDate | Datetime | The date when a purchase order is fully approved. | |
| PreviousApprovalRequestsVersion | Int | The version number for the previous version of the approval request. This field is used for internal purpose only. | |
| ResubmitDate | Datetime | The date when a purchase order is resubmitted for approval. A purchase order is considered as resubmitted if a user edits a denied purchase order and resubmits it for approval. Note: Purchase orders that are withdrawn by the preparer and submitted again are not considered as resubmitted purchase orders. | |
| NumberCleared | Decimal | The number of invoiced items on an order that have been cleared after invoices are reconciled. | |
| OrderMethodCategory | String | The ordering method configured for a customer site. This field contains one of the following values: Direct, PCard, or ERP. | |
| RejectionReason | String | The reason provided by a supplier on Ariba Network while rejecting an order. | |
| Active | Bool | Indicates whether a purchase order is currently in use in the buying solution. This field can contain the values as True or False. False indicates inactive purchase orders. Inactive purchase orders are considered as those that are deleted and do not appear in search results and purchase order choosers. | |
| ReceivedDate | Datetime | The date when a shipment of an item was last received. | |
| AmountBilled_AmountInReportingCurrency | Decimal | ||
| AmountBilled_ApproxAmountInBaseCurrency | Decimal | ||
| AmountBilled_Amount | Decimal | ||
| AmountBilled_ConversionDate | Datetime | ||
| AmountBilled_Currency_UniqueName | String | ||
| NextVersion | String | ||
| NumberBilled | Decimal | The total number of invoiced items on an order. | |
| UniqueName | String | The unique ID of a purchase order. Example: PO456. | |
| ReportingCurrency_UniqueName | String | ||
| OrderedDate | Datetime | The date when an order is sent to the supplier. | |
| ManuallyOrdered | Bool | Indicates whether an order needs to be processed manually. | |
| IsFromExternalReq | Bool | Indicates whether an order originated from Fieldglass. Fieldglass orders are not included in order choosers when users select orders to create PO-based invoices. | |
| MasterAgreement_UniqueName | String | ||
| AmountCleared_AmountInReportingCurrency | Decimal | ||
| AmountCleared_ApproxAmountInBaseCurrency | Decimal | ||
| AmountCleared_Amount | Decimal | ||
| AmountCleared_ConversionDate | Datetime | ||
| AmountCleared_Currency_UniqueName | String | ||
| OriginatingSystem | String | The external system from which a order is imported. This field contains the value Imported if the ID of the external system is not available. | |
| PaymentTerms_UniqueName | String | ||
| NumberReceivableLineItems | Int | The number of line items on a purchase order that are not fully received. | |
| Attachments | String | ||
| AmountReconciled_AmountInReportingCurrency | Decimal | ||
| AmountReconciled_ApproxAmountInBaseCurrency | Decimal | ||
| AmountReconciled_Amount | Decimal | ||
| AmountReconciled_ConversionDate | Datetime | ||
| AmountReconciled_Currency_UniqueName | String | ||
| Supplier_UniqueName | String | ||
| Supplier_Name | String | ||
| AmountRejected_AmountInReportingCurrency | Decimal | ||
| AmountRejected_ApproxAmountInBaseCurrency | Decimal | ||
| AmountRejected_Amount | Decimal | ||
| AmountRejected_ConversionDate | Datetime | ||
| AmountRejected_Currency_UniqueName | String | ||
| StatusString | String | The status of a purchase order. Example: Ordering or Ordered. | |
| PreOrdered | Bool | Indicates whether a purchasing card order originated from the buying solution and not an external system. | |
| IsBlanketOrder | Bool | Indicates whether an order is a blanket purchase order. | |
| PreviousVersion | String | ||
| ApprovalRequestsVersion | Int | The version of an approval request when it was generated. This field is used for internal purpose only. | |
| AmountInvoiced_AmountInReportingCurrency | Decimal | ||
| AmountInvoiced_ApproxAmountInBaseCurrency | Decimal | ||
| AmountInvoiced_Amount | Decimal | ||
| AmountInvoiced_ConversionDate | Datetime | ||
| AmountInvoiced_Currency_UniqueName | String | ||
| TimeUpdated | Datetime | The time when a purchase order was last updated. | |
| OriginatingSystemReferenceID | String | The external system ID of an order associated with an imported requisition. | |
| VersionNumber | Int | The version number of an order. | |
| Type | String | The internal name for the approvable document. For example, the internal name for purchase order is ariba.purchasing.core.PurchaseOrder. | |
| ExpirationDate | Datetime | The expiration date of a purchase order. | |
| Closed | String | Indicates whether an order is closed for invoicing. This field can contain one of these values: 1 - The purchase order is in an Open state, 2 - The purchase order is closed for change, 3 - The purchase order is closed for receiving, 4 - The purchase order is closed for invoicing, 5 - The purchase order is closed for all actions, 6 - The purchase order is adjusted and closed for receiving, 7 - The purchase order is closed for receiving and invoicing, or -1 - The purchase order is closed for various actions. | |
| IsServiceOrder | Bool | Indicates whether a purchase order is a service purchase order. Note: Service purchase orders are orders consisting of service items that follow the service sheet process. | |
| Requisition_UniqueName | String | ||
| Preparer_UniqueName | String | The user who creates a requisition and submits it for approval. | |
| CompanyCode_UniqueName | String | The unique name for the SAP company code. | |
| IncludeInactive | Bool | By default, API responses do not include inactive transactions. You can set this query parameter to true to include inactive transactions in the responses. | |
| updatedDateFrom | Datetime | This filter corresponds to the 'TimeUpdated' field. The operation is '>' and the default value is '2018-03-01T23:59:59Z'. | |
| updatedDateTo | Datetime | This filter corresponds to the 'TimeUpdated' field. The operation is '<=' and the default value is '2018-03-29T23:59:59Z'. |
A 'system vsap' view template that queries 'ERPOrder' transaction data.
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.
SELECT * FROM ERPOrderSAPcreatedRange WHERE createdDateFrom='2024-01-01 00:00:00.0' AND createdDateTo='2024-02-01 00:00:00.0'
SELECT * FROM ERPOrderSAPcreatedRange WHERE IncludeInactive='True'
| Name | Type | References | Description |
| ApprovedState | String | An integer value representing the current approval state of a purchase order. This field is used for internal purpose only. | |
| InitialUniqueName | String | The ID of the purchase order when it was first created. This field is used for internal purpose only. | |
| InvoicedState | String | The status indicating whether a line item is invoiced (fully or partially) or not invoiced. | |
| SubmitDate | Datetime | The date when a purchase order is successfully submitted for approval. | |
| ReceivedState | String | The status indicating whether a line item is received (either fully or partially) or not received. | |
| HoldTillDate | Datetime | The date until which processing of a fully approved requisition is withheld. | |
| SupplierLocation_State | String | ||
| SupplierLocation_Phone | String | ||
| SupplierLocation_Country_UniqueName | String | ||
| SupplierLocation_PostalCode | String | ||
| SupplierLocation_City | String | ||
| SupplierLocation_Fax | String | ||
| SupplierLocation_UniqueName | String | ||
| SupplierLocation_Lines | String | ||
| SupplierLocation_Name | String | ||
| NumberReceivableOrders | Int | The number of orders that are not fully received. | |
| OrderID | String | The unique ID of a purchase order. Example: PO456. | |
| OrderStatusPunchOutDisabled | Bool | Indicates whether the punchout link on a purchase order is disabled. | |
| ChargeAmount_AmountInReportingCurrency | Decimal | ||
| ChargeAmount_ApproxAmountInBaseCurrency | Decimal | ||
| ChargeAmount_Amount | Decimal | ||
| ChargeAmount_ConversionDate | Datetime | ||
| ChargeAmount_Currency_UniqueName | String | ||
| CreateDate | Datetime | The date when a purchase order is created. | |
| Conditions_UniqueName | String | ||
| Conditions_TAndCVersion | Int | ||
| Name | String | The title of a purchase order. | |
| TotalCost_AmountInReportingCurrency | Decimal | ||
| TotalCost_ApproxAmountInBaseCurrency | Decimal | ||
| TotalCost_Amount | Decimal | ||
| TotalCost_ConversionDate | Datetime | ||
| TotalCost_Currency_UniqueName | String | ||
| OrderConfirmationState | String | The status of the order confirmation for a purchase order. | |
| LastModified | Datetime | The date when a purchase order was last modified. Actions that lead to updates to the history record of a purchase order trigger changes to the last modified date. | |
| TimeCreated | Datetime | The time when a purchase order is created. | |
| AdvancedShipNoticeState | String | The status of the ship notice for an order. | |
| Requester_UniqueName | String | The user on behalf of whom a requisition is created. Typically, the preparer and requester of a requisition are the same user. If a preparer creates a requisition for someone else, the requester is the user for whom the requisition is created. | |
| Version | Int | The internal version number assigned to an approvable document. This field is used for optimistic locking and ensures that changes to the document are followed in an appropriate sequence. This field is used for internal purposes only. | |
| InvoicedDate | Datetime | The date when an order was last invoiced. | |
| UsePOLineNumberForIntegration | Bool | Determines how a line number is assigned to an item on the purchase order. Depending on the settings for the Application.Procure.UsePOLineNumberForExternalIntegration parameter, this field can contain the line number assigned to it in the buying solution or retain the line number assigned in the external ERP system. | |
| AmountAccepted_AmountInReportingCurrency | Decimal | ||
| AmountAccepted_ApproxAmountInBaseCurrency | Decimal | ||
| AmountAccepted_Amount | Decimal | ||
| AmountAccepted_ConversionDate | Datetime | ||
| AmountAccepted_Currency_UniqueName | String | ||
| LineItems | String | ||
| OrderConfirmationStatusString | String | The status of the order confirmation associated with a purchase order. | |
| ChangedBy_UniqueName | String | ||
| OrderedState | String | The status of an order. This field can contain one of the following values: Ordering, Ordered, Canceled, Ordered with Errors or Unordered. | |
| ApprovedDate | Datetime | The date when a purchase order is fully approved. | |
| PreviousApprovalRequestsVersion | Int | The version number for the previous version of the approval request. This field is used for internal purpose only. | |
| ResubmitDate | Datetime | The date when a purchase order is resubmitted for approval. A purchase order is considered as resubmitted if a user edits a denied purchase order and resubmits it for approval. Note: Purchase orders that are withdrawn by the preparer and submitted again are not considered as resubmitted purchase orders. | |
| NumberCleared | Decimal | The number of invoiced items on an order that have been cleared after invoices are reconciled. | |
| OrderMethodCategory | String | The ordering method configured for a customer site. This field contains one of the following values: Direct, PCard, or ERP. | |
| RejectionReason | String | The reason provided by a supplier on Ariba Network while rejecting an order. | |
| Active | Bool | Indicates whether a purchase order is currently in use in the buying solution. This field can contain the values as True or False. False indicates inactive purchase orders. Inactive purchase orders are considered as those that are deleted and do not appear in search results and purchase order choosers. | |
| ReceivedDate | Datetime | The date when a shipment of an item was last received. | |
| AmountBilled_AmountInReportingCurrency | Decimal | ||
| AmountBilled_ApproxAmountInBaseCurrency | Decimal | ||
| AmountBilled_Amount | Decimal | ||
| AmountBilled_ConversionDate | Datetime | ||
| AmountBilled_Currency_UniqueName | String | ||
| NextVersion | String | ||
| NumberBilled | Decimal | The total number of invoiced items on an order. | |
| UniqueName | String | The unique ID of a purchase order. Example: PO456. | |
| ReportingCurrency_UniqueName | String | ||
| OrderedDate | Datetime | The date when an order is sent to the supplier. | |
| ManuallyOrdered | Bool | Indicates whether an order needs to be processed manually. | |
| IsFromExternalReq | Bool | Indicates whether an order originated from Fieldglass. Fieldglass orders are not included in order choosers when users select orders to create PO-based invoices. | |
| MasterAgreement_UniqueName | String | ||
| AmountCleared_AmountInReportingCurrency | Decimal | ||
| AmountCleared_ApproxAmountInBaseCurrency | Decimal | ||
| AmountCleared_Amount | Decimal | ||
| AmountCleared_ConversionDate | Datetime | ||
| AmountCleared_Currency_UniqueName | String | ||
| OriginatingSystem | String | The external system from which a order is imported. This field contains the value Imported if the ID of the external system is not available. | |
| PaymentTerms_UniqueName | String | ||
| NumberReceivableLineItems | Int | The number of line items on a purchase order that are not fully received. | |
| Attachments | String | ||
| AmountReconciled_AmountInReportingCurrency | Decimal | ||
| AmountReconciled_ApproxAmountInBaseCurrency | Decimal | ||
| AmountReconciled_Amount | Decimal | ||
| AmountReconciled_ConversionDate | Datetime | ||
| AmountReconciled_Currency_UniqueName | String | ||
| Supplier_UniqueName | String | ||
| Supplier_Name | String | ||
| AmountRejected_AmountInReportingCurrency | Decimal | ||
| AmountRejected_ApproxAmountInBaseCurrency | Decimal | ||
| AmountRejected_Amount | Decimal | ||
| AmountRejected_ConversionDate | Datetime | ||
| AmountRejected_Currency_UniqueName | String | ||
| StatusString | String | The status of a purchase order. Example: Ordering or Ordered. | |
| PreOrdered | Bool | Indicates whether a purchasing card order originated from the buying solution and not an external system. | |
| IsBlanketOrder | Bool | Indicates whether an order is a blanket purchase order. | |
| PreviousVersion | String | ||
| ApprovalRequestsVersion | Int | The version of an approval request when it was generated. This field is used for internal purpose only. | |
| AmountInvoiced_AmountInReportingCurrency | Decimal | ||
| AmountInvoiced_ApproxAmountInBaseCurrency | Decimal | ||
| AmountInvoiced_Amount | Decimal | ||
| AmountInvoiced_ConversionDate | Datetime | ||
| AmountInvoiced_Currency_UniqueName | String | ||
| TimeUpdated | Datetime | The time when a purchase order was last updated. | |
| OriginatingSystemReferenceID | String | The external system ID of an order associated with an imported requisition. | |
| VersionNumber | Int | The version number of an order. | |
| Type | String | The internal name for the approvable document. For example, the internal name for purchase order is ariba.purchasing.core.PurchaseOrder. | |
| ExpirationDate | Datetime | The expiration date of a purchase order. | |
| Closed | String | Indicates whether an order is closed for invoicing. This field can contain one of these values: 1 - The purchase order is in an Open state, 2 - The purchase order is closed for change, 3 - The purchase order is closed for receiving, 4 - The purchase order is closed for invoicing, 5 - The purchase order is closed for all actions, 6 - The purchase order is adjusted and closed for receiving, 7 - The purchase order is closed for receiving and invoicing, or -1 - The purchase order is closed for various actions. | |
| IsServiceOrder | Bool | Indicates whether a purchase order is a service purchase order. Note: Service purchase orders are orders consisting of service items that follow the service sheet process. | |
| Requisition_UniqueName | String | ||
| Preparer_UniqueName | String | The user who creates a requisition and submits it for approval. | |
| CompanyCode_UniqueName | String | The unique name for the SAP company code. | |
| IncludeInactive | Bool | By default, API responses do not include inactive transactions. You can set this query parameter to true to include inactive transactions in the responses. | |
| createdDateFrom | Datetime | This filter corresponds to the 'TimeCreated' field. The operation is '>' and the default value is '2018-03-01T23:59:59Z'. | |
| createdDateTo | Datetime | This filter corresponds to the 'TimeCreated' field. The operation is '<=' and the default value is '2018-03-29T23:59:59Z'. |
A 'system vsap' view template that queries 'ERPOrder' transaction data.
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.
SELECT * FROM ERPOrderSAPupdatedRange WHERE updatedDateFrom='2024-01-01 00:00:00.0' AND updatedDateTo='2024-02-01 00:00:00.0'
SELECT * FROM ERPOrderSAPupdatedRange WHERE IncludeInactive='True'
| Name | Type | References | Description |
| ApprovedState | String | An integer value representing the current approval state of a purchase order. This field is used for internal purpose only. | |
| InitialUniqueName | String | The ID of the purchase order when it was first created. This field is used for internal purpose only. | |
| InvoicedState | String | The status indicating whether a line item is invoiced (fully or partially) or not invoiced. | |
| SubmitDate | Datetime | The date when a purchase order is successfully submitted for approval. | |
| ReceivedState | String | The status indicating whether a line item is received (either fully or partially) or not received. | |
| HoldTillDate | Datetime | The date until which processing of a fully approved requisition is withheld. | |
| SupplierLocation_State | String | ||
| SupplierLocation_Phone | String | ||
| SupplierLocation_Country_UniqueName | String | ||
| SupplierLocation_PostalCode | String | ||
| SupplierLocation_City | String | ||
| SupplierLocation_Fax | String | ||
| SupplierLocation_UniqueName | String | ||
| SupplierLocation_Lines | String | ||
| SupplierLocation_Name | String | ||
| NumberReceivableOrders | Int | The number of orders that are not fully received. | |
| OrderID | String | The unique ID of a purchase order. Example: PO456. | |
| OrderStatusPunchOutDisabled | Bool | Indicates whether the punchout link on a purchase order is disabled. | |
| ChargeAmount_AmountInReportingCurrency | Decimal | ||
| ChargeAmount_ApproxAmountInBaseCurrency | Decimal | ||
| ChargeAmount_Amount | Decimal | ||
| ChargeAmount_ConversionDate | Datetime | ||
| ChargeAmount_Currency_UniqueName | String | ||
| CreateDate | Datetime | The date when a purchase order is created. | |
| Conditions_UniqueName | String | ||
| Conditions_TAndCVersion | Int | ||
| Name | String | The title of a purchase order. | |
| TotalCost_AmountInReportingCurrency | Decimal | ||
| TotalCost_ApproxAmountInBaseCurrency | Decimal | ||
| TotalCost_Amount | Decimal | ||
| TotalCost_ConversionDate | Datetime | ||
| TotalCost_Currency_UniqueName | String | ||
| OrderConfirmationState | String | The status of the order confirmation for a purchase order. | |
| LastModified | Datetime | The date when a purchase order was last modified. Actions that lead to updates to the history record of a purchase order trigger changes to the last modified date. | |
| TimeCreated | Datetime | The time when a purchase order is created. | |
| AdvancedShipNoticeState | String | The status of the ship notice for an order. | |
| Requester_UniqueName | String | The user on behalf of whom a requisition is created. Typically, the preparer and requester of a requisition are the same user. If a preparer creates a requisition for someone else, the requester is the user for whom the requisition is created. | |
| Version | Int | The internal version number assigned to an approvable document. This field is used for optimistic locking and ensures that changes to the document are followed in an appropriate sequence. This field is used for internal purposes only. | |
| InvoicedDate | Datetime | The date when an order was last invoiced. | |
| UsePOLineNumberForIntegration | Bool | Determines how a line number is assigned to an item on the purchase order. Depending on the settings for the Application.Procure.UsePOLineNumberForExternalIntegration parameter, this field can contain the line number assigned to it in the buying solution or retain the line number assigned in the external ERP system. | |
| AmountAccepted_AmountInReportingCurrency | Decimal | ||
| AmountAccepted_ApproxAmountInBaseCurrency | Decimal | ||
| AmountAccepted_Amount | Decimal | ||
| AmountAccepted_ConversionDate | Datetime | ||
| AmountAccepted_Currency_UniqueName | String | ||
| LineItems | String | ||
| OrderConfirmationStatusString | String | The status of the order confirmation associated with a purchase order. | |
| ChangedBy_UniqueName | String | ||
| OrderedState | String | The status of an order. This field can contain one of the following values: Ordering, Ordered, Canceled, Ordered with Errors or Unordered. | |
| ApprovedDate | Datetime | The date when a purchase order is fully approved. | |
| PreviousApprovalRequestsVersion | Int | The version number for the previous version of the approval request. This field is used for internal purpose only. | |
| ResubmitDate | Datetime | The date when a purchase order is resubmitted for approval. A purchase order is considered as resubmitted if a user edits a denied purchase order and resubmits it for approval. Note: Purchase orders that are withdrawn by the preparer and submitted again are not considered as resubmitted purchase orders. | |
| NumberCleared | Decimal | The number of invoiced items on an order that have been cleared after invoices are reconciled. | |
| OrderMethodCategory | String | The ordering method configured for a customer site. This field contains one of the following values: Direct, PCard, or ERP. | |
| RejectionReason | String | The reason provided by a supplier on Ariba Network while rejecting an order. | |
| Active | Bool | Indicates whether a purchase order is currently in use in the buying solution. This field can contain the values as True or False. False indicates inactive purchase orders. Inactive purchase orders are considered as those that are deleted and do not appear in search results and purchase order choosers. | |
| ReceivedDate | Datetime | The date when a shipment of an item was last received. | |
| AmountBilled_AmountInReportingCurrency | Decimal | ||
| AmountBilled_ApproxAmountInBaseCurrency | Decimal | ||
| AmountBilled_Amount | Decimal | ||
| AmountBilled_ConversionDate | Datetime | ||
| AmountBilled_Currency_UniqueName | String | ||
| NextVersion | String | ||
| NumberBilled | Decimal | The total number of invoiced items on an order. | |
| UniqueName | String | The unique ID of a purchase order. Example: PO456. | |
| ReportingCurrency_UniqueName | String | ||
| OrderedDate | Datetime | The date when an order is sent to the supplier. | |
| ManuallyOrdered | Bool | Indicates whether an order needs to be processed manually. | |
| IsFromExternalReq | Bool | Indicates whether an order originated from Fieldglass. Fieldglass orders are not included in order choosers when users select orders to create PO-based invoices. | |
| MasterAgreement_UniqueName | String | ||
| AmountCleared_AmountInReportingCurrency | Decimal | ||
| AmountCleared_ApproxAmountInBaseCurrency | Decimal | ||
| AmountCleared_Amount | Decimal | ||
| AmountCleared_ConversionDate | Datetime | ||
| AmountCleared_Currency_UniqueName | String | ||
| OriginatingSystem | String | The external system from which a order is imported. This field contains the value Imported if the ID of the external system is not available. | |
| PaymentTerms_UniqueName | String | ||
| NumberReceivableLineItems | Int | The number of line items on a purchase order that are not fully received. | |
| Attachments | String | ||
| AmountReconciled_AmountInReportingCurrency | Decimal | ||
| AmountReconciled_ApproxAmountInBaseCurrency | Decimal | ||
| AmountReconciled_Amount | Decimal | ||
| AmountReconciled_ConversionDate | Datetime | ||
| AmountReconciled_Currency_UniqueName | String | ||
| Supplier_UniqueName | String | ||
| Supplier_Name | String | ||
| AmountRejected_AmountInReportingCurrency | Decimal | ||
| AmountRejected_ApproxAmountInBaseCurrency | Decimal | ||
| AmountRejected_Amount | Decimal | ||
| AmountRejected_ConversionDate | Datetime | ||
| AmountRejected_Currency_UniqueName | String | ||
| StatusString | String | The status of a purchase order. Example: Ordering or Ordered. | |
| PreOrdered | Bool | Indicates whether a purchasing card order originated from the buying solution and not an external system. | |
| IsBlanketOrder | Bool | Indicates whether an order is a blanket purchase order. | |
| PreviousVersion | String | ||
| ApprovalRequestsVersion | Int | The version of an approval request when it was generated. This field is used for internal purpose only. | |
| AmountInvoiced_AmountInReportingCurrency | Decimal | ||
| AmountInvoiced_ApproxAmountInBaseCurrency | Decimal | ||
| AmountInvoiced_Amount | Decimal | ||
| AmountInvoiced_ConversionDate | Datetime | ||
| AmountInvoiced_Currency_UniqueName | String | ||
| TimeUpdated | Datetime | The time when a purchase order was last updated. | |
| OriginatingSystemReferenceID | String | The external system ID of an order associated with an imported requisition. | |
| VersionNumber | Int | The version number of an order. | |
| Type | String | The internal name for the approvable document. For example, the internal name for purchase order is ariba.purchasing.core.PurchaseOrder. | |
| ExpirationDate | Datetime | The expiration date of a purchase order. | |
| Closed | String | Indicates whether an order is closed for invoicing. This field can contain one of these values: 1 - The purchase order is in an Open state, 2 - The purchase order is closed for change, 3 - The purchase order is closed for receiving, 4 - The purchase order is closed for invoicing, 5 - The purchase order is closed for all actions, 6 - The purchase order is adjusted and closed for receiving, 7 - The purchase order is closed for receiving and invoicing, or -1 - The purchase order is closed for various actions. | |
| IsServiceOrder | Bool | Indicates whether a purchase order is a service purchase order. Note: Service purchase orders are orders consisting of service items that follow the service sheet process. | |
| Requisition_UniqueName | String | ||
| Preparer_UniqueName | String | The user who creates a requisition and submits it for approval. | |
| CompanyCode_UniqueName | String | The unique name for the SAP company code. | |
| IncludeInactive | Bool | By default, API responses do not include inactive transactions. You can set this query parameter to true to include inactive transactions in the responses. | |
| updatedDateFrom | Datetime | This filter corresponds to the 'TimeUpdated' field. The operation is '>' and the default value is '2018-03-01T23:59:59Z'. | |
| updatedDateTo | Datetime | This filter corresponds to the 'TimeUpdated' field. The operation is '<=' and the default value is '2018-03-29T23:59:59Z'. |
A 'system vsap' view template that queries 'InvoiceReconciliation' transaction data.
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.
SELECT * FROM InvoiceReconcilationSAPcreatedRange WHERE createdDateFrom='2024-01-01 00:00:00.0' AND createdDateTo='2024-02-01 00:00:00.0'
SELECT * FROM InvoiceReconcilationSAPcreatedRange WHERE IncludeInactive='True'
| Name | Type | References | Description |
| RejectedDate | Datetime | The date when an invoice reconciliation was rejected. | |
| ApprovedState | String | An integer value representing the current approval state of an invoice reconciliation. This field is used for internal purposes only. Possible numbers for the approvated state are: 1 - Composing, 2 - Submitted, 4 - Approved, 8 - Invalid, 16- Denied. | |
| Invoice_UniqueName | String | ||
| InitialUniqueName | String | The ID of the invoice reconciliation when it was first created. This field is used for internal purposes only. | |
| SubmitDate | Datetime | The date when an invoice reconciliation is successfully submitted for approval. | |
| HoldTillDate | Datetime | The date until which processing of a fully approved invoice reconciliation is withheld. | |
| SupplierLocation_State | String | ||
| SupplierLocation_Phone | String | ||
| SupplierLocation_Country_UniqueName | String | ||
| SupplierLocation_PostalCode | String | ||
| SupplierLocation_City | String | ||
| SupplierLocation_Fax | String | ||
| SupplierLocation_UniqueName | String | ||
| SupplierLocation_Lines | String | ||
| SupplierLocation_Name | String | ||
| Payments | String | ||
| ChargeAmount_AmountInReportingCurrency | Decimal | ||
| ChargeAmount_ApproxAmountInBaseCurrency | Decimal | ||
| ChargeAmount_Amount | Decimal | ||
| ChargeAmount_ConversionDate | Datetime | ||
| ChargeAmount_Currency_UniqueName | String | ||
| CreateDate | Datetime | The date when an invoice reconciliation is created. | |
| Name | String | The title of an invoice reconciliation. | |
| ExternalStatus | String | The status of this invoice reconciliation in the external system. | |
| LastModified | Datetime | The date when an invoice reconciliation was last modified. Actions that lead to updates to the history record of an invoice reconciliation trigger changes to the last modified date. | |
| TimeCreated | Datetime | The time when an invoice reconciliation is created. | |
| PayloadID | String | The ID generated for documents transmitted to Ariba Network. | |
| TaxAmount_AmountInReportingCurrency | Decimal | ||
| TaxAmount_ApproxAmountInBaseCurrency | Decimal | ||
| TaxAmount_Amount | Decimal | ||
| TaxAmount_ConversionDate | Datetime | ||
| TaxAmount_Currency_UniqueName | String | ||
| Requester_UniqueName | String | The user on behalf of whom a requisition is created. Typically, the preparer and requester of a requisition are the same user. If a preparer creates a requisition for someone else, the requester is the user for whom the requisition is created. | |
| TaxDetails | String | ||
| PaidAmounts_AdjustmentAmount_Reason | String | ||
| PaidAmounts_AdjustmentAmount_Amount_AmountInReportingCurrency | Decimal | ||
| PaidAmounts_AdjustmentAmount_Amount_ApproxAmountInBaseCurrency | Decimal | ||
| PaidAmounts_AdjustmentAmount_Amount_Amount | Decimal | ||
| PaidAmounts_AdjustmentAmount_Amount_ConversionDate | Datetime | ||
| PaidAmounts_AdjustmentAmount_Amount_Currency_UniqueName | String | ||
| PaidAmounts_GrossAmount_AmountInReportingCurrency | Decimal | ||
| PaidAmounts_GrossAmount_ApproxAmountInBaseCurrency | Decimal | ||
| PaidAmounts_GrossAmount_Amount | Decimal | ||
| PaidAmounts_GrossAmount_ConversionDate | Datetime | ||
| PaidAmounts_GrossAmount_Currency_UniqueName | String | ||
| PaidAmounts_DiscountAmount_AmountInReportingCurrency | Decimal | ||
| PaidAmounts_DiscountAmount_ApproxAmountInBaseCurrency | Decimal | ||
| PaidAmounts_DiscountAmount_Amount | Decimal | ||
| PaidAmounts_DiscountAmount_ConversionDate | Datetime | ||
| PaidAmounts_DiscountAmount_Currency_UniqueName | String | ||
| PaidAmounts_NetAmount_AmountInReportingCurrency | Decimal | ||
| PaidAmounts_NetAmount_ApproxAmountInBaseCurrency | Decimal | ||
| PaidAmounts_NetAmount_Amount | Decimal | ||
| PaidAmounts_NetAmount_ConversionDate | Datetime | ||
| PaidAmounts_NetAmount_Currency_UniqueName | String | ||
| VATAmount_AmountInReportingCurrency | Decimal | ||
| VATAmount_ApproxAmountInBaseCurrency | Decimal | ||
| VATAmount_Amount | Decimal | ||
| VATAmount_ConversionDate | Datetime | ||
| VATAmount_Currency_UniqueName | String | ||
| LineItems | String | ||
| ChangedBy_UniqueName | String | ||
| ApprovedDate | Datetime | The date when an invoice reconciliation is fully approved. | |
| TotalWithholdingTax_AmountInReportingCurrency | Decimal | ||
| TotalWithholdingTax_ApproxAmountInBaseCurrency | Decimal | ||
| TotalWithholdingTax_Amount | Decimal | ||
| TotalWithholdingTax_ConversionDate | Datetime | ||
| TotalWithholdingTax_Currency_UniqueName | String | ||
| ScheduledPaymentDate | Datetime | The scheduled payment date for a reconciled invoice. | |
| PreviousApprovalRequestsVersion | Int | The version number for the previous version of the approval request. This field is used for internal purposes only. | |
| ResubmitDate | Datetime | The date when an invoice is resubmitted for approval. An invoice is considered as resubmitted if a user edits a denied invoice and resubmits it for approval. Note: Invoices that are withdrawn by the preparer and submitted again are not considered as resubmitted invoices. | |
| EligibleForDynamicDiscount | Bool | A flag used by Buyers to indicate if the supplier can ask for immediate remittance of this invoice reconciliation to get dynamic discounts. | |
| NumberCleared | Decimal | The number of invoiced items that have been cleared after an invoice reconciliation is reconciled. | |
| MaxDiscountApplicable_AmountInReportingCurrency | Decimal | ||
| MaxDiscountApplicable_ApproxAmountInBaseCurrency | Decimal | ||
| MaxDiscountApplicable_Amount | Decimal | ||
| MaxDiscountApplicable_ConversionDate | Datetime | ||
| MaxDiscountApplicable_Currency_UniqueName | String | ||
| DiscountAmount_AmountInReportingCurrency | Decimal | ||
| DiscountAmount_ApproxAmountInBaseCurrency | Decimal | ||
| DiscountAmount_Amount | Decimal | ||
| DiscountAmount_ConversionDate | Datetime | ||
| DiscountAmount_Currency_UniqueName | String | ||
| ServicePeriod | String | ||
| ApprovalRequests | String | ||
| Active | Bool | Indicates whether the invoice reconciliation is currently in use in the buying solution. This field can contain the values as True or False. False indicates inactive invoice reconciliations. Inactive invoice reconciliations are considered as those that are deleted and do not appear in search results and invoice reconciliation choosers. | |
| ProcurementUnit_UniqueName | String | ||
| AmountBilled_AmountInReportingCurrency | Decimal | ||
| AmountBilled_ApproxAmountInBaseCurrency | Decimal | ||
| AmountBilled_Amount | Decimal | ||
| AmountBilled_ConversionDate | Datetime | ||
| AmountBilled_Currency_UniqueName | String | ||
| NextVersion | String | ||
| NumberBilled | Decimal | The total number of invoiced items. | |
| UniqueName | String | The unique identifier for an invoice reconciliation in the system. | |
| TotalInvoiced_AmountInReportingCurrency | Decimal | ||
| TotalInvoiced_ApproxAmountInBaseCurrency | Decimal | ||
| TotalInvoiced_Amount | Decimal | ||
| TotalInvoiced_ConversionDate | Datetime | ||
| TotalInvoiced_Currency_UniqueName | String | ||
| ProcessedState | String | The current payment processing state for an invoice reconciliation after it has been reconciled. The following are the possible values for the processing state for an invoice reconciliation: - Unprocessed: The invoice reconciliation has not been processed for payment. - Rejected: The invoice reconciliation has been rejected by an approver. - Paying: The invoice reconciliation has been approved and payment is being processed. - Paid: The invoice reconciliation has been approved and invoiced amounts have been paid. - FailedPaying: The invoice reconciliation has been approved but payment for the invoiced amount has failed. | |
| AmountCleared_AmountInReportingCurrency | Decimal | ||
| AmountCleared_ApproxAmountInBaseCurrency | Decimal | ||
| AmountCleared_Amount | Decimal | ||
| AmountCleared_ConversionDate | Datetime | ||
| AmountCleared_Currency_UniqueName | String | ||
| ProjectID | String | The ID of a project. | |
| Attachments | String | ||
| SourcingStatusString | String | The status of a sourcing transaction in the sourcing solution. This field contains cXML updates received from the sourcing solution. | |
| PaymentModel | Int | The payment model used for a payment request associated with an invoice reconciliation document. This field can contain one of the following values: -1 – Default, 0 - ExternalPay, 1 – LocalPay, or 2 - AribaNetworkPay. | |
| RemittanceLocation_UniqueName | String | ||
| PaidDate | Datetime | The date when payment for a reconciled invoice was made. | |
| ServiceLocation_State | String | ||
| ServiceLocation_Phone | String | ||
| ServiceLocation_Country_UniqueName | String | ||
| ServiceLocation_PostalCode | String | ||
| ServiceLocation_City | String | ||
| ServiceLocation_Fax | String | ||
| ServiceLocation_UniqueName | String | ||
| ServiceLocation_Lines | String | ||
| ServiceLocation_Name | String | ||
| Exceptions | String | ||
| Supplier_UniqueName | String | ||
| Supplier_Name | String | ||
| InvoiceDate | Datetime | The date when the invoice associated with an invoice reconciliation is created. | |
| StatusString | String | The current status of an invoice reconciliation. Example: Approved or Reconciled. | |
| PreviousVersion | String | ||
| ApprovalRequestsVersion | Int | The version of an approval request when it was generated. This field is used for internal purposes only. | |
| TimeUpdated | Datetime | The time when an invoice reconciliation was last updated. | |
| VersionNumber | Int | The internal version number assigned to an approvable document. This field is used for optimistic locking and ensures that changes to the document are followed in an appropriate sequence. This field is used for internal purposes only. | |
| TaxAccrualAmount_AmountInReportingCurrency | Decimal | ||
| TaxAccrualAmount_ApproxAmountInBaseCurrency | Decimal | ||
| TaxAccrualAmount_Amount | Decimal | ||
| TaxAccrualAmount_ConversionDate | Datetime | ||
| TaxAccrualAmount_Currency_UniqueName | String | ||
| Type | String | The internal name for the approvable document. For example, the internal name for an invoice reconciliation is ariba.invoicing.core.InvoiceReconciliation. | |
| ProjectTitle | String | The title of a project. | |
| IsAccruedOnIR | Bool | A flag that indicates if the amounts are accrued in an invoice reconciliation. Only NonPO Invoice's will have accrued amounts. | |
| Preparer_UniqueName | String | The user who creates a requisition and submits it for approval. | |
| IncludeInactive | Bool | By default, API responses do not include inactive transactions. You can set this query parameter to true to include inactive transactions in the responses. | |
| createdDateFrom | Datetime | This filter corresponds to the 'TimeCreated' field. The operation is '>' and the default value is '2018-03-01T23:59:59Z'. | |
| createdDateTo | Datetime | This filter corresponds to the 'TimeCreated' field. The operation is '<=' and the default value is '2018-03-29T23:59:59Z'. |
A 'system vsap' view template that queries 'InvoiceReconciliation' transaction data.
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.
SELECT * FROM InvoiceReconcilationSAPupdatedRange WHERE updatedDateFrom='2024-01-01 00:00:00.0' AND updatedDateTo='2024-02-01 00:00:00.0'
SELECT * FROM InvoiceReconcilationSAPupdatedRange WHERE IncludeInactive='True'
| Name | Type | References | Description |
| RejectedDate | Datetime | The date when an invoice reconciliation was rejected. | |
| ApprovedState | String | An integer value representing the current approval state of an invoice reconciliation. This field is used for internal purposes only. Possible numbers for the approvated state are: 1 - Composing, 2 - Submitted, 4 - Approved, 8 - Invalid, 16- Denied. | |
| Invoice_UniqueName | String | ||
| InitialUniqueName | String | The ID of the invoice reconciliation when it was first created. This field is used for internal purposes only. | |
| SubmitDate | Datetime | The date when an invoice reconciliation is successfully submitted for approval. | |
| HoldTillDate | Datetime | The date until which processing of a fully approved invoice reconciliation is withheld. | |
| SupplierLocation_State | String | ||
| SupplierLocation_Phone | String | ||
| SupplierLocation_Country_UniqueName | String | ||
| SupplierLocation_PostalCode | String | ||
| SupplierLocation_City | String | ||
| SupplierLocation_Fax | String | ||
| SupplierLocation_UniqueName | String | ||
| SupplierLocation_Lines | String | ||
| SupplierLocation_Name | String | ||
| Payments | String | ||
| ChargeAmount_AmountInReportingCurrency | Decimal | ||
| ChargeAmount_ApproxAmountInBaseCurrency | Decimal | ||
| ChargeAmount_Amount | Decimal | ||
| ChargeAmount_ConversionDate | Datetime | ||
| ChargeAmount_Currency_UniqueName | String | ||
| CreateDate | Datetime | The date when an invoice reconciliation is created. | |
| Name | String | The title of an invoice reconciliation. | |
| ExternalStatus | String | The status of this invoice reconciliation in the external system. | |
| LastModified | Datetime | The date when an invoice reconciliation was last modified. Actions that lead to updates to the history record of an invoice reconciliation trigger changes to the last modified date. | |
| TimeCreated | Datetime | The time when an invoice reconciliation is created. | |
| PayloadID | String | The ID generated for documents transmitted to Ariba Network. | |
| TaxAmount_AmountInReportingCurrency | Decimal | ||
| TaxAmount_ApproxAmountInBaseCurrency | Decimal | ||
| TaxAmount_Amount | Decimal | ||
| TaxAmount_ConversionDate | Datetime | ||
| TaxAmount_Currency_UniqueName | String | ||
| Requester_UniqueName | String | The user on behalf of whom a requisition is created. Typically, the preparer and requester of a requisition are the same user. If a preparer creates a requisition for someone else, the requester is the user for whom the requisition is created. | |
| TaxDetails | String | ||
| PaidAmounts_AdjustmentAmount_Reason | String | ||
| PaidAmounts_AdjustmentAmount_Amount_AmountInReportingCurrency | Decimal | ||
| PaidAmounts_AdjustmentAmount_Amount_ApproxAmountInBaseCurrency | Decimal | ||
| PaidAmounts_AdjustmentAmount_Amount_Amount | Decimal | ||
| PaidAmounts_AdjustmentAmount_Amount_ConversionDate | Datetime | ||
| PaidAmounts_AdjustmentAmount_Amount_Currency_UniqueName | String | ||
| PaidAmounts_GrossAmount_AmountInReportingCurrency | Decimal | ||
| PaidAmounts_GrossAmount_ApproxAmountInBaseCurrency | Decimal | ||
| PaidAmounts_GrossAmount_Amount | Decimal | ||
| PaidAmounts_GrossAmount_ConversionDate | Datetime | ||
| PaidAmounts_GrossAmount_Currency_UniqueName | String | ||
| PaidAmounts_DiscountAmount_AmountInReportingCurrency | Decimal | ||
| PaidAmounts_DiscountAmount_ApproxAmountInBaseCurrency | Decimal | ||
| PaidAmounts_DiscountAmount_Amount | Decimal | ||
| PaidAmounts_DiscountAmount_ConversionDate | Datetime | ||
| PaidAmounts_DiscountAmount_Currency_UniqueName | String | ||
| PaidAmounts_NetAmount_AmountInReportingCurrency | Decimal | ||
| PaidAmounts_NetAmount_ApproxAmountInBaseCurrency | Decimal | ||
| PaidAmounts_NetAmount_Amount | Decimal | ||
| PaidAmounts_NetAmount_ConversionDate | Datetime | ||
| PaidAmounts_NetAmount_Currency_UniqueName | String | ||
| VATAmount_AmountInReportingCurrency | Decimal | ||
| VATAmount_ApproxAmountInBaseCurrency | Decimal | ||
| VATAmount_Amount | Decimal | ||
| VATAmount_ConversionDate | Datetime | ||
| VATAmount_Currency_UniqueName | String | ||
| LineItems | String | ||
| ChangedBy_UniqueName | String | ||
| ApprovedDate | Datetime | The date when an invoice reconciliation is fully approved. | |
| TotalWithholdingTax_AmountInReportingCurrency | Decimal | ||
| TotalWithholdingTax_ApproxAmountInBaseCurrency | Decimal | ||
| TotalWithholdingTax_Amount | Decimal | ||
| TotalWithholdingTax_ConversionDate | Datetime | ||
| TotalWithholdingTax_Currency_UniqueName | String | ||
| ScheduledPaymentDate | Datetime | The scheduled payment date for a reconciled invoice. | |
| PreviousApprovalRequestsVersion | Int | The version number for the previous version of the approval request. This field is used for internal purposes only. | |
| ResubmitDate | Datetime | The date when an invoice is resubmitted for approval. An invoice is considered as resubmitted if a user edits a denied invoice and resubmits it for approval. Note: Invoices that are withdrawn by the preparer and submitted again are not considered as resubmitted invoices. | |
| EligibleForDynamicDiscount | Bool | A flag used by Buyers to indicate if the supplier can ask for immediate remittance of this invoice reconciliation to get dynamic discounts. | |
| NumberCleared | Decimal | The number of invoiced items that have been cleared after an invoice reconciliation is reconciled. | |
| MaxDiscountApplicable_AmountInReportingCurrency | Decimal | ||
| MaxDiscountApplicable_ApproxAmountInBaseCurrency | Decimal | ||
| MaxDiscountApplicable_Amount | Decimal | ||
| MaxDiscountApplicable_ConversionDate | Datetime | ||
| MaxDiscountApplicable_Currency_UniqueName | String | ||
| DiscountAmount_AmountInReportingCurrency | Decimal | ||
| DiscountAmount_ApproxAmountInBaseCurrency | Decimal | ||
| DiscountAmount_Amount | Decimal | ||
| DiscountAmount_ConversionDate | Datetime | ||
| DiscountAmount_Currency_UniqueName | String | ||
| ServicePeriod | String | ||
| ApprovalRequests | String | ||
| Active | Bool | Indicates whether the invoice reconciliation is currently in use in the buying solution. This field can contain the values as True or False. False indicates inactive invoice reconciliations. Inactive invoice reconciliations are considered as those that are deleted and do not appear in search results and invoice reconciliation choosers. | |
| ProcurementUnit_UniqueName | String | ||
| AmountBilled_AmountInReportingCurrency | Decimal | ||
| AmountBilled_ApproxAmountInBaseCurrency | Decimal | ||
| AmountBilled_Amount | Decimal | ||
| AmountBilled_ConversionDate | Datetime | ||
| AmountBilled_Currency_UniqueName | String | ||
| NextVersion | String | ||
| NumberBilled | Decimal | The total number of invoiced items. | |
| UniqueName | String | The unique identifier for an invoice reconciliation in the system. | |
| TotalInvoiced_AmountInReportingCurrency | Decimal | ||
| TotalInvoiced_ApproxAmountInBaseCurrency | Decimal | ||
| TotalInvoiced_Amount | Decimal | ||
| TotalInvoiced_ConversionDate | Datetime | ||
| TotalInvoiced_Currency_UniqueName | String | ||
| ProcessedState | String | The current payment processing state for an invoice reconciliation after it has been reconciled. The following are the possible values for the processing state for an invoice reconciliation: - Unprocessed: The invoice reconciliation has not been processed for payment. - Rejected: The invoice reconciliation has been rejected by an approver. - Paying: The invoice reconciliation has been approved and payment is being processed. - Paid: The invoice reconciliation has been approved and invoiced amounts have been paid. - FailedPaying: The invoice reconciliation has been approved but payment for the invoiced amount has failed. | |
| AmountCleared_AmountInReportingCurrency | Decimal | ||
| AmountCleared_ApproxAmountInBaseCurrency | Decimal | ||
| AmountCleared_Amount | Decimal | ||
| AmountCleared_ConversionDate | Datetime | ||
| AmountCleared_Currency_UniqueName | String | ||
| ProjectID | String | The ID of a project. | |
| Attachments | String | ||
| SourcingStatusString | String | The status of a sourcing transaction in the sourcing solution. This field contains cXML updates received from the sourcing solution. | |
| PaymentModel | Int | The payment model used for a payment request associated with an invoice reconciliation document. This field can contain one of the following values: -1 – Default, 0 - ExternalPay, 1 – LocalPay, or 2 - AribaNetworkPay. | |
| RemittanceLocation_UniqueName | String | ||
| PaidDate | Datetime | The date when payment for a reconciled invoice was made. | |
| ServiceLocation_State | String | ||
| ServiceLocation_Phone | String | ||
| ServiceLocation_Country_UniqueName | String | ||
| ServiceLocation_PostalCode | String | ||
| ServiceLocation_City | String | ||
| ServiceLocation_Fax | String | ||
| ServiceLocation_UniqueName | String | ||
| ServiceLocation_Lines | String | ||
| ServiceLocation_Name | String | ||
| Exceptions | String | ||
| Supplier_UniqueName | String | ||
| Supplier_Name | String | ||
| InvoiceDate | Datetime | The date when the invoice associated with an invoice reconciliation is created. | |
| StatusString | String | The current status of an invoice reconciliation. Example: Approved or Reconciled. | |
| PreviousVersion | String | ||
| ApprovalRequestsVersion | Int | The version of an approval request when it was generated. This field is used for internal purposes only. | |
| TimeUpdated | Datetime | The time when an invoice reconciliation was last updated. | |
| VersionNumber | Int | The internal version number assigned to an approvable document. This field is used for optimistic locking and ensures that changes to the document are followed in an appropriate sequence. This field is used for internal purposes only. | |
| TaxAccrualAmount_AmountInReportingCurrency | Decimal | ||
| TaxAccrualAmount_ApproxAmountInBaseCurrency | Decimal | ||
| TaxAccrualAmount_Amount | Decimal | ||
| TaxAccrualAmount_ConversionDate | Datetime | ||
| TaxAccrualAmount_Currency_UniqueName | String | ||
| Type | String | The internal name for the approvable document. For example, the internal name for an invoice reconciliation is ariba.invoicing.core.InvoiceReconciliation. | |
| ProjectTitle | String | The title of a project. | |
| IsAccruedOnIR | Bool | A flag that indicates if the amounts are accrued in an invoice reconciliation. Only NonPO Invoice's will have accrued amounts. | |
| Preparer_UniqueName | String | The user who creates a requisition and submits it for approval. | |
| IncludeInactive | Bool | By default, API responses do not include inactive transactions. You can set this query parameter to true to include inactive transactions in the responses. | |
| updatedDateFrom | Datetime | This filter corresponds to the 'TimeUpdated' field. The operation is '>' and the default value is '2018-03-01T23:59:59Z'. | |
| updatedDateTo | Datetime | This filter corresponds to the 'TimeUpdated' field. The operation is '<=' and the default value is '2018-03-29T23:59:59Z'. |
A 'system vsap' view template that queries 'Receipt' transaction data.
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.
SELECT * FROM ReceiptSAPcreatedRange WHERE createdDateFrom='2024-01-01 00:00:00.0' AND createdDateTo='2024-02-01 00:00:00.0'
SELECT * FROM ReceiptSAPcreatedRange WHERE IncludeInactive='True'
| Name | Type | References | Description |
| ApprovedState | String | An integer value that represents the current approval state of a receipt. This field is used for internal purpose only. | |
| ReceiptItems | String | ||
| ProcessedState | String | The post-approval processing state of a receipt. The post-approval processing states can be one of the following for receipts imported from external systems: 0 - Unprocessed, 1 – Awaiting Processing, 2 – Processing, 3 – Failed Processing, or 4 - Processed. Note: Receipts created in the buying solution move to the Processed state after they are fully approved. | |
| MasterAgreement_UniqueName | String | ||
| InitialUniqueName | String | The ID of the receipt when it was first created. This field is used for internal purpose only. | |
| SubmitDate | Datetime | The date when a receipt was successfully submitted for approval. | |
| HoldTillDate | Datetime | The date until which post-approval processing of the associated requisition was withheld. | |
| CreateDate | Datetime | The date when a receipt was created. | |
| Attachments | String | ||
| IsReceiptPushFailed | Bool | Indicates whether a receipt failed to be pushed to the external ERP system. | |
| Name | String | The title of the receipt. | |
| IsInTransitionToManual | Bool | Indicates the transition stage of a receipt in which line items configured for auto-receiving transition from automatic receiving to the manual receiving state. This field is set to true when a user creates manual receipts for line items that are configured for automatic receiving. | |
| LastModified | Datetime | The date when a receipt was last modified. Actions that lead to updates to the history record or the comments section of a receipt trigger changes to the last modified date. | |
| TimeCreated | Datetime | The time when a receipt was created. | |
| GoodsReturnTrackingNumber | String | The goods return tracking number to identify items returned to suppliers. | |
| Requester_UniqueName | String | The user on behalf of whom a requisition is created. Typically, the preparer and requester of a requisition are the same user. If a preparer creates a requisition for someone else, the requester is the user for whom the requisition is created. | |
| CloseOrder | Bool | Indicates whether the buying solution automatically closes an order for further receiving after the associated receipts are fully approved. | |
| ERPReceiptNumber | String | The ID assigned to a receipt imported from the external ERP system. | |
| DueDate | Datetime | The due date for creation of an automatic receipt. | |
| Order_UniqueName | String | ||
| StatusString | String | The approval state of a receipt. Example: Composing, Submitted, or Approved. | |
| ChangedBy_UniqueName | String | ||
| ApprovedDate | Datetime | The date when the status of a receipt changed to Approved. | |
| PreviousApprovalRequestsVersion | Int | The version number for the previous version of the approval request. This field is used for internal purpose only. | |
| RecentReceiveDate | Datetime | The most recent date when a receipt transaction was performed for a line item. | |
| PreviousVersion | String | ||
| ResubmitDate | Datetime | The date when a receipt was resubmitted for approval. A receipt is considered as resubmitted when a user edits a denied receipt and resubmits it for approval. Note: Receipts that are withdrawn by the preparer and submitted again are not considered as resubmitted receipts. | |
| ApprovalRequestsVersion | Int | The version of an approval request when it was generated. This field is used for internal purpose only. | |
| TimeUpdated | Datetime | The time when a receipt was last updated. | |
| VersionNumber | Int | Indicates whether the changes for the receipt version are internal to the buying solution. | |
| ApprovalRequests | String | ||
| Active | Bool | Indicates whether a receipt is currently in use in the buying solution. This field can contain the values as True or False. False indicates inactive receipts. Inactive receipts are considered as those that are deleted and do not appear in search results and receipt choosers. | |
| IsImported | Bool | Indicates whether a receipt is imported from an external system | |
| Type | String | The internal name for the approvable document. For example, the internal name for receipt is ariba.receiving.core.Receipt. | |
| ANSentState | String | The state of transmission of a receipt to Ariba Network. This field can contain one of the following values: Sent (2), Sending (4), or Failed (8). | |
| ProcurementUnit_UniqueName | String | ||
| NextVersion | String | ||
| IsUnitPriceChanged | Bool | Indicates whether the unit price of a line item on a receipt was edited. | |
| UniqueName | String | The unique ID of a receipt. Example: RC678. | |
| Preparer_UniqueName | String | The user who creates a requisition and submits it for approval. | |
| IncludeInactive | Bool | By default, API responses do not include inactive transactions. You can set this query parameter to true to include inactive transactions in the responses. | |
| createdDateFrom | Datetime | This filter corresponds to the 'TimeCreated' field. The operation is '>' and the default value is '2018-03-01T23:59:59Z'. | |
| createdDateTo | Datetime | This filter corresponds to the 'TimeCreated' field. The operation is '<=' and the default value is '2018-03-29T23:59:59Z'. |
A 'system vsap' view template that queries 'Receipt' transaction data.
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.
SELECT * FROM ReceiptSAPupdatedRange WHERE updatedDateFrom='2024-01-01 00:00:00.0' AND updatedDateTo='2024-02-01 00:00:00.0'
SELECT * FROM ReceiptSAPupdatedRange WHERE IncludeInactive='True'
| Name | Type | References | Description |
| ApprovedState | String | An integer value that represents the current approval state of a receipt. This field is used for internal purpose only. | |
| ReceiptItems | String | ||
| ProcessedState | String | The post-approval processing state of a receipt. The post-approval processing states can be one of the following for receipts imported from external systems: 0 - Unprocessed, 1 – Awaiting Processing, 2 – Processing, 3 – Failed Processing, or 4 - Processed. Note: Receipts created in the buying solution move to the Processed state after they are fully approved. | |
| MasterAgreement_UniqueName | String | ||
| InitialUniqueName | String | The ID of the receipt when it was first created. This field is used for internal purpose only. | |
| SubmitDate | Datetime | The date when a receipt was successfully submitted for approval. | |
| HoldTillDate | Datetime | The date until which post-approval processing of the associated requisition was withheld. | |
| CreateDate | Datetime | The date when a receipt was created. | |
| Attachments | String | ||
| IsReceiptPushFailed | Bool | Indicates whether a receipt failed to be pushed to the external ERP system. | |
| Name | String | The title of the receipt. | |
| IsInTransitionToManual | Bool | Indicates the transition stage of a receipt in which line items configured for auto-receiving transition from automatic receiving to the manual receiving state. This field is set to true when a user creates manual receipts for line items that are configured for automatic receiving. | |
| LastModified | Datetime | The date when a receipt was last modified. Actions that lead to updates to the history record or the comments section of a receipt trigger changes to the last modified date. | |
| TimeCreated | Datetime | The time when a receipt was created. | |
| GoodsReturnTrackingNumber | String | The goods return tracking number to identify items returned to suppliers. | |
| Requester_UniqueName | String | The user on behalf of whom a requisition is created. Typically, the preparer and requester of a requisition are the same user. If a preparer creates a requisition for someone else, the requester is the user for whom the requisition is created. | |
| CloseOrder | Bool | Indicates whether the buying solution automatically closes an order for further receiving after the associated receipts are fully approved. | |
| ERPReceiptNumber | String | The ID assigned to a receipt imported from the external ERP system. | |
| DueDate | Datetime | The due date for creation of an automatic receipt. | |
| Order_UniqueName | String | ||
| StatusString | String | The approval state of a receipt. Example: Composing, Submitted, or Approved. | |
| ChangedBy_UniqueName | String | ||
| ApprovedDate | Datetime | The date when the status of a receipt changed to Approved. | |
| PreviousApprovalRequestsVersion | Int | The version number for the previous version of the approval request. This field is used for internal purpose only. | |
| RecentReceiveDate | Datetime | The most recent date when a receipt transaction was performed for a line item. | |
| PreviousVersion | String | ||
| ResubmitDate | Datetime | The date when a receipt was resubmitted for approval. A receipt is considered as resubmitted when a user edits a denied receipt and resubmits it for approval. Note: Receipts that are withdrawn by the preparer and submitted again are not considered as resubmitted receipts. | |
| ApprovalRequestsVersion | Int | The version of an approval request when it was generated. This field is used for internal purpose only. | |
| TimeUpdated | Datetime | The time when a receipt was last updated. | |
| VersionNumber | Int | Indicates whether the changes for the receipt version are internal to the buying solution. | |
| ApprovalRequests | String | ||
| Active | Bool | Indicates whether a receipt is currently in use in the buying solution. This field can contain the values as True or False. False indicates inactive receipts. Inactive receipts are considered as those that are deleted and do not appear in search results and receipt choosers. | |
| IsImported | Bool | Indicates whether a receipt is imported from an external system | |
| Type | String | The internal name for the approvable document. For example, the internal name for receipt is ariba.receiving.core.Receipt. | |
| ANSentState | String | The state of transmission of a receipt to Ariba Network. This field can contain one of the following values: Sent (2), Sending (4), or Failed (8). | |
| ProcurementUnit_UniqueName | String | ||
| NextVersion | String | ||
| IsUnitPriceChanged | Bool | Indicates whether the unit price of a line item on a receipt was edited. | |
| UniqueName | String | The unique ID of a receipt. Example: RC678. | |
| Preparer_UniqueName | String | The user who creates a requisition and submits it for approval. | |
| IncludeInactive | Bool | By default, API responses do not include inactive transactions. You can set this query parameter to true to include inactive transactions in the responses. | |
| updatedDateFrom | Datetime | This filter corresponds to the 'TimeUpdated' field. The operation is '>' and the default value is '2018-03-01T23:59:59Z'. | |
| updatedDateTo | Datetime | This filter corresponds to the 'TimeUpdated' field. The operation is '<=' and the default value is '2018-03-29T23:59:59Z'. |
Get all child elements for a specific view template.
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.
SELECT * FROM ViewChildElements WHERE ViewTemplateName='Requisition_SAP_createdRange_v2'
| Name | Type | References | Description |
| ViewTemplateName [KEY] | String | The name of the view. | |
| ChildElement [KEY] | String | A child element/array of documents in the view template in dot notation. | |
| Description | String | A description of the child element. |
Request a list of all supported document types or a list of all filter and selection fields, either for a single document type or for all document types, that can be used to create custom view templates.
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.
SELECT * FROM ViewFields WHERE ViewTemplateName='Contract_SAP_createdRange_v1'
SELECT * FROM ViewFields WHERE DocumentType='DirectOrder'
| Name | Type | References | Description |
| ViewTemplateName | String | Supported document type. | |
| DocumentType | String | Supported document type. | |
| Name | String | The name of the field. | |
| FieldName | String | The field's formatted name. | |
| Description | String | The field's description. | |
| Type | String | The type of the field. | |
| Size | Int | The maximum length in characters if this is a string field. | |
| AllowedValues | String | Permissible values if this field accepts only specific values. | |
| IsCustomField | Bool | Whether this field is a custom field. | |
| Precision | String | The field's precision. | |
| Scale | String | The field's scale. | |
| Source | String | The field's JSON repeat path source. |
| プロパティ | 説明 |
| ANID | SAP Ariba Network ID を指定。 |
| API | provider にSAP Ariba データを取得させたいAPI を指定。 |
| APIKey | 使用するOAuth アプリケーションキー。 |
| AuthScheme | SAP Ariba に接続する際に使用する認証の種類に設定。 |
| Environment | SAP Ariba への接続に使用する環境。 |
| DataCenter | アカウントのデータがホストされているデータセンター。 |
| Realm | データにアクセスするレルムを指定。 |
| プロパティ | 説明 |
| OAuthClientId | カスタムOAuth アプリケーションの作成時に割り当てられたクライアントId を指定します。(コンシューマーキーとも呼ばれます。)このID は、カスタムアプリケーションをOAuth 認可サーバーに登録します。 |
| OAuthClientSecret | カスタムOAuth アプリケーションの作成時に割り当てられたクライアントシークレットを指定します。( コンシューマーシークレット とも呼ばれます。)このシークレットは、カスタムアプリケーションをOAuth 認可サーバーに登録します。 |
| プロパティ | 説明 |
| SSLServerCert | TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。 |
| プロパティ | 説明 |
| FirewallType | provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。 |
| FirewallServer | ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。 |
| FirewallPort | プロキシベースのファイアウォールで使用するTCP ポートを指定します。 |
| FirewallUser | プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。 |
| FirewallPassword | プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。 |
| プロパティ | 説明 |
| ProxyAutoDetect | provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。 |
| ProxyServer | HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。 |
| ProxyPort | クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバー(ProxyServer 接続プロパティで設定)のTCP ポート。 |
| ProxyAuthScheme | ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。 |
| ProxyUser | ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名。 |
| ProxyPassword | ProxyUser 接続プロパティで指定されたユーザーに紐付けられたパスワード。 |
| ProxySSLType | ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプ。 |
| ProxyExceptions | ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。 |
| プロパティ | 説明 |
| LogModules | ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。 |
| プロパティ | 説明 |
| Location | テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。 |
| BrowsableSchemas | レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
| Tables | レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。 |
| Views | レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。 |
| プロパティ | 説明 |
| IncludeCustomFields | Determines whether the provider exposes custom fields in SAP Ariba tables as columns. |
| MaxRows | 集計やGROUP BY を使用しないクエリで返される最大行数を指定します。 |
| MaxThreads | Specifies the maximum number of concurrent requests the provider can execute to SAP Ariba. |
| Other | 特定のユースケースに対して追加の隠しプロパティを指定します。これらは通常のprovider の機能では必要ありません。複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。 |
| Pagesize | SAP Ariba から返される、1ページあたりの結果の最大数を指定します。この設定は、ほとんどのユースケースに最適化されている、データソースによって設定されたデフォルトのページサイズをオーバーライドします。 |
| PseudoColumns | テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。 |
| Timeout | provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。 |
| UserDefinedViews | カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。 |
このセクションでは、本プロバイダーの接続文字列で設定可能なAuthentication プロパティの全リストを提供します。
| プロパティ | 説明 |
| ANID | SAP Ariba Network ID を指定。 |
| API | provider にSAP Ariba データを取得させたいAPI を指定。 |
| APIKey | 使用するOAuth アプリケーションキー。 |
| AuthScheme | SAP Ariba に接続する際に使用する認証の種類に設定。 |
| Environment | SAP Ariba への接続に使用する環境。 |
| DataCenter | アカウントのデータがホストされているデータセンター。 |
| Realm | データにアクセスするレルムを指定。 |
SAP Ariba Network ID を指定。
バイヤーとしてのID を見つけるには: https://support.ariba.com/item/view/187831
サプライヤーとしてのID を見つけるには: https://support.ariba.com/item/view/KB0392438
provider にSAP Ariba データを取得させたいAPI を指定。
Sync App にSAP Ariba データを取得させたいAPI を指定。
使用するOAuth アプリケーションキー。
SAP Ariba OAuth アプリケーションキーは、OAuth アプリケーションが最初に作成されたときに生成されます。詳しくは、カスタムOAuth アプリの作成 を参照してください。
SAP Ariba に接続する際に使用する認証の種類に設定。
SAP Ariba への接続に使用する環境。
PRODUCTION 環境は実際のデータを返し、アプリケーションに関連付けられます。
TEST 環境はモックデータを返し、アプリケーションに関連付けられます。
アカウントのデータがホストされているデータセンター。
アカウントのデータがホストされているデータセンター。
データにアクセスするレルムを指定。
データにアクセスするレルムを指定。
このセクションでは、本プロバイダーの接続文字列で設定可能なOAuth プロパティの全リストを提供します。
| プロパティ | 説明 |
| OAuthClientId | カスタムOAuth アプリケーションの作成時に割り当てられたクライアントId を指定します。(コンシューマーキーとも呼ばれます。)このID は、カスタムアプリケーションをOAuth 認可サーバーに登録します。 |
| OAuthClientSecret | カスタムOAuth アプリケーションの作成時に割り当てられたクライアントシークレットを指定します。( コンシューマーシークレット とも呼ばれます。)このシークレットは、カスタムアプリケーションをOAuth 認可サーバーに登録します。 |
カスタムOAuth アプリケーションの作成時に割り当てられたクライアントId を指定します。(コンシューマーキーとも呼ばれます。)このID は、カスタムアプリケーションをOAuth 認可サーバーに登録します。
OAuthClientId は、ユーザーがOAuth 経由で認証を行う前に設定する必要があるいくつかの接続パラメータの1つです。詳細は接続の確立を参照してください。
カスタムOAuth アプリケーションの作成時に割り当てられたクライアントシークレットを指定します。( コンシューマーシークレット とも呼ばれます。)このシークレットは、カスタムアプリケーションをOAuth 認可サーバーに登録します。
OAuthClientSecret は、ユーザーがOAuth 経由で認証を行う前に設定する必要があるいくつかの接続パラメータの1つです。詳細は接続の確立を参照してください。
このセクションでは、本プロバイダーの接続文字列で設定可能なSSL プロパティの全リストを提供します。
| プロパティ | 説明 |
| SSLServerCert | TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。 |
TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。
TLS/SSL 接続を使用する場合は、このプロパティを使用して、サーバーが受け入れるTLS/SSL 証明書を指定できます。コンピュータによって信頼されていない他の証明書はすべて拒否されます。
このプロパティは、次のフォームを取ります:
| 説明 | 例 |
| フルPEM 証明書(例では省略されています) | -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE----- |
| 証明書を保有するローカルファイルへのパス。 | C:\cert.cer |
| 公開鍵(例では省略されています) | -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY----- |
| MD5 Thumbprint (hex 値はスペースおよびコロン区切り) | ecadbdda5a1529c58a1e9e09828d70e4 |
| SHA1 Thumbprint (hex 値はスペースおよびコロン区切り) | 34a929226ae0819f2ec14b4a3d904f801cbb150d |
これを指定しない場合は、マシンが信用するすべての証明書が受け入れられます。
すべての証明書の受け入れを示すには、'*'を使用します。セキュリティ上の理由から、これはお勧めできません。
このセクションでは、本プロバイダーの接続文字列で設定可能なFirewall プロパティの全リストを提供します。
| プロパティ | 説明 |
| FirewallType | provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。 |
| FirewallServer | ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。 |
| FirewallPort | プロキシベースのファイアウォールで使用するTCP ポートを指定します。 |
| FirewallUser | プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。 |
| FirewallPassword | プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。 |
provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。
プロキシベースのファイアウォール(またはプロキシファイアウォール)は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。
プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。
Note:デフォルトでは、Sync App はシステムプロキシに接続します。この動作を無効化し、次のプロキシタイプのいずれかに接続するには、ProxyAutoDetect をfalse に設定します。
次の表は、サポートされている各プロトコルのポート番号情報です。
| プロトコル | デフォルトポート | 説明 |
| TUNNEL | 80 | Sync App がSAP Ariba への接続を開くポート。トラフィックはこの場所のプロキシを経由して行き来します。 |
| SOCKS4 | 1080 | Sync App がSAP Ariba への接続を開くポート。SOCKS 4 は次にFirewallUser 値をプロキシに渡し、接続リクエストが許容されるかどうかを決定します。 |
| SOCKS5 | 1080 | Sync App がSAP Ariba にデータを送信するポート。SOCKS 5 プロキシに認証が必要な場合には、FirewallUser およびFirewallPassword をプロキシが認識する認証情報に設定します。 |
HTTP プロキシへの接続には、ProxyServer およびProxyPort ポートを使ってください。HTTP プロキシへの認証には、ProxyAuthScheme、ProxyUser、およびProxyPassword を使ってください。
ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。
プロキシベースのファイアウォール(またはプロキシファイアウォール)は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。
プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。
プロキシベースのファイアウォールで使用するTCP ポートを指定します。
プロキシベースのファイアウォール(またはプロキシファイアウォール)は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。
プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。
プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。
プロキシベースのファイアウォール(またはプロキシファイアウォール)は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。
プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。
プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。
プロキシベースのファイアウォール(またはプロキシファイアウォール)は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。
プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。
このセクションでは、本プロバイダーの接続文字列で設定可能なProxy プロパティの全リストを提供します。
| プロパティ | 説明 |
| ProxyAutoDetect | provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。 |
| ProxyServer | HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。 |
| ProxyPort | クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバー(ProxyServer 接続プロパティで設定)のTCP ポート。 |
| ProxyAuthScheme | ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。 |
| ProxyUser | ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名。 |
| ProxyPassword | ProxyUser 接続プロパティで指定されたユーザーに紐付けられたパスワード。 |
| ProxySSLType | ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプ。 |
| ProxyExceptions | ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。 |
provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。
この接続プロパティをTrue に設定すると、Sync App は既存のプロキシサーバー構成についてシステムプロキシ設定をチェックします(プロキシサーバーの詳細を手動で入力する必要はありません)。
この接続プロパティは他のプロキシ設定より優先されます。特定のプロキシサーバーに接続するためにSync App を手動で構成する場合は、False に設定します。
HTTP プロキシへの接続には、ProxyServer を参照してください。SOCKS やトンネリングなどの他のプロキシには、FirewallType を参照してください。
HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。
ProxyAutoDetect がFalse に設定されている場合、Sync App はこの接続プロパティで指定されたプロキシサーバーを通じてのみHTTP トラフィックをルーティングします。ProxyAutoDetect がTrue に設定されている場合(デフォルト)、Sync App は代わりにシステムプロキシ設定で指定されたプロキシサーバーを介してHTTP トラフィックをルーティングします。
クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバー(ProxyServer 接続プロパティで設定)のTCP ポート。
ProxyAutoDetect がFalse に設定されている場合、Sync App はこの接続プロパティで指定されたプロキシサーバーポートを通じてのみHTTP トラフィックをルーティングします。ProxyAutoDetect がTrue に設定されている場合(デフォルト)、Sync App は代わりにシステムプロキシ設定で指定されたプロキシサーバーポートを介してHTTP トラフィックをルーティングします。
その他のプロキシタイプについては、FirewallType を参照してください。
ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。
認証タイプは次のいずれかです。
"NONE" 以外のすべての値については、ProxyUser およびProxyPassword 接続プロパティも設定する必要があります。
SOCKS 5 認証のような他の認証タイプを使用するには、FirewallType を参照してください。
ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名。
ProxyUser および ProxyPassword 接続プロパティは、ProxyServer で指定されたHTTP プロキシに対して接続よび認証するために使用されます。
ProxyAuthScheme で利用可能な認証タイプを1つ選択した後、このプロパティを以下のように設定します。
| ProxyAuthScheme の値 | ProxyUser に設定する値 |
| BASIC | プロキシサーバーに登録されているユーザーのユーザー名。 |
| DIGEST | プロキシサーバーに登録されているユーザーのユーザー名。 |
| NEGOTIATE | プロキシサーバーが属するドメインまたは信頼されたドメイン内の有効なユーザーであるWindows ユーザーのユーザー名。user@domain またはdomain\user の形式で指定。 |
| NTLM | プロキシサーバーが属するドメインまたは信頼されたドメイン内の有効なユーザーであるWindows ユーザーのユーザー名。user@domain またはdomain\user の形式で指定。 |
| NONE | ProxyPassword 接続プロパティは設定しないでください。 |
Sync App は、ProxyAutoDetect がFalse に設定されている場合にのみ、このユーザー名を使用します。ProxyAutoDetect がTrue に設定されている場合(デフォルト)、Sync App は代わりにシステムのプロキシ設定で指定されているユーザー名を使用します。
ProxyUser 接続プロパティで指定されたユーザーに紐付けられたパスワード。
ProxyUser および ProxyPassword 接続プロパティは、ProxyServer で指定されたHTTP プロキシに対して接続よび認証するために使用されます。
ProxyAuthScheme で利用可能な認証タイプを1つ選択した後、このプロパティを以下のように設定します。
| ProxyAuthScheme の値 | ProxyPassword に設定する値 |
| BASIC | ProxyUser で指定したプロキシサーバーユーザーに紐付けられたパスワード。 |
| DIGEST | ProxyUser で指定したプロキシサーバーユーザーに紐付けられたパスワード。 |
| NEGOTIATE | ProxyUser で指定したWindows ユーザーアカウントに紐付けられたパスワード。 |
| NTLM | ProxyUser で指定したWindows ユーザーアカウントに紐付けられたパスワード。 |
| NONE | ProxyPassword 接続プロパティは設定しないでください。 |
SOCKS 5 認証もしくは、トンネリングは、FirewallType を参照してください。
Sync App は、ProxyAutoDetect がFalse に設定されている場合にのみ、このパスワードを使用します。ProxyAutoDetect がTrue に設定されている場合(デフォルト)、Sync App は代わりにシステムのプロキシ設定で指定されているパスワードを使用します。
ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプ。
このプロパティは、ProxyServer で指定されたHTTP プロキシへの接続にSSL を使用するかどうかを決定します。この接続プロパティには、以下の値を設定できます。
| AUTO | デフォルト設定。ProxyServer がHTTPS URL に設定されている場合、Sync App は、TUNNEL オプションを使用します。ProxyServer がHTTP URL に設定されている場合、コンポーネントはNEVER オプションを使用します。 |
| ALWAYS | 接続は、常にSSL 有効となります。 |
| NEVER | 接続は、SSL 有効になりません。 |
| TUNNEL | 接続はトンネリングプロキシ経由で行われます。プロキシサーバーがリモートホストへの接続を開き、プロキシを経由して通信が行われます。 |
ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。
ProxyServer は、このプロパティで定義されたアドレスを除くすべてのアドレスに使用されます。セミコロンを使用してエントリを区切ります。
Sync App はデフォルトでシステムプロキシ設定を使用するため、それ以上の設定は必要ありません。この接続にプロキシ例外を明示的に設定する場合は、ProxyAutoDetect をFalse に設定します。
このセクションでは、本プロバイダーの接続文字列で設定可能なLogging プロパティの全リストを提供します。
| プロパティ | 説明 |
| LogModules | ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。 |
ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。
このプロパティは、含めるログモジュールを指定することでログファイルの内容をカスタマイズすることができます。 ログモジュールは、クエリ実行、メタデータ、SSL 通信などの異なる領域にログ情報を分類します。 各モジュールは4文字のコードで表され、文字の名前の場合は末尾にスペースが必要なものもあります。
例えば、EXEC はクエリ実行をログに記録し、INFO は一般的なプロバイダーメッセージをログに記録します。 複数のモジュールを含めるには、次のように名前をセミコロンで区切ります:INFO;EXEC;SSL。
Verbosity 接続プロパティは、このプロパティで指定されたモジュールベースのフィルタリングよりも優先されます。 Verbosity レベルを満たし、指定されたモジュールに属するログエントリのみが記録されます。 利用可能なすべてのモジュールをログファイルに含めるには、このプロパティを空白のままにします。
利用可能なモジュールの完全なリストとログの設定に関する詳細な手引きについては、ログ の「高度なログの記録」セクションを参照してください。
このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。
| プロパティ | 説明 |
| Location | テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。 |
| BrowsableSchemas | レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
| Tables | レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。 |
| Views | レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。 |
テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。
Location プロパティは、定義をカスタマイズしたり(例えば、カラム名を変更する、カラムを無視するなど)、新しいテーブル、ビュー、またはストアドプロシージャでデータモデルを拡張する場合にのみ必要です。
指定しない場合、デフォルトの場所は%APPDATA%\\CData\\SAPAribaProcurement Data Provider\\Schema となり、%APPDATA%はユーザーのコンフィギュレーションディレクトリに設定されます:
| プラットフォーム | %APPDATA% |
| Windows | APPDATA 環境変数の値 |
| Linux | ~/.config |
レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
利用可能なデータベーススキーマをすべてリストすると余分な時間がかかり、パフォーマンスが低下します。 接続文字列にスキーマのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。
レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。
データベースによっては、利用可能なすべてのテーブルをリストするのに時間がかかり、パフォーマンスが低下する場合があります。 接続文字列にテーブルのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。
利用可能なテーブルがたくさんあり、すでに作業したいテーブルが決まっている場合、このプロパティを使用して対象のテーブルのみに表示を制限することができます。これを行うには、カンマ区切りのリストで使用したいテーブルを指定します。各テーブルは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space` です。
Note:複数のスキーマまたはカタログを持つデータソースに接続する場合は、表示する各テーブルを完全修飾名で指定する必要があります。これにより、複数のカタログやスキーマに存在するテーブルが混同されることを防ぎます。
レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。
データベースによっては、利用可能なすべてのビューをリストするのに時間がかかり、パフォーマンスが低下する場合があります。 接続文字列にビューのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。
利用可能なビューがたくさんあり、すでに作業したいビューが決まっている場合、このプロパティを使用して対象のビューのみに表示を制限することができます。これを行うには、カンマ区切りのリストで使用したいビューを指定します。各ビューは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space` です。
Note:複数のスキーマまたはカタログを持つデータソースに接続する場合は、確認する各ビューを完全修飾名で指定する必要があります。これにより、複数のカタログやスキーマに存在するビューが混同されることを防ぎます。
このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。
| プロパティ | 説明 |
| IncludeCustomFields | Determines whether the provider exposes custom fields in SAP Ariba tables as columns. |
| MaxRows | 集計やGROUP BY を使用しないクエリで返される最大行数を指定します。 |
| MaxThreads | Specifies the maximum number of concurrent requests the provider can execute to SAP Ariba. |
| Other | 特定のユースケースに対して追加の隠しプロパティを指定します。これらは通常のprovider の機能では必要ありません。複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。 |
| Pagesize | SAP Ariba から返される、1ページあたりの結果の最大数を指定します。この設定は、ほとんどのユースケースに最適化されている、データソースによって設定されたデフォルトのページサイズをオーバーライドします。 |
| PseudoColumns | テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。 |
| Timeout | provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。 |
| UserDefinedViews | カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。 |
Determines whether the provider exposes custom fields in SAP Ariba tables as columns.
Determines whether the Sync App exposes custom fields in SAP Ariba tables as columns.
集計やGROUP BY を使用しないクエリで返される最大行数を指定します。
このプロパティは、集計やGROUP BY 句を含まないクエリに対してSync App が返す行数の上限を設定します。 この制限により、クエリがデフォルトで過度に大きな結果セットを返さないようにします。
クエリにLIMIT 句が含まれている場合、クエリで指定された値がMaxRows 設定よりも優先されます。 MaxRows が"-1" に設定されている場合、LIMIT 句が明示的にクエリに含まれていない限り、行の制限は行われません。
このプロパティは、非常に大きなデータセットを返す可能性のあるクエリを実行する際に、パフォーマンスを最適化し過剰なリソース消費を防ぐのに役立ちます。
Specifies the maximum number of concurrent requests the provider can execute to SAP Ariba.
このプロパティを使用すると、複数のリクエストを同時に発行することができパフォーマンスが向上します。
Using more concurrent threads improves performance at the cost of additional memory usage.
特定のユースケースに対して追加の隠しプロパティを指定します。これらは通常のprovider の機能では必要ありません。複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。
このプロパティは、シニアユーザーが特定のシナリオに対して隠しプロパティを設定できるようにします。 これらの設定は通常のユースケースには必要ありませんが、特定の要件に対応したり、追加の機能を提供したりすることができます。 複数のプロパティをセミコロン区切りのリストで定義できます。
Note: 特定のシナリオや問題に対処するためにサポートチームから助言があった場合にのみ、これらのプロパティを設定することを強く推奨します。
複数のプロパティをセミコロン区切りリストで指定します。
| DefaultColumnSize | データソースがメタデータにカラムの長さを提供しない場合に、文字列フィールドのデフォルトの長さを設定します。デフォルト値は2000です。 |
| ConvertDateTimeToGMT | 日時の値を、マシンのローカルタイムではなくGMT グリニッジ標準時に変換するかどうかを決定します。 |
| RecordToFile=filename | 基底のソケットデータ転送を指定のファイルに記録します。 |
SAP Ariba から返される、1ページあたりの結果の最大数を指定します。この設定は、ほとんどのユースケースに最適化されている、データソースによって設定されたデフォルトのページサイズをオーバーライドします。
クエリする特定のオブジェクトやサービスエンドポイントの結果を最適化するために、デフォルトのページサイズを調整したい場合があります。 ページサイズを大きくするとパフォーマンスが向上するかもしれませんが、ページあたりのメモリ消費量が増える可能性もあることに注意してください。
テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。
このプロパティを使用すると、Sync App がテーブルカラムとして公開する擬似カラムを定義できます。
個々の擬似カラムを指定するには、以下の形式を使用します。"Table1=Column1;Table1=Column2;Table2=Column3"
すべてのテーブルのすべての擬似カラムを含めるには、次のようにします:"*=*"
provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。
このプロパティは、Sync App が操作をキャンセルする前に操作の完了を待機する最大時間を秒単位で制御します。 操作の完了前にタイムアウト時間が経過すると、Sync App は操作をキャンセルして例外をスローします。
タイムアウトは、クエリや操作全体ではなくサーバーとの個々の通信に適用されます。 例えば、各ページング呼び出しがタイムアウト制限内に完了する場合、クエリは60秒を超えて実行を続けることができます。
このプロパティを0に設定するとタイムアウトが無効になり、操作が成功するか、サーバー側のタイムアウト、ネットワークの中断、またはサーバーのリソース制限などの他の条件で失敗するまで無期限に実行されます。 このプロパティは慎重に使用してください。長時間実行される操作がパフォーマンスを低下させたり、応答しなくなる可能性があるためです。
カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。
このプロパティを使用すると、UserDefinedViews.json というJSON 形式の構成ファイルを通じてカスタムビューを定義および管理できます。 これらのビューはSync App によって自動的に認識され、標準のデータベースビューのようにカスタムSQL クエリを実行できるようになります。 JSON ファイルは、各ビューをルート要素として定義し、その子要素として"query" を持ちます。この"query" にはビューのSQL クエリが含まれています。次に例を示します。
{
"MyView": {
"query": "SELECT * FROM Orders WHERE MyColumn = 'value'"
},
"MyView2": {
"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
}
}
このプロパティを使用して、1つのファイルに複数のビューを定義し、ファイルパスを指定できます。 例:UserDefinedViews=C:\Path\To\UserDefinedViews.json。 このプロパティを使用すると、指定されたビューのみがSync App によって検知されます。
詳しくは、ユーザー定義ビュー を参照してください。