1. Integration Guide
  2. DataQuerySummary Interface

DataQuerySummary Interface

Contains the GID of a business object record.

Some external systems may not be prepared for Transportation and Global Trade Management Cloud to send large amounts of data. The DataQuerySummary interface provides a mechanism to send only a summary of the data. The external system can request the individual records from Transportation and Global Trade Management Cloud at appropriate times (e.g. idle times, overnight) by referencing the GID.

Send DataQuery Summary from Transportation and Global Trade Management Cloud

Required Data

Setup

You must have created the external system you want to send to.

How To Send the Transmission?

Mark the Send Summary check box when sending from one of these managers:

  • Order Base Manager
  • Order Manager (use for order releases)
  • Buy Shipment Manager
  • Sell Shipment Manager
  • Shipment Group Manager
  • Bill Manager
  • Service Provider Manager
  • Location Manager
  • Rate Offering Manager
  • Rate Record Manager
  • Item Manager
  • Invoice Manager
  • In the Process Manager, Send Integration Page.

What Data Goes into the Transmission?

Transportation and Global Trade Management Cloud includes only the GID of the record.

Transmission Results

Error Messages

The Role of the Transaction Code

The TransactionCode specifies whether the information should be inserted, or updated/replaced. For the Refnum objects that have the qualifier and value as part of the primary key, the TransactionCode indicates whether the new qualifier/value pair should be added (Insert), or used to replace all of the current records with the same qualifier (Update).

For example, the Shipment_Refnum table has a composite primary key made up of the ShipmentGID, RefnumQualifier, and RefnumValue. Assume a shipment has the following ShipmentRefnum Qualifier/Value pairs in the system: CO/A-12345, CO/B-89387, CN/C-83920. If you send a new refnum qualifier/value of CO/D-23849 using the GenericStatusUpdate interface, the TransactionCode would affect the change as follows:

  • TransactionCode = I: The new refnum would be added, resulting in all of the following being present in the table: CO/A-12345, CO/B-89387, CN/C-83920, CO/D-23849.
  • TransactionCode = U: The current reference numbers with the same qualifier would be deleted, and replaced by the new one. In this case, the result would leave the following in the table: CN/C-83920, CO/D-23849.

The TransactionCode is only applicable for the Refnum and Remark elements. It is not used for the Status or Indicator elements, which are only intended to be updated.