xml interface changes - oracle® transportation...

Oracle® Transportation Management

XML Interface Changes Guide

Release 6.3

Part No. E38431-04

January 2014

Copyright © 2001, 2014, Oracle and/or its affiliates. All rights reserved. iii

Oracle Transportation Management XML Interface Changes Guide, Release 6.3

Part No. E38431-04

Copyright © 2003, 2014, Oracle and/or its affiliates. All rights reserved.

This software and related documentation are provided under a license agreement containing

restrictions on use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited.

The information contained herein is subject to change without notice and is not warranted to be error-free. If you find any errors, please report them to us in writing.

If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, the following notice is applicable:

U.S. GOVERNMENT END USERS: Oracle programs, including any operating system, integrated

software, any programs installed on the hardware, and/or documentation, delivered to U.S. Government end users are "commercial computer software" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, use, duplication,

disclosure, modification, and adaptation of the programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, shall be subject to license terms and license restrictions applicable to the programs. No other rights are granted to the U.S. Government.

This software or hardware is developed for general use in a variety of information management applications. It is not developed or intended for use in any inherently dangerous applications, including applications that may create a risk of personal injury. If you use this software or hardware in

dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its safe use. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software or hardware in dangerous applications.

Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be

trademarks of their respective owners.

Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are used under license and are trademarks or registered trademarks of SPARC

International, Inc. AMD, Opteron, the AMD logo, and the AMD Opteron logo are trademarks or registered trademarks of Advanced Micro Devices. UNIX is a registered trademark of The Open Group.

This software or hardware and documentation may provide access to or information on content, products, and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services. Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages

incurred due to your access to or use of third-party content, products, or services.

For information about Oracle's commitment to accessibility, visit the Oracle Accessibility Program website at http://www.oracle.com/pls/topic/lookup?ctx=acc&id=docacc.

Access to Oracle Support

Oracle customers have access to electronic support through My Oracle Support. For information, visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=info or visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=trs if you are hearing impaired.

Copyright © 2001, 2014, Oracle and/or its affiliates. All rights reserved. iv

Contents

CONTENTS ................................................................................................. IV

SEND US YOUR COMMENTS ....................................................................... VI

PREFACE .................................................................................................. VII

CHANGE HISTORY ................................................................................................... VII

1. GENERAL INTEGRATION PROCESSING CHANGES .............................. 1-1

CHANGE ELEMENTFORMDEFAULT SCHEMA ATTRIBUTE ........................................................... 1-1 FLEX FIELD SUPPORT .............................................................................................. 1-1 ELEMENT SIZE COMMENTS ........................................................................................ 1-1

2. SCHEMA CHANGE HISTORY ............................................................... 2-1

RELEASE 6.3.3 ..................................................................................................... 2-1

CHANGES TO GLOGXML.XSD .................................................................................................... 2-1 CHANGES TO GLOGXML-GTM.XSD ............................................................................................ 2-1

RELEASE 6.3.2 ..................................................................................................... 2-1


RELEASE 6.3.1 ..................................................................................................... 2-2


RELEASE 6.3 ........................................................................................................ 2-3


3. ADDED ELEMENT DEFINITIONS ......................................................... 3-1

RELEASE 6.3.3 ..................................................................................................... 3-1

GLOGXML.XSD ................................................................................................................... 3-1 GLOGXML-GTM.XSD ............................................................................................................ 3-2

RELEASE 6.3.2 ..................................................................................................... 3-4


RELEASE 6.3.1 ..................................................................................................... 3-5


RELEASE 6.3 ........................................................................................................ 3-6


4. CHANGED ELEMENT DEFINITIONS................................................... 4-13

Copyright © 2001, 2014, Oracle and/or its affiliates. All rights reserved. v

RELEASE 6.3.3 ................................................................................................... 4-13

GLOGXML.XSD ................................................................................................................. 4-13 GLOGXML-GTM.XSD .......................................................................................................... 4-15

RELEASE 6.3.2 ................................................................................................... 4-17


RELEASE 6.3.1 ................................................................................................... 4-18


RELEASE 6.3 ...................................................................................................... 4-19


5. REMOVED, RESTRUCTURED, AND DEPRECATED ELEMENTS ................ 5-1

SUMMARY OF REMOVED OR RESTRUCTURED ELEMENTS ................................................... 5-1

RELEASE 6.3.3 .................................................................................................................... 5-1 RELEASE 6.3.2 .................................................................................................................... 5-1 RELEASE 6.3.1 .................................................................................................................... 5-1 RELEASE 6.3 ...................................................................................................................... 5-1

SUMMARY OF DEPRECATED ELEMENTS ........................................................................ 5-2

RELEASE 6.3.3 .................................................................................................................... 5-2 RELEASE 6.3.2 .................................................................................................................... 5-2 RELEASE 6.3.1 .................................................................................................................... 5-3 RELEASE 6.3 ...................................................................................................................... 5-3

6. APPENDIX A: PREVIOUS VERSION DEPRECATIONS ........................... 6-1

Copyright © 2001, 2014, Oracle and/or its affiliates. All rights reserved. vi

Send Us Your Comments

Oracle Transportation Management XML Interface Changes Guide, Release 6.3

Part No. E38431-04

Oracle welcomes your comments and suggestions on the quality and usefulness of this publication. Your input is an important part of the information used for revision.

Did you find any errors?

Is the information clearly presented?

Do you need more information? If so, where?

Are the examples correct? Do you need more examples?

What features did you like most about this manual?

If you find any errors or have any other suggestions for improvement, please indicate the title and part number of the documentation and the chapter, section, and page number (if available). You can send comments to us in the following ways:

Electronic mail: [email protected]

If you would like a reply, please give your name, address, telephone number, and electronic mail

address (optional).

If you have problems with the software, contact Support at https://support.oracle.com or find the Support phone number for your region at http://www.oracle.com/support/contact.html.

mailto:[email protected]

Copyright © 2001, 2014, Oracle and/or its affiliates. All rights reserved. vii

Preface

This document shows the integration schema element changes between the Oracle Transportation Management versions. Specifically, this will record the changes between the last minor release of

version 6.2 and immediately before version 6.3 became Generally Available. At the time of writing this is version 6.2.7.

The Change History will also record all modifications made during the ‘Roll Up’ (RU) minor releases of version 6.3 e.g. 6.3.1, 6.3.2 etc.

The intended audience is individuals responsible for supporting and changing integration between versions.

Change History

Date Document Revision Summary of Changes

11/2012 -01 Initial release for 6.3 GA.

3/2013 -02 Make LocationGid in LocationServProvPref an optional element.

Deprecate DocumentDefinitionGid in ControlScreeningResult.

Make InvolvedCountryQualifier optional in LocationInfo

4/2013 -03 Changes for Partial Pallet as Filler feature,

SanctionControlScreeningResult interface added to capture sanction controls, Flex Field Support for GtmTransactionLine and GtmShipmentLine, Add RegimeGid to GtmRegistration

Add Combination Equipment Group ID (double/triple) on the shipment

Add UserBIAppGid and UserBIRoleGid to User interface.

12/2013 -04 Modifications for 6.3.3

Integration support for Item structure

Add ShipmentGid to ShipmentStatus interface

Add TradeDirection to GtmItemClassification.

Support Active & Inactive Locations

Flex Fields on Contact

Allow Spot Rating for ServiceProvider

Flex Fields on Rate and Accessorial Costs.

CMIS Document enhancement

RIQ Query for Supporting options

Regional Handling Time for Location Role Profile.

Add GtmItemClassificationGid to GtmItemClassification.

Copyright © 2001, 2014, Oracle and/or its affiliates. All rights reserved. 1-1

1. General Integration Processing Changes

This chapter describes the XML interface changes introduced in Oracle Transportation Management version 6.3 that affect the schema documents as a whole. A description of each element and attribute

change is covered in section 3. For a complete description of the meaning and use of all interfaces refer to the integration online documentation.

Change elementFormDefault schema attribute

The elementFormDefault schema attribute essentially controls which elements are required to have or

are permitted to have, an XML namespace association.

In releases prior to v6.3, this attribute value was ‘unqualified’ which meant that local element declarations must NOT have a namespace association.

As of version 6.3, the elementFormDefault attribute value will be ‘qualified’ meaning that ALL elements MUST have a namespace association.

The impact on the majority of GLogXML.xsd and GLogXML-GTM.xsd element declarations is minimal due the fact that most definitions are global and not local element definitions.

Flex Field Support

The Flex Field feature added in v6.3 introduces the capability to have a set of customizable columns to the top level objects in OTM/GTM e.g. Order Release, Shipment etc..

Flex Fields will be one of the following types, with number of fields supported in parenthesis:

String (20)

Number (10)

Date (10)

Currency (3)

Not all top level objects use all of the above.

The corresponding schema interface for the top level elements will therefore be extended to support

input and output of these new elements

Element size comments

Several documentation comments which specified the maximum field lengths for related elements were out of date and required updating. The complete list follows:

Element Old Size New Size

EmailAddress 60 2000

FirstName 20 150

LastName 30 150


Element Old Size New Size

CorporationName 30 360

LocationName 30 360

ItemName 30 240


2. Schema Change History

Release 6.3.3

Changes to GLogXML.xsd

Reference Description

16742847 Add TradeDirection to GtmItemClassification.

16814574 Add ShipmentGid to ShipmentStatus

17325408 Add Flex Fields to RATE_GEO and ACCESSORIAL_COST

16812029 Added supporting options RIQ Results to RIQ Query

17440943 Add Flex fields to Contact.

10086179 Support for Active and Inactive Locations

17509534 Service Provider Spot Rating indicator.

17822920 Support for Regional Variable Handling time for Location Role

Profiles.

17891616 Add GtmItemClassificationGid to GtmItemClassification.

Changes to GLogXML-GTM.xsd


17174666, 17552477 Integration support for Item Structure

16742908 Add Trade Direction element to Transaction and Shipment lines and to Product Classification.

17241214 The percentage value support has been added in the Trade Item Structure component, Trade Transaction Line and Customs Shipment Line.

Release 6.3.2





16217123 Changes for Partial Pallet as Filler feature

16997281 Add Combination Equipment Group ID (double/triple) on the shipment

17249312 Add UserBIAppGid and UserBIRoleGid to User interface. Deprecate BiRoleGid.



16078206 SanctionControlScreeningResult interface added to capture sanction controls.

16527367, 16527382 Flex Field Support for GtmTransactionLine, GtmShipmentLine

17174666 Integration support for Item Structure

16515026 Add RegimeGid to GtmRegistration

Release 6.3.1



14570427 Make LocationGid in LocationServProvPref an optional element



14822744 Make InvolvedCountryQualifier in LocationInfo an optional element.

Deprecate ControlScreeningResult/DocumentDefinitionGid.


Release 6.3



10373105 Add support for multiple source locations to RIQ query & results.

11800344 Add ReleaseMethodGid to ShipUnit.

10406584 Add Shipment and Order refnum to RIQ Query

12864556 Add support for pre entered pick up.

12928561 Add UOM conversion for GTM item.

13095443 Additional elements for Tracking events

13346831 Add support for Custom Filing response

13511977 Enhancements to Document interface

13683848 Additional splittable flags for Ship Unit building

13845661 Add Flex Fields support.

13569306, 14135854 Added Integration capability for Outbound XML for a newly added business object: Demurrage Transaction. (Demurrage Management Solution deals with business aspects related to demurrage which is a

term for the fees charged by a carrier to a customer for the use of

assets beyond a contracted free time for loading and unloading).

13567443 Add IsHazardous flag to ShipUnitContent

14087535 Changes for Load Configuration updates for Ship Unit Build feature

(SUBLD).

13004541 Remove unused OrderMovement element from Shipment

13485668 Remove Sensor Edge interface

10154604 Added Integration support to the Contact interface elements that are

otherwise accessible only through the UI

11897690 As a part of Network Routing Enhancement, added new fields from the

LEG table to the Itinerary XML schema definition.





10395888 Add user defined codes to TradeTransaction

11704021 Country and Region modifications

12399821 Add transaction line license

12620840, 12537528, 11881307 License Determination

12716309 Trade Transaction missing date qualifier

12634687 Customs Shipment UI

12928561 Customs Filing

13038921 Compliance Policy Assignment

13406026 GTM Transaction Required Documents

13819111 New GtmShipment interface

14036708, 14610374, 14615890 Flex Field Support for GTM


3. Added Element Definitions

The following global element, type or attribute definitions have been added. Refer to section 4, for details on which elements may have been changed to use these new definitions.

[Legend: ‘E’ – Element, ‘T’ – Complex Type, ‘A’ – Attribute.]

Release 6.3.3

GLogXML.xsd

XML Element Description

RegionalHandlingTime E Used to specify the handling time for order going through the location - the most specific

matching entry will be used to determine handling time.

VarHandlingCostPerVolume E Used to specify Planning Handling Cost per

Volume at location.

VarHandlingVolume E Used to specify Planning Handling Cost Volume at location.

TradeDirection E Specifies the trade direction. Could be one of

Import, Export, or Both

AllowSpotRating E Specifies if the service provider is valid for Spot Rating Shipment actions. Defaults to 'Y'.

DocumentContentParam E Specifies a set of parameters used by external

content management systems to store and search for the document. These parameters are in addition to any parameters generated by the system for a specific content management system or document type.

ContentManagementSystemGid E Identifies content management system used to

store document content. If DATABASE, content is stored within the OTM database schema. If omitted, the system is based on the system associated with the document type. If no type or system can be ascertained, a default system is used based on an OTM property. Validation: Reference to

CONTENT_MANAGEMENT_SYSTEM table.

PrimarySourceLocationGid E Describes the primary source arbitrary Gid. References the LOCATION table.

PrimaryDestLocationGid E Describes the primary dest arbitrary Gid.

References the LOCATION table.

PrimaryTotalCost E Indicates Total Shipment cost.



PrimaryTransitTime E Total transit time.

PrimaryRateOfferingGid E PrimaryRateOfferingGid is a reference to a record in the RATE_OFFERING table,which specifies contractual information for a

particular rate offering of the Primary shipment.

PrimaryRateGeoGid E PrimaryRateGeoGid uniquely identifies a RateGeo element.

LeadTime E Total lead time for the shipment.

RIQResultRouteNR E

PrimaryLegRouteOption E

ShipFromLocationGid E

ShipToLocationGid E

GtmItemClassificationGid E Unique ID for GtmItemClassification.

GLogXML-GTM.xsd


GtmStructure E Represents Trade Item Structure (bill of

material) to identify components that make up a single sellable product or item.

GtmStructureGid E Unique ID for Item Structure

GtmStructureName E Represents trade item structure name

GtmStructureCategoryGid E Represents trade item structure category

GtmStructureTypeGid E Represents trade item structure type

GtmStructureCodeGid E Represents trade item structure code

DefaultCountryOfOriginGid E Unique ID for default country of origin

GtmStructureComponent E Trade Item Structure Component information for an item structure

GtmStructureCompSeq E Unique sequence for structure component


Release 6.3.2

GLogXML.xsd


CombinationEquipmentGrpGid E Specifies the Combination Equipment Group ID (double/triple) on the shipment

UserBIAppGid E GL User BI App. References the

GL_USER_BI_APP.

UserBIRoleGid E GL User BI Role. References the GL_USER_BI_ROLE.

ShipUnitLoadingSplit E Used to specify Ob Ship Unit of an Order Base

or Ship Unit of an Order Release.

References OB_SHIP_UNIT_LOADING_SPLIT when child of TransOrder.

References SHIP_UNIT_LOADING_SPLIT when child of Release.

SplitNumber E Specifies the split number for ship unit loading.

GLogXML-GTM.xsd


RegimeGid E Part of GtmRegistration


Release 6.3.1

GLogXML.xsd

No changes.

GLogXML-GTM.xsd

No changes.


Release 6.3

GLogXML.xsd


SourceLocationProfileGid E Specifies the destination location profile for the leg

TotalActualCostPerUOM

E Indicates the total actual cost per UOM

TotalWeightedCostPerUOM E Indicates the total weighted cost per UOM

CostPerWeightVolumeUOM E Indicates the cost per result i.e 100 USD PER KILO

IsPreEnteredPU E Used to indicated if the order is a pre-entered pickup order

SplittableBy E Indicates how the resulting order release ship unit may be split across equipment.

OrLinePackageRefUnit E Used to specify Packaging Reference Unit of an Order Release Line.

OBLinePackageRefUnit E Used to specify Packaging Reference Unit of an Order Base Line.

ERPC E ERPC String

GtmItemUomConversion E Holds item specific UOM-to-UOM conversion rates

FromUomCode E Used in GtmItemUomConversion

ToUomCode E Used in GtmItemUomConversion

ConversionRate E Used in GtmItemUomConversion

IeDocumentResponse E Document Response for Customs Filing.

AddNewRevision E Specifies whether or not to add a new revision

Annotation E Optional annotation to be added to a new revision.

FlexFieldStringType T New type to hold Flex Field Strings

FlexFieldDateType T New type to hold Flex Field Dates

FlexFieldNumberType T New type to hold Flex Field Numbers



FlexFieldCurrencyType T New type to hold Flex Field Currencies

ATTRIBUTE1 to 20 E Flex Field for RATE_GEO and RATE_OFFERING

ATTRIBUTE_NUMBER1 to 10 E Flex Field for RATE_GEO and RATE_OFFERING

ATTRIBUTE_DATE1 to 10 E Flex Field for RATE_GEO and RATE_OFFERING

Telex E

UseMessageHub E

PrinterGid E

MessageProfileGid E

CellPhone E

LegType E Specifies the leg type. Validation: Should be one of ‘ITINERARY LEG’ or ‘NETWORK LEG’. Default value is ‘ITINERARY LEG’

RoutingNetworkGid E Uniquely identifies the Routing Network for a Leg

SourceRegionGid E Uniquely identifies the Source Region of Leg

DestRegionGid E Uniquely identifies the Destination Region of Le

LegConsolidationGroupGid E Uniquely identifies the Leg Consolidation Group

AllowCrossConsolidation E Specifies if cross consolidation is allowed

The following elements relate to the feature for enhancing Ship Unit building for Order Releases and Shipments.


IsRepackAllowed E Indicate if Ship Unit can be repacked

LocationTHUCapacity E The Location THU capacity is a structure

specifying the capacity that a transport handling unit may hold when it is being delivered to this location for this role

MaxLength E

MaxHeight E

MaxWidth E



MaxWeight E

MaxVolume E

MaxOnLength E

MaxOnHeight E

MaxOnWidth E

THUCapacityPackageRefUnit E

PackageItemTypeGid E Identifies the packaging item type

LoadConfigRuleRank E Specifies the LoadConfigRuleRank

PackagingInnerPack E Contains Inner Pack count information

PkgItemPackageRefUnit E Contains packaged item reference unit usage information

PackageRefUnitGid E A GID that uniquely identifies a packaging reference unit

IsFloorCompatible E Used in LoadConfigSetup Orientation

LoadConfigSetupRef E

LoadConfigSetup E

LoadConfigSetupOrientation E

PatternConfigProfileGid E

LoadConfigSetupGid E

StackingRule E

MaxUnsupportedAreaPercent E

ShipUnitLoadingSplit E Used to specify split pallet information during ship unit loading to increase container utilization level

SplitNumber E Used in ShipUnitLoadingSplit

GLogXML-GTM.xsd




LicenseDetermination E New Type to send request for License Determination Screening Service

LicenseDeterminationResponse E New Type To Receive License Determination

Screening Response

BalanceQuantity E Holds the value of a Balance Quantity available on License Line

BalanceValue E Holds the value of a Balance Value available on License Line

PortInfo E Port information for a transaction.

PortQualifier E Part of PortInfo

PortId E Part of PortInfo

ControlTypeCode E Specify the value for which license is required.

TransDateInfo E Date information as part of license

screening request.

CountrySequence E

RegionCountryInfo E Holds region and Country information in License Screening request.

RegionInfo E Holds region information in Compliance Screening request.

RegionQualifier E Placeholder for Qualifier in RegionCountryInfo and RegionInfo

RegionId E Placeholder for Region ID

GtmTransLineLicense E License Assignment result for a transaction line

LicenseLineGid E Part of GtmTransLineLicense

LicenseAssignedDate E Part of GtmTransLineLicense

ItemRemarks E Item remark information as for license determination request

TransLineRemarks E Remarks for a Trade Transaction Line

TransDate E Date Information For Trade Transaction or Customs Shipment



TransactionCurrency E Currency value for a trade transaction or customs shipment

TransactionQuantity E Quantity value for a trade transaction or

customs shipment

TransportModeGid E Transport Mode information for a Trade Transaction or Customs Shipment

IncoTermGid E IncoTerm information for a transaction

ReportingQuantity E Quantity value for a Customs Shipment which is specific to customs filing.

ReportingResult E Compliance screening result which determines whether the specific Customs Shipment Line requires customs filing or not for a specific regime.

GtmPolicyQualifierGid E Part of TransactionPolicy

TransactionPolicy E Policy information for a Trade Transaction or Customs Shipment

InvolvedLocationQualifierGid E Part of TransactionInvLocation

TransactionInvLocation E Involved location information for a Trade

transaction or Customs Shipment.

GlUserGid E Represents unique application User ID.

TransactionRequiredDocument E Standard document determined for Trade

Transaction

TransactionRequiredText E Test Templates applied for determined Documents for a transaction

TransactionDocumentReviewer E Reviewer details for a determined document on a transaction

TransactionDocumentSubscriber E Subscriber details for a determined

document on a transaction

GtmTransactionLineRequiredDocument E Standard document determined for Trade Transaction Line

GtmTransactionLineRequiredText E Standard text determined for Trade Transaction Line

GtmTransactionLineTextLinkGid E Test Templates applied for determined Documents specific a transaction Line



Authorization E Manual license/Exception information for a Transaction Line

IncoTermLocation E Inco Term Location for a transaction

IsHazardousCargo E Indicates whether the Items shipped are hazardous in a transaction or customs shipment

TextTemplateGid E Text template for a document on a transaction or customs shipment

ReviewStatus E Document review status on a transaction

GtmTransactionType E Data which used to differentiate between trade transaction and customs shipment

IsPassed E Restricted party screening result for a

contact

PrecedingTransactionLineGid E Reference transaction line information for a customs shipment line

CalculatedValueResult E Result of a value formula determination for a transaction line/customs shipment line

CalculatedValueGid E Value formula ID determined for a

transaction line/customs shipment line

GtmShipment E New type for customs shipment

GtmShipmentGid E Unique ID for GtmShipment

GtmShipmentLineGid E Unique ID for GtmShipmentLine

GtmShipmentLine E New type for customs shipment line

TransLineType E Data which used to differentiate between trade transaction line and customs shipment line

FlexFieldDateType T Flex Field for DATE type values

IsActive E Specifies whether a specific registration is active or not

IsTemplate E Specifies the whether the specified registration information is for a specific registration or a template which can be applied for any registration

GtmRegistrationDate E Date information for a registration



DateQualifierGid E Qualifiers information to specify the type of a date

RegistrationDate E Date values for a registration

GtmRegRelatedItem E Items Related to Registration

GtmRegRelatedCommodity E Commodities Related to Registration

GtmRegRelatedUDCommodity E User Defined Commodities Related to Registration

GtmRegRelatedLicense E Licenses Related to Registration

GtmRegRelatedRegistration E Related Registration information for a Registration

GtmRelatedRegistrationGid E Unique ID for Registration.

InvolvedPartyDetail E Extended replacement of original InvolvedParty element.

SanctionControlScreeningResult E To capture sanction controls.

AuthorizationAddedBy E Who added this Authorization?

AuthorizationAddedOn E When was the Authorization added?


4. Changed Element Definitions

Release 6.3.3

GLogXML.xsd


ShipmentStatus Added

ShipmentGid

GtmItemClassification Added

TradeDirection

GtmItemClassificationGid

Location Added

IsActive

Contact Added

FlexFieldStrings

FlexFieldNumbers

FlexFieldDates

ServiceProvider Added

AllowSpotRating

RATE_GEO_COST_ROW Added

ATTRIBUTE1 to 20

ATTRIBUTE_NUMBER1 to 10

ATTRIBUTE_DATE1 to 10

ACCESSORIAL_COST_ROW Added

ATTRIBUTE1 to 20



Document Added

ContentManagementSystemGid

DocumentContentParam



RIQQuery Added

UseRIQRouteNR

PortOfLoadLocationRef

PortOfDisLocationRef

VoyageGid

PrimaryOptionDefinition

MaxPrimaryOptions

MaxSupportingOptions

RIQQueryReply Added

RIQResultNR

RIQRouteShipment Added

IsPrimary

IsOptimalResult

EstArrivalTimeSrc

EstDeptTimeSrc

EstArrivalTimeDest

EstDeptTimeDest



RIQResultRoute Added

Perspective

LeadTime


TotalWeightedCostPerUOM

TotalWeightedCost

TransportModeGid

ServiceProviderGid

TotalTransitTime

OrigCarrierGid

DelivCarrierGid

EquipmentGroupGid

RouteCodeGid

VesselGid

PortOfLoadLocationRef

PortOfDisLocationRef

PrimarySourceLocationGid

PrimaryDestLocationGid

PrimaryTotalCost

VoyageGid

PrimaryTransitTime

CommitmentCountPlanned

CommitmentCountActual

PrimaryRateOfferingGid

PrimaryRateGeoGid

CommodityGid

ShipFromLocationGid

ShipToLocationGid

LocationRole Added

VarHandlingCostPerVolume

VarHandlingVolume

RegionalHandingTime

GLogXML-GTM.xsd


GLogXMLElement (via

GLogXMLTransaction substitution)

Added

GtmStructure


Release 6.3.2

GLogXML.xsd


ShipUnit Added

ShipUnitLoadingSplit

ShipmentHeader2 Added

CombinationEquipmentGrpGid

User Added

UserBIAppGid UserBIRoleGid EffectiveDate ExpirationDate

GLogXML-GTM.xsd


GtmTransactionLine Added

SanctionControlScreeningResult

FlexFieldStrings

FlexFieldNumbers

FlexFieldDates

GtmShipmentLine Added

SanctionControlScreeningResult

FlexFieldStrings

FlexFieldNumbers

FlexFieldDates

GtmRegistration Added

RegimeGid


Release 6.3.1

GLogXML.xsd


LocationServProvPref Changed

LocationGid to be optional

GLogXML-GTM.xsd


LocationInfo Changed

InvolvedCountryQualifier to be optional


Release 6.3

GLogXML.xsd


GLogXMLElement Added

Demurrage Transaction.

RIQQuery Added

SourceLocationProfileGid

ShipmentRefnum

OrderRefnum

RIQResult Added

SourceLocationGid



RIQRouteShipment Added



ReleaseHeader Added

IsPreEnteredPU

FlexFieldStrings

FlexFieldNumbers

FlexFieldDates

FlexFieldCurrencies

Item Added

GtmItemUomConvesion

FlexFieldStrings

FlexFieldNumbers

FlexFieldDates

SSLocation Added

ERPC

SStatusSEquipment Added

AARCarType

RailInfo Added

EventCountry

LocationID

ERPC



ShipmentStatus Added

IeDocumentResponse

FilingResponseType

FlexFieldStrings

FlexFieldNumbers

FlexFieldDates

ReleaseLine Added

IsSplitAllowed

ShipUnitSpecProfileGid

OrLinePackageRefUnit

ShipUnit Added

SplittableBy

FlexFieldStrings

FlexFieldNumbers

FlexFieldDates

LoadConfigSetupRef

IsRepackAllowed

TransOrderHeader Added

FlexFieldStrings

FlexFieldNumbers

FlexFieldDates

FlexFieldCurrencies

TransOrderLine Added

FlexFieldStrings

FlexFieldNumbers

FlexFieldDates


OBLinePackageRefUnit

Location Added

FlexFieldStrings

FlexFieldNumbers

FlexFieldDates



ShipmentHeader Added

FlexFieldStrings

FlexFieldNumbers

FlexFieldDates

FlexFieldCurrencies

Equipment Added

FlexFieldStrings

FlexFieldNumbers

FlexFieldDates

ShipmentStop Added

FlexFieldStrings

FlexFieldNumbers

FlexFieldDates

PaymentHeader Added

FlexFieldStrings

FlexFieldNumbers

FlexFieldDates

FlexFieldCurrencies

Voucher Added

FlexFieldStrings

FlexFieldNumbers

FlexFieldDates

FlexFieldCurrencies

Packaging Added

FlexFieldStrings

FlexFieldNumbers

FlexFieldDates

PackageItemTypeGid

LoadConfigRuleRank


PackagingInnerPack

PkgItemPackageRefUnit

ShipmentGroupHeader Added

FlexFieldStrings

FlexFieldNumbers

FlexFieldDates



Job Added

FlexFieldStrings

FlexFieldNumbers

FlexFieldDates

Consol Added

FlexFieldStrings

FlexFieldNumbers

FlexFieldDates

Claim Added

FlexFieldStrings

FlexFieldNumbers

FlexFieldDates

FlexFieldCurrencies

QuoteHdr Added

FlexFieldStrings

FlexFieldNumbers

FlexFieldDates

Driver Added

FlexFieldStrings

FlexFieldNumbers

FlexFieldDates

PowerunitHeader Added

FlexFieldStrings

FlexFieldNumbers

FlexFieldDates

Device Added

FlexFieldStrings

FlexFieldNumbers

FlexFieldDates

OrderMovement Added

FlexFieldStrings

FlexFieldNumbers

FlexFieldDates



Itinerary Added

FlexFieldStrings

FlexFieldNumbers

FlexFieldDates

ShipUnitContent Added

IsHazardous

LocationRole Added

IsMixedFreightTHUAllowed


LocationTHUCapacity

ShipUnitSpec Added

MaxOnLength

MaxOnWidth

MaxOnHeight

THUCapacityPackageRefUnit

Contact Added

Telex

TimeZoneGid

CellPhone

UseMessageHub

MessageProfileGid

PrinterGid

Leg Added

LegType

RoutingNetworkGid

SourceRegionGid

DestRegionGid

LegConsolidationGroupGid

DepotProfileGid

AllowCrossConsolidation

RATE_GEO_ROW Added

ATTRIBUTE1 to 20





RATE_OFFERING_ROW Added

ATTRIBUTE1 to 20



GLogXML-GTM.xsd


ServiceRequest Added

LicenseDetermination

ServiceResponse Added

LicenseDeterminationResponse

RestrictedPartyResponse Added

MatchPer

TradeTransaction Added

TradeClassification

GtmTransaction Added

GtmTransactionType

TransDate

PortInfo

TransactionQuantity

TransactionCurrency

TransportModeGid

IncoTermGid

IncoTermLocation

IsHazardousCargo

IsShipmentCreated

TransactionPolicy

TransactionInvLocation

TransactionRequiredDocument

FlexFieldStrings

FlexFieldNumbers

FlexFieldDates

Changed

GtmTransactionGid to be optional



GtmTransactionLine Added

GtmTransLineLicense

CountryOfOriginGid

ManufacturingCountryGid

ReportingQuantity

ReportingResult

GtmTransactionLineRequiredDocume

nt

GtmTransactionLineRequiredText

TransLineType

CalculatedValueResult

ParentTransactionLineGid

Changed

GtmTransactionLineGid to be optional

ComplianceRule Added

RegionInfo

InvolvedPartyDetail

CategoryTypeCode Changed

GtmType made mandatory

GtmCode made mandatory

ControlScreeningResult Added

Authorization

InvolvedPartyQualifierGid

RestrictedPartyScreeningResult Added

IsPassed

GtmRegistration Added

IsActive

IsTemplate

GtmRegistrationDate

GtmRegRelatedItem

GtmRegRelatedCommodity

GtmRegRelatedUDCommodity

GtmRegRelatedLicense

GtmRegRelatedRegistration


5. Removed, Restructured, and Deprecated Elements

Summary of Removed or Restructured Elements

This section summarizes the elements that have been removed from the schema or have had a major

modification such that it will require clients to modify their existing integration code to comply with the change. These elements will normally have been deprecated in a previous release. Exceptions to this process will be clearly stated. The location of the element is given as an XPATH expression relative to the schema document root.

Release 6.3.3

No removed elements.

Release 6.3.2


Release 6.3.1


Release 6.3

GLogXML.xsd


Shipment/OrderMovement Removed as this was intended for future

use bit will not now be used.

ShipmentStatus/SensorEvent Removed as Sensor Edge Server is no longer supported.

TransOrderStatus/SensorEvent Removed as Sensor Edge Server is no longer supported.

SensorEvent Removed as Sensor Edge Server is no longer supported.

GLogXML-GTM.xsd




GtmTransactionLine/GtmTransactionLine This is replaced by ParentTransactionLineGid. The original function to support parent-child relationships did work and had to be restructured to use the new element.

There should therefore be no pre-existing implementations which use the original element.

ComplianceRule/InvolvedParty This has been replaced with InvolvedPartyDetail element as original processing did not work. There should

therefore be no pre-existing implementations which use the original

element.

Summary of Deprecated Elements

This section summarizes the elements that have been deprecated in this release. Deprecated elements have been left in the schema to minimize the impact to clients, but will be removed in the next major release. For elements that have been renamed, the old and new element names will be supported on the inbound, but only the new name will be sent on the outbound. The location of the element is given as an XPATH expression relative to the schema document root.

Release 6.3.3

GLogXML.xsd

No deprecated elements.

GLogXML-GTM.xsd


Release 6.3.2

GLogXML.xsd


User/BiRoleGid BiRole has a one to many relation with GL

User going forward. BI_ROLE_GID is moved to GL_USER_BI_ROLE table from GL_USER. BiRoleGid is replaced by UserBIRoleGid. BiRoleGid is deprecated in

6.3.2 and will be removed in a couple of releases.


GLogXML-GTM.xsd


Release 6.3.1

GLogXML.xsd


GLogXML-GTM.xsd


ControlScreeningResult/DocumentDefinitionGid Superseded by the GtmTransactionLine/GtmTransactionLineR

equiredDocument element

Release 6.3

GLogXML.xsd


ShipUnit/ShipUnitLoadConfig This field is no longer used. The new rules for when to apply the correct load configuration parameters as defined in the rules will allow the user to modify the load

configurations based on location and equipment used. This new approach now allows for all of the load configuration parameters to be varied this way and is no longer necessary to specify this by leg classification. If specified it will be ignored. The Load Config Rule table

defines the pattern based loading by equipment and therefore it is not necessary to use leg classification to vary these patterns.



ShipUnit/OBShipUnitLoadConfig This field is no longer used. The new rules for when to apply the correct load configuration parameters as defined in the rules will allow the user to modify the load configurations based on location and

equipment used. This new approach now allows for all of the load configuration parameters to be varied this way and is no longer necessary to specify this by leg classification. If specified it will be ignored. The Load Config Rule table defines the pattern based loading by

equipment and therefore it is not necessary to use leg classification to vary these patterns.

ReleaseLine/ReleaseLineLoadConfig This field is no longer used. The new rules for when to apply the correct load

configuration parameters as defined in the rules will allow the user to modify the load configurations based on location and equipment used. This new approach now allows for all of the load configuration parameters to be varied this way and is no longer necessary to specify this by leg

classification. If specified it will be ignored. The Load Config Rule table defines the pattern based loading by equipment and therefore it is not necessary to use leg classification to vary

these patterns.

ShipUnitSpec/StackingIndex Indicates how an item/ship unit can be stacked. An object with a higher stacking index cannot be placed on an object with a lower stacking index. If the value is entered on the ShipUnit Specification for a given Ship Unit it will be entered on the

LoadConfigSetup structure for that ShipUnit

ShipUnitSpec/MaxStackingHeight The unit and the unit of measure indicate the highest height that may be stacked in this parameter set. If the value is entered on the ShipUnit Specification for a given

Ship Unit it will be entered on the




ShipUnitSpec/MaxStackingLayers Indicates the maximum number of layers that may be stacked in this parameter set. If the value is entered on the ShipUnit Specification for a given Ship Unit it will be entered on the


ShipUnitSpec/IsStackableAbove Y, N - indicates if stacking above this ship unit is permitted. If the value is entered on the ShipUnit Specification for a given Ship Unit it will be entered on the


ShipUnitSpec/IsStackableBelow Y, N - indicates if stacking below this ship unit is permitted. If the value is entered on the ShipUnit Specification for a given

Ship Unit it will be entered on the LoadConfigSetup structure for that ShipUnit

ShipUnitSpec/LoadingPatternGid If this value is entered it will populate the PatternConfigProfileGid. This Gid refers to the LOAD_CONFIG_PROFILE table and the

table and contents have not changed. The name Loading Pattern was added to clarify that the table LOAD_CONFIG_PROFILE is only relevant for the Pattern based load config option

ShipUnitSpec/ShipUnitSpecOrientation

Location/IsMixedFreightTHUAllowed

Location/MixedFreightTHU This field corresponds to the field THU_PROFILE_GID on the table LOCATION_ROLE_PROFILE. The current

field on the XML is for a single THU where the new field is a profile. We would have to search the SHIP UNIT SPEC PROFILE table to find the profile that contains just this THU. If we do not find one then we would have to create one and then add

that to the LOCATION_ROLE_PROFILE

table where the LOCATION_ROLE_GID=SHIPFROM/TO

Packaging/StackingIndex This field is no longer used

PackagingShipUnit/InnerPackCount



Leg/LoadConfigProfileGid This field is no longer used. The new rules for when to apply the correct load configuration parameters as defined in the rules will allow the user to modify the load configurations based on location and

equipment used. This new approach now allows for all of the load configuration parameters to be varied this way and is no longer necessary to specify this on the leg. If specified it will be ignored.

ShipUnit/StackingIndex This field has been removed from the

database at the ship unit level. The new structure Load Config Setup contains all of

the parameters for the load config algorithm in one structure. If a stacking index is specified on the ShipUnit level a new LoadConfigSetup record will be

created for this ShipUnit. The LoadConfigSetup Gid in the LoadConfigSetup table will be set to the ShipUnitGID.

GLogXML-GTM.xsd


GtmTransaction/ExportDate This element has been superseded by the

GtmTransaction/TransDate element.

ControlScreeningResult/LicenseNumber In 6.3, GTM now supports complete License Management. All the License Information is captured under GtmTransactionLine/GtmTransLineLicense. The License Number Field in 6.2 is changed as Authorization in 6.3

GtmTransaction/GtmComplianceTemplateGid In 6.3, users can assign more than one Compliance policy. All the policy information is now captured in GtmTransaction/ TransactionPolicy

GtmTransactionLine/GtmTransactionLineText This element has been superseded by the

GtmTransactionLine/GtmTransactionLineRequiredText element.

ControlScreeningResult/ControlCategory This field used to differentiate license control and sanction control. A new table has been introduced for sanction control making this element obsolete.


6. Appendix A: Previous Version Deprecations


For Release 5.5

ShipmentModViaOrderLine.AffectsCurrentLegOnly

ShipmentModViaOrderSU.AffectsCurrentLegOnly

This is being replaced by specifying ShipmentHeader.IntCommand.IntCommandName

= ‘PropagateShipUnitChanges’ when the AffectsCurrentLegOnly = ‘N’

ShipmentHeader2.FeasibilityCode This is being replaced by the FeasibilityCodeGid element.

LocationRole.FixedStopTime

LocationRole.VariableStopTime

LocationRole.VarStopQuantity

LocationRole.VarStopWeightVolume

These elements have been replaced by the

LocationActivityTime element.

ReleaseHeader.SequenceType

TransOrderHeader.SequenceType

These elements have been replaced by the PickupRoutingSeqGid and DropoffRoutingSeqGid

elements as of the 5.5 CU3 Release.

RouteCodeDetail.CarrierScac The element has been replaced by the ScacGid element in 5.5 CU4.

RouteCodeDetail.JunctionCity The element has been replaced by the

RailJunctionCodeGid element in 5.5 CU4.

For Release 5.0

TransOrderHeader.MustShipAlone Replaced by BundlingType element

ReleaseHeader.MustShipAlone Replaced by BundlingType element

Job.InvolvedParty Replaced by JobInvolvedParty element

Itinerary.MaxDistanceBetweenStops Replaced by MaxDistBtwDeliveryStops element

Sku.QuantityOnHand Replaced by SkuQuantity element

Sku.MinLevel Replaced by SkuLevel element

Sku.MaxLevel Replaced by SkuLevel element

Sku.ReorderLevel Replaced by SkuLevel element

Sku.MaxReceipt Replaced by SkuLevel element



Sku.AverageCost Replaced by SkuCost element

PaymentHeader.VatCodeGid

PaymentHeader.VatRate

PaymentHeader.VatAmount

Replaced by VatAnalysis element

CommonInvoiceLineElements.VatCodeGid

CommonInvoiceLineElements.VatRate

CommonInvoiceLineElements.VatAmount

CommonInvoiceLineElements.VatCalcAmount

CommonInvoiceLineElements.VatOverrideAmount

Replaced by the LineItemVat element.

Note: The VatCodeGid element is being specified as the Quick Invoice Line Vat Code, which will be

used by the invoice action to manually calculate the VAT. If the VatCodeGid element is specified by itself, it will be used as such. If it is specified with

any of the other elements, it will be mapped to the LineItemVat element.

For Release 4.5

ShipmentHeader.TotalShippingSpaces

ShipmentOrderRelease.ShippingSpaces

ShipmentOrderRelease.IsFixedShippingSpaces

The term ShippingSpaces has been replaced by ReferenceUnits to generalize the functionality and have it apply to several client implementations. It is used to refer to “PALLET SPACES”, “POINT”, or “LOAD METERS”. (Re: PALLET)

Packaging.PackageShipUnitSpecRef This has been replaced by the Packaging.PackagedItemSpecRef for consistency.

(Re: PKG)

Packaging.PackageShipUnitWeight This has been replaced by the Packaging.PackageShipUnitWeightVolume which contains both the weight and volume. (Re: PKG)

Packaging.PackagePrimarySpecRef This has been replaced by the InnerPackInfo element. (Re: PKG)

Packaging.PackagePrimarySize This has been replaced by the InnerPackInfo element. (Re: PKG)

Packaging.PackagePrimaryQuantity This has been replaced by the InnerPackInfo element. (Re: PKG)

PackagingShipUnit.PackageHandlingUnitSpecRef This has been replaced by TransportHandlingUnitRef (Re: PKG)

Location.SubstituteLocationGid This has been replaced by the SubstituteLocation

element (Re: 35234.4.5)



TransOrderLine.PackageHandlingUnitSpecRef This has been replaced by TransportHandlingUnitRef (Re: PKG)

ShipUnit.ShipUnitSpecGid This has been replaced by the TransportHandlingUnitRef (Re: PKG)

ShipmentLink.PrevShipmentGid This has been replaced by PrevObjectGid. (Re: ORDMVMT)

ShipmentLink.NextShipmentGid This has been replaced by NextObjectGid. (Re: ORDMVMT)

SStatuShipUnitContent.PackageShipUnitSpecGid This has been replaced by PackagedItemSpecGid (Re: PKG)

BilledRated.ShipUnitSpecGid This has been replaced by TransportHandlingUnitRef within CommonInvoiceLineElements.BilledRated and PackagedItemSpecRef element in

PaymentSummaryDetail.BilledRated. (Re: PKG)

CommercialInvoiceData.ShipUnitSpecGid This has been replaced by CommercialInvoiceData.PackagedItemSpecRef (Re: PKG)

PaymentSummary.ShipUnitSpecGid This has been replaced by TransportHandlingUnitRef (Re: PKG)

For Release 4.0

AllocationBase.Allocation

AllocationBase.AllocationDetail

Replaced by AllocReleaseDetail and AllocReleaseLineDetail

Location.PlanFromLocationGid Replaced by SubstituteLocationGid