1.
Integration Overview
The Oracle Transportation Management (OTM) and Global Trade Management (GTM) suite
of products
use XML messages to interface with external applications.
OTM and GTM have separate interfaces for processing different messages. For
example, the
Transportation Orders (TransOrder) interface receives transportation order messages
from an
external application into OTM. This is referred to as an inbound interface. The
outbound interfaces
send messages from the OTM/GTM application to other external applications. For
example, shipments
planned from Orders in OTM can be sent in a PlannedShipment message to another
system for
additional processing.
The valid formats of all messages are described by XML Schema Definitions (XSD)
documents.
This document will describe the following:-
The purpose of each XSD and the available messages defined by it.
The application level message protocol describing the process of message
exchange.
The transport level protocols supported for inbound and outbound message
communication.
2. Understanding the Integration Schemas
This section will describe the overall format and design of the Integration XML
Schema Definition
(XSD) schemas for use when implementing interfaces.
Definitions
The following definitions are used widely in the remainder of the document and
deserve detailed
explanation of their exact meaning.
Term Definition
Global element/type/attribute This is an XSD definition which is an immediate
child of the <xsd:schema> document element.
Local element/type/attribute This is an XSD definition that is contained within a
parent definition e.g. an element definition within
a named complex type.
Local reference This refers to using the ‘ref=’ attribute to
reference a global element definition i.e. as
opposed to a Local element definition.
For mainly historical reasons, the vast majority of Integration Schema definitions
are defined as Global
element definitions and are referenced from local references within other element
or type definitions.
This is in contrast to the current best practice where Global element definitions
should only be used to
define XML fragments that can exist sensibly as isolated documents (referred to as
‘Primary
Documents’ in this documentation) or as targets for substitution groups. Therefore
it is important to
read and understand the following section – Primary XML Documents – which will
identify and describe
those Global elements intended to be used as XML documents for interface messaging.
The OTM/GTM XML Schemas
The OTM/GTM XML schemas define the data elements that the system sends or receives
for each type
of interface.
The GLogXML schema defines the Transmission related messages and the interface
transaction
formats, contained in the Transmission, which would be sent to Oracle
Transportation Management.
Note: Both the XML schema and the online help describes each element. The XML
Element
Dictionary, which is distributed with documentation, contains definitions of each
element.
The GLogXML-GTM schema describes the interface transaction formats, also contained
in a
Transmission, but which would be sent to Oracle Global Trade Management.
The Mobile Message Schema defines the format in which you send mobile device
messages.
The Common Schema defines some common data types that are currently only used by
the Message
Schema but are intended for future use.
W3C XML Schema Version
All schema files conform to the W3C XML Schema standard (see
[Link]
defined by the following namespace name:
xmlns:xsd=”[Link]
XML Schema Namespaces
Each XML schema is defined with a specific target namespace. The following table
lists the current
target namespaces and associated physical file name for each schema:
Schema XSD Schema File Namespace
GLogXML Schema [Link] [Link]
Mobile Message Schema [Link] [Link]
GLogXML-GTM Schema [Link] [Link]
Common Schema [Link] [Link]
All XML transmissions sent inbound to Oracle Transportation Management SHOULD
correctly use
namespace names as defined by the XML schemas listed above. However, for backward
compatibility,
interface transmissions are not REQUIRED to specify the namespace in the XML
(except when using
inbound web services; see section 12 Oracle Transportation Management Web
Services). Please note
that this support is DEPRECATED and will be removed in the next major release of
Oracle
Transportation Management after which time valid namespace names will be REQUIRED.
When XML documents are sent outbound from Oracle Transportation Management, the
namespace
attribute is specified by default. See Section: Excluding Namespace Names in
Outbound Interfaces for
details on how this can be configured.
XML Schema Changes
All changes to XSD documents for a particular release are described in the XML
Interface Changes
Guide document.
Viewing the XML Schemas
The schema files can be obtained from the following User Interface menu location:-
Business Process Automation > Integration > Integration Manager > Retrieve Schemas
When integrating to Oracle Transportation Management using XML, you must create
documents that
follow the structure and rules of the Oracle Transportation Management XML schemas.
We recommend
that you use an XML management tool to view the schema files. This will help in
understanding the
Oracle Transportation Management and Global Trade Management data elements and
relationships.
The W3C XML Schema site ([Link] provides links to several
such tools. The
examples in this document use the freely available Oracle XSD Visual Editor which
is a built-in part of
the JDeveloper IDE (see
[Link] for
details.)
For a full description of the Visual Editor tool please see Developing Applications
Using XML in the
Oracle Fusion Middleware User’s Guide for JDeveloper online documentation
([Link]
Common Schema Elements and Types
Global IDs (GIDs)
GIDs are global identifiers that Oracle Transportation Management uses to define
various types of
information (e.g., orders, shipments, locations, payment vouchers, etc.). A GID
consists of the
following two parts:
Domain name: Typically identifies a company and is used to separate data and
secure it from
other data in a shared, web-based environment. For example, if you are using Oracle
Transportation Management in an environment where many companies may be using the
same Oracle Transportation Management installation, the domain allows you to
isolate data in
Oracle Transportation Management for each company. Therefore, many users from
different
companies can work in the same Oracle Transportation Management installation (or
web site)
and use data that is private and specific to their company. If you do not include a
domain
name in a GID, it can be viewed across all domains in your system.
External ID (XID): The ID that defines the item on the external system. An
external system
is any system other than Oracle Transportation Management.
Note: You should not create GIDs with trailing spaces, as these records will not be
able to
be looked up via the UI.
The GLogXML and GLogXML-GTM schemas use a containment model for specifying
instances of GID
data types whereas the Message schema uses a more concise reference type. The
former design was
due in most part to concerns of interoperability as it did not depend on
sophisticated (at the time) use
of XSD schemas. It is anticipated that in the near future the GLogXML and GLogXML-
GTM schemas will
migrate to also use a reference type.
Containment Model example
The following is an example of a GID – LocationGid – which uses containment.
