U.S. patent application number 13/340510 was filed with the patent office on 2012-05-03 for managing consistent interfaces for business objects across heterogeneous systems.
Invention is credited to Oliver Dannat, Ruediger Fritz, Abhishek Gupta, Martin Janssen, Heidi Johann, Steve Mallack, Younus Mohammed, Ahmed Daddi Moussa, Elmar Paul, Kallu Vinay Kumar Reddy, Thomas Roesch, Dirk Schiebeler, Torsten Schmitt, Andreas Schoknecht, Michael Schweitzer, Shankar V.
Application Number | 20120109841 13/340510 |
Document ID | / |
Family ID | 41448620 |
Filed Date | 2012-05-03 |
United States Patent
Application |
20120109841 |
Kind Code |
A1 |
Moussa; Ahmed Daddi ; et
al. |
May 3, 2012 |
MANAGING CONSISTENT INTERFACES FOR BUSINESS OBJECTS ACROSS
HETEROGENEOUS SYSTEMS
Abstract
A business object model, which reflects data that is used during
a given business transaction, is utilized to generate interfaces.
This business object model facilitates commercial transactions by
providing consistent interfaces that are suitable for use across
industries, across businesses, and across different departments
within a business during a business transaction. In some
operations, software creates, updates, or otherwise processes
information related to a freight order, a maintenance plan, a
maintenance task list, a request for supplier freight quote, and/or
a supplier freight quote business object.
Inventors: |
Moussa; Ahmed Daddi;
(Edingen-Neckarhausen, DE) ; Dannat; Oliver;
(Walldorf, DE) ; Fritz; Ruediger; (Karlsruhe,
DE) ; Gupta; Abhishek; (Meerut, IN) ; Janssen;
Martin; (Binau, DE) ; Johann; Heidi;
(Sandhausen, DE) ; Mallack; Steve; (Mannheim,
DE) ; Mohammed; Younus; (Khammam, IN) ; Paul;
Elmar; (Angelbachtal, DE) ; Reddy; Kallu Vinay
Kumar; (Andhra Pradesh, IN) ; Roesch; Thomas;
(Sandhausen, DE) ; Schiebeler; Dirk; (Mannheim,
DE) ; Schmitt; Torsten; (Munich, DE) ;
Schoknecht; Andreas; (Linkenheim-Hochstetten, DE) ;
Schweitzer; Michael; (Leimen, DE) ; V; Shankar;
(Bangalore, IN) |
Family ID: |
41448620 |
Appl. No.: |
13/340510 |
Filed: |
December 29, 2011 |
Related U.S. Patent Documents
|
|
|
|
|
|
Application
Number |
Filing Date |
Patent Number |
|
|
12147449 |
Jun 26, 2008 |
|
|
|
13340510 |
|
|
|
|
Current U.S.
Class: |
705/332 |
Current CPC
Class: |
G06Q 10/08 20130101;
G06Q 10/0875 20130101; G06Q 10/0832 20130101; G06Q 40/12
20131203 |
Class at
Publication: |
705/332 |
International
Class: |
G06Q 30/00 20120101
G06Q030/00 |
Claims
1. A computer readable medium including program code for providing
a message-based interface for performing a freight order service,
the interface exposing at least one service as defined in a service
registry, wherein upon execution the program code executes in an
environment of computer systems providing message-based services
and comprises: program code for receiving, from a service consumer,
a first message for processing information representing an order to
a transportation service provider to ship goods from shippers to
consignees; program code for invoking a freight order business
object, wherein the business object is a logically centralized,
semantically disjointed object for representing an order to a
transportation service provider to ship goods from shippers to
consignees, and comprises data logically organized as: a freight
order root node; a date time periods subordinate node; a nature of
cargo subordinate node; a total quantity subordinate node; a total
amount subordinate node; a text collection subordinate node; a
business transaction document reference subordinate node and
wherein the business transaction document reference node contains a
date time period subordinate node; a governmental procedure
subordinate node and wherein the governmental procedure node
contains: a location subordinate node; a date time period
subordinate node; a seal subordinate node; a text collection
subordinate node; and a transportation document information
subordinate node and wherein the transportation document
information node contains a date time period subordinate node; a
party subordinate node and wherein the party node contains: a
business transaction document reference subordinate node and
wherein the business transaction document reference node contains a
date time period subordinate node; a transportation stage
subordinate node and wherein the transportation stage node
contains: a contact information subordinate node; a quantity
subordinate node; a party subordinate node and wherein the party
node contains: a transportation document information subordinate
node and wherein the transportation document information node
contains a date time period subordinate node; and a business
transaction document reference subordinate node and wherein the
business transaction document reference node contains a date time
period subordinate node; a location subordinate node and wherein
the location node contains a date time periods subordinate node; a
seal subordinate node; a text collection subordinate node; a
business transaction document reference subordinate node and
wherein the business transaction document reference node contains a
date time period subordinate node; and a transportation service
requirement subordinate node; a transportation unit resource
information subordinate node and wherein the transportation unit
resource information node contains: a transportation stage
assignment subordinate node; an attached equipment subordinate
node; a quantity subordinate node; a seal subordinate node; a
business transaction document reference subordinate node and
wherein the business transaction document reference node contains a
date time period subordinate node; a text collection subordinate
node; a party subordinate node; a location subordinate node and
wherein the location node contains a date time periods subordinate
node; and a dangerous goods subordinate node and wherein the
dangerous goods node contains: a contact information subordinate
node; and a text collection subordinate node; a transportation
charges information subordinate node and wherein the transportation
charges information node contains: a transportation charges
subordinate node and wherein the transportation charges node
contains: a location subordinate node and wherein the location node
contains a date time periods subordinate node; a text collection
subordinate node; a currency subordinate node; an exchange rate
subordinate node; a percent element subordinate node; a date time
period subordinate node; a business transaction document reference
subordinate node; a tax detail subordinate node; a payment
instruction subordinate node; a cash discount terms subordinate
node; and an element subordinate node and wherein the element node
contains a location subordinate node and wherein the location node
contains a date time periods subordinate node, a text collection
subordinate node, a currency subordinate node, a rate element
subordinate node, a percent element subordinate node, an amount
element subordinate node and wherein the amount element node
contains a rate detail assignment subordinate node, a calculation
base subordinate node, a tax detail subordinate node, a date time
period subordinate node, and a charge distribution subordinate
node; and a shipment order subordinate node and wherein the
shipment order node contains: a transportation stage assignment
subordinate node; a transportation unit resource information
assignment subordinate node; and a request subordinate node and
wherein the request node contains: a date time periods subordinate
node; a nature of cargo subordinate node; a total quantity
subordinate node; a total amount subordinate node; a text
collection subordinate node; a transportation service requirement
subordinate node; a transportation document information subordinate
node and wherein the transportation document information node
contains a date time period subordinate node; a business
transaction document reference subordinate node and wherein the
business transaction document reference node contains a date time
period subordinate node; a governmental procedure subordinate node
and wherein the governmental procedure node contains a location
subordinate node, a date time period subordinate node, a seal
subordinate node, a text collection subordinate node, and a
transportation document information subordinate node and wherein
the transportation document information node contains a date time
period subordinate node; a party subordinate node and wherein the
party node contains an amount subordinate node, a date time periods
subordinate node, a transportation document information subordinate
node and wherein the transportation document information node
contains a date time period subordinate node, and a business
transaction document reference subordinate node and wherein the
business transaction document reference node contains a date time
period subordinate node; a location subordinate node and wherein
the location node contains a date time periods subordinate node; a
transportation stage subordinate node and wherein the
transportation stage node contains a location subordinate node; a
transportation unit resource information subordinate node and
wherein the transportation unit resource information node contains
a seal subordinate node and wherein the seal node contains a
contact information subordinate node; a package information
subordinate node and wherein the package information node contains
an item assignment subordinate node, a transportation unit resource
information assignment subordinate node and wherein the
transportation unit resource information assignment node contains a
quantity subordinate node, a quantity subordinate node, and a text
collection subordinate node; an item subordinate node and wherein
the item node contains an amount subordinate node, a text
collection subordinate node, a nature of cargo subordinate node, a
quantity subordinate node, a transportation document information
subordinate node and wherein the transportation document
information node contains a date time period subordinate node, a
business transaction document reference subordinate node and
wherein the business transaction document reference node contains a
date time period subordinate node, a dangerous goods subordinate
node, a transportation stage assignment subordinate node and
wherein the transportation stage assignment node contains a
quantity subordinate node, a transportation unit resource
information assignment subordinate node and wherein the
transportation unit resource information assignment node contains a
quantity subordinate node, a governmental procedure subordinate
node, a party subordinate node and wherein the party node contains
a date time periods subordinate node, a location subordinate node
and wherein the location node contains a date time periods
subordinate node, a product information subordinate node, and a
transportation goods identification subordinate node; and a
transportation charges information subordinate node and wherein the
transportation charges information node contains a transportation
charges subordinate node; and program code for initiating
transmission of a message transmission of a message to a
heterogeneous second application, executing in the environment of
computer systems providing message-based services, based on the
data in the freight order business object, the message comprising a
freight order execution request message entity, a message header
package, and a freight order execution package.
2. A computer readable medium including program code for providing
a message-based interface for performing a freight order service,
the software comprising computer readable instructions embodied on
tangible media, wherein upon execution the software executes in a
landscape of computer systems providing message-based services and
comprises: program code for initiating transmission of a message to
a heterogeneous second application, executing in the environment of
computer systems providing message-based services, based on data in
a freight order business object invoked by the second application,
wherein the business object is a logically centralized,
semantically disjointed object for representing an order to a
transportation service provider to ship goods from shippers to
consignees and comprises data logically organized as: a freight
order root node; a date time periods subordinate node; a nature of
cargo subordinate node; a total quantity subordinate node; a total
amount subordinate node; a text collection subordinate node; a
business transaction document reference subordinate node and
wherein the business transaction document reference node contains a
date time period subordinate node; a governmental procedure
subordinate node and wherein the governmental procedure node
contains: a location subordinate node; a date time period
subordinate node; a seal subordinate node; a text collection
subordinate node; and a transportation document information
subordinate node and wherein the transportation document
information node contains a date time period subordinate node; a
party subordinate node and wherein the party node contains: a
business transaction document reference subordinate node and
wherein the business transaction document reference node contains a
date time period subordinate node; a transportation stage
subordinate node and wherein the transportation stage node
contains: a contact information subordinate node; a quantity
subordinate node; a party subordinate node and wherein the party
node contains: a transportation document information subordinate
node and wherein the transportation document information node
contains a date time period subordinate node; and a business
transaction document reference subordinate node and wherein the
business transaction document reference node contains a date time
period subordinate node; a location subordinate node and wherein
the location node contains a date time periods subordinate node; a
seal subordinate node; a text collection subordinate node; a
business transaction document reference subordinate node and
wherein the business transaction document reference node contains a
date time period subordinate node; and a transportation service
requirement subordinate node; a transportation unit resource
information subordinate node and wherein the transportation unit
resource information node contains: a transportation stage
assignment subordinate node; an attached equipment subordinate
node; a quantity subordinate node; a seal subordinate node; a
business transaction document reference subordinate node and
wherein the business transaction document reference node contains a
date time period subordinate node; a text collection subordinate
node; a party subordinate node; a location subordinate node and
wherein the location node contains a date time periods subordinate
node; and a dangerous goods subordinate node and wherein the
dangerous goods node contains: a contact information subordinate
node; and a text collection subordinate node; a transportation
charges information subordinate node and wherein the transportation
charges information node contains: a transportation charges
subordinate node and wherein the transportation charges node
contains: a location subordinate node and wherein the location node
contains a date time periods subordinate node; a text collection
subordinate node; a currency subordinate node; an exchange rate
subordinate node; a percent element subordinate node; a date time
period subordinate node; a business transaction document reference
subordinate node; a tax detail subordinate node; a payment
instruction subordinate node; a cash discount terms subordinate
node; and an element subordinate node and wherein the element node
contains a location subordinate node and wherein the location node
contains a date time periods subordinate node, a text collection
subordinate node, a currency subordinate node, a rate element
subordinate node, a percent element subordinate node, an amount
element subordinate node and wherein the amount element node
contains a rate detail assignment subordinate node, a calculation
base subordinate node, a tax detail subordinate node, a date time
period subordinate node, and a charge distribution subordinate
node; and a shipment order subordinate node and wherein the
shipment order node contains: a transportation stage assignment
subordinate node; a transportation unit resource information
assignment subordinate node; and a request subordinate node and
wherein the request node contains: a date time periods subordinate
node; a nature of cargo subordinate node; a total quantity
subordinate node; a total amount subordinate node; a text
collection subordinate node; a transportation service requirement
subordinate node; a transportation document information subordinate
node and wherein the transportation document information node
contains a date time period subordinate node; a business
transaction document reference subordinate node and wherein the
business transaction document reference node contains a date time
period subordinate node; a governmental procedure subordinate node
and wherein the governmental procedure node contains a location
subordinate node, a date time period subordinate node, a seal
subordinate node, a text collection subordinate node, and a
transportation document information subordinate node and wherein
the transportation document information node contains a date time
period subordinate node; a party subordinate node and wherein the
party node contains an amount subordinate node, a date time periods
subordinate node, a transportation document information subordinate
node and wherein the transportation document information node
contains a date time period subordinate node, and a business
transaction document reference subordinate node and wherein the
business transaction document reference node contains a date time
period subordinate node; a location subordinate node and wherein
the location node contains a date time periods subordinate node; a
transportation stage subordinate node and wherein the
transportation stage node contains a location subordinate node; a
transportation unit resource information subordinate node and
wherein the transportation unit resource information node contains
a seal subordinate node and wherein the seal node contains a
contact information subordinate node; a package information
subordinate node and wherein the package information node contains
an item assignment subordinate node, a transportation unit resource
information assignment subordinate node and wherein the
transportation unit resource information assignment node contains a
quantity subordinate node, a quantity subordinate node, and a text
collection subordinate node; an item subordinate node and wherein
the item node contains an amount subordinate node, a text
collection subordinate node, a nature of cargo subordinate node, a
quantity subordinate node, a transportation document information
subordinate node and wherein the transportation document
information node contains a date time period subordinate node, a
business transaction document reference subordinate node and
wherein the business transaction document reference node contains a
date time period subordinate node, a dangerous goods subordinate
node, a transportation stage assignment subordinate node and
wherein the transportation stage assignment node contains a
quantity subordinate node, a transportation unit resource
information assignment subordinate node and wherein the
transportation unit resource information assignment node contains a
quantity subordinate node, a governmental procedure subordinate
node, a party subordinate node and wherein the party node contains
a date time periods subordinate node, a location subordinate node
and wherein the location node contains a date time periods
subordinate node, a product information subordinate node, and a
transportation goods identification subordinate node; and a
transportation charges information subordinate node and wherein the
transportation charges information node contains a transportation
charges subordinate node; and and the message comprising a freight
order execution request message entity, a message header package,
and a freight order execution package; and program code for
receiving a second message from the second application, the second
message associated with the invoked freight order business object
and in response to the first message.
3. A distributed system operating in a landscape of computer
systems providing message-based services, the system processing
business objects involving a freight order and comprising: memory
storing a business object repository storing a plurality of
business objects; wherein each business object is a logically
centralized, semantically disjointed object and at least one of the
business objects is for representing an order to a transportation
service provider to ship goods from shippers to consignees and
comprises data logically organized as: a freight order root node; a
date time periods subordinate node; a nature of cargo subordinate
node; a total quantity subordinate node; a total amount subordinate
node; a text collection subordinate node; a business transaction
document reference subordinate node and wherein the business
transaction document reference node contains a date time period
subordinate node; a governmental procedure subordinate node and
wherein the governmental procedure node contains: a location
subordinate node; a date time period subordinate node; a seal
subordinate node; a text collection subordinate node; and a
transportation document information subordinate node and wherein
the transportation document information node contains a date time
period subordinate node; a party subordinate node and wherein the
party node contains: a business transaction document reference
subordinate node and wherein the business transaction document
reference node contains a date time period subordinate node; a
transportation stage subordinate node and wherein the
transportation stage node contains: a contact information
subordinate node; a quantity subordinate node; a party subordinate
node and wherein the party node contains: a transportation document
information subordinate node and wherein the transportation
document information node contains a date time period subordinate
node; and a business transaction document reference subordinate
node and wherein the business transaction document reference node
contains a date time period subordinate node; a location
subordinate node and wherein the location node contains a date time
periods subordinate node; a seal subordinate node; a text
collection subordinate node; a business transaction document
reference subordinate node and wherein the business transaction
document reference node contains a date time period subordinate
node; and a transportation service requirement subordinate node; a
transportation unit resource information subordinate node and
wherein the transportation unit resource information node contains:
a transportation stage assignment subordinate node; an attached
equipment subordinate node; a quantity subordinate node; a seal
subordinate node; a business transaction document reference
subordinate node and wherein the business transaction document
reference node contains a date time period subordinate node; a text
collection subordinate node; a party subordinate node; a location
subordinate node and wherein the location node contains a date time
periods subordinate node; and a dangerous goods subordinate node
and wherein the dangerous goods node contains: a contact
information subordinate node; and a text collection subordinate
node; a transportation charges information subordinate node and
wherein the transportation charges information node contains: a
transportation charges subordinate node and wherein the
transportation charges node contains: a location subordinate node
and wherein the location node contains a date time periods
subordinate node; a text collection subordinate node; a currency
subordinate node; an exchange rate subordinate node; a percent
element subordinate node; a date time period subordinate node; a
business transaction document reference subordinate node; a tax
detail subordinate node; a payment instruction subordinate node; a
cash discount terms subordinate node; and an element subordinate
node and wherein the element node contains a location subordinate
node and wherein the location node contains a date time periods
subordinate node, a text collection subordinate node, a currency
subordinate node, a rate element subordinate node, a percent
element subordinate node, an amount element subordinate node and
wherein the amount element node contains a rate detail assignment
subordinate node, a calculation base subordinate node, a tax detail
subordinate node, a date time period subordinate node, and a charge
distribution subordinate node; and a shipment order subordinate
node and wherein the shipment order node contains: a transportation
stage assignment subordinate node; a transportation unit resource
information assignment subordinate node; and a request subordinate
node and wherein the request node contains: a date time periods
subordinate node; a nature of cargo subordinate node; a total
quantity subordinate node; a total amount subordinate node; a text
collection subordinate node; a transportation service requirement
subordinate node; a transportation document information subordinate
node and wherein the transportation document information node
contains a date time period subordinate node; a business
transaction document reference subordinate node and wherein the
business transaction document reference node contains a date time
period subordinate node; a governmental procedure subordinate node
and wherein the governmental procedure node contains a location
subordinate node, a date time period subordinate node, a seal
subordinate node, a text collection subordinate node, and a
transportation document information subordinate node and wherein
the transportation document information node contains a date time
period subordinate node; a party subordinate node and wherein the
party node contains an amount subordinate node, a date time periods
subordinate node, a transportation document information subordinate
node and wherein the transportation document information node
contains a date time period subordinate node, and a business
transaction document reference subordinate node and wherein the
business transaction document reference node contains a date time
period subordinate node; a location subordinate node and wherein
the location node contains a date time periods subordinate node; a
transportation stage subordinate node and wherein the
transportation stage node contains a location subordinate node; a
transportation unit resource information subordinate node and
wherein the transportation unit resource information node contains
a seal subordinate node and wherein the seal node contains a
contact information subordinate node; a package information
subordinate node and wherein the package information node contains
an item assignment subordinate node, a transportation unit resource
information assignment subordinate node and wherein the
transportation unit resource information assignment node contains a
quantity subordinate node, a quantity subordinate node, and a text
collection subordinate node; an item subordinate node and wherein
the item node contains an amount subordinate node, a text
collection subordinate node, a nature of cargo subordinate node, a
quantity subordinate node, a transportation document information
subordinate node and wherein the transportation document
information node contains a date time period subordinate node, a
business transaction document reference subordinate node and
wherein the business transaction document reference node contains a
date time period subordinate node, a dangerous goods subordinate
node, a transportation stage assignment subordinate node and
wherein the transportation stage assignment node contains a
quantity subordinate node, a transportation unit resource
information assignment subordinate node and wherein the
transportation unit resource information assignment node contains a
quantity subordinate node, a governmental procedure subordinate
node, a party subordinate node and wherein the party node contains
a date time periods subordinate node, a location subordinate node
and wherein the location node contains a date time periods
subordinate node, a product information subordinate node, and a
transportation goods identification subordinate node; and a
transportation charges information subordinate node and wherein the
transportation charges information node contains a transportation
charges subordinate node; and a graphical user interface remote
from the memory for presenting data associated with an invoked
instance of the freight order business object, the interface
comprising computer readable instructions embodied on tangible
media.
4. A computer readable medium including program code for providing
a message-based interface for performing a maintenance plan
service, the interface exposing at least one service as defined in
a service registry, wherein upon execution the program code
executes in an environment of computer systems providing
message-based services and comprises: program code for receiving,
from a service consumer, a first message for processing maintenance
plans; program code for invoking a maintenance plan business
object, wherein the business object is a logically centralized,
semantically disjointed object for representing information used to
manage maintenance plans, and comprises data logically organized
as: a maintenance plan root node; a scheduling terms subordinate
node; a cycles subordinate node; a maintenance plan item
subordinate node and wherein the maintenance plan item node
contains: an object reference subordinate node; and an accounting
coding block subordinate node; and an item cycle group assignment
subordinate node; and program code for initiating transmission of a
message transmission of a message to a heterogeneous second
application, executing in the environment of computer systems
providing message-based services, based on the data in the
maintenance plan business object, the message comprising a
maintenance plan create confirmation message entity, a message
header package, a maintenance plan package, and a log package.
5. A computer readable medium including program code for providing
a message-based interface for performing a maintenance task list
service, the interface exposing at least one service as defined in
a service registry, wherein upon execution the program code
executes in an environment of computer systems providing
message-based services and comprises: program code for receiving,
from a service consumer, a first message for processing maintenance
task lists; program code for invoking a maintenance task list
business object, wherein the business object is a logically
centralized, semantically disjointed object for representing
information used to manage maintenance task lists, and comprises
data logically organized as: a maintenance task list root node; and
an operation subordinate node and wherein the operation node
contains: a relationship subordinate node; and a material input
subordinate node; and program code for initiating transmission of a
message transmission of a message to a heterogeneous second
application, executing in the environment of computer systems
providing message-based services, based on the data in the
maintenance task list business object, the message comprising a
maintenance task list simple by elements response message entity, a
maintenance task list package, a processing conditions package, and
a log package.
6. A computer readable medium including program code for providing
a message-based interface for performing a request for supplier
freight quote service, the interface exposing at least one service
as defined in a service registry, wherein upon execution the
program code executes in an environment of computer systems
providing message-based services and comprises: program code for
receiving, from a service consumer, a first message for processing
information for requesting a freight quote from a supplier,
including terms and conditions of a transportation service and
bidding rules of the tendering process; program code for invoking a
request for supplier freight quote business object, wherein the
business object is a logically centralized, semantically disjointed
object for representing information for requesting a freight quote
from a supplier, including terms and conditions of a transportation
service and bidding rules of the tendering process, and comprises
data logically organized as: a request for supplier freight quote
root node; a date time periods subordinate node; a nature of cargo
subordinate node; a total quantity subordinate node; a total amount
subordinate node; a text collection subordinate node; a business
transaction document reference subordinate node and wherein the
business transaction document reference node contains a date time
period subordinate node; a governmental procedure subordinate node
and wherein the governmental procedure node contains: a location
subordinate node; a date time period subordinate node; a text
collection subordinate node; and a transportation document
information subordinate node and wherein the transportation
document information node contains a date time period subordinate
node; a party subordinate node and wherein the party node contains:
a business transaction document reference subordinate node and
wherein the business transaction document reference node contains a
date time period subordinate node; a transportation stage
subordinate node and wherein the transportation stage node
contains: a contact information subordinate node; a quantity
subordinate node; a party subordinate node and wherein the party
node contains: a transportation document information subordinate
node and wherein the transportation document information node
contains a date time period subordinate node; and a business
transaction document reference subordinate node and wherein the
business transaction document reference node contains a date time
period subordinate node; a location subordinate node and wherein
the location node contains a date time periods subordinate node; a
text collection subordinate node; a business transaction document
reference subordinate node and wherein the business transaction
document reference node contains a date time period subordinate
node; and a transportation service requirement subordinate node; a
transportation unit resource information subordinate node and
wherein the transportation unit resource information node contains:
a transportation stage assignment subordinate node; an attached
equipment subordinate node; a quantity subordinate node; a business
transaction document reference subordinate node and wherein the
business transaction document reference node contains a date time
period subordinate node; a text collection subordinate node; a
party subordinate node; a location subordinate node and wherein the
location node contains a date time periods subordinate node; and a
dangerous goods subordinate node and wherein the dangerous goods
node contains: a contact information subordinate node; and a text
collection subordinate node; a transportation charges information
subordinate node and wherein the transportation unit resource
information node contains: a transportation charges subordinate
node and wherein the transportation charges node contains: a
location subordinate node and wherein the location node contains a
date time periods subordinate node; a text collection subordinate
node; a currency subordinate node; an exchange rate subordinate
node; a percent element subordinate node; a date time period
subordinate node; a business transaction document reference
subordinate node; a tax detail subordinate node; a payment
instruction subordinate node; a cash discount terms subordinate
node; and an element subordinate node and wherein the element node
contains a location subordinate node and wherein the location node
contains a date time periods subordinate node, a text collection
subordinate node, a currency subordinate node, a rate element
subordinate node, a percent element subordinate node, an amount
element subordinate node and wherein the amount element node
contains a rate detail assignment subordinate node, a calculation
base subordinate node, a tax detail subordinate node, a date time
period subordinate node, and a cost distribution subordinate node;
and a request for supplier shipment quote subordinate node and
wherein the request for supplier shipment quote node contains: a
transportation stage assignment subordinate node; a transportation
unit resource information assignment subordinate node; a date time
periods subordinate node; a nature of cargo subordinate node; a
total quantity subordinate node; a total amount subordinate node; a
text collection subordinate node; a transportation service
requirement subordinate node; a transportation document information
subordinate node and wherein the transportation document
information node contains a date time period subordinate node; a
business transaction document reference subordinate node and
wherein the business transaction document reference node contains a
date time period subordinate node; a governmental procedure
subordinate node and wherein the governmental procedure node
contains: a location subordinate node; a date time period
subordinate node; a text collection subordinate node; and a
transportation document information subordinate node and wherein
the transportation document information node contains a date time
period subordinate node; a party subordinate node and wherein the
party node contains: an amount subordinate node; a date time
periods subordinate node; a transportation document information
subordinate node and wherein the transportation document
information node contains a date time period subordinate node; and
a business transaction document reference subordinate node and
wherein the business transaction document reference node contains a
date time period subordinate node; a location subordinate node and
wherein the location node contains a date time periods subordinate
node; a transportation stage subordinate node and wherein the
transportation stage node contains: a location subordinate node and
wherein the location node contains a date time periods subordinate
node; a business transaction document reference subordinate node
and wherein the business transaction document reference node
contains a date time period subordinate node; and a transportation
service requirement subordinate node; a transportation unit
resource information subordinate node and wherein the
transportation unit resource information node contains: a
transportation stage assignment subordinate node; an attached
equipment subordinate node; a quantity subordinate node; a business
transaction document reference subordinate node and wherein the
business transaction document reference node contains a date time
period subordinate node; a text collection subordinate node; a
location subordinate node and wherein the location node contains a
date time periods subordinate node; and a dangerous goods
subordinate node and wherein the dangerous goods node contains a
contact information subordinate node and a text collection
subordinate node; a package information subordinate node and
wherein the package information node contains: an item assignment
subordinate node and wherein the item assignment node contains a
quantity subordinate node, a business transaction document
reference subordinate node and wherein the business transaction
document reference node contains a date time period subordinate
node, and a transportation goods identification subordinate node; a
transportation unit resource information assignment subordinate
node and wherein the transportation unit resource information
assignment node contains a quantity subordinate node; a quantity
subordinate node; and a text collection subordinate node; an item
subordinate node and wherein the item node contains: an amount
subordinate node; a text collection subordinate node; a nature of
cargo subordinate node; a quantity subordinate node; a
transportation document information subordinate node and wherein
the transportation document information node contains a date time
period subordinate node; a business transaction document reference
subordinate node and wherein the business transaction document
reference node contains a date time period subordinate node; a
dangerous goods subordinate node and wherein the dangerous goods
node contains a contact information subordinate node, a quantity
subordinate node, a text collection subordinate node, and a
transportation unit resource information assignment subordinate
node and wherein the transportation unit resource information
assignment node contains a quantity subordinate node; a
transportation stage assignment subordinate node and wherein the
transportation stage assignment node contains a quantity
subordinate node; a transportation unit resource information
assignment subordinate node and wherein the transportation unit
resource information assignment node contains a quantity
subordinate node; a governmental procedure subordinate node and
wherein the governmental procedure node contains a location
subordinate node, a date time period subordinate node, a text
collection subordinate node, and a transportation document
information subordinate node and wherein the transportation
document information node contains a date time period subordinate
node; a party subordinate node and wherein the party node contains
a date time periods subordinate node; a location subordinate node
and wherein the location node contains a date time periods
subordinate node; a product information subordinate node; and a
transportation goods identification subordinate node; and a
transportation charges information subordinate node and wherein the
transportation charges information node contains: a transportation
charges subordinate node and wherein the transportation charges
node contains a location subordinate node and wherein the location
node contains a date time periods subordinate node, a text
collection subordinate node, a currency subordinate node, an
exchange rate subordinate node, a percent element subordinate node,
a date time period subordinate node, a business transaction
document reference subordinate node, a tax detail subordinate node,
a payment instruction subordinate node, a cash discount terms
subordinate node, and an element subordinate node; and program code
for initiating transmission of a message transmission of a message
to a heterogeneous second application, executing in the environment
of computer systems providing message-based services, based on the
data in the request for supplier freight quote business object, the
message comprising a request for supplier freight quote request
message entity, a message header package, and a request for
supplier freight quote package.
7. The program code of claim 1, wherein processing includes
creating, updating and/or retrieving.
8. The program code of claim 1, wherein the item assignment node of
the package information node contains a quantity subordinate node,
a business transaction document reference subordinate node and
wherein the business transaction document reference node contains a
date time period subordinate node, and a transportation goods
identification subordinate node:
9. The program code of claim 1, wherein: the dangerous goods node
of the item node contains a contact information subordinate node, a
quantity subordinate node, a text collection subordinate node, and
a transportation unit recourse information assignment subordinate
node; and the governmental procedure node of the item node contains
a location subordinate node a date time period subordinate node, a
seal subordinate node, a text collection subordinate node, and a
transportation document information subordinate node and wherein
the transportation document information node contains a date time
period subordinate node.
10. The program code of claim 1, wherein the transportation charges
node of the transportation charges information node contains a
location subordinate node and wherein the location node contains a
date time periods subordinate node, a text collection subordinate
node, a currency subordinate node, an exchange rate subordinate
node, a percent element subordinate node, a date time period
subordinate node, a business transaction document reference
subordinate node, a tax detail subordinate node, a payment
instruction subordinate node, a cash discount terms subordinate
node, and an element subordinate node and wherein the element node
contains a location subordinate node and wherein the location node
contains a date time periods subordinate node, a text collection
subordinate node, a currency subordinate node, a rate element
subordinate node, a percent element subordinate node, an amount
element subordinate node and wherein the amount element node
contains a rate element assignment subordinate node, a calculation
base subordinate node, a tax detail subordinate node, a date time
period subordinate node, and a cost distribution subordinate node.
Description
CROSS-REFERENCE TO RELATED APPLICATION
[0001] This application is a continuation application of and claims
priority to U.S. application Ser. No. 12/147,449, filed on Jun. 26,
2008, the entire disclosure of which is incorporated herein by
reference.
TECHNICAL FIELD
[0002] The subject matter described herein relates generally to the
generation and use of consistent interfaces (or services) derived
from a business object model. More particularly, the present
disclosure relates to the generation and use of consistent
interfaces or services that are suitable for use across industries,
across businesses, and across different departments within a
business.
BACKGROUND
[0003] Transactions are common among businesses and between
business departments within a particular business. During any given
transaction, these business entities exchange information. For
example, during a sales transaction, numerous business entities may
be involved, such as a sales entity that sells merchandise to a
customer, a financial institution that handles the financial
transaction, and a warehouse that sends the merchandise to the
customer. The end-to-end business transaction may require a
significant amount of information to be exchanged between the
various business entities involved. For example, the customer may
send a request for the merchandise as well as some form of payment
authorization for the merchandise to the sales entity, and the
sales entity may send the financial institution a request for a
transfer of funds from the customer's account to the sales entity's
account.
[0004] Exchanging information between different business entities
is not a simple task. This is particularly true because the
information used by different business entities is usually tightly
tied to the business entity itself. Each business entity may have
its own program for handling its part of the transaction. These
programs differ from each other because they typically are created
for different purposes and because each business entity may use
semantics that differ from the other business entities. For
example, one program may relate to accounting, another program may
relate to manufacturing, and a third program may relate to
inventory control. Similarly, one program may identify merchandise
using the name of the product while another program may identify
the same merchandise using its model number. Further, one business
entity may use U.S. dollars to represent its currency while another
business entity may use Japanese Yen. A simple difference in
formatting, e.g., the use of upper-case lettering rather than
lower-case or title-case, makes the exchange of information between
businesses a difficult task. Unless the individual businesses agree
upon particular semantics, human interaction typically is required
to facilitate transactions between these businesses. Because these
"heterogeneous" programs are used by different companies or by
different business areas within a given company, a need exists for
a consistent way to exchange information and perform a business
transaction between the different business entities.
[0005] Currently, many standards exist that offer a variety of
interfaces used to exchange business information. Most of these
interfaces, however, apply to only one specific industry and are
not consistent between the different standards. Moreover, a number
of these interfaces are not consistent within an individual
standard.
SUMMARY
[0006] In a first aspect, computer readable medium includes program
code for providing a message-based interface for performing a
freight order service. The interface exposes at least one service
as defined in a service registry. Upon execution, the program code
executes in an environment of computer systems providing
message-based services. The service comprises program code for
receiving, from a service consumer, a first message for processing
information representing an order to a transportation service
provider to ship goods from shippers to consignees. Program code
invokes a freight order business object. The business object is a
logically centralized, semantically disjointed object for
representing an order to a transportation service provider to ship
goods from shippers to consignees. The business object comprises
data logically organized as a freight order root node and a date
time periods subordinate node. Program code initiates transmission
of a message to a heterogeneous second application, executing in
the environment of computer systems providing message-based
services, based on the data in the freight order business object.
The message comprises a freight order execution request message
entity, a message header package, and a freight order execution
package.
[0007] In a second aspect, computer readable medium includes
program code for providing a message-based interface for performing
a freight order service. The software comprises computer readable
instructions embodied on tangible media. Upon execution, the
software executes in a landscape of computer systems providing
message-based services. The software comprises program code for
initiating transmission of a message to a heterogeneous second
application, executing in the environment of computer systems
providing message-based services, based on data in a freight order
business object invoked by the second application. The business
object is a logically centralized, semantically disjointed object
for representing an order to a transportation service provider to
ship goods from shippers to consignees. The business object
comprises data logically organized as a freight order root node and
a date time periods subordinate node. The message comprises a
freight order execution request message entity, a message header
package, and a freight order execution package. The software
comprises program code for receiving a second message from the
second application. The second message is associated with the
invoked freight order business object and in response to the first
message.
[0008] In a third aspect, a distributed system operates in a
landscape of computer systems providing message-based services. The
system processes business objects involving a freight order. The
system comprises memory and a graphical user interface remote from
the memory. The memory stores a business object repository storing
a plurality of business objects. Each business object is a
logically centralized, semantically disjointed object. At least one
of the business objects is for representing an order to a
transportation service provider to ship goods from shippers to
consignees. The business object comprises data logically organized
as a freight order root node and a date time periods subordinate
node. The graphical user interface presents data associated with an
invoked instance of the freight order business object. The
interface comprises computer readable instructions embodied on
tangible media.
[0009] In a fourth aspect, a computer readable medium includes
program code for providing a message-based interface for performing
a maintenance plan service. The interface exposes at least one
service as defined in a service registry. Upon execution, the
program code executes in an environment of computer systems
providing message-based services. The service comprises program
code for receiving, from a service consumer, a first message for
processing maintenance plans. Program code invokes a maintenance
plan business object. The business object is a logically
centralized, semantically disjointed object for representing
information used to manage maintenance plans. The service comprises
data logically organized as a maintenance plan root node, a
scheduling terms subordinate node, a cycles subordinate node, and a
maintenance plan item subordinate node. The maintenance plan item
node contains an object reference subordinate node, an accounting
coding block subordinate node, and an item cycle group assignment
subordinate node. Program code initiates transmission of a message
to a heterogeneous second application, executing in the environment
of computer systems providing message-based services, based on the
data in the maintenance plan business object. The message comprises
a maintenance plan create confirmation message entity, a message
header package, a maintenance plan package, and a log package.
[0010] In a fifth aspect, a computer readable medium includes
program code for providing a message-based interface for performing
a maintenance plan service. The software comprises computer
readable instructions embodied on tangible media. Upon execution,
the software executes in a landscape of computer systems providing
message-based services. The service comprises program code for
initiating transmission of a message to a heterogeneous second
application, executing in the environment of computer systems
providing message-based services, based on data in a maintenance
plan business object invoked by the second application. The
business object is a logically centralized, semantically disjointed
object for representing information used to manage maintenance
plans. The business object comprises data logically organized as a
maintenance plan root node, a scheduling terms subordinate node, a
cycles subordinate node, and a maintenance plan item subordinate
node. The maintenance plan item node contains an object reference
subordinate node, an accounting coding block subordinate node, and
an item cycle group assignment subordinate node. The message
comprises a maintenance plan create confirmation message entity, a
message header package, a maintenance plan package, and a log
package. Program code receives a second message from the second
application, the second message associated with the invoked
maintenance plan business object and in response to the first
message.
[0011] In a sixth aspect, a distributed system operates in a
landscape of computer systems providing message-based services. The
system processes business objects involving a maintenance plan
service. The service comprises memory and a graphical user
interface remote from the memory. Memory stores a business object
repository storing a plurality of business objects. Each business
object is a logically centralized, semantically disjointed object
and at least one of the business objects is for representing
information used to manage maintenance plans. The business object
comprises data logically organized as a maintenance plan root node,
a scheduling terms subordinate node, a cycles subordinate node, and
a maintenance plan item subordinate node. The maintenance plan item
node contains an object reference subordinate node, an accounting
coding block subordinate node, and an item cycle group assignment
subordinate node. The graphical user interface presents data
associated with an invoked instance of the maintenance plan
business object, the interface comprising computer readable
instructions embodied on tangible media.
[0012] In a seventh aspect, a computer readable medium includes
program code for providing a message-based interface for performing
a maintenance task list service. The interface exposes at least one
service as defined in a service registry. Upon execution, the
program code executes in an environment of computer systems
providing message-based services. The service comprises program
code for receiving, from a service consumer, a first message for
processing maintenance task lists. Program code invokes a
maintenance task list business object. The business object is a
logically centralized, semantically disjointed object for
representing information used to manage maintenance task lists. The
business object comprises data logically organized as a maintenance
task list root node, an operation subordinate node, a relationship
subordinate node, and a material input subordinate node. Program
code initiates transmission of a message to a heterogeneous second
application, executing in the environment of computer systems
providing message-based services, based on the data in the
maintenance task list business object. The message comprises a
maintenance task list simple by elements response message entity, a
maintenance task list package, a processing conditions package, and
a log package.
[0013] In an eighth aspect, a computer readable medium includes
program code for providing a message-based interface for performing
a maintenance task list service. The software comprises computer
readable instructions embodied on tangible media. Upon execution
the software executes in a landscape of computer systems providing
message-based services. The service comprises program code for
initiating transmission of a message to a heterogeneous second
application, executing in the environment of computer systems
providing message-based services, based on data in a maintenance
task list business object invoked by the second application. The
business object is a logically centralized, semantically disjointed
object for representing information used to manage maintenance task
lists. The business object comprises data logically organized as a
maintenance task list root node, an operation subordinate node, a
relationship subordinate node, and a material input subordinate
node. The message comprises a maintenance task list simple by
elements response message entity, a maintenance task list package,
a processing conditions package, and a log package. Program code
receives a second message from the second application, the second
message associated with the invoked maintenance task list business
object and in response to the first message.
[0014] In a ninth aspect, a distributed system operates in a
landscape of computer systems providing message-based services. The
system processes business objects involving a maintenance task list
service. The service comprises memory and a graphical user
interface remote from the memory. Memory stores a business object
repository storing a plurality of business objects. Each business
object is a logically centralized, semantically disjointed object
and at least one of the business objects is for representing
information used to manage maintenance task lists. The business
object comprises data logically organized as a maintenance task
list root node, an operation subordinate node, a relationship
subordinate node, and a material input subordinate node. The
graphical user interface presents data associated with an invoked
instance of the maintenance task list business object, the
interface comprising computer readable instructions embodied on
tangible media.
[0015] In a tenth aspect, computer readable medium includes program
code for providing a message-based interface for performing a
request for supplier freight quote service. The interface exposes
at least one service as defined in a service registry. Upon
execution, the program code executes in an environment of computer
systems providing message-based services. The service comprises
program code for receiving, from a service consumer, a first
message for processing information for requesting a freight quote
from a supplier, including terms and conditions of a transportation
service and bidding rules of the tendering process. Program code
invokes a request for a supplier freight quote business object. The
business object is a logically centralized, semantically disjointed
object for representing information for requesting a freight quote
from a supplier, including terms and conditions of a transportation
service and bidding rules of the tendering process. The business
object comprises data logically organized as a request for supplier
freight quote root node and at least one subordinate node,
including a nature of cargo subordinate node, each subordinate node
having zero or more hierarchically more structured subordinate
nodes. Program code initiates transmission of a message to a
heterogeneous second application, executing in the environment of
computer systems providing message-based services, based on the
data in the request for a supplier freight quote business object.
The message comprises a request for supplier freight quote request
message entity, a message header package, and a request for
supplier freight quote package.
[0016] In an eleventh aspect, computer readable medium includes
program code for providing a message-based interface for performing
a request for supplier freight quote service. The software
comprises computer readable instructions embodied on tangible
media. Upon execution, the software executes in a landscape of
computer systems providing message-based services. The software
comprises program code for initiating transmission of a message to
a heterogeneous second application, executing in the environment of
computer systems providing message-based services, based on data in
a request for supplier freight quote business object invoked by the
second application. The business object is a logically centralized,
semantically disjointed object for representing information for
requesting a freight quote from a supplier, including terms and
conditions of a transportation service and bidding rules of the
tendering process. The business object comprises data logically
organized as a request for supplier freight quote root node and at
least one subordinate node, including a nature of cargo subordinate
node, each subordinate node having zero or more hierarchically more
structured subordinate nodes. The message comprises a request for
supplier freight quote request message entity, a message header
package, and a request for supplier freight quote package. The
software comprises program code for receiving a second message from
the second application. The second message is associated with the
invoked request for supplier freight quote business object and in
response to the first message.
[0017] In a twelfth aspect, a distributed system operates in a
landscape of computer systems providing message-based services. The
system processes business objects involving a request for supplier
freight quote. The system comprises memory and a graphical user
interface remote from the memory. The memory stores a business
object repository storing a to plurality of business objects. Each
business object is a logically centralized, semantically disjointed
object. At least one of the business objects is for representing
information for requesting a freight quote from a supplier. The
business object comprises data logically organized as a request for
supplier freight quote root node and at least one subordinate node,
including a nature of cargo subordinate node, each subordinate node
having zero or more hierarchically more structured subordinate
nodes. The graphical user interface presents data associated with
an invoked instance of the request for supplier freight quote
business object. The interface comprises computer readable
instructions embodied on tangible media.
[0018] In a thirteenth aspect, computer readable medium includes
program code for providing a message-based interface for performing
a supplier freight quote service. The interface exposes at least
one service as defined in a service registry. Upon execution, the
program code executes in an environment of computer systems
providing message-based services. The service comprises program
code for receiving, from a service consumer, a first message for
processing information for transportation services tendered between
transportation service providers, including quoted services in
response to a request for a supplier freight quote. Program code
invokes a supplier freight quote business object. The business
object is a logically centralized, semantically disjointed object
for representing information for transportation services tendered
between transportation service providers, including quoted services
in response to a request for a supplier freight quote. The business
object comprises data logically organized as a supplier freight
quote root node and at least one subordinate node, including a
nature of cargo subordinate node, each subordinate node having zero
or more hierarchically more structured subordinate nodes. Program
code initiates transmission of a message to a heterogeneous second
application, executing in the environment of computer systems
providing message-based services, based on the data in the supplier
freight quote business object. The message comprises a supplier
freight quote request message entity, a message header package, and
a supplier freight quote package.
[0019] In a fourteenth aspect, computer readable medium includes
program code for providing a message-based interface for performing
a supplier freight quote service. The software comprises computer
readable instructions embodied on tangible media. Upon execution,
the software executes in a landscape of computer systems providing
message-based services. The software comprises program code for
initiating transmission of a message to a heterogeneous second
application, executing in the environment of computer systems
providing message-based services, based on data in a supplier
freight quote business object invoked by the second application.
The business object is a logically centralized, semantically
disjointed object for representing information for transportation
services tendered between transportation service providers,
including quoted services in response to a request for a supplier
freight quote. The business object comprises data logically
organized as a supplier freight quote root node and at least one
subordinate node, including a nature of cargo subordinate node,
each subordinate node having zero or more hierarchically more
structured subordinate nodes. The message comprises a supplier
freight quote request message entity, a message header package, and
a supplier freight quote package. The software comprises program
code for receiving a second message from the second application.
The second message is associated with the invoked supplier freight
quote business object and in response to the first message.
[0020] In a fifteenth aspect, a distributed system operates in a
landscape of computer systems providing message-based services. The
system processes business objects involving a supplier freight
quote. The system comprises memory and a graphical user interface
remote from the memory. The memory stores a business object
repository storing a plurality of business objects. Each business
object is a logically centralized, semantically disjointed object.
At least one of the business objects is for representing
information for transportation services tendered between
transportation service providers, including quoted services in
response to a request for a supplier freight quote. The business
object comprises data logically organized as a supplier freight
quote root node and at least one subordinate node, including a
nature of cargo subordinate node, each subordinate node having zero
or more hierarchically more structured subordinate nodes. The
graphical user interface presents data associated with an invoked
instance of the supplier freight quote business object. The
interface comprises computer readable instructions embodied on
tangible media.
[0021] In some implementations, processing business objects
includes creating, updating and/or retrieving information
associated with the business objects.
BRIEF DESCRIPTION OF THE DRAWINGS
[0022] FIG. 1 depicts a flow diagram of the overall steps performed
by methods and systems consistent with the subject matter described
herein.
[0023] FIG. 2 depicts a business document flow for an invoice
request in accordance with methods and systems consistent with the
subject matter described herein.
[0024] FIGS. 3A-B illustrate example environments implementing the
transmission, receipt, and processing of data between heterogeneous
applications in accordance with certain embodiments included in the
present disclosure.
[0025] FIG. 4 illustrates an example application implementing
certain techniques and components in accordance with one embodiment
of the system of FIG. 1.
[0026] FIG. 5A depicts an example development environment in
accordance with one embodiment of FIG. 1.
[0027] FIG. 5B depicts a simplified process for mapping a model
representation to a runtime representation using the example
development environment of FIG. 5A or some other development
environment.
[0028] FIG. 6 depicts message categories in accordance with methods
and systems consistent with the subject matter described
herein.
[0029] FIG. 7 depicts an example of a package in accordance with
methods and systems consistent with the subject matter described
herein.
[0030] FIG. 8 depicts another example of a package in accordance
with methods and systems consistent with the subject matter
described herein.
[0031] FIG. 9 depicts a third example of a package in accordance
with methods and systems consistent with the subject matter
described herein.
[0032] FIG. 10 depicts a fourth example of a package in accordance
with methods and systems consistent with the subject matter
described herein.
[0033] FIG. 11 depicts the representation of a package in the XML
schema in accordance with methods and systems consistent with the
subject matter described herein.
[0034] FIG. 12 depicts a graphical representation of cardinalities
between two entities in accordance with methods and systems
consistent with the subject matter described herein.
[0035] FIG. 13 depicts an example of a composition in accordance
with methods and systems consistent with the subject matter
described herein.
[0036] FIG. 14 depicts an example of a hierarchical relationship in
accordance with methods and systems consistent with the subject
matter described herein.
[0037] FIG. 15 depicts an example of an aggregating relationship in
accordance with methods and systems consistent with the subject
matter described herein.
[0038] FIG. 16 depicts an example of an association in accordance
with methods and systems consistent with the subject matter
described herein.
[0039] FIG. 17 depicts an example of a specialization in accordance
with methods and systems consistent with the subject matter
described herein.
[0040] FIG. 18 depicts the categories of specializations in
accordance with methods and systems consistent with the subject
matter described herein.
[0041] FIG. 19 depicts an example of a hierarchy in accordance with
methods and systems consistent with the subject matter described
herein.
[0042] FIG. 20 depicts a graphical representation of a hierarchy in
accordance with methods and systems consistent with the subject
matter described herein.
[0043] FIGS. 21A-B depict a flow diagram of the steps performed to
create a business object model in accordance with methods and
systems consistent with the subject matter described herein.
[0044] FIGS. 22A-F depict a flow diagram of the steps performed to
generate an interface from the business object model in accordance
with methods and systems consistent with the subject matter
described herein.
[0045] FIG. 23 depicts an example illustrating the transmittal of a
business document in accordance with methods and systems consistent
with the subject matter described herein.
[0046] FIG. 24 depicts an interface proxy in accordance with
methods and systems consistent with the subject matter described
herein.
[0047] FIG. 25 depicts an example illustrating the transmittal of a
message using proxies in accordance with methods and systems
consistent with the subject matter described herein.
[0048] FIG. 26A depicts components of a message in accordance with
methods and systems consistent with the subject matter described
herein.
[0049] FIG. 26B depicts IDs used in a message in accordance with
methods and systems consistent with the subject matter described
herein.
[0050] FIGS. 27A-E depict a hierarchization process in accordance
with methods and systems consistent with the subject matter
described herein.
[0051] FIG. 28 illustrates an example method for service enabling
in accordance with one embodiment of the present disclosure.
[0052] FIG. 29 is a graphical illustration of an example business
object and associated components as may be used in the enterprise
service infrastructure system of the present disclosure.
[0053] FIG. 30 illustrates an example method for managing a process
agent framework in accordance with one embodiment of the present
disclosure.
[0054] FIG. 31 illustrates an example method for status and action
management in accordance with one embodiment of the present
disclosure.
[0055] FIG. 32 shows an exemplary Freight Order Execution Message
Choreography.
[0056] FIG. 33 shows an exemplary Freight Order Invoicing
Preparation Message Choreography.
[0057] FIGS. 34-1 through 34-28 show an exemplary
FreightOrderExecutionRequestMessage Message Data Type.
[0058] FIG. 35 shows an exemplary
FreightOrderExecutionCancelRequestMessage Message Data Type.
[0059] FIGS. 36-1 through 36-28 show an exemplary
FreightOrderExecution Message Data Type.
[0060] FIG. 37 shows an exemplary
FreightOrderExecutionStatusNotificationMessage Message Data
Type.
[0061] FIGS. 38-1 through 38-28 show an exemplary
FreightOrderInvoicingPreparationRequestMessage Message Data
Type.
[0062] FIG. 39 shows an exemplary
FreightOrderInvoicingPreparationCancelRequest Message Data
Type.
[0063] FIG. 40 shows an exemplary
FreightOrderInvoicingPreparationConfirmationMessage Message Data
Type.
[0064] FIGS. 41-1 through 41-85 show an exemplary
FreightOrderInvoicingPrepRequest Element Structure.
[0065] FIGS. 42-1 through 42-3 show an exemplary
FreightOrderExecutionCancelRequest Element Structure.
[0066] FIGS. 43-1 through 43-138 show an exemplary
FreightOrderExecutionConfirmation Element Structure.
[0067] FIGS. 44-1 through 44-141 show an exemplary
FreightOrderExecutionReques Element Structure.
[0068] FIGS. 45-1 through 45-6 show an exemplary
FreightOrderExecutionStatusNotification Element Structure.
[0069] FIGS. 46-1 through 46-3 show an exemplary
FreightOrderInvoicingPrepCancelRequest Element Structure.
[0070] FIGS. 47-1 through 47-3 show an exemplary
FreightOrderInvoicingPrepConfirmation Element Structure.
[0071] FIG. 48 shows an exemplary Maintenance Plan Message
Choreography.
[0072] FIG. 49 shows an exemplary MaintPlnERPCrteReqMsg_sync
Message Data Type.
[0073] FIG. 50 shows an exemplary MaintPlnERPCrteConfMsg_sync
Message Data Type.
[0074] FIG. 51 shows an exemplary MaintPlnERPActvteReqMsg_sync
Message Data Type.
[0075] FIG. 52 shows an exemplary MaintPlnERPActvteConfMsg_sync
Message Data Type.
[0076] FIG. 53 shows an exemplary MaintPlnERPDactvteReqMsg_sync
Message Data Type.
[0077] FIG. 54 shows an exemplary MaintPlnERPDactvteConfMsg_sync
Message Data Type.
[0078] FIG. 55 shows an exemplary MaintPlnERPSetDelIndReqMsg_sync
Message Data Type.
[0079] FIG. 56 shows an exemplary MaintPlnERPSetDelIndConfMsg_sync
Message Data Type.
[0080] FIG. 57 shows an exemplary MaintPlnERPRstDelIndReqMsg_sync
Message Data Type.
[0081] FIG. 58 shows an exemplary MaintPlnERPRstDelIndConfMsg_sync
Message Data Type.
[0082] FIG. 59 shows an exemplary MaintPlnERPSimplElmntsQryMsg_sync
Message Data Type.
[0083] FIG. 60 shows an exemplary MaintPlnERPSimplElmntsRspMsg_sync
Message Data Type.
[0084] FIG. 61 shows an exemplary MaintPlnERPUpdtReqMsg_sync
Message Data Type.
[0085] FIG. 62 shows an exemplary MaintPlnERPUpdtConfMsg_sync
Message Data Type.
[0086] FIG. 63 shows an exemplary MaintPlnERPCrteCkQryMsg_sync
Message Data Type.
[0087] FIG. 64 shows an exemplary MaintPlnERPCrteCkRspMsg_sync
Message Data Type.
[0088] FIG. 65 shows an exemplary
MaintPlnItmERPSimplElmntsQryMsg_sync Message Data Type.
[0089] FIG. 66 shows an exemplary
MaintPlnItmERPSimplElmntsRspMsg_sync Message Data Type.
[0090] FIG. 67 shows an exemplary MaintPlnERPUpdtCkQryMsg_sync
Message Data Type.
[0091] FIG. 68 shows an exemplary MaintPlnERPUpdtCkRspMsg_sync
Message Data Type.
[0092] FIG. 69 shows an exemplary MaintPlnERPByIDQryMsg_sync
Message Data Type.
[0093] FIG. 70 shows an exemplary MaintPlnERPByIDRspMsg_sync
Message Data Type.
[0094] FIG. 71 shows an exemplary MaintPlnSchedERPByIDQryMsg_sync
Message Data Type.
[0095] FIG. 72 shows an exemplary MaintPlnSchedERPByIDRspMsg_sync
Message Data Type.
[0096] FIGS. 73-1 through 73-12 show an exemplary
MaintenancePlanMessage_sync Element Structure.
[0097] FIGS. 74-1 through 74-8 show an exemplary
MaintPlnERPCrteReqMsg_s Element Structure.
[0098] FIG. 75 shows an exemplary MaintPlnERPCrteConfMsg_s Element
Structure.
[0099] FIG. 76 shows an exemplary MaintPlnERPActvteReqMsg_s Element
Structure.
[0100] FIG. 77 shows an exemplary MaintPlnERPActvteConfMsg_s
Element Structure.
[0101] FIG. 78 shows an exemplary MaintPlnERPDactvteReqMsg_s
Element Structure.
[0102] FIG. 79 shows an exemplary MaintPlnERPDactvteConfMsg_s
Element Structure.
[0103] FIG. 80 shows an exemplary MaintPlnERPSetDelIndReqMsg_s
Element Structure.
[0104] FIG. 81 shows an exemplary MaintPlnERPSetDelIndConfMsg_s
Element Structure.
[0105] FIG. 82 shows an exemplary MaintPlnERPRstDelIndReqMsg_s
Element Structure.
[0106] FIG. 83 shows an exemplary MaintPlnERPRstDelIndConfMsg_s
Element Structure.
[0107] FIGS. 84-1 through 84-2 show an exemplary
MaintPlnERPSimplElmntsQryMsg_s Element Structure.
[0108] FIGS. 85-1 through 85-2 show an exemplary
MaintPlnERPSimplElmntsRspMsg_s Element Structure.
[0109] FIGS. 86-1 through 86-8 show an exemplary
MaintPlnERPUpdtReqMsg_s Element Structure.
[0110] FIG. 87 shows an exemplary MaintPlnERPUpdtConfMsg_s Element
Structure.
[0111] FIGS. 88-1 through 88-8 show an exemplary
MaintPlnERPCrteCkQryMsg_s Element Structure.
[0112] FIG. 89 shows an exemplary MaintPlnERPCrteCkRspMsg_s Element
Structure.
[0113] FIGS. 90-1 through 90-2 show an exemplary
MaintPlnERPItmElmntsQryMsg_s Element Structure.
[0114] FIGS. 91-1 through 91-2 show an exemplary
MaintPlnERPItmElmntsRspMsg_s Element Structure.
[0115] FIGS. 92-1 through 92-8 show an exemplary
MaintPlnERPUpdtCkQryMsg_s Element Structure.
[0116] FIG. 93 shows an exemplary MaintPlnERPUpdtCkRspMsg_s Element
Structure.
[0117] FIG. 94 shows an exemplary MaintPlnERPByIDQryMsg_s Element
Structure.
[0118] FIGS. 95-1 through 95-10 show an exemplary
MaintPlnERPByIDRspMsg_s Element Structure.
[0119] FIG. 96 shows an exemplary MaintPlnERPSchedLineByIDQryMsg_s
Element Structure.
[0120] FIGS. 97-1 through 97-2 show an exemplary
MaintPlnERPSchedLineByIDRspMsg_s Element Structure.
[0121] FIG. 98 shows an exemplary Maintenance Task List Message
Choreography.
[0122] FIG. 99 shows an exemplary
MaintenanceTaskListERPSimpleByElementsQuery_sync Message Data
Type.
[0123] FIG. 100 shows an exemplary
MaintenanceTaskListERPSimpleByElementsResponse_sync Message Data
Type.
[0124] FIG. 101 shows an exemplary
ParentMaintenanceTaskListERPSimpleByMaintenanceTaskListQuery_sync
Message Data Type.
[0125] FIG. 102 shows an exemplary
ParentMaintenanceTaskListERPSimpleByMaintenanceTaskListResponse_sync
Message Data Type.
[0126] FIG. 103 shows an exemplary
SubordinateMaintenanceTaskListERPSimpleByMaintenanceTaskListQuery_sync
Message Data Type.
[0127] FIG. 104 shows an exemplary
SubordinateMaintenanceTaskListERPSimpleByMaintenanceTaskListResponse_sync
Message Data Type.
[0128] FIG. 105 shows an exemplary
TopLevelMaintenanceTaskListERPSimpleByMaintenanceTaskListQuery_sync
Message Data Type.
[0129] FIG. 106 shows an exemplary
TopLevelMaintenanceTaskListERPSimpleByMaintenanceTaskListResponse_sync
Message Data Type.
[0130] FIG. 107 shows an exemplary
MaintenanceTaskListERPByIDQuery_sync Message Data Type.
[0131] FIG. 108 shows an exemplary
MaintenanceTaskListERPByIDresponse_sync Message Data Type.
[0132] FIGS. 109-1 through 109-7 show an exemplary
MaintenanceTaskListMessage_sync Element Structure.
[0133] FIGS. 110-1 through 110-2 show an exemplary
MaintTskListERPSimplElmntsQryMsg_s Element Structure.
[0134] FIGS. 111-1 through 111-2 show an exemplary
MaintTskListERPSimplElmntsRspMsg_s Element Structure.
[0135] FIG. 112 shows an exemplary
ParMaintTskListERPSimplByMaintTskListQryMsg_s Element
Structure.
[0136] FIGS. 113-1 through 113-2 show an exemplary
ParMaintTskListERPSimplByMaintTskListRspMsg_s Element
Structure.
[0137] FIG. 114 shows an exemplary
SubordMaintTskListERPSimplByMaintTskListQryMsg_s Element
Structure.
[0138] FIGS. 115-1 through 115-2 show an exemplary
SubordMaintTskListERPSimplByMaintTskListRspMsg_s Element
Structure.
[0139] FIG. 116 shows an exemplary
TopLvlMaintTskListERPSimplByMaintTskListQryMsg_s Element
Structure.
[0140] FIG. 117 shows an exemplary
TopLvlMaintTskListERPSimplByMaintTskListRspMsg_s Element
Structure.
[0141] FIG. 118 shows an exemplary
MaintTskListERPByIDAndGrpIDAndTypeCodeQryMsg_s Element
Structure.
[0142] FIGS. 119-1 through 119-6 show an exemplary
MaintTskListERPByIDAndGrpIDAndTypeCodeRspMsg_s Element
Structure.
[0143] FIG. 120 shows an exemplary RequestForSupplierFreightQuote
Message Choreography.
[0144] FIGS. 121-1 through 121-21 show an exemplary
RequestForSupplierFreightQuoteRequestMessage Message Data Type.
[0145] FIG. 122 shows an exemplary
RequestForSupplierFreightQuoteCancelRequestMessage Message Data
Type.
[0146] FIGS. 123-1 through 123-123 show an exemplary
RequestForSupplierFreightQuoteRequestMessage Element Structure.
[0147] FIG. 124 shows an exemplary
RequestForSupplierFreightQuoteCancelRequestMessage Element
Structure.
[0148] FIG. 125 shows an exemplary SupplierFreightQuote Message
Choreography.
[0149] FIGS. 126-1 through 126-21 show an exemplary
SupplierFreightQuoteNotificationMessage Message Data Type.
[0150] FIGS. 127-1 through 127-123 show an exemplary
SupplierFreightQuoteNotificationMessage Element Structure.
DETAILED DESCRIPTION
[0151] A. Overview
[0152] Methods and systems consistent with the subject matter
described herein facilitate e-commerce by providing consistent
interfaces that are suitable for use across industries, across
businesses, and across different departments within a business
during a business transaction. To generate consistent interfaces,
methods and systems consistent with the subject matter described
herein utilize a business object model, which reflects the data
that will be used during a given business transaction. An example
of a business transaction is the exchange of purchase orders and
order confirmations between a buyer and a seller. The business
object model is generated in a hierarchical manner to ensure that
the same type of data is represented the same way throughout the
business object model. This ensures the consistency of the
information in the business object model. Consistency is also
reflected in the semantic meaning of the various structural
elements. That is, each structural element has a consistent
business meaning. For example, the location entity, regardless of
in which package it is located, refers to a location.
[0153] From this business object model, various interfaces are
derived to accomplish the functionality of the business
transaction. Interfaces provide an entry point for components to
access the functionality of an application. For example, the
interface for a Purchase Order Request provides an entry point for
components to access the functionality of a Purchase Order, in
particular, to transmit and/or receive a Purchase Order Request.
One skilled in the art will recognize that each of these interfaces
may be provided, sold, distributed, utilized, or marketed as a
separate product or as a major component of a separate product.
Alternatively, a group of related interfaces may be provided, sold,
distributed, utilized, or marketed as a product or as a major
component of a separate product. Because the interfaces are
generated from the business object model, the information in the
interfaces is consistent, and the interfaces are consistent among
the business entities. Such consistency facilitates heterogeneous
business entities in cooperating to accomplish the business
transaction.
[0154] Generally, the business object is a representation of a type
of a uniquely identifiable business entity (an object instance)
described by a structural model. In the architecture, processes may
typically operate on business objects. Business objects represent a
specific view on some well-defined business content. In other
words, business objects represent content, which a typical business
user would expect and understand with little explanation. Business
objects are further categorized as business process objects and
master data objects. A master data object is an object that
encapsulates master data (i.e., data that is valid for a period of
time). A business process object, which is the kind of business
object generally found in a process component, is an object that
encapsulates transactional data (i.e., data that is valid for a
point in time). The term business object will be used generically
to refer to a business process object and a master data object,
unless the context requires otherwise. Properly implemented,
business objects are implemented free of redundancies.
[0155] The architectural elements also include the process
component. The process component is a software package that
realizes a business process and generally exposes its functionality
as services. The functionality contains business transactions. In
general, the process component contains one or more semantically
related business objects. Often, a particular business object
belongs to no more than one process component. Interactions between
process component pairs involving their respective business
objects, process agents, operations, interfaces, and messages are
described as process component interactions, which generally
determine the interactions of a pair of process components across a
deployment unit boundary. Interactions between process components
within a deployment unit are typically not constrained by the
architectural design and can be implemented in any convenient
fashion. Process components may be modular and context-independent.
In other words, process components may not be specific to any
particular application and as such, may be reusable. In some
implementations, the process component is the smallest (most
granular) element of reuse in the architecture. An external process
component is generally used to represent the external system in
describing interactions with the external system; however, this
should be understood to require no more of the external system than
that able to produce and receive messages as required by the
process component that interacts with the external system. For
example, process components may include multiple operations that
may provide interaction with the external system. Each operation
generally belongs to one type of process component in the
architecture. Operations can be synchronous or asynchronous,
corresponding to synchronous or asynchronous process agents, which
will be described below. The operation is often the smallest,
separately-callable function, described by a set of data types used
as input, output, and fault parameters serving as a signature.
[0156] The architectural elements may also include the service
interface, referred to simply as the interface. The interface is a
named group of operations. The interface often belongs to one
process component and process component might contain multiple
interfaces. In one implementation, the service interface contains
only inbound or outbound operations, but not a mixture of both. One
interface can contain both synchronous and asynchronous operations.
Normally, operations of the same type (either inbound or outbound)
which belong to the same message choreography will belong to the
same interface. Thus, generally, all outbound operations to the
same other process component are in one interface.
[0157] The architectural elements also include the message.
Operations transmit and receive messages. Any convenient messaging
infrastructure can be used. A message is information conveyed from
one process component instance to another, with the expectation
that activity will ensue. Operation can use multiple message types
for inbound, outbound, or error messages. When two process
components are in different deployment units, invocation of an
operation of one process component by the other process component
is accomplished by the operation on the other process component
sending a message to the first process component.
[0158] The architectural elements may also include the process
agent. Process agents do business processing that involves the
sending or receiving of messages. Each operation normally has at
least one associated process agent. Each process agent can be
associated with one or more operations. Process agents can be
either inbound or outbound and either synchronous or asynchronous.
Asynchronous outbound process agents are called after a business
object changes such as after a "create", "update", or "delete" of a
business object instance. Synchronous outbound process agents are
generally triggered directly by business object. An outbound
process agent will generally perform some processing of the data of
the business object instance whose change triggered the event. The
outbound agent triggers subsequent business process steps by
sending messages using well-defined outbound services to another
process component, which generally will be in another deployment
unit, or to an external system. The outbound process agent is
linked to the one business object that triggers the agent, but it
is sent not to another business object but rather to another
process component. Thus, the outbound process agent can be
implemented without knowledge of the exact business object design
of the recipient process component. Alternatively, the process
agent may be inbound. For example, inbound process agents may be
used for the inbound part of a message-based communication. Inbound
process agents are called after a message has been received. The
inbound process agent starts the execution of the business process
step requested in a message by creating or updating one or multiple
business object instances. Inbound process agent is not generally
the agent of business object but of its process component. Inbound
process agent can act on multiple business objects in a process
component. Regardless of whether the process agent is inbound or
outbound, an agent may be synchronous if used when a process
component requires a more or less immediate response from another
process component, and is waiting for that response to continue its
work.
[0159] The architectural elements also include the deployment unit.
Each deployment unit may include one or more process components
that are generally deployed together on a single computer system
platform. Conversely, separate deployment units can be deployed on
separate physical computing systems. The process components of one
deployment unit can interact with those of another deployment unit
using messages passed through one or more data communication
networks or other suitable communication channels. Thus, a
deployment unit deployed on a platform belonging to one business
can interact with a deployment unit software entity deployed on a
separate platform belonging to a different and unrelated business,
allowing for business-to-business communication. More than one
instance of a given deployment unit can execute at the same time,
on the same computing system or on separate physical computing
systems. This arrangement allows the functionality offered by the
deployment unit to be scaled to meet demand by creating as many
instances as needed.
[0160] Since interaction between deployment units is through
process component operations, one deployment unit can be replaced
by other another deployment unit as long as the new deployment unit
supports the operations depended upon by other deployment units as
appropriate. Thus, while deployment units can depend on the
external interfaces of process components in other deployment
units, deployment units are not dependent on process component
interaction within other deployment units. Similarly, process
components that interact with other process components or external
systems only through messages, e.g., as sent and received by
operations, can also be replaced as long as the replacement
generally supports the operations of the original.
[0161] Services (or interfaces) may be provided in a flexible
architecture to support varying criteria between services and
systems. The flexible architecture may generally be provided by a
service delivery business object. The system may be able to
schedule a service asynchronously as necessary, or on a regular
basis. Services may be planned according to a schedule manually or
automatically. For example, a follow-up service may be scheduled
automatically upon completing an initial service. In addition,
flexible execution periods may be possible (e.g. hourly, daily,
every three months, etc.). Each customer may plan the services on
demand or reschedule service execution upon request.
[0162] FIG. 1 depicts a flow diagram 100 showing an example
technique, perhaps implemented by systems similar to those
disclosed herein. Initially, to generate the business object model,
design engineers study the details of a business process, and model
the business process using a "business scenario" (step 102). The
business scenario identifies the steps performed by the different
business entities during a business process. Thus, the business
scenario is a complete representation of a clearly defined business
process.
[0163] After creating the business scenario, the developers add
details to each step of the business scenario (step 104). In
particular, for each step of the business scenario, the developers
identify the complete process steps performed by each business
entity. A discrete portion of the business scenario reflects a
"business transaction," and each business entity is referred to as
a "component" of the business transaction. The developers also
identify the messages that are transmitted between the components.
A "process interaction model" represents the complete process steps
between two components.
[0164] After creating the process interaction model, the developers
create a "message choreography" (step 106), which depicts the
messages transmitted between the two components in the process
interaction model. The developers then represent the transmission
of the messages between the components during a business process in
a "business document flow" (step 108). Thus, the business document
flow illustrates the flow of information between the business
entities during a business process.
[0165] FIG. 2 depicts an example business document flow 200 for the
process of purchasing a product or service. The business entities
involved with the illustrative purchase process include Accounting
202, Payment 204, Invoicing 206, Supply Chain Execution ("SCE")
208, Supply Chain Planning ("SCP") 210, Fulfillment Coordination
("FC") 212, Supply Relationship Management ("SRM") 214, Supplier
216, and Bank 218. The business document flow 200 is divided into
four different transactions: Preparation of Ordering ("Contract")
220, Ordering 222, Goods Receiving ("Delivery") 224, and
Billing/Payment 226. In the business document flow, arrows 228
represent the transmittal of documents. Each document reflects a
message transmitted between entities. One of ordinary skill in the
art will appreciate that the messages transferred may be considered
to be a communications protocol. The process flow follows the focus
of control, which is depicted as a solid vertical line (e.g., 229)
when the step is required, and a dotted vertical line (e.g., 230)
when the step is optional.
[0166] During the Contract transaction 220, the SRM 214 sends a
Source of Supply Notification 232 to the SCP 210. This step is
optional, as illustrated by the optional control line 230 coupling
this step to the remainder of the business document flow 200.
During the Ordering transaction 222, the SCP 210 sends a Purchase
Requirement Request 234 to the FC 212, which forwards a Purchase
Requirement Request 236 to the SRM 214. The SRM 214 then sends a
Purchase Requirement Confirmation 238 to the FC 212, and the FC 212
sends a Purchase Requirement Confirmation 240 to the SCP 210. The
SRM 214 also sends a Purchase Order Request 242 to the Supplier
216, and sends Purchase Order Information 244 to the FC 212. The FC
212 then sends a Purchase Order Planning Notification 246 to the
SCP 210. The Supplier 216, after receiving the Purchase Order
Request 242, sends a Purchase Order Confirmation 248 to the SRM
214, which sends a Purchase Order Information confirmation message
254 to the FC 212, which sends a message 256 confirming the
Purchase Order Planning Notification to the SCP 210. The SRM 214
then sends an Invoice Due Notification 258 to Invoicing 206.
[0167] During the Delivery transaction 224, the FC 212 sends a
Delivery Execution Request 260 to the SCE 208. The Supplier 216
could optionally (illustrated at control line 250) send a
Dispatched Delivery Notification 252 to the SCE 208. The SCE 208
then sends a message 262 to the FC 212 notifying the FC 212 that
the request for the Delivery Information was created. The FC 212
then sends a message 264 notifying the SRM 214 that the request for
the Delivery Information was created. The FC 212 also sends a
message 266 notifying the SCP 210 that the request for the Delivery
Information was created. The SCE 208 sends a message 268 to the FC
212 when the goods have been set aside for delivery. The FC 212
sends a message 270 to the SRM 214 when the goods have been set
aside for delivery. The FC 212 also sends a message 272 to the SCP
210 when the goods have been set aside for delivery.
[0168] The SCE 208 sends a message 274 to the FC 212 when the goods
have been delivered. The FC 212 then sends a message 276 to the SRM
214 indicating that the goods have been delivered, and sends a
message 278 to the SCP 210 indicating that the goods have been
delivered. The SCE 208 then sends an Inventory Change Accounting
Notification 280 to Accounting 202, and an Inventory Change
Notification 282 to the SCP 210. The FC 212 sends an Invoice Due
Notification 284 to Invoicing 206, and SCE 208 sends a Received
Delivery Notification 286 to the Supplier 216.
[0169] During the Billing/Payment transaction 226, the Supplier 216
sends an Invoice Request 287 to Invoicing 206. Invoicing 206 then
sends a Payment Due Notification 288 to Payment 204, a Tax Due
Notification 289 to Payment 204, an Invoice Confirmation 290 to the
Supplier 216, and an Invoice Accounting Notification 291 to
Accounting 202. Payment 204 sends a Payment Request 292 to the Bank
218, and a Payment Requested Accounting Notification 293 to
Accounting 202. Bank 218 sends a Bank Statement Information 296 to
Payment 204. Payment 204 then sends a Payment Done Information 294
to Invoicing 206 and a Payment Done Accounting Notification 295 to
Accounting 202.
[0170] Within a business document flow, business documents having
the same or similar structures are marked. For example, in the
business document flow 200 depicted in FIG. 2, Purchase Requirement
Requests 234, 236 and Purchase Requirement Confirmations 238, 240
have the same structures. Thus, each of these business documents is
marked with an "O6." Similarly, Purchase Order Request 242 and
Purchase Order Confirmation 248 have the same structures. Thus,
both documents are marked with an "O1." Each business document or
message is based on a message type.
[0171] From the business document flow, the developers identify the
business documents having identical or similar structures, and use
these business documents to create the business object model (step
110). The business object model includes the objects contained
within the business documents. These objects are reflected as
packages containing related information, and are arranged in a
hierarchical structure within the business object model, as
discussed below.
[0172] Methods and systems consistent with the subject matter
described herein then generate interfaces from the business object
model (step 112). The heterogeneous programs use instantiations of
these interfaces (called "business document objects" below) to
create messages (step 114), which are sent to complete the business
transaction (step 116). Business entities use these messages to
exchange information with other business entities during an
end-to-end business transaction. Since the business object model is
shared by heterogeneous programs, the interfaces are consistent
among these programs. The heterogeneous programs use these
consistent interfaces to communicate in a consistent manner, thus
facilitating the business transactions.
[0173] Standardized Business-to-Business ("B2B") messages are
compliant with at least one of the e-business standards (i.e., they
include the business-relevant fields of the standard). The
e-business standards include, for example, RosettaNet for the
high-tech industry, Chemical Industry Data Exchange ("CIDX"),
Petroleum Industry Data Exchange ("PIDX") for the oil industry,
UCCnet for trade, PapiNet for the paper industry, Odette for the
automotive industry, HR-XML for human resources, and XML Common
Business Library ("xCBL"). Thus, B2B messages enable simple
integration of components in heterogeneous system landscapes.
Application-to-Application ("A2A") messages often exceed the
standards and thus may provide the benefit of the full
functionality of application components. Although various steps of
FIG. 1 were described as being performed manually, one skilled in
the art will appreciate that such steps could be computer-assisted
or performed entirely by a computer, including being performed by
either hardware, software, or any other combination thereof.
[0174] B. Implementation Details
[0175] As discussed above, methods and systems consistent with the
subject matter described herein create consistent interfaces by
generating the interfaces from a business object model. Details
regarding the creation of the business object model, the generation
of an interface from the business object model, and the use of an
interface generated from the business object model are provided
below.
[0176] Turning to the illustrated embodiment in FIG. 3A,
environment 300 includes or is communicably coupled (such as via a
one-, bi- or multi-directional link or network) with server 302,
one or more clients 304, one or more or vendors 306, one or more
customers 308, at least some of which communicate across network
312. But, of course, this illustration is for example purposes
only, and any distributed system or environment implementing one or
more of the techniques described herein may be within the scope of
this disclosure. Server 302 comprises an electronic computing
device operable to receive, transmit, process and store data
associated with environment 300. Generally, FIG. 3A provides merely
one example of computers that may be used with the disclosure. Each
computer is generally intended to encompass any suitable processing
device. For example, although FIG. 3A illustrates one server 302
that may be used with the disclosure, environment 300 can be
implemented using computers other than servers, as well as a server
pool. Indeed, server 302 may be any computer or processing device
such as, for example, a blade server, general-purpose personal
computer (PC), Macintosh, workstation, Unix-based computer, or any
other suitable device. In other words, the present disclosure
contemplates computers other than general purpose computers as well
as computers without conventional operating systems. Server 302 may
be adapted to execute any operating system including Linux, UNIX,
Windows Server, or any other suitable operating system. According
to one embodiment, server 302 may also include or be communicably
coupled with a web server and/or a mail server.
[0177] As illustrated (but not required), the server 302 is
communicably coupled with a relatively remote repository 335 over a
portion of the network 312. The repository 335 is any electronic
storage facility, data processing center, or archive that may
supplement or replace local memory (such as 327). The repository
335 may be a central database communicably coupled with the one or
more servers 302 and the clients 304 via a virtual private network
(VPN), SSH (Secure Shell) tunnel, or other secure network
connection. The repository 335 may be physically or logically
located at any appropriate location including in one of the example
enterprises or off-shore, so long as it remains operable to store
information associated with the environment 300 and communicate
such data to the server 302 or at least a subset of plurality of
the clients 304.
[0178] Illustrated server 302 includes local memory 327. Memory 327
may include any memory or database module and may take the form of
volatile or non-volatile memory including, without limitation,
magnetic media, optical media, random access memory (RAM),
read-only memory (ROM), removable media, or any other suitable
local or remote memory component. Illustrated memory 327 includes
an exchange infrastructure ("XI") 314, which is an infrastructure
that supports the technical interaction of business processes
across heterogeneous system environments. XI 314 centralizes the
communication between components within a business entity and
between different business entities. When appropriate, XI 314
carries out the mapping between the messages. XI 314 integrates
different versions of systems implemented on different platforms
(e.g., Java and ABAP). XI 314 is based on an open architecture, and
makes use of open standards, such as eXtensible Markup Language
(XML).TM. and Java environments. XI 314 offers services that are
useful in a heterogeneous and complex system landscape. In
particular, XI 314 offers a runtime infrastructure for message
exchange, configuration options for managing business processes and
message flow, and options for transforming message contents between
sender and receiver systems.
[0179] XI 314 stores data types 316, a business object model 318,
and interfaces 320. The details regarding the business object model
are described below. Data types 316 are the building blocks for the
business object model 318. The business object model 318 is used to
derive consistent interfaces 320. XI 314 allows for the exchange of
information from a first company having one computer system to a
second company having a second computer system over network 312 by
using the standardized interfaces 320.
[0180] While not illustrated, memory 327 may also include business
objects and any other appropriate data such as services,
interfaces, VPN applications or services, firewall policies, a
security or access log, print or other reporting files, HTML files
or templates, data classes or object interfaces, child software
applications or sub-systems, and others. This stored data may be
stored in one or more logical or physical repositories. In some
embodiments, the stored data (or pointers thereto) may be stored in
one or more tables in a relational database described in terms of
SQL statements or scripts. In the same or other embodiments, the
stored data may also be formatted, stored, or defined as various
data structures in text files, XML documents, Virtual Storage
Access Method (VSAM) files, flat files, Btrieve files,
comma-separated-value (CSV) files, internal variables, or one or
more libraries. For example, a particular data service record may
merely be a pointer to a particular piece of third party software
stored remotely. In another example, a particular data service may
be an internally stored software object usable by authenticated
customers or internal development. In short, the stored data may
comprise one table or file or a plurality of tables or files stored
on one computer or across a plurality of computers in any
appropriate format. Indeed, some or all of the stored data may be
local or remote without departing from the scope of this disclosure
and store any type of appropriate data.
[0181] Server 302 also includes processor 325. Processor 325
executes instructions and manipulates data to perform the
operations of server 302 such as, for example, a central processing
unit (CPU), a blade, an application specific integrated circuit
(ASIC), or a field-programmable gate array (FPGA). Although FIG. 3A
illustrates a single processor 325 in server 302, multiple
processors 325 may be used according to particular needs and
reference to processor 325 is meant to include multiple processors
325 where applicable. In the illustrated embodiment, processor 325
executes at least business application 330.
[0182] At a high level, business application 330 is any
application, program, module, process, or other software that
utilizes or facilitates the exchange of information via messages
(or services) or the use of business objects. For example,
application 330 may implement, utilize or otherwise leverage an
enterprise service-oriented architecture (enterprise SOA), which
may be considered a blueprint for an adaptable, flexible, and open
IT architecture for developing services-based, enterprise-scale
business solutions. This example enterprise service may be a series
of web services combined with business logic that can be accessed
and used repeatedly to support a particular business process.
Aggregating web services into business-level enterprise services
helps provide a more meaningful foundation for the task of
automating enterprise-scale business scenarios Put simply,
enterprise services help provide a holistic combination of actions
that are semantically linked to complete the specific task, no
matter how many cross-applications are involved. In certain cases,
environment 300 may implement a composite application 330, as
described below in FIG. 4. Regardless of the particular
implementation, "software" may include software, firmware, wired or
programmed hardware, or any combination thereof as appropriate.
Indeed, application 330 may be written or described in any
appropriate computer language including C, C++, Java, Visual Basic,
assembler, Perl, any suitable version of 4GL, as well as others.
For example, returning to the above mentioned composite
application, the composite application portions may be implemented
as Enterprise Java Beans (EJBs) or the design-time components may
have the ability to generate run-time implementations into
different platforms, such as J2EE (Java 2 Platform, Enterprise
Edition), ABAP (Advanced Business Application Programming) objects,
or Microsoft's .NET. It will be understood that while application
330 is illustrated in FIG. 4 as including various sub-modules,
application 330 may include numerous other sub-modules or may
instead be a single multi-tasked module that implements the various
features and functionality through various objects, methods, or
other processes. Further, while illustrated as internal to server
302, one or more processes associated with application 330 may be
stored, referenced, or executed remotely. For example, a portion of
application 330 may be a web service that is remotely called, while
another portion of application 330 may be an interface object
bundled for processing at remote client 304. Moreover, application
330 may be a child or sub-module of another software module or
enterprise application (not illustrated) without departing from the
scope of this disclosure. Indeed, application 330 may be a hosted
solution that allows multiple related or third parties in different
portions of the process to perform the respective processing.
[0183] More specifically, as illustrated in FIG. 4, application 330
may be a composite application, or an application built on other
applications, that includes an object access layer (OAL) and a
service layer. In this example, application 330 may execute or
provide a number of application services, such as customer
relationship management (CRM) systems, human resources management
(HRM) systems, financial management (FM) systems, project
management (PM) systems, knowledge management (KM) systems, and
electronic file and mail systems. Such an object access layer is
operable to exchange data with a plurality of enterprise base
systems and to present the data to a composite application through
a uniform interface. The example service layer is operable to
provide services to the composite application. These layers may
help the composite application to orchestrate a business process in
synchronization with other existing processes (e.g., native
processes of enterprise base systems) and leverage existing
investments in the IT platform. Further, composite application 330
may run on a heterogeneous IT platform. In doing so, composite
application may be cross-functional in that it may drive business
processes across different applications, technologies, and
organizations. Accordingly, composite application 330 may drive
end-to-end business processes across heterogeneous systems or
sub-systems. Application 330 may also include or be coupled with a
persistence layer and one or more application system connectors.
Such application system connectors enable data exchange and
integration with enterprise sub-systems and may include an
Enterprise Connector (EC) interface, an Internet Communication
Manager/Internet Communication Framework (ICM/ICF) interface, an
Encapsulated PostScript (EPS) interface, and/or other interfaces
that provide Remote Function Call (RFC) capability. It will be
understood that while this example describes a composite
application 330, it may instead be a standalone or (relatively)
simple software program. Regardless, application 330 may also
perform processing automatically, which may indicate that the
appropriate processing is substantially performed by at least one
component of environment 300. It should be understood that
automatically further contemplates any suitable administrator or
other user interaction with application 330 or other components of
environment 300 without departing from the scope of this
disclosure.
[0184] Returning to FIG. 3A, illustrated server 302 may also
include interface 317 for communicating with other computer
systems, such as clients 304, over network 312 in a client-server
or other distributed environment. In certain embodiments, server
302 receives data from internal or external senders through
interface 317 for storage in memory 327, for storage in DB 335,
and/or processing by processor 325. Generally, interface 317
comprises logic encoded in software and/or hardware in a suitable
combination and operable to communicate with network 312. More
specifically, interface 317 may comprise software supporting one or
more communications protocols associated with communications
network 312 or hardware operable to communicate physical
signals.
[0185] Network 312 facilitates wireless or wireline communication
between computer server 302 and any other local or remote computer,
such as clients 304. Network 312 may be all or a portion of an
enterprise or secured network. In another example, network 312 may
be a VPN merely between server 302 and client 304 across wireline
or wireless link. Such an example wireless link may be via 802.11a,
802.11b, 802.11g, 802.20, WiMax, and many others. While illustrated
as a single or continuous network, network 312 may be logically
divided into various sub-nets or virtual networks without departing
from the scope of this disclosure, so long as at least portion of
network 312 may facilitate communications between server 302 and at
least one client 304. For example, server 302 may be communicably
coupled to one or more "local" repositories through one sub-net
while communicably coupled to a particular client 304 or "remote"
repositories through another. In other words, network 312
encompasses any internal or external network, networks,
sub-network, or combination thereof operable to facilitate
communications between various computing components in environment
300. Network 312 may communicate, for example, Internet Protocol
(IP) packets, Frame Relay frames, Asynchronous Transfer Mode (ATM)
cells, voice, video, data, and other suitable information between
network addresses. Network 312 may include one or more local area
networks (LANs), radio access networks (RANs), metropolitan area
networks (MANs), wide area networks (WANs), all or a portion of the
global computer network known as the Internet, and/or any other
communication system or systems at one or more locations. In
certain embodiments, network 312 may be a secure network associated
with the enterprise and certain local or remote vendors 306 and
customers 308. As used in this disclosure, customer 308 is any
person, department, organization, small business, enterprise, or
any other entity that may use or request others to use environment
300. As described above, vendors 306 also may be local or remote to
customer 308. Indeed, a particular vendor 306 may provide some
content to business application 330, while receiving or purchasing
other content (at the same or different times) as customer 308. As
illustrated, customer 308 and vendor 06 each typically perform some
processing (such as uploading or purchasing content) using a
computer, such as client 304.
[0186] Client 304 is any computing device operable to connect or
communicate with server 302 or network 312 using any communication
link. For example, client 304 is intended to encompass a personal
computer, touch screen terminal, workstation, network computer,
kiosk, wireless data port, smart phone, personal data assistant
(PDA), one or more processors within these or other devices, or any
other suitable processing device used by or for the benefit of
business 308, vendor 306, or some other user or entity. At a high
level, each client 304 includes or executes at least GUI 336 and
comprises an electronic computing device operable to receive,
transmit, process and store any appropriate data associated with
environment 300. It will be understood that there may be any number
of clients 304 communicably coupled to server 302. Further, "client
304," "business," "business analyst," "end user," and "user" may be
used interchangeably as appropriate without departing from the
scope of this disclosure. Moreover, for ease of illustration, each
client 304 is described in terms of being used by one user. But
this disclosure contemplates that many users may use one computer
or that one user may use multiple computers. For example, client
304 may be a PDA operable to wirelessly connect with external or
unsecured network. In another example, client 304 may comprise a
laptop that includes an input device, such as a keypad, touch
screen, mouse, or other device that can accept information, and an
output device that conveys information associated with the
operation of server 302 or clients 304, including digital data,
visual information, or GUI 336. Both the input device and output
device may include fixed or removable storage media such as a
magnetic computer disk, CD-ROM, or other suitable media to both
receive input from and provide output to users of clients 304
through the display, namely the client portion of GUI or
application interface 336.
[0187] GUI 336 comprises a graphical user interface operable to
allow the user of client 304 to interface with at least a portion
of environment 300 for any suitable purpose, such as viewing
application or other transaction data. Generally, GUI 336 provides
the particular user with an efficient and user-friendly
presentation of data provided by or communicated within environment
300. For example, GUI 336 may present the user with the components
and information that is relevant to their task, increase reuse of
such components, and facilitate a sizable developer community
around those components. GUI 336 may comprise a plurality of
customizable frames or views having interactive fields, pull-down
lists, and buttons operated by the user. For example, GUI 336 is
operable to display data involving business objects and interfaces
in a user-friendly form based on the user context and the displayed
data. In another example, GUI 336 is operable to display different
levels and types of information involving business objects and
interfaces based on the identified or supplied user role. GUI 336
may also present a plurality of portals or dashboards. For example,
GUI 336 may display a portal that allows users to view, create, and
manage historical and real-time reports including role-based
reporting and such. Of course, such reports may be in any
appropriate output format including PDF, HTML, and printable text.
Real-time dashboards often provide table and graph information on
the current state of the data, which may be supplemented by
business objects and interfaces. It should be understood that the
term graphical user interface may be used in the singular or in the
plural to describe one or more graphical user interfaces and each
of the displays of a particular graphical user interface. Indeed,
reference to GUI 336 may indicate a reference to the front-end or a
component of business application 330, as well as the particular
interface accessible via client 304, as appropriate, without
departing from the scope of this disclosure. Therefore, GUI 336
contemplates any graphical user interface, such as a generic web
browser or touchscreen, that processes information in environment
300 and efficiently presents the results to the user. Server 302
can accept data from client 304 via the web browser (e.g.,
Microsoft Internet Explorer or Netscape Navigator) and return the
appropriate HTML or XML responses to the browser using network
312.
[0188] More generally in environment 300 as depicted in FIG. 3B, a
Foundation Layer 375 can be deployed on multiple separate and
distinct hardware platforms, e.g., System A 350 and System B 360,
to support application software deployed as two or more deployment
units distributed on the platforms, including deployment unit 352
deployed on System A and deployment unit 362 deployed on System B.
In this example, the foundation layer can be used to support
application software deployed in an application layer. In
particular, the foundation layer can be used in connection with
application software implemented in accordance with a software
architecture that provides a suite of enterprise service operations
having various application functionality. In some implementations,
the application software is implemented to be deployed on an
application platform that includes a foundation layer that contains
all fundamental entities that can used from multiple deployment
units. These entities can be process components, business objects,
and reuse service components. A reuse service component is a piece
of software that is reused in different transactions. A reuse
service component is used by its defined interfaces, which can be,
e.g., local APIs or service interfaces. As explained above, process
components in separate deployment units interact through service
operations, as illustrated by messages passing between service
operations 356 and 366, which are implemented in process components
354 and 364, respectively, which are included in deployment units
352 and 362, respectively. As also explained above, some form of
direct communication is generally the form of interaction used
between a business object, e.g., business object 358 and 368, of an
application deployment unit and a business object, such as master
data object 370, of the Foundation Layer 375.
[0189] Various components of the present disclosure may be modeled
using a model-driven environment. For example, the model-driven
framework or environment may allow the developer to use simple
drag-and-drop techniques to develop pattern-based or freestyle user
interfaces and define the flow of data between them. The result
could be an efficient, customized, visually rich online experience.
In some cases, this model-driven development may accelerate the
application development process and foster business-user
self-service. It further enables business analysts or IT developers
to compose visually rich applications that use analytic services,
enterprise services, remote function calls (RFCs), APIs, and stored
procedures. In addition, it may allow them to reuse existing
applications and create content using a modeling process and a
visual user interface instead of manual coding.
[0190] FIG. 5A depicts an example modeling environment 516, namely
a modeling environment, in accordance with one embodiment of the
present disclosure. Thus, as illustrated in FIG. 5A, such a
modeling environment 516 may implement techniques for decoupling
models created during design-time from the runtime environment. In
other words, model representations for GUIs created in a design
time environment are decoupled from the runtime environment in
which the GUIs are executed. Often in these environments, a
declarative and executable representation for GUIs for applications
is provided that is independent of any particular runtime platform,
GUI framework, device, or programming language.
[0191] According to some embodiments, a modeler (or other analyst)
may use the model-driven modeling environment 516 to create
pattern-based or freestyle user interfaces using simple
drag-and-drop services. Because this development may be
model-driven, the modeler can typically compose an application
using models of business objects without having to write much, if
any, code. In some cases, this example modeling environment 516 may
provide a personalized, secure interface that helps unify
enterprise applications, information, and processes into a
coherent, role-based portal experience. Further, the modeling
environment 516 may allow the developer to access and share
information and applications in a collaborative environment. In
this way, virtual collaboration rooms allow developers to work
together efficiently, regardless of where they are located, and may
enable powerful and immediate communication that crosses
organizational boundaries while enforcing security requirements.
Indeed, the modeling environment 516 may provide a shared set of
services for finding, organizing, and accessing unstructured
content stored in third-party repositories and content management
systems across various networks 312. Classification tools may
automate the organization of information, while subject-matter
experts and content managers can publish information to distinct
user audiences. Regardless of the particular implementation or
architecture, this modeling environment 516 may allow the developer
to easily model hosted business objects 140 using this model-driven
approach.
[0192] In certain embodiments, the modeling environment 516 may
implement or utilize a generic, declarative, and executable GUI
language (generally described as XGL). This example XGL is
generally independent of any particular GUI framework or runtime
platform. Further, XGL is normally not dependent on characteristics
of a target device on which the graphic user interface is to be
displayed and may also be independent of any programming language.
XGL is used to generate a generic representation (occasionally
referred to as the XGL representation or XGL-compliant
representation) for a design-time model representation. The XGL
representation is thus typically a device-independent
representation of a GUI. The XGL representation is declarative in
that the representation does not depend on any particular GUI
framework, runtime platform, device, or programming language. The
XGL representation can be executable and therefore can
unambiguously encapsulate execution semantics for the GUI described
by a model representation. In short, models of different types can
be transformed to XGL representations.
[0193] The XGL representation may be used for generating
representations of various different GUIs and supports various GUI
features including full windowing and componentization support,
rich data visualizations and animations, rich modes of data entry
and user interactions, and flexible connectivity to any complex
application data services. While a specific embodiment of XGL is
discussed, various other types of XGLs may also be used in
alternative embodiments. In other words, it will be understood that
XGL is used for example description only and may be read to include
any abstract or modeling language that can be generic, declarative,
and executable.
[0194] Turning to the illustrated embodiment in FIG. 5A, modeling
tool 340 may be used by a GUI designer or business analyst during
the application design phase to create a model representation 502
for a GUI application. It will be understood that modeling
environment 516 may include or be compatible with various different
modeling tools 340 used to generate model representation 502. This
model representation 502 may be a machine-readable representation
of an application or a domain specific model. Model representation
502 generally encapsulates various design parameters related to the
GUI such as GUI components, dependencies between the GUI
components, inputs and outputs, and the like. Put another way,
model representation 502 provides a form in which the one or more
models can be persisted and transported, and possibly handled by
various tools such as code generators, runtime interpreters,
analysis and validation tools, merge tools, and the like. In one
embodiment, model representation 502 maybe a collection of XML
documents with a well-formed syntax.
[0195] Illustrated modeling environment 516 also includes an
abstract representation generator (or XGL generator) 504 operable
to generate an abstract representation (for example, XGL
representation or XGL-compliant representation) 506 based upon
model representation 502. Abstract representation generator 504
takes model representation 502 as input and outputs abstract
representation 506 for the model representation. Model
representation 502 may include multiple instances of various forms
or types depending on the tool/language used for the modeling. In
certain cases, these various different model representations may
each be mapped to one or more abstract representations 506.
Different types of model representations may be transformed or
mapped to XGL representations. For each type of model
representation, mapping rules may be provided for mapping the model
representation to the XGL representation 506. Different mapping
rules may be provided for mapping a model representation to an XGL
representation.
[0196] This XGL representation 506 that is created from a model
representation may then be used for processing in the runtime
environment. For example, the XGL representation 506 may be used to
generate a machine-executable runtime GUI (or some other runtime
representation) that may be executed by a target device. As part of
the runtime processing, the XGL representation 506 may be
transformed into one or more runtime representations, which may
indicate source code in a particular programming language,
machine-executable code for a specific runtime environment,
executable GUI, and so forth, which may be generated for specific
runtime environments and devices. Since the XGL representation 506,
rather than the design-time model representation, is used by the
runtime environment, the design-time model representation is
decoupled from the runtime environment. The XGL representation 506
can thus serve as the common ground or interface between
design-time user interface modeling tools and a plurality of user
interface runtime frameworks. It provides a self-contained, closed,
and deterministic definition of all aspects of a graphical user
interface in a device-independent and programming-language
independent manner. Accordingly, abstract representation 506
generated for a model representation 502 is generally declarative
and executable in that it provides a representation of the GUI of
model representation 502 that is not dependent on any device or
runtime platform, is not dependent on any programming language, and
unambiguously encapsulates execution semantics for the GUI. The
execution semantics may include, for example, identification of
various components of the GUI, interpretation of connections
between the various GUI components, information identifying the
order of sequencing of events, rules governing dynamic behavior of
the GUI, rules governing handling of values by the GUI, and the
like. The abstract representation 506 is also not GUI
runtime-platform specific. The abstract representation 506 provides
a self-contained, closed, and deterministic definition of all
aspects of a graphical user interface that is device independent
and language independent.
[0197] Abstract representation 506 is such that the appearance and
execution semantics of a GUI generated from the XGL representation
work consistently on different target devices irrespective of the
GUI capabilities of the target device and the target device
platform. For example, the same XGL representation may be mapped to
appropriate GUIs on devices of differing levels of GUI complexity
(i.e., the same abstract representation may be used to generate a
GUI for devices that support simple GUIs and for devices that can
support complex GUIs), the GUI generated by the devices are
consistent with each other in their appearance and behavior.
[0198] Abstract representation generator 504 may be configured to
generate abstract representation 506 for models of different types,
which may be created using different modeling tools 340. It will be
understood that modeling environment 516 may include some, none, or
other sub-modules or components as those shown in this example
illustration. In other words, modeling environment 516 encompasses
the design-time environment (with or without the abstract generator
or the various representations), a modeling toolkit (such as 340)
linked with a developer's space, or any other appropriate software
operable to decouple models created during design-time from the
runtime environment. Abstract representation 506 provides an
interface between the design time environment and the runtime
environment. As shown, this abstract representation 506 may then be
used by runtime processing.
[0199] As part of runtime processing, modeling environment 516 may
include various runtime tools 508 and may generate different types
of runtime representations based upon the abstract representation
506. Examples of runtime representations include device or
language-dependent (or specific) source code, runtime
platform-specific machine-readable code, GUIs for a particular
target device, and the like. The runtime tools 508 may include
compilers, interpreters, source code generators, and other such
tools that are configured to generate runtime platform-specific or
target device-specific runtime representations of abstract
representation 506. The runtime tool 508 may generate the runtime
representation from abstract representation 506 using specific
rules that map abstract representation 506 to a particular type of
runtime representation. These mapping rules may be dependent on the
type of runtime tool, characteristics of the target device to be
used for displaying the GUI, runtime platform, and/or other
factors. Accordingly, mapping rules may be provided for
transforming the abstract representation 506 to any number of
target runtime representations directed to one or more target GUI
runtime platforms. For example, XGL-compliant code generators may
conform to semantics of XGL, as described below. XGL-compliant code
generators may ensure that the appearance and behavior of the
generated user interfaces is preserved across a plurality of target
GUI frameworks, while accommodating the differences in the
intrinsic characteristics of each and also accommodating the
different levels of capability of target devices.
[0200] For example, as depicted in example FIG. 5A, an XGL-to-Java
compiler 508A may take abstract representation 506 as input and
generate Java code 510 for execution by a target device comprising
a Java runtime 512. Java runtime 512 may execute Java code 510 to
generate or display a GUI 514 on a Java-platform target device. As
another example, an XGL-to-Flash compiler 508B may take abstract
representation 506 as input and generate Flash code 526 for
execution by a target device comprising a Flash runtime 518. Flash
runtime 518 may execute Flash code 516 to generate or display a GUI
520 on a target device comprising a Flash platform. As another
example, an XGL-to-DHTML (dynamic HTML) interpreter 508C may take
abstract representation 506 as input and generate DHTML statements
(instructions) on the fly which are then interpreted by a DHTML
runtime 522 to generate or display a GUI 524 on a target device
comprising a DHTML platform.
[0201] It should be apparent that abstract representation 506 may
be used to generate GUIs for Extensible Application Markup Language
(XAML) or various other runtime platforms and devices. The same
abstract representation 506 may be mapped to various runtime
representations and device-specific and runtime platform-specific
GUIs. In general, in the runtime environment, machine executable
instructions specific to a runtime environment may be generated
based upon the abstract representation 506 and executed to generate
a GUI in the runtime environment. The same XGL representation may
be used to generate machine executable instructions specific to
different runtime environments and target devices.
[0202] According to certain embodiments, the process of mapping a
model representation 502 to an abstract representation 506 and
mapping an abstract representation 506 to some runtime
representation may be automated. For example, design tools may
automatically generate an abstract representation for the model
representation using XGL and then use the XGL abstract
representation to generate GUIs that are customized for specific
runtime environments and devices. As previously indicated, mapping
rules may be provided for mapping model representations to an XGL
representation. Mapping rules may also be provided for mapping an
XGL representation to a runtime platform-specific
representation.
[0203] Since the runtime environment uses abstract representation
506 rather than model representation 502 for runtime processing,
the model representation 502 that is created during design-time is
decoupled from the runtime environment. Abstract representation 506
thus provides an interface between the modeling environment and the
runtime environment. As a result, changes may be made to the design
time environment, including changes to model representation 502 or
changes that affect model representation 502, generally to not
substantially affect or impact the runtime environment or tools
used by the runtime environment. Likewise, changes may be made to
the runtime environment generally to not substantially affect or
impact the design time environment. A designer or other developer
can thus concentrate on the design aspects and make changes to the
design without having to worry about the runtime dependencies such
as the target device platform or programming language
dependencies.
[0204] FIG. 5B depicts an example process for mapping a model
representation 502 to a runtime representation using the example
modeling environment 516 of FIG. 5A or some other modeling
environment. Model representation 502 may comprise one or more
model components and associated properties that describe a data
object, such as hosted business objects and interfaces. As
described above, at least one of these model components is based on
or otherwise associated with these hosted business objects and
interfaces. The abstract representation 506 is generated based upon
model representation 502. Abstract representation 506 may be
generated by the abstract representation generator 504. Abstract
representation 506 comprises one or more abstract GUI components
and properties associated with the abstract GUI components. As part
of generation of abstract representation 506, the model GUI
components and their associated properties from the model
representation are mapped to abstract GUI components and properties
associated with the abstract GUI components. Various mapping rules
may be provided to facilitate the mapping. The abstract
representation encapsulates both appearance and behavior of a GUI.
Therefore, by mapping model components to abstract components, the
abstract representation not only specifies the visual appearance of
the GUI but also the behavior of the GUI, such as in response to
events whether clicking/dragging or scrolling, interactions between
GUI components and such.
[0205] One or more runtime representations 550a, including GUIs for
specific runtime environment platforms, may be generated from
abstract representation 506. A device-dependent runtime
representation may be generated for a particular type of target
device platform to be used for executing and displaying the GUI
encapsulated by the abstract representation. The GUIs generated
from abstract representation 506 may comprise various types of GUI
elements such as buttons, windows, scrollbars, input boxes, etc.
Rules may be provided for mapping an abstract representation to a
particular runtime representation. Various mapping rules may be
provided for different runtime environment platforms.
[0206] Methods and systems consistent with the subject matter
described herein provide and use interfaces 320 derived from the
business object model 318 suitable for use with more than one
business area, for example different departments within a company
such as finance, or marketing. Also, they are suitable across
industries and across businesses. Interfaces 320 are used during an
end-to-end business transaction to transfer business process
information in an application-independent manner. For example the
interfaces can be used for fulfilling a sales order.
[0207] 1. Message Overview
[0208] To perform an end-to-end business transaction, consistent
interfaces are used to create business documents that are sent
within messages between heterogeneous programs or modules.
[0209] a) Message Categories
[0210] As depicted in FIG. 6, the communication between a sender
602 and a recipient 604 can be broken down into basic categories
that describe the type of the information exchanged and
simultaneously suggest the anticipated reaction of the recipient
604. A message category is a general business classification for
the messages. Communication is sender-driven. In other words, the
meaning of the message categories is established or formulated from
the perspective of the sender 602. The message categories include
information 606, notification 608, query 610, response 612, request
614, and confirmation 616.
[0211] (1) Information
[0212] Information 606 is a message sent from a sender 602 to a
recipient 604 concerning a condition or a statement of affairs. No
reply to information is expected. Information 606 is sent to make
business partners or business applications aware of a situation.
Information 606 is not compiled to be application-specific.
Examples of "information" are an announcement, advertising, a
report, planning information, and a message to the business
warehouse.
[0213] (2) Notification
[0214] A notification 608 is a notice or message that is geared to
a service. A sender 602 sends the notification 608 to a recipient
604. No reply is expected for a notification. For example, a
billing notification relates to the preparation of an invoice while
a dispatched delivery notification relates to preparation for
receipt of goods.
[0215] (3) Query
[0216] A query 610 is a question from a sender 602 to a recipient
604 to which a response 612 is expected. A query 610 implies no
assurance or obligation on the part of the sender 602. Examples of
a query 610 are whether space is available on a specific flight or
whether a specific product is available. These queries do not
express the desire for reserving the flight or purchasing the
product.
[0217] (4) Response
[0218] A response 612 is a reply to a query 610. The recipient 604
sends the response 612 to the sender 602. A response 612 generally
implies no assurance or obligation on the part of the recipient
604. The sender 602 is not expected to reply. Instead, the process
is concluded with the response 612. Depending on the business
scenario, a response 612 also may include a commitment, i.e., an
assurance or obligation on the part of the recipient 604. Examples
of responses 612 are a response stating that space is available on
a specific flight or that a specific product is available. With
these responses, no reservation was made.
[0219] (5) Request
[0220] A request 614 is a binding requisition or requirement from a
sender 602 to a recipient 604. Depending on the business scenario,
the recipient 604 can respond to a request 614 with a confirmation
616. The request 614 is binding on the sender 602. In making the
request 614, the sender 602 assumes, for example, an obligation to
accept the services rendered in the request 614 under the reported
conditions. Examples of a request 614 are a parking ticket, a
purchase order, an order for delivery and a job application.
[0221] (6) Confirmation
[0222] A confirmation 616 is a binding reply that is generally made
to a request 614. The recipient 604 sends the confirmation 616 to
the sender 602. The information indicated in a confirmation 616,
such as deadlines, products, quantities and prices, can deviate
from the information of the preceding request 614. A request 614
and confirmation 616 may be used in negotiating processes. A
negotiating process can consist of a series of several request 614
and confirmation 616 messages. The confirmation 616 is binding on
the recipient 604. For example, 100 units of X may be ordered in a
purchase order request; however, only the delivery of 80 units is
confirmed in the associated purchase order confirmation.
[0223] b) Message Choreography
[0224] A message choreography is a template that specifies the
sequence of messages between business entities during a given
transaction. The sequence with the messages contained in it
describes in general the message "lifecycle" as it proceeds between
the business entities. If messages from a choreography are used in
a business transaction, they appear in the transaction in the
sequence determined by the choreography. This illustrates the
template character of a choreography, i.e., during an actual
transaction, it is not necessary for all messages of the
choreography to appear. Those messages that are contained in the
transaction, however, follow the sequence within the choreography.
A business transaction is thus a derivation of a message
choreography. The choreography makes it possible to determine the
structure of the individual message types more precisely and
distinguish them from one another.
[0225] 2. Components of the Business Object Model
[0226] The overall structure of the business object model ensures
the consistency of the interfaces that are derived from the
business object model. The derivation ensures that the same
business-related subject matter or concept is represented and
structured in the same way in all interfaces.
[0227] The business object model defines the business-related
concepts at a central location for a number of business
transactions. In other words, it reflects the decisions made about
modeling the business entities of the real world acting in business
transactions across industries and business areas. The business
object model is defined by the business objects and their
relationship to each other (the overall net structure).
[0228] Each business object is generally a capsule with an internal
hierarchical structure, behavior offered by its operations, and
integrity constraints. Business objects are semantically disjoint,
i.e., the same business information is represented once. In the
business object model, the business objects are arranged in an
ordering framework. From left to right, they are arranged according
to their existence dependency to each other. For example, the
customizing elements may be arranged on the left side of the
business object model, the strategic elements may be arranged in
the center of the business object model, and the operative elements
may be arranged on the right side of the business object model.
Similarly, the business objects are arranged from the top to the
bottom based on defined order of the business areas, e.g., finance
could be arranged at the top of the business object model with CRM
below finance and SRM below CRM.
[0229] To ensure the consistency of interfaces, the business object
model may be built using standardized data types as well as
packages to group related elements together, and package templates
and entity templates to specify the arrangement of packages and
entities within the structure.
[0230] a) Data Types
[0231] Data types are used to type object entities and interfaces
with a structure. This typing can include business semantic. Such
data types may include those generally described at pages 96
through 1642 (which are incorporated by reference herein) of U.S.
patent application Ser. No. 11/803,178, filed on May 11, 2007 and
entitled "Consistent Set Of Interfaces Derived From A Business
Object Model". For example, the data type
BusinessTransactionDocumentID is a unique identifier for a document
in a business transaction. Also, as an example, Data type
BusinessTransactionDocumentParty contains the information that is
exchanged in business documents about a party involved in a
business transaction, and includes the party's identity, the
party's address, the party's contact person and the contact
person's address. BusinessTransactionDocumentParty also includes
the role of the party, e.g., a buyer, seller, product recipient, or
vendor.
[0232] The data types are based on Core Component Types ("CCTs"),
which themselves are based on the World Wide Web Consortium ("W3C")
data types. "Global" data types represent a business situation that
is described by a fixed structure. Global data types include both
context-neutral generic data types ("GDTs") and context-based
context data types ("CDTs"). GDTs contain business semantics, but
are application-neutral, i.e., without context. CDTs, on the other
hand, are based on GDTs and form either a use-specific view of the
GDTs, or a context-specific assembly of GDTs or CDTs. A message is
typically constructed with reference to a use and is thus a
use-specific assembly of GDTs and CDTs. The data types can be
aggregated to complex data types.
[0233] To achieve a harmonization across business objects and
interfaces, the same subject matter is typed with the same data
type. For example, the data type "GeoCoordinates" is built using
the data type "Measure" so that the measures in a GeoCoordinate
(i.e., the latitude measure and the longitude measure) are
represented the same as other "Measures" that appear in the
business object model.
[0234] b) Entities
[0235] Entities are discrete business elements that are used during
a business transaction. Entities are not to be confused with
business entities or the components that interact to perform a
transaction. Rather, "entities" are one of the layers of the
business object model and the interfaces. For example, a Catalogue
entity is used in a Catalogue Publication Request and a Purchase
Order is used in a Purchase Order Request. These entities are
created using the data types defined above to ensure the consistent
representation of data throughout the entities.
[0236] c) Packages
[0237] Packages group the entities in the business object model and
the resulting interfaces into groups of semantically associated
information. Packages also may include "sub"-packages, i.e., the
packages may be nested.
[0238] Packages may group elements together based on different
factors, such as elements that occur together as a rule with regard
to a business-related aspect. For example, as depicted in FIG. 7,
in a Purchase Order, different information regarding the purchase
order, such as the type of payment 702, and payment card 704, are
grouped together via the PaymentInformation package 700.
[0239] Packages also may combine different components that result
in a new object. For example, as depicted in FIG. 8, the components
wheels 804, motor 806, and doors 808 are combined to form a
composition "Car" 802. The "Car" package 800 includes the wheels,
motor and doors as well as the composition "Car."
[0240] Another grouping within a package may be subtypes within a
type. In these packages, the components are specialized forms of a
generic package. For example, as depicted in FIG. 9, the components
Car 904, Boat 906, and Truck 908 can be generalized by the generic
term Vehicle 902 in Vehicle package 900. Vehicle in this case is
the generic package 910, while Car 912, Boat 914, and Truck 916 are
the specializations 918 of the generalized vehicle 910.
[0241] Packages also may be used to represent hierarchy levels. For
example, as depicted in FIG. 10, the Item Package 1000 includes
Item 1002 with subitem xxx 1004, subitem yyy 1006, and subitem zzz
1008.
[0242] Packages can be represented in the XML schema as a comment.
One advantage of this grouping is that the document structure is
easier to read and is more understandable. The names of these
packages are assigned by including the object name in brackets with
the suffix "Package." For example, as depicted in FIG. 11, Party
package 1100 is enclosed by <PartyPackage> 1102 and
</PartyPackage> 1104. Party package 1100 illustratively
includes a Buyer Party 1106, identified by <BuyerParty> 1108
and </BuyerParty> 1110, and a Seller Party 1112, identified
by <SellerParty> 1114 and </SellerParty>, etc.
[0243] d) Relationships
[0244] Relationships describe the interdependencies of the entities
in the business object model, and are thus an integral part of the
business object model.
(1) Cardinality of Relationships
[0245] FIG. 12 depicts a graphical representation of the
cardinalities between two entities. The cardinality between a first
entity and a second entity identifies the number of second entities
that could possibly exist for each first entity. Thus, a 1:c
cardinality 1200 between entities A 1202 and X 1204 indicates that
for each entity A 1202, there is either one or zero 1206 entity X
1204. A 1:1 cardinality 1208 between entities A 1210 and X 1212
indicates that for each entity A 1210, there is exactly one 1214
entity X 1212. A 1:n cardinality 1216 between entities A 1218 and X
1220 indicates that for each entity A 1218, there are one or more
1222 entity Xs 1220. A 1:cn cardinality 1224 between entities A
1226 and X 1228 indicates that for each entity A 1226, there are
any number 1230 of entity Xs 1228 (i.e., 0 through n Xs for each
A).
[0246] (2) Types of Relationships
[0247] (a) Composition
[0248] A composition or hierarchical relationship type is a strong
whole-part relationship which is used to describe the structure
within an object. The parts, or dependent entities, represent a
semantic refinement or partition of the whole, or less dependent
entity. For example, as depicted in FIG. 13, the components 1302,
wheels 1304, and doors 1306 may be combined to form the composite
1300 "Car" 1308 using the composition 1310. FIG. 14 depicts a
graphical representation of the composition 1410 between composite
Car 1408 and components wheel 1404 and door 1406.
[0249] (b) Aggregation
[0250] An aggregation or an aggregating relationship type is a weak
whole-part relationship between two objects. The dependent object
is created by the combination of one or several less dependent
objects. For example, as depicted in FIG. 15, the properties of a
competitor product 1500 are determined by a product 1502 and a
competitor 1504. A hierarchical relationship 1506 exists between
the product 1502 and the competitor product 1500 because the
competitor product 1500 is a component of the product 1502.
Therefore, the values of the attributes of the competitor product
1500 are determined by the product 1502. An aggregating
relationship 1508 exists between the competitor 1504 and the
competitor product 1500 because the competitor product 1500 is
differentiated by the competitor 1504. Therefore the values of the
attributes of the competitor product 1500 are determined by the
competitor 1504.
[0251] (c) Association
[0252] An association or a referential relationship type describes
a relationship between two objects in which the dependent object
refers to the less dependent object. For example, as depicted in
FIG. 16, a person 1600 has a nationality, and thus, has a reference
to its country 1602 of origin. There is an association 1604 between
the country 1602 and the person 1600. The values of the attributes
of the person 1600 are not determined by the country 1602.
[0253] (3) Specialization
[0254] Entity types may be divided into subtypes based on
characteristics of the entity types. For example, FIG. 17 depicts
an entity type "vehicle" 1700 specialized 1702 into subtypes
"truck" 1704, "car" 1706, and "ship" 1708. These subtypes represent
different aspects or the diversity of the entity type.
[0255] Subtypes may be defined based on related attributes. For
example, although ships and cars are both vehicles, ships have an
attribute, "draft," that is not found in cars. Subtypes also may be
defined based on certain methods that can be applied to entities of
this subtype and that modify such entities. For example, "drop
anchor" can be applied to ships. If outgoing relationships to a
specific object are restricted to a subset, then a subtype can be
defined which reflects this subset.
[0256] As depicted in FIG. 18, specializations may further be
characterized as complete specializations 1800 or incomplete
specializations 1802. There is a complete specialization 1800 where
each entity of the generalized type belongs to at least one
subtype. With an incomplete specialization 1802, there is at least
one entity that does not belong to a subtype. Specializations also
may be disjoint 1804 or nondisjoint 1806. In a disjoint
specialization 1804, each entity of the generalized type belongs to
a maximum of one subtype. With a nondisjoint specialization 1806,
one entity may belong to more than one subtype. As depicted in FIG.
18, four specialization categories result from the combination of
the specialization characteristics.
[0257] e) Structural Patterns
[0258] (1) Item
[0259] An item is an entity type which groups together features of
another entity type. Thus, the features for the entity type chart
of accounts are grouped together to form the entity type chart of
accounts item. For example, a chart of accounts item is a category
of values or value flows that can be recorded or represented in
amounts of money in accounting, while a chart of accounts is a
superordinate list of categories of values or value flows that is
defined in accounting.
[0260] The cardinality between an entity type and its item is often
either 1:n or 1:cn. For example, in the case of the entity type
chart of accounts, there is a hierarchical relationship of the
cardinality 1:n with the entity type chart of accounts item since a
chart of accounts has at least one item in all cases.
[0261] (2) Hierarchy
[0262] A hierarchy describes the assignment of subordinate entities
to superordinate entities and vice versa, where several entities of
the same type are subordinate entities that have, at most, one
directly superordinate entity. For example, in the hierarchy
depicted in FIG. 19, entity B 1902 is subordinate to entity A 1900,
resulting in the relationship (A,B) 1912. Similarly, entity C 1904
is subordinate to entity A 1900, resulting in the relationship
(A,C) 1914. Entity D 1906 and entity E 1908 are subordinate to
entity B 1902, resulting in the relationships (B,D) 1916 and (B,E)
1918, respectively. Entity F 1910 is subordinate to entity C 1904,
resulting in the relationship (C,F) 1920.
[0263] Because each entity has at most one superordinate entity,
the cardinality between a subordinate entity and its superordinate
entity is 1:c. Similarly, each entity may have 0, 1 or many
subordinate entities. Thus, the cardinality between a superordinate
entity and its subordinate entity is 1:cn. FIG. 20 depicts a
graphical representation of a Closing Report Structure Item
hierarchy 2000 for a Closing Report Structure Item 2002. The
hierarchy illustrates the 1:c cardinality 2004 between a
subordinate entity and its superordinate entity, and the 1:cn
cardinality 2006 between a superordinate entity and its subordinate
entity.
[0264] 3. Creation of the Business Object Model
[0265] FIGS. 21A-B depict the steps performed using methods and
systems consistent with the subject matter described herein to
create a business object model. Although some steps are described
as being performed by a computer, these steps may alternatively be
performed manually, or computer-assisted, or any combination
thereof. Likewise, although some steps are described as being
performed by a computer, these steps may also be computer-assisted,
or performed manually, or any combination thereof.
[0266] As discussed above, the designers create message
choreographies that specify the sequence of messages between
business entities during a transaction. After identifying the
messages, the developers identify the fields contained in one of
the messages (step 2100, FIG. 21A). The designers then determine
whether each field relates to administrative data or is part of the
object (step 2102). Thus, the first eleven fields identified below
in the left column are related to administrative data, while the
remaining fields are part of the
TABLE-US-00001 MessageID Admin ReferenceID CreationDate SenderID
AdditionalSenderID ContactPersonID SenderAddress RecipientID
AdditionalRecipientID ContactPersonID RecipientAddress ID Main
Object AdditionalID PostingDate LastChangeDate AcceptanceStatus
Note CompleteTransmission Indicator Buyer BuyerOrganisationName
Person Name FunctionalTitle DepartmentName CountryCode
StreetPostalCode POBox Postal Code Company Postal Code City Name
DistrictName PO Box ID PO Box Indicator PO Box Country Code PO Box
Region Code PO Box City Name Street Name House ID Building ID Floor
ID Room ID Care Of Name AddressDescription Telefonnumber
MobileNumber Facsimile Email Seller SellerAddress Location
LocationType DeliveryItemGroupID DeliveryPriority DeliveryCondition
TransferLocation NumberofPartialDelivery QuantityTolerance
MaximumLeadTime TransportServiceLevel TranportCondition
TransportDescription CashDiscountTerms PaymentForm PaymentCardID
PaymentCardReferenceID SequenceID Holder ExpirationDate
AttachmentID AttachmentFilename DescriptionofMessage
ConfirmationDescriptionof Message FollowUpActivity ItemID
ParentItemID HierarchyType ProductID ProductType ProductNote
ProductCategoryID Amount BaseQuantity ConfirmedAmount
ConfirmedBaseQuantity ItemBuyer ItemBuyerOrganisationName Person
Name FunctionalTitle DepartmentName CountryCode StreetPostalCode
POBox Postal Code Company Postal Code City Name DistrictName PO Box
ID PO Box Indicator PO Box Country Code PO Box Region Code PO Box
City Name Street Name House ID Building ID Floor ID Room ID Care Of
Name AddressDescription Telefonnumber MobilNumber Facsimile Email
ItemSeller ItemSellerAddress ItemLocation ItemLocationType
ItemDeliveryItemGroupID ItemDeliveryPriority ItemDeliveryCondition
ItemTransferLocation ItemNumberofPartialDelivery
ItemQuantityTolerance ItemMaximumLeadTime ItemTransportServiceLevel
ItemTranportCondition ItemTransportDescription ContractReference
QuoteReference CatalogueReference ItemAttachmentID
ItemAttachmentFilename ItemDescription ScheduleLineID
DeliveryPeriod Quantity ConfirmedScheduleLineID
ConfirmedDeliveryPeriod ConfirmedQuantity
[0267] Next, the designers determine the proper name for the object
according to the ISO 11179 naming standards (step 2104). In the
example above, the proper name for the "Main Object" is "Purchase
Order." After naming the object, the system that is creating the
business object model determines whether the object already exists
in the business object model (step 2106). If the object already
exists, the system integrates new attributes from the message into
the existing object (step 2108), and the process is complete.
[0268] If at step 2106 the system determines that the object does
not exist in the business object model, the designers model the
internal object structure (step 2110). To model the internal
structure, the designers define the components. For the above
example, the designers may define the components identified
below.
TABLE-US-00002 ID Purchase AdditionalID Order PostingDate
LastChangeDate AcceptanceStatus Note CompleteTransmission Indicator
Buyer Buyer BuyerOrganisationName Person Name FunctionalTitle
DepartmentName CountryCode StreetPostalCode POBox Postal Code
Company Postal Code City Name DistrictName PO Box ID PO Box
Indicator PO Box Country Code PO Box Region Code PO Box City Name
Street Name House ID Building ID Floor ID Room ID Care Of Name
AddressDescription Telefonnumber MobileNumber Facsimile Email
Seller Seller SellerAddress Location Location LocationType
DeliveryItemGroupID Delivery- DeliveryPriority Terms
DeliveryCondition TransferLocation NumberofPartialDelivery
QuantityTolerance MaximumLeadTime TransportServiceLevel
TranportCondition TransportDescription CashDiscountTerms
PaymentForm Payment PaymentCardID PaymentCardReferenceID SequenceID
Holder ExpirationDate AttachmentID AttachmentFilename
DescriptionofMessage ConfirmationDescriptionof Message
FollowUpActivity ItemID Purchase ParentItemID Order HierarchyType
Item ProductID Product ProductType ProductNote ProductCategoryID
ProductCategory Amount BaseQuantity ConfirmedAmount
ConfirmedBaseQuantity ItemBuyer Buyer ItemBuyerOrganisation Name
Person Name FunctionalTitle DepartmentName CountryCode
StreetPostalCode POBox Postal Code Company Postal Code City Name
DistrictName PO Box ID PO Box Indicator PO Box Country Code PO Box
Region Code PO Box City Name Street Name House ID Building ID Floor
ID Room ID Care Of Name AddressDescription Telefonnumber
MobilNumber Facsimile Email ItemSeller Seller ItemSellerAddress
ItemLocation Location ItemLocationType ItemDeliveryItemGroupID
ItemDeliveryPriority ItemDeliveryCondition ItemTransferLocation
ItemNumberofPartial Delivery ItemQuantityTolerance
ItemMaximumLeadTime ItemTransportServiceLevel ItemTranportCondition
ItemTransportDescription ContractReference Contract QuoteReference
Quote CatalogueReference Catalogue ItemAttachmentID
ItemAttachmentFilename ItemDescription ScheduleLineID
DeliveryPeriod Quantity ConfirmedScheduleLineID
ConfirmedDeliveryPeriod ConfirmedQuantity
[0269] During the step of modeling the internal structure, the
designers also model the complete internal structure by identifying
the compositions of the components and the corresponding
cardinalities, as shown below.
TABLE-US-00003 PurchaseOrder 1 Buyer 0 . . . 1 Address 0 . . . 1
ContactPerson 0 . . . 1 Address 0 . . . 1 Seller 0 . . . 1 Location
0 . . . 1 Address 0 . . . 1 DeliveryTerms 0 . . . 1 Incoterms 0 . .
. 1 PartialDelivery 0 . . . 1 QuantityTolerance 0 . . . 1 Transport
0 . . . 1 CashDiscount 0 . . . 1 Terms MaximumCashDiscount 0 . . .
1 NormalCashDiscount 0 . . . 1 PaymentForm 0 . . . 1 PaymentCard 0
. . . 1 Attachment 0 . . . n Description 0 . . . 1 Confirmation 0 .
. . 1 Description Item 0 . . . n HierarchyRelationship 0 . . . 1
Product 0 . . . 1 ProductCategory 0 . . . 1 Price 0 . . . 1
NetunitPrice 0 . . . 1 ConfirmedPrice 0 . . . 1 NetunitPrice 0 . .
. 1 Buyer 0 . . . 1 Seller 0 . . . 1 Location 0 . . . 1
DeliveryTerms 0 . . . 1 Attachment 0 . . . n Description 0 . . . 1
ConfirmationDescription 0 . . . 1 ScheduleLine 0 . . . n
DeliveryPeriod 1 ConfirmedScheduleLine 0 . . . n
[0270] After modeling the internal object structure, the developers
identify the subtypes and generalizations for all objects and
components (step 2112). For example, the Purchase Order may have
subtypes Purchase Order Update, Purchase Order Cancellation and
Purchase Order Information. Purchase Order Update may include
Purchase Order Request, Purchase Order Change, and Purchase Order
Confirmation. Moreover, Party may be identified as the
generalization of Buyer and Seller. The subtypes and
generalizations for the above example are shown below.
TABLE-US-00004 Purchase 1 Order PurchaseOrder Update PurchaseOrder
Request PurchaseOrder Change PurchaseOrder Confirmation
PurchaseOrder Cancellation PurchaseOrder Information Party
BuyerParty 0 . . . 1 Address 0 . . . 1 ContactPerson 0 . . . 1
Address 0 . . . 1 SellerParty 0 . . . 1 Location ShipToLocation 0 .
. . 1 Address 0 . . . 1 ShipFromLocation 0 . . . 1 Address 0 . . .
1 DeliveryTerms 0 . . . 1 Incoterms 0 . . . 1 PartialDelivery 0 . .
. 1 QuantityTolerance 0 . . . 1 Transport 0 . . . 1 CashDiscount 0
. . . 1 Terms MaximumCash Discount 0 . . . 1 NormalCashDiscount 0 .
. . 1 PaymentForm 0 . . . 1 PaymentCard 0 . . . 1 Attachment 0 . .
. n Description 0 . . . 1 Confirmation 0 . . . 1 Description Item 0
. . . n HierarchyRelationship 0 . . . 1 Product 0 . . . 1
ProductCategory 0 . . . 1 Price 0 . . . 1 NetunitPrice 0 . . . 1
ConfirmedPrice 0 . . . 1 NetunitPrice 0 . . . 1 Party BuyerParty 0
. . . 1 SellerParty 0 . . . 1 Location ShipTo 0 . . . 1 Location
ShipFrom 0 . . . 1 Location DeliveryTerms 0 . . . 1 Attachment 0 .
. . n Description 0 . . . 1 Confirmation 0 . . . 1 Description
ScheduleLine 0 . . . n Delivery 1 Period ConfirmedScheduleLine 0 .
. . n
[0271] After identifying the subtypes and generalizations, the
developers assign the attributes to these components (step 2114).
The attributes for a portion of the components are shown below.
TABLE-US-00005 Purchase 1 Order ID 1 SellerID 0 . . . 1
BuyerPosting 0 . . . 1 DateTime BuyerLast 0 . . . 1 ChangeDate Time
SellerPosting 0 . . . 1 DateTime SellerLast 0 . . . 1 ChangeDate
Time Acceptance 0 . . . 1 StatusCode Note 0 . . . 1 ItemList 0 . .
. 1 Complete Transmission Indicator BuyerParty 0 . . . 1 StandardID
0 . . . n BuyerID 0 . . . 1 SellerID 0 . . . 1 Address 0 . . . 1
ContactPerson 0 . . . 1 BuyerID 0 . . . 1 SellerID 0 . . . 1
Address 0 . . . 1 SellerParty 0 . . . 1 Product 0 . . . 1
RecipientParty VendorParty 0 . . . 1 Manufacturer 0 . . . 1 Party
BillToParty 0 . . . 1 PayerParty 0 . . . 1 CarrierParty 0 . . . 1
ShipTo 0 . . . 1 Location StandardID 0 . . . n BuyerID 0 . . . 1
SellerID 0 . . . 1 Address 0 . . . 1 ShipFrom 0 . . . 1
Location
[0272] The system then determines whether the component is one of
the object nodes in the business object model (step 2116, FIG.
21B). If the system determines that the component is one of the
object nodes in the business object model, the system integrates a
reference to the corresponding object node from the business object
model into the object (step 2118). In the above example, the system
integrates the reference to the Buyer party represented by an ID
and the reference to the ShipToLocation represented by an into the
object, as shown below. The attributes that were formerly located
in the PurchaseOrder object are now assigned to the new found
object party. Thus, the attributes are removed from the
PurchaseOrder object.
TABLE-US-00006 PurchaseOrder ID SellerID BuyerPostingDateTime
BuyerLastChangeDateTime SellerPostingDateTime
SellerLastChangeDateTime AcceptanceStatusCode Note ItemListComplete
TransmissionIndicator BuyerParty ID SellerParty
ProductRecipientParty VendorParty ManufacturerParty BillToParty
PayerParty CarrierParty ShipToLocation ID ShipFromLocation
[0273] During the integration step, the designers classify the
relationship (i.e., aggregation or association) between the object
node and the object being integrated into the business object
model. The system also integrates the new attributes into the
object node (step 2120). If at step 2116, the system determines
that the component is not in the business object model, the system
adds the component to the business object model (step 2122).
[0274] Regardless of whether the component was in the business
object model at step 2116, the next step in creating the business
object model is to add the integrity rules (step 2124). There are
several levels of integrity rules and constraints which should be
described. These levels include consistency rules between
attributes, consistency rules between components, and consistency
rules to other objects. Next, the designers determine the services
offered, which can be accessed via interfaces (step 2126). The
services offered in the example above include
PurchaseOrderCreateRequest, PurchaseOrderCancellationRequest, and
PurchaseOrderReleaseRequest. The system then receives an indication
of the location for the object in the business object model (step
2128). After receiving the indication of the location, the system
integrates the object into the business object model (step
2130).
[0275] 4. Structure of the Business Object Model
[0276] The business object model, which serves as the basis for the
process of generating consistent interfaces, includes the elements
contained within the interfaces. These elements are arranged in a
hierarchical structure within the business object model.
[0277] 5. Interfaces Derived from Business Object Model
[0278] Interfaces are the starting point of the communication
between two business entities. The structure of each interface
determines how one business entity communicates with another
business entity. The business entities may act as a unified whole
when, based on the business scenario, the business entities know
what an interface contains from a business perspective and how to
fill the individual elements or fields of the interface. As
illustrated in FIG. 27A, communication between components takes
place via messages that contain business documents (e.g., business
document 27002). The business document 27002 ensures a holistic
business-related understanding for the recipient of the message.
The business documents are created and accepted or consumed by
interfaces, specifically by inbound and outbound interfaces. The
interface structure and, hence, the structure of the business
document are derived by a mapping rule. This mapping rule is known
as "hierarchization." An interface structure thus has a
hierarchical structure created based on the leading business object
27000. The interface represents a usage-specific, hierarchical view
of the underlying usage-neutral object model.
[0279] As illustrated in FIG. 27B, several business document
objects 27006, 27008, and 27010 as overlapping views may be derived
for a given leading object 27004. Each business document object
results from the object model by hierarchization.
[0280] To illustrate the hierarchization process, FIG. 27C depicts
an example of an object model 27012 (i.e., a portion of the
business object model) that is used to derive a service operation
signature (business document object structure). As depicted,
leading object X 27014 in the object model 27012 is integrated in a
net of object A 27016, object B 27018, and object C 27020.
Initially, the parts of the leading object 27014 that are required
for the business object document are adopted. In one variation, all
parts required for a business document object are adopted from
leading object 27014 (making such an operation a maximal service
operation). Based on these parts, the relationships to the
superordinate objects (i.e., objects A, B, and C from which object
X depends) are inverted. In other words, these objects are adopted
as dependent or subordinate objects in the new business document
object.
[0281] For example, object A 27016, object B 27018, and object C
27020 have information that characterize object X. Because object A
27016, object B 27018, and object C 27020 are superordinate to
leading object X 27014, the dependencies of these relationships
change so that object A 27016, object B 27018, and object C 27020
become dependent and subordinate to leading object X 27014. This
procedure is known as "derivation of the business document object
by hierarchization."
[0282] Business-related objects generally have an internal
structure (parts). This structure can be complex and reflect the
individual parts of an object and their mutual dependency. When
creating the operation signature, the internal structure of an
object is strictly hierarchized. Thus, dependent parts keep their
dependency structure, and relationships between the parts within
the object that do not represent the hierarchical structure are
resolved by prioritizing one of the relationships.
[0283] Relationships of object X to external objects that are
referenced and whose information characterizes object X are added
to the operation signature. Such a structure can be quite complex
(see, for example, FIG. 27D). The cardinality to these referenced
objects is adopted as 1:1 or 1:C, respectively. By this, the
direction of the dependency changes. The required parts of this
referenced object are adopted identically, both in their
cardinality and in their dependency arrangement.
[0284] The newly created business document object contains all
required information, including the incorporated master data
information of the referenced objects. As depicted in FIG. 27D,
components Xi in leading object X 27022 are adopted directly. The
relationship of object X 27022 to object A 27024, object B 27028,
and object C 27026 are inverted, and the parts required by these
objects are added as objects that depend from object X 27022. As
depicted, all of object A 27024 is adopted. B3 and B4 are adopted
from object B 27028, but B1 is not adopted. From object C 27026, C2
and C1 are adopted, but C3 is not adopted.
[0285] FIG. 27E depicts the business document object X 27030
created by this hierarchization process. As shown, the arrangement
of the elements corresponds to their dependency levels, which
directly leads to a corresponding representation as an XML
structure 27032.
[0286] The following provides certain rules that can be adopted
singly or in combination with regard to the hierarchization
process: [0287] A business document object always refers to a
leading business document object and is derived from this object.
[0288] The name of the root entity in the business document entity
is the name of the business object or the name of a specialization
of the business object or the name of a service specific view onto
the business object. [0289] The nodes and elements of the business
object that are relevant (according to the semantics of the
associated message type) are contained as entities and elements in
the business document object. [0290] The name of a business
document entity is predefined by the name of the corresponding
business object node. The name of the superordinate entity is not
repeated in the name of the business document entity. The "full"
semantic name results from the concatenation of the entity names
along the hierarchical structure of the business document object.
[0291] The structure of the business document object is, except for
deviations due to hierarchization, the same as the structure of the
business object. [0292] The cardinalities of the business document
object nodes and elements are adopted identically or more
restrictively to the business document object. [0293] An object
from which the leading business object is dependent can be adopted
to the business document object. For this arrangement, the
relationship is inverted, and the object (or its parts,
respectively) are hierarchically subordinated in the business
document object. [0294] Nodes in the business object representing
generalized business information can be adopted as explicit
entities to the business document object (generally speaking,
multiply TypeCodes out). When this adoption occurs, the entities
are named according to their more specific semantic (name of
TypeCode becomes prefix). [0295] Party nodes of the business object
are modeled as explicit entities for each party role in the
business document object. These nodes are given the name
<Prefix><Party Role>Party, for example, BuyerParty,
ItemBuyerParty. [0296] BTDReference nodes are modeled as separate
entities for each reference type in the business document object.
These nodes are given the name
<Qualifier><BO><Node>Reference, for example
SalesOrderReference, OriginSalesOrderReference,
SalesOrderItemReference. [0297] A product node in the business
object comprises all of the information on the Product,
ProductCategory, and Batch. This information is modeled in the
business document object as explicit entities for Product,
ProductCategory, and Batch. [0298] Entities which are connected by
a 1:1 relationship as a result of hierarchization can be combined
to a single entity, if they are semantically equivalent. Such a
combination can often occurs if a node in the business document
object that results from an assignment node is removed because it
does not have any elements. [0299] The message type structure is
typed with data types. [0300] Elements are typed by GDTs according
to their business objects. [0301] Aggregated levels are typed with
message type specific data types (Intermediate Data Types), with
their names being built according to the corresponding paths in the
message type structure. [0302] The whole message type structured is
typed by a message data type with its name being built according to
the root entity with the suffix "Message". [0303] For the message
type, the message category (e.g., information, notification, query,
response, request, confirmation, etc.) is specified according to
the suited transaction communication pattern.
[0304] In one variation, the derivation by hierarchization can be
initiated by specifying a leading business object and a desired
view relevant for a selected service operation. This view
determines the business document object. The leading business
object can be the source object, the target object, or a third
object. Thereafter, the parts of the business object required for
the view are determined. The parts are connected to the root node
via a valid path along the hierarchy. Thereafter, one or more
independent objects (object parts, respectively) referenced by the
leading object which are relevant for the service may be determined
(provided that a relationship exists between the leading object and
the one or more independent objects).
[0305] Once the selection is finalized, relevant nodes of the
leading object node that are structurally identical to the message
type structure can then be adopted. If nodes are adopted from
independent objects or object parts, the relationships to such
independent objects or object parts are inverted. Linearization can
occur such that a business object node containing certain TypeCodes
is represented in the message type structure by explicit entities
(an entity for each value of the TypeCode). The structure can be
reduced by checking all 1:1 cardinalities in the message type
structure. Entities can be combined if they are semantically
equivalent, one of the entities carries no elements, or an entity
solely results from an n:m assignment in the business object.
[0306] After the hierarchization is completed, information
regarding transmission of the business document object (e.g.,
CompleteTransmissionIndicator, ActionCodes, message category, etc.)
can be added. A standardized message header can be added to the
message type structure and the message structure can be typed.
Additionally, the message category for the message type can be
designated.
[0307] Invoice Request and Invoice Confirmation are examples of
interfaces. These invoice interfaces are used to exchange invoices
and invoice confirmations between an invoicing party and an invoice
recipient (such as between a seller and a buyer) in a B2B process.
Companies can create invoices in electronic as well as in paper
form. Traditional methods of communication, such as mail or fax,
for invoicing are cost intensive, prone to error, and relatively
slow, since the data is recorded manually. Electronic communication
eliminates such problems. The motivating business scenarios for the
Invoice Request and Invoice Confirmation interfaces are the Procure
to Stock (PTS) and Sell from Stock (SFS) scenarios. In the PTS
scenario, the parties use invoice interfaces to purchase and settle
goods. In the SFS scenario, the parties use invoice interfaces to
sell and invoice goods. The invoice interfaces directly integrate
the applications implementing them and also form the basis for
mapping data to widely-used XML standard formats such as
RosettaNet, PIDX, xCBL, and CIDX.
[0308] The invoicing party may use two different messages to map a
B2B invoicing process: (1) the invoicing party sends the message
type InvoiceRequest to the invoice recipient to start a new
invoicing process; and (2) the invoice recipient sends the message
type InvoiceConfirmation to the invoicing party to confirm or
reject an entire invoice or to temporarily assign it the status
"pending."
[0309] An InvoiceRequest is a legally binding notification of
claims or liabilities for delivered goods and rendered
services--usually, a payment request for the particular goods and
services. The message type InvoiceRequest is based on the message
data type InvoiceMessage. The InvoiceRequest message (as defined)
transfers invoices in the broader sense. This includes the specific
invoice (request to settle a liability), the debit memo, and the
credit memo.
[0310] InvoiceConfirmation is a response sent by the recipient to
the invoicing party confirming or rejecting the entire invoice
received or stating that it has been assigned temporarily the
status "pending." The message type InvoiceConfirmation is based on
the message data type InvoiceMessage. An InvoiceConfirmation is not
mandatory in a B2B invoicing process, however, it automates
collaborative processes and dispute management.
[0311] Usually, the invoice is created after it has been confirmed
that the goods were delivered or the service was provided. The
invoicing party (such as the seller) starts the invoicing process
by sending an InvoiceRequest message. Upon receiving the
InvoiceRequest message, the invoice recipient (for instance, the
buyer) can use the InvoiceConfirmation message to completely accept
or reject the invoice received or to temporarily assign it the
status "pending." The InvoiceConfirmation is not a negotiation tool
(as is the case in order management), since the options available
are either to accept or reject the entire invoice. The invoice data
in the InvoiceConfirmation message merely confirms that the invoice
has been forwarded correctly and does not communicate any desired
changes to the invoice. Therefore, the InvoiceConfirmation includes
the precise invoice data that the invoice recipient received and
checked. If the invoice recipient rejects an invoice, the invoicing
party can send a new invoice after checking the reason for
rejection (AcceptanceStatus and ConfirmationDescription at Invoice
and InvoiceItem level). If the invoice recipient does not respond,
the invoice is generally regarded as being accepted and the
invoicing party can expect payment.
[0312] FIGS. 22A-F depict a flow diagram of the steps performed by
methods and systems consistent with the subject matter described
herein to generate an interface from the business object model.
Although described as being performed by a computer, these steps
may alternatively be performed manually, or using any combination
thereof. The process begins when the system receives an indication
of a package template from the designer, i.e., the designer
provides a package template to the system (step 2200).
[0313] Package templates specify the arrangement of packages within
a business transaction document. Package templates are used to
define the overall structure of the messages sent between business
entities. Methods and systems consistent with the subject matter
described herein use package templates in conjunction with the
business object model to derive the interfaces.
[0314] The system also receives an indication of the message type
from the designer (step 2202). The system selects a package from
the package template (step 2204), and receives an indication from
the designer whether the package is required for the interface
(step 2206). If the package is not required for the interface, the
system removes the package from the package template (step 2208).
The system then continues this analysis for the remaining packages
within the package template (step 2210).
[0315] If, at step 2206, the package is required for the interface,
the system copies the entity template from the package in the
business object model into the package in the package template
(step 2212, FIG. 22B). The system determines whether there is a
specialization in the entity template (step 2214). If the system
determines that there is a specialization in the entity template,
the system selects a subtype for the specialization (step 2216).
The system may either select the subtype for the specialization
based on the message type, or it may receive this information from
the designer. The system then determines whether there are any
other specializations in the entity template (step 2214). When the
system determines that there are no specializations in the entity
template, the system continues this analysis for the remaining
packages within the package template (step 2210, FIG. 22A).
[0316] At step 2210, after the system completes its analysis for
the packages within the package template, the system selects one of
the packages remaining in the package template (step 2218, FIG.
22C), and selects an entity from the package (step 2220). The
system receives an indication from the designer whether the entity
is required for the interface (step 2222). If the entity is not
required for the interface, the system removes the entity from the
package template (step 2224). The system then continues this
analysis for the remaining entities within the package (step 2226),
and for the remaining packages within the package template (step
2228).
[0317] If, at step 2222, the entity is required for the interface,
the system retrieves the cardinality between a superordinate entity
and the entity from the business object model (step 2230, FIG.
22D). The system also receives an indication of the cardinality
between the superordinate entity and the entity from the designer
(step 2232). The system then determines whether the received
cardinality is a subset of the business object model cardinality
(step 2234). If the received cardinality is not a subset of the
business object model cardinality, the system sends an error
message to the designer (step 2236). If the received cardinality is
a subset of the business object model cardinality, the system
assigns the received cardinality as the cardinality between the
superordinate entity and the entity (step 2238). The system then
continues this analysis for the remaining entities within the
package (step 2226, FIG. 22C), and for the remaining packages
within the package template (step 2228).
[0318] The system then selects a leading object from the package
template (step 2240, FIG. 22E). The system determines whether there
is an entity superordinate to the leading object (step 2242). If
the system determines that there is an entity superordinate to the
leading object, the system reverses the direction of the dependency
(step 2244) and adjusts the cardinality between the leading object
and the entity (step 2246). The system performs this analysis for
entities that are superordinate to the leading object (step 2242).
If the system determines that there are no entities superordinate
to the leading object, the system identifies the leading object as
analyzed (step 2248).
[0319] The system then selects an entity that is subordinate to the
leading object (step 2250, FIG. 22F). The system determines whether
any non-analyzed entities are superordinate to the selected entity
(step 2252). If a non-analyzed entity is superordinate to the
selected entity, the system reverses the direction of the
dependency (step 2254) and adjusts the cardinality between the
selected entity and the non-analyzed entity (step 2256). The system
performs this analysis for non-analyzed entities that are
superordinate to the selected entity (step 2252). If the system
determines that there are no non-analyzed entities superordinate to
the selected entity, the system identifies the selected entity as
analyzed (step 2258), and continues this analysis for entities that
are subordinate to the leading object (step 2260). After the
packages have been analyzed, the system substitutes the
BusinessTransactionDocument ("BTD") in the package template with
the name of the interface (step 2262). This includes the "BTD" in
the BTDItem package and the "BTD" in the BTDItemScheduleLine
package.
[0320] 6. Use of an Interface
[0321] The XI stores the interfaces (as an interface type). At
runtime, the sending party's program instantiates the interface to
create a business document, and sends the business document in a
message to the recipient. The messages are preferably defined using
XML. In the example depicted in FIG. 23, the Buyer 2300 uses an
application 2306 in its system to instantiate an interface 2308 and
create an interface object or business document object 2310. The
Buyer's application 2306 uses data that is in the sender's
component-specific structure and fills the business document object
2310 with the data. The Buyer's application 2306 then adds message
identification 2312 to the business document and places the
business document into a message 2302. The Buyer's application 2306
sends the message 2302 to the Vendor 2304. The Vendor 2304 uses an
application 2314 in its system to receive the message 2302 and
store the business document into its own memory. The Vendor's
application 2314 unpacks the message 2302 using the corresponding
interface 2316 stored in its XI to obtain the relevant data from
the interface object or business document object 2318.
[0322] From the component's perspective, the interface is
represented by an interface proxy 2400, as depicted in FIG. 24. The
proxies 2400 shield the components 2402 of the sender and recipient
from the technical details of sending messages 2404 via XI. In
particular, as depicted in FIG. 25, at the sending end, the Buyer
2500 uses an application 2510 in its system to call an implemented
method 2512, which generates the outbound proxy 2506. The outbound
proxy 2506 parses the internal data structure of the components and
converts them to the XML structure in accordance with the business
document object. The outbound proxy 2506 packs the document into a
message 2502. Transport, routing and mapping the XML message to the
recipient 28304 is done by the routing system (XI, modeling
environment 516, etc.).
[0323] When the message arrives, the recipient's inbound proxy 2508
calls its component-specific method 2514 for creating a document.
The proxy 2508 at the receiving end downloads the data and converts
the XML structure into the internal data structure of the recipient
component 2504 for further processing.
[0324] As depicted in FIG. 26A, a message 2600 includes a message
header 2602 and a business document 2604. The message 2600 also may
include an attachment 2606. For example, the sender may attach
technical drawings, detailed specifications or pictures of a
product to a purchase order for the product. The business document
2604 includes a business document message header 2608 and the
business document object 2610. The business document message header
2608 includes administrative data, such as the message ID and a
message description. As discussed above, the structure 2612 of the
business document object 2610 is derived from the business object
model 2614. Thus, there is a strong correlation between the
structure of the business document object and the structure of the
business object model. The business document object 2610 forms the
core of the message 2600.
[0325] In collaborative processes as well as Q&A processes,
messages should refer to documents from previous messages. A simple
business document object ID or object ID is insufficient to
identify individual messages uniquely because several versions of
the same business document object can be sent during a transaction.
A business document object ID with a version number also is
insufficient because the same version of a business document object
can be sent several times. Thus, messages require several
identifiers during the course of a transaction.
[0326] As depicted in FIG. 26B, the message header 2618 in message
2616 includes a technical ID ("ID4") 2622 that identifies the
address for a computer to route the message. The sender's system
manages the technical ID 2622.
[0327] The administrative information in the business document
message header 2624 of the payload or business document 2620
includes a BusinessDocumentMessageID ("ID3") 2628. The business
entity or component 2632 of the business entity manages and sets
the BusinessDocumentMessageID 2628. The business entity or
component 2632 also can refer to other business documents using the
BusinessDocumentMessageID 2628. The receiving component 2632
requires no knowledge regarding the structure of this ID. The
BusinessDocumentMessageID 2628 is, as an ID, unique. Creation of a
message refers to a point in time. No versioning is typically
expressed by the ID. Besides the BusinessDocumentMessageID 2628,
there also is a business document object ID 2630, which may include
versions.
[0328] The component 2632 also adds its own component object ID
2634 when the business document object is stored in the component.
The component object ID 2634 identifies the business document
object when it is stored within the component. However, not all
communication partners may be aware of the internal structure of
the component object ID 2634. Some components also may include a
versioning in their ID 2634.
[0329] 7. Use of Interfaces Across Industries
[0330] Methods and systems consistent with the subject matter
described herein provide interfaces that may be used across
different business areas for different industries. Indeed, the
interfaces derived using methods and systems consistent with the
subject matter described herein may be mapped onto the interfaces
of different industry standards. Unlike the interfaces provided by
any given standard that do not include the interfaces required by
other standards, methods and systems consistent with the subject
matter described herein provide a set of consistent interfaces that
correspond to the interfaces provided by different industry
standards. Due to the different fields provided by each standard,
the interface from one standard does not easily map onto another
standard. By comparison, to map onto the different industry
standards, the interfaces derived using methods and systems
consistent with the subject matter described herein include most of
the fields provided by the interfaces of to different industry
standards. Missing fields may easily be included into the business
object model. Thus, by derivation, the interfaces can be extended
consistently by these fields. Thus, methods and systems consistent
with the subject matter described herein provide consistent
interfaces or services that can be used across different industry
standards.
[0331] For example, FIG. 28 illustrates an example method 2800 for
service enabling. In this example, the enterprise services
infrastructure may offer one common and standard-based service
infrastructure. Further, one central enterprise services repository
may support uniform service definition, implementation and usage of
services for user interface, and cross-application communication.
In step 2801, a business object is defined via a process component
model in a process modeling phase. Next, in step 2802, the business
object is designed within an enterprise services repository. For
example, FIG. 29 provides a graphical representation of one of the
business objects 2900. As shown, an innermost layer or kernel 2901
of the business object may represent the business object's inherent
data. Inherent data may include, for example, an employee's name,
age, status, position, address, etc. A second layer 2902 may be
considered the business object's logic. Thus, the layer 2902
includes the rules for consistently embedding the business object
in a system environment as well as constraints defining values and
domains applicable to the business object. For example, one such
constraint may limit sale of an item only to a customer with whom a
company has a business relationship. A third layer 2903 includes
validation options for accessing the business object. For example,
the third layer 2903 defines the business object's interface that
may be interfaced by other business objects or applications. A
fourth layer 2904 is the access layer that defines technologies
that may externally access the business object.
[0332] Accordingly, the third layer 2903 separates the inherent
data of the first layer 2901 and the technologies used to access
the inherent data. As a result of the described structure, the
business object reveals only an interface that includes a set of
clearly defined methods. Thus, applications access the business
object via those defined methods. An application wanting access to
the business object and the data associated therewith usually
includes the information or data to execute the clearly defined
methods of the business object's interface. Such clearly defined
methods of the business object's interface represent the business
object's behavior. That is, when the methods are executed, the
methods may change the business object's data. Therefore, an
application may utilize any business object by providing the
information or data without having any concern for the details
related to the internal operation of the business object. Returning
to method 2800, a service provider class and data dictionary
elements are generated within a development environment at step
2803. In step 2804, the service provider class is implemented
within the development environment.
[0333] FIG. 30 illustrates an example method 3000 for a process
agent framework. For example, the process agent framework may be
the basic infrastructure to integrate business processes located in
different deployment units. It may support a loose coupling of
these processes by message based integration. A process agent may
encapsulate the process integration logic and separate it from
business logic of business objects. As shown in FIG. 30, an
integration scenario and a process component interaction model are
defined during a process modeling phase in step 3001. In step 3002,
required interface operations and process agents are identified
during the process modeling phase also. Next, in step 3003, a
service interface, service interface operations, and the related
process agent are created within an enterprise services repository
as defined in the process modeling phase. In step 3004, a proxy
class for the service interface is generated. Next, in step 3005, a
process agent class is created and the process agent is registered.
In step 3006, the agent class is implemented within a development
environment.
[0334] FIG. 31 illustrates an example method 3100 for status and
action management (S&AM). For example, status and action
management may describe the life cycle of a business object (node)
by defining actions and statuses (as their result) of the business
object (node), as well as, the constraints that the statuses put on
the actions. In step 3101, the status and action management schemas
are modeled per a relevant business object node within an
enterprise services repository. In step 3102, existing statuses and
actions from the business object model are used or new statuses and
actions are created. Next, in step 3103, the schemas are simulated
to verify correctness and completeness. In step 3104, missing
actions, statuses, and derivations are created in the business
object model with the enterprise services repository. Continuing
with method 3100, the statuses are related to corresponding
elements in the node in step 3105. In step 3106, status code GDT's
are generated, including constants and code list providers. Next,
in step 3107, a proxy class for a business object service provider
is generated and the proxy class S&AM schemas are imported. In
step 3108, the service provider is implemented and the status and
action management runtime interface is called from the actions.
[0335] Regardless of the particular hardware or software
architecture used, the disclosed systems or software are generally
capable of implementing business objects and deriving (or otherwise
utilizing) consistent interfaces that are suitable for use across
industries, across businesses, and across different departments
within a business in accordance with some or all of the following
description. In short, system 100 contemplates using any
appropriate combination and arrangement of logical elements to
implement some or all of the described functionality.
[0336] Moreover, the preceding flowcharts and accompanying
description illustrate example methods. The present services
environment contemplates using or implementing any suitable
technique for performing these and other tasks. It will be
understood that these methods are for illustration purposes only
and that the described or similar techniques may be performed at
any appropriate time, including concurrently, individually, or in
combination. In addition, many of the steps in these flowcharts may
take place simultaneously and/or in different orders than as shown.
Moreover, the services environment may use methods with additional
steps, fewer steps, and/or different steps, so long as the methods
remain appropriate.
Freight Order Interfaces
[0337] A freight order can be an order to a transportation service
provider to ship goods from shippers to consignees. A freight order
can be a combination of shipment orders, which can be assigned to
stages and resources. The combination can be based on
transportation planning or transportation charges calculations. The
freight order execution interface can be used to delegate execution
of planned transportation of goods (from shippers to consignees) to
transportation execution processing of an ERP (Enterprise Resource
Planning) system. The freight order invoicing preparation interface
can be used for preparation of invoice verification which can be
executed later on.
[0338] A FreightOrderExecutionRequest can be a request for a
FreightOrderExecution from Transportation Order Processing to
Transportation Execution Processing. The structure of the
FreightOrderExecutionRequest can be specified by the message data
type FreightOrderExecutionRequestMessage.
[0339] A FreightOrderExecutionCancelRequest can be a request to
cancel a FreightOrderExecution. The structure of the
FreightOrderExecutionCancelRequest can be specified by the message
data type FreightOrderExecutionCancelRequestMessage.
[0340] A FreightOrderExecutionConfirmation can be a confirmation of
the FreightOrderExecutionRequest from Transportation Execution
Processing to Transportation Order Processing. Through the
confirmation, a FreightOrderExecutionRequest can be accepted,
rejected, or conditionally accepted. The confirmation can include
information on transport and carriage conditions, such as carrier,
mode of transport, or stages. The confirmation can be related to a
part of the FreightOrderExecution, in the case of a split scenario.
The structure of the FreightOrderExecutionConfirmation can be
specified by the message data type
FreightOrderExecutionConfirmationMessage.
[0341] A FreightOrderExecutionStatusNotification can be a message
from Transportation Execution Processing to Transportation Order
Processing, confirming a receipt of a FreightOrderExecutionRequest
message or of a FreightOrderExecutionCancelRequest message, and
reporting administrative errors included in the received message.
The structure of the FreightOrderExecutionStatusNotification can be
specified by the message data type
FreightOrderExecutionStatusNotification Message.
[0342] A FreightOrderInvoicingPreparationRequest can be a request
to prepare an invoice verification from transportation order
processing to purchase order processing. The structure of the
FreightOrderInvoicePreparationRequest can be specified by the
message data type
FreightOrderInvoicingPreparationRequestMessage.
[0343] A FreightOrderInvoicingPreparationCancelRequest can be a
request to cancel a FreightOrderInvoicingPreparation from
transportation order processing to purchase order processing. The
structure of the FreightOrderInvoicingPreparationCancelRequest can
be specified by the message data type
FreightOrderInvoicingPreparationCancelRequestMessage.
[0344] A FreightOrderInvoicingPreparationConfirmation can be a
confirmation of the FreightOrderInvoicingPreparation from purchase
order processing to transportation order processing. The structure
of the FreightOrderInvoicingPreparationConfirmation can be
specified by the message data type
FreightOrderInvoicingPreparationConfirmationMessage.
[0345] The FreightOrderExecution messages can be implemented by the
following message interfaces that may be equally distributed on a
transportation order processing side and on a transportation
execution processing side. In some implementations, only the
message interfaces on the Transportation Order Processing side may
be implemented in transportation management. The message interfaces
on the Transportation Order Processing side include the following:
FreightOrderExecutionRequest_Out,
FreightOrderExecutionCancelRequest_Out,
FreightOrderExecutionConfirmation_In, and
FreightOrderExecutionStatusNotification_In.
[0346] The FreightOrderInvoicingPreparation messages can be
implemented by the following message interfaces that may be equally
distributed on the transportation order processing side and on the
purchase order processing side. The message interfaces on the
Transportation Order Processing side can include the following:
FreightOrderInvoicingPreparationRequest_Out,
FreightOrderInvoicingPreparationCancelRequest_Out, and
FreightOrderInvoicingPreparationConfirmation_In. The message
interfaces on the Purchase Order Processing side can include the
following: FreightOrderInvoicingPreparationRequest_In,
FreightOrderInvoicingPreparationCancelRequest_In, and
FreightOrderInvoicingPreparationConfirmation_Out.
[0347] The message choreography of FIG. 32 describes a possible
logical sequence of messages that can be used to realize a Freight
Order business scenario.
[0348] A "Transportation Ordering Processing" system 32000 can
request a freight order execution, using a
FreightOrderExecutionRequest message 32004 as shown, for example in
FIG. 32. A "Transportation Execution Processing" system 32002 can
confirm the receipt of a request, and report any administrative
errors, using a FreightOrderExecutionStatusNotification message
32010 as shown, for example, in FIG. 32. The "Transportation
Execution Processing" system 32002 can confirm a freight order
execution using a FreightOrderExecutionConfirmation message 32008
as shown, for example, in FIG. 32.
[0349] The "Transportation Order Processing" system 32000 can
request the cancellation of a freight order execution using a
FreightOrderExecutionCancelRequest message 32006 as shown, for
example, in FIG. 32. The "Transportation Execution Processing"
system 32002 can confirm the receipt of a request, and report any
administrative errors, using the
FreightOrderExecutionStatusNotification message 32010 as shown, for
example, in FIG. 32.
[0350] The message choreography of FIG. 33 describes a possible
logical sequence of messages that can be used to realize a Freight
Order business scenario. A "Transportation Order Processing" system
33000 can request a freight order invoice preparation from a
"Purchase Order Processing" system 33002, using a
FreightOrderInvoicingPreparationRequest message 33004 as shown, for
example in FIG. 33. The "Purchase Order Processing" system 33002
can confirm the freight order invoicing preparation, using a
FreightOrderInvoicingPreparationConfirmation message 33008 as
shown, for example in FIG. 33. The "Transportation Order
Processing" system 33000 can request to cancel a freight order
invoice preparation from the "Purchase Order Processing" system
33002, using a FreightOrderInvoicingPreparationRequest message
33006 as shown, for example in FIG. 33.
[0351] FIGS. 34-1 through 34-28 illustrate one example logical
configuration of FreightOrderExecutionRequestMessage message 34000.
Specifically, this figure depicts the arrangement and hierarchy of
various components such as one or more levels of packages,
entities, and datatypes, shown here as 34002 through 34440. As
described above, packages may be used to represent hierarchy
levels. Entities are discrete business elements that are used
during a business transaction. Data types are used to type object
entities and interfaces with a structure. For example,
FreightOrderExecutionRequestMessage message 34000 includes, among
other things, FreightOrderExecution 34060. Accordingly,
heterogeneous applications may communicate using this consistent
message configured as such.
[0352] Additionally, FIG. 35 illustrates one example logical
configuration of FreightOrderExecutionCancelRequestMessage message
35000. Specifically, this figure depicts the arrangement and
hierarchy of various components such as one or more levels of
packages, entities, and datatypes, shown here as 35002 through
35024. As described above, packages may be used to represent
hierarchy levels. Entities are discrete business elements that are
used during a business transaction. Data types are used to type
object entities and interfaces with a structure. For example,
FreightOrderExecutionCancelRequestMessage message 35000 includes,
among other things, FreightOrder 35018. Accordingly, heterogeneous
applications may communicate using this consistent message
configured as such.
[0353] Additionally, FIGS. 36-1 through 36-28 illustrate one
example logical configuration of
FreightOrderExecutionConfirmationMessage message 36000.
Specifically, this figure depicts the arrangement and hierarchy of
various components such as one or more levels of packages,
entities, and datatypes, shown here as 36002 through 36440. As
described above, packages may be used to represent hierarchy
levels. Entities are discrete business elements that are used
during a business transaction. Data types are used to type object
entities and interfaces with a structure. For example,
FreightOrderExecutionConfirmationMessage message 36000 includes,
among other things, FreightOrderExecution 36062. Accordingly,
heterogeneous applications may communicate using this consistent
message configured as such.
[0354] Additionally, FIG. 37 illustrates one example logical
configuration of FreightOrderExecutionStatusNotificationMessage
message 37000. Specifically, this figure depicts the arrangement
and hierarchy of various components such as one or more levels of
packages, entities, and datatypes, shown here as 37002 through
37034. As described above, packages may be used to represent
hierarchy levels. Entities are discrete business elements that are
used during a business transaction. Data types are used to type
object entities and interfaces with a structure. For example,
FreightOrderExecutionStatusNotificationMessage message 37000
includes, among other things, FreightOrderExecution 37018.
Accordingly, heterogeneous applications may communicate using this
consistent message configured as such.
[0355] Additionally, FIGS. 38-1 through 38-28 illustrates one
example logical configuration of
FreightOrderInvoicingPreparationRequestMessage message 38000.
Specifically, this figure depicts the arrangement and hierarchy of
various components such as one or more levels of packages,
entities, and datatypes, shown here as 38002 through 38292. As
described above, packages may be used to represent hierarchy
levels. Entities are discrete business elements that are used
during a business transaction. Data types are used to type object
entities and interfaces with a structure. For example,
FreightOrderInvoicingPreparationRequestMessage message 38000
includes, among other things,
FreightOrderInvoicingPreparationMessage 38050. Accordingly,
heterogeneous applications may communicate using this consistent
message configured as such.
[0356] Additionally, FIG. 39 illustrates one example logical
configuration of
FreightOrderInvoicingPreparationCancelRequestMessage message 39000.
Specifically, this figure depicts the arrangement and hierarchy of
various components such as one or more levels of packages,
entities, and datatypes, shown here as 39002 through 39024. As
described above, packages may be used to represent hierarchy
levels. Entities are discrete business elements that are used
during a business transaction. Data types are used to type object
entities and interfaces with a structure. For example,
FreightOrderInvoicingPreparationCancelRequestMessage message 39000
includes, among other things, FreightOrderInvoicingPreparation
39018. Accordingly, heterogeneous applications may communicate
using this consistent message configured as such.
[0357] Additionally, FIG. 40 illustrates one example logical
configuration of
FreightOrderInvoicingPreparationConfirmationMessage message 40000.
Specifically, this figure depicts the arrangement and hierarchy of
various components such as one or more levels of packages,
entities, and datatypes, shown here as 40002 through 40024. As
described above, packages may be used to represent hierarchy
levels. Entities are discrete business elements that are used
during a business transaction. Data types are used to type object
entities and interfaces with a structure. For example,
FreightOrderInvoicingPreparationConfirmationMessage message 40000
includes, among other things, FreightOrderInvoicingPreparation
40018. Accordingly, heterogeneous applications may communicate
using this consistent message configured as such.
[0358] FIGS. 41-1 through 41-85 illustrate one example logical
configuration of a FreightOrderInvoicingPreparationRequestMessage
410000 element structure. Specifically, these figures depict the
arrangement and hierarchy of various components such as one or more
levels of packages, entities, and datatypes, shown here as 410000
through 412936. As described above, packages may be used to
represent hierarchy levels. Entities are discrete business elements
that are used during a business transaction. Data types are used to
type object entities and interfaces with a structure. For example,
the FreightOrderInvoicingPreparationRequestMessage 410000 includes,
among other things, a
FreightOrderInvoicingPreparationRequestMessage entity 410002.
Accordingly, heterogeneous applications may communicate using this
consistent message configured as such.
[0359] FIGS. 42-1 through 42-3 illustrate one example logical
configuration of a FreightOrderExecutionCancelRequestMessage 42000
element structure. Specifically, these figures depict the
arrangement and hierarchy of various components such as one or more
levels of packages, entities, and datatypes, shown here as 42000
through 42088. As described above, packages may be used to
represent hierarchy levels. Entities are discrete business elements
that are used during a business transaction. Data types are used to
type object entities and interfaces with a structure. For example,
the FreightOrderExecutionCancelRequestMessage 42000 includes, among
other things, a FreightOrderExecutionCancelRequestMessage entity
42002. Accordingly, heterogeneous applications may communicate
using this consistent message configured as such.
[0360] FIGS. 43-1 through 43-138 illustrate one example logical
configuration of a FreightOrderExecutionConfirmationMessage 430000
element structure. Specifically, these figures depict the
arrangement and hierarchy of various components such as one or more
levels of packages, entities, and datatypes, shown here as 430000
through 434850. As described above, packages may be used to
represent hierarchy levels. Entities are discrete business elements
that are used during a business transaction. Data types are used to
type object entities and interfaces with a structure. For example,
the FreightOrderExecutionConfirmationMessage 430000 includes, among
other things, a FreightOrderExecutionConfirmationMessage entity
430002. Accordingly, heterogeneous applications may communicate
using this consistent message configured as such.
[0361] FIGS. 44-1 through 44-141 illustrate one example logical
configuration of a FreightOrderExecutionRequestMessage 440000
element structure. Specifically, these figures depict the
arrangement and hierarchy of various components such as one or more
levels of packages, entities, and datatypes, shown here as 440000
through 444844. As described above, packages may be used to
represent hierarchy levels. Entities are discrete business elements
that are used during a business transaction. Data types are used to
type object entities and interfaces with a structure. For example,
the FreightOrderExecutionRequestMessage 440000 includes, among
other things, a FreightOrderExecutionRequestMessage entity 440002.
Accordingly, heterogeneous applications may communicate using this
consistent message configured as such.
[0362] FIGS. 45-1 through 45-6 illustrate one example logical
configuration of a FreightOrderExecutionStatusNotificationMessage
45000 element structure. Specifically, these figures depict the
arrangement and hierarchy of various components such as one or more
levels of packages, entities, and datatypes, shown here as 45000
through 45172. As described above, packages may be used to
represent hierarchy levels. Entities are discrete business elements
that are used during a business transaction. Data types are used to
type object entities and interfaces with a structure. For example,
the FreightOrderExecutionStatusNotificationMessage 45000 includes,
among other things, a
FreightOrderExecutionStatusNotificationMessage entity 45002.
Accordingly, heterogeneous applications may communicate using this
consistent message configured as such.
[0363] FIGS. 46-1 through 46-3 illustrate one example logical
configuration of a
FreightOrderInvoicingPreparationCancelRequestMessage 46000 element
structure. Specifically, these figures depict the arrangement and
hierarchy of various components such as one or more levels of
packages, entities, and datatypes, shown here as 46000 through
46094. As described above, packages may be used to represent
hierarchy levels. Entities are discrete business elements that are
used during a business transaction. Data types are used to type
object entities and interfaces with a structure. For example, the
FreightOrderInvoicingPreparationCancelRequestMessage 46000
includes, among other things, a
FreightOrderInvoicingPreparationCancelRequestMessage entity 46002.
Accordingly, heterogeneous applications may communicate using this
consistent message configured as such.
[0364] FIGS. 47-1 through 47-3 illustrate one example logical
configuration of a
FreightOrderInvoicingPreparationConfirmationMessage 47000 element
structure. Specifically, these figures depict the arrangement and
hierarchy of various components such as one or more levels of
packages, entities, and datatypes, shown here as 47000 through
47094. As described above, packages may be used to represent
hierarchy levels. Entities are discrete business elements that are
used during a business transaction. Data types are used to type
object entities and interfaces with a structure. For example, the
FreightOrderInvoicingPreparationConfirmationMessage 47000 includes,
among other things, a
FreightOrderInvoicingPreparationConfirmationMessage entity 47002.
Accordingly, heterogeneous applications may communicate using this
consistent message configured as such.
Message Data Type FreightOrderExecutionRequestMessage
[0365] The message data type FreightOrderExecutionRequestMessage
includes business information relevant for sending a business
document in a message and the FreightOrderExecution included in a
business document. The message data type
FreightOrderExecutionRequestMessage includes the MessageHeader and
FreightOrderExecution packages. The message data type
FreightOrderExecutionRequestMessage can provide a structure for the
message type FreightOrderExecutionRequest and for interfaces that
are based on it.
[0366] A MessageHeader package can group together business
information relevant for sending a business document in a message.
The MessageHeader package includes the MessageHeader entity. A
MessageHeader can group together business information from a
perspective of the sending application in order to identify a
business document in a message, provide information about the
sender, or provide information about the recipient. The
MessageHeader can be divided up into the SenderParty and
RecipientParty entities. The MessageHeader can be of type GDT:
BusinessDocumentMessageHeader. The MessageHeader includes the
following elements: ID, ReferenceID, and CreationDateTime. The
MessageID can be set by the sending application. With the
ReferencedMessageID, reference can be made in the current
BusinessDocument to a previous BusinessDocument.
[0367] A SenderParty can be a party responsible for sending a
business document at a business application level. The SenderParty
can be of type GDT: BusinessDocumentMessageHeaderParty. The
SenderParty includes the following elements: InternalID,
StandardID, and ContactPerson. The SenderParty can be filled by the
sending application to name a contact person for problems with the
message. A contact person can be useful if an additional
infrastructure, such as a marketplace, is located between the
sender and the recipient. The SenderParty can be used to transfer
the message and can be ignored by the receiving application.
SenderParty can be filled by the sender if the participating
parties are not transferred with the FreightOrderExecution
Package.
[0368] A RecipientParty can be a party responsible for receiving a
business document at a business application level. The
RecipientParty can be of type GDT:
BusinessDocumentMessageHeaderParty. The RecipientParty includes the
following elements: InternalID, StandardID, and ContactPerson. The
RecipientParty can be filled by the sending application to name a
contact person for problems that occur with the message. A contact
person can be useful if an additional infrastructure, such as a
marketplace, is located between the sender and the recipient. The
RecipientParty can be used to transfer a message and can be ignored
by the receiving application. In some implementations,
RecipientParty may be filled by the sender if the
FreightOrderExecution Package cannot be used to transfer the
participating parties.
[0369] The FreightOrderExecution package can group the
FreightOrderExecution with its packages. The FreightOrderExecution
package includes the FreightOrderExecution entity and the Request
package. The FreightOrderExecution interface can be used to
delegate execution of planned transportation of goods, from
shippers to consignees, to transportation execution processing of
an ERP system. The attributes and elements located directly at the
FreightOrder entity can include @actioncode and ID. The @actioncode
attribute can be a coded representation of an instruction to a
message recipient describing how to process a transmitted element.
The @actioncode attribute can be based on GDT: ActionCode. ID can
be a unique identifier of a FreightOrder. ID can be based on GDT:
BusinessTransactionDocumentID. In some implementations, the
attribute @actioncode may include the two values "01--Create" and
"02--Change". In some implementations, the ID might not be changed
once a FreightOrder has been created. In some implementations, the
Complete Transmission Indicator may be set to true (i.e., the
complete message content may be transmitted in every message). As a
consequence, previously transferred data that is not sent with the
change message may be deleted.
[0370] The Request package can group a Request with its packages.
The Request package includes the Request entity. The Request
package includes the following packages: HeaderInformation,
GovernmentalRequirementInformation, PartyInformation,
TransportationStageInformation,
TransportationUnitResourceInformation,
TransportationChargesInformation, and ShipmentOrder. Request can be
an agreement between a transportation service provider and an
ordering party on transportation of goods from a single ship-from
party to a single ship-to party in accordance with agreed terms and
conditions.
[0371] The HeaderInformation package can group dates, total values,
document and references related to a freight order. The
HeaderInformation package includes the following entities:
DateTimePeriods, NatureOfCargo, TotalQuantity, TotalAmount,
TextCollection, and BusinessTransactionDocumentReference.
[0372] DateTimePeriods can specify a requested and an acceptable
date, time and period applying to a shipment request (e.g., date
and time of document issue). A requested period can be a period in
which an event is requested to take place. An acceptable period can
be a period in which an event may take place at an earliest start
date/time to a latest end date/time. The elements located directly
at the DateTimePeriods entity can include the following:
RequestedFulfillmentPeriod, AcceptableFulfillmentPeriod, and
PeriodRoleCode. RequestedFulfillmentPeriod can be a period which is
requested depending on semantics of the PeriodRoleCode.
RequestedFulfillmentPeriod can be based on GDT: DATETIMEPERIOD,
Qualifier: RequestedFulfillment. AcceptableFulfillmentPeriod can be
a period which is acceptable depending on semantics of the
PeriodRoleCode. AcceptableFulfillmentPeriod can be based on GDT:
DATETIMEPERIOD, Qualifier: AcceptableFulfillment. PeriodRoleCode
can be a coded representation of business semantics of two periods
defined by the entities RequestedFulfillmentPeriod and
AcceptableFulfillmentPeriod. PeriodRoleCode can be based on GDT:
PeriodRoleCode. In some implementations, RequestedFulfillmentPeriod
and AcceptableFulfillmentPeriod are optional, but in every instance
one of them can be filled.
[0373] NatureOfCargo can indicate a nature of cargo related to a
shipment request (e.g., palletized, containerized, documents). The
structure of NatureOfCargo includes the ClassificationCode element.
ClassificationCode can be a coded representation of a
classification of a nature of cargo. ClassificationCode can be
based on GDT: NatureOfCargoClassificationCode.
[0374] TotalQuantity can specify a total quantity which is related
to a whole shipment request (e.g., total number of equipment, total
number of items). The structure of TotalQuantity includes the
following elements: Quantity, RoleCode, and TypeCode. Quantity can
be a non-monetary numerical specification of an amount in a unit of
measurement. Quantity can be based on GDT: Quantity. RoleCode can
be a coded representation of a role of a quantity. RoleCode can be
based on GDT: QuantityRoleCode. TypeCode can be a coded
representation of a type of quantity that is based on a measurable
characteristic of an object or physical phenomenon. TypeCode can be
based on GDT: QuantityTypeCode. In some implementations,
QuantityRoleCode and QuantityTypeCode are optional, but in every
instance one of them can be filled.
[0375] TotalAmount can specify a cumulated monetary amount related
to a shipment request (e.g., duty amount, insurance amount, or
total value). The structure of TotalAmount includes the Amount and
RoleCode elements. Amount can be an amount with a corresponding
currency unit. Amount can be based on CDT: Amount. RoleCode can be
a coded representation of a role of an amount. RoleCode can be
based on GDT: AmountRoleCode. TextCollection can be a group of
textual information that relates to a shipment request. The
structure of TextCollection includes the TextCollection element.
TextCollection can be based on GDT: TextCollection.
[0376] BusinessTransactionDocumentReference can specify a business
document reference that is related to a whole shipment request.
BusinessTransactionDocumentReference includes the
DateTimePeriodentity. The structure of
BusinessTransactionDocumentReference includes the following
elements:
[0377] BusinessTransactionDocumentReference,
BusinessTransactionDocumentRelationshipRoleCode,
BusinessTransactionDocumentRelationshipTypeCode,
TransportationDocumentTypeCode, TransportationDocumentNote, and
TransportationDocumentID. BusinessTransactionDocumentReference can
be a unique reference to other business documents or business
document items that are of significance within each respective
business process.
[0378] BusinessTransactionDocumentReference can be based on GDT:
BusinessTransactionDocumentReference.
BusinessTransactionDocumentRelationshipRoleCode can be a coded
representation of a role that a business document or a business
document item can have when set against another business document
or business document item with a relationship.
BusinessTransactionDocumentRelationshipRoleCode can be based on
GDT: BusinessTransactionDocumentRelationshipRoleCode.
BusinessTransactionDocumentRelationshipTypeCode can be a coded
representation of a relationship between two business documents or
business document items.
BusinessTransactionDocumentRelationshipTypeCode can be based on
GDT: BusinessTransactionDocumentRelationshipTypeCode.
TransportationDocumentTypeCode can be a coded representation of a
documentation type. TransportationDocumentTypeCode can be based on
GDT: TransportationDocumentTypeCode. TransportationDocumentNote can
be a short Note regarding documentation. TransportationDocumentNote
can be based on GDT: SHORT_Note. TransportationDocumentID can be a
unique identifier for a transportation document.
TransportationDocumentID can be based on GDT:
TransportationDocumentID. RelationshipTypeCode and
RelationshipRoleCode are both optional. In some implementations, if
used, both may be filled. Either the combination
BusinessTransactionDocumentReference,
BusinessTransactionDocumentRelationshipRoleCode,
BusinessTransactionDocumentRelationshipTypeCode, or
TransportationDocumentTypeCode, TransportationDocumentNote,
TransportationDocumentID can be filled.
[0379] DateTimePeriod can specify a date, time and/or period
related to a DocumentReference. The structure of the DateTimePeriod
entity includes the elements DateTimePeriod and PeriodRoleCode.
DateTimePeriod can be a period that is defined by two points in
time. DateTimePeriod can be based on GDT: DateTimePeriod.
PeriodRoleCode can be a coded representation of business semantics
of a period. PeriodRoleCode can be based on GDT:
PeriodRoleCode.
[0380] GovernmentalProcedureInformation can specify applicable
governmental procedures related to import, export and transport of
goods of a shipment request. GovernmentalProcedureInformation
includes the GovernmentalProcedure entity. GovernmentalProcedure
can specify applicable governmental procedures related to import,
export and transport of goods of a shipment request.
GovernmentalProcedure includes the following entities: Location,
DateTimePeriod, Seal, TextCollection, and
TransportationDocumentInformation. The structure of
GovernmentalProcedure includes the elements
TransportationGovernmentAgencyTypeCode,
TransportationMovementTypeCode,
TransportationGovernmentAgencyInvolvementStatusCode,
TransportationGovernmentAgencyActionCode, and
TransportationGovernmentAgencyProcedureStatusCode.
[0381] TransportationGovernmentAgencyTypeCode can be a coded
representation of a type of a government agency.
TransportationGovernmentAgencyTypeCode can be based on GDT:
TransportationGovernmentAgencyTypeCode.
TransportationMovementTypeCode can be a coded representation of a
type of a transport movement. Examples can include Import, Export,
Transit, and Transshipment. TransportationMovementTypeCode can be
based on GDT: TransportationMovementTypeCode.
TransportationGovernmentAgencyInvolvementStatusCode can be a coded
representation for an involvement status of a transportation
related government agency.
TransportationGovernmentAgencyInvolvementStatusCode can be based on
GDT: TransportationGovernmentAgencyInvolvementStatusCode.
TransportationGovernmentAgencyActionCode can be a coded
representation of an action of a transportation related government
agency. TransportationGovernmentAgencyActionCode can be based on
GDT: TransportationGovernmentAgencyActionCode.
TransportationGovernmentAgencyProcedureStatusCode can be a coded
representation of a status of a procedure related to a
transportation government agency.
TransportationGovernmentAgencyProcedureStatusCode can be based on
GDT: TransportationGovernmentAgencyProcedureStatusCode.
[0382] The PartyInformation package includes information regarding
a party of a freight order (i.e., Shipper, Carrier, Agent). The
PartyInformation package includes the Party entity. Party includes
information exchanged, in accordance with common business
understanding, in business documents about a party involved in
business transactions. This information can be used to identify the
party and the party's address, as well as the party's contact
person and the contact person's address. This identification can
take place using an internal ID, a standardized ID, or IDs assigned
by the parties involved.
[0383] The Party entity includes the following entities: Amount,
DateTimePeriods, TransportationDocumentInformation, and
BusinessTransactionDocumentReference. The structure of Party
includes the Party, RoleCode and FormattedName elements. A Party
includes information exchanged, in accordance with common business
understanding, in to business documents, about a party involved in
business transactions. This information can be used to identify the
party and the party's address, as well as the party's contact
person and the contact person's address. This identification can
take place using an internal ID, a standardized ID, or IDs assigned
by the parties involved. Party can be based on GDT:
BusinessTransactionDocumentParty. RoleCode can be a coded
representation of a PartyRoleCode which specifies which rights and
obligations a party has regarding a business object and
corresponding processes. In some implementations, PartyRole is
assigned to a PartyRoleCategory and refines its semantics. RoleCode
can be based on GDT: PartyRoleCode. FormattedName can be a
formatted name of a party. FormattedName can be based on GDT:
LONG_Name, Qualifier: PartyFormatted.
[0384] BusinessTransactionDocumentReference can specify a business
document reference that is related to a whole shipment request.
BusinessTransactionDocumentReference includes the DateTimePeriod
entity. The structure of BusinessTransactionDocumentReference
includes the following elements:
BusinessTransactionDocumentReference,
BusinessTransactionDocumentRelationshipRoleCode,
BusinessTransactionDocumentRelationshipTypeCode,
TransportationDocumentTypeCode, TransportationDocumentNote, and
TransportationDocumentID. BusinessTransactionDocumentReference can
be a unique reference to other business documents or business
document items that are of significance within each respective
business process.
[0385] BusinessTransactionDocumentReference can be based on GDT:
BusinessTransactionDocumentReference.
BusinessTransactionDocumentRelationshipRoleCode can be a coded
representation of a role that a business document or a business
document item has when set against another business document or
business document item with a relationship.
BusinessTransactionDocumentRelationshipRoleCode can be based on
GDT: BusinessTransactionDocumentRelationshipRoleCode.
BusinessTransactionDocumentRelationshipTypeCode can be a coded
representation of a relationship between two business documents or
business document items.
BusinessTransactionDocumentRelationshipTypeCode can be based on
GDT: BusinessTransactionDocumentRelationshipTypeCode.
[0386] TransportationDocumentTypeCode can be a coded representation
of documentation type. TransportationDocumentTypeCode can be based
on GDT: TransportationDocumentTypeCode. TransportationDocumentNote
can be a short Note regarding documentation.
TransportationDocumentNote can be based on GDT: SHORT_Note.
TransportationDocumentID can be a unique identifier for a
transportation document. TransportationDocumentID can be based on
GDT: TransportationDocumentID. RelationshipTypeCode and
RelationshipRoleCode are both optional. In some implementations, if
used, both may be filled. Either the combination
BusinessTransactionDocumentReference,
BusinessTransactionDocumentRelationshipRoleCode,
BusinessTransactionDocumentRelationshipTypeCode, or
TransportationDocumentTypeCode, TransportationDocumentNote,
TransportationDocumentID can be filled. DateTimePeriod can specify
a date, time and/or period related to the DocumentReference. The
TransportationStageInformation package includes information
regarding a stage of a freight order. A stage can represent a
section of a transport. The TransportationStageInformation package
includes the TransportationStage entity.
[0387] TransportationStage can specify details related to a stage
of a transport which is part of a freight order.
TransportationStage includes the following entities:
ContactInformation, Quantity, Party, Location, Seal,
TextCollection, BusinessTransactionDocumentReference, and
TransportationServiceRequirement. The structure of
TransportationStage includes the following elements: ID,
OrdinalNumberValue, TypeCode, JourneyID, TransportModeCode,
TransportMeansDescriptionCode, TransportMeansDescription,
TransportMeansID, TransportMeansHomeCountryCode,
TransportMeansOwnershipTypeCode, CarrierStandardID,
CarrierFormattedName, TransportationTransitDirectionCode,
CalculatedDistanceMeasure, and GivenDistanceMeasure.
[0388] ID can be a unique identifier of a stage in a shipment
request. ID can be based on GDT: TransportationStageID.
OrdinalNumberValue can be an ordinal number to indicate a position
of a transportation stage in a set of transportation stages.
OrdinalNumberValue can be based on GDT: OrdinalNumberValue,
Qualifier: TransportationStage. TypeCode can be a coded
representation of a type of a TransportationStage. TypeCode can be
based on GDT: TransportationStageTypeCode. JourneyID can be an
identifier of a Journey. JourneyID can be based on GDT: JourneyID.
TransportModeCode can be a coded representation of a mode of
transportation used for delivery. TransportModeCode can be based on
GDT: TransportModeCode. TransportMeansDescriptionCode can be a
coded representation of a transport means type with which goods or
persons are to be transported.
[0389] TransportMeansDescriptionCode can be based on GDT:
TransportMeansDescriptionCode. TransportMeansDescription can be a
description of a means of transport. TransportMeansDescription can
be based on GDT: SHORT_Description, Qualifier: TransportMeans.
TransportMeansID can be a unique identifier of a means of
transport. TransportMeansID can be based on GDT: TransportMeansID.
TransportMeansHomeCountryCode can be a coded representation of the
home country of a transport means. TransportMeansHomeCountryCode
can be based on GDT: CountryCode, Qualifier: TransportMeansHome.
TransportMeansOwnershipTypeCode can be a coded representation of a
type of ownership for a means of transport.
[0390] TransportMeansOwnershipTypeCode can be based on GDT:
TransportMeansOwnershipTypeCode. CarrierStandardID can be a
standard identifier of a carrier. CarrierStandardID can be based on
GDT: PartyStandardID. CarrierFormattedName can be a name of a
carrier. CarrierFormattedName can be based on GDT: LONG_Name,
Qualifier: PartyFormatted. TransportationTransitDirectionCode can
be a coded representation for a transportation transit direction.
TransportationTransitDirectionCode can be based on GDT:
TransportationTransitDirectionCode. CalculatedDistanceMeasure can
be a calculated distance measure. CalculatedDistanceMeasure can be
based on GDT: Measure, Qualifier: CalculatedDistance.
GivenDistanceMeasure can be a given distance measure.
GivenDistanceMeasure can be based on GDT: Measure, Qualifier:
GivenDistance.
[0391] ContactInformation can specify information on a department
or person to whom information regarding a Stage can be directed.
The structure of ContactInformation includes the
ContactPersonFunctionTypeCode and Address elements.
ContactPersonFunctionTypeCode can be a coded representation of a
type of function that a contact person has.
ContactPersonFunctionTypeCode can be based on GDT:
ContactPersonFunctionTypeCode. Address can be an address related to
contact information defined by a corresponding FunctionTypeCode.
Address can be based on GDT: Address.
[0392] Quantity can specify a quantity related to a Stage. The
structure of Quantity includes the elements Quantity, RoleCode, and
TypeCode. Quantity can be a non-monetary numerical specification of
an amount in a unit of measurement. Quantity can be based on GDT:
Quantity. RoleCode can be a coded representation of a role of a
quantity. RoleCode can be based on GDT: QuantityRoleCode. TypeCode
can be a coded representation of a type of quantity that is based
on a measurable characteristic of an object or physical phenomenon.
TypeCode can be based on GDT: QuantityTypeCode. In some
implementations, QuantityRoleCode and QuantityTypeCode are
optional, but in every instance one of may be filled.
[0393] Party includes information exchanged, in accordance with
common business understanding, in business documents, about a party
involved in a current stage. This information can be used to
identify the party and the party's address. Party includes the
TransportationDocumentInformation and
BusinessTransactionDocumentReference entities. The structure of
Party includes the following elements: Party, RoleCode, and
FormattedName.
[0394] A Party includes information exchanged, in accordance with
common business understanding, in business documents, about a party
involved in business transactions. This information can be used to
identify the party and the party's address, as well as the party's
contact person and the contact person's address. This
identification can take place using an internal ID, a standardized
ID, or IDs assigned by the parties involved. Party can be based on
GDT: BusinessTransactionDocumentParty. RoleCode can be a coded
representation of a PartyRoleCode which specifies which rights and
obligations the party has regarding a business object and
corresponding processes. In some implementations, a PartyRole is
assigned to a PartyRoleCategory and refines its semantics. RoleCode
can be based on GDT: PartyRoleCode. FormattedName can be a
formatted name of a party. FormattedName can be based on GDT:
LONG_Name, Qualifier: PartyFormatted.
[0395] TransportationDocumentInformation can specify information on
a transportation document related to a shipment request.
TransportationDocumentInformation includes the DateTimePeriod
entity. The structure of TransportationDocumentInformation includes
the following elements: TransportationDocumentTypeCode,
TransportationDocumentNote, TransportationDocumentID,
TransportationDocumentStatusCode, LanguageCode,
CommunicationMediumTypeCode, RequiredIndicator,
OutputCopyNumberValue, and OutputOriginalNumberValue.
[0396] TransportationDocumentTypeCode can be a coded representation
of a documentation type. TransportationDocumentTypeCode can be
based on GDT: TransportationDocumentTypeCode.
TransportationDocumentNote can be a short Note on documentation.
TransportationDocumentNote can be based on GDT: SHORT_Note.
TransportationDocumentID can be a unique identifier for a
transportation document. TransportationDocumentID can be based on
GDT: TransportationDocumentID. TransportationDocumentStatusCode can
be a coded representation of a status of a transportation document
(e.g., to be printed, document complete).
TransportationDocumentStatusCode can be based on GDT:
TransportationDocumentStatusCode. LanguageCode can be a coded
representation of the language of a documentation. LanguageCode can
be based on GDT: LanguageCode. CommunicationMediumTypeCode can be a
coded representation of a type of a medium used for communication
of documentation (e.g., fax, mail, EDI (Electronic Data
Interchange), or letter). CommunicationMediumTypeCode can be based
on GDT: CommunicationMediumTypeCode.
[0397] RequiredIndicator can indicate whether a documentation is
required or not. RequiredIndicator can be based on GDT: Indicator
Qualifier: Required. OutputCopyNumberValue can be a number
specifying the number of copies of a document that should be
issued. OutputCopyNumberValue can be based on GDT: NumberValue,
Qualifier: OutputCopy. OutputOriginalNumberValue can be a number
specifying the number of originals of a document that should be
issued. OutputOriginalNumberValue can be based on GDT: NumberValue,
Qualifier: OutputOriginal. In some implementations, TypeCode and
TypeDescription are both optional, but at least one of them may be
used. In some implementations, if the RequiredIndicator is set to
true, at least one of the NumberValues OutputCopyNumberValue or
OutputOriginalNumberValue may be filled.
[0398] BusinessTransactionDocumentReference can specify a business
document reference that is related to a whole shipment request.
BusinessTransactionDocumentReference includes the
DateTimePeriodentity. The structure of
BusinessTransactionDocumentReference includes the following
elements: BusinessTransactionDocumentReference,
BusinessTransactionDocumentRelationshipRoleCode,
BusinessTransactionDocumentRelationshipTypeCode,
TransportationDocumentTypeCode, TransportationDocumentNote, and
TransportationDocumentID. BusinessTransactionDocumentReference can
be a unique reference to other business documents or business
document items that are of significance within each respective
business process.
[0399] BusinessTransactionDocumentReference can be based on GDT:
BusinessTransactionDocumentReference.
BusinessTransactionDocumentRelationshipRoleCode can be a coded
representation of a role that a business document or a business
document item has when set against another business document or
business document item with a relationship.
BusinessTransactionDocumentRelationshipRoleCode can be based on
GDT: BusinessTransactionDocumentRelationshipRoleCode.
BusinessTransactionDocumentRelationshipTypeCode can be a coded
representation of a relationship between two business documents or
business document items.
BusinessTransactionDocumentRelationshipTypeCode can be based on
GDT: BusinessTransactionDocumentRelationshipTypeCode.
[0400] TransportationDocumentTypeCode can be a coded representation
of a documentation type. TransportationDocumentTypeCode can be
based on GDT: TransportationDocumentTypeCode.
TransportationDocumentNote can be a short Note on documentation.
TransportationDocumentNote can be based on GDT: SHORT_Note.
TransportationDocumentID can be a unique identifier for a
transportation document. TransportationDocumentID can be based on
GDT: TransportationDocumentID. RelationshipTypeCode and
RelationshipRoleCode are both optional. In some implementations, if
used, both can be filled. Either the combination
BusinessTransactionDocumentReference,
BusinessTransactionDocumentRelationshipRoleCode,
BusinessTransactionDocumentRelationshipTypeCode, or
TransportationDocumentTypeCode, TransportationDocumentNote,
TransportationDocumentID can be filled. DateTimePeriod can specify
a date, time and/or period related to a DocumentReference.
[0401] The Location can specify a physical place to which the
TransportationCharges and an associated calculation can refer.
Location includes the DateTimePeriod entity. The structure of
Location includes the following elements: Location, RoleCode,
TypeCode, and Name. Location includes information exchanged in
business documents about a location relevant for business
transactions. Location can be based on GDT:
BusinessTransactionDocumentLocation. RoleCode can be a coded
representation of a LocationRole. RoleCode can be based on GDT:
LocationRoleCode. TypeCode can be a coded representation of a type
of a physical location. TypeCode can be based on GDT:
LocationTypeCode. Name can be a name of a location. Name can be
based on GDT: MEDIUM_Name, Qualifier: Location.
[0402] Seal can specify seal information related to a Stage. The
structure of Seal includes the following elements: ID,
PartyRoleCode, PartyFormattedName, and StatusCode. ID can be a
unique identifier of a seal. ID can be based on GDT: SealID.
PartyRoleCode can be a coded representation of a party role.
PartyRoleCode can be based on GDT: PartyRoleCode.
PartyFormattedName can be a complete, formatted name of a party
(e.g., the name of a SealingParty). PartyFormattedName can be based
on GDT: LONG_Name, Qualifier: PartyFormatted. StatusCode can be a
coded representation of a status of a seal. StatusCode can be based
on GDT: SealStatusCode.
[0403] TextCollection can be a group of textual information that
relates to a Stage. The structure of TextCollection includes the
element TextCollection. TextCollection can be based on GDT:
TextCollection.
[0404] BusinessTransactionDocumentReference can specify a business
document reference that is related to a whole shipment request.
BusinessTransactionDocumentReference includes the
DateTimePeriodentity. The structure of
BusinessTransactionDocumentReference includes the following
elements: BusinessTransactionDocumentReference,
BusinessTransactionDocumentRelationshipRoleCode,
BusinessTransactionDocumentRelationshipTypeCode,
TransportationDocumentTypeCode, TransportationDocumentNote, and
TransportationDocumentID. BusinessTransactionDocumentReference can
be a unique reference to other business documents or business
document items that are of significance within each respective
business process. BusinessTransactionDocumentReference can be based
on GDT: BusinessTransactionDocumentReference.
[0405] BusinessTransactionDocumentRelationshipRoleCode can be a
coded representation of a role that a business document or a
business document item has when set against another business
document or business document item with a relationship.
BusinessTransactionDocumentRelationshipRoleCode can be based on
GDT: BusinessTransactionDocumentRelationshipRoleCode.
BusinessTransactionDocumentRelationshipTypeCode can be a coded
representation of a relationship between two business documents or
business document items.
BusinessTransactionDocumentRelationshipRoleCode can be based on
GDT: BusinessTransactionDocumentRelationshipTypeCode.
TransportationDocumentTypeCode can be a coded representation of a
documentation type. TransportationDocumentTypeCode can be based on
GDT: TransportationDocumentTypeCode.
[0406] TransportationDocumentNote can be a short Note on
documentation. TransportationDocumentNote can be based on GDT:
SHORT_Note. TransportationDocumentID can be a unique identifier for
a transportation document. TransportationDocumentID can be based on
GDT: TransportationDocumentID. RelationshipTypeCode and
RelationshipRoleCode are both optional. In some implementations, if
used, both may be filled. Either the combination
BusinessTransactionDocumentReference,
BusinessTransactionDocumentRelationshipRoleCode,
BusinessTransactionDocumentRelationshipTypeCode or
TransportationDocumentTypeCode, TransportationDocumentNote,
TransportationDocumentID can be filled.
[0407] TransportationServiceRequirement can specify a contract and
carriage condition and service and priority requirements for
transport which apply to a whole shipment request. The structure of
TransportationServiceRequirement includes the following elements:
TransportationServiceRequirementCode,
AdditionalTransportationServiceRequirementCode,
TransportationContractConditionCode, TransportServiceLevelCode, and
NatureOfCargoClassificationCode.
TransportationServiceRequirementCode can be a coded representation
of a requirement related to a transportation service.
TransportationServiceRequirementCode can be based on GDT
TransportationServiceRequirementCode.
[0408] AdditionalTransportationServiceRequirementCode can be a
coded representation of an additional requirement related to a
transportation service.
AdditionalTransportationServiceRequirementCode can be based on GDT:
TransportationServiceRequirementCode, Qualifier: Additional.
TransportationContractConditionCode can be a coded representation
of a contract and carriage condition.
TransportationContractConditionCode can be based on GDT:
TransportationContractConditionCode. TransportServiceLevelCode can
be a coded representation of agreed or defined services in terms of
the delivery of goods with respect to the speed of the delivery.
TransportServiceLevelCode can be based on GDT:
TransportServiceLevelCode. NatureOfCargoClassificationCode can be a
coded representation of a classification of a nature of cargo.
NatureOfCargoClassificationCode can be based on GDT:
NatureOfCargoClassificationCode.
[0409] The TransportationUnitResourceInformation package includes
information regarding a transportation unit resource that is
relevant for the freight order (e.g., a container). The
TransportationUnitResourceInformation package includes the
TransportationUnitResourceInformation entity.
TransportationUnitResourceInformation includes information on one
or more transportation unit resources, such as a resource type and
related properties, and related measures or handling instructions.
A TransportationUnitResource can be a unit into which goods are
loaded and/or from which goods are unloaded. In some
implementations, this unit can provide transportation capacity for
goods but cannot move by itself. TransportationUnitResource
includes the following entities: TransportationStageAssignment,
AttachedEquipment, Quantity, Seal,
BusinessTransactionDocumentReference, TextCollection, Party,
Location, and DangerousGoods.
[0410] The structure of TransportationUnitResourceInformation
includes the following elements: ID, ResourceNumberValue,
ResourceID, ResourceHomeCountryCode,
TransportationUnitResourceCategoryCode,
TransportationUnitResourceTypeCode, FillLevelCode,
ShippingTypeCode, HaulageArrangerCode,
TransportationHandlingInstructionCode, and
TransportationHandlingInstructionNote. ID can be a unique
identifier for a resource information. ID can be based on GDT
ResourceInformationID. ResourceNumberValue can be a count of
resources. ResourceNumberValue can be based on GDT: NumberValue,
Qualifier: Resource. ResourceID can be a unique identifier for a
resource. ResourceID can be based on GDT: ResourceID.
ResourceHomeCountryCode can be a coded representation of the home
country of a resource. ResourceHomeCountryCode can be based on GDT:
CountryCode, Qualifier: ResourceHome.
[0411] TransportationUnitResourceCategoryCode can be a coded
representation of a category of transportation unit resources.
TransportationUnitResourceCategoryCode can be based on GDT:
TransportationUnitResourceCategoryCode.
TransportationUnitResourceTypeCode can be a coded representation of
a type of a transportation unit resource.
TransportationUnitResourceTypeCode can be based on GDT:
TransportationUnitResourceTypeCode. FillLevelCode can be a coded
representation of a fill level of a resource. FillLevelCode can be
based on GDT: FillLevelCode. ShippingTypeCode can be a coded
representation of a shipping type. A shipping type can specify how
planning and execution of a transportation can be performed.
[0412] Transportation terms include detailed specifications on
agreed means of transportation, such as shipping and transport type
and means of transport to be used. ShippingTypeCode can be based on
GDT: ShippingTypeCode. HaulageArrangerCode can be a coded
representation of an arranger of a haulage. Haulage can be inland
transport of cargo. HaulageArrangerCode can be based on GDT:
HaulageArrangerCode. TransportationHandlingInstructionCode can be a
coded representation of the type of a transportation handling
instruction. TransportationHandlingInstructionCode can be based on
GDT: TransportationHandlingInstructionCode.
TransportationHandlingInstructionNote can be a note regarding a
transportation handling instruction.
TransportationHandlingInstructionNote can be based on GDT:
LONG_Note, Qualifier: TransportationHandlingInstruction.
[0413] TransportationStageAssignment can specify an assignment of a
resource to a stage. The structure of TransportationStageAssignment
includes the element FreightOrderTransportationStageID.
FreightOrderTransportationStageID can be a unique identifier of a
TransportationStage in a freight order.
FreightOrderTransportationStageID can be based on GDT:
TransportationStageID.
[0414] AttachedEquipment can specify equipment attached to a
TransportationUnitResource. The structure of AttachedEquipment
includes the ShipmentRequestResourceInformationID element.
ShipmentRequestResourceInformationID can be a unique identifier of
a resource information in a ShipmentRequest.
ShipmentRequestResourceInformationID can be based on GDT:
ResourceInformationID.
[0415] Quantity can specify a quantity related to
TransportationUnitResourceInformation. The structure of Quantity
includes the following elements: Quantity, RoleCode, and TypeCode.
Quantity can be a non-monetary numerical specification of an amount
in a unit of measurement. Quantity can be based on GDT: Quantity.
RoleCode can be a coded representation of a role of a quantity.
RoleCode can be based on GDT: QuantityRoleCode. TypeCode can be a
coded representation of a type of quantity that is based on a
measurable characteristic of an object or physical phenomenon.
TypeCode can be based on GDT: QuantityTypeCode. In some
implementations, QuantityRoleCode and QuantityTypeCode are
optional, but in every instance one of them may be filled.
[0416] Seal can specify a seal related to a
TransportationUnitResource. The structure of Seal includes the
following elements: ID, PartyRoleCode, PartyFormattedName, and
StatusCode. ID can be a unique identifier of a seal. ID can be
based on GDT: SealID. PartyRoleCode can be a coded representation
of a party role. PartyRoleCode can be based on GDT: PartyRoleCode.
PartyFormattedName can be a complete, formatted name of a party, or
the name of the SealingParty. PartyFormattedName can be based on
GDT: LONG_Name, Qualifier: PartyFormatted. StatusCode can be a
coded representation of a status of a seal. StatusCode can be based
on GDT: SealStatusCode.
[0417] TextCollection can be a group of textual information that
relates to a GovernmentalProcedure. The structure of the
TextCollection entity includes the TextCollection element.
TextCollection can be based on GDT: TextCollection.
[0418] BusinessTransactionDocumentReference can specify a business
document reference that is related to a whole shipment request.
BusinessTransactionDocumentReference includes the
DateTimePeriodentity. The structure of
BusinessTransactionDocumentReference includes the following
elements: BusinessTransactionDocumentReference,
BusinessTransactionDocumentRelationshipRoleCode,
BusinessTransactionDocumentRelationshipTypeCode,
TransportationDocumentTypeCode, TransportationDocumentNote, and
TransportationDocumentID. BusinessTransactionDocumentReference can
be a unique reference to other business documents or business
document items that are of significance within each respective
business process. BusinessTransactionDocumentReference can be based
on GDT: BusinessTransactionDocumentReference.
[0419] BusinessTransactionDocumentRelationshipRoleCode can be a
coded representation of a role that a business document or a
business document item has when set against another business
document or business document item with a relationship.
BusinessTransactionDocumentRelationshipRoleCode can be based on
GDT: BusinessTransactionDocumentRelationshipRoleCode.
BusinessTransactionDocumentRelationshipTypeCode can be a coded
representation of a relationship between two business documents or
business document items.
BusinessTransactionDocumentRelationshipRoleCode can be based on
GDT: BusinessTransactionDocumentRelationshipTypeCode.
TransportationDocumentTypeCode can be a coded representation of a
documentation type.
[0420] TransportationDocumentTypeCode can be based on GDT:
TransportationDocumentTypeCode. TransportationDocumentNote can be a
short Note on documentation. TransportationDocumentNote can be
based on GDT: SHORT_Note. TransportationDocumentID can be a unique
identifier for a transportation document. TransportationDocumentID
can be based on GDT: TransportationDocumentID. RelationshipTypeCode
and RelationshipRoleCode are both optional. In some
implementations, if used, both may be filled. Either the
combination BusinessTransactionDocumentReference,
BusinessTransactionDocumentRelationshipRoleCode,
BusinessTransactionDocumentRelationshipTypeCode or
TransportationDocumentTypeCode, TransportationDocumentNote,
TransportationDocumentID can be filled.
[0421] TextCollection can be a group of textual information that
relates to a TransportationUnitResource. The structure of
TextCollection includes the element TextCollection. TextCollection
can be based on GDT: TextCollection.
[0422] Party includes information exchanged, in accordance with
common business understanding, in business documents, about a party
involved in the current TransportationUnitResource. This
information can be used to identify the party and the party's
address. The structure of Party includes the following elements:
Party, RoleCode, and FormattedName. A Party includes information
exchanged, in accordance with common business understanding, in
business documents, about a party involved in business
transactions. This information can be used to identify the party
and the party's address, as well as the party's contact person and
the contact person's address. This identification can take place
using an internal ID, a standardized ID, or IDs assigned by the
parties involved. Party can be based on GDT:
BusinessTransactionDocumentParty. RoleCode can be a coded
representation of a PartyRoleCode which specifies which rights and
obligations the party has regarding a business object and
corresponding processes. In some implementations, a PartyRole is
assigned to one PartyRoleCategory and refines its semantics.
PartyRole can be based on GDT: PartyRoleCode. FormattedName can be
a complete, formatted name of a party. FormattedName can be based
on GDT: LONG_Name, Qualifier: PartyFormatted.
[0423] Location can specify a physical place related to a
TransportationUnitResource. The structure of Location includes the
following elements: Location, RoleCode, TypeCode, and Name.
Location includes information exchanged in business documents about
a location relevant for business transactions. Location can be
based on GDT: BusinessTransactionDocumentLocation. RoleCode can be
a coded representation of a LocationRole. RoleCode can be based on
GDT: LocationRoleCode. TypeCode can be a coded representation of a
type of a physical location. TypeCode can be based on GDT:
LocationTypeCode. Name can be a name of a location. Name can be
based on GDT: MEDIUM_Name, Qualifier: Location.
[0424] DangerousGoods can specify dangerous goods included in a
resource. DangerousGoods includes the ContactInformation and
TextCollection entities. The structure of DangerousGoods includes
the following elements: ID, RegulationsCode, HazardCode,
FlashpointMeasureInterval, PackagingGroupCode, EmergencySchedule,
TransportEmergencyCardCode, DangerousGoodsLabelCode,
DangerousGoodsLabelCode2, DangerousGoodsLabelCode3,
PackagingInstructionTypeCode, TransportMeansDescriptionCode, and
TransportAuthorisationCode. ID can be a unique identifier for a
dangerous good, using the United Nations Dangerous Goods Number. ID
can be based on GDT: DangerousGoodsID.
[0425] RegulationsCode can be a coded representation of national or
international dangerous goods rules or regulations. RegulationsCode
can be based on GDT: DangerousGoodsRegulationsCode. HazardCode can
be a coded representation of a hazard that is imminent in a
dangerous good. HazardCode can be based on GDT:
DangerousGoodsHazardCode. FlashpointMeasureInterval can be an
interval of measures defined by a lower and an upper boundary
indicating a flashpoint of a dangerous good.
FlashpointMeasureInterval can be based on GDT: MeasureInterval,
Qualifier: Flashpoint. PackagingGroupCode can be a coded
representation of the effectiveness of a packaging to transport
dangerous goods depending on the degree of danger of the goods.
PackagingGroupCode can be based on GDT:
DangerousGoodsPackagingGroupCode.
[0426] EmergencySchedule can be a coded representation of an
emergency schedule for dangerous goods. EmergencySchedule can
identify an emergency schedule. The DangerousGoodsEmergencySchedule
can be used for transports of dangerous goods by sea similar to a
Transport Emergency Card which is used for transports of dangerous
goods by road. EmergencySchedule can be based on GDT:
DangerousGoodsEmergencySchedule. TransportEmergencyCardCode can be
a coded representation of a transport emergency card which
specifies how to react in case of an accident.
TransportEmergencyCardCode can be based on GDT:
TransportEmergencyCardCode. DangerousGoodsLabelCode can be a coded
representation of a label for a dangerous good.
[0427] In some implementations, DangerousGoodsLabelCode's values
are dependant on the DangerousGoodsRegulationsCode.
DangerousGoodsLabelCode can be based on GDT:
DangerousGoodsLabelCode. DangerousGoodsLabelCode2 can be a coded
representation of a label for a dangerous good. In some
implementations, DangerousGoodsLabelCode's values are dependant on
the DangerousGoodsRegulationsCode. DangerousGoodsLabelCode2 can be
based on GDT: DangerousGoodsLabelCode. DangerousGoodsLabelCode3 can
be a coded representation of a label for a dangerous good. In some
implementations, DangerousGoodsLabelCode's values are dependant on
the DangerousGoodsRegulationsCode. DangerousGoodsLabelCode3 can be
based on GDT: DangerousGoodsLabelCode.
[0428] PackagingInstructionTypeCode can be a coded representation
of a packaging instruction. A packaging instruction can be an
instruction defining which packagings can be used to pack a
dangerous good. PackagingInstructionTypeCode can be based on GDT:
PackagingInstructionTypeCode. TransportMeansDescriptionCode can be
a coded representation of a transport means type with which goods
or persons are to be transported. TransportMeansDescriptionCode can
be based on GDT: TransportMeansDescriptionCode.
TransportAuthorisationCode can be a coded representation of an
authorisation for a transportation of dangerous goods. This code
can specify an authorisation for a transportation of a particular
dangerous good. TransportAuthorisationCode can be based on GDT:
DangerousGoodsTransportAuthorisationCode.
[0429] The TransportationChargesInformation package includes
information regarding a transportation charge calculation specific
to components related to a FreightOrder. The
TransportationChargesInformation package includes the
TransportationChargesInformation entity. The entity
TransportationChargesInformation can define a relationship between
transportation charges and the origin of these charges.
TransportationChargesInformation includes the
TransportationChargesentity. The structure of
TransportationChargesInformation includes the following elements:
TransportationChargesUsageCode, FreightOrderPartyStandardID,
FreightOrderTransportationUnitResourceID, and
FreightOrderTransportationStageID. TransportationChargesUsageCode
can be a coded representation of the usage of
TransportationCharges. The usage points out if subsequent
information represents a revenue view or cost view on
transportation charges.
[0430] TransportationChargesUsageCode can be based on GDT:
TransportationChargesUsageCode. FreightOrderPartyStandardID can be
a unique identifier of a Party in a FreightOrder.
FreightOrderPartyStandardID can be based on GDT: PartyStandardID.
FreightOrderTransportationUnitResourceID can be a unique
identification of a TransportationUnitResource in a FreightOrder.
FreightOrderTransportationUnitResourceID can be based on GDT:
ResourceID. FreightOrderTransportationStageID can be a unique
identification of a TransportationStage in a FreightOrder.
FreightOrderTransportationStageID can be based on GDT:
TransportationStageID. If none of the IDs is maintained, the
transportation charges are related to the entire freight order.
[0431] TransportationCharges can be a summary of determined
transportation charge specific components for a transportation
business case. TransportationCharges includes the following
entities: Location, TextCollection, Currency, ExchangeRate,
PercentElement, DateTimePeriod,
BusinessTransactionDocumentReference, TaxDetail,
PaymentInstruction, CashDiscountTerms, and Element. The structure
of TransportationCharges includes the following elements: ID,
FreightAgreementID, CalculationOriginCode, TariffID, and
CalculationSheetID. ID can be a unique identifier of
TransportationCharges in a ShipmentRequest. ID can be based on GDT:
TransportationChargesID. FreightAgreementID can be an
identification of a Freight Agreement which includes and points to
a configuration for the Transportation Charges Calculation.
[0432] FreightAgreementID can be based on GDT: FreightAgreementID.
CalculationOriginCode can be a coded representation of the origin
of a transportation charges calculation. The calculation can be
done automatically based on a system configuration. Data for the
calculation, including the results, can be manually entered or
received from another business system via a message. In some
implementations, it may be necessary to have a clear distinction of
the origin of TransportationChargesCalculation details, such as the
TransportationChargesCalculationSheet and its
TransportationChargeElements. The distinction can give information
whether the calculation was done completely automatically, or if
the results were manually adopted. CalculationOriginCode can be
based on GDT: TransportationChargesOriginCode.
[0433] TariffID can be an identifier for a transportation charges
tariff. A transportation charges tariff can be a specific
combination of a transportation charges calculation sheet and terms
and conditions. The terms and conditions can define if a certain
transportation charges calculation sheet and its related rates are
applicable for a transportation business case. TariffID can be
based on GDT: TransportationChargesTariffID. CalculationSheetID can
be a unique Identifier for a transportation charges calculation
sheet. A TransportationChargesCalculationSheet can represent a
configuration describing how to calculate necessary transportation
charges for a transportation business case.
TransportationChargesCalculationSheet includes instructions,
indications of which charges are applicable, indications of which
data from the transportation business case can be considered for
the calculation, information describing how the underlying
transportation charge rates determined, and information describing
which special calculation methods can be considered.
CalculationSheetID can be based on GDT:
TransportationChargesCalculationSheetID.
[0434] A ShipmentOrder package can specify or group together data
related to a shipment request which is assigned to a freight order.
The ShipmentOrder package includes the ShipmentOrder entity and the
Request package. ShippingOrder can be an agreement between an
ordering party and a transportation service provider on the
shipment of goods from a single shipper to a single consignee in
accordance with agreed terms and conditions. ShippingOrder includes
the TransportationStageAssignment and
TransportationUnitResourceInformationAssignment entities. The
structure of ShipmentOrder includes the ID element. ID can be a
unique identifier of a ShipmentOrder. ID can be based on GDT:
BusinessTransactionDocumentID.
[0435] TransportationStageAssignment can specify an assignment of a
shipment order to a transportation stage of a freight order. The
structure of TransportationStageAssignment includes the element
FreightOrderTransportationStageID.
FreightOrderTransportationStageID can be a unique identifier of a
TransportationStage in a freight order.
FreightOrderTransportationStageID can be based on GDT:
TransportationStageID.
[0436] TransportationUnitResourceInformationAssignment can specify
an assignment of a shipment order to a
TransportationUnitResourceInformation of a freight order. The
structure of TransportationUnitResourceInformationAssignment
includes the FreightOrderTransportationUnitResourceID element.
FreightOrderTransportationUnitResourceID can be a unique identifier
of a TransportationUnitResource in a freight order.
FreightOrderTransportationUnitResourceID can be based on GDT:
ResourceID.
[0437] The Request package can group a Request with its packages.
The Request package includes the Request entity and the packages
HeaderInformation, TransportationChargesInformation,
GovernmentalRequirementInformation, PartyInformation,
LocationInformation, TransportationStageInformation,
TransportationUnitResourceInformation, PackagingInformation, and
Item. In some implementations, the Request Package is filled either
for none or for all of the shipment requests which are assigned to
a freight order. In a first case (short form message),
ShipmentRequest and its subentities identify the ShipmentRequest
requests that have already been sent before. In a second case
(extended form message) the Request Package includes
ShipmentRequest request data, and in a standard process the
subentities of entity ShipmentRequest may or may not be filled.
Message Data Type FreightOrderExecutionCancelRequestMessage
[0438] The message data type
FreightOrderExecutionCancelRequestMessage can group together
business information relevant for sending a business document in a
message and the FreightOrderExecution object in a business
document. The message data type
FreightOrderExecutionCancelRequestMessage includes the
MessageHeader and FreightOrderExecution packages. The message data
type FreightOrderExecutionCancelRequestMessage can provide a
structure for the message type FreightOrderExecutionCancelRequest
and the interfaces that are based on it.
[0439] A MessageHeader package can group together business
information relevant for sending a business document in a message.
The MessageHeader package includes the MessageHeader entity. A
MessageHeader can group together business information from the
perspective of a sending application to identify a business
document in a message, to provide information about the sender, or
to provide information about the recipient. The MessageHeader can
be divided up into the SenderParty and RecipientParty entities.
MessageHeader can be of type GDT: BusinessDocumentMessageHeader.
The MessageHeader includes the following elements: ID, ReferenceID,
and CreationDateTime. The MessageID can be set by the sending
application. With the ReferencedMessageID, reference can be made in
the current BusinessDocument to a previous BusinessDocument.
[0440] A SenderParty can be a party responsible for sending a
business document at a business application level. The SenderParty
can be of type GDT: BusinessDocumentMessageHeaderParty. The
SenderParty includes the following elements: InternalID,
StandardID, and ContactPerson. The SenderParty can be filled by the
sending application to name a contact person for problems with the
message. A contact person can be useful if an additional
infrastructure, such as a marketplace, is located between the
sender and the recipient. The SenderParty can be used to transfer a
message and can be ignored by the receiving application.
SenderParty can be filled by the sender if the participating
parties are not transferred with the FreightOrderExecution
Package.
[0441] A RecipientParty can be a party responsible for receiving a
business document at a business application level. The
RecipientParty can be of type GDT:
BusinessDocumentMessageHeaderParty. The RecipientParty includes the
following elements: InternalID, StandardID, and ContactPerson. The
RecipientParty can be filled by the sending application to name a
contact person for problems that may occur with the message. A
contact person can be useful if an additional infrastructure, such
as a marketplace, is located between the sender and the recipient.
The RecipientParty can be used to transfer a message and can be
ignored by the receiving application. RecipientParty can be filled
by the sender if the FreightOrderExecution Package cannot be used
to transfer the participating parties.
[0442] The FreightOrderExecution package can group together
information about the FreightOrderExecution. The
FreightOrderExecution package includes the FreightOrderExecution
entity and the BusinessTransactionDocumentReference package. The
FreightOrderExecution interface can be used to delegate the
execution of planned transportation of goods, from shippers to
consignees, to the transportation execution processing of an ERP
system. The attributes and elements located directly at the
FreightOrder entity include ID. ID can be a unique identifier of a
FreightOrder. ID can be based on GDT:
BusinessTransactionDocumentID.
[0443] Request can be an agreement between a transportation service
provider and an ordering party on the transportation of goods from
a single ship-from party to a single ship-to party in accordance
with agreed terms and conditions.
[0444] A BusinessTransactionDocumentReference package can group
references to business documents. A
BusinessTransactionDocumentReference package includes the
BusinessTransactionDocumentReference entity. The structure of
BusinessTransactionDocumentReference includes the following
elements: BusinessTransactionDocumentReference,
BusinessTransactionDocumentRelationshipRoleCode,
BusinessTransactionDocumentRelationshipTypeCode,
TransportationDocumentTypeCode, TransportationDocumentNote, and
TransportationDocumentID. BusinessTransactionDocumentReference can
be a unique reference to other business documents or business
document items that are of significance within each respective
business process. BusinessTransactionDocumentReference can be based
on GDT: BusinessTransactionDocumentReference.
[0445] BusinessTransactionDocumentRelationshipRoleCode can be a
coded representation of a role that a business document or a
business document item has when set against another business
document or business document item with a relationship.
BusinessTransactionDocumentRelationshipRoleCode can be based on
GDT: BusinessTransactionDocumentRelationshipRoleCode.
BusinessTransactionDocumentRelationshipTypeCode can be a coded
representation of a relationship between two business documents or
business document items.
BusinessTransactionDocumentRelationshipTypeCode can be based on
GDT: BusinessTransactionDocumentRelationshipTypeCode.
TransportationDocumentTypeCode can be a coded representation of a
documentation type. TransportationDocumentTypeCode can be based on
GDT: TransportationDocumentTypeCode.
[0446] TransportationDocumentNote can be a short Note on
documentation. TransportationDocumentNote can be based on GDT:
SHORT_Note. TransportationDocumentID can be a unique identifier for
a transportation document. TransportationDocumentID can be based on
GDT: TransportationDocumentID. RelationshipTypeCode and
RelationshipRoleCode are both optional. In some implementations, if
used, both may be filled. Either the combination
BusinessTransactionDocumentReference,
BusinessTransactionDocumentRelationshipRoleCode,
BusinessTransactionDocumentRelationshipTypeCode or
TransportationDocumentTypeCode, TransportationDocumentNote,
TransportationDocumentID may be filled.
Message Data Type FreightOrderExecutionConfirmationMessage
[0447] The message data type
FreightOrderExecutionConfirmationMessage includes business
information relevant for sending a business document in a message,
and the FreightOrderExecution included in a business document. The
message data type FreightOrderExecutionConfirmationMessage includes
the MessageHeader and FreightOrderExecution packages. The message
data type FreightOrderExecutionConfirmationMessage can provide a
structure for the message type FreightOrderExecutionConfirmation
and the interfaces that are based on it.
[0448] A MessageHeader package can group together business
information relevant for sending a business document in a message.
The MessageHeader package includes the MessageHeader entity. A
MessageHeader can group together business information from a
perspective of a sending application to identify a business
document in a message, to provide information about the sender, and
to provide information about the recipient. The MessageHeader can
be divided up into the SenderParty and RecipientParty entities.
MessageHeader can be of type GDT: BusinessDocumentMessageHeader.
The MessageHeader includes the following elements: ID, ReferenceID,
and CreationDateTime. The MessageID can be set by the sending
application. With the ReferencedMessageID, reference can be made in
the current BusinessDocument to a previous BusinessDocument.
[0449] A SenderParty can be a party responsible for sending a
business document at a business application level. The SenderParty
can be of type GDT: BusinessDocumentMessageHeaderParty. The
SenderParty includes the following elements: InternalID,
StandardID, and ContactPerson. The SenderParty can be filled by the
sending application to name a contact person for problems with the
message. A contact person can be useful if an additional
infrastructure, such as a marketplace, is located between the
sender and the recipient. The SenderParty can be used to transfer
the message and can be ignored by the receiving application.
SenderParty can be filled by the sender if the participating
parties are not transferred with the FreightOrderExecution
Package.
[0450] A RecipientParty can be a party responsible for receiving a
business document at a business application level. The
RecipientParty can be of type GDT:
BusinessDocumentMessageHeaderParty. The RecipientParty includes the
following elements: InternalID, StandardID, and ContactPerson. The
RecipientParty can be filled by the sending application to name a
contact person for problems that may occur with the message. A
contact person can be useful if an additional infrastructure, such
as a marketplace, is located between the sender and the recipient.
The RecipientParty can be used to transfer the message and can be
ignored by the receiving application. RecipientParty can be filled
by the sender if the FreightOrderExecution Package cannot be used
to transfer the participating parties.
[0451] The FreightOrderExecution package can group the
FreightOrderExecution together with its packages. The
FreightOrderExecution package includes the FreightOrderExecution
entity and the Confirmation package. The freight order execution
interface can be used to delegate the execution of planned
transportation of goods, from shippers to consignees, to the
transportation execution processing of an ERP system. The
attributes and elements located directly at the FreightOrder entity
include @actioncode and ID. @actioncode can be a coded
representation of an instruction to a message recipient describing
how to process a transmitted element. @actioncode can be based on
GDT: ActionCode. ID can be a unique identifier of a FreightOrder.
ID can be based on GDT: BusinessTransactionDocumentID. In some
implementations, the attribute @actioncode may only include the two
values "01--Create" and "02--Change". In some implementations, the
ID is not changed once a FreightOrder has been created. In some
implementations, the Complete Transmission Indicator is set to true
(i.e., the complete message content is transmitted in every
message). As a consequence, previously transferred data that is not
sent with the change message may be deleted.
[0452] The Confirmation package can be a confirmation of an
agreement between a transportation service provider and an ordering
party on the transportation of goods from a single ship-from party
to a single ship-to party in accordance with agreed terms and
conditions. The Confirmation package includes the Confirmation
entity. The Confirmation package includes the following packages:
HeaderInformation, TransportationChargesInformation,
GovernmentalRequirementInformation, PartyInformation,
LocationInformation, TransportationStageInformation,
TransportationUnitResourceInformation, PackagingInformation, and
Item. Confirmation can be a confirmation of an agreement between a
transportation service provider and an ordering party on the
transportation of goods from a single ship-from party to a single
ship-to party in accordance with agreed terms and conditions. The
confirmation entity includes the AcceptanceStatusCode element.
AcceptanceStatusCode can be a coded representation of a status of
an acceptance by a communication partner regarding a business
transaction that has been transmitted to that partner.
AcceptanceStatusCode can be based on GDT: Acceptance Status
Code.
[0453] The HeaderInformation package can group dates, total values,
document and references related to a freight order. The
HeaderInformation package includes the following entities:
DateTimePeriods, NatureOfCargo, TotalQuantity, TotalAmount,
TextCollection, and BusinessTransactionDocumentReference.
[0454] The GovernmentalProcedureInformation package can specify
applicable governmental procedures related to import, export and
transport of goods of a shipment request. The
GovernmentalProcedureInformation package includes the
GovernmentalProcedure entity. GovernmentalProcedure can specify
applicable governmental procedures related to import, export and
transport of goods of a shipment request. GovernmentalProcedure
includes the following entities: Location, DateTimePeriod, Seal,
TextCollection, and TransportationDocumentInformation. The
structure of GovernmentalProcedure includes the following elements:
TransportationGovernmentAgencyTypeCode,
TransportationMovementTypeCode,
TransportationGovernmentAgencyInvolvementStatusCode,
TransportationGovernmentAgencyActionCode, and
TransportationGovernmentAgencyProcedureStatusCode.
[0455] TransportationGovernmentAgencyTypeCode can be a coded
representation of a type of a government agency.
TransportationGovernmentAgencyTypeCode can be based on GDT:
TransportationGovernmentAgencyTypeCode.
TransportationMovementTypeCode can be a coded representation of a
type of a transport movement. Examples include Import, Export,
Transit, and Transshipment. TransportationMovementTypeCode can be
based on GDT: TransportationMovementTypeCode.
TransportationGovernmentAgencyInvolvementStatusCode can be a coded
representation for an involvement status of a transportation
related government agency.
TransportationGovernmentAgencyInvolvementStatusCode can be based on
GDT: TransportationGovernmentAgencyInvolvementStatusCode.
TransportationGovernmentAgencyActionCode can be a coded
representation of an action of a transportation related government
agency.
[0456] TransportationGovernmentAgencyActionCode can be based on
GDT: TransportationGovernmentAgencyActionCode.
TransportationGovernmentAgencyProcedureStatusCode can be a coded
representation of a status of a procedure related to a
transportation government agency.
TransportationGovernmentAgencyProcedureStatusCode can be based on
GDT: TransportationGovernmentAgencyProcedureStatusCode.
[0457] The PartyInformation package includes information regarding
a party of a freight order (e.g., Shipper, Carrier, Agent).
PartyInformation includes the Party entity. The LocationInformation
package includes information regarding a location of a shipment
order (e.g., Ship-from location). The LocationInformation package
includes the Location entity.
[0458] The TransportationStageInformation package includes
information regarding a stage of a freight order. A stage can
represent a section of a transport. The
TransportationStageInformation package includes the
TransportationStage entity. TransportationStage can specify details
related to a stage of a transport which is part of a freight order.
TransportationStage includes the following entities:
ContactInformation, Quantity, Party, Location, Seal,
TextCollection, BusinessTransactionDocumentReference, and
TransportationServiceRequirement. The structure of
TransportationStage includes the following elements: ID,
OrdinalNumberValue, TypeCode, JourneyID, TransportModeCode,
TransportMeansDescriptionCode, TransportMeansDescription,
TransportMeansID, TransportMeansHomeCountryCode,
TransportMeansOwnershipTypeCode, CarrierStandardID,
CarrierFormattedName, TransportationTransitDirectionCode,
CalculatedDistanceMeasure, and GivenDistanceMeasure.
[0459] ID can be a unique identifier of a stage in a shipment
request. ID can be based on GDT: TransportationStageID.
OrdinalNumberValue can be an ordinal number to indicate a position
of a transportation stage in a set of transportation stages.
OrdinalNumberValue can be based on GDT: OrdinalNumberValue,
Qualifier: TransportationStage. TypeCode can be a coded
representation of a type of a TransportationStage. TypeCode can be
based on GDT: TransportationStageTypeCode. JourneyID can be an
identifier of a Journey. JourneyID can be based on GDT: JourneyID.
TransportModeCode can be a coded representation of a mode of
transportation used for delivery. TransportModeCode can be based on
GDT: TransportModeCode.
[0460] TransportMeansDescriptionCode can be a coded representation
of a transport means type with which goods or persons are to be
transported. TransportMeansDescriptionCode can be based on GDT:
TransportMeansDescriptionCode. TransportMeansDescription can be a
description of a means of transport. TransportMeansDescription can
be based on GDT: SHORT_Description, Qualifier: TransportMeans.
TransportMeansID can be a unique identifier of a means of
transport. TransportMeansID can be based on GDT: TransportMeansID.
TransportMeansHomeCountryCode can be a coded representation of the
home country of a transport means. TransportMeansHomeCountryCode
can be based on GDT: CountryCode, Qualifier: TransportMeansHome.
TransportMeansOwnershipTypeCode can be a coded representation of a
type of ownership for a means of transport.
[0461] TransportMeansOwnershipTypeCode can be based on GDT:
TransportMeansOwnershipTypeCode. CarrierStandardID can be a
standard identifier of a carrier. CarrierStandardID can be based on
GDT: PartyStandardID. CarrierFormattedName can be a name of a
carrier. CarrierFormattedName can be based on GDT: LONG_Name,
Qualifier: PartyFormatted. TransportationTransitDirectionCode can
be a coded representation for a transportation transit direction.
TransportationTransitDirectionCode can be based on GDT:
TransportationTransitDirectionCode. CalculatedDistanceMeasure can
be a calculated distance measure. CalculatedDistanceMeasure can be
based on GDT: Measure, Qualifier: CalculatedDistance.
GivenDistanceMeasure can be a given distance measure.
GivenDistanceMeasure can be based on GDT: Measure, Qualifier:
GivenDistance.
[0462] The TransportationUnitResourceInformation package includes
information regarding a transportation unit resource that is
relevant for a freight order, (e.g., a container). The
TransportationUnitResourceInformation package includes the
TransportationUnitResourceInformation entity.
TransportationUnitResourceInformation includes information on one
or more transportation unit resources, such as a resource type and
related properties, related measures or handling instructions. A
Transportation Unit Resource can be a unit into which goods are
loaded and/or from which goods are unloaded. In some
implementations, this unit can provide transportation capacity for
goods but may or may not move by itself.
[0463] TransportationUnitResourceInformation includes the following
entities: TransportationStageAssignment, AttachedEquipment,
Quantity, Seal, BusinessTransactionDocumentReference,
TextCollection, Party, Location, and DangerousGoods. The structure
of TransportationUnitResourceInformation includes the following
elements: ID, ResourceNumberValue, ResourceID,
ResourceHomeCountryCode, TransportationUnitResourceCategoryCode,
TransportationUnitResourceTypeCode, FillLevelCode,
ShippingTypeCode, HaulageArrangerCode,
TransportationHandlingInstructionCode, and
TransportationHandlingInstructionNote. ID can be a unique
identifier for a resource information, and can be based on GDT
ResourceInformationID. ResourceNumberValue can be a number of
resources, and can be based on GDT: NumberValue, Qualifier:
Resource.
[0464] ResourceID can be a unique identifier for a resource, and
can be based on GDT: ResourceID. ResourceHomeCountryCode can be a
coded representation of the home country of a resource.
ResourceHomeCountryCode can be based on GDT: CountryCode,
Qualifier: ResourceHome. TransportationUnitResourceCategoryCode can
be a coded representation of a category of transportation unit
resources. TransportationUnitResourceCategoryCode can be based on
GDT: TransportationUnitResourceCategoryCode.
TransportationUnitResourceTypeCode can be a coded representation of
a type of a transportation unit resource.
TransportationUnitResourceTypeCode can be based on GDT:
TransportationUnitResourceTypeCode. FillLevelCode can be a coded
representation of a fill level of a resource. FillLevelCode can be
based on GDT: FillLevelCode. ShippingTypeCode can be a coded
representation of a shipping type.
[0465] A shipping type can specify how planning and execution of a
transportation may be performed. Transportation terms include
detailed specifications on agreed means of transportation, such as
shipping or transport type and means of transport to be used. The
ShippingTypeCode can be based on GDT: ShippingTypeCode.
HaulageArrangerCode can be a coded representation of an arranger of
a haulage. Haulage can be inland transport of cargo.
HaulageArrangerCode can be based on GDT: HaulageArrangerCode.
TransportationHandlingInstructionCode can be a coded representation
of the type of a transportation handling instruction.
TransportationHandlingInstructionCode can be based on GDT:
TransportationHandlingInstructionCode.
TransportationHandlingInstructionNote can be a note regarding a
transportation handling instruction.
TransportationHandlingInstructionNote can be based on GDT:
LONG_Note, Qualifier: TransportationHandlingInstruction.
[0466] A PackageInformation package can describe package
information related to a whole shipment order. A PackageInformation
package includes the following entities: ItemAssignment,
TransportationUnitResourceInformationAssignment, and Quantity. The
structure of PackageInformation includes ID, PackageID,
PackageOrdinalNumberValue, PackageNumberValue, PackageTypeCode,
PackagingLevelCode, PackageMarkingInstructionCode, and
PredecessorPackageID. ID can be a unique identifier for a package
information, and can be based on GDT: PackageInformationID.
PackageID can be a unique identifier of a package used in a
packaging, and can be based on GDT: PackageID.
PackageOrdinalNumberValue can be an ordinal number to indicate a
position of a package in a set of packages. In a transportation
document, a position of a package can be a position that has been
specified at shipping time.
[0467] PackageOrdinalNumberValue can be based on GDT:
OrdinalNumberValue, Qualifier: Package. PackageNumberValue can be
the number of packages used in a packaging. PackageNumberValue can
be based on GDT: NumberValue, Qualifier: Package. PackageTypeCode
can be a coded representation of a type of a package, and can be
based on GDT: PackageTypeCode. PackagingLevelCode can be a coded
representation of a packaging level. A packaging level can specify
a rank of a packaging in a packaging hierarchy. PackagingLevelCode
can be based on GDT: PackagingLevelCode.
PackageMarkingInstructionCode can be a coded representation of a
marking instruction of a package, and can be based on GDT:
PackageMarkingInstructionCode. PredecessorPackageID can be a unique
identification of a related package, and can be based on GDT:
PackageID. In some implementations, PredecessorPackageID may be
filled in case a PackageID is available.
[0468] The TransportationChargesInformation package includes
information regarding transportation charge calculation specific
components related to a FreightOrder. The
TransportationChargesInformation package includes the
TransportationChargesInformation entity. The entity
TransportationChargesInformation can define a relationship between
transportation charges and an origin of these charges.
TransportationChargesInformation includes the
TransportationChargesentity. The structure of
TransportationChargesInformation includes the following elements:
TransportationChargesUsageCode, FreightOrderPartyStandardID,
FreightOrderTransportationUnitResourceID, and
FreightOrderTransportationStageID. TransportationChargesUsageCode
can be a coded representation of usage of the
TransportationCharges.
[0469] The usage points out if subsequent information represents a
revenue view or cost view on transportation charges.
TransportationChargesUsageCode can be based on GDT:
TransportationChargesUsageCode. FreightOrderPartyStandardID can be
a unique identifier of a Party in a FreightOrder.
FreightOrderPartyStandardID can be based on GDT: PartyStandardID.
FreightOrderTransportationUnitResourceID can be a unique
identification of a TransportationUnitResource in a FreightOrder.
FreightOrderTransportationUnitResourceID can be based on GDT:
ResourceID. FreightOrderTransportationStageID can be a unique
identification of a TransportationStage in a FreightOrder, and can
be based on GDT: TransportationStageID. In some implementations, if
none of the IDs is maintained, the transportation charges are
related to an entire freight order.
[0470] An Item package includes information regarding products
included in a shipment order and additional information on these
products. The Item package includes the Item entity and the
following packages: ItemInformation, LocationInformation, and
TransportGoodsInformation. The structure of Item includes the
following elements: ID, OriginCountryCode, DestinationCountryCode,
ShippingTypeCode, HaulageArrangerCode, TemperatureMeasureInterval,
and TransportationHandlingInstructionCode. ID can be a unique
identifier of an Item in a shipment request, and can be based on
GDT: BusinessTransactionDocumentItemID OriginCountryCode can be a
country of origin of goods that are considered in a shipment
request.
[0471] OriginCountryCode can be based on GDT: CountryCode,
Qualifier: Origin. DestinationCountryCode can be the ultimate
country of destination of goods that are considered in a shipment
request. DestinationCountryCode can be based on GDT: CountryCode,
Qualifier: Destination. ShippingTypeCode can be a coded
representation of a shipping type. A shipping type can specify how
planning and execution of a transportation may be performed.
Transportation terms include detailed specifications on agreed
means of transportation, such as shipping or transport type and
means of transport to be used. ShippingTypeCode can be based on
GDT: ShippingTypeCode. HaulageArrangerCode can be a coded
representation of an arranger of a haulage. Haulage can be inland
transportation of cargo.
[0472] HaulageArrangerCode can be based on GDT:
HaulageArrangerCode. TemperatureMeasureInterval can be an interval
of temperature measures defined by a lower and an upper boundary
and a measure type code. TemperatureMeasureInterval can be based on
GDT: MeasureInterval, Qualifier: Temperature.
TransportationHandlingInstructionCode can be a coded representation
of a transportation handling instruction.
TransportationHandlingInstructionCode can be based on GDT:
TransportationHandlingInstructionNote. In some implementations, for
a measure related to a temperature, the units of measurement
Celsius and Fahrenheit are allowed.
Message Data Type
FreightOrderExecutionStatusNotificationMessage
[0473] The message data type
FreightOrderExecutionStatusNotificationMessage includes business
information relevant for sending a business document in a message,
and the FreightOrderExecution included in a business document. The
message data type FreightOrderExecutionStatusNotificationMessage
includes the MessageHeader and FreightOrderExecution packages. The
message data type FreightOrderExecutionStatusNotificationMessage
can provide a structure for the message type
FreightOrderExecutionStatusNotification and for interfaces that are
based on it.
[0474] A MessageHeader package can group together business
information relevant for sending a business document in a message.
The MessageHeader package includes the MessageHeader entity. A
MessageHeader can group together business information from the
perspective of the sending application to identify a business
document in a message, to provide information about the sender, and
to provide information about the recipient. The MessageHeader can
be divided up into the SenderParty and RecipientParty entities.
MessageHeader can be of type GDT: BusinessDocumentMessageHeader.
The MessageHeader includes the following elements: ID, ReferenceID,
and CreationDateTime. The MessageID can be set by the sending
application. With the ReferencedMessageID, reference can be made in
the current BusinessDocument to a previous BusinessDocument.
[0475] A SenderParty can be a party responsible for sending a
business document at a business application level. The SenderParty
can be of type GDT: BusinessDocumentMessageHeaderParty. The
SenderParty includes the following elements: InternalID,
StandardID, and ContactPerson. The SenderParty can be filled by the
sending application to name a contact person for problems with a
message. A contact person can be useful if an additional
infrastructure, such as a marketplace, is located between the
sender and the recipient. The SenderParty can be used to transfer a
message and can be ignored by the receiving application.
SenderParty can be filled by the sender if the participating
parties are not transferred with the FreightOrderExecution
Package.
[0476] A RecipientParty can be a party responsible for receiving a
business document at a business application level. The
RecipientParty can be of type GDT:
BusinessDocumentMessageHeaderParty. The RecipientParty includes the
following elements: InternalID, StandardID, and ContactPerson. The
RecipientParty can be filled by the sending application to name a
contact person for problems that may occur with a message. This can
be useful if an additional infrastructure, such as a marketplace,
is located between the sender and the recipient. The RecipientParty
can be used to transfer a message and can be ignored by the
receiving application. RecipientParty can be filled by the sender
if the FreightOrderExecution Package cannot be used to transfer the
participating parties.
[0477] The FreightOrderExecution package can group the
FreightOrderExecution together with its packages. The
FreightOrderExecution package includes the FreightOrderExecution
entity and the Confirmation package. The FreightOrderExecution
interface can be used to delegate execution of planned
transportation of goods, from shippers to consignees, to
transportation execution processing of an ERP system. The
attributes and elements located directly at the FreightOrder entity
include @actioncode and ID. @actioncode can be a coded
representation of an instruction to a message recipient describing
how to process a transmitted element. @actioncode can be based on
GDT: ActionCode. ID can be a unique identifier of a FreightOrder.
ID can be based on GDT: BusinessTransactionDocumentID. In some
implementations, the attribute @actioncode may only contain the two
values "01--Create" and "02--Change".
[0478] In some implementations, the ID is not changed once a
FreightOrder has been created. In some implementations, the
Complete Transmission Indicator is set to true, (i.e., the complete
message content may be transmitted in every message). As a
consequence, previously transferred data that is not sent with the
change message may be deleted.
[0479] The Confirmation package can group the Confirmation with its
packages. The Confirmation package includes the Confirmation entity
and the HeaderInformation package. Confirmation can be a
confirmation of an agreement between a transportation service
provider and an ordering party on transportation of goods from a
single ship-from party to a single ship-to party in accordance with
agreed terms and conditions.
[0480] The HeaderInformation package can group dates, total values,
document and references related to a freight order. The
HeaderInformation package includes the following entities:
DateTimePeriods, NatureOfCargo, TotalQuantity, TotalAmount,
TextCollection, and BusinessTransactionDocumentReference.
Message Data Type
FreightOrderInvoicingPreparationRequestMessage
[0481] The message data type
FreightOrderInvoicingPreparationRequestMessage includes business
information relevant for sending a business document in a message,
and the FreightOrderInvoicingPreparation included in a business
document. The message data type
FreightOrderInvoicingPreparationRequestMessage includes the
MessageHeader and FreightOrderInvoicingPreparation packages. The
message data type FreightOrderInvoicingPreparationRequestMessage
can provide a structure for the message type
FreightOrderInvoicingPreparationRequest and for interfaces that are
based on it.
[0482] A MessageHeader package can group together business
information relevant for sending a business document in a message.
The MessageHeader package includes the MessageHeader entity. A
MessageHeader can group together business information from the
perspective of the sending application in order to identify a
business document in a message, provide information about the
sender, and provide information about the recipient. The
MessageHeader can be divided up into the SenderParty and
RecipientParty entities. The MessageHeader can be of type GDT:
BusinessDocumentMessageHeader. The MessageHeader includes the
following elements: ID, ReferenceID, and CreationDateTime. The
MessageID can be set by the sending application. With the
ReferencedMessageID, reference can be made in the current
BusinessDocument to a previous BusinessDocument.
[0483] A SenderParty can be a party responsible for sending a
business document at a business application level. The SenderParty
can be of type GDT: BusinessDocumentMessageHeaderParty. The
SenderParty includes the following elements: InternalID,
StandardID, and ContactPerson. The SenderParty can be filled by the
sending application to name a contact person for problems with a
message. A contact person can be useful if an additional
infrastructure, such as a marketplace, is located between the
sender and the recipient. The SenderParty can be used to transfer a
message and can be ignored by the receiving application.
SenderParty can be filled by the sender if the participating
parties are not transferred with the
FreightOrderInvoicingPreparation Package.
[0484] A RecipientParty can be a party responsible for receiving a
business document at a business application level. The
RecipientParty can be of type GDT:
BusinessDocumentMessageHeaderParty. The RecipientParty includes the
following elements: InternalID, StandardID, and ContactPerson. The
RecipientParty can be filled by the sending application to name a
contact person for problems that may occur with a message. A
contact person can be useful if an additional infrastructure, such
as a marketplace, is located between the sender and the recipient.
The RecipientParty can be used to transfer a message and can be
ignored by the receiving application. RecipientParty can be filled
by the sender if the FreightOrderInvoicingPreparation Package
cannot be used to transfer the participating parties.
[0485] The FreightOrderInvoicingPreparation package can group the
FreightOrderInvoicingPreparation with its packages. The
FreightOrderInvoicingPreparation package includes the
FreightOrderInvoicingPreparation entity and the Request package. A
FreightOrderInvoicingPreparation can be used in purchase order
processing for the preparation of supplier invoicing. The
attributes and elements located directly at the
FreightOrderInvoicingPreparation entity include @actioncode and ID.
@actioncode can be a coded representation of an instruction to a
message recipient describing how to process a transmitted element.
@actioncode can be based on GDT: ActionCode. ID can be a unique
identifier of a FreightOrder. ID can be based on GDT:
BusinessTransactionDocumentID. In some implementations, the
attribute @actioncode may include the two values "01--Create" and
"02--Change".
[0486] The Request package can group a Request with its packages.
The Request package includes the Request entity and the following
packages: HeaderInformation, PartyInformation,
TransportationChargesInformation, and ShipmentOrder.
[0487] The HeaderInformation package can group dates, total values,
document and references related to freight order invoicing
preparation. The HeaderInformation package includes the following
entities: PurchaseBusinessArea, DateTimePeriods, NatureOfCargo,
TotalQuantity, TotalAmount, TextCollection, and
BusinessTransactionDocumentReference.
[0488] The PurchaseBusinessArea can be a purchase specific area
within an enterprise. For example, a PurchaseBusinessArea can be a
purchasing organization or purchasing group. The structure of
PurchaseBusinessArea includes the PurchasingOrganisationID and
PurchasingGroupID elements. PurchasingOrganisationID can be an
identifier for a purchasing organisation, and can be based on GDT:
OrganisationalCentreID. PurchasingGroupID can be an identifier for
a purchasing group, and can be based on GDT:
OrganisationalCentreID.
[0489] DateTimePeriods can specify a requested and an acceptable
date, time and period applying to a shipment request (e.g., date
and time of document issue). A requested period can be a period in
which an event is requested to take place. An acceptable period can
be a period in which an event may take place at an earliest start
date/time to a latest end date/time. The elements located directly
at the DateTimePeriods entity include RequestedFulfillmentPeriod,
AcceptableFulfillmentPeriod, and PeriodRoleCode.
RequestedFulfillmentPeriod can be a period which is requested
depending on the semantics of the PeriodRoleCode.
RequestedFulfillmentPeriod can be based on GDT: DATETIMEPERIOD,
Qualifier: RequestedFulfillment. AcceptableFulfillmentPeriod can be
a period which is acceptable depending on the semantics of the
PeriodRoleCode. AcceptableFulfillmentPeriod can be based on GDT:
DATETIMEPERIOD, Qualifier: AcceptableFulfillment. PeriodRoleCode
can be a coded representation of business semantics of the two
periods defined by the entities RequestedFulfillmentPeriod and
AcceptableFulfillmentPeriod. PeriodRoleCode can be based on GDT:
PeriodRoleCode. In some implementations, RequestedFulfillmentPeriod
and AcceptableFulfillmentPeriod are optional, but in every instance
one of them may be filled.
[0490] NatureOfCargo can indicate a nature of cargo related to a
shipment request (e.g., palletized, containerized, documents). The
structure of NatureOfCargo includes the ClassificationCode element.
ClassificationCode can be a coded representation of a
classification of a nature of cargo. ClassificationCode can be
based on GDT: NatureOfCargoClassificationCode.
[0491] TotalQuantity can specify a total quantity which is related
to a whole shipment request (e.g., total number of equipment, total
number of items). The structure of TotalQuantity includes the
elements Quantity, RoleCode, and TypeCode. Quantity can be a
non-monetary numerical specification of an amount in a unit of
measurement. Quantity can be based on GDT: Quantity. RoleCode can
be a coded representation of a role of a quantity, and can be based
on GDT: QuantityRoleCode. TypeCode can be a coded representation of
a type of quantity that is based on a measurable characteristic of
an object or physical phenomenon. TypeCode can be based on GDT:
QuantityTypeCode. In some implementations, QuantityRoleCode and
QuantityTypeCode are optional, but in every instance one of them
can be filled.
[0492] TotalAmount can specify a cumulated monetary amount related
to a shipment request (e.g., duty amount, insurance amount, total
value). The structure of TotalAmount includes the Amount and
RoleCode elements. Amount can be an amount with a corresponding
currency unit, and can be based on CDT: Amount. RoleCode can be a
coded representation of a role of an amount, and can be based on
GDT: AmountRoleCode.
[0493] TextCollection can be a group of textual information that
relates to a shipment request. The structure of TextCollection
includes the TextCollection element. TextCollection can be based on
GDT: TextCollection.
[0494] BusinessTransactionDocumentReference can specify a business
document reference that is related to a whole shipment request.
BusinessTransactionDocumentReference includes the
DateTimePeriodentity. The structure of
BusinessTransactionDocumentReference includes the following
elements: BusinessTransactionDocumentReference,
BusinessTransactionDocumentRelationshipRoleCode,
BusinessTransactionDocumentRelationshipTypeCode,
TransportationDocumentTypeCode, TransportationDocumentNote, and
TransportationDocumentID. BusinessTransactionDocumentReference can
be a unique reference to other business documents or business
document items that are of significance within each respective
business process. BusinessTransactionDocumentReference can be based
on GDT: BusinessTransactionDocumentReference.
[0495] BusinessTransactionDocumentRelationshipRoleCode can be a
coded representation of a role that a business document or a
business document item has when set against another business
document or business document item with a relationship.
BusinessTransactionDocumentRelationshipRoleCode can be based on
GDT: BusinessTransactionDocumentRelationshipRoleCode.
BusinessTransactionDocumentRelationshipTypeCode can be a coded
representation of a relationship between two business documents or
business document items.
BusinessTransactionDocumentRelationshipTypeCode can be based on
GDT: BusinessTransactionDocumentRelationshipTypeCode.
[0496] TransportationDocumentTypeCode can be a coded representation
of a documentation type. TransportationDocumentTypeCode can be
based on GDT: TransportationDocumentTypeCode.
TransportationDocumentNote can be a short Note on documentation,
and can be based on GDT: SHORT_Note. TransportationDocumentID can
be a unique identifier for a transportation document, and can be
based on GDT: TransportationDocumentID. RelationshipTypeCode and
RelationshipRoleCode are both optional. In some implementations, if
used, both may be filled. Either the combination
BusinessTransactionDocumentReference,
BusinessTransactionDocumentRelationshipRoleCode,
BusinessTransactionDocumentRelationshipTypeCode or
TransportationDocumentTypeCode, TransportationDocumentNote,
TransportationDocumentID may be filled.
[0497] The PartyInformation package includes information regarding
a party of freight order invoicing preparation (e.g., Shipper,
Carrier, Agent). The PartyInformation package includes the Party
entity. Party includes information exchanged, in accordance with
common business understanding, in business documents, about a party
involved in business transactions. This information can be used to
identify the party and the party's address, as well as the party's
contact person and the contact person's address. This
identification can take place using an internal ID, a standardized
ID, or IDs assigned by the parties involved. The Party entity
includes the following entities: Amount, DateTimePeriods,
TransportationDocumentInformation, and
BusinessTransactionDocumentReference.
[0498] The structure of Party includes the elements Party,
RoleCode, and FormattedName. A Party includes information
exchanged, in accordance with common business understanding, in
business documents, about a party involved in business
transactions. This information can be used to identify the party
and the party's address, as well as the party's contact person and
the contact person's address. This identification can take place
using an internal ID, a standardized ID, or IDs assigned by the
parties involved. Party can be based on GDT:
BusinessTransactionDocumentParty. RoleCode can be a coded
representation of a PartyRoleCode which specifies which rights and
obligations the party has regarding a business object and
corresponding processes. In some implementations, a PartyRole is
assigned to exactly one PartyRoleCategory and refines its
semantics. RoleCode can be based on GDT: PartyRoleCode.
FormattedName can be a complete, formatted name of a party, and can
be based on GDT: LONG_Name, Qualifier: PartyFormatted.
[0499] BusinessTransactionDocumentReference can specify a business
document reference that is related to a party.
BusinessTransactionDocumentReference includes the DateTimePeriod
entity. The structure of BusinessTransactionDocumentReference
includes the following elements:
BusinessTransactionDocumentReference,
BusinessTransactionDocumentRelationshipRoleCode,
BusinessTransactionDocumentRelationshipTypeCode,
TransportationDocumentTypeCode, TransportationDocumentNote, and
TransportationDocumentID. BusinessTransactionDocumentReference can
be a unique reference to other business documents or business
document items that are of significance within each respective
business process. BusinessTransactionDocumentReference can be based
on GDT: BusinessTransactionDocumentReference.
[0500] BusinessTransactionDocumentRelationshipRoleCode can be a
coded representation of a role that a business document or a
business document item can have when set against another business
document or business document item with a relationship.
BusinessTransactionDocumentRelationshipRoleCode can be based on
GDT: BusinessTransactionDocumentRelationshipRoleCode.
BusinessTransactionDocumentRelationshipTypeCode can be a coded
representation of a relationship between two business documents or
business document items.
BusinessTransactionDocumentRelationshipTypeCode can be based on
GDT: BusinessTransactionDocumentRelationshipTypeCode.
TransportationDocumentTypeCode can be a coded representation of a
documentation type. TransportationDocumentTypeCode can be based on
GDT: TransportationDocumentTypeCode.
[0501] TransportationDocumentNote can be a short Note on
documentation, and can be based on GDT: SHORT_Note.
TransportationDocumentID can be a unique identifier for a
transportation document, and can be based on GDT:
TransportationDocumentID. RelationshipTypeCode and
RelationshipRoleCode are both optional. In some implementations, if
used, both may be filled. Either the combination
BusinessTransactionDocumentReference,
BusinessTransactionDocumentRelationshipRoleCode,
BusinessTransactionDocumentRelationshipTypeCode or
TransportationDocumentTypeCode, TransportationDocumentNote,
TransportationDocumentID may be filled.
[0502] The TransportationChargesInformation package includes
information regarding transportation charge calculation specific
components related to a FreightOrderInvoicingPreparation. The
TransportationChargesInformation package includes the
TransportationChargesInformation entity. The entity
TransportationChargesInformation can define a relationship between
transportation charges and an origin of these charges. The
TransportationChargesInformation entity includes the
TransportationCharges entity. The structure of
TransportationChargesInformation includes the
TransportationChargesUsageCode element.
TransportationChargesUsageCode can be a coded representation of
usage of the TransportationCharges. The usage can point out if
subsequent information represents a revenue view or cost view on
transportation charges. TransportationChargesUsageCode can be based
on GDT: TransportationChargesUsageCode.
[0503] TransportationCharges can be a summary of determined
transportation charge specific components for a transportation
business case. TransportationCharges includes the following
entities: Location, TextCollection, Currency, ExchangeRate,
PercentElement, DateTimePeriod,
BusinessTransactionDocumentReference, TaxDetail,
PaymentInstruction, CashDiscountTerms, and Element. The structure
of TransportationCharges includes the following elements: ID,
FreightAgreementID, CalculationOriginCode, TariffID, and
CalculationSheetID. ID can be a unique identifier of
TransportationCharges in a ShipmentRequest, and can be based on
GDT: TransportationChargesID. FreightAgreementID can be an
identification of a Freight Agreement which includes and points to
a configuration for a Transportation Charges Calculation.
[0504] FreightAgreementID can be based on GDT: FreightAgreementID.
CalculationOriginCode can be a coded representation of an origin of
a transportation charges calculation. The calculation can be done
automatically based on system configuration. Data for a
calculation, including results, can be manually entered or received
from another business system via a message. In some
implementations, there can be a clear distinction of the origin of
TransportationChargesCalculation details such as the
TransportationChargesCalculationSheet and its
TransportationChargeElements. A distinction can give information
whether the calculation was done completely automatically, or if
results were manually adopted. CalculationOriginCode can be based
on GDT: TransportationChargesOriginCode.
[0505] TariffID can be an identifier for a transportation charges
tariff. A transportation charges tariff can be a specific
combination of transportation charges calculation sheet and terms
and conditions. Terms and conditions can define if a certain
transportation charges calculation sheet and its related rates are
applicable for a transportation business case. TariffID can be
based on GDT: TransportationChargesTariffID. CalculationSheetID can
be a unique identifier for a transportation charges calculation
sheet. A TransportationChargesCalculationSheet can represent a
configuration for how to calculate transportation charges for a
transportation business case. A
TransportationChargesCalculationSheet includes instructions
describing which charges are applicable, which data from the
transportation business case can be considered for a calculation,
how the underlying transportation charge rates are determined, and
which special calculation methods may be considered.
CalculationSheetID can be based on GDT:
TransportationChargesCalculationSheetID.
[0506] A ShipmentOrder package can specify or group together the
data related to a Shipment Order which is assigned to a freight
order invoicing preparation. A ShipmentOrder package includes the
ShipmentOrder entity and the Request package. ShipmentOrder can be
an agreement between an ordering party and a transportation service
provider on the shipment of goods from a single shipper to a single
consignee in accordance with agreed terms and conditions. The
structure of ShipmentOrder includes the ID element. ID can be a
unique identifier of a ShipmentOrder, and can be based on GDT:
BusinessTransactionDocumentID.
[0507] The Request package can group a Request with its packages.
The Request package includes the Request entity and the following
packages: HeaderInformation, PartyInformation, LocationInformation,
TransportationStageInformation,
TransportationUnitResourceInformation, PackageInformation,
TransportationChargesInformation, and Item. In some
implementations, the Request package is filled for all of the
shipment orders which are assigned to a freight order invoicing
preparation. Request can be an agreement between a transportation
service provider and an ordering party on the transportation of
goods from a single ship-from party to a single ship-to party in
accordance with agreed terms and conditions. The elements located
directly at the Request entity include DeliveryTerms. DeliveryTerms
can be a collection of conditions and agreements that apply when
delivering ordered goods and providing services and activities.
DeliveryTerms can be based on GDT: DeliveryTerms.
[0508] The HeaderInformation package can group dates, total values,
document and references related to a shipment order. The
HeaderInformation package includes the following entities:
DateTimePeriods, NatureOfCargo, TotalQuantity, TotalAmount,
TextCollection, TransportationServiceRequirement, and
BusinessTransactionDocumentReference.
[0509] DateTimePeriods can specify a requested and an acceptable
date, time and period applying to a shipment request (e.g., date
and time of document issue). A requested period can be a period in
which an event is requested to take place. An acceptable period can
be a period in which an event may take place at an earliest start
date/time to a latest end date/time. The elements located directly
at the DateTimePeriods entity include RequestedFulfillmentPeriod,
AcceptableFulfillmentPeriod, and PeriodRoleCode.
RequestedFulfillmentPeriod can be a period which is requested
depending on semantics of the PeriodRoleCode.
RequestedFulfillmentPeriod can be based on GDT: DATETIMEPERIOD,
Qualifier: RequestedFulfillment. AcceptableFulfillmentPeriod can be
a period which is acceptable depending on semantics of the
PeriodRoleCode. AcceptableFulfillmentPeriod can be based on GDT:
DATETIMEPERIOD, Qualifier: AcceptableFulfillment. PeriodRoleCode
can be a coded representation of business semantics of the two
periods defined by the entities RequestedFulfillmentPeriod and
AcceptableFulfillmentPeriod. PeriodRoleCode can be based on GDT:
PeriodRoleCode. In some implementations, RequestedFulfillmentPeriod
and AcceptableFulfillmentPeriod are optional, but in every instance
one of them may be filled.
[0510] NatureOfCargo can indicate a nature of cargo related to a
shipment request (e.g., palletized, containerized, documents). The
structure of NatureOfCargo includes the element ClassificationCode.
ClassificationCode can be a coded representation of a
classification of a nature of cargo. ClassificationCode can be
based on GDT: NatureOfCargoClassificationCode.
[0511] TotalQuantity can specify a total quantity which is related
to a whole shipment request (e.g., total number of equipment, total
number of items). The structure of TotalQuantity includes the
following elements: Quantity, RoleCode, and TypeCode. Quantity can
be a non-monetary numerical specification of an amount in a unit of
measurement. Quantity can be based on GDT: Quantity. RoleCode can
be a coded representation of a role of a quantity, and can be based
on GDT: QuantityRoleCode. TypeCode can be a coded representation of
a type of quantity that is based on a measurable characteristic of
an object or physical phenomenon. TypeCode can be based on GDT:
QuantityTypeCode. In some implementations, QuantityRoleCode and
QuantityTypeCode are optional, but in every instance one of them
may be filled.
[0512] TotalAmount can specify a cumulated monetary amount related
to a shipment request (e.g., duty amount, insurance amount, total
value). The structure of TotalAmount includes the elements Amount
and RoleCode. Amount can be an amount with a corresponding currency
unit, and can be based on CDT: Amount. RoleCode can be a coded
representation of a role of an amount, and can be based on GDT:
AmountRoleCode.
[0513] TextCollection can be a group of textual information that
relates to a shipment request. TextCollection includes the element
TextCollection. TextCollection can be based on GDT:
TextCollection.
[0514] TransportationServiceRequirement can specify a contract and
carriage condition and service and priority requirements for a
transport which apply to a whole shipment request. The structure of
TransportationServiceRequirement includes the following elements:
TransportationServiceRequirementCode,
AdditionalTransportationServiceRequirementCode,
TransportationContractConditionCode, TransportServiceLevelCode, and
NatureOfCargoClassificationCode.
TransportationServiceRequirementCode can be a coded representation
of a requirement related to a transportation service, and can be
based on GDT: TransportationServiceRequirementCode.
AdditionalTransportationServiceRequirementCode can be a coded
representation of an additional requirement related to a
transportation service, and can be based on GDT:
TransportationServiceRequirementCode, Qualifier: Additional.
TransportationContractConditionCode can be a coded representation
of a contract and carriage condition, and can be based on GDT:
TransportationContractConditionCode.
[0515] TransportServiceLevelCode can be a coded representation of
agreed or defined services in terms of the delivery of goods with
respect to the speed of the delivery. TransportServiceLevelCode can
be based on GDT: TransportServiceLevelCode.
NatureOfCargoClassificationCode can be a coded representation of a
classification of a nature of cargo.
NatureOfCargoClassificationCode can be based on GDT:
NatureOfCargoClassificationCode.
BusinessTransactionDocumentReference can specify a business
document reference that is related to a whole shipment request.
BusinessTransactionDocumentReference includes the DateTimePeriod
entity. The structure of BusinessTransactionDocumentReference
includes the following elements:
BusinessTransactionDocumentReference,
BusinessTransactionDocumentRelationshipRoleCode,
BusinessTransactionDocumentRelationshipTypeCode,
TransportationDocumentTypeCode, TransportationDocumentNote, and
TransportationDocumentID. BusinessTransactionDocumentReference can
be a unique reference to other business documents or business
document items that are of significance within each respective
business process. BusinessTransactionDocumentReference can be based
on GDT: BusinessTransactionDocumentReference.
[0516] BusinessTransactionDocumentRelationshipRoleCode can be a
coded representation of a role that a business document or a
business document item can have when set against another business
document or business document item with a relationship.
BusinessTransactionDocumentRelationshipRoleCode can be based on
GDT: BusinessTransactionDocumentRelationshipRoleCode.
BusinessTransactionDocumentRelationshipTypeCode can be a coded
representation of a relationship between two business documents or
business document items.
BusinessTransactionDocumentRelationshipTypeCode can be based on
GDT: BusinessTransactionDocumentRelationshipTypeCode.
[0517] TransportationDocumentTypeCode can be a coded representation
of a type of a documentation. TransportationDocumentTypeCode can be
based on GDT: TransportationDocumentTypeCode.
TransportationDocumentNote can be a short Note on documentation,
and can be based on GDT: SHORT_Note. TransportationDocumentID can
be a unique identifier for a transportation document, and can be
based on GDT: TransportationDocumentID. RelationshipTypeCode and
RelationshipRoleCode are both optional. In some implementations, if
used, both may be filled. Either the combination
BusinessTransactionDocumentReference,
BusinessTransactionDocumentRelationshipRoleCode,
BusinessTransactionDocumentRelationshipTypeCode or
TransportationDocumentTypeCode, TransportationDocumentNote,
TransportationDocumentID may be filled.
[0518] The PartyInformation package includes information regarding
a party of a shipment request (e.g., Shipper, Carrier, Agent). The
PartyInformation package includes the Party entity. Party includes
information exchanged, in accordance with common business
understanding, in business documents, about a party involved in
business transactions. This information can be used to identify the
party and the party's address, as well as the party's contact
person and the contact person's address. This identification can
take place using an internal ID, a standardized ID, or IDs assigned
by the parties involved. The Party entity includes the following
entities: Amount, DateTimePeriods,
TransportationDocumentInformation, and
BusinessTransactionDocumentReference.
[0519] The structure of the Party entity includes the Party,
RoleCode, and FormattedName elements. A Party includes information
exchanged, in accordance with common business understanding, in
business documents, about a party involved in business
transactions. This information can be used to identify the party
and the party's address, as well as the party's contact person and
the contact person's address. This identification can take place
using an internal ID, a standardized ID, or IDs assigned by the
parties involved. Party can be based on GDT:
BusinessTransactionDocumentParty. RoleCode can be a coded
representation of a PartyRoleCode which specifies which rights and
obligations the party has regarding a business object and
corresponding processes. In some implementations, a PartyRole is
assigned to exactly one PartyRoleCategory and refines its
semantics. RoleCode can be based on GDT: PartyRoleCode.
FormattedName can be a complete, formatted name of a party, and can
be based on GDT: LONG_Name, Qualifier: PartyFormatted.
[0520] BusinessTransactionDocumentReference can specify a business
document reference that is related to a whole shipment request.
BusinessTransactionDocumentReference includes the DateTimePeriod
entity. The structure of BusinessTransactionDocumentReference
includes the following elements:
BusinessTransactionDocumentReference,
BusinessTransactionDocumentRelationshipRoleCode,
BusinessTransactionDocumentRelationshipTypeCode,
TransportationDocumentTypeCode, TransportationDocumentNote, and
TransportationDocumentID. BusinessTransactionDocumentReference can
be a unique reference to other business documents or business
document items that are of significance within each respective
business process. BusinessTransactionDocumentReference can be based
on GDT: BusinessTransactionDocumentReference.
[0521] BusinessTransactionDocumentRelationshipRoleCode can be a
coded representation of a role that a business document or a
business document item can have when set against another business
document or business document item with a relationship.
BusinessTransactionDocumentRelationshipRoleCode can be based on
GDT: BusinessTransactionDocumentRelationshipRoleCode.
BusinessTransactionDocumentRelationshipTypeCode can be a coded
representation of a relationship between two business documents or
business document items.
BusinessTransactionDocumentRelationshipTypeCode can be based on
GDT: BusinessTransactionDocumentRelationshipTypeCode.
TransportationDocumentTypeCode can be a coded representation of a
documentation type.
[0522] TransportationDocumentTypeCode can be based on GDT:
TransportationDocumentTypeCode. TransportationDocumentNote can be a
short Note on documentation, and can be based on GDT: SHORT_Note.
TransportationDocumentID can be a unique identifier for a
transportation document, and can be based on GDT:
TransportationDocumentID. RelationshipTypeCode and
RelationshipRoleCode are both optional. In some implementations, if
used, both maybe filled. Either the combination
BusinessTransactionDocumentReference,
BusinessTransactionDocumentRelationshipRoleCode,
BusinessTransactionDocumentRelationshipTypeCode or
TransportationDocumentTypeCode, TransportationDocumentNote,
TransportationDocumentID may be filled.
[0523] The LocationInformation package includes information
regarding a location of the shipment order (e.g., Ship-from
location). The LocationInformation package includes the Location
entity. Location can specify a physical place that a shipment
request refers as relevant for the processing of the shipment
request. The LocationInformation package includes the
DateTimePeriods entity. The structure of Location includes the
elements Location, RoleCode, TypeCode, and Name. Location includes
information exchanged in business documents about a location
relevant for business transactions. Location can be based on GDT:
BusinessTransactionDocumentLocation. RoleCode can be a coded
representation of a LocationRole, and can be based on GDT:
LocationRoleCode. TypeCode can be a coded representation of a type
of a physical location. TypeCode can be based on GDT:
LocationTypeCode. Name can be a name of a location, and can be
based on GDT: MEDIUM_Name, Qualifier: Location.
[0524] The TransportationStageInformation package includes
information regarding a transportation stage of a shipment order. A
transportation stage can represent a section of a transport. The
TransportationStageInformation package includes the
TransportationStage entity. TransportationStage can specify details
related to a stage of a transport which is part of a shipment
order. TransportationStage includes the following entities:
Location, BusinessTransactionDocumentReference, and
TransportationServiceRequirement. The structure of
TransportationStage includes the following elements: ID,
OrdinalNumberValue, TypeCode, JourneyID, TransportModeCode,
TransportMeansDescriptionCode, TransportMeansDescription,
TransportMeansID, TransportMeansHomeCountryCode, TransportMeans
OwnershipTypeCode, CarrierStandardID, CarrierFormattedName,
TransportationTransitDirectionCode, CalculatedDistanceMeasure, and
GivenDistanceMeasure.
[0525] ID can be a unique identifier of a stage in a shipment
request, and can be based on GDT: TransportationStageID.
OrdinalNumberValue can be an ordinal number to indicate a position
of a transportation stage in a set of transportation stages.
OrdinalNumberValue can be based on GDT: OrdinalNumberValue,
Qualifier: TransportationStage. TypeCode can be a coded
representation of a type of a TransportationStage, and can be based
on GDT: TransportationStageTypeCode. JourneyID can be an identifier
of a Journey, and can be based on GDT: JourneyID. TransportModeCode
can be a coded representation of a mode of transportation used for
delivery, and can be based on GDT: TransportModeCode.
TransportMeansDescriptionCode can be a coded representation of a
transport means type with which goods or persons are to be
transported. TransportMeansDescriptionCode can be based on GDT:
TransportMeansDescriptionCode. TransportMeansDescription can be a
description of a means of transport, and can be based on GDT:
SHORT_Description, Qualifier: TransportMeans. TransportMeansID can
be a unique identifier of a means of transport, and can be based on
GDT: TransportMeansID.
[0526] TransportMeansHomeCountryCode can be a coded representation
of the home country of a transport means.
TransportMeansHomeCountryCode can be based on GDT: CountryCode,
Qualifier: TransportMeansHome. TransportMeansOwnershipTypeCode can
be a coded representation of the type of ownership for a means of
transport, and can be based on GDT:
TransportMeansOwnershipTypeCode. CarrierStandardID can be a
standard identifier of a carrier, and can be based on GDT:
PartyStandardID. CarrierFormattedName can be a name of a carrier,
and can be based on GDT: LONG_Name, Qualifier: PartyFormatted.
TransportationTransitDirectionCode can be a coded representation
for a transportation transit direction.
TransportationTransitDirectionCode can be based on GDT:
TransportationTransitDirectionCode. CalculatedDistanceMeasure can
be a calculated distance measure, and can be based on GDT: Measure,
Qualifier: CalculatedDistance. GivenDistanceMeasure can be a given
distance measure, and can be based on GDT: Measure, Qualifier:
GivenDistance.
[0527] StageLocation can specify a physical place related to a
stage. StageLocation includes the DateTimePeriods entity. The
structure of StageLocation includes the elements Location,
RoleCode, TypeCode, and Name. Location includes information
exchanged in business documents about a location relevant for
business transactions. Location can be based on GDT:
BusinessTransactionDocumentLocation. RoleCode can be a coded
representation of a LocationRole, and can be based on GDT:
LocationRoleCode. TypeCode can be a coded representation of a type
of a physical location, and can be based on GDT: LocationTypeCode.
Name can be a name of a location, and can be based on GDT:
MEDIUM_Name, Qualifier: Location.
[0528] BusinessTransactionDocumentReference can specify a business
document reference that is related to a Stage.
BusinessTransactionDocumentReference includes the DateTimePeriod
entity. The structure of BusinessTransactionDocumentReference
includes the following elements:
BusinessTransactionDocumentReference,
BusinessTransactionDocumentRelationshipRoleCode,
BusinessTransactionDocumentRelationshipTypeCode,
TransportationDocumentTypeCode, TransportationDocumentNote, and
TransportationDocumentID. BusinessTransactionDocumentReference can
be a unique reference to other business documents or business
document items that are of significance within each respective
business process. BusinessTransactionDocumentReference can be based
on GDT: BusinessTransactionDocumentReference.
[0529] BusinessTransactionDocumentRelationshipRoleCode can be a
coded representation of a role that a business document or a
business document item can have when set against another business
document or business document item with a relationship.
BusinessTransactionDocumentRelationshipRoleCode can be based on
GDT: BusinessTransactionDocumentRelationshipRoleCode.
BusinessTransactionDocumentRelationshipTypeCode can be a coded
representation of a relationship between two business documents or
business document items.
BusinessTransactionDocumentRelationshipTypeCode can be based on
GDT: BusinessTransactionDocumentRelationshipTypeCode.
TransportationDocumentTypeCode can be a coded representation of a
documentation type.
[0530] TransportationDocumentTypeCode can be based on GDT:
TransportationDocumentTypeCode. TransportationDocumentNote can be a
short Note on documentation, and can be based on GDT: SHORT_Note.
TransportationDocumentID can be a unique identifier for a
transportation document, and can be based on GDT:
TransportationDocumentID. RelationshipTypeCode and
RelationshipRoleCode are both optional. In some implementations, if
used, both may be filled. Either the combination
BusinessTransactionDocumentReference,
BusinessTransactionDocumentRelationshipRoleCode,
BusinessTransactionDocumentRelationshipTypeCode or
TransportationDocumentTypeCode, TransportationDocumentNote,
TransportationDocumentID may be filled.
[0531] TransportationServiceRequirement can specify a contract and
carriage condition and service and priority requirements related to
a stage. The structure of TransportationServiceRequirement includes
the following elements: TransportationServiceRequirementCode,
AdditionalTransportationServiceRequirementCode,
TransportationContractConditionCode, TransportServiceLevelCode, and
NatureOfCargoClassificationCode.
TransportationServiceRequirementCode can be a coded representation
of a requirement related to a transportation service, and can be
based on GDT: TransportationServiceRequirementCode.
[0532] AdditionalTransportationServiceRequirementCode can be a
coded representation of an additional requirement related to a
transportation service, and can be based on GDT:
TransportationServiceRequirementCode, Qualifier: Additional.
TransportationContractConditionCode can be a coded representation
of a contract and carriage condition, and can be based on GDT:
TransportationContractConditionCode. TransportServiceLevelCode can
be a coded representation of agreed or defined services in terms of
the delivery of goods with respect to the speed of the delivery.
TransportServiceLevelCode can be based on GDT:
TransportServiceLevelCode. NatureOfCargoClassificationCode can be a
coded representation of a classification of a nature of cargo, and
can be based on GDT: NatureOfCargoClassificationCode.
[0533] The TransportationUnitResourceInformation package includes
information regarding a transportation unit resource that is
relevant for a shipment order (e.g., a container). The
TransportationUnitResourceInformation package includes the
TransportationUnitResourceInformation entity.
TransportationUnitResourceInformation can include information on
one or more transportation unit resources, such as a resource type
and related properties, or related measures, or handling
instructions. A Transportation Unit Resource can be a unit into
which goods are loaded and/or from which goods are unloaded. In
some implementations, this unit can provide transportation capacity
for goods but may or ay not move by itself.
TransportationUnitResourceInformation includes the following
entities: TransportationStageAssignment, AttachedEquipment,
Quantity, Seal, BusinessTransactionDocumentReference, Location, and
Dangerous Goods.
[0534] The structure of TransportationUnitResourceInformation
includes the following elements: ID, ResourceNumberValue,
ResourceID, ResourceHomeCountryCode,
TransportationUnitResourceCategoryCode,
TransportationUnitResourceTypeCode, FillLevelCode,
ShippingTypeCode, HaulageArrangerCode,
TransportationHandlingInstructionCode, and
TransportationHandlingInstructionNote. ID can be a unique
identifier for a resource information, and can be based on GDT
ResourceInformationID. ResourceNumberValue can be a count of
resources, and can be based on GDT: NumberValue, Qualifier:
Resource. ResourceID can be a unique identifier for a resource, and
can be based on GDT: ResourceID.
[0535] ResourceHomeCountryCode can be a coded representation of the
home country of a resource, and can be based on GDT: CountryCode,
Qualifier: ResourceHome. TransportationUnitResourceCategoryCode can
be a coded representation of a category of transportation unit
resources, and can be based on GDT:
TransportationUnitResourceCategoryCode.
TransportationUnitResourceTypeCode can be a coded representation of
a type of a transportation unit resource, and can be based on GDT:
TransportationUnitResourceTypeCode. FillLevelCode can be a coded
representation of a fill level of a resource, and can be based on
GDT: FillLevelCode. ShippingTypeCode can be a coded representation
of a shipping type. A shipping type can specify how planning and
execution of a transportation can be performed.
[0536] Transportation terms include detailed specifications on
agreed means of transportation, such as shipping or transport type
and means of transport to be used. ShippingTypeCode can be based on
GDT: ShippingTypeCode. HaulageArrangerCode can be a coded
representation of an arranger of a haulage. Haulage can be an
inland transport of cargo. HaulageArrangerCode can be based on GDT:
HaulageArrangerCode. TransportationHandlingInstructionCode can be a
coded representation of a type of a transportation handling
instruction, and can be based on GDT:
TransportationHandlingInstructionCode.
TransportationHandlingInstructionNote can be a note regarding a
transportation handling instruction, and can be based on GDT:
LONG_Note, Qualifier: TransportationHandlingInstruction.
[0537] TransportationStageAssignment can specify an assignment of a
transportation stage to a transportation unit resource information.
The structure of the TransportationStageAssignment includes the
ShipmentOrderTransportationStageID element.
ShipmentOrderTransportationStageID can be a unique identifier of a
TransportationStage in a shipment request, and can be based on GDT:
TransportationStageID.
[0538] AttachedEquipment can specify equipment attached to a
TransportationUnitResource. The structure of AttachedEquipment
includes the element ShipmentOrderResourceInformationID.
ShipmentOrderResourceInformationID can be a unique identifier of a
resource information in a Shipment Order, and can be based on GDT:
ResourceInformationID.
[0539] Quantity can specify a quantity related to
TransportationUnitResourceInformation. The structure of the
Quantity entity includes the Quantity, RoleCode and TypeCode
elements. Quantity can be a non-monetary numerical specification of
an amount in a unit of measurement, and can be based on GDT:
Quantity. RoleCode can be a coded representation of a role of a
quantity, and can be based on GDT: QuantityRoleCode. TypeCode can
be a coded representation of a type of quantity that is based on a
measurable characteristic of an object or physical phenomenon, and
can be based on GDT: QuantityTypeCode. In some implementations,
QuantityRoleCode and QuantityTypeCode are optional, but in every
instance one of them may be filled.
[0540] Seal can specify a seal related to a
TransportationUnitResource. The structure of Seal includes the
following elements: ID, PartyRoleCode, PartyFormattedName, and
StatusCode. ID can be a unique identifier of a seal, and can be
based on GDT: SealID. PartyRoleCode can be a coded representation
of a party role, and can be based on GDT: PartyRoleCode.
PartyFormattedName can be a complete, formatted name of a party, or
the name of a SealingParty. PartyFormattedName can be based on GDT:
LONG_Name, Qualifier: PartyFormatted. StatusCode can be a coded
representation of a status of a seal, and can be based on GDT:
SealStatusCode.
[0541] BusinessTransactionDocumentReference can specify a business
document reference that is related to a Stage.
BusinessTransactionDocumentReference includes the DateTimePeriod
entity. The structure of BusinessTransactionDocumentReference
includes the following elements:
BusinessTransactionDocumentReference,
BusinessTransactionDocumentRelationshipRoleCode,
BusinessTransactionDocumentRelationshipTypeCode,
TransportationDocumentTypeCode, TransportationDocumentNote, and
TransportationDocumentID. BusinessTransactionDocumentReference can
be a unique reference to other business documents or business
document items that are of significance within each respective
business process. BusinessTransactionDocumentReference can be based
on GDT: BusinessTransactionDocumentReference.
[0542] BusinessTransactionDocumentRelationshipRoleCode can be a
coded representation of a role that a business document or a
business document item can have when set against another business
document or business document item with a relationship.
BusinessTransactionDocumentRelationshipRoleCode can be based on
GDT: BusinessTransactionDocumentRelationshipRoleCode.
BusinessTransactionDocumentRelationshipTypeCode can be a coded
representation of a relationship between two business documents or
business document items.
BusinessTransactionDocumentRelationshipTypeCode can be based on
GDT: BusinessTransactionDocumentRelationshipTypeCode.
TransportationDocumentTypeCode can be a coded representation of a
documentation type.
[0543] TransportationDocumentTypeCode can be based on GDT:
[0544] TransportationDocumentTypeCode. TransportationDocumentNote
can be a short Note on documentation, and can be based on GDT:
SHORT_Note. TransportationDocumentID can be a unique identifier for
a transportation document, and can be based on GDT:
TransportationDocumentID. RelationshipTypeCode and
RelationshipRoleCode are both optional. In some implementations, if
used, both may be filled. Either the combination
BusinessTransactionDocumentReference,
BusinessTransactionDocumentRelationshipRoleCode,
BusinessTransactionDocumentRelationshipTypeCode or
TransportationDocumentTypeCode, TransportationDocumentNote,
TransportationDocumentID may be filled.
[0545] Location can specify a physical place related to the
TransportationUnitResource. The structure of Location includes the
following elements: Location, RoleCode, TypeCode, and Name.
Location includes information exchanged in business documents about
a location relevant for business transactions. Location can be
based on GDT: BusinessTransactionDocumentLocation. RoleCode can be
a coded representation of a LocationRole, and can be based on GDT:
LocationRoleCode. TypeCode can be a coded representation of a type
of a physical location. TypeCode can be based on GDT:
LocationTypeCode. Name can be a name of a location, and can be
based on GDT: MEDIUM_Name, Qualifier: Location.
[0546] DangerousGoods can specify dangerous goods included in a
resource. DangerousGoods includes the ContactInformation and
TextCollection entities. The structure of DangerousGoods includes
the following elements: ID, RegulationsCode, HazardCode,
FlashpointMeasureInterval, PackagingGroupCode, EmergencySchedule,
TransportEmergencyCardCode, DangerousGoodsLabelCode,
DangerousGoodsLabelCode2, DangerousGoodsLabelCode3,
PackagingInstructionTypeCode, TransportMeansDescriptionCode, and
TransportAuthorisationCode. ID can be a unique identifier for a
dangerous good, using the United Nations Dangerous Goods Number. ID
can be based on GDT: DangerousGoodsID. RegulationsCode can be a
coded representation of national or international dangerous goods
rules or regulations, and can be based on GDT:
DangerousGoodsRegulationsCode.
[0547] HazardCode can be a coded representation of a hazard that is
imminent in a dangerous good, and can be based on GDT:
DangerousGoodsHazardCode. FlashpointMeasureInterval can be an
interval of measures defined by a lower and an upper boundary
indicating a flashpoint of a dangerous good, and can be based on
GDT: MeasureInterval, Qualifier: Flashpoint. PackagingGroupCode can
be a coded representation of the effectiveness of a packaging to
transport dangerous goods depending on a degree of danger of the
goods. PackagingGroupCode can be based on GDT:
DangerousGoodsPackagingGroupCode. EmergencySchedule can be a coded
representation of an emergency schedule for dangerous goods.
EmergencySchedule identifies an emergency schedule. The
DangerousGoodsEmergencySchedule can be used for transports of
dangerous goods by sea similar to the Transport Emergency Card
which is used for transports of dangerous goods by road.
[0548] EmergencySchedule can be based on GDT:
DangerousGoodsEmergencySchedule. TransportEmergencyCardCode can be
a coded representation of a transport emergency card which
specifies how to react in case of an accident, and can be based on
GDT: TransportEmergencyCardCode. DangerousGoodsLabelCode can be a
coded representation of a label for a dangerous good. In some
implementations, DangerousGoodsLabelCode's values are dependant on
the DangerousGoodsRegulationsCode. DangerousGoodsLabelCode can be
based on GDT: DangerousGoodsLabelCode. DangerousGoodsLabelCode2 can
be a coded representation of a label for a dangerous good. In some
implementations, DangerousGoodsLabelCode's values are dependant on
the DangerousGoodsRegulationsCode. DangerousGoodsLabelCode2 can be
based on GDT: DangerousGoodsLabelCode.
[0549] DangerousGoodsLabelCode3 can be a coded representation of a
label for a dangerous good. In some implementations,
DangerousGoodsLabelCode's values are dependant on the
DangerousGoodsRegulationsCode. DangerousGoodsLabelCode3 can be
based on GDT: DangerousGoodsLabelCode. PackagingInstructionTypeCode
can be a coded representation of a packaging instruction. In some
implementations, a packaging instruction is an instruction defining
which packagings may be used to pack a dangerous good.
PackagingInstructionTypeCode can be based on GDT:
PackagingInstructionTypeCode. TransportMeansDescriptionCode can be
a coded representation of a transport means type with which goods
or persons are to be transported, and can be based on GDT:
TransportMeansDescriptionCode. TransportAuthorisationCode can be a
coded representation of an authorisation for a transportation of
dangerous goods. This code can specify an authorisation for the
transportation of a particular dangerous good.
TransportAuthorisationCode can be based on GDT:
DangerousGoodsTransportAuthorisationCode.
[0550] The PackageInformation package can describe package
information related to a whole shipment order. The
PackageInformation package includes the ItemAssignment,
TransportationUnitResourceInformationAssignment, and Quantity
entities.
[0551] The structure of PackageInformation includes the following
elements: ID, PackageID, PackageOrdinalNumberValue,
PackageNumberValue, PackageTypeCode, PackagingLevelCode,
PackageMarkingInstructionCode, and PredecessorPackageID. ID can be
a unique identifier for a package information, and can be based on
GDT: PackageInformationID. PackageID can be a unique identifier of
a package used in this packaging, and can be based on GDT:
PackageID. PackageOrdinalNumberValue can be an ordinal number
indicating a position of a package in a set of packages. In a
transportation document, the position of a package is one that has
been specified at shipping time. PackageOrdinalNumberValue can be
based on GDT: OrdinalNumberValue, Qualifier: Package.
[0552] PackageNumberValue can be a count of the number of packages
used in a packaging, and can be based on GDT: NumberValue,
Qualifier: Package. PackageTypeCode can be a coded representation
of a type of a package, and can be based on GDT: PackageTypeCode.
PackagingLevelCode can be a coded representation of a packaging
level. A packaging level can specify a rank of packaging in a
packaging hierarchy. PackagingLevelCode can be based on GDT:
PackagingLevelCode. PackageMarkingInstructionCode can be a coded
representation of a marking instruction of a package, and can be
based on GDT: PackageMarkingInstructionCode. PredecessorPackageID
can be a unique identification of a related package, and can be
based on GDT: PackageID. In some implementations,
PredecessorPackageID may be filled in case a PackageID is
available.
[0553] ItemAssignment can specify an assignment of a packaging to
an item with corresponding information on quantities.
ItemAssignment includes the Quantity entity. The structure of
ItemAssignment includes the element ShipmentOrderItemID
ShipmentOrderItemID can be a unique identifier of an item of a
ShipmentOrder, and can be based on GDT:
BusinessTransactionDocumentItemID.
[0554] Quantity can specify a quantity related to an assignment of
a packaging to an item. The structure of the Quantity entity
includes the following elements: Quantity, RoleCode, and TypeCode.
Quantity can be a non-monetary numerical specification of an amount
in a unit of measurement. Quantity can be based on GDT: Quantity.
RoleCode can be a coded representation of a role of a quantity, and
can be based on GDT: QuantityRoleCode. TypeCode can be a coded
representation of a type of quantity that is based on a measurable
characteristic of an object or physical phenomenon. TypeCode can be
based on GDT: QuantityTypeCode. In some implementations,
QuantityRoleCode and QuantityTypeCode are optional, but in every
instance one of them may be filled.
[0555] TransportationUnitResourceInformationAssignment can specify
an assignment of a packaging to a
TransportationUnitResourceInformation with corresponding quantity
information. The structure of
TransportationUnitResourceInformationAssignment includes the
element ShipmentOrderResourceInformationID.
ShipmentOrderResourceInformationID can be a unique identifier of a
TransportationUnitResourceInformation in a shipment order.
ShipmentOrderResourceInformationID can be based on GDT:
ResourceInformationID.
[0556] Quantity can specify a quantity related to a
TransportationUnitResourceAssignment. The structure of the Quantity
entity includes the Quantity, RoleCode, and TypeCode elements.
Quantity can be a non-monetary numerical specification of an amount
in a unit of measurement. Quantity can be based on GDT: Quantity.
RoleCode can be a coded representation of a role of a quantity, and
can be based on GDT: QuantityRoleCode. TypeCode can be a coded
representation of a type of quantity that is based on a measurable
characteristic of an object or physical phenomenon. TypeCode can be
based on GDT: QuantityTypeCode. In some implementations,
QuantityRoleCode and QuantityTypeCode are optional, but in every
instance one of them can be filled.
[0557] The TransportationChargesInformation package includes
information regarding transportation charge calculation specific
components related to a ShipmentOrder. The
TransportationChargesInformation package includes the
TransportationChargesInformation entity. The
TransportationChargesInformation entity can define a relationship
between transportation charges and an origin of these charges. The
TransportationChargesInformation entity includes the
TransportationCharges entity. The structure of
TransportationChargesInformation includes the following elements:
TransportationChargesUsageCode, ShipmentOrderItemID,
ShipmentOrderResourceInformationID,
ShipmentOrderPackageInformationID, and
ShipmentOrderTransportationStageID. TransportationChargesUsageCode
can be a coded representation of a usage of
TransportationCharges.
[0558] A usage can point out if subsequent information represents a
revenue- or cost-view on transportation charges.
TransportationChargesUsageCode can be based on GDT:
TransportationChargesUsageCode. ShipmentOrderItemID can be a unique
identifier of an Item in a ShipmentOrder, and can be based on GDT:
BusinessTransactionDocumentItemID
ShipmentOrderResourceInformationID can be a unique identification
of a TransportationUnitResource in a ShipmentOrder, and can be
based on GDT: ResourceInformationID.
ShipmentOrderPackageInformationID can be a unique identification of
a PackageInformation in a ShipmentOrder, and can be based on GDT:
PackageInformationID. ShipmentOrderTransportationStageID can be a
unique identification of a TransportationStage in a ShipmentOrder,
and can be based on GDT: TransportationStageID. In some
implementations, if none of the identifiers is maintained,
transportation charges are related to a whole shipment order.
[0559] TransportationCharges can be a summary of determined
transportation charge specific components for a transportation
business case. TransportationCharges includes the following
entities: Location, TextCollection, Currency, ExchangeRate,
PercentElement, DateTimePeriod,
BusinessTransactionDocumentReference, TaxDetail,
PaymentInstruction, CashDiscountTerms, and Element. The structure
of TransportationCharges includes the following elements: ID,
FreightAgreementID, CalculationOriginCode, TariffID, and
CalculationSheetID. ID can be a unique identifier of
TransportationCharges in a ShipmentRequest, and can be based on
GDT: TransportationChargesID. FreightAgreementID can be an
identification of a Freight Agreement which includes and points to
a configuration for a Transportation Charges Calculation.
[0560] FreightAgreementID can be based on GDT: FreightAgreementID.
CalculationOriginCode can be a coded representation of an origin of
a transportation charges calculation. A calculation can be done
automatically based on a system configuration. All necessary data
for a calculation, including results, can be manually entered or
received from another business system via a message. In some
implementations, there may be a clear distinction of an origin of
TransportationChargesCalculation details like a
TransportationChargesCalculationSheet and its
TransportationChargeElements. A distinction can give information
whether a calculation was done completely automatically, or if
results were manually adopted. CalculationOriginCode can be based
on GDT: TransportationChargesOriginCode. TariffID can be an
identifier for a transportation charges tariff.
[0561] A transportation charges tariff can be a specific
combination of transportation charges calculation sheet and terms
and conditions. Terms and conditions can define if a certain
transportation charges calculation sheet and its related rates are
applicable for a transportation business case. TariffID can be
based on GDT: TransportationChargesTariffID. CalculationSheetID can
be a unique Identifier for a transportation charges calculation
sheet. A TransportationChargesCalculationSheet can represent a
configuration to calculate transportation charges for a
transportation business case. A
TransportationChargesCalculationSheet includes instructions
describing which charges are applicable, which data from a
transportation business case may be considered for a calculation,
how the underlying transportation charge rates are determined, and
which special calculation methods may be considered.
CalculationSheetID can be based on GDT:
TransportationChargesCalculationSheetID.
[0562] The Item package includes information regarding products
included in a shipment order and additional information on these
products. The Item package includes the Item entity and the
following packages: ItemInformation, LocationInformation, and
TransportGoodsInformation. Item can specify products included in a
shipment request and additional information about these products.
The structure of Item includes the following elements: ID,
OriginCountryCode, DestinationCountryCode, ShippingTypeCode,
HaulageArrangerCode, TemperatureMeasureInterval,
TransportationHandlingInstructionCode, and
TransportationHandlingInstructionNote. ID can be a unique
identifier of an Item in a shipment request, and can be based on
GDT: BusinessTransactionDocumentItemID OriginCountryCode can be a
country of origin of goods that are considered in a shipment
request.
[0563] OriginCountryCode can be based on GDT: CountryCode,
Qualifier: Origin. DestinationCountryCode can be the ultimate
country of destination of goods that are considered in a shipment
request. DestinationCountryCode can be based on GDT: CountryCode,
Qualifier: Destination. ShippingTypeCode can be a coded
representation of a shipping type. A shipping type can specify how
planning and execution of a transportation can be performed.
Transportation terms include detailed specifications on agreed
means of transportation, such as shipping or transport type and
means of transport to be used. ShippingTypeCode can be based on
GDT: ShippingTypeCode. HaulageArrangerCode can be a coded
representation of an arranger of a haulage. Haulage can be inland
transportation of cargo.
[0564] HaulageArrangerCode can be based on GDT:
HaulageArrangerCode. TemperatureMeasureInterval can be an interval
of temperature measures defined by a lower and an upper boundary
and a measure type code. TemperatureMeasureInterval can be based on
GDT: MeasureInterval, Qualifier: Temperature.
TransportationHandlingInstructionCode can be a coded representation
of a transportation handling instruction.
TransportationHandlingInstructionCode can be based on GDT:
TransportationHandlingInstructionCode.
TransportationHandlingInstructionNote can be a note regarding a
transportation handling instruction, and can be based on GDT:
TransportationHandlingInstructionNote. In some implementations, for
a measure related to a temperature, the units of measurement
Celsius and Fahrenheit are allowed.
[0565] The ItemInformation package can specify products included in
a shipment order and additional information related to the
transportation of these products. The ItemInformation package
includes the following entities: Amount, TextCollection,
NatureOfCargo, Quantity, BusinessTransactionDocumentReference,
DangerousGoods, TransportationStageAssignment, and
TransportationUnitResourceInformationAssignment.
[0566] An Amount can specify a monetary amount associated with an
item, such as a declared value, or insured value. The structure of
the Amount entity includes the Amount and RoleCode elements. Amount
can be an amount with a corresponding currency unit, and can be
based on CDT: Amount. RoleCode can be a coded representation of a
role of an amount, and can be based on GDT: AmountRoleCode.
[0567] TextCollection can be a group of textual information that
relates to an item. The structure of the TextCollection entity
includes the element TextCollection. TextCollection can be based on
GDT: TextCollection. NatureOfCargo can indicate a nature of cargo
related to an item (e.g., palletized, containerized, documents).
The structure of NatureOfCargo includes the element
ClassificationCode. ClassificationCode can be a coded
representation of a classification of a nature of cargo.
ClassificationCode can be based on GDT:
NatureOfCargoClassificationCode.
[0568] Quantity can specify a quantity related to an item. The
structure of the Quantity entity includes the elements Quantity,
RoleCode, and TypeCode. Quantity can be a non-monetary numerical
specification of an amount in a unit of measurement. Quantity can
be based on GDT: Quantity. RoleCode can be a coded representation
of a role of a quantity, and can be based on GDT: QuantityRoleCode.
TypeCode can be a coded representation of a type of quantity that
is based on a measurable characteristic of an object or physical
phenomenon. TypeCode can be based on GDT: QuantityTypeCode.
[0569] In some implementations, QuantityRoleCode and
QuantityTypeCode are optional, but in every instance one of them
may be filled. BusinessTransactionDocumentReference can specify a
business document reference that is related to an item.
BusinessTransactionDocumentReference includes the DateTimePeriod
entity. The structure of BusinessTransactionDocumentReference
includes the following elements:
BusinessTransactionDocumentReference,
BusinessTransactionDocumentRelationshipRoleCode,
BusinessTransactionDocumentRelationshipTypeCode,
TransportationDocumentTypeCode, TransportationDocumentNote, and
TransportationDocumentID. BusinessTransactionDocumentReference can
be a unique reference to other business documents or business
document items that are of significance within each respective
business process. BusinessTransactionDocumentReference can be based
on GDT: BusinessTransactionDocumentReference.
[0570] BusinessTransactionDocumentRelationshipRoleCode can be a
coded representation of a role that a business document or a
business document item can have when set against another business
document or business document item with a relationship.
BusinessTransactionDocumentRelationshipRoleCode can be based on
GDT: BusinessTransactionDocumentRelationshipRoleCode.
BusinessTransactionDocumentRelationshipTypeCode can be a coded
representation of a relationship between two business documents or
business document items.
BusinessTransactionDocumentRelationshipTypeCode can be based on
GDT: BusinessTransactionDocumentRelationshipTypeCode.
[0571] TransportationDocumentTypeCode can be a coded representation
of the type of a documentation. TransportationDocumentTypeCode can
be based on GDT: TransportationDocumentTypeCode.
TransportationDocumentNote can be a short Note on documentation,
and can be based on GDT: SHORT_Note. TransportationDocumentID can
be a unique identifier for a transportation document, and can be
based on GDT: TransportationDocumentID. RelationshipTypeCode and
RelationshipRoleCode are both optional. In some implementations, if
used, both can be filled. Either the combination
BusinessTransactionDocumentReference,
BusinessTransactionDocumentRelationshipRoleCode,
BusinessTransactionDocumentRelationshipTypeCode or
TransportationDocumentTypeCode, TransportationDocumentNote,
TransportationDocumentID may be filled.
[0572] DangerousGoods can specify the identification, description
and classification of dangerous goods related to an item.
DangerousGoods includes the following entities: Quantity,
TextCollection, and
TransportationUnitResourceInformationAssignment.
[0573] Quantity can specify a quantity of DangerousGoods. The
structure of Quantity includes the following elements: Quantity,
RoleCode, and TypeCode. Quantity can be a non-monetary numerical
specification of an amount in a unit of measurement. Quantity can
be based on GDT: Quantity. RoleCode can be a coded representation
of a role of a quantity, and can be based on GDT: QuantityRoleCode.
TypeCode can be a coded representation of a type of quantity that
is based on a measurable characteristic of an object or physical
phenomenon. TypeCode can be based on GDT: QuantityTypeCode. In some
implementations, QuantityRoleCode and QuantityTypeCode are
optional, but in every instance one of them can be filled.
[0574] TextCollection can be a group of textual information that
relates to ItemDangerousGoods. The structure of the TextCollection
entity includes the TextCollection element. TextCollection can be
based on GDT: TextCollection.
[0575] TransportationUnitResourceAssignment can specify an
assignment of dangerous goods of an item to a
TransportationUnitResource with corresponding quantity information.
TransportationUnitResourceAssignment includes the Quantity entity.
The structure of TransportationUnitResourceInformationAssignment
includes the ShipmentOrderResourceInformationID element.
ShipmentOrderResourceInformationID can be a unique identifier of a
TransportationUnitResource. ShipmentOrderResourceInformationID can
be based on GDT: ResourceInformationID.
[0576] Quantity can specify a quantity related to dangerous goods
assigned to a Resource. The structure of the Quantity entity
includes the Quantity, RoleCode, and TypeCode elements. Quantity
can be a non-monetary numerical specification of an amount in a
unit of measurement. Quantity can be based on GDT: Quantity.
RoleCode can be a coded representation of a role of a quantity, and
can be based on GDT: QuantityRoleCode. TypeCode can be a coded
representation of a type of quantity that is based on a measurable
characteristic of an object or physical phenomenon. TypeCode can be
based on GDT: QuantityTypeCode. In some implementations,
QuantityRoleCode and QuantityTypeCode are optional, but in every
instance one of them has to be filled.
[0577] The TransportationStageAssignment can specify the assignment
of an item to a transportation stage with corresponding quantity
information. The structure of TransportationStageAssignment
includes the element ShipmentOrderTransportationStageID.
ShipmentOrderTransportationStageID can be a unique identifier of a
TransportationStage. ShipmentOrderTransportationStageID can be
based on GDT: TransportationStageID.
[0578] The Quantity can specify a quantity related to an item
assigned to a transportation stage. The structure of the Quantity
entity includes the Quantity, RoleCode and TypeCode elements.
Quantity can be a non-monetary numerical specification of an amount
in a unit of measurement. Quantity can be based on GDT: Quantity.
RoleCode can be a coded representation of a role of a quantity, and
can be based on GDT: QuantityRoleCode. TypeCode can be a coded
representation of a type of quantity that is based on a measurable
characteristic of an object or physical phenomenon. TypeCode can be
based on GDT: QuantityTypeCode. In some implementations,
QuantityRoleCode and QuantityTypeCode are optional, but in every
instance one of them can be filled.
[0579] TransportationUnitResourceInformationAssignment can specify
an assignment of an item to a transportation unit resource
information with corresponding quantity information.
TransportationUnitResourceInformationAssignment includes the
Quantity entity. The structure of
TransportationUnitResourceInformationAssignment includes the
ShipmentOrderTransportationUnitResourceID element.
ShipmentOrderTransportationUnitResourceID can be a unique
identifier of a TransportationUnitResource, and can be based on
GDT: ResourceID.
[0580] Quantity can specify a quantity related to an item which is
assigned to a TransportationUnitResource. The structure of the
Quantity entity includes the Quantity, RoleCode and TypeCode
elements. Quantity can be a non-monetary numerical specification of
an amount in a unit of measurement. Quantity can be based on GDT:
Quantity. RoleCode can be a coded representation of a role of a
quantity, and can be based on GDT: QuantityRoleCode. TypeCode can
be a coded representation of a type of quantity that is based on a
measurable characteristic of an object or physical phenomenon.
TypeCode can be based on GDT: QuantityTypeCode. In some
implementations, QuantityRoleCode and QuantityTypeCode are
optional, but in every instance one of them can be filled.
[0581] The ItemLocationInformation package includes information
regarding a location that is related to an item.
ItemLocationInformation includes the Location entity. Location can
specify a physical place which is part of a shipment request item.
Location includes the DateTimePeriods entity. The structure of the
Location entity includes the following elements: Location,
RoleCode, TypeCode, and Name. Location includes information
exchanged in business documents about a location relevant for
business transactions. Location can be based on GDT:
BusinessTransactionDocumentLocation. RoleCode can be a coded
representation of a LocationRole, and can be based on GDT:
LocationRoleCode. TypeCode can be a coded representation of a type
of a physical location. TypeCode can be based on GDT:
LocationTypeCode. Name can be a name of a location, and can be
based on GDT: MEDIUM_Name, Qualifier: Location.
[0582] The TransportationGoodsInformation package can group
information on goods that are to be transported according to an
item. The TransportationGoodsInformation package includes the
ProductInformation and TransportationGoodsIdentification entities.
ProductInformation includes information on a commodity that is the
object of a business activity of a company and serves to generate
value for the company. ProductInformation can be tangible or
intangible. A product can have relationships to other products or
objects. For example, there can be a service for a specially
manufactured product.
[0583] The structure of ProductInformation includes the Product and
ProductDescription elements. Product includes information
exchanged, in accordance with common business understanding, in
business documents, about a product. Product can be based on GDT:
BusinessTransactionDocumentProduct. ProductDescription can be a
natural-language representation of properties of a product.
ProductDescription can be based on GDT: SHORT_Description,
Qualifier: Product. TransportationGoodsIdentification can describe
content identification related to a PackagingItem. The structure of
TransportationGoodsIdentification includes the elements:
TransportationGoodsIdentifierTypeCode,
LowerBoundaryTransportationGoodsID, and
UpperBoundaryTransportationGoodsID.
TransportationGoodsIdentifierTypeCode can be a coded representation
of a type of identifier for transportation goods. Goods can be
movable property, merchandise or wares, to name a few examples.
[0584] Transportation Goods can be goods that are to be
transported. TransportationGoodsIdentifierTypeCode can be based on
GDT: TransportationGoodsIdentifierTypeCode.
LowerBoundaryTransportationGoodsID can be a lower boundary of a
TransportationGoodsID interval. In some implementations,
LowerBoundaryTransportationGoodsID may also be used for intervals
that contain a single value. LowerBoundaryTransportationGoodsID can
be based on GDT: TransportationGoodsID, Qualifier: LowerBoundary.
UpperBoundaryTransportationGoodsID can be an upper boundary of a
TransportationGoodsID interval. UpperBoundaryTransportationGoodsID
can be based on GDT: TransportationGoodsID, Qualifier:
UpperBoundary.
Message Data Type
FreightOrderInvoicingPreparationCancelRequestMessage
[0585] The message data type
FreightOrderInvoicingPreparationCancelRequestMessage can group
together business information relevant for sending a business
document in a message, and the FreightOrderInvoicingPreparation
object in a business document. The message data type
FreightOrderInvoicingPreparationCancelRequestMessage includes the
MessageHeader and FreightOrderInvoicingPreparation packages. The
message data type
FreightOrderInvoicingPreparationCancelRequestMessage can provide a
structure for the message type
FreightOrderInvoicingPreparationCancelRequest and the interfaces
that are based on it.
[0586] A MessageHeader package can group together business
information relevant for sending a business document in a message.
The MessageHeader package includes the MessageHeader entity. A
MessageHeader can group together business information from the
perspective of the sending application to identify a business
document in a message, to provide information about the sender, or
to provide information about the recipient. The MessageHeader can
be divided up into the SenderParty and RecipientParty entities.
MessageHeader can be of type GDT: BusinessDocumentMessageHeader.
The MessageHeader includes the following elements: ID, ReferenceID,
and CreationDateTime. The MessageID can be set by the sending
application. With the ReferencedMessageID, reference can be made in
the current BusinessDocument to a previous BusinessDocument.
[0587] A SenderParty can be a party responsible for sending a
business document at a business application level. The SenderParty
can be of type GDT: BusinessDocumentMessageHeaderParty. The
SenderParty includes the following elements: InternalID,
StandardID, and ContactPerson. The SenderParty can be filled by the
sending application to name a contact person for problems with the
message. A contact person can be useful if an additional
infrastructure, such as a marketplace, is located between the
sender and the recipient. The SenderParty can be used to transfer a
message and can be ignored by the receiving application.
SenderParty can be filled by the sender if the participating
parties are not transferred with the
FreightOrderInvoicingPreparation Package.
[0588] A RecipientParty can be a party responsible for receiving a
business document at a business application level. The
RecipientParty can be of type GDT:
BusinessDocumentMessageHeaderParty. The RecipientParty includes the
following elements: InternalID, StandardID, and ContactPerson. The
RecipientParty can be filled by the sending application to name a
contact person for problems that may occur with the message. A
contact person can be useful if an additional infrastructure, such
as a marketplace, is located between the sender and the recipient.
The RecipientParty can be used to transfer a message and can be
ignored by the receiving application. RecipientParty can be filled
by the sender if the FreightOrderInvoicingPreparation Package
cannot be used to transfer the participating parties.
[0589] The FreightOrderInvoicingPreparation package can group
together information about the FreightOrderInvoicingPreparation.
The FreightOrderInvoicingPreparation package includes the
FreightOrderInvoicingPreparation entity and the
BusinessTransactionDocumentReference package.
[0590] A freight order invoicing preparation can be used in
purchase order processing for preparation of supplier invoicing.
The attributes and elements located directly at the
FreightOrderInvoicingPreparation entity include ID. ID can be a
unique identifier of a FreightOrder, and can be based on GDT:
BusinessTransactionDocumentID.
[0591] The Request package can group a Request with its packages.
The Request package includes the Request entity and the
BusinessTransactionDocumentReference package. The structure of
Request includes the element RequestedCancellationDate.
RequestedCancellationDate can be a requested date for a
cancellation, and can be based on GDT: Date, Qualifier:
Cancellation.
[0592] A BusinessTransactionDocumentReference package can group
references to business documents. A
BusinessTransactionDocumentReference package includes the
BusinessTransactionDocumentReference entity. The structure of
BusinessTransactionDocumentReference includes the following
elements: BusinessTransactionDocumentReference,
BusinessTransactionDocumentRelationshipRoleCode,
BusinessTransactionDocumentRelationshipTypeCode,
TransportationDocumentTypeCode, TransportationDocumentNote, and
TransportationDocumentID. BusinessTransactionDocumentReference can
be a unique reference to other business documents or business
document items that are of significance within each respective
business process. BusinessTransactionDocumentReference can be based
on GDT: BusinessTransactionDocumentReference.
[0593] BusinessTransactionDocumentRelationshipRoleCode can be a
coded representation of a role that a business document or a
business document item can have when set against another business
document or business document item with a relationship.
BusinessTransactionDocumentRelationshipRoleCode can be based on
GDT: BusinessTransactionDocumentRelationshipRoleCode.
BusinessTransactionDocumentRelationshipTypeCode can be a coded
representation of a relationship between two business documents or
business document items.
BusinessTransactionDocumentRelationshipTypeCode can be based on
GDT: BusinessTransactionDocumentRelationshipTypeCode.
TransportationDocumentTypeCode can be a coded representation of a
documentation type, and can be based on GDT:
TransportationDocumentTypeCode. TransportationDocumentNote can be a
short Note on documentation, and can be based on GDT:
SHORT_Note.
[0594] TransportationDocumentID can be a unique identifier for a
transportation document, and can be based on GDT:
TransportationDocumentID. RelationshipTypeCode and
RelationshipRoleCode are both optional. In some implementations, if
used, both may be filled. Either the combination
BusinessTransactionDocumentReference,
BusinessTransactionDocumentRelationshipRoleCode,
BusinessTransactionDocumentRelationshipTypeCode, or
TransportationDocumentTypeCode, TransportationDocumentNote,
TransportationDocumentID may be filled.
Message Data Type
FreightOrderInvoicingPreparationConfirmationMessage
[0595] The message data type
FreightOrderInvoicingPreparationConfirmationMessage includes
business information relevant for sending a business document in a
message and FreightOrderInvoicingPreparation included in a business
document. The message data type
FreightOrderInvoicingPreparationConfirmationMessage can provide a
structure for the message type
FreightOrderInvoicingPreparationConfirmationMessage and for
interfaces that are based on it.
[0596] A MessageHeader package can group together business
information relevant for sending a business document in a message.
The MessageHeader package includes the MessageHeader entity. A
MessageHeader can group together business information from the
perspective of the sending application to identify a business
document in a message, to provide information about the sender, or
to provide information about the recipient. The MessageHeader can
be divided up into the SenderParty and RecipientParty entities.
MessageHeader can be of type GDT: BusinessDocumentMessageHeader.
The MessageHeader includes the following elements: ID, ReferenceID,
and CreationDateTime. The MessageID can be set by the sending
application. With the ReferencedMessageID, reference can be made in
the current BusinessDocument to a previous BusinessDocument.
[0597] A SenderParty can be a party responsible for sending a
business document at a business application level. The SenderParty
can be of type GDT: BusinessDocumentMessageHeaderParty. The
SenderParty includes the following elements: InternalID,
StandardID, and ContactPerson. The SenderParty can be filled by the
sending application to name a contact person for problems with the
message. A contact person can be useful if an additional
infrastructure, such as a marketplace, is located between the
sender and the recipient. The SenderParty can be used to transfer a
message and can be ignored by the receiving application.
SenderParty can be filled by the sender if the participating
parties are not transferred with the
FreightOrderInvoicingPreparation package.
[0598] A RecipientParty can be a party responsible for receiving a
business document at a business application level. The
RecipientParty can be of type GDT:
BusinessDocumentMessageHeaderParty. The RecipientParty includes the
following elements: InternalID, StandardID, and ContactPerson. The
RecipientParty can be filled by the sending application to name a
contact person for problems that may occur with a message. A
contact person can be useful if an additional infrastructure, such
as a marketplace, is located between the sender and the recipient.
The RecipientParty can be used to transfer a message and can be
ignored by the receiving application. RecipientParty can be filled
by the sender if the FreightOrderInvoicingPreparation package
cannot be used to transfer the participating parties. The
FreightOrderInvoicingPreparation package can group the
FreightOrderInvoicingPreparation together with its packages.
[0599] The FreightOrderInvoicingPreparation package includes the
FreightOrderInvoicingPreparation entity and the Confirmation
package. A FreightOrderInvoicingPreparation can be used in purchase
order processing for preparation of supplier invoicing.
[0600] The Confirmation package can be part of a
FreightOrderInvoicingPreparation which confirms
FreightOrderInvoicingPreparation. The Confirmation package includes
the Confirmation entity and the
BusinessTransactionDocumentReference package. A Confirmation can be
part of a FreightOrderInvoicingPreparation which confirms
FreightOrderInvoicingPreparation. The element located directly at
the Confirmation entity include AcceptanceStatusCode. The
AcceptanceStatusCode can be a coded representation of the status of
an acceptance by a communication partner regarding a business
transaction that has been transmitted to that partner.
AcceptanceStatusCode can be based on GDT: Acceptance Status
Code.
[0601] A BusinessTransactionDocumentReference package can group
references to a business transaction documents. A
BusinessTransactionDocumentReference package includes the
BusinessTransactionDocumentReference entity.
BusinessTransactionDocumentReference specifies a business document
reference that is related to a whole shipment request.
BusinessTransactionDocumentReference includes the DateTimePeriod
entity. The structure of BusinessTransactionDocumentReference
includes the following elements:
BusinessTransactionDocumentReference,
BusinessTransactionDocumentRelationshipRoleCode,
BusinessTransactionDocumentRelationshipTypeCode,
TransportationDocumentTypeCode, TransportationDocumentNote, and
TransportationDocumentID. BusinessTransactionDocumentReference can
be a unique reference to other business documents or business
document items that are of significance within each respective
business process. BusinessTransactionDocumentReference can be based
on GDT: BusinessTransactionDocumentReference.
[0602] BusinessTransactionDocumentRelationshipRoleCode can be a
coded representation of a role that a business document or a
business document item can have when set against another business
document or business document item with a relationship.
BusinessTransactionDocumentRelationshipRoleCode can be based on
GDT: BusinessTransactionDocumentRelationshipRoleCode.
BusinessTransactionDocumentRelationshipTypeCode can be a coded
representation of a relationship between two business documents or
business document items.
BusinessTransactionDocumentRelationshipTypeCode can be based on
GDT: BusinessTransactionDocumentRelationshipTypeCode.
[0603] TransportationDocumentTypeCode can be a coded representation
of a documentation type, and can be based on GDT:
TransportationDocumentTypeCode. TransportationDocumentNote can be a
short Note on documentation, and can be based on GDT: SHORT_Note.
TransportationDocumentID can be a unique identifier for a
transportation document, and can be based on GDT:
TransportationDocumentID. RelationshipTypeCode and
RelationshipRoleCode are both optional. In some implementations, if
used, both can be filled. Either the combination
BusinessTransactionDocumentReference,
BusinessTransactionDocumentRelationshipRoleCode,
BusinessTransactionDocumentRelationshipTypeCode, or
TransportationDocumentTypeCode, TransportationDocumentNote,
TransportationDocumentID may be filled.
Maintenance Plan Interfaces
[0604] In order to keep a company up and running from usually
occurring down times or break downs, it can be useful to take
preventive measures by performing regular checks and maintenance.
In order to schedule maintenance and checks at regular intervals,
Maintenance Plans are created for technical objects in the company,
thereby ensuring that technical objects function optimally.
[0605] The Maintenance Plan interface can perform various
operations, namely a
MaintenancePlanERPCreateRequestConfirmation_In, a
MaintenancePlanERPUpdateRequestConfirmation_In, a
MaintenancePlanERPCreateCheckQueryResponse_In a
MaintenancePlanERPUpdateCheckQueryResponse_In, a
MaintenancePlanERPByIDQueryResponse_In, a
MaintenancePlanERPSimpleByElementsQueryResponse_In a
MaintenancePlanERPItemByElementsQueryResponse_In, a
MaintenancePlanERPScheduleLineByIDQueryResponse_In, a
MaintenancePlanERPActivateRequestConfirmation_In, a
MaintenancePlanERPDeactivateRequestConfirmation_In, a
MaintenancePlanERPSetDeleteIndicatorRequestConfirmation_In, and a
MaintenancePlanERPResetDeleteIndicatorRequestConfirmation_In.
[0606] The MaintenancePlanERPCreateRequestConfirmation_In operation
can handle a request to Maintenance Planning to create a
MaintenancePlan and get a confirmation of the same. A Maintenance
Planner can use a `Create Maintenance Plan` inbound operation to
create a MaintenancePlan. The
MaintenancePlanERPCreateRequestConfirmation_In operation includes
various message types, namely a
MaintenancePlanERPCreateRequest_sync and a
MaintenancePlanERPCreateConfirmation_sync. The structure of the
MaintenancePlanERPCreateRequest_sync message type can be specified
by a MaintPlnERPCrteReqMsg_s message data type. The structure of
the MaintenancePlanERPCreateConfirmation_sync message type can be
specified by a MaintPlnERPCrteConfMsg_s message data type.
[0607] The MaintenancePlanERPUpdateRequestConfirmation_In operation
can handle a request to Maintenance Planning to update a
MaintenancePlan and get a confirmation of the same. A Maintenance
Planner can use an `Update MaintenancePlan` inbound operation to
update a MaintenancePlan. The
MaintenancePlanERPUpdateRequestConfirmation_In operation includes
various message types, namely a
MaintenancePlanERPUpdateRequest_sync and a
MaintenancePlanERPUpdateConfirmation_sync. The structure of the
MaintenancePlanERPUpdateRequest_sync message type can be specified
by a MaintPlnERPUpdtReqMsg_s message data type. The structure of
the MaintenancePlanERPUpdateConfirmation_sync message type can be
specified by a MaintPlnERPUpdtConfMsg_s message data type.
[0608] The MaintenancePlanERPCreateCheckQueryResponse_In operation
can handle an inquiry to Maintenance Planning to check the
consistency of the creation of a MaintenancePlan. A Maintenance
Planner can use a `Create Check Maintenance Plan` inbound operation
to check the consistency of the creation of a maintenance plan. The
MaintenancePlanERPCreateCheckQueryResponse_In operation includes
various message types, namely a
MaintenancePlanERPCreateCheckQuery_sync and a
MaintenancePlanERPCreateCheckResponse_sync. The structure of the
MaintenancePlanERPCreateCheckQuery_sync message type can be
specified by a MaintPlnERPCrteCkQryMsg_s message data type. The
structure of the MaintenancePlanERPCreateCheckResponse_sync message
type can be specified by a MaintPlnERPCrteCkRspMsg_s message data
type.
[0609] The MaintenancePlanERPUpdateCheckQueryResponse_In operation
can handle an inquiry to Maintenance Planning to check the
consistency of the update of a MaintenancePlan. A Maintenance
Planner can use an `Update Check Maintenance Plan` inbound
operation to check the consistency of the update of a
MaintenancePlan. The MaintenancePlanERPUpdateCheckQueryResponse_In
operation includes various message types, namely a
MaintenancePlanERPUpdateCheckQuery_sync and a
MaintenancePlanERPUpdateCheckResponse_sync. The structure of the
MaintenancePlanERPUpdateCheckQuery_sync message type can be
specified by a MaintPlnERPUpdtCkQryMsg_s message data type. The
structure of the MaintenancePlanERPUpdateCheckResponse_sync message
type can be specified by a MaintPlnERPUpdtCkRspMsg_s message data
type.
[0610] The MaintenancePlanERPByIDQueryResponse_In operation can
handle an inquiry to Maintenance Planning to read a
MaintenancePlan. A Maintenance Planner can use a `Read Maintenance
Plan` inbound operation to read a MaintenancePlan by using an ID
(identifier).
[0611] The MaintenancePlanERPByIDQueryResponse_In operation
includes various message types, namely a
MaintenancePlanERPByIDQuery_sync and a
MaintenancePlanERPByIDResponse_sync. The structure of the
MaintenancePlanERPByIDQuery_sync message type can be specified by a
MaintPlnERPByIDQryMsg_s message data type. The structure of the
MaintenancePlanERPByIDResponse_sync message type can be specified
by a MaintPlnERPByIDRspMsg_s message data type.
[0612] The MaintenancePlanERPSimpleByElementsQueryResponse_In
operation can handle an inquiry to Maintenance Planning to get a
list of MaintenancePlans based on the selection criteria. A
Maintenance Planner can use a `Find Maintenance Plan By Elements`
inbound operation to get a list of MaintenancePlans based on a
selection criteria. The
MaintenancePlanERPSimpleByElementsQueryResponse_In operation
includes various message types, namely a
MaintenancePlanERPSimpleByElementsQuery_sync and a
MaintenancePlanERPSimpleByElementsResponse_sync The structure of
the MaintenancePlanERPSimpleByElementsQuery_sync message type can
be specified by a MaintPlnERPSimplElmntsQryMsg_s message data type.
The structure of the
MaintenancePlanERPSimpleByElementsResponse_sync message type can be
specified by a MaintPlnERPSimplElmntsRspMsg_s message data
type.
[0613] The MaintenancePlanERPItemByElementsQueryResponse_In
operation can be an inquiry to Maintenance Planning to get a list
of MaintenancePlanItems based on selection criteria. A Maintenance
planner can use a `Find Maintenance Plan Item By Elements` inbound
operation to get a list of Maintenance plan items based on
selection criteria. The
MaintenancePlanERPItemByElementsQueryResponse_In operation includes
various message types, namely a
MaintenancePlanERPItemByElementsQuery_sync and a
MaintenancePlanERPItemByElementsResponse_sync. The structure of the
MaintenancePlanERPItemByElementsQuery_sync message type can be
specified by a MaintPlnERPItmElmntsQryMsg_s message data type. The
structure of the MaintenancePlanERPItemByElementsResponse_sync
message type can be specified by a MaintPlnERPItmElmntsRspMsg_s
message data type.
[0614] The MaintenancePlanERPScheduleLineByIDQueryResponse_In
operation can handle an inquiry to Maintenance Planning to read a
MaintenancePlanSchedule. A Maintenance Planner can use a `Read
Maintenance Plan Schedule` inbound operation to read a
MaintenancePlanSchedule by ID. The
MaintenancePlanERPScheduleLineByIDQueryResponse_In operation
includes various message types, namely a
MaintenancePlanERPScheduleLineByIDQuery_sync and a
MaintenancePlanERPScheduleLineByIDResponse_sync. The structure of
the MaintenancePlanERPScheduleLineByIDQuery_sync message type can
be specified by a MaintPlnERPSchedLineByIDQryMsg_s message data
type. The structure of the
MaintenancePlanERPScheduleLineByIDResponse_sync message type can be
specified by a MaintPlnERPSchedLineByIDRspMsg_s message data
type.
[0615] The MaintenancePlanERPActivateRequestConfirmation_In
operation can be a request to Maintenance Planning to activate a
MaintenancePlan and get a confirmation of the same. A Maintenance
Planner can use the `Activate MaintenancePlan` inbound operation to
activate a MaintenancePlan. The
MaintenancePlanERPActivateRequestConfirmation_In operation includes
various message types, namely a
MaintenancePlanERPActivateRequest_sync and a
MaintenancePlanERPActivateConfirmation_sync. The structure of the
MaintenancePlanERPActivateRequest_sync message type can be
specified by a MaintPlnERPActvteReqMsg_s message data type. The
structure of the MaintenancePlanERPActivateConfirmation_sync
message type can be specified by a MaintPlnERPActvteConfMsg_s
message data type.
[0616] The MaintenancePlanERPDeactivateRequestConfirmation_In
operation can handle a request to Maintenance Planning to
deactivate a MaintenancePlan and get a confirmation of the same. A
Maintenance Planner can use a `Deactivate MaintenancePlan` inbound
operation to deactivate a MaintenancePlan. The
MaintenancePlanERPDeactivateRequestConfirmation_In operation
includes various message types, namely a
MaintenancePlanERPDeactivateRequest_sync and a
MaintenancePlanERPDeactivateConfirmation_sync. The structure of the
MaintenancePlanERPDeactivateRequest_sync message type can be
specified by a MaintPlnERPDactvteReqMsg_s message data type. The
structure of the MaintenancePlanERPDeactivateConfirmation_sync
message type can be specified by a MaintPlnERPDactvteConfMsg_s
message data type.
[0617] The
MaintenancePlanERPSetDeleteIndicatorRequestConfirmation_In
operation can handle a request to Maintenance Planning to set a
deletion flag for a MaintenancePlan and get a confirmation of the
same. A Maintenance Planner can use a `Set Delete Indicator
MaintenancePlan` inbound operation to set a deletion flag for a
MaintenancePlan. The
MaintenancePlanERPSetDeleteIndicatorRequestConfirmation_In
operation includes various message types, namely a
MaintenancePlanERPSetDeleteIndicatorRequest_sync and a
MaintenancePlanERPSetDeleteIndicatorConfirmation_sync. The
structure of the MaintenancePlanERPSetDeleteIndicatorRequest_sync
message type can be specified by a MaintPlnERPSetDelIndReqMsg_s
message data type. The structure of the
MaintenancePlanERPSetDeleteIndicatorConfirmation_sync message type
can be specified by a MaintPlnERPSetDelIndConfMsg_s message data
type.
[0618] The
MaintenancePlanERPResetDeleteIndicatorRequestConfirmation_In
operation can handle a request to Maintenance Planning to reset a
deletion flag for a MaintenancePlan and get the confirmation of the
same. A Maintenance Planner can use a `Reset Delete Indicator
MaintenancePlan` inbound operation to reset a deletion flag for a
MaintenancePlan. The
MaintenancePlanERPResetDeleteIndicatorRequestConfirmation_In
operation includes various message types, namely a
MaintenancePlanERPResetDeleteIndicatorRequest_sync and a
MaintenancePlanERPResetDeleteIndicatorConfirmation_sync. The
structure of the MaintenancePlanERPResetDeleteIndicatorRequest_sync
message type can be specified by a MaintPlnERPRstDelIndReqMsg_s
message data type. The structure of the
MaintenancePlanERPResetDeleteIndicatorConfirmation_sync message
type can be specified by an MaintPlnERPRstDelIndConfMsg_s message
data type.
[0619] The message choreography of FIG. 48 describes a possible
logical sequence of messages that can be used to realize a
Maintenance Plan business scenario.
[0620] A "Maintenance Planner" system 48000 can request the
creation of a maintenance plan, using a
MaintenancePlanERPCreateRequest_sync message 48004 as shown, for
example in FIG. 48. A "Maintenance Planning" system 48002 can
confirm the request, using a
MaintenancePlanERPCreateConfirmation_sync message 48006 as shown,
for example, in FIG. 48.
[0621] The "Maintenance Planner" system 48000 can request an update
of a maintenance plan using a MaintenancePlanERPUpdateRequest
message 48008 as shown, for example, in FIG. 48. The "Maintenance
Planning" system 48002 can confirm the request, using the
MaintenancePlanERPUpdateConfirmation_sync message 48040 as shown,
for example, in FIG. 48.
[0622] The "Maintenance Planner" system 48000 can request the
creation of a maintenance plan item using a
MaintenancePlanItemERPCreateRequest message 48010 as shown, for
example, in FIG. 48. The "Maintenance Planning" system 48002 can
confirm the request, using the
MaintenancePlanItemERPCreateConfirmation_sync message 48042 as
shown, for example, in FIG. 48.
[0623] The "Maintenance Planner" system 48000 can request an update
of a maintenance plan item using a
MaintenancePlanItemERPUpdateRequest message 48012 as shown, for
example, in FIG. 48. The "Maintenance Planning" system 48002 can
confirm the request, using the
MaintenancePlanItemERPUpdateConfirmation_sync message 48044 as
shown, for example, in FIG. 48.
[0624] The "Maintenance Planner" system 48000 can query the
"Maintenance Planning" system 48002 to check the consistency of the
creation of a maintenance plan, using a
MaintenancePlanERPCreateCheckQuery_sync message 48014 as shown, for
example in FIG. 48. The "Maintenance Planning" system 48002 can
respond to the query, using a
MaintenancePlanERPCreateCheckResponse_sync message 48046 as shown,
for example, in FIG. 48.
[0625] The "Maintenance Planner" system 48000 can query the
"Maintenance Planning" system 48002 to check the consistency of the
update of a maintenance plan, using a
MaintenancePlanERPUpdateCheckQuery_sync message 48016 as shown, for
example in FIG. 48. The "Maintenance Planning" system 48002 can
respond to the query, using a
MaintenancePlanERPUpdateCheckResponse_sync message 48048 as shown,
for example, in FIG. 48.
[0626] The "Maintenance Planner" system 48000 can query the
"Maintenance Planning" system 48002 to check the consistency of the
creation of a maintenance plan item using a
MaintenancePlanItemERPCreateCheckQuery_sync message 48018 as shown,
for example, in FIG. 48. The "Maintenance Planning" system 48002
can respond to the query, using the
MaintenancePlanItemERPCreateCheckResponse_sync message 48050 as
shown, for example, in FIG. 48.
[0627] The "Maintenance Planner" system 48000 can query the
"Maintenance Planning" system 48002 to check the consistency of the
update of a maintenance plan item, using a
MaintenancePlanItemERPUpdateCheckQuery_sync message 48020 as shown,
for example in FIG. 48. The "Maintenance Planning" system 48002 can
respond to the query, using a
MaintenancePlanItemERPUpdateCheckResponse_sync message 48052 as
shown, for example, in FIG. 48.
[0628] The "Maintenance Planner" system 48000 can query the
"Maintenance Planning" system 48002 to read a maintenance plan,
using a MaintenancePlanERPReadQuery_sync message 48022 as shown,
for example in FIG. 48. The "Maintenance Planning" system 48002 can
respond to the query, using a MaintenancePlanERPReadResponse_sync
message 48054 as shown, for example, in FIG. 48.
[0629] The "Maintenance Planner" system 48000 can query the
"Maintenance Planning" system 48002 to get a list of maintenance
plans based on selection criteria, using a
MaintenancePlanERPSimpleByElementsQuery_sync message 48024 as
shown, for example in FIG. 48. The "Maintenance Planning" system
48002 can respond to the query, using a
MaintenancePlanERPSimpleByElementsResponse_sync message 48056 as
shown, for example, in FIG. 48.
[0630] The "Maintenance Planner" system 48000 can query the
"Maintenance Planning" system 48002 to read a maintenance plan
item, using a MaintenancePlanItemERPReadQuery_sync message 48026 as
shown, for example in FIG. 48. The "Maintenance Planning" system
48002 can respond to the query, using a
MaintenancePlanItemERPReadResponse_sync message 48058 as shown, for
example, in FIG. 48.
[0631] The "Maintenance Planner" system 48000 can query the
"Maintenance Planning" system 48002 to get a list of maintenance
plan items based on selection criteria, using a
MaintenancePlanItemERPSimpleByElementsQuery_sync message 48028 as
shown, for example in FIG. 48. The "Maintenance Planning" system
48002 can respond to the query, using a
MaintenancePlanItemERPSimpleByElementsResponse_sync message 48060
as shown, for example, in FIG. 48.
[0632] The "Maintenance Planner" system 48000 can query the
"Maintenance Planning" system 48002 to read a maintenance plan
schedule, using a MaintenancePlanScheduleERPReadQuery_sync message
48030 as shown, for example in FIG. 48. The "Maintenance Planning"
system 48002 can respond to the query, using a
MaintenancePlanScheduleERPReadResponse_sync message 48062 as shown,
for example, in FIG. 48.
[0633] The "Maintenance Planner" system 48000 can request the
activation of a maintenance plan, using a
MaintenancePlanERPActivateRequest_sync message 48032 as shown, for
example in FIG. 48. A "Maintenance Planning" system 48002 can
confirm the request, using a
MaintenancePlanERPActivateConfirmation_sync message 48064 as shown,
for example, in FIG. 48.
[0634] The "Maintenance Planner" system 48000 can request the
deactivation of a maintenance plan, using a
MaintenancePlanERPDeactivateRequest_sync message 48034 as shown,
for example in FIG. 48. A "Maintenance Planning" system 48002 can
confirm the request, using a
MaintenancePlanERPDeactivateConfirmation_sync message 48066 as
shown, for example, in FIG. 48.
[0635] The "Maintenance Planner" system 48000 can request the
"Maintenance Planning" system 48002 to set a deletion flag for a
maintenance plan, using a
MaintenancePlanERPSetDeletionIndicatorRequest_sync message 48036 as
shown, for example in FIG. 48. A "Maintenance Planning" system
48002 can confirm the request, using a
MaintenancePlanERPSetDeletionConfirmation_sync message 48068 as
shown, for example, in FIG. 48.
[0636] The "Maintenance Planner" system 48000 can request the
"Maintenance Planning" system 48002 to reset a deletion flag for a
maintenance plan, using a
MaintenancePlanERPResetDeletionIndicatorRequest_sync message 48038
as shown, for example in FIG. 48. A "Maintenance Planning" system
48002 can confirm the request, using a
MaintenancePlanERPResetDeletionConfirmation_sync message 48070 as
shown, for example, in FIG. 48.
[0637] FIG. 49 illustrates one example logical configuration of
MaintPInERPCrteReqMsg_s message 49000. Specifically, this figure
depicts the arrangement and hierarchy of various components such as
one or more levels of packages, entities, and datatypes, shown here
as 49002 through 49026. As described above, packages may be used to
represent hierarchy levels. Entities are discrete business elements
that are used during a business transaction. Data types are used to
type object entities and interfaces with a structure. For example,
MaintPInERPCrteReqMsg_s message 49000 includes, among other things,
SchedulingTerms 49016. Accordingly, heterogeneous applications may
communicate using this consistent message configured as such.
[0638] Additionally, FIG. 50 illustrates one example logical
configuration of MaintPInERPCrteConfMsg_s message 50000.
Specifically, this figure depicts the arrangement and hierarchy of
various components such as one or more levels of packages,
entities, and datatypes, shown here as 50002 through 50014. As
described above, packages may be used to represent hierarchy
levels. Entities are discrete business elements that are used
during a business transaction. Data types are used to type object
entities and interfaces with a structure. For example,
MaintPlnERPCrteConfMsg_s message 50000 includes, among other
things, MaintenancePlan 50012. Accordingly, heterogeneous
applications may communicate using this consistent message
configured as such.
[0639] Additionally, FIG. 51 illustrates one example logical
configuration of MaintPInERPActvteReqMgs_s message 51000.
Specifically, this figure depicts the arrangement and hierarchy of
various components such as one or more levels of packages,
entities, and datatypes, shown here as 51002 through 51008. As
described above, packages may be used to represent hierarchy
levels. Entities are discrete business elements that are used
during a business transaction. Data types are used to type object
entities and interfaces with a structure. For example,
MaintPInERPActvteReqMgs_s message 51000 includes, among other
things, MaintenancePlan 51004. Accordingly, heterogeneous
applications may communicate using this consistent message
configured as such.
[0640] Additionally, FIG. 52 illustrates one example logical
configuration of MaintPlnERPActvteConfMsg_s message 52000.
Specifically, this figure depicts the arrangement and hierarchy of
various components such as one or more levels of packages,
entities, and datatypes, shown here as 52002 through 52010. As
described above, packages may be used to represent hierarchy
levels. Entities are discrete business elements that are used
during a business transaction. Data types are used to type object
entities and interfaces with a structure. For example,
MaintPlnERPActvteConfMsg_s message 52000 includes, among other
things, Log 52004. Accordingly, heterogeneous applications may
communicate using this consistent message configured as such.
[0641] Additionally, FIG. 53 illustrates one example logical
configuration of MaintPInERPDactvteReqMsg_s message 53000.
Specifically, this figure depicts the arrangement and hierarchy of
various components such as one or more levels of packages,
entities, and datatypes, shown here as 53002 through 53008. As
described above, packages may be used to represent hierarchy
levels. Entities are discrete business elements that are used
during a business transaction. Data types are used to type object
entities and interfaces with a structure. For example,
MaintPInERPDactvteReqMsg_s message 53000 includes, among other
things, MaintenancePlan 53004. Accordingly, heterogeneous
applications may communicate using this consistent message
configured as such.
[0642] Additionally, FIG. 54 illustrates one example logical
configuration of MaintPInERPDactvteConfMsg_s message 54000.
Specifically, this figure depicts the arrangement and hierarchy of
various components such as one or more levels of packages,
entities, and datatypes, shown here as 54002 through 54010. As
described above, packages may be used to represent hierarchy
levels. Entities are discrete business elements that are used
during a business transaction. Data types are used to type object
entities and interfaces with a structure. For example,
MaintPlnERPDactvteConfMsg_s message 54000 includes, among other
things, Log 54006. Accordingly, heterogeneous applications may
communicate using this consistent message configured as such.
[0643] Additionally, FIG. 55 illustrates one example logical
configuration of MaintPInERPSetDelIndReqMsg_s message 55000.
Specifically, this figure depicts the arrangement and hierarchy of
various components such as one or more levels of packages,
entities, and datatypes, shown here as 55002 through 55008. As
described above, packages may be used to represent hierarchy
levels. Entities are discrete business elements that are used
during a business transaction. Data types are used to type object
entities and interfaces with a structure. For example,
MaintPInERPSetDelIndReqMsg_s message 55000 includes, among other
things, MaintenancePlan 55004. Accordingly, heterogeneous
applications may communicate using this consistent message
configured as such.
[0644] Additionally, FIG. 56 illustrates one example logical
configuration of MaintPlnERPSetDelConfMsg_s message 56000.
Specifically, this figure depicts the arrangement and hierarchy of
various components such as one or more levels of packages,
entities, and datatypes, shown here as 56002 through 56010. As
described above, packages may be used to represent hierarchy
levels. Entities are discrete business elements that are used
during a business transaction. Data types are used to type object
entities and interfaces with a structure. For example,
MaintPlnERPSetDelConfMsg_s message 56000 includes, among other
things, Log 56008. Accordingly, heterogeneous applications may
communicate using this consistent message configured as such.
[0645] Additionally, FIG. 57 illustrates one example logical
configuration of MaintPInERPRstDelIndReqMsg_s message 57000.
Specifically, this figure depicts the arrangement and hierarchy of
various components such as one or more levels of packages,
entities, and datatypes, shown here as 57002 through 57008. As
described above, packages may be used to represent hierarchy
levels. Entities are discrete business elements that are used
during a business transaction. Data types are used to type object
entities and interfaces with a structure. For example,
MaintPInERPRstDelIndReqMsg_s message 57000 includes, among other
things, MaintenancePlan 57004. Accordingly, heterogeneous
applications may communicate using this consistent message
configured as such.
[0646] Additionally, FIG. 58 illustrates one example logical
configuration of MaintPlnERPRstDelIndConfMsg_s message 58000.
Specifically, this figure depicts the arrangement and hierarchy of
various components such as one or more levels of packages,
entities, and datatypes, shown here as 58002 through 58010. As
described above, packages may be used to represent hierarchy
levels. Entities are discrete business elements that are used
during a business transaction. Data types are used to type object
entities and interfaces with a structure. For example,
MaintPlnERPRstDelIndConfMsg_s message 58000 includes, among other
things, Log 58004. Accordingly, heterogeneous applications may
communicate using this consistent message configured as such.
[0647] Additionally, FIG. 59 illustrates one example logical
configuration of MaintPlnERPSimplElmntsQryMsg_s message 59000.
Specifically, this figure depicts the arrangement and hierarchy of
various components such as one or more levels of packages,
entities, and datatypes, shown here as 59002 through 59010. As
described above, packages may be used to represent hierarchy
levels. Entities are discrete business elements that are used
during a business transaction. Data types are used to type object
entities and interfaces with a structure. For example,
MaintPlnERPSimplElmntsQryMsg_s message 59000 includes, among other
things, ProcessingConditions 59006. Accordingly, heterogeneous
applications may communicate using this consistent message
configured as such.
[0648] Additionally, FIG. 60 illustrates one example logical
configuration of MaintPlnERPSimplElmntsRspMsg_s message 60000.
Specifically, this figure depicts the arrangement and hierarchy of
various components such as one or more levels of packages,
entities, and datatypes, shown here as 60002 through 60014. As
described above, packages may be used to represent hierarchy
levels. Entities are discrete business elements that are used
during a business transaction. Data types are used to type object
entities and interfaces with a structure. For example,
MaintPlnERPSimplElmntsRspMsg_s message 60000 includes, among other
things, MaintenancePlan 60010. Accordingly, heterogeneous
applications may communicate using this consistent message
configured as such.
[0649] Additionally, FIG. 61 illustrates one example logical
configuration of MaintPlnERPUpdtReqMsg_s message 61000.
Specifically, this figure depicts the arrangement and hierarchy of
various components such as one or more levels of packages,
entities, and datatypes, shown here as 61002 through 61026. As
described above, packages may be used to represent hierarchy
levels. Entities are discrete business elements that are used
during a business transaction. Data types are used to type object
entities and interfaces with a structure. For example,
MaintPlnERPUpdtReqMsg_s message 61000 includes, among other things,
SchedulingTerms 61016. Accordingly, heterogeneous applications may
communicate using this consistent message configured as such.
[0650] Additionally, FIG. 62 illustrates one example logical
configuration of MaintPlnERPUpdtConfMsg_s message 62000.
Specifically, this figure depicts the arrangement and hierarchy of
various components such as one or more levels of packages,
entities, and datatypes, shown here as 62002 through 62014. As
described above, packages may be used to represent hierarchy
levels. Entities are discrete business elements that are used
during a business transaction. Data types are used to type object
entities and interfaces with a structure. For example,
MaintPlnERPUpdtConfMsg_s message 62000 includes, among other
things, MaintenancePlan 62012. Accordingly, heterogeneous
applications may communicate using this consistent message
configured as such.
[0651] Additionally, FIG. 63 illustrates one example logical
configuration of MaintPlnERPCrteCkQryMsg_s message 63000.
Specifically, this figure depicts the arrangement and hierarchy of
various components such as one or more levels of packages,
entities, and datatypes, shown here as 63002 through 63022. As
described above, packages may be used to represent hierarchy
levels. Entities are discrete business elements that are used
during a business transaction. Data types are used to type object
entities and interfaces with a structure. For example,
MaintPlnERPCrteCkQryMsg_s message 63000 includes, among other
things, Cycles 63014. Accordingly, heterogeneous applications may
communicate using this consistent message configured as such.
[0652] Additionally, FIG. 64 illustrates one example logical
configuration of MaintPlnERPCrteCkRspMsg_s message 64000.
Specifically, this figure depicts the arrangement and hierarchy of
various components such as one or more levels of packages,
entities, and datatypes, shown here as 64024 through 64038. As
described above, packages may be used to represent hierarchy
levels. Entities are discrete business elements that are used
during a business transaction. Data types are used to type object
entities and interfaces with a structure. For example,
MaintPlnERPCrteCkRspMsg_s message 64000 includes, among other
things, MaintenancePlan 64036. Accordingly, heterogeneous
applications may communicate using this consistent message
configured as such.
[0653] Additionally, FIG. 65 illustrates one example logical
configuration of MaintPlnItmERPSimplElmntsQryMsg_s message 65000.
Specifically, this figure depicts the arrangement and hierarchy of
various components such as one or more levels of packages,
entities, and datatypes, shown here as 65002 through 65010. As
described above, packages may be used to represent hierarchy
levels. Entities are discrete business elements that are used
during a business transaction. Data types are used to type object
entities and interfaces with a structure. For example,
MaintPlnItmERPSimplElmntsQryMsg_s message 65000 includes, among
other things, ProcessingConditions 65004. Accordingly,
heterogeneous applications may communicate using this consistent
message configured as such.
[0654] Additionally, FIG. 66 illustrates one example logical
configuration of MaintPlnItmERPSimplElmntsRspMsg_s message 66000.
Specifically, this figure depicts the arrangement and hierarchy of
various components such as one or more levels of packages,
entities, and datatypes, shown here as 66002 through 66014. As
described above, packages may be used to represent hierarchy
levels. Entities are discrete business elements that are used
during a business transaction. Data types are used to type object
entities and interfaces with a structure. For example,
MaintPlnItmERPSimplElmntsRspMsg_s message 66000 includes, among
other things, MaintenancePlanItem 66010. Accordingly, heterogeneous
applications may communicate using this consistent message
configured as such.
[0655] Additionally, FIG. 67 illustrates one example logical
configuration of MaintPlnERPUpdtCkQryMsg_s message 67000.
Specifically, this figure depicts the arrangement and hierarchy of
various components such as one or more levels of packages,
entities, and datatypes, shown here as 67002 through 67022. As
described above, packages may be used to represent hierarchy
levels. Entities are discrete business elements that are used
during a business transaction. Data types are used to type object
entities and interfaces with a structure. For example,
MaintPlnERPUpdtCkQryMsg_s message 67000 includes, among other
things, ItemCycleGroupAssignment 67022. Accordingly, heterogeneous
applications may communicate using this consistent message
configured as such.
[0656] Additionally, FIG. 68 illustrates one example logical
configuration of MaintPlnERPUpdtCkRspMsg_s message 68000.
Specifically, this figure depicts the arrangement and hierarchy of
various components such as one or more levels of packages,
entities, and datatypes, shown here as 68002 through 68014. As
described above, packages may be used to represent hierarchy
levels. Entities are discrete business elements that are used
during a business transaction. Data types are used to type object
entities and interfaces with a structure. For example,
MaintPlnERPUpdtCkRspMsg_s message 68000 includes, among other
things, Log 68006. Accordingly, heterogeneous applications may
communicate using this consistent message configured as such.
[0657] Additionally, FIG. 69 illustrates one example logical
configuration of MaintPlnERPByIDQryMsg_s message 69000.
Specifically, this figure depicts the arrangement and hierarchy of
various components such as one or more levels of packages,
entities, and datatypes, shown here as 69002 through 69006. As
described above, packages may be used to represent hierarchy
levels. Entities are discrete business elements that are used
during a business transaction. Data types are used to type object
entities and interfaces with a structure. For example,
MaintPlnERPByIDQryMsg_s message 69000 includes, among other things,
MaintenancePlan 69004. Accordingly, heterogeneous applications may
communicate using this consistent message configured as such.
[0658] Additionally, FIG. 70 illustrates one example logical
configuration of MaintPlnERPByIDRspMsg_s message 70000.
Specifically, this figure depicts the arrangement and hierarchy of
various components such as one or more levels of packages,
entities, and datatypes, shown here as 70002 through 70032. As
described above, packages may be used to represent hierarchy
levels. Entities are discrete business elements that are used
during a business transaction. Data types are used to type object
entities and interfaces with a structure. For example,
MaintPlnERPByIDRspMsg_s message 70000 includes, among other things,
SchedulingTerms 70018. Accordingly, heterogeneous applications may
communicate using this consistent message configured as such.
[0659] Additionally, FIG. 71 illustrates one example logical
configuration of MaintPlnSchedERPByIDQryMsg_s message 71000.
Specifically, this figure depicts the arrangement and hierarchy of
various components such as one or more levels of packages,
entities, and datatypes, shown here as 71002 through 71006. As
described above, packages may be used to represent hierarchy
levels. Entities are discrete business elements that are used
during a business transaction. Data types are used to type object
entities and interfaces with a structure. For example,
MaintPlnSchedERPByIDQryMsg_s message 71000 includes, among other
things, MaintenancePlan 71004. Accordingly, heterogeneous
applications may communicate using this consistent message
configured as such.
[0660] Additionally, FIG. 72 illustrates one example logical
configuration of MaintPlnSchedERPByIDRspMsg_s message 72000.
Specifically, this figure depicts the arrangement and hierarchy of
various components such as one or more levels of packages,
entities, and datatypes, shown here as 72002 through 72018. As
described above, packages may be used to represent hierarchy
levels. Entities are discrete business elements that are used
during a business transaction. Data types are used to type object
entities and interfaces with a structure. For example,
MaintPlnSchedERPByIDRspMsg_s message 72000 includes, among other
things, Item 72014. Accordingly, heterogeneous applications may
communicate using this consistent message configured as such.
[0661] FIGS. 73-1 through 73-12 show an example configuration of an
Element Structure that includes a MaintenancePlanMessage_sync 73000
package. The MaintenancePlanMessage_sync 73000 package is a
<MessageDataType> 73002 data type. The
MaintenancePlanMessage_sync 73000 package includes various
packages, namely a MessageHeader 73004, a MaintenancePlan 73010, a
ProcessingConditions 73424 and a Log 73460.
[0662] The MessageHeader 73004 package can be a
BasicBusinessDocumentMessageHeader 73008 data type. The
MessageHeader 73004 package includes a MessageHeader 73006 entity.
A BasicBusinessDocumentMessageHeader can be a collection of
identification data of an instance of a business document message,
or reference data to another instance of a business document
message, or both. The subject of the identification data can be a
message instance that conveys them, whereas the reference data can
be related to a different message instance previously exchanged
between the same interaction parties.
[0663] The MaintenancePlan 73010 package includes a MaintenancePlan
73012 entity. The MaintenancePlan 73012 entity includes various
attributes, namely an ID 73014, a CategoryCode 73020, a TypeCode
73026, a StatusObject 73032, a StartDateTime 73038, a
MeasuringDeviceStartMeasurementReadingMeasure 73042, a Description
73048 and a TextCollection 73054. The MaintenancePlan 73012 entity
includes various subordinate entities, namely a SchedulingTerms
73060, a Cycle 73148, an Item 73194 and a CycleGroup 73402.
[0664] The ID 73014 attribute can be a MaintenancePlanID 73018 data
type. The ID 73014 attribute has a cardinality of 1 73016 meaning
that for each instance of the MaintenancePlan 73012 entity there is
one ID 73014 attribute. A MaintenancePlanID can be a unique
identifier for a maintenance plan. The CategoryCode 73020 attribute
can be a MaintenancePlanCategoryCode 73024 data type. The
CategoryCode 73020 attribute has a cardinality of 1 73022 meaning
that for each instance of the MaintenancePlan 73012 entity there is
one CategoryCode 73020 attribute. A MaintenancePlanCategoryCode can
be a coded representation of a maintenance plan category, and can
determine which maintenance call object the system generates for a
maintenance plan.
[0665] The TypeCode 73026 attribute can be a
MaintenancePlanTypeCode 73030 data type. The TypeCode 73026
attribute has a cardinality of 1 73028 meaning that for each
instance of the MaintenancePlan 73012 entity there is one TypeCode
73026 attribute. The StatusObject 73032 attribute can be a
StatusObject 73036 data type. The StatusObject 73032 attribute has
a cardinality of 0..1 73034 meaning that for each instance of the
MaintenancePlan 73012 entity there may be one StatusObject 73032
attribute. A StatusObject can describe the processing status of a
maintenance plan in a structured form. The StartDateTime 73038
attribute has a cardinality of 0..1 73040 meaning that for each
instance of the MaintenancePlan 73012 entity there may be one
StartDateTime 73038 attribute.
[0666] A CycleStartDateTime can be a date on which the system
starts a maintenance plan. The
MeasuringDeviceStartMeasurementReadingMeasure 73042 attribute can
be a Measure 73046 data type. The
MeasuringDeviceStartMeasurementReadingMeasure 73042 attribute has a
cardinality of 0..1 73044 meaning that for each instance of the
MaintenancePlan 73012 entity there may be one
MeasuringDeviceStartMeasurementReadingMeasure 73042 attribute. A
MeasuringDeviceStartMeasurementReadingMeasure can be a measure from
where the system starts a maintenance plan. The Description 73048
attribute can be a SHORT_Description 73052 data type.
[0667] The Description 73048 attribute has a cardinality of 1 73050
meaning that for each instance of the MaintenancePlan 73012 entity
there is one Description 73048 attribute. A Description can be a
representation of the properties of a maintenance plan in natural
language. The TextCollection 73054 attribute can be a
TextCollection 73058 data type. The TextCollection 73054 attribute
has a cardinality of 0..1 73056 meaning that for each instance of
the MaintenancePlan 73012 entity there may be one TextCollection
73054 attribute. A TextCollection can be a collection of text
descriptions of a business object or a part of a business
object.
[0668] The SchedulingTerms 73060 entity has a cardinality of 0..1
73062 meaning that for each instance of the MaintenancePlan 73012
entity there may be one SchedulingTerms 73060 entity. The
SchedulingTerms 73060 entity includes various attributes, namely a
StartDateTime 73064, a
MeasuringDeviceStartMeasurementReadingMeasure 73070, a
LateCompletionShiftPercent 73076, an EarlyCompletionShiftPercent
73082, a LateCompletionTolerencePercent 73088, an
EarlyCompletionTolerencePercent 73094, a WorkingDayCalendarCode
73100, a MaintenancePlanCycleQuantityModificationFactorValue 73106,
a BufferStartDaysNumberValue 73112, a CallHorizonPercent 73118, a
PredecessorCompletionRequiredIndicator 73124, a SchedulingDuration
73130, a SchedulingCategoryCode 73136 and a
CycleDependencyIndicator 73142.
[0669] The StartDateTime 73064 attribute is a
TIMEZONEINDEPENDENT_DateTime 73068 data type. The StartDateTime
73064 attribute has a cardinality of 0..1 73066 meaning that for
each instance of the SchedulingTerms 73060 entity there may be one
StartDateTime 73064 attribute. A StartDateTime can be a date on
which the system starts a maintenance plan. The
MeasuringDeviceStartMeasurementReadingMeasure 73070 attribute can
be a Measure 73074 data type. The
MeasuringDeviceStartMeasurementReadingMeasure 73070 attribute has a
cardinality of 0..1 73072 meaning that for each instance of the
SchedulingTerms 73060 entity there may be one
MeasuringDeviceStartMeasurementReadingMeasure 73070 attribute.
[0670] A MeasuringDeviceStartMeasurementReadingMeasure can be a
measure from where the system starts a maintenance plan. The
LateCompletionShiftPercent 73076 attribute can be a Percent 73080
data type. The LateCompletionShiftPercent 73076 attribute has a
cardinality of 0..1 73078 meaning that for each instance of the
SchedulingTerms 73060 entity there may be one
LateCompletionShiftPercent 73076 attribute. A
LateCompletionShiftPercent can be a percentage of a shift to be
applied to a calculation of a next date in an event of late
completion. The EarlyCompletionShiftPercent 73082 attribute can be
a Percent 73086 data type.
[0671] The EarlyCompletionShiftPercent 73082 attribute has a
cardinality of 0..1 73084 meaning that for each instance of the
SchedulingTerms 73060 entity there may be one
EarlyCompletionShiftPercent 73082 attribute. An
EarlyCompletionShiftPercent can be a percentage of a shift to be
applied to a calculation of a next date in an event of early
completion. The LateCompletionTolerencePercent 73088 attribute can
be a Percent 73092 data type. The LateCompletionTolerencePercent
73088 attribute has a cardinality of 0..1 73090 meaning that for
each instance of the SchedulingTerms 73060 entity there may be one
LateCompletionTolerencePercent 73088 attribute. A
LateCompletionTolerencePercent can be a percentage rate of the
smallest interval between maintenance cycles which determines a
time span in which positive variances between actual and planned
dates do not influence subsequent scheduling. The
EarlyCompletionTolerencePercent 73094 attribute can be a Percent
73098 data type.
[0672] The EarlyCompletionTolerencePercent 73094 attribute has a
cardinality of 0..1 73096 meaning that for each instance of the
SchedulingTerms 73060 entity there may be one
EarlyCompletionTolerencePercent 73094 attribute. A
LateCompletionTolerencePercent can be a percentage rate of the
smallest interval between maintenance cycles which determines a
time span in which negative variances between actual and planned
dates do not influence subsequent planning. The
WorkingDayCalendarCode 73100 attribute can be a
WorkingDayCalendarCode 73104 data type. The WorkingDayCalendarCode
73100 attribute has a cardinality of 0..1 73102 meaning that for
each instance of the SchedulingTerms 73060 entity there may be one
WorkingDayCalendarCode 73100 attribute. A WorkingDayCalendarCode
can be a coded representation of a working day calendar.
[0673] The MaintenancePlanCycleQuantityModificationFactorValue
73106 attribute can be a
MaintenancePlanCycleQuantityModificationFactorValue 73110 data
type. The MaintenancePlanCycleQuantityModificationFactorValue 73106
attribute has a cardinality of 0..1 73108 meaning that for each
instance of the SchedulingTerms 73060 entity there may be one
MaintenancePlanCycleQuantityModificationFactorValue 73106
attribute. A MaintenancePlanCycleModificationValue can be a
multiplication factor number that changes the cycle times of
maintenance plan. The BufferStartDaysNumberValue 73112 attribute
can be a NumberValue 73116 data type. The
BufferStartDaysNumberValue 73112 attribute has a cardinality of
0..1 73114 meaning that for each instance of the SchedulingTerms
73060 entity there may be one BufferStartDaysNumberValue 73112
attribute.
[0674] A BufferStartDaysNumberValue can be the number of days
specified as a preliminary buffer for a maintenance call object
start date. The CallHorizonPercent 73118 attribute can be a Percent
73122 data type. The CallHorizonPercent 73118 attribute has a
cardinality of 0..1 73120 meaning that for each instance of the
SchedulingTerms 73060 entity there may be one CallHorizonPercent
73118 attribute. A CallHorizonPercent can be a percentage value
which determines when a maintenance call object may be generated
for a maintenance plan. The PredecessorCompletionRequiredIndicator
73124 attribute can be an Indicator 73128 data type. The
PredecessorCompletionRequiredIndicator 73124 attribute has a
cardinality of 0..1 73126 meaning that for each instance of the
SchedulingTerms 73060 entity there may be one
PredecessorCompletionRequiredIndicator 73124 attribute.
[0675] A PredecessorCompletionRequiredIndicator can be an indicator
to generate the next maintenance call object after the completion
of a predecessor. The SchedulingDuration 73130 attribute can be a
Duration 73134 data type. The SchedulingDuration 73130 attribute
has a cardinality of 0..1 73132 meaning that for each instance of
the SchedulingTerms 73060 entity there may be one
SchedulingDuration 73130 attribute. SchedulingDuration can be a
length of time for which the system creates maintenance calls
during maintenance plan scheduling. The SchedulingCategoryCode
73136 attribute can be a MaintenancePlanSchedulingTypeCode 73140
data type.
[0676] The SchedulingCategoryCode 73136 attribute has a cardinality
of 0..1 73138 meaning that for each instance of the SchedulingTerms
73060 entity there may be one SchedulingCategoryCode 73136
attribute. A SchedulingCategoryCode can be an indicator for
identification of specific time-based or counter-based maintenance.
The CycleDependencylndicator 73142 attribute can be an Indicator
73146 data type. The CycleDependencylndicator 73142 attribute has a
cardinality of 0..1 73144 meaning that for each instance of the
SchedulingTerms 73060 entity there may be one
CycleDependencylndicator 73142 attribute. An
CycleDependencylndicator can be an indicator for defining a
relationship between maintenance cycles.
[0677] The Cycle 73148 entity has a cardinality of 0..N 73150
meaning that for each instance of the MaintenancePlan 73012 entity
there may be one or more Cycle 73148 entities. The Cycle 73148
entity includes various attributes, namely a CounterValue 73152, a
GroupSequenceNumberValue 73158, a
GroupSequenceRepetitionNumberValue 73164, a Quantity 73170, a
StartOffsetQuantity 73176, a MeasuringDeviceID 73182 and a
Description 73188. The CounterValue 73152 attribute can be a
CounterValue 73156 data type.
[0678] The CounterValue 73152 attribute has a cardinality of 1
73154 meaning that for each instance of the Cycle 73148 entity
there is one CounterValue 73152 attribute. A MaintenancePlanCycleID
can be a unique identifier for a maintenance plan cycle. The
GroupSequenceNumberValue 73158 attribute can be a NumberValue 73162
data type. The GroupSequenceNumberValue 73158 attribute has a
cardinality of 1 73160 meaning that for each instance of the Cycle
73148 entity there is one GroupSequenceNumberValue 73158 attribute.
A MaintenancePlanCycleGroupSequenceNumberValue can be a value to
determine a maintenance cycle group.
[0679] The GroupSequenceRepetitionNumberValue 73164 attribute can
be a NumberValue 73168 data type. The
GroupSequenceRepetitionNumberValue 73164 attribute has a
cardinality of 0..N 73166 meaning that for each instance of the
Cycle 73148 entity there may be one or more
GroupSequenceRepetitionNumberValue 73164 attributes. A
GroupSequenceRepetitionNumberValue can be a value to determine how
often in a sequence a cycle set is used to calculate a date, before
the system changes to the next cycle set.
[0680] The Quantity 73170 attribute can be a Quantity 73174 data
type. The Quantity 73170 attribute has a cardinality of 1 73172
meaning that for each instance of the Cycle 73148 entity there is
one Quantity 73170 attribute. A maintenance plan cycle quantity can
be a quantity after which a maintenance task is due to be
performed. The StartOffsetQuantity 73176 attribute can be a
Quantity 73180 data type. The StartOffsetQuantity 73176 attribute
has a cardinality of 0..1 73178 meaning that for each instance of
the Cycle 73148 entity there may be one StartOffsetQuantity 73176
attribute. A StartOffsetQuantity can be a quantity using which the
first due task is determined The MeasuringDeviceID 73182 attribute
can be a MeasuringDeviceID 73186 data type.
[0681] The MeasuringDeviceID 73182 attribute has a cardinality of
0..N 73184 meaning that for each instance of the Cycle 73148 entity
there may be one or more MeasuringDeviceID 73182 attributes. A
MeasuringDeviceID can be a unique identifier for a measuring
device. The Description 73188 attribute can be a SHORT_Description
73192 data type. The Description 73188 attribute has a cardinality
of 0..1 73190 meaning that for each instance of the Cycle 73148
entity there may be one Description 73188 attribute. A Description
can be a representation of properties of a maintenance plan cycle
in natural language.
[0682] The Item 73194 entity has a cardinality of 0..N 73196
meaning that for each instance of the MaintenancePlan 73012 entity
there may be one or more Item 73194 entities. The Item 73194 entity
includes various attributes, namely an ID 73198, a CategoryCode
73204, a CycleGroupSequenceNumberValue 73210, a Description 73216,
a BusinessTransactionDocumentProcessingTypeCode 73222, a
MaintenancePlannerGroupCode 73228, an ImportanceCode 73234, a
MaintenanceTaskListID 73240, a MaintenanceTaskListGroupID 73246, a
MaintenanceTaskListTypeCode 73252, a BusinessTransactionDocumentID
73258, a WorkCentreDescription 73264, a StatusObject 73270, a
MaintenancePlanningPlantID 73276, a WorkCentreID 73282, a
WorkCentrePlantID 73288, a MaintenancePlantDescription 73294, a
MaintenanceWorkCenterDescription 73300 and a TextCollection
73306.
[0683] The Item 73194 entity includes various subordinate entities,
namely an ObjectReference 73312 and a ScheduleLine 73376. The ID
73198 attribute can be a MaintenancePlanItemID 73202 data type. The
ID 73198 attribute has a cardinality of 1 73200 meaning that for
each instance of the Item 73194 entity there is one ID 73198
attribute. A MaintenancePlanItemID can be a unique identifier for a
maintenance plan item. The CategoryCode 73204 attribute can be a
MaintenancePlanCategoryCode 73208 data type. The CategoryCode 73204
attribute has a cardinality of 1 73206 meaning that for each
instance of the Item 73194 entity there is one CategoryCode 73204
attribute. A MaintenancePlanCategoryCode can be a coded
representation of a maintenance plan category that determines which
maintenance call object the system generates for a maintenance
plan. The CycleGroupSequenceNumberValue 73210 attribute can be a
NumberValue 73214 data type.
[0684] The CycleGroupSequenceNumberValue 73210 attribute has a
cardinality of 1 73212 meaning that for each instance of the Item
73194 entity there is one CycleGroupSequenceNumberValue 73210
attribute. A MaintenancePlanCycleGroupSequenceNumberValue can be a
value to determine a maintenance cycle group. The Description 73216
attribute can be a SHORT_Description 73220 data type. The
Description 73216 attribute has a cardinality of 0..1 73218 meaning
that for each instance of the Item 73194 entity there may be one
Description 73216 attribute. A Description can be a representation
of properties of a maintenance plan item in natural language.
[0685] The BusinessTransactionDocumentProcessingTypeCode 73222
attribute can be a BusinessTransactionDocumentProcessingTypeCode
73226 data type. The BusinessTransactionDocumentProcessingTypeCode
73222 attribute has a cardinality of 1 73224 meaning that for each
instance of the Item 73194 entity there is one
BusinessTransactionDocumentProcessingTypeCode 73222 attribute. A
BusinessTransactionDocumentProcessingTypeCode can be a coded
representation of a type of a MaintenanceOrder. The
MaintenancePlannerGroupCode 73228 attribute can be a
MaintenancePlannerGroupCode 73232 data type. The
MaintenancePlannerGroupCode 73228 attribute has a cardinality of
0..1 73230 meaning that for each instance of the Item 73194 entity
there may be one MaintenancePlannerGroupCode 73228 attribute.
[0686] A PlannerGroupCode can be a coded representation of a
PlannerGroup. The ImportanceCode 73234 attribute can be an
ImportanceCode 73238 data type. The ImportanceCode 73234 attribute
has a cardinality of 0..1 73236 meaning that for each instance of
the Item 73194 entity there may be one ImportanceCode 73234
attribute. An ImportanceCode can be a coded representation of the
importance of a maintenance plan. The MaintenanceTaskListID 73240
attribute can be a MaintenanceTaskListID 73244 data type. The
MaintenanceTaskListID 73240 attribute has a cardinality of 0..1
73242 meaning that for each instance of the Item 73194 entity there
may be one MaintenanceTaskListID 73240 attribute. A
MaintenanceTaskListID can be an identifier for a maintenance task
list in a MaintenanceTaskList Group.
[0687] The MaintenanceTaskListGroupID 73246 attribute can be a
BusinessTransactionDocumentGroupID 73250 data type. The
MaintenanceTaskListGroupID 73246 attribute has a cardinality of
0..1 73248 meaning that for each instance of the Item 73194 entity
there may be one MaintenanceTaskListGroupID 73246 attribute. A
MaintenanceTaskListGroupID can be an identifier for a
TaskListGroup. The MaintenanceTaskListTypeCode 73252 attribute can
be a BusinessObjectTypeCode 73256 data type. The
MaintenanceTaskListTypeCode 73252 attribute has a cardinality of
0..1 73254 meaning that for each instance of the Item 73194 entity
there may be one MaintenanceTaskListTypeCode 73252 attribute.
[0688] A MaintenanceTaskListTypeCode can be a coded representation
of the type of a maintenance task list. The
BusinessTransactionDocumentID 73258 attribute can be a
BusinessTransactionDocumentReference 73262 data type. The
BusinessTransactionDocumentID 73258 attribute has a cardinality of
0..1 73260 meaning that for each instance of the Item 73194 entity
there may be one BusinessTransactionDocumentID 73258 attribute. A
BusinessTransactionDocumentID can be a unique identifier for a
business transaction document.
[0689] The WorkCentreDescription 73264 attribute can be a
SHORT_Description 73268 data type. The WorkCentreDescription 73264
attribute has a cardinality of 0..1 73266 meaning that for each
instance of the Item 73194 entity there may be one
WorkCentreDescription 73264 attribute. A WorkCentreDescription can
be a representation of the properties of a maintenance work centre
in natural language.
[0690] The StatusObject 73270 attribute can be a StatusObject 73274
data type. The StatusObject 73270 attribute has a cardinality of
0..1 73272 meaning that for each instance of the Item 73194 entity
there may be one StatusObject 73270 attribute. A StatusObject can
describe the processing status of a maintenance plan item in
structured form. The MaintenancePlanningPlantID 73276 attribute can
be a PlantID 73280 data type. The MaintenancePlanningPlantID 73276
attribute has a cardinality of 0..1 73278 meaning that for each
instance of the Item 73194 entity there may be one
MaintenancePlanningPlantID 73276 attribute.
[0691] A MaintenancePlanningPlantID can be an identifier of a plant
in which planning and supervision of the execution of maintenance
work is done. The WorkCentreID 73282 attribute can be a
WorkCentreID 73286 data type. The WorkCentreID 73282 attribute has
a cardinality of 0..1 73284 meaning that for each instance of the
Item 73194 entity there may be one WorkCentreID 73282 attribute. A
WorkCentreID can be an identifier of a work centre where the
execution of maintenance work is done. The WorkCentrePlantID 73288
attribute can be a PlantID 73292 data type. The WorkCentrePlantID
73288 attribute has a cardinality of 0..1 73290 meaning that for
each instance of the Item 73194 entity there may be one
WorkCentrePlantID 73288 attribute. A WorkCentrePlantID can be an
identifier of a plant where a work centre which is responsible for
the execution of maintenance work is present. The
MaintenancePlantDescription 73294 attribute can be a
SHORT_Description 73298 data type.
[0692] The MaintenancePlantDescription 73294 attribute has a
cardinality of 0..1 73296 meaning that for each instance of the
Item 73194 entity there may be one MaintenancePlantDescription
73294 attribute. A MaintenancePlantDescription can be a
representation of properties of a Maintenance Plant in natural
language. The MaintenanceWorkCenterDescription 73300 attribute can
be a SHORT_Description 73304 data type. The
MaintenanceWorkCenterDescription 73300 attribute has a cardinality
of 0..1 73302 meaning that for each instance of the Item 73194
entity there may be one MaintenanceWorkCenterDescription 73300
attribute. A WorkCenterDescription can be a representation of
properties of a Maintenance Work Center in natural language. The
TextCollection 73306 attribute can be a TextCollection 73310 data
type. The TextCollection 73306 attribute has a cardinality of 0..1
73308 meaning that for each instance of the Item 73194 entity there
may be one TextCollection 73306 attribute. A TextCollection can be
a collection of text descriptions of a business object or a part of
a business object.
[0693] The ObjectReference 73312 entity has a cardinality of 0..N
73314 meaning that for each instance of the Item 73194 entity there
may be one or more ObjectReference 73312 entities. The
ObjectReference 73312 entity includes various attributes, namely an
OrdinalNumberValue 73316, a SerialID 73322, a MaterialInternalID
73328, an IndividualMaterialID 73334, a MainIndicator 73340, an
InstallationPointID 73346, a MaterialDescription 73352, an
IndividualMaterialDescription 73358, an
InstallationPointDescription 73364 and a @actionCode 73370. The
OrdinalNumberValue 73316 attribute can be an OrdinalNumberValue
73320 data type. The OrdinalNumberValue 73316 attribute has a
cardinality of 0..1 73318 meaning that for each instance of the
ObjectReference 73312 entity there may be one OrdinalNumberValue
73316 attribute.
[0694] An OrdinalNumberValue can be a number that indicates a
position of a maintenance plan item object reference in a linearly
ordered set that is ordered according to particular factors. The
SerialID 73322 attribute can be a SerialID 73326 data type. The
SerialID 73322 attribute has a cardinality of 0..1 73324 meaning
that for each instance of the ObjectReference 73312 entity there
may be one SerialID 73322 attribute. A SerialID (serial number) can
be a unique identifier for an individual material that is assigned
in a maintenance request. The MaterialInternalID 73328 attribute
can be a ProductInternalID 73332 data type. The MaterialInternalID
73328 attribute has a cardinality of 0..1 73330 meaning that for
each instance of the ObjectReference 73312 entity there may be one
MaterialInternalID 73328 attribute. A MaterialInternalID can be a
proprietary identifier for a material.
[0695] The IndividualMaterialID 73334 attribute can be a
ProductInternalID 73338 data type. The IndividualMaterialID 73334
attribute has a cardinality of 0..1 73336 meaning that for each
instance of the ObjectReference 73312 entity there may be one
IndividualMaterialID 73334 attribute. An IndividualMaterialID can
be a proprietary identifier for an individual material. The
MainIndicator 73340 attribute can be an Indicator 73344 data type.
The MainIndicator 73340 attribute has a cardinality of 1 73342
meaning that for each instance of the ObjectReference 73312 entity
there is one MainIndicator 73340 attribute. A MainIndicator can be
an indicator which describes a focused object reference. The
InstallationPointID 73346 attribute can be an InstallationPointID
73350 data type. The InstallationPointID 73346 attribute has a
cardinality of 0..1 73348 meaning that for each instance of the
ObjectReference 73312 entity there may be one InstallationPointID
73346 attribute.
[0696] An InstallationPointID can be a unique identifier for an
installation point. The MaterialDescription 73352 attribute can be
a SHORT_Description 73356 data type. The MaterialDescription 73352
attribute has a cardinality of 0..1 73354 meaning that for each
instance of the ObjectReference 73312 entity there may be one
MaterialDescription 73352 attribute. A MaterialInternalDescription
can be a representation of properties of a material in natural
language. The IndividualMaterialDescription 73358 attribute can be
a SHORT_Description 73362 data type. The
IndividualMaterialDescription 73358 attribute has a cardinality of
0..1 73360 meaning that for each instance of the ObjectReference
73312 entity there may be one IndividualMaterialDescription 73358
attribute. An IndividualMaterialDescription can be a representation
of properties of an individual material in natural language.
[0697] The InstallationPointDescription 73364 attribute can be a
SHORT_Description 73368 data type. The InstallationPointDescription
73364 attribute has a cardinality of 0..1 73366 meaning that for
each instance of the ObjectReference 73312 entity there may be one
InstallationPointDescription 73364 attribute. An
InstallationPointDescription can be a representation of properties
of an installation point in natural language. The @actionCode 73370
attribute can be an ActionCode 73374 data type. The @actionCode
73370 attribute has a cardinality of 1 73372 meaning that for each
instance of the ObjectReference 73312 entity there is one
@actionCode 73370 attribute. An ActionCode can be a coded
representation of an instruction to a recipient of a message
telling the recipient how to process a transmitted element.
ActionCode can determine if the Service Execution Order Operation
may be created (Code 01), changed (Code 02), or deleted (Code 03).
In some implementations, other codes are not allowed.
[0698] The ScheduleLine 73376 entity has a cardinality of 0..N
73378 meaning that for each instance of the Item 73194 entity there
may be one or more ScheduleLine 73376 entities. The ScheduleLine
73376 entity includes various attributes, namely an
OrdinalNumberValue 73380, a PlannedDateTime 73384, an
InitiatedDateTime 73390 and a CompletionDateTime 73396. The
OrdinalNumberValue 73380 attribute can be an OrdinalNumberValue
73382 data type. An OrdinalNumberValue can be a number that
indicates a position of an element in a linearly ordered set that
is ordered according to particular factors.
[0699] The PlannedDateTime 73384 attribute can be a
TIMEZONEINDEPENDENT_DateTime 73388 data type. The PlannedDateTime
73384 attribute has a cardinality of 0..1 73386 meaning that for
each instance of the ScheduleLine 73376 entity there may be one
PlannedDateTime 73384 attribute. A PlannedDateTime can be a date on
which a maintenance call object can be executed. The
InitiatedDateTime 73390 attribute can be a
TIMEZONEINDEPENDENT_DateTime 73394 data type. The InitiatedDateTime
73390 attribute has a cardinality of 0..1 73392 meaning that for
each instance of the ScheduleLine 73376 entity there may be one
InitiatedDateTime 73390 attribute. A CallDateTime can be a date on
which the system creates a maintenance call object. The
CompletionDateTime 73396 attribute can be a
TIMEZONEINDEPENDENT_DateTime 73400 data type. The
CompletionDateTime 73396 attribute has a cardinality of 0..1 73398
meaning that for each instance of the ScheduleLine 73376 entity
there may be one CompletionDateTime 73396 attribute. A
CompletionDateTime can be a date on which a maintenance task was
completed.
[0700] The CycleGroup 73402 entity has a cardinality of 0..N 73404
meaning that for each instance of the MaintenancePlan 73012 entity
there may be one or more CycleGroup 73402 entities. The CycleGroup
73402 entity includes various attributes, namely a
SequenceNumberValue 73406, an ItemMaintenancePlanID 73412 and a
MaintenancePlanCycleSetNumberValue 73418. The SequenceNumberValue
73406 attribute can be a NumberValue 73410 data type. The
SequenceNumberValue 73406 attribute has a cardinality of 1 73408
meaning that for each instance of the CycleGroup 73402 entity there
is one SequenceNumberValue 73406 attribute. A
GroupSequenceNumberValue can be a value to determine a maintenance
cycle group. The ItemMaintenancePlanID 73412 attribute can be a
MaintenancePlanID 73416 data type.
[0701] The ItemMaintenancePlanID 73412 attribute has a cardinality
of 0..1 73414 meaning that for each instance of the CycleGroup
73402 entity there may be one ItemMaintenancePlanID 73412
attribute. A MaintenancePlanID can be a unique identifier for a
maintenance plan. The MaintenancePlanCycleSetNumberValue 73418
attribute can be a NumberValue 73422 data type. The
MaintenancePlanCycleSetNumberValue 73418 attribute has a
cardinality of 0..N 73420 meaning that for each instance of the
CycleGroup 73402 entity there may be one or more
MaintenancePlanCycleSetNumberValue 73418 attributes. A
MaintenancePlanCycleSetNumberValue can be a value to determine a
maintenance cycles group.
[0702] The ProcessingConditions 73424 package includes a
ProcessingConditions 73426 entity. The ProcessingConditions 73426
entity has a cardinality of 0..1 73428 meaning that for each
instance of the ProcessingConditions 73424 package there may be one
ProcessingConditions 73426 entity. The ProcessingConditions 73426
entity includes various attributes, namely a
QueryHitsMaximumNumberValue 73430, an UnlimitedQueryHitsIndicator
73436, a ReturnedQueryHitsNumberValue 73442, a
MoreElementsAvailablelndicator 73448 and a
LastProvidedMaintenanceRequestID 73454. The
QueryHitsMaximumNumberValue 73430 attribute can be a NumberValue
73434 data type.
[0703] The QueryHitsMaximumNumberValue 73430 attribute has a
cardinality of 0..1 73432 meaning that for each instance of the
ProcessingConditions 73426 entity there may be one
QueryHitsMaximumNumberValue 73430 attribute. A NumberValue can be a
number. In some implementations, NumberValue is used for cardinal
numbers. The UnlimitedQueryHitsIndicator 73436 attribute can be an
Indicator 73440 data type. The UnlimitedQueryHitsIndicator 73436
attribute has a cardinality of 0..1 73438 meaning that for each
instance of the ProcessingConditions 73426 entity there may be one
UnlimitedQueryHitsIndicator 73436 attribute. An Indicator can be a
representation of a situation that has exactly two mutually
exclusive Boolean values. The ReturnedQueryHitsNumberValue 73442
attribute can be a NumberValue 73446 data type. The
ReturnedQueryHitsNumberValue 73442 attribute has a cardinality of
0..1 73444 meaning that for each instance of the
ProcessingConditions 73426 entity there may be one
ReturnedQueryHitsNumberValue 73442 attribute. A NumberValue can be
a number. In some implementations, NumberValue is used for cardinal
numbers.
[0704] The MoreElementsAvailablelndicator 73448 attribute can be a
MoreElementsAvailablelndicator 73452 data type. The
MoreElementsAvailablelndicator 73448 attribute has a cardinality of
0..1 73450 meaning that for each instance of the
ProcessingConditions 73426 entity there may be one
MoreElementsAvailablelndicator 73448 attribute. An Indicator can be
a representation of a situation that has exactly two mutually
exclusive Boolean values. The LastProvidedMaintenanceRequestID
73454 attribute can be a MaintenanceRequestID 73458 data type. The
LastProvidedMaintenanceRequestID 73454 attribute has a cardinality
of 0..1 73456 meaning that for each instance of the
ProcessingConditions 73426 entity there may be one
LastProvidedMaintenanceRequestID 73454 attribute. A
MaintenanceRequestID can be a unique identifier for a
MaintenanceRequest
[0705] The Log 73460 package can be a Log 73466 data type. The Log
73460 package includes a Log 73462 entity. The Log 73462 entity has
a cardinality of 1 73464 meaning that for each instance of the Log
73460 package there is one Log 73462 entity.
[0706] FIGS. 74-1 through 74-8 show an example configuration of an
Element Structure that includes a MaintPlnERPCrteReqMsg_s 74000
package. The MaintPlnERPCrteReqMsg_s 74000 package includes a
MaintPlnERPCrteReqMsg_s 74002 entity. The MaintPlnERPCrteReqMsg_s
74000 package includes various packages, namely a MessageHeader
74004 and a MaintenancePlan 74010.
[0707] The MessageHeader 74004 package includes a MessageHeader
74006 entity. The MessageHeader 74006 entity has a cardinality of
0..1 74008 meaning that for each instance of the MessageHeader
74004 package there may be one MessageHeader 74006 entity. The
MaintenancePlan 74010 package includes a MaintenancePlan 74012
entity.
[0708] The MaintenancePlan 74012 entity has a cardinality of 1
74014 meaning that for each instance of the MaintenancePlan 74010
package there is one MaintenancePlan 74012 entity. The
MaintenancePlan 74012 entity includes various attributes, namely a
CategoryCode 74016, a Description 74020 and a TextCollection 74024.
The MaintenancePlan 74012 entity includes various subordinate
entities, namely a SchedulingTerms 74028, a Cycle 74088 and an Item
74120. The CategoryCode 74016 attribute has a cardinality of 1
74018 meaning that for each instance of the MaintenancePlan 74012
entity there is one CategoryCode 74016 attribute. The Description
74020 attribute has a cardinality of 1 74022 meaning that for each
instance of the MaintenancePlan 74012 entity there is one
Description 74020 attribute. The TextCollection 74024 attribute has
a cardinality of 0..1 74026 meaning that for each instance of the
MaintenancePlan 74012 entity there may be one TextCollection 74024
attribute.
[0709] The SchedulingTerms 74028 entity has a cardinality of 0..1
74030 meaning that for each instance of the MaintenancePlan 74012
entity there may be one SchedulingTerms 74028 entity. The
SchedulingTerms 74028 entity includes various attributes, namely a
StartDateTime 74032, a
MeasuringDeviceStartMeasurementReadingMeasure 74036, a
LateCompletionShiftPercent 74040, an EarlyCompletionShiftPercent
74044, a LateCompletionTolerencePercent 74048, an
EarlyCompletionTolerencePercent 74052, a WorkingDayCalendarCode
74056, a MaintenancePlanCycleQuantityModificationFactorValue 74060,
a BufferStartDaysNumberValue 74064, a CallHorizonPercent 74068, a
PredecessorCompletionRequiredIndicator 74072, a SchedulingDuration
74076, a SchedulingCategoryCode 74080 and a
CycleDependencylndicator 74084. The StartDateTime 74032 attribute
has a cardinality of 0..1 74034 meaning that for each instance of
the SchedulingTerms 74028 entity there may be one StartDateTime
74032 attribute.
[0710] The MeasuringDeviceStartMeasurementReadingMeasure 74036
attribute has a cardinality of 0..1 74038 meaning that for each
instance of the SchedulingTerms 74028 entity there may be one
MeasuringDeviceStartMeasurementReadingMeasure 74036 attribute. The
LateCompletionShiftPercent 74040 attribute has a cardinality of
0..1 74042 meaning that for each instance of the SchedulingTerms
74028 entity there may be one LateCompletionShiftPercent 74040
attribute. The EarlyCompletionShiftPercent 74044 attribute has a
cardinality of 0..1 74046 meaning that for each instance of the
SchedulingTerms 74028 entity there may be one
EarlyCompletionShiftPercent 74044 attribute. The
LateCompletionTolerencePercent 74048 attribute has a cardinality of
0..1 74050 meaning that for each instance of the SchedulingTerms
74028 entity there may be one LateCompletionTolerencePercent 74048
attribute.
[0711] The EarlyCompletionTolerencePercent 74052 attribute has a
cardinality of 0..1 74054 meaning that for each instance of the
SchedulingTerms 74028 entity there may be one
EarlyCompletionTolerencePercent 74052 attribute. The
WorkingDayCalendarCode 74056 attribute has a cardinality of 0..1
74058 meaning that for each instance of the SchedulingTerms 74028
entity there may be one WorkingDayCalendarCode 74056 attribute. The
MaintenancePlanCycleQuantityModificationFactorValue 74060 attribute
has a cardinality of 0..1 74062 meaning that for each instance of
the SchedulingTerms 74028 entity there may be one
MaintenancePlanCycleQuantityModificationFactorValue 74060
attribute. The BufferStartDaysNumberValue 74064 attribute has a
cardinality of 0..1 74066 meaning that for each instance of the
SchedulingTerms 74028 entity there may be one
BufferStartDaysNumberValue 74064 attribute.
[0712] The CallHorizonPercent 74068 attribute has a cardinality of
0..1 74070 meaning that for each instance of the SchedulingTerms
74028 entity there may be one CallHorizonPercent 74068 attribute.
The PredecessorCompletionRequiredIndicator 74072 attribute has a
cardinality of 0..1 74074 meaning that for each instance of the
SchedulingTerms 74028 entity there may be one
PredecessorCompletionRequiredIndicator 74072 attribute. The
SchedulingDuration 74076 attribute has a cardinality of 0..1 74078
meaning that for each instance of the SchedulingTerms 74028 entity
there may be one SchedulingDuration 74076 attribute. The
SchedulingCategoryCode 74080 attribute has a cardinality of 0..1
74082 meaning that for each instance of the SchedulingTerms 74028
entity there may be one SchedulingCategoryCode 74080 attribute. The
CycleDependencyIndicator 74084 attribute has a cardinality of 0..1
74086 meaning that for each instance of the SchedulingTerms 74028
entity there may be one CycleDependencyIndicator 74084
attribute.
[0713] The Cycle 74088 entity has a cardinality of 0..n 74090
meaning that for each instance of the MaintenancePlan 74012 entity
there may be one or more Cycle 74088 entities. The Cycle 74088
entity includes various attributes, namely a CounterValue 74092, a
GroupSequenceNumberValue 74096, a
GroupSequenceRepetitionNumberValue 74100, a Quantity 74104, a
StartOffsetQuantity 74108, a MeasuringDeviceID 74112 and a
Description 74116. The CounterValue 74092 attribute has a
cardinality of 1 74094 meaning that for each instance of the Cycle
74088 entity there is one CounterValue 74092 attribute. The
GroupSequenceNumberValue 74096 attribute has a cardinality of 0..1
74098 meaning that for each instance of the Cycle 74088 entity
there may be one GroupSequenceNumberValue 74096 attribute. The
GroupSequenceRepetitionNumberValue 74100 attribute has a
cardinality of 0..1 74102 meaning that for each instance of the
Cycle 74088 entity there may be one
GroupSequenceRepetitionNumberValue 74100 attribute. The Quantity
74104 attribute has a cardinality of 1 74106 meaning that for each
instance of the Cycle 74088 entity there is one Quantity 74104
attribute. The StartOffsetQuantity 74108 attribute has a
cardinality of 0..1 74110 meaning that for each instance of the
Cycle 74088 entity there may be one StartOffsetQuantity 74108
attribute. The MeasuringDeviceID 74112 attribute has a cardinality
of 0..1 74114 meaning that for each instance of the Cycle 74088
entity there may be one MeasuringDeviceID 74112 attribute. The
Description 74116 attribute has a cardinality of 0..1 74118 meaning
that for each instance of the Cycle 74088 entity there may be one
Description 74116 attribute.
[0714] The Item 74120 entity has a cardinality of 1..n 74122
meaning that for each instance of the MaintenancePlan 74012 entity
there are one or more Item 74120 entities. The Item 74120 entity
includes various attributes, namely an OrdinalNumberValue 74124, a
CycleGroupSequenceNumberValue 74128, a
BusinessTransactionDocumentProcessingTypeCode 74132, a WorkCentreID
74136, a MaintenancePlanningPlantID 74140, a WorkCenterPlantID
74144, a MaintenancePlannerGroupCode 74148, an ImportanceCode
74152, a MaintenanceTaskListID 74156, a
BusinessTransactionDocumentGroupID 74160, a BusinessObjectTypeCode
74164, a BusinessTransactionDocumentReference 74168, a Description
74172 and a TextCollection 74176. The Item 74120 entity includes an
ObjectReference 74180 subordinate entity.
[0715] The OrdinalNumberValue 74124 attribute has a cardinality of
1 74126 meaning that for each instance of the Item 74120 entity
there is one OrdinalNumberValue 74124 attribute. The
CycleGroupSequenceNumberValue 74128 attribute has a cardinality of
0..1 74130 meaning that for each instance of the Item 74120 entity
there may be one CycleGroupSequenceNumberValue 74128 attribute. The
BusinessTransactionDocumentProcessingTypeCode 74132 attribute has a
cardinality of 1 74134 meaning that for each instance of the Item
74120 entity there is one
BusinessTransactionDocumentProcessingTypeCode 74132 attribute. The
WorkCentreID 74136 attribute has a cardinality of 1 74138 meaning
that for each instance of the Item 74120 entity there is one
WorkCentreID 74136 attribute. The MaintenancePlanningPlantID 74140
attribute has a cardinality of 1 74142 meaning that for each
instance of the Item 74120 entity there is one
MaintenancePlanningPlantID 74140 attribute. The WorkCenterPlantID
74144 attribute has a cardinality of 0..1 74146 meaning that for
each instance of the Item 74120 entity there may be one
WorkCenterPlantID 74144 attribute. The MaintenancePlannerGroupCode
74148 attribute has a cardinality of 0..1 74150 meaning that for
each instance of the Item 74120 entity there may be one
MaintenancePlannerGroupCode 74148 attribute. The ImportanceCode
74152 attribute has a cardinality of 0..1 74154 meaning that for
each instance of the Item 74120 entity there may be one
ImportanceCode 74152 attribute.
[0716] The MaintenanceTaskListID 74156 attribute has a cardinality
of 0..1 74158 meaning that for each instance of the Item 74120
entity there may be one MaintenanceTaskListID 74156 attribute. The
BusinessTransactionDocumentGroupID 74160 attribute has a
cardinality of 0..1 74162 meaning that for each instance of the
Item 74120 entity there may be one
BusinessTransactionDocumentGroupID 74160 attribute. The
BusinessObjectTypeCode 74164 attribute has a cardinality of 0..1
74166 meaning that for each instance of the Item 74120 entity there
may be one BusinessObjectTypeCode 74164 attribute. The
BusinessTransactionDocumentReference 74168 attribute has a
cardinality of 0..1 74170 meaning that for each instance of the
Item 74120 entity there may be one
BusinessTransactionDocumentReference 74168 attribute. The
Description 74172 attribute has a cardinality of 0..1 74174 meaning
that for each instance of the Item 74120 entity there may be one
Description 74172 attribute. The TextCollection 74176 attribute has
a cardinality of 0..1 74178 meaning that for each instance of the
Item 74120 entity there may be one TextCollection 74176
attribute.
[0717] The ObjectReference 74180 entity has a cardinality of 1..n
74182 meaning that for each instance of the Item 74120 entity there
are one or more ObjectReference 74180 entities. The ObjectReference
74180 entity includes various attributes, namely an
OrdinalNumberValue 74184, a MainIndicator 74188, a SerialID 74192,
a MaterialInternalID 74196, an IndividualMaterialID 74200 and an
InstallationPointID 74204. The OrdinalNumberValue 74184 attribute
has a cardinality of 1 74186 meaning that for each instance of the
ObjectReference 74180 entity there is one OrdinalNumberValue 74184
attribute. The MainIndicator 74188 attribute has a cardinality of 1
74190 meaning that for each instance of the ObjectReference 74180
entity there is one MainIndicator 74188 attribute.
[0718] The SerialID 74192 attribute has a cardinality of 0..1 74194
meaning that for each instance of the ObjectReference 74180 entity
there may be one SerialID 74192 attribute. The MaterialInternalID
74196 attribute has a cardinality of 0..1 74198 meaning that for
each instance of the ObjectReference 74180 entity there may be one
MaterialInternalID 74196 attribute. The IndividualMaterialID 74200
attribute has a cardinality of 0..1 74202 meaning that for each
instance of the ObjectReference 74180 entity there may be one
IndividualMaterialID 74200 attribute. The InstallationPointID 74204
attribute has a cardinality of 0..1 74206 meaning that for each
instance of the ObjectReference 74180 entity there may be one
InstallationPointID 74204 attribute. The data types of the various
packages, entities, and attributes are described with respect to
FIG. 73.
[0719] FIG. 75 shows an example configuration of an Element
Structure that includes a MaintPlnERPCrteConfMsg_s 75000 package.
The MaintPlnERPCrteConfMsg_s 75000 package includes a
MaintPlnERPCrteConfMsg_s 75002 entity. The MaintPlnERPCrteConfMsg_s
75000 package includes various packages, namely a MessageHeader
75004, a MaintenancePlan 75010 and a Log 75020.
[0720] The MessageHeader 75004 package includes a MessageHeader
75006 entity. The MessageHeader 75006 entity has a cardinality of
0..1 75008 meaning that for each instance of the MessageHeader
75004 package there may be one MessageHeader 75006 entity. The
MaintenancePlan 75010 package includes a MaintenancePlan 75012
entity.
[0721] The MaintenancePlan 75012 entity has a cardinality of 0..1
75014 meaning that for each instance of the MaintenancePlan 75010
package there may be one MaintenancePlan 75012 entity. The
MaintenancePlan 75012 entity includes an ID 75016 attribute. The ID
75016 attribute has a cardinality of 1 75018 meaning that for each
instance of the MaintenancePlan 75012 entity there is one ID 75016
attribute.
[0722] The Log 75020 package includes a Log 75022 entity. The Log
75022 entity has a cardinality of 1 75024 meaning that for each
instance of the Log 75020 package there is one Log 75022 entity.
The data types of the various packages, entities, and attributes
are described with respect to FIG. 73.
[0723] FIG. 76 shows an example configuration of an Element
Structure that includes a MaintPlnERPActvteReqMsg_s 76000 package.
The MaintPlnERPActvteReqMsg_s 76000 package includes a
MaintPlnERPActvteReqMsg_s 76002 entity. The
MaintPlnERPActvteReqMsg_s 76000 package includes various packages,
namely a MessageHeader 76004 and a MaintenancePlan 76010.
[0724] The MessageHeader 76004 package includes a MessageHeader
76006 entity. The MessageHeader 76006 entity has a cardinality of
0..1 76008 meaning that for each instance of the MessageHeader
76004 package there may be one MessageHeader 76006 entity. The
MaintenancePlan 76010 package includes a MaintenancePlan 76012
entity.
[0725] The MaintenancePlan 76012 entity has a cardinality of 1
76014 meaning that for each instance of the MaintenancePlan 76010
package there is one MaintenancePlan 76012 entity. The
MaintenancePlan 76012 entity includes an ID 76016 attribute. The ID
76016 attribute has a cardinality of 1 76018 meaning that for each
instance of the MaintenancePlan 76012 entity there is one ID 76016
attribute. The data types of the various packages, entities, and
attributes are described with respect to FIG. 73.
[0726] FIG. 77 shows an example configuration of an Element
Structure that includes a MaintPlnERPActvteConfMsg_s 77000 package.
The MaintPlnERPActvteConfMsg_s 77000 package includes a
MaintPlnERPActvteConfMsg_s 77002 entity. The
MaintPlnERPActvteConfMsg_s 77000 package includes various packages,
namely a MessageHeader 77004 and a Log 77010.
[0727] The MessageHeader 77004 package includes a MessageHeader
77006 entity. The MessageHeader 77006 entity has a cardinality of
0..1 77008 meaning that for each instance of the MessageHeader
77004 package there may be one MessageHeader 77006 entity. The Log
77010 package includes a Log 77012 entity. The Log 77012 entity has
a cardinality of 1 77014 meaning that for each instance of the Log
77010 package there is one Log 77012 entity. The data types of the
various packages, entities, and attributes are described with
respect to FIG. 73.
[0728] FIG. 78 shows an example configuration of an Element
Structure that includes a MaintPlnERPDactvteReqMsg_s 78000 package.
The MaintPlnERPDactvteReqMsg_s 78000 package includes a
MaintPlnERPDactvteReqMsg_s 78002 entity. The
MaintPlnERPDactvteReqMsg_s 78000 package includes various packages,
namely a MessageHeader 78004 and a MaintenancePlan 78010.
[0729] The MessageHeader 78004 package includes a MessageHeader
78006 entity. The MessageHeader 78006 entity has a cardinality of
0..1 78008 meaning that for each instance of the MessageHeader
78004 package there may be one MessageHeader 78006 entity. The
MaintenancePlan 78010 package includes a MaintenancePlan 78012
entity. The MaintenancePlan 78012 entity has a cardinality of 1
78014 meaning that for each instance of the MaintenancePlan 78010
package there is one MaintenancePlan 78012 entity. The
MaintenancePlan 78012 entity includes an ID 78016 attribute. The ID
78016 attribute has a cardinality of 1 78018 meaning that for each
instance of the MaintenancePlan 78012 entity there is one ID 78016
attribute. The data types of the various packages, entities, and
attributes are described with respect to FIG. 73.
[0730] FIG. 79 shows an example configuration of an Element
Structure that includes a MaintPlnERPDactvteConfMsg_s 79000
package. The MaintPlnERPDactvteConfMsg_s 79000 package includes a
MaintPlnERPDactvteConfMsg_s 79002 entity. The
MaintPlnERPDactvteConfMsg_s 79000 package includes various
packages, namely a MessageHeader 79004 and a Log 79010.
[0731] The MessageHeader 79004 package includes a MessageHeader
79006 entity. The MessageHeader 79006 entity has a cardinality of
0..1 79008 meaning that for each instance of the MessageHeader
79004 package there may be one MessageHeader 79006 entity. The Log
79010 package includes a Log 79012 entity. The Log 79012 entity has
a cardinality of 1 79014 meaning that for each instance of the Log
79010 package there is one Log 79012 entity. The data types of the
various packages, entities, and attributes are described with
respect to FIG. 73.
[0732] FIG. 80 shows an example configuration of an Element
Structure that includes a MaintPlnERPSetDelIndReqMsg_s 80000
package. The MaintPlnERPSetDelIndReqMsg_s 80000 package includes a
MaintPlnERPSetDelIndReqMsg_s 80002 entity. The
MaintPlnERPSetDelIndReqMsg_s 80000 package includes various
packages, namely a MessageHeader 80004 and a MaintenancePlan
80010.
[0733] The MessageHeader 80004 package includes a MessageHeader
80006 entity. The MessageHeader 80006 entity has a cardinality of
0..1 80008 meaning that for each instance of the MessageHeader
80004 package there may be one MessageHeader 80006 entity. The
MaintenancePlan 80010 package includes a MaintenancePlan 80012
entity. The MaintenancePlan 80012 entity has a cardinality of 1
80014 meaning that for each instance of the MaintenancePlan 80010
package there is one MaintenancePlan 80012 entity. The
MaintenancePlan 80012 entity includes an ID 80016 attribute. The ID
80016 attribute has a cardinality of 1 80018 meaning that for each
instance of the MaintenancePlan 80012 entity there is one ID 80016
attribute. The data types of the various packages, entities, and
attributes are described with respect to FIG. 73.
[0734] FIG. 81 shows an example configuration of an Element
Structure that includes a MaintPlnERPSetDelIndConfMsg_s 81000
package. The MaintPlnERPSetDelIndConfMsg_s 81000 package includes a
MaintPlnERPSetDelIndConfMsg_s 81002 entity. The
MaintPlnERPSetDelIndConfMsg_s 81000 package includes various
packages, namely a MessageHeader 81004 and a Log 81010.
[0735] The MessageHeader 81004 package includes a MessageHeader
81006 entity. The MessageHeader 81006 entity has a cardinality of
0..1 81008 meaning that for each instance of the MessageHeader
81004 package there may be one MessageHeader 81006 entity. The Log
81010 package includes a Log 81012 entity. The Log 81012 entity has
a cardinality of 1 81014 meaning that for each instance of the Log
81010 package there is one Log 81012 entity. The data types of the
various packages, entities, and attributes are described with
respect to FIG. 73.
[0736] FIG. 82 shows an example configuration of an Element
Structure that includes a MaintPlnERPRstDelIndReqMsg_s 82000
package. The MaintPlnERPRstDelIndReqMsg_s 82000 package includes a
MaintPlnERPRstDelIndReqMsg_s 82002 entity. The
MaintPlnERPRstDelIndReqMsg_s 82000 package includes various
packages, namely a MessageHeader 82004 and a MaintenancePlan
82010.
[0737] The MessageHeader 82004 package includes a MessageHeader
82006 entity. The MessageHeader 82006 entity has a cardinality of
0..1 82008 meaning that for each instance of the MessageHeader
82004 package there may be one MessageHeader 82006 entity. The
MaintenancePlan 82010 package includes a MaintenancePlan 82012
entity. The MaintenancePlan 82012 entity has a cardinality of 1
82014 meaning that for each instance of the MaintenancePlan 82010
package there is one MaintenancePlan 82012 entity. The
MaintenancePlan 82012 entity includes an ID 82016 attribute. The ID
82016 attribute has a cardinality of 1 82018 meaning that for each
instance of the MaintenancePlan 82012 entity there is one ID 82016
attribute. The data types of the various packages, entities, and
attributes are described with respect to FIG. 73.
[0738] FIG. 83 shows an example configuration of an Element
Structure that includes a MaintPlnERPRstDelIndConfMsg_s 83000
package. The MaintPlnERPRstDelIndConfMsg_s 83000 package includes a
MaintPlnERPRstDelIndConfMsg_s 83002 entity. The
MaintPlnERPRstDelIndConfMsg_s 83000 package includes various
packages, namely a MessageHeader 83004 and a Log 83010.
[0739] The MessageHeader 83004 package includes a MessageHeader
83006 entity. The MessageHeader 83006 entity has a cardinality of
0..1 83008 meaning that for each instance of the MessageHeader
83004 package there may be one MessageHeader 83006 entity. The Log
83010 package includes a Log 83012 entity. The Log 83012 entity has
a cardinality of 1 83014 meaning that for each instance of the Log
83010 package there is one Log 83012 entity. The data types of the
various packages, entities, and attributes are described with
respect to FIG. 73.
[0740] FIGS. 84-1 through 84-2 show an example configuration of an
Element Structure that includes a MaintPlnERPSimplElmntsQryMsg_s
84000 package. The MaintPlnERPSimplElmntsQryMsg_s 84000 package
includes a MaintPlnERPSimplElmntsQryMsg_s 84002 entity. The
MaintPlnERPSimplElmntsQryMsg_s 84000 package includes various
packages, namely a Selection 84004 and a ProcessingConditions
84034.
[0741] The Selection 84004 package includes a
MaintenancePlanSimpleSelectionByElements 84006 entity. The
MaintenancePlanSimpleSelectionByElements 84006 entity has a
cardinality of 1 84008 meaning that for each instance of the
Selection 84004 package there is one
MaintenancePlanSimpleSelectionByElements 84006 entity. The
MaintenancePlanSimpleSelectionByElements 84006 entity includes a
MaintenancePlanCategoryCode 84010 attribute. The
MaintenancePlanSimpleSelectionByElements 84006 entity includes a
SelectionByMaintenancePlanID 84014 subordinate entity. The
MaintenancePlanCategoryCode 84010 attribute has a cardinality of
0..1 84012 meaning that for each instance of the
MaintenancePlanSimpleSelectionByElements 84006 entity there may be
one MaintenancePlanCategoryCode 84010 attribute.
[0742] The SelectionByMaintenancePlanID 84014 entity has a
cardinality of 0..1 84016 meaning that for each instance of the
MaintenancePlanSimpleSelectionByElements 84006 entity there may be
one SelectionByMaintenancePlanID 84014 entity. The
SelectionByMaintenancePlanID 84014 entity includes various
attributes, namely an InclusionExclusionCode 84018, an
IntervalBoundaryTypeCode 84022, a LowerBoundaryMaintenancePlanID
84026 and an UpperBoundaryMaintenancePlanID 84030. The
InclusionExclusionCode 84018 attribute has a cardinality of 0..1
84020 meaning that for each instance of the
SelectionByMaintenancePlanID 84014 entity there may be one
InclusionExclusionCode 84018 attribute.
[0743] The IntervalBoundaryTypeCode 84022 attribute has a
cardinality of 0..1 84024 meaning that for each instance of the
SelectionByMaintenancePlanID 84014 entity there may be one
IntervalBoundaryTypeCode 84022 attribute. The
LowerBoundaryMaintenancePlanID 84026 attribute has a cardinality of
0..1 84028 meaning that for each instance of the
SelectionByMaintenancePlanID 84014 entity there may be one
LowerBoundaryMaintenancePlanID 84026 attribute. The
UpperBoundaryMaintenancePlanID 84030 attribute has a cardinality of
0..1 84032 meaning that for each instance of the
SelectionByMaintenancePlanID 84014 entity there may be one
UpperBoundaryMaintenancePlanID 84030 attribute.
[0744] The ProcessingConditions 84034 package includes a
ProcessingConditions 84036 entity. The ProcessingConditions 84036
entity has a cardinality of 0..1 84038 meaning that for each
instance of the ProcessingConditions 84034 package there may be one
ProcessingConditions 84036 entity. The ProcessingConditions 84036
entity includes various attributes, namely a
QueryHitsMaximumNumberValue 84040, an UnlimitedQueryHitsIndicator
84044, a ReturnedQueryHitsNumberValue 84048, a
MoreElementsAvailablelndicator 84052 and a
LastProvidedMaintenancePlanID 84056. The
QueryHitsMaximumNumberValue 84040 attribute has a cardinality of
0..1 84042 meaning that for each instance of the
ProcessingConditions 84036 entity there may be one
QueryHitsMaximumNumberValue 84040 attribute.
[0745] The UnlimitedQueryHitsIndicator 84044 attribute has a
cardinality of 0..1 84046 meaning that for each instance of the
ProcessingConditions 84036 entity there may be one
UnlimitedQueryHitsIndicator 84044 attribute. The
ReturnedQueryHitsNumberValue 84048 attribute has a cardinality of
0..1 84050 meaning that for each instance of the
ProcessingConditions 84036 entity there may be one
ReturnedQueryHitsNumberValue 84048 attribute. The
MoreElementsAvailablelndicator 84052 attribute has a cardinality of
0..1 84054 meaning that for each instance of the
ProcessingConditions 84036 entity there may be one
MoreElementsAvailablelndicator 84052 attribute. The
LastProvidedMaintenancePlanID 84056 attribute has a cardinality of
0..1 84058 meaning that for each instance of the
ProcessingConditions 84036 entity there may be one
LastProvidedMaintenancePlanID 84056 attribute. The data types of
the various packages, entities, and attributes are described with
respect to FIG. 73.
[0746] FIGS. 85-1 through 85-2 show an example configuration of an
Element Structure that includes a MaintPlnERPSimplElmntsRspMsg_s
85000 package. The MaintPlnERPSimplElmntsRspMsg_s 85000 package
includes a MaintPlnERPSimplElmntsRspMsg_s 85002 entity. The
MaintPlnERPSimplElmntsRspMsg_s 85000 package includes various
packages, namely a MaintenancePlan 85004, a ProcessingConditions
85018 and a Log 85044.
[0747] The MaintenancePlan 85004 package includes a MaintenancePlan
85006 entity. The MaintenancePlan 85006 entity has a cardinality of
0..n 85008 meaning that for each instance of the MaintenancePlan
85004 package there may be one or more MaintenancePlan 85006
entities. The MaintenancePlan 85006 entity includes various
attributes, namely an ID 85010 and a Description 85014. The ID
85010 attribute has a cardinality of 1 85012 meaning that for each
instance of the MaintenancePlan 85006 entity there is one ID 85010
attribute. The Description 85014 attribute has a cardinality of
0..1 85016 meaning that for each instance of the MaintenancePlan
85006 entity there may be one Description 85014 attribute.
[0748] The ProcessingConditions 85018 package includes a
ProcessingConditions 85020 entity. The ProcessingConditions 85020
entity has a cardinality of 1 85022 meaning that for each instance
of the ProcessingConditions 85018 package there is one
ProcessingConditions 85020 entity. The ProcessingConditions 85020
entity includes various attributes, namely a
QueryHitsMaximumNumberValue 85024, an UnlimitedQueryHitsIndicator
85028, a ReturnedQueryHitsNumberValue 85032, a
MoreElementsAvailablelndicator 85036 and a
LastProvidedMaintenancePlanID 85040. The
QueryHitsMaximumNumberValue 85024 attribute has a cardinality of
0..1 85026 meaning that for each instance of the
ProcessingConditions 85020 entity there may be one
QueryHitsMaximumNumberValue 85024 attribute.
[0749] The UnlimitedQueryHitsIndicator 85028 attribute has a
cardinality of 0..1 85030 meaning that for each instance of the
ProcessingConditions 85020 entity there may be one
UnlimitedQueryHitsIndicator 85028 attribute. The
ReturnedQueryHitsNumberValue 85032 attribute has a cardinality of
0..1 85034 meaning that for each instance of the
ProcessingConditions 85020 entity there may be one
ReturnedQueryHitsNumberValue 85032 attribute. The
MoreElementsAvailablelndicator 85036 attribute has a cardinality of
0..1 85038 meaning that for each instance of the
ProcessingConditions 85020 entity there may be one
MoreElementsAvailablelndicator 85036 attribute. The
LastProvidedMaintenancePlanID 85040 attribute has a cardinality of
0..1 85042 meaning that for each instance of the
ProcessingConditions 85020 entity there may be one
LastProvidedMaintenancePlanID 85040 attribute.
[0750] The Log 85044 package includes a Log 85046 entity. The Log
85046 entity has a cardinality of 1 85048 meaning that for each
instance of the Log 85044 package there is one Log 85046 entity.
The data types of the various packages, entities, and attributes
are described with respect to FIG. 73.
[0751] FIGS. 86-1 through 86-8 show an example configuration of an
Element Structure that includes a MaintPlnERPUpdtReqMsg_s 86000
package. The MaintPlnERPUpdtReqMsg_s 86000 package includes a
MaintPlnERPUpdtReqMsg_s 86002 entity. The MaintPlnERPUpdtReqMsg_s
86000 package includes various packages, namely a MessageHeader
86004 and a MaintenancePlan 86010.
[0752] The MessageHeader 86004 package includes a MessageHeader
86006 entity. The MessageHeader 86006 entity has a cardinality of
0..1 86008 meaning that for each instance of the MessageHeader
86004 package there may be one MessageHeader 86006 entity.
[0753] The MaintenancePlan 86010 package includes a MaintenancePlan
86012 entity. The MaintenancePlan 86012 entity has a cardinality of
1 86014 meaning that for each instance of the MaintenancePlan 86010
package there is one MaintenancePlan 86012 entity. The
MaintenancePlan 86012 entity includes various attributes, namely an
ID 86016, a ChangeStateID 86020, a Description 86024 and a
TextCollection 86028. The MaintenancePlan 86012 entity includes
various subordinate entities, namely a SchedulingTerms 86032, a
Cycle 86092 and an Item 86128. The ID 86016 attribute has a
cardinality of 1 86018 meaning that for each instance of the
MaintenancePlan 86012 entity there is one ID 86016 attribute.
[0754] The ChangeStateID 86020 attribute has a cardinality of 1
86022 meaning that for each instance of the MaintenancePlan 86012
entity there is one ChangeStateID 86020 attribute. The Description
86024 attribute has a cardinality of 0..1 86026 meaning that for
each instance of the MaintenancePlan 86012 entity there may be one
Description 86024 attribute. The TextCollection 86028 attribute has
a cardinality of 0..1 86030 meaning that for each instance of the
MaintenancePlan 86012 entity there may be one TextCollection 86028
attribute.
[0755] The SchedulingTerms 86032 entity has a cardinality of 0..1
86034 meaning that for each instance of the MaintenancePlan 86012
entity there may be one SchedulingTerms 86032 entity. The
SchedulingTerms 86032 entity includes various attributes, namely a
StartDateTime 86036, a
MeasuringDeviceStartMeasurementReadingMeasure 86040, a
LateCompletionShiftPercent 86044, an EarlyCompletionShiftPercent
86048, a LateCompletionTolerencePercent 86052, an
EarlyCompletionTolerencePercent 86056, a WorkingDayCalendarCode
86060, a MaintenancePlanCycleQuantityModificationFactorValue 86064,
a BufferStartDaysNumberValue 86068, a CallHorizonPercent 86072, a
PredecessorCompletionRequiredIndicator 86076, a SchedulingDuration
86080, a SchedulingCategoryCode 86084 and a
CycleDependencyIndicator 86088. The StartDateTime 86036 attribute
has a cardinality of 0..1 86038 meaning that for each instance of
the SchedulingTerms 86032 entity there may be one StartDateTime
86036 attribute.
[0756] The MeasuringDeviceStartMeasurementReadingMeasure 86040
attribute has a cardinality of 0..1 86042 meaning that for each
instance of the SchedulingTerms 86032 entity there may be one
MeasuringDeviceStartMeasurementReadingMeasure 86040 attribute. The
LateCompletionShiftPercent 86044 attribute has a cardinality of
0..1 86046 meaning that for each instance of the SchedulingTerms
86032 entity there may be one LateCompletionShiftPercent 86044
attribute. The EarlyCompletionShiftPercent 86048 attribute has a
cardinality of 0..1 86050 meaning that for each instance of the
SchedulingTerms 86032 entity there may be one
EarlyCompletionShiftPercent 86048 attribute.
[0757] The LateCompletionTolerencePercent 86052 attribute has a
cardinality of 0..1 86054 meaning that for each instance of the
SchedulingTerms 86032 entity there may be one
LateCompletionTolerencePercent 86052 attribute. The
EarlyCompletionTolerencePercent 86056 attribute has a cardinality
of 0..1 86058 meaning that for each instance of the SchedulingTerms
86032 entity there may be one EarlyCompletionTolerencePercent 86056
attribute. The WorkingDayCalendarCode 86060 attribute has a
cardinality of 0..1 86062 meaning that for each instance of the
SchedulingTerms 86032 entity there may be one
WorkingDayCalendarCode 86060 attribute. The
MaintenancePlanCycleQuantityModificationFactorValue 86064 attribute
has a cardinality of 0..1 86066 meaning that for each instance of
the SchedulingTerms 86032 entity there may be one
MaintenancePlanCycleQuantityModificationFactorValue 86064
attribute. The BufferStartDaysNumberValue 86068 attribute has a
cardinality of 0..1 86070 meaning that for each instance of the
SchedulingTerms 86032 entity there may be one
BufferStartDaysNumberValue 86068 attribute.
[0758] The CallHorizonPercent 86072 attribute has a cardinality of
0..1 86074 meaning that for each instance of the SchedulingTerms
86032 entity there may be one CallHorizonPercent 86072 attribute.
The PredecessorCompletionRequiredIndicator 86076 attribute has a
cardinality of 0..1 86078 meaning that for each instance of the
SchedulingTerms 86032 entity there may be one
PredecessorCompletionRequiredIndicator 86076 attribute. The
SchedulingDuration 86080 attribute has a cardinality of 0..1 86082
meaning that for each instance of the SchedulingTerms 86032 entity
there may be one SchedulingDuration 86080 attribute. The
SchedulingCategoryCode 86084 attribute has a cardinality of 0..1
86086 meaning that for each instance of the SchedulingTerms 86032
entity there may be one SchedulingCategoryCode 86084 attribute. The
CycleDependencyIndicator 86088 attribute has a cardinality of 0..1
86090 meaning that for each instance of the SchedulingTerms 86032
entity there may be one CycleDependencyIndicator 86088
attribute.
[0759] The Cycle 86092 entity has a cardinality of 0..n 86094
meaning that for each instance of the MaintenancePlan 86012 entity
there may be one or more Cycle 86092 entities. The Cycle 86092
entity includes various attributes, namely a @actionCode 86096, a
CounterValue 86100, a GroupSequenceNumberValue 86104, a
GroupSequenceRepetitionNumberValue 86108, a Quantity 86112, a
StartOffsetQuantity 86116, a MeasuringDeviceID 86120 and a
Description 86124. The @actionCode 86096 attribute has a
cardinality of 1 86098 meaning that for each instance of the Cycle
86092 entity there is one @actionCode 86096 attribute. The
CounterValue 86100 attribute has a cardinality of 1 86102 meaning
that for each instance of the Cycle 86092 entity there is one
CounterValue 86100 attribute. The GroupSequenceNumberValue 86104
attribute has a cardinality of 0..1 86106 meaning that for each
instance of the Cycle 86092 entity there may be one
GroupSequenceNumberValue 86104 attribute.
[0760] The GroupSequenceRepetitionNumberValue 86108 attribute has a
cardinality of 0..1 86110 meaning that for each instance of the
Cycle 86092 entity there may be one
GroupSequenceRepetitionNumberValue 86108 attribute. The Quantity
86112 attribute has a cardinality of 0..1 86114 meaning that for
each instance of the Cycle 86092 entity there may be one Quantity
86112 attribute. The StartOffsetQuantity 86116 attribute has a
cardinality of 0..1 86118 meaning that for each instance of the
Cycle 86092 entity there may be one StartOffsetQuantity 86116
attribute. The MeasuringDeviceID 86120 attribute has a cardinality
of 0..1 86122 meaning that for each instance of the Cycle 86092
entity there may be one MeasuringDeviceID 86120 attribute. The
Description 86124 attribute has a cardinality of 0..1 86126 meaning
that for each instance of the Cycle 86092 entity there may be one
Description 86124 attribute.
[0761] The Item 86128 entity has a cardinality of 0..n 86130
meaning that for each instance of the MaintenancePlan 86012 entity
there may be one or more Item 86128 entities. The Item 86128 entity
includes various attributes, namely a @actionCode 86132, an ID
86136, a CycleGroupSequenceNumberValue 86140, a
BusinessTransactionDocumentProcessingTypeCode 86144, a
BusinessTransactionDocumentReference 86148, a WorkCentreID 86152, a
MaintenancePlanningPlantID 86156, a MaintenancePlannerGroupCode
86160, an ImportanceCode 86164, a MaintenanceTaskListID 86168, a
BusinessTransactionDocumentGroupID 86172, a BusinessObjectTypeCode
86176, a WorkCentrePlantID 86180, a Description 86184 and a
TextCollection 86188. The Item 86128 entity includes an
ObjectReference 86192 subordinate entity. The @actionCode 86132
attribute has a cardinality of 1 86134 meaning that for each
instance of the Item 86128 entity there is one @actionCode 86132
attribute. The ID 86136 attribute has a cardinality of 0..1 86138
meaning that for each instance of the Item 86128 entity there may
be one ID 86136 attribute. The CycleGroupSequenceNumberValue 86140
attribute has a cardinality of 0..1 86142 meaning that for each
instance of the Item 86128 entity there may be one
CycleGroupSequenceNumberValue 86140 attribute.
[0762] The BusinessTransactionDocumentProcessingTypeCode 86144
attribute has a cardinality of 0..1 86146 meaning that for each
instance of the Item 86128 entity there may be one
BusinessTransactionDocumentProcessingTypeCode 86144 attribute. The
BusinessTransactionDocumentReference 86148 attribute has a
cardinality of 0..1 86150 meaning that for each instance of the
Item 86128 entity there may be one
BusinessTransactionDocumentReference 86148 attribute. The
WorkCentreID 86152 attribute has a cardinality of 0..1 86154
meaning that for each instance of the Item 86128 entity there may
be one WorkCentreID 86152 attribute. The MaintenancePlanningPlantID
86156 attribute has a cardinality of 0..1 86158 meaning that for
each instance of the Item 86128 entity there may be one
MaintenancePlanningPlantID 86156 attribute. The
MaintenancePlannerGroupCode 86160 attribute has a cardinality of
0..1 86162 meaning that for each instance of the Item 86128 entity
there may be one MaintenancePlannerGroupCode 86160 attribute.
[0763] The ImportanceCode 86164 attribute has a cardinality of 0..1
86166 meaning that for each instance of the Item 86128 entity there
may be one ImportanceCode 86164 attribute. The
MaintenanceTaskListID 86168 attribute has a cardinality of 0..1
86170 meaning that for each instance of the Item 86128 entity there
may be one MaintenanceTaskListID 86168 attribute. The
BusinessTransactionDocumentGroupID 86172 attribute has a
cardinality of 0..1 86174 meaning that for each instance of the
Item 86128 entity there may be one
BusinessTransactionDocumentGroupID 86172 attribute. The
BusinessObjectTypeCode 86176 attribute has a cardinality of 0..1
86178 meaning that for each instance of the Item 86128 entity there
may be one BusinessObjectTypeCode 86176 attribute. The
WorkCentrePlantID 86180 attribute has a cardinality of 0..1 86182
meaning that for each instance of the Item 86128 entity there may
be one WorkCentrePlantID 86180 attribute. The Description 86184
attribute has a cardinality of 0..1 86186 meaning that for each
instance of the Item 86128 entity there may be one Description
86184 attribute. The TextCollection 86188 attribute has a
cardinality of 0..1 86190 meaning that for each instance of the
Item 86128 entity there may be one TextCollection 86188
attribute.
[0764] The ObjectReference 86192 entity has a cardinality of 0..n
86194 meaning that for each instance of the Item 86128 entity there
may be one or more ObjectReference 86192 entities. The
ObjectReference 86192 entity includes various attributes, namely a
@actionCode 86196, an OrdinalNumberValue 86200, a MainIndicator
86204, a SerialID 86208, a MaterialInternalID 86212, an
IndividualMaterialID 86216 and an InstallationPointID 86220. The
@actionCode 86196 attribute has a cardinality of 1 86198 meaning
that for each instance of the ObjectReference 86192 entity there is
one @actionCode 86196 attribute. The OrdinalNumberValue 86200
attribute has a cardinality of 0..1 86202 meaning that for each
instance of the ObjectReference 86192 entity there may be one
OrdinalNumberValue 86200 attribute.
[0765] The MainIndicator 86204 attribute has a cardinality of 1
86206 meaning that for each instance of the ObjectReference 86192
entity there is one MainIndicator 86204 attribute. The SerialID
86208 attribute has a cardinality of 0..1 86210 meaning that for
each instance of the ObjectReference 86192 entity there may be one
SerialID 86208 attribute. The MaterialInternalID 86212 attribute
has a cardinality of 0..1 86214 meaning that for each instance of
the ObjectReference 86192 entity there may be one
MaterialInternalID 86212 attribute. The IndividualMaterialID 86216
attribute has a cardinality of 0..1 86218 meaning that for each
instance of the ObjectReference 86192 entity there may be one
IndividualMaterialID 86216 attribute. The InstallationPointID 86220
attribute has a cardinality of 0..1 86222 meaning that for each
instance of the ObjectReference 86192 entity there may be one
InstallationPointID 86220 attribute. The data types of the various
packages, entities, and attributes are described with respect to
FIG. 73.
[0766] FIG. 87 shows an example configuration of an Element
Structure that includes a MaintPlnERPUpdtConfMsg_s 87000 package.
The MaintPlnERPUpdtConfMsg_s 87000 package includes a
MaintPlnERPUpdtConfMsg_s 87002 entity. The MaintPlnERPUpdtConfMsg_s
87000 package includes various packages, namely a MessageHeader
87004, a MaintenancePlan 87010 and a Log 87020.
[0767] The MessageHeader 87004 package includes a MessageHeader
87006 entity. The MessageHeader 87006 entity has a cardinality of
0..1 87008 meaning that for each instance of the MessageHeader
87004 package there may be one MessageHeader 87006 entity.
[0768] The MaintenancePlan 87010 package includes a MaintenancePlan
87012 entity. The MaintenancePlan 87012 entity has a cardinality of
0..1 87014 meaning that for each instance of the MaintenancePlan
87010 package there may be one MaintenancePlan 87012 entity. The
MaintenancePlan 87012 entity includes an ID 87016 attribute. The ID
87016 attribute has a cardinality of 1 87018 meaning that for each
instance of the MaintenancePlan 87012 entity there is one ID 87016
attribute.
[0769] The Log 87020 package includes a Log 87022 entity. The Log
87022 entity has a cardinality of 1 87024 meaning that for each
instance of the Log 87020 package there is one Log 87022 entity.
The data types of the various packages, entities, and attributes
are described with respect to FIG. 73.
[0770] FIGS. 88-1 through 88-8 show an example configuration of an
Element Structure that includes a MaintPlnERPCrteCkQryMsg_s 88000
package. The MaintPlnERPCrteCkQryMsg_s 88000 package includes a
MaintPlnERPCrteCkQryMsg_s 88002 entity. The
MaintPlnERPCrteCkQryMsg_s 88000 package includes a MaintenancePlan
88004 package.
[0771] The MaintenancePlan 88004 package includes a MaintenancePlan
88006 entity. The MaintenancePlan 88006 entity has a cardinality of
1 88008 meaning that for each instance of the MaintenancePlan 88004
package there is one MaintenancePlan 88006 entity. The
MaintenancePlan 88006 entity includes various attributes, namely a
CategoryCode 88010, a Description 88014 and a TextCollection 88018.
The MaintenancePlan 88006 entity includes various subordinate
entities, namely a SchedulingTerms 88022, a Cycle 88082 and an Item
88114. The CategoryCode 88010 attribute has a cardinality of 1
88012 meaning that for each instance of the MaintenancePlan 88006
entity there is one CategoryCode 88010 attribute. The Description
88014 attribute has a cardinality of 1 88016 meaning that for each
instance of the MaintenancePlan 88006 entity there is one
Description 88014 attribute. The TextCollection 88018 attribute has
a cardinality of 0..1 88020 meaning that for each instance of the
MaintenancePlan 88006 entity there may be one TextCollection 88018
attribute.
[0772] The SchedulingTerms 88022 entity has a cardinality of 0..1
88024 meaning that for each instance of the MaintenancePlan 88006
entity there may be one SchedulingTerms 88022 entity. The
SchedulingTerms 88022 entity includes various attributes, namely a
StartDateTime 88026, a
MeasuringDeviceStartMeasurementReadingMeasure 88030, a
LateCompletionShiftPercent 88034, an EarlyCompletionShiftPercent
88038, a LateCompletionTolerencePercent 88042, a
WorkingDayCalendarCode 88046, an EarlyCompletionTolerencePercent
88050, a MaintenancePlanCycleQuantityModificationFactorValue 88054,
a BufferStartDaysNumberValue 88058, a CallHorizonPercent 88062, a
PredecessorCompletionRequiredIndicator 88066, a SchedulingDuration
88070, a SchedulingCategoryCode 88074 and a
CycleDependencylndicator 88078. The StartDateTime 88026 attribute
has a cardinality of 0..1 88028 meaning that for each instance of
the SchedulingTerms 88022 entity there may be one StartDateTime
88026 attribute.
[0773] The MeasuringDeviceStartMeasurementReadingMeasure 88030
attribute has a cardinality of 0..1 88032 meaning that for each
instance of the SchedulingTerms 88022 entity there may be one
MeasuringDeviceStartMeasurementReadingMeasure 88030 attribute. The
LateCompletionShiftPercent 88034 attribute has a cardinality of
0..1 88036 meaning that for each instance of the SchedulingTerms
88022 entity there may be one LateCompletionShiftPercent 88034
attribute. The EarlyCompletionShiftPercent 88038 attribute has a
cardinality of 0..1 88040 meaning that for each instance of the
SchedulingTerms 88022 entity there may be one
EarlyCompletionShiftPercent 88038 attribute.
[0774] The LateCompletionTolerencePercent 88042 attribute has a
cardinality of 0..1 88044 meaning that for each instance of the
SchedulingTerms 88022 entity there may be one
LateCompletionTolerencePercent 88042 attribute. The
WorkingDayCalendarCode 88046 attribute has a cardinality of 0..1
88048 meaning that for each instance of the SchedulingTerms 88022
entity there may be one WorkingDayCalendarCode 88046 attribute. The
EarlyCompletionTolerencePercent 88050 attribute has a cardinality
of 0..1 88052 meaning that for each instance of the SchedulingTerms
88022 entity there may be one EarlyCompletionTolerencePercent 88050
attribute. The MaintenancePlanCycleQuantityModificationFactorValue
88054 attribute has a cardinality of 0..1 88056 meaning that for
each instance of the SchedulingTerms 88022 entity there may be one
MaintenancePlanCycleQuantityModificationFactorValue 88054
attribute.
[0775] The BufferStartDaysNumberValue 88058 attribute has a
cardinality of 0..1 88060 meaning that for each instance of the
SchedulingTerms 88022 entity there may be one
BufferStartDaysNumberValue 88058 attribute. The CallHorizonPercent
88062 attribute has a cardinality of 0..1 88064 meaning that for
each instance of the SchedulingTerms 88022 entity there may be one
CallHorizonPercent 88062 attribute. The
PredecessorCompletionRequiredIndicator 88066 attribute has a
cardinality of 0..1 88068 meaning that for each instance of the
SchedulingTerms 88022 entity there may be one
PredecessorCompletionRequiredIndicator 88066 attribute.
[0776] The SchedulingDuration 88070 attribute has a cardinality of
0..1 88072 meaning that for each instance of the SchedulingTerms
88022 entity there may be one SchedulingDuration 88070 attribute.
The SchedulingCategoryCode 88074 attribute has a cardinality of
0..1 88076 meaning that for each instance of the SchedulingTerms
88022 entity there may be one SchedulingCategoryCode 88074
attribute. The CycleDependencyIndicator 88078 attribute has a
cardinality of 0..1 88080 meaning that for each instance of the
SchedulingTerms 88022 entity there may be one
CycleDependencyIndicator 88078 attribute.
[0777] The Cycle 88082 entity has a cardinality of 0..n 88084
meaning that for each instance of the MaintenancePlan 88006 entity
there may be one or more Cycle 88082 entities. The Cycle 88082
entity includes various attributes, namely a CounterValue 88086, a
GroupSequenceNumberValue 88090, a
GroupSequenceRepetitionNumberValue 88094, a Quantity 88098, a
StartOffsetQuantity 88102, a MeasuringDeviceID 88106 and a
Description 88110. The CounterValue 88086 attribute has a
cardinality of 1 88088 meaning that for each instance of the Cycle
88082 entity there is one CounterValue 88086 attribute. The
GroupSequenceNumberValue 88090 attribute has a cardinality of 0..1
88092 meaning that for each instance of the Cycle 88082 entity
there may be one GroupSequenceNumberValue 88090 attribute.
[0778] The GroupSequenceRepetitionNumberValue 88094 attribute has a
cardinality of 0..1 88096 meaning that for each instance of the
Cycle 88082 entity there may be one
GroupSequenceRepetitionNumberValue 88094 attribute. The Quantity
88098 attribute has a cardinality of 1 88100 meaning that for each
instance of the Cycle 88082 entity there is one Quantity 88098
attribute. The StartOffsetQuantity 88102 attribute has a
cardinality of 0..1 88104 meaning that for each instance of the
Cycle 88082 entity there may be one StartOffsetQuantity 88102
attribute. The MeasuringDeviceID 88106 attribute has a cardinality
of 1 88108 meaning that for each instance of the Cycle 88082 entity
there is one MeasuringDeviceID 88106 attribute. The Description
88110 attribute has a cardinality of 0..1 88112 meaning that for
each instance of the Cycle 88082 entity there may be one
Description 88110 attribute.
[0779] The Item 88114 entity has a cardinality of 1..N 88116
meaning that for each instance of the MaintenancePlan 88006 entity
there are one or more Item 88114 entities. The Item 88114 entity
includes various attributes, namely an OrdinalNumberValue 88118, a
CycleGroupSequenceNumberValue 88122, a
BusinessTransactionDocumentProcessingTypeCode 88126, a WorkCentreID
88130, a WorkCentrePlantID 88134, a MaintenancePlanningPlantID
88138, a MaintenancePlannerGroupCode 88142, an ImportanceCode
88146, a MaintenanceTaskListID 88150, a
BusinessTransactionDocumentGroupID 88154, a BusinessObjectTypeCode
88158, a BusinessTransactionDocumentReference 88162, a Description
88166 and a TextCollection 88170. The Item 88114 entity includes an
ObjectReference 88174 subordinate entity. The OrdinalNumberValue
88118 attribute has a cardinality of 1 88120 meaning that for each
instance of the Item 88114 entity there is one OrdinalNumberValue
88118 attribute.
[0780] The CycleGroupSequenceNumberValue 88122 attribute has a
cardinality of 0..1 88124 meaning that for each instance of the
Item 88114 entity there may be one CycleGroupSequenceNumberValue
88122 attribute. The BusinessTransactionDocumentProcessingTypeCode
88126 attribute has a cardinality of 1 88128 meaning that for each
instance of the Item 88114 entity there is one
BusinessTransactionDocumentProcessingTypeCode 88126 attribute. The
WorkCentreID 88130 attribute has a cardinality of 1 88132 meaning
that for each instance of the Item 88114 entity there is one
WorkCentreID 88130 attribute. The WorkCentrePlantID 88134 attribute
has a cardinality of 1 88136 meaning that for each instance of the
Item 88114 entity there is one WorkCentrePlantID 88134 attribute.
The MaintenancePlanningPlantID 88138 attribute has a cardinality of
1 88140 meaning that for each instance of the Item 88114 entity
there is one MaintenancePlanningPlantID 88138 attribute.
[0781] The MaintenancePlannerGroupCode 88142 attribute has a
cardinality of 0..1 88144 meaning that for each instance of the
Item 88114 entity there may be one MaintenancePlannerGroupCode
88142 attribute. The ImportanceCode 88146 attribute has a
cardinality of 0..1 88148 meaning that for each instance of the
Item 88114 entity there may be one ImportanceCode 88146 attribute.
The MaintenanceTaskListID 88150 attribute has a cardinality of 0..1
88152 meaning that for each instance of the Item 88114 entity there
may be one MaintenanceTaskListID 88150 attribute. The
BusinessTransactionDocumentGroupID 88154 attribute has a
cardinality of 0..1 88156 meaning that for each instance of the
Item 88114 entity there may be one
BusinessTransactionDocumentGroupID 88154 attribute.
[0782] The BusinessObjectTypeCode 88158 attribute has a cardinality
of 0..1 88160 meaning that for each instance of the Item 88114
entity there may be one BusinessObjectTypeCode 88158 attribute. The
BusinessTransactionDocumentReference 88162 attribute has a
cardinality of 0..1 88164 meaning that for each instance of the
Item 88114 entity there may be one
BusinessTransactionDocumentReference 88162 attribute. The
Description 88166 attribute has a cardinality of 0..1 88168 meaning
that for each instance of the Item 88114 entity there may be one
Description 88166 attribute. The TextCollection 88170 attribute has
a cardinality of 0..1 88172 meaning that for each instance of the
Item 88114 entity there may be one TextCollection 88170
attribute.
[0783] The ObjectReference 88174 entity has a cardinality of 1..n
88176 meaning that for each instance of the Item 88114 entity there
are one or more ObjectReference 88174 entities. The ObjectReference
88174 entity includes various attributes, namely an
OrdinalNumberValue 88178, a MainIndicator 88182, a SerialID 88186,
a MaterialInternalID 88190, an IndividualMaterialID 88194 and an
InstallationPointID 88198. The OrdinalNumberValue 88178 attribute
has a cardinality of 1 88180 meaning that for each instance of the
ObjectReference 88174 entity there is one OrdinalNumberValue 88178
attribute. The MainIndicator 88182 attribute has a cardinality of 1
88184 meaning that for each instance of the ObjectReference 88174
entity there is one MainIndicator 88182 attribute.
[0784] The SerialID 88186 attribute has a cardinality of 0..1 88188
meaning that for each instance of the ObjectReference 88174 entity
there may be one SerialID 88186 attribute. The MaterialInternalID
88190 attribute has a cardinality of 0..1 88192 meaning that for
each instance of the ObjectReference 88174 entity there may be one
MaterialInternalID 88190 attribute. The IndividualMaterialID 88194
attribute has a cardinality of 0..1 88196 meaning that for each
instance of the ObjectReference 88174 entity there may be one
IndividualMaterialID 88194 attribute. The InstallationPointID 88198
attribute has a cardinality of 0..1 88200 meaning that for each
instance of the ObjectReference 88174 entity there may be one
InstallationPointID 88198 attribute. The data types of the various
packages, entities, and attributes are described with respect to
FIG. 73.
[0785] FIG. 89 shows an example configuration of an Element
Structure that includes a MaintPlnERPCrteCkRspMsg_s 89000 package.
The MaintPlnERPCrteCkRspMsg_s 89000 package includes a
MaintPlnERPCrteCkRspMsg_s 89002 entity. The
MaintPlnERPCrteCkRspMsg_s 89000 package includes a Log 89004
package.
[0786] The Log 89004 package includes a Log 89006 entity. The Log
89006 entity has a cardinality of 1 89008 meaning that for each
instance of the Log 89004 package there is one Log 89006 entity.
The data types of the various packages, entities, and attributes
are described with respect to FIG. 73.
[0787] FIGS. 90-1 through 90-2 show an example configuration of an
Element Structure that includes a MaintPlnERPItmElmntsQryMsg_s
90000 package. The MaintPlnERPItmElmntsQryMsg_s 90000 package
includes a MaintPlnERPItmElmntsQryMsg_s 90002 entity. The
MaintPlnERPItmElmntsQryMsg_s 90000 package includes various
packages, namely a Selection 90004, and a ProcessingConditions
90034.
[0788] The Selection 90004 package includes a
MaintenancePlanItemSelectionByElements 90006 entity. The
MaintenancePlanItemSelectionByElements 90006 entity has a
cardinality of 1 90008 meaning that for each instance of the
Selection 90004 package there is one
MaintenancePlanItemSelectionByElements 90006 entity. The
MaintenancePlanItemSelectionByElements 90006 entity includes
various attributes, namely a CategoryCode 90010, a
MaintenancePlannerGroupCode 90014, a MaintenancePlanID 90018, a
MaterialInternalID 90022, an IndividualMaterialID 90026 and an
InstallationPointID 90030. The CategoryCode 90010 attribute has a
cardinality of 0..1 90012 meaning that for each instance of the
MaintenancePlanItemSelectionByElements 90006 entity there may be
one CategoryCode 90010 attribute.
[0789] The MaintenancePlannerGroupCode 90014 attribute has a
cardinality of 0..1 90016 meaning that for each instance of the
MaintenancePlanItemSelectionByElements 90006 entity there may be
one MaintenancePlannerGroupCode 90014 attribute. The
MaintenancePlanID 90018 attribute has a cardinality of 0..1 90020
meaning that for each instance of the
MaintenancePlanItemSelectionByElements 90006 entity there may be
one MaintenancePlanID 90018 attribute. The MaterialInternalID 90022
attribute has a cardinality of 0..1 90024 meaning that for each
instance of the MaintenancePlanItemSelectionByElements 90006 entity
there may be one MaterialInternalID 90022 attribute. The
IndividualMaterialID 90026 attribute has a cardinality of 0..1
90028 meaning that for each instance of the
MaintenancePlanItemSelectionByElements 90006 entity there may be
one IndividualMaterialID 90026 attribute. The InstallationPointID
90030 attribute has a cardinality of 0..1 90032 meaning that for
each instance of the MaintenancePlanItemSelectionByElements 90006
entity there may be one InstallationPointID 90030 attribute.
[0790] The ProcessingConditions 90034 package includes a
ProcessingConditions 90036 entity. The ProcessingConditions 90036
entity has a cardinality of 0..1 90038 meaning that for each
instance of the ProcessingConditions 90034 package there may be one
ProcessingConditions 90036 entity. The ProcessingConditions 90036
entity includes various attributes, namely a
QueryHitsMaximumNumberValue 90040, an UnlimitedQueryHitsIndicator
90044, a ReturnedQueryHitsNumberValue 90048, a
MoreElementsAvailablelndicator 90052 and a LastProvidedItemID
90056. The QueryHitsMaximumNumberValue 90040 attribute has a
cardinality of 0..1 90042 meaning that for each instance of the
ProcessingConditions 90036 entity there may be one
QueryHitsMaximumNumberValue 90040 attribute.
[0791] The UnlimitedQueryHitsIndicator 90044 attribute has a
cardinality of 0..1 90046 meaning that for each instance of the
ProcessingConditions 90036 entity there may be one
UnlimitedQueryHitsIndicator 90044 attribute. The
ReturnedQueryHitsNumberValue 90048 attribute has a cardinality of
0..1 90050 meaning that for each instance of the
ProcessingConditions 90036 entity there may be one
ReturnedQueryHitsNumberValue 90048 attribute. The
MoreElementsAvailablelndicator 90052 attribute has a cardinality of
0..1 90054 meaning that for each instance of the
ProcessingConditions 90036 entity there may be one
MoreElementsAvailablelndicator 90052 attribute. The
LastProvidedItemID 90056 attribute has a cardinality of 0..1 90058
meaning that for each instance of the ProcessingConditions 90036
entity there may be one LastProvidedItemID 90056 attribute. The
data types of the various packages, entities, and attributes are
described with respect to FIG. 73.
[0792] FIGS. 91-1 through 91-2 show an example configuration of an
Element Structure that includes a MaintPlnERPItmElmntsRspMsg_s
91000 package. The MaintPlnERPItmElmntsRspMsg_s 91000 package
includes a MaintPlnERPItmElmntsRspMsg_s 91002 entity. The
MaintPlnERPItmElmntsRspMsg_s 91000 package includes various
packages, namely a MaintenancePlanItem 91004, and a Log 91054.
[0793] The MaintenancePlanItem 91004 package includes various
entities, namely a MaintenancePlan 91006 and a ProcessingConditions
91030. The MaintenancePlan 91006 entity has a cardinality of 0..n
91008 meaning that for each instance of the MaintenancePlanItem
91004 package there may be one or more MaintenancePlan 91006
entities. The MaintenancePlan 91006 entity includes various
attributes, namely an ID 91010 and a Description 91014. The
MaintenancePlan 91006 entity includes an Item 91018 subordinate
entity. The ID 91010 attribute has a cardinality of 1 91012 meaning
that for each instance of the MaintenancePlan 91006 entity there is
one ID 91010 attribute.
[0794] The Description 91014 attribute has a cardinality of 0..1
91016 meaning that for each instance of the MaintenancePlan 91006
entity there may be one Description 91014 attribute. The Item 91018
entity has a cardinality of 1 91020 meaning that for each instance
of the MaintenancePlan 91006 entity there is one Item 91018 entity.
The Item 91018 entity includes various attributes, namely an ID
91022 and a Description 91026. The ID 91022 attribute has a
cardinality of 1 91024 meaning that for each instance of the Item
91018 entity there is one ID 91022 attribute. The Description 91026
attribute has a cardinality of 0..1 91028 meaning that for each
instance of the Item 91018 entity there may be one Description
91026 attribute.
[0795] The ProcessingConditions 91030 entity has a cardinality of
0..1 91032 meaning that for each instance of the
MaintenancePlanItem 91004 package there may be one
ProcessingConditions 91030 entity. The ProcessingConditions 91030
entity includes various attributes, namely a
QueryHitsMaximumNumberValue 91034, an UnlimitedQueryHitsIndicator
91038, a ReturnedQueryHitsNumberValue 91042, a
MoreElementsAvailablelndicator 91046 and a LastProvidedItemID
91050. The QueryHitsMaximumNumberValue 91034 attribute has a
cardinality of 0..1 91036 meaning that for each instance of the
ProcessingConditions 91030 entity there may be one
QueryHitsMaximumNumberValue 91034 attribute.
[0796] The UnlimitedQueryHitsIndicator 91038 attribute has a
cardinality of 0..1 91040 meaning that for each instance of the
ProcessingConditions 91030 entity there may be one
UnlimitedQueryHitsIndicator 91038 attribute. The
ReturnedQueryHitsNumberValue 91042 attribute has a cardinality of
0..1 91044 meaning that for each instance of the
ProcessingConditions 91030 entity there may be one
ReturnedQueryHitsNumberValue 91042 attribute. The
MoreElementsAvailablelndicator 91046 attribute has a cardinality of
0..1 91048 meaning that for each instance of the
ProcessingConditions 91030 entity there may be one
MoreElementsAvailablelndicator 91046 attribute. The
LastProvidedItemID 91050 attribute has a cardinality of 0..1 91052
meaning that for each instance of the ProcessingConditions 91030
entity there may be one LastProvidedItemID 91050 attribute.
[0797] The Log 91054 package includes a Log 91056 entity. The Log
91056 entity has a cardinality of 1 91058 meaning that for each
instance of the Log 91054 package there is one Log 91056 entity.
The data types of the various packages, entities, and attributes
are described with respect to FIG. 73.
[0798] FIGS. 92-1 through 92-8 show an example configuration of an
Element Structure that includes a MaintPlnERPUpdtCkQryMsg_s 92000
package. The MaintPlnERPUpdtCkQryMsg_s 92000 package includes a
MaintPlnERPUpdtCkQryMsg_s 92002 entity. The
MaintPlnERPUpdtCkQryMsg_s 92000 package includes a MaintenancePlan
92004 package.
[0799] The MaintenancePlan 92004 package includes a MaintenancePlan
92006 entity. The MaintenancePlan 92006 entity has a cardinality of
1 92008 meaning that for each instance of the MaintenancePlan 92004
package there is one MaintenancePlan 92006 entity. The
MaintenancePlan 92006 entity includes various attributes, namely an
ID 92010, a ChangeStateID 92014, a Description 92018 and a
TextCollection 92022. The MaintenancePlan 92006 entity includes
various subordinate entities, namely a SchedulingTerms 92026, a
Cycle 92086 and an Item 92122. The ID 92010 attribute has a
cardinality of 1 92012 meaning that for each instance of the
MaintenancePlan 92006 entity there is one ID 92010 attribute.
[0800] The ChangeStateID 92014 attribute has a cardinality of 1
92016 meaning that for each instance of the MaintenancePlan 92006
entity there is one ChangeStateID 92014 attribute. The Description
92018 attribute has a cardinality of 0..1 92020 meaning that for
each instance of the MaintenancePlan 92006 entity there may be one
Description 92018 attribute. The TextCollection 92022 attribute has
a cardinality of 0..1 92024 meaning that for each instance of the
MaintenancePlan 92006 entity there may be one TextCollection 92022
attribute.
[0801] The SchedulingTerms 92026 entity has a cardinality of 0..1
92028 meaning that for each instance of the MaintenancePlan 92006
entity there may be one SchedulingTerms 92026 entity. The
SchedulingTerms 92026 entity includes various attributes, namely a
StartDateTime 92030, a
MeasuringDeviceStartMeasurementReadingMeasure 92034, a
LateCompletionShiftPercent 92038, an EarlyCompletionShiftPercent
92042, a LateCompletionTolerencePercent 92046, a
WorkingDayCalendarCode 92050, an EarlyCompletionTolerencePercent
92054, a MaintenancePlanCycleQuantityModificationFactorValue 92058,
a BufferStartDaysNumberValue 92062, a CallHorizonPercent 92066, a
PredecessorCompletionRequiredIndicator 92070, a SchedulingDuration
92074, a SchedulingCategoryCode 92078 and a
CycleDependencyIndicator 92082. The StartDateTime 92030 attribute
has a cardinality of 0..1 92032 meaning that for each instance of
the SchedulingTerms 92026 entity there may be one StartDateTime
92030 attribute.
[0802] The MeasuringDeviceStartMeasurementReadingMeasure 92034
attribute has a cardinality of 0..1 92036 meaning that for each
instance of the SchedulingTerms 92026 entity there may be one
MeasuringDeviceStartMeasurementReadingMeasure 92034 attribute. The
LateCompletionShiftPercent 92038 attribute has a cardinality of
0..1 92040 meaning that for each instance of the SchedulingTerms
92026 entity there may be one LateCompletionShiftPercent 92038
attribute. The EarlyCompletionShiftPercent 92042 attribute has a
cardinality of 0..1 92044 meaning that for each instance of the
SchedulingTerms 92026 entity there may be one
EarlyCompletionShiftPercent 92042 attribute. The
LateCompletionTolerencePercent 92046 attribute has a cardinality of
0..1 92048 meaning that for each instance of the SchedulingTerms
92026 entity there may be one LateCompletionTolerencePercent 92046
attribute.
[0803] The WorkingDayCalendarCode 92050 attribute has a cardinality
of 0..1 92052 meaning that for each instance of the SchedulingTerms
92026 entity there may be one WorkingDayCalendarCode 92050
attribute. The EarlyCompletionTolerencePercent 92054 attribute has
a cardinality of 0..1 92056 meaning that for each instance of the
SchedulingTerms 92026 entity there may be one
EarlyCompletionTolerencePercent 92054 attribute. The
MaintenancePlanCycleQuantityModificationFactorValue 92058 attribute
has a cardinality of 0..1 92060 meaning that for each instance of
the SchedulingTerms 92026 entity there may be one
MaintenancePlanCycleQuantityModificationFactorValue 92058
attribute. The BufferStartDaysNumberValue 92062 attribute has a
cardinality of 0..1 92064 meaning that for each instance of the
SchedulingTerms 92026 entity there may be one
BufferStartDaysNumberValue 92062 attribute. The CallHorizonPercent
92066 attribute has a cardinality of 0..1 92068 meaning that for
each instance of the SchedulingTerms 92026 entity there may be one
CallHorizonPercent 92066 attribute.
[0804] The PredecessorCompletionRequiredIndicator 92070 attribute
has a cardinality of 0..1 92072 meaning that for each instance of
the SchedulingTerms 92026 entity there may be one
PredecessorCompletionRequiredIndicator 92070 attribute. The
SchedulingDuration 92074 attribute has a cardinality of 0..1 92076
meaning that for each instance of the SchedulingTerms 92026 entity
there may be one SchedulingDuration 92074 attribute. The
SchedulingCategoryCode 92078 attribute has a cardinality of 0..1
92080 meaning that for each instance of the SchedulingTerms 92026
entity there may be one SchedulingCategoryCode 92078 attribute. The
CycleDependencyIndicator 92082 attribute has a cardinality of 0..1
92084 meaning that for each instance of the SchedulingTerms 92026
entity there may be one CycleDependencyIndicator 92082
attribute.
[0805] The Cycle 92086 entity has a cardinality of 0..n 92088
meaning that for each instance of the MaintenancePlan 92006 entity
there may be one or more Cycle 92086 entities. The Cycle 92086
entity includes various attributes, namely a @actionCode 92090, a
CounterValue 92094, a GroupSequenceNumberValue 92098, a
GroupSequenceRepetitionNumberValue 92102, a Quantity 92106, a
StartOffsetQuantity 92110, a MeasuringDeviceID 92114 and a
Description 92118. The @actionCode 92090 attribute has a
cardinality of 1 92092 meaning that for each instance of the Cycle
92086 entity there is one @actionCode 92090 attribute. The
CounterValue 92094 attribute has a cardinality of 1 92096 meaning
that for each instance of the Cycle 92086 entity there is one
CounterValue 92094 attribute. The GroupSequenceNumberValue 92098
attribute has a cardinality of 0..1 92100 meaning that for each
instance of the Cycle 92086 entity there may be one
GroupSequenceNumberValue 92098 attribute.
[0806] The GroupSequenceRepetitionNumberValue 92102 attribute has a
cardinality of 0..1 92104 meaning that for each instance of the
Cycle 92086 entity there may be one
GroupSequenceRepetitionNumberValue 92102 attribute. The Quantity
92106 attribute has a cardinality of 0..1 92108 meaning that for
each instance of the Cycle 92086 entity there may be one Quantity
92106 attribute. The StartOffsetQuantity 92110 attribute has a
cardinality of 0..1 92112 meaning that for each instance of the
Cycle 92086 entity there may be one StartOffsetQuantity 92110
attribute. The MeasuringDeviceID 92114 attribute has a cardinality
of 0..1 92116 meaning that for each instance of the Cycle 92086
entity there may be one MeasuringDeviceID 92114 attribute. The
Description 92118 attribute has a cardinality of 0..1 92120 meaning
that for each instance of the Cycle 92086 entity there may be one
Description 92118 attribute.
[0807] The Item 92122 entity has a cardinality of 0..n 92124
meaning that for each instance of the MaintenancePlan 92006 entity
there may be one or more Item 92122 entities. The Item 92122 entity
includes various attributes, namely a @actionCode 92126, an ID
92130, a CycleGroupSequenceNumberValue 92134, a
BusinessTransactionDocumentProcessingTypeCode 92138, a
BusinessTransactionDocumentReference 92142, a WorkCentreID 92146, a
WorkCentrePlantID 92150, a MaintenancePlanningPlantID 92154, a
MaintenancePlannerGroupCode 92158, an ImportanceCode 92162, a
MaintenanceTaskListID 92166, a BusinessTransactionDocumentGroupID
92170, a BusinessObjectTypeCode 92174, a Description 92178 and a
TextCollection 92182. The Item 92122 entity includes an
ObjectReference 92186 subordinate entity.
[0808] The @actionCode 92126 attribute has a cardinality of 1 92128
meaning that for each instance of the Item 92122 entity there is
one @actionCode 92126 attribute. The ID 92130 attribute has a
cardinality of 0..1 92132 meaning that for each instance of the
Item 92122 entity there may be one ID 92130 attribute. The
CycleGroupSequenceNumberValue 92134 attribute has a cardinality of
0..1 92136 meaning that for each instance of the Item 92122 entity
there may be one CycleGroupSequenceNumberValue 92134 attribute. The
BusinessTransactionDocumentProcessingTypeCode 92138 attribute has a
cardinality of 0..1 92140 meaning that for each instance of the
Item 92122 entity there may be one
BusinessTransactionDocumentProcessingTypeCode 92138 attribute. The
BusinessTransactionDocumentReference 92142 attribute has a
cardinality of 0..1 92144 meaning that for each instance of the
Item 92122 entity there may be one
BusinessTransactionDocumentReference 92142 attribute.
[0809] The WorkCentreID 92146 attribute has a cardinality of 0..1
92148 meaning that for each instance of the Item 92122 entity there
may be one WorkCentreID 92146 attribute. The WorkCentrePlantID
92150 attribute has a cardinality of 0..1 92152 meaning that for
each instance of the Item 92122 entity there may be one
WorkCentrePlantID 92150 attribute. The MaintenancePlanningPlantID
92154 attribute has a cardinality of 0..1 92156 meaning that for
each instance of the Item 92122 entity there may be one
MaintenancePlanningPlantID 92154 attribute. The
MaintenancePlannerGroupCode 92158 attribute has a cardinality of
0..1 92160 meaning that for each instance of the Item 92122 entity
there may be one MaintenancePlannerGroupCode 92158 attribute. The
ImportanceCode 92162 attribute has a cardinality of 0..1 92164
meaning that for each instance of the Item 92122 entity there may
be one ImportanceCode 92162 attribute.
[0810] The MaintenanceTaskListID 92166 attribute has a cardinality
of 0..1 92168 meaning that for each instance of the Item 92122
entity there may be one MaintenanceTaskListID 92166 attribute. The
BusinessTransactionDocumentGroupID 92170 attribute has a
cardinality of 0..1 92172 meaning that for each instance of the
Item 92122 entity there may be one
BusinessTransactionDocumentGroupID 92170 attribute. The
BusinessObjectTypeCode 92174 attribute has a cardinality of 0..1
92176 meaning that for each instance of the Item 92122 entity there
may be one BusinessObjectTypeCode 92174 attribute. The Description
92178 attribute has a cardinality of 0..1 92180 meaning that for
each instance of the Item 92122 entity there may be one Description
92178 attribute. The TextCollection 92182 attribute has a
cardinality of 0..1 92184 meaning that for each instance of the
Item 92122 entity there may be one TextCollection 92182
attribute.
[0811] The ObjectReference 92186 entity has a cardinality of 0..n
92188 meaning that for each instance of the Item 92122 entity there
may be one or more ObjectReference 92186 entities. The
ObjectReference 92186 entity includes various attributes, namely a
@actionCode 92190, an OrdinalNumberValue 92194, a MainIndicator
92198, a SerialID 92202, a MaterialInternalID 92206, an
IndividualMaterialID 92210 and an InstallationPointID 92214. The
@actionCode 92190 attribute has a cardinality of 1 92192 meaning
that for each instance of the ObjectReference 92186 entity there is
one @actionCode 92190 attribute. The OrdinalNumberValue 92194
attribute has a cardinality of 0..1 92196 meaning that for each
instance of the ObjectReference 92186 entity there may be one
OrdinalNumberValue 92194 attribute. The MainIndicator 92198
attribute has a cardinality of 1 92200 meaning that for each
instance of the ObjectReference 92186 entity there is one
MainIndicator 92198 attribute. The SerialID 92202 attribute has a
cardinality of 0..1 92204 meaning that for each instance of the
ObjectReference 92186 entity there may be one SerialID 92202
attribute. The MaterialInternalID 92206 attribute has a cardinality
of 0..1 92208 meaning that for each instance of the ObjectReference
92186 entity there may be one MaterialInternalID 92206 attribute.
The IndividualMaterialID 92210 attribute has a cardinality of 0..1
92212 meaning that for each instance of the ObjectReference 92186
entity there may be one IndividualMaterialID 92210 attribute. The
InstallationPointID 92214 attribute has a cardinality of 0..1 92216
meaning that for each instance of the ObjectReference 92186 entity
there may be one InstallationPointID 92214 attribute. The data
types of the various packages, entities, and attributes are
described with respect to FIG. 73.
[0812] FIG. 93 shows an example configuration of an Element
Structure that includes a MaintPlnERPUpdtCkRspMsg_s 93000 package.
The MaintPlnERPUpdtCkRspMsg_s 93000 package includes a
MaintPlnERPUpdtCkRspMsg_s 93002 entity. The
MaintPlnERPUpdtCkRspMsg_s 93000 package includes a Log 93004
package.
[0813] The Log 93004 package includes a Log 93006 entity. The Log
93006 entity has a cardinality of 1 93008 meaning that for each
instance of the Log 93004 package there is one Log 93006 entity.
The data types of the various packages, entities, and attributes
are described with respect to FIG. 73.
[0814] FIG. 94 shows an example configuration of an Element
Structure that includes a MaintPlnERPByIDQryMsg_s 94000 package.
The MaintPlnERPByIDQryMsg_s 94000 package includes a
MaintPlnERPByIDQryMsg_s 94002 entity. The MaintPlnERPByIDQryMsg_s
94000 package includes a Selection 94004 package.
[0815] The Selection 94004 package includes a
MaintenancePlanSelectionByID 94006 entity. The
MaintenancePlanSelectionByID 94006 entity has a cardinality of 1
94008 meaning that for each instance of the Selection 94004 package
there is one MaintenancePlanSelectionByID 94006 entity. The
MaintenancePlanSelectionByID 94006 entity includes a
MaintenancePlanID 94010 attribute. The MaintenancePlanID 94010
attribute has a cardinality of 1 94012 meaning that for each
instance of the MaintenancePlanSelectionByID 94006 entity there is
one MaintenancePlanID 94010 attribute. The data types of the
various packages, entities, and attributes are described with
respect to FIG. 73.
[0816] FIGS. 95-1 through 95-10 show an example configuration of an
Element Structure that includes a MaintPlnERPByIDRspMsg_s 95000
package. The MaintPlnERPByIDRspMsg_s 95000 package includes a
MaintPlnERPByIDRspMsg_s 95002 entity. The MaintPlnERPByIDRspMsg_s
95000 package includes various packages, namely a MaintenancePlan
95004 and a Log 95262.
[0817] The MaintenancePlan 95004 package includes a MaintenancePlan
95006 entity. The MaintenancePlan 95006 entity has a cardinality of
0..1 95008 meaning that for each instance of the MaintenancePlan
95004 package there may be one MaintenancePlan 95006 entity.
[0818] The MaintenancePlan 95006 entity includes various
attributes, namely an ID 95010, a ChangeStateID 95014, a
CategoryCode 95018, a StatusObject 95022, a Description 95026 and a
TextCollection 95030. The MaintenancePlan 95006 entity includes
various subordinate entities, namely a SchedulingTerms 95034, a
Cycle 95094 and an Item 95126. The ID 95010 attribute has a
cardinality of 1 95012 meaning that for each instance of the
MaintenancePlan 95006 entity there is one ID 95010 attribute.
[0819] The ChangeStateID 95014 attribute has a cardinality of 1
95016 meaning that for each instance of the MaintenancePlan 95006
entity there is one ChangeStateID 95014 attribute. The CategoryCode
95018 attribute has a cardinality of 1 95020 meaning that for each
instance of the MaintenancePlan 95006 entity there is one
CategoryCode 95018 attribute. The StatusObject 95022 attribute has
a cardinality of 0..1 95024 meaning that for each instance of the
MaintenancePlan 95006 entity there may be one StatusObject 95022
attribute. The Description 95026 attribute has a cardinality of
0..1 95028 meaning that for each instance of the MaintenancePlan
95006 entity there may be one Description 95026 attribute. The
TextCollection 95030 attribute has a cardinality of 0..1 95032
meaning that for each instance of the MaintenancePlan 95006 entity
there may be one TextCollection 95030 attribute.
[0820] The SchedulingTerms 95034 entity has a cardinality of 0..1
95036 meaning that for each instance of the MaintenancePlan 95006
entity there may be one SchedulingTerms 95034 entity. The
SchedulingTerms 95034 entity includes various attributes, namely a
StartDateTime 95038, a
MeasuringDeviceStartMeasurementReadingMeasure 95042, a
LateCompletionShiftPercent 95046, an EarlyCompletionShiftPercent
95050, a LateCompletionTolerencePercent 95054, a
WorkingDayCalendarCode 95058, an EarlyCompletionTolerencePercent
95062, a MaintenancePlanCycleQuantityModificationFactorValue 95066,
a BufferStartDaysNumberValue 95070, a CallHorizonPercent 95074, a
PredecessorCompletionRequiredIndicator 95078, a SchedulingDuration
95082, a SchedulingCategoryCode 95086 and a
CycleDependencyIndicator 95090. The StartDateTime 95038 attribute
has a cardinality of 0..1 95040 meaning that for each instance of
the SchedulingTerms 95034 entity there may be one StartDateTime
95038 attribute.
[0821] The MeasuringDeviceStartMeasurementReadingMeasure 95042
attribute has a cardinality of 0..1 95044 meaning that for each
instance of the SchedulingTerms 95034 entity there may be one
MeasuringDeviceStartMeasurementReadingMeasure 95042 attribute. The
LateCompletionShiftPercent 95046 attribute has a cardinality of
0..1 95048 meaning that for each instance of the SchedulingTerms
95034 entity there may be one LateCompletionShiftPercent 95046
attribute. The EarlyCompletionShiftPercent 95050 attribute has a
cardinality of 0..1 95052 meaning that for each instance of the
SchedulingTerms 95034 entity there may be one
EarlyCompletionShiftPercent 95050 attribute. The
LateCompletionTolerencePercent 95054 attribute has a cardinality of
0..1 95056 meaning that for each instance of the SchedulingTerms
95034 entity there may be one LateCompletionTolerencePercent 95054
attribute.
[0822] The WorkingDayCalendarCode 95058 attribute has a cardinality
of 0..1 95060 meaning that for each instance of the SchedulingTerms
95034 entity there may be one WorkingDayCalendarCode 95058
attribute. The EarlyCompletionTolerencePercent 95062 attribute has
a cardinality of 0..1 95064 meaning that for each instance of the
SchedulingTerms 95034 entity there may be one
EarlyCompletionTolerencePercent 95062 attribute. The
MaintenancePlanCycleQuantityModificationFactorValue 95066 attribute
has a cardinality of 0..1 95068 meaning that for each instance of
the SchedulingTerms 95034 entity there may be one
MaintenancePlanCycleQuantityModificationFactorValue 95066
attribute. The BufferStartDaysNumberValue 95070 attribute has a
cardinality of 0..1 95072 meaning that for each instance of the
SchedulingTerms 95034 entity there may be one
BufferStartDaysNumberValue 95070 attribute.
[0823] The CallHorizonPercent 95074 attribute has a cardinality of
0..1 95076 meaning that for each instance of the SchedulingTerms
95034 entity there may be one CallHorizonPercent 95074 attribute.
The PredecessorCompletionRequiredIndicator 95078 attribute has a
cardinality of 0..1 95080 meaning that for each instance of the
SchedulingTerms 95034 entity there may be one
PredecessorCompletionRequiredIndicator 95078 attribute. The
SchedulingDuration 95082 attribute has a cardinality of 0..1 95084
meaning that for each instance of the SchedulingTerms 95034 entity
there may be one SchedulingDuration 95082 attribute. The
SchedulingCategoryCode 95086 attribute has a cardinality of 0..1
95088 meaning that for each instance of the SchedulingTerms 95034
entity there may be one SchedulingCategoryCode 95086 attribute. The
CycleDependencylndicator 95090 attribute has a cardinality of 0..1
95092 meaning that for each instance of the SchedulingTerms 95034
entity there may be one CycleDependencylndicator 95090
attribute.
[0824] The Cycle 95094 entity includes various attributes, namely a
CounterValue 95098, a GroupSequenceNumberValue 95102, a
GroupSequenceRepetitionNumberValue 95106, a Quantity 95110, a
StartOffsetQuantity 95114, a MeasuringDeviceID 95118 and a
Description 95122. The CounterValue 95098 attribute has a
cardinality of 1 95100 meaning that for each instance of the Cycle
95094 entity there is one CounterValue 95098 attribute. The
GroupSequenceNumberValue 95102 attribute has a cardinality of 0..1
95104 meaning that for each instance of the Cycle 95094 entity
there may be one GroupSequenceNumberValue 95102 attribute.
[0825] The GroupSequenceRepetitionNumberValue 95106 attribute has a
cardinality of 0..1 95108 meaning that for each instance of the
Cycle 95094 entity there may be one
GroupSequenceRepetitionNumberValue 95106 attribute. The Quantity
95110 attribute has a cardinality of 1 95112 meaning that for each
instance of the Cycle 95094 entity there is one Quantity 95110
attribute. The StartOffsetQuantity 95114 attribute has a
cardinality of 0..1 95116 meaning that for each instance of the
Cycle 95094 entity there may be one StartOffsetQuantity 95114
attribute. The MeasuringDeviceID 95118 attribute has a cardinality
of 0..1 95120 meaning that for each instance of the Cycle 95094
entity there may be one MeasuringDeviceID 95118 attribute. The
Description 95122 attribute has a cardinality of 0..1 95124 meaning
that for each instance of the Cycle 95094 entity there may be one
Description 95122 attribute.
[0826] The Item 95126 entity has a cardinality of 1..n 95128
meaning that for each instance of the MaintenancePlan 95006 entity
there are one or more Item 95126 entities. The Item 95126 entity
includes various attributes, namely an OrdinalNumberValue 95130, an
ID 95134, a CycleGroupSequenceNumberValue 95138, a
BusinessTransactionDocumentProcessingTypeCode 95142, a
BusinessTransactionDocumentReference 95146, a WorkCentreID 95150, a
WorkCentrePlantID 95154, a MaintenancePlanningPlantID 95158, a
MaintenancePlannerGroupCode 95162, an ImportanceCode 95166, a
MaintenanceTaskListID 95170, a BusinessTransactionDocumentGroupID
95174, a BusinessObjectTypeCode 95178, a WorkCentreDescription
95182, a MaintenancePlantDescription 95186, a StatusObject 95190, a
Description 95194 and a TextCollection 95198. The Item 95126 entity
includes various subordinate entities, namely an ObjectReference
95202 and a ScheduleLine 95242.
[0827] The OrdinalNumberValue 95130 attribute has a cardinality of
1 95132 meaning that for each instance of the Item 95126 entity
there is one OrdinalNumberValue 95130 attribute. The ID 95134
attribute has a cardinality of 1 95136 meaning that for each
instance of the Item 95126 entity there is one ID 95134 attribute.
The CycleGroupSequenceNumberValue 95138 attribute has a cardinality
of 0..1 95140 meaning that for each instance of the Item 95126
entity there may be one CycleGroupSequenceNumberValue 95138
attribute. The BusinessTransactionDocumentProcessingTypeCode 95142
attribute has a cardinality of 1 95144 meaning that for each
instance of the Item 95126 entity there is one
BusinessTransactionDocumentProcessingTypeCode 95142 attribute.
[0828] The BusinessTransactionDocumentReference 95146 attribute has
a cardinality of 0..1 95148 meaning that for each instance of the
Item 95126 entity there may be one
BusinessTransactionDocumentReference 95146 attribute. The
WorkCentreID 95150 attribute has a cardinality of 1 95152 meaning
that for each instance of the Item 95126 entity there is one
WorkCentreID 95150 attribute. The WorkCentrePlantID 95154 attribute
has a cardinality of 0..1 95156 meaning that for each instance of
the Item 95126 entity there may be one WorkCentrePlantID 95154
attribute. The MaintenancePlanningPlantID 95158 attribute has a
cardinality of 1 95160 meaning that for each instance of the Item
95126 entity there is one MaintenancePlanningPlantID 95158
attribute. The MaintenancePlannerGroupCode 95162 attribute has a
cardinality of 0..1 95164 meaning that for each instance of the
Item 95126 entity there may be one MaintenancePlannerGroupCode
95162 attribute. The ImportanceCode 95166 attribute has a
cardinality of 0..1 95168 meaning that for each instance of the
Item 95126 entity there may be one ImportanceCode 95166
attribute.
[0829] The MaintenanceTaskListID 95170 attribute has a cardinality
of 0..1 95172 meaning that for each instance of the Item 95126
entity there may be one MaintenanceTaskListID 95170 attribute. The
BusinessTransactionDocumentGroupID 95174 attribute has a
cardinality of 0..1 95176 meaning that for each instance of the
Item 95126 entity there may be one
BusinessTransactionDocumentGroupID 95174 attribute. The
BusinessObjectTypeCode 95178 attribute has a cardinality of 0..1
95180 meaning that for each instance of the Item 95126 entity there
may be one BusinessObjectTypeCode 95178 attribute. The
WorkCentreDescription 95182 attribute has a cardinality of 0..1
95184 meaning that for each instance of the Item 95126 entity there
may be one WorkCentreDescription 95182 attribute.
[0830] The MaintenancePlantDescription 95186 attribute has a
cardinality of 0..1 95188 meaning that for each instance of the
Item 95126 entity there may be one MaintenancePlantDescription
95186 attribute. The StatusObject 95190 attribute has a cardinality
of 0..1 95192 meaning that for each instance of the Item 95126
entity there may be one StatusObject 95190 attribute. The
Description 95194 attribute has a cardinality of 0..1 95196 meaning
that for each instance of the Item 95126 entity there may be one
Description 95194 attribute. The TextCollection 95198 attribute has
a cardinality of 0..1 95200 meaning that for each instance of the
Item 95126 entity there may be one TextCollection 95198
attribute.
[0831] The ObjectReference 95202 entity has a cardinality of 1..n
95204 meaning that for each instance of the Item 95126 entity there
are one or more ObjectReference 95202 entities. The ObjectReference
95202 entity includes various attributes, namely an
OrdinalNumberValue 95206, a MainIndicator 95210, a SerialID 95214,
a MaterialInternalID 95218, an IndividualMaterialID 95222, an
InstallationPointID 95226, a MaterialDescription 95230, an
IndividualMaterialDescription 95234 and an
InstallationPointDescription 95238. The OrdinalNumberValue 95206
attribute has a cardinality of 1 95208 meaning that for each
instance of the ObjectReference 95202 entity there is one
OrdinalNumberValue 95206 attribute. The MainIndicator 95210
attribute has a cardinality of 1 95212 meaning that for each
instance of the ObjectReference 95202 entity there is one
MainIndicator 95210 attribute. The SerialID 95214 attribute has a
cardinality of 0..1 95216 meaning that for each instance of the
ObjectReference 95202 entity there may be one SerialID 95214
attribute.
[0832] The MaterialInternalID 95218 attribute has a cardinality of
0..1 95220 meaning that for each instance of the ObjectReference
95202 entity there may be one MaterialInternalID 95218 attribute.
The IndividualMaterialID 95222 attribute has a cardinality of 0..1
95224 meaning that for each instance of the ObjectReference 95202
entity there may be one IndividualMaterialID 95222 attribute. The
InstallationPointID 95226 attribute has a cardinality of 0..1 95228
meaning that for each instance of the ObjectReference 95202 entity
there may be one InstallationPointID 95226 attribute. The
MaterialDescription 95230 attribute has a cardinality of 0..1 95232
meaning that for each instance of the ObjectReference 95202 entity
there may be one MaterialDescription 95230 attribute. The
IndividualMaterialDescription 95234 attribute has a cardinality of
0..1 95236 meaning that for each instance of the ObjectReference
95202 entity there may be one IndividualMaterialDescription 95234
attribute. The InstallationPointDescription 95238 attribute has a
cardinality of 0..1 95240 meaning that for each instance of the
ObjectReference 95202 entity there may be one
InstallationPointDescription 95238 attribute.
[0833] The ScheduleLine 95242 entity has a cardinality of 0..n
95244 meaning that for each instance of the Item 95126 entity there
may be one or more ScheduleLine 95242 entities. The ScheduleLine
95242 entity includes various attributes, namely an
OrdinalNumberValue 95246, a PlannedDateTime 95250, an
InitiatedDateTime 95254 and a CompletionDateTime 95258. The
OrdinalNumberValue 95246 attribute has a cardinality of 1 95248
meaning that for each instance of the ScheduleLine 95242 entity
there is one OrdinalNumberValue 95246 attribute. The
PlannedDateTime 95250 attribute has a cardinality of 1 95252
meaning that for each instance of the ScheduleLine 95242 entity
there is one PlannedDateTime 95250 attribute. The InitiatedDateTime
95254 attribute has a cardinality of 0..1 95256 meaning that for
each instance of the ScheduleLine 95242 entity there may be one
InitiatedDateTime 95254 attribute. The CompletionDateTime 95258
attribute has a cardinality of 0..1 95260 meaning that for each
instance of the ScheduleLine 95242 entity there may be one
CompletionDateTime 95258 attribute.
[0834] The Log 95262 package includes a Log 95264 entity. The Log
95264 entity has a cardinality of 1 95266 meaning that for each
instance of the Log 95262 package there is one Log 95264 entity.
The data types of the various packages, entities, and attributes
are described with respect to FIG. 73.
[0835] FIG. 96 shows an example configuration of an Element
Structure that includes a MaintPlnERPSchedLineByIDQryMsg_s 96000
package. The MaintPlnERPSchedLineByIDQryMsg_s 96000 package
includes a MaintPlnERPSchedLineByIDQryMsg_s 96002 entity. The
MaintPlnERPSchedLineByIDQryMsg_s 96000 package includes a Selection
96004 package.
[0836] The Selection 96004 package includes a
MaintenancePlanScheduleLineSelectionByID 96006 entity. The
MaintenancePlanScheduleLineSelectionByID 96006 entity has a
cardinality of 1 96008 meaning that for each instance of the
Selection 96004 package there is one
MaintenancePlanScheduleLineSelectionByID 96006 entity. The
MaintenancePlanScheduleLineSelectionByID 96006 entity includes a
MaintenancePlanID 96010 attribute. The MaintenancePlanID 96010
attribute has a cardinality of 1 96012 meaning that for each
instance of the MaintenancePlanScheduleLineSelectionByID 96006
entity there is one MaintenancePlanID 96010 attribute. The data
types of the various packages, entities, and attributes are
described with respect to FIG. 73.
[0837] FIGS. 97-1 through 97-2 show an example configuration of an
Element Structure that includes a MaintPlnERPSchedLineByIDRspMsg_s
97000 package. The MaintPlnERPSchedLineByIDRspMsg_s 97000 package
includes a MaintPlnERPSchedLineByIDRspMsg_s 97002 entity. The
MaintPlnERPSchedLineByIDRspMsg_s 97000 package includes various
packages, namely a MessageHeader 97004, a MaintenancePlan 97010 and
a Log 97048.
[0838] The MessageHeader 97004 package includes a MessageHeader
97006 entity. The MessageHeader 97006 entity has a cardinality of
0..1 97008 meaning that for each instance of the MessageHeader
97004 package there may be one MessageHeader 97006 entity.
[0839] The MaintenancePlan 97010 package includes a MaintenancePlan
97012 entity. The MaintenancePlan 97012 entity has a cardinality of
0..1 97014 meaning that for each instance of the MaintenancePlan
97010 package there may be one MaintenancePlan 97012 entity. The
MaintenancePlan 97012 entity includes an ID 97016 attribute. The
MaintenancePlan 97012 entity includes an Item 97020 subordinate
entity. The ID 97016 attribute has a cardinality of 1 97018 meaning
that for each instance of the MaintenancePlan 97012 entity there is
one ID 97016 attribute.
[0840] The Item 97020 entity has a cardinality of 0..n 97022
meaning that for each instance of the MaintenancePlan 97012 entity
there may be one or more Item 97020 entities. The Item 97020 entity
includes an ID 97024 attribute. The Item 97020 entity includes a
ScheduleLine 97028 subordinate entity. The ID 97024 attribute has a
cardinality of 1 97026 meaning that for each instance of the Item
97020 entity there is one ID 97024 attribute.
[0841] The ScheduleLine 97028 entity has a cardinality of 0..n
97030 meaning that for each instance of the Item 97020 entity there
may be one or more ScheduleLine 97028 entities. The ScheduleLine
97028 entity includes various attributes, namely an
OrdinalNumberValue 97032, a PlannedDateTime 97036, an
InitiatedDateTime 97040 and a CompletionDateTime 97044. The
OrdinalNumberValue 97032 attribute has a cardinality of 0..1 97034
meaning that for each instance of the ScheduleLine 97028 entity
there may be one OrdinalNumberValue 97032 attribute. The
PlannedDateTime 97036 attribute has a cardinality of 0..1 97038
meaning that for each instance of the ScheduleLine 97028 entity
there may be one PlannedDateTime 97036 attribute. The
InitiatedDateTime 97040 attribute has a cardinality of 0..1 97042
meaning that for each instance of the ScheduleLine 97028 entity
there may be one InitiatedDateTime 97040 attribute. The
CompletionDateTime 97044 attribute has a cardinality of 0..1 97046
meaning that for each instance of the ScheduleLine 97028 entity
there may be one CompletionDateTime 97044 attribute.
[0842] The Log 97048 package includes a Log 97050 entity. The Log
97050 entity has a cardinality of 1 97052 meaning that for each
instance of the Log 97048 package there is one Log 97050 entity.
The data types of the various packages, entities, and attributes
are described with respect to FIG. 73.
MaintenanceTaskList Interfaces
[0843] Maintenance Task List can be a list of maintenance tasks
which may be performed repeatedly for maintaining a product. Task
lists can be used to standardize recurring work sequences and to
plan them more effectively. Many manufacturers can deliver task
lists along with their products for the maintenance of those
products.
[0844] The MaintenanceTaskList interface can perform various
operations, namely a
MaintenanceTaskListERPSimpleByElementsQueryResponse_In, a
ParentMaintenanceTaskListERPSimpleByMaintenanceTaskListQueryResponse_In,
a
SubordinateMaintenanceTaskListERPSimpleByMaintenanceTaskListQueryRespon-
se_In, a
TopLevelMaintenanceTaskListERPSimpleByMaintenanceTaskListQueryRes-
ponse_In, a
MaintenanceTaskListERPByIDAndGroupIDAndTypeCodeQueryResponse_In,
and a
MaintenanceTaskListERPSimulateMaintenanceOrderCalculationRequestConfirmat-
ion_In. The MaintenanceTaskListERPSimpleByElementsQueryResponse_In
operation can handle an inquiry to and response from Maintenance
Planning to list Maintenance Task Lists according to a given
selection criteria.
[0845] Maintenance Planner can use a `Find Maintenance Task List By
Elements` inbound operation to get a list of Maintenance Task Lists
based on a given selection criteria. The
MaintenanceTaskListERPSimpleByElementsQueryResponse_In operation
includes various message types, namely a
MaintenanceTaskListERPSimpleByElementsQuery_sync and a
MaintenanceTaskListERPSimpleByElementsResponse_sync. The structure
of the MaintenanceTaskListERPSimpleByElementsQuery_sync message
type can be specified by a MaintTskListERPSimplElmntsQryMsg_s
message data type. The structure of the
MaintenanceTaskListERPSimpleByElementsResponse_sync message type
can be specified by a MaintTskListERPSimplElmntsRspMsg_s message
data type.
[0846] The
ParentMaintenanceTaskListERPSimpleByMaintenanceTaskListQueryRes-
ponse_In operation can handle an inquiry to and response from
Maintenance Planning to list Parent Maintenance Task Lists for a
given Maintenance Task List and level. Maintenance Planner can use
a `Find Parent Maintenance Task List By Maintenance Task List`
inbound operation to find Parent Maintenance Task Lists for a given
Maintenance Task List and a given level. The upper hierarchy can be
returned until a specified level is reached. The
ParentMaintenanceTaskListERPSimpleByMaintenanceTaskListQueryResponse_In
operation includes various message types, namely a
ParentMaintenanceTaskListERPSimpleByMaintenanceTaskListQuery_sync
and a
ParentMaintenanceTaskListERPSimpleByMaintenanceTaskListResponse_sync
The structure of the
ParentMaintenanceTaskListERPSimpleByMaintenanceTaskListQuery_sync
message type can be specified by a
ParMaintTskListERPSimplMaintTskListRspMsg_s message data type. The
structure of the
ParentMaintenanceTaskListERPSimpleByMaintenanceTaskListResponse_sync
message type can be specified by a
ParMaintTskListERPSimplMaintTskListRspMsg_s message data type.
[0847] The
SubordinateMaintenanceTaskListERPSimpleByMaintenanceTaskListQue-
ryResponse_In operation can handle an inquiry to and response from
Maintenance Planning to list Subordinate Maintenance Task Lists
according to a specified Maintenance Task List. Maintenance Planner
can use a `Find Subordinate Maintenance Task List By Maintenance
Task List` inbound operation to find Subordinate Maintenance Task
Lists for a given Maintenance Task List and a given level. A lower
hierarchy can be returned until a specified level is reached. The
SubordinateMaintenanceTaskListERPSimpleByMaintenanceTaskListQueryResponse-
_In operation includes various message types, namely a
SubordinateMaintenanceTaskListERPSimpleByMaintenanceTaskListQuery_sync
and a
SubordinateMaintenanceTaskListERPSimpleByMaintenanceTaskListRespons-
e_sync. The structure of the
SubordinateMaintenanceTaskListERPSimpleByMaintenanceTaskListQuery_sync
message type can be specified by a
SubordMaintTskListERPSimplMaintTskListQryMsg_s message data type.
The structure of the
SubordinateMaintenanceTaskListERPSimpleByMaintenanceTaskListResponse_sync
message type can be specified by a
SubordMaintTskListERPSimplMaintTskListRspMsg_s message data
type.
[0848] The
TopLevelMaintenanceTaskListERPSimpleByMaintenanceTaskListQueryR-
esponse_In operation can handle an inquiry to and response from
Maintenance Planning to find the Top Level Maintenance Task List in
the given Maintenance Task List hierarchy. Maintenance Planner can
use a `Find Top Level Maintenance Task List By Maintenance Task
List` inbound operation to find a Top Level Maintenance Task List
in a given Maintenance Task List hierarchy. The
TopLevelMaintenanceTaskListERPSimpleByMaintenanceTaskListQueryResponse_In
operation includes various message types, namely a
TopLevelMaintenanceTaskListERPSimpleByMaintenanceTaskListQuery_sync
and a
TopLevelMaintenanceTaskListERPSimpleByMaintenanceTaskListResponse_sync
The structure of the
TopLevelMaintenanceTaskListERPSimpleByMaintenanceTaskListQuery_sync
message type can be specified by a
TopLvlMaintTskListERPSimplMaintTskListQryMsg_s message data type.
The structure of the
TopLevelMaintenanceTaskListERPSimpleByMaintenanceTaskListResponse_sync
message type can be specified by a
TopLvlMaintTskListERPSimplMaintTskListRspMsg_s message data
type.
[0849] The
MaintenanceTaskListERPByIDAndGroupIDAndTypeCodeQueryResponse_In
operation can handle an inquiry to and response from Maintenance
Planning to read a Maintenance Task List. Maintenance Planner can
use a `Read Maintenance Task List` inbound operation to read a
Maintenance Task List. The
MaintenanceTaskListERPByIDAndGroupIDAndTypeCodeQueryResponse_In
operation includes various message types, namely a
MaintenanceTaskListERPByIDAndGroupIDAndTypeCodeQuery_sync and a
MaintenanceTaskListERPByIDAndGroupIDAndTypeCodeResponse_sync. The
structure of the
MaintenanceTaskListERPByIDAndGroupIDAndTypeCodeQuery_sync message
type can be specified by a
MaintTskListERPByIDAndGrpIDAndTypeCodeQryMsg_s message data type.
The structure of the
MaintenanceTaskListERPByIDAndGroupIDAndTypeCodeResponse_sync
message type can be specified by a
MaintTskListERPByIDAndGrpIDAndTypeCodeRspMsg_s message data
type.
[0850] The
MaintenanceTaskListERPSimulateMaintenanceOrderCalculationReques-
tConfirmation_In operation can request to and confirm from
Maintenance Planning to simulate Maintenance Order calculation. The
Maintenance Planner can use a `Simulate Task List Maintenance Order
Calculation` inbound operation to simulate a Maintenance Order
calculation. The
MaintenanceTaskListERPSimulateMaintenanceOrderCalculationRequestConfirmat-
ion_In operation includes various message types, namely a
MaintenanceTaskListERPSimulateMaintenanceOrderCalculationRequest_sync
and a
MaintenanceTaskListERPSimulateMaintenanceOrderCalculationConfirmation_s-
ync. The structure of the
MaintenanceTaskListERPSimulateMaintenanceOrderCalculationRequest_sync
message type can be specified by a
MaintenanceTaskListERPSimulateMaintenanceOrderCalculationRequestMessage_s-
ync message data type. The structure of the
MaintenanceTaskListERPSimulateMaintenanceOrderCalculationConfirmation_syn-
c message type can be specified by a
MaintenanceTaskListERPSimulateMaintenanceOrderCalculationConfirmationMess-
age_sync message data type.
[0851] The message choreography of FIG. 98 describes a possible
logical sequence of messages that can be used to realize a
Maintenance Task List business scenario. A "Maintenance Planner"
system 98000 can query a "Maintenance Planning" system 98002 to
list maintenance task lists according to a given selection
criteria, using a MaintenanceTaskListERPSimpleByElementsQuery_sync
message 98004 as shown, for example in FIG. 98. The "Maintenance
Planning" system 98002 can respond to the query, using a
MaintenanceTaskListERPSimpleByElementsResponse_sync message 98006
as shown, for example, in FIG. 98.
[0852] The "Maintenance Planner" system 98000 can query the
"Maintenance Planning" system 98002 to list parent maintenance task
lists for a given maintenance task list and level, using a
ParentMaintenanceTaskListERPSimpleByMaintenanceTaskListQuery_sync
message 98008 as shown, for example in FIG. 98. The "Maintenance
Planning" system 98002 can respond to the query, using a
ParentMaintenanceTaskListERPSimpleByMaintenanceTaskListResponse_sync
message 98010 as shown, for example, in FIG. 98.
[0853] The "Maintenance Planner" system 98000 can query the
"Maintenance Planning" system 98002 to list subordinate maintenance
task lists for a given maintenance task list, using a
SubordinateMaintenanceTaskListERPSimpleByMaintenanceTaskListQuery_sync
message 98012 as shown, for example in FIG. 98. The "Maintenance
Planning" system 98002 can respond to the query, using a
SubordinateMaintenanceTaskListERPSimpleByMaintenanceTaskListResponse_sync
message 98014 as shown, for example, in FIG. 98.
[0854] The "Maintenance Planner" system 98000 can query the
"Maintenance Planning" system 98002 to find the top level
maintenance task list for a given maintenance task list hierarchy,
using a
TopLevelMaintenanceTaskListERPSimpleByMaintenanceTaskListQuery_sync
message 98016 as shown, for example in FIG. 98. The "Maintenance
Planning" system 98002 can respond to the query, using a
TopLevelMaintenanceTaskListERPSimpleByMaintenanceTaskListResponse_sync
message 98018 as shown, for example, in FIG. 98.
[0855] The "Maintenance Planner" system 98000 can query the
"Maintenance Planning" system 98002 to read a maintenance task
list, using a MaintenanceTaskListERPByIDQuery_sync message 98020 as
shown, for example in FIG. 98. The "Maintenance Planning" system
98002 can respond to the query, using a
MaintenanceTaskListERPByIDResponse_sync message 98022 as shown, for
example, in FIG. 98.
[0856] FIG. 99 illustrates one example logical configuration of
MaintTskListERPSimplElmntsQryMsg_s message 99000. Specifically,
this figure depicts the arrangement and hierarchy of various
components such as one or more levels of packages, entities, and
datatypes, shown here as 99002 through 99010. As described above,
packages may be used to represent hierarchy levels. Entities are
discrete business elements that are used during a business
transaction. Data types are used to type object entities and
interfaces with a structure. For example,
MaintTskListERPSimplElmntsQryMsg_s message 99000 includes, among
other things, ProcessingConditions 99004. Accordingly,
heterogeneous applications may communicate using this consistent
message configured as such.
[0857] Additionally, FIG. 100 illustrates one example logical
configuration of MaintTskListERPSimplElmntsRspMsg_s message 100000.
Specifically, this figure depicts the arrangement and hierarchy of
various components such as one or more levels of packages,
entities, and datatypes, shown here as 100002 through 100014. As
described above, packages may be used to represent hierarchy
levels. Entities are discrete business elements that are used
during a business transaction. Data types are used to type object
entities and interfaces with a structure. For example,
MaintTskListERPSimplElmntsRspMsg_s message 100000 includes, among
other things, ProcessingConditions 100012. Accordingly,
heterogeneous applications may communicate using this consistent
message configured as such.
[0858] Additionally, FIG. 101 illustrates one example logical
configuration of ParMaintTskListERPSimplByMaintTskListQryMsg_s
message 101000. Specifically, this figure depicts the arrangement
and hierarchy of various components such as one or more levels of
packages, entities, and datatypes, shown here as 101002 through
101006. As described above, packages may be used to represent
hierarchy levels. Entities are discrete business elements that are
used during a business transaction. Data types are used to type
object entities and interfaces with a structure. For example,
ParMaintTskListERPSimplByMaintTskListQryMsg_s message 101000
includes, among other things, Selection 101002. Accordingly,
heterogeneous applications may communicate using this consistent
message configured as such.
[0859] Additionally, FIG. 102 illustrates one example logical
configuration of ParMaintTskListERPSimplByMaintTskListRspMsg_s
message 102000. Specifically, this figure depicts the arrangement
and hierarchy of various components such as one or more levels of
packages, entities, and datatypes, shown here as 102002 through
102010. As described above, packages may be used to represent
hierarchy levels. Entities are discrete business elements that are
used during a business transaction. Data types are used to type
object entities and interfaces with a structure. For example,
ParMaintTskListERPSimplByMaintTskListRspMsg_s message 102000
includes, among other things, MaintenanceTaskList 102008.
Accordingly, heterogeneous applications may communicate using this
consistent message configured as such.
[0860] Additionally, FIG. 103 illustrates one example logical
configuration of SubordMaintTskListERPSimplByMaintTskListQryMsg_s
message 103000. Specifically, this figure depicts the arrangement
and hierarchy of various components such as one or more levels of
packages, entities, and datatypes, shown here as 103002 through
103006. As described above, packages may be used to represent
hierarchy levels. Entities are discrete business elements that are
used during a business transaction. Data types are used to type
object entities and interfaces with a structure. For example,
SubordMaintTskListERPSimplByMaintTskListQryMsg_s message 103000
includes, among other things, Selection 103004. Accordingly,
heterogeneous applications may communicate using this consistent
message configured as such.
[0861] Additionally, FIG. 104 illustrates one example logical
configuration of SubordMaintTskListERPSimplByMaintTskListRspMsg_s
message 104000. Specifically, this figure depicts the arrangement
and hierarchy of various components such as one or more levels of
packages, entities, and datatypes, shown here as 104002 through
104010. As described above, packages may be used to represent
hierarchy levels. Entities are discrete business elements that are
used during a business transaction. Data types are used to type
object entities and interfaces with a structure. For example,
SubordMaintTskListERPSimplByMaintTskListRspMsg_s message 104000
includes, among other things, MaintenanceTaskList 104008.
Accordingly, heterogeneous applications may communicate using this
consistent message configured as such.
[0862] Additionally, FIG. 105 illustrates one example logical
configuration of TopLvlMaintTskListERPSimplByMaintTskListQryMsg_s
message 105000. Specifically, this figure depicts the arrangement
and hierarchy of various components such as one or more levels of
packages, entities, and datatypes, shown here as 105002 through
105006. As described above, packages may be used to represent
hierarchy levels. Entities are discrete business elements that are
used during a business transaction. Data types are used to type
object entities and interfaces with a structure. For example,
TopLvlMaintTskListERPSimplByMaintTskListQryMsg_s message 105000
includes, among other things, Selection 105002. Accordingly,
heterogeneous applications may communicate using this consistent
message configured as such.
[0863] Additionally, FIG. 106 illustrates one example logical
configuration of TopLvlMaintTskListERPSimplByMaintTskListRspMsg_s
message 106000. Specifically, this figure depicts the arrangement
and hierarchy of various components such as one or more levels of
packages, entities, and datatypes, shown here as 106002 through
106010. As described above, packages may be used to represent
hierarchy levels. Entities are discrete business elements that are
used during a business transaction. Data types are used to type
object entities and interfaces with a structure. For example,
TopLvlMaintTskListERPSimplByMaintTskListRspMsg_s message 106000
includes, among other things, MaintenanceTaskList 106008.
Accordingly, heterogeneous applications may communicate using this
consistent message configured as such.
[0864] Additionally, FIG. 107 illustrates one example logical
configuration of MaintTskListERPByIDAndGrpIDAndTypeCodeQryMsg_s
message 107000. Specifically, this figure depicts the arrangement
and hierarchy of various components such as one or more levels of
packages, entities, and datatypes, shown here as 107002 through
107006. As described above, packages may be used to represent
hierarchy levels. Entities are discrete business elements that are
used during a business transaction. Data types are used to type
object entities and interfaces with a structure. For example,
MaintTskListERPByIDAndGrpIDAndTypeCodeQryMsg_s message 107000
includes, among other things, Selection 107004. Accordingly,
heterogeneous applications may communicate using this consistent
message configured as such.
[0865] Additionally, FIG. 108 illustrates one example logical
configuration of MaintTskListERPByIDAndGrpIDAndTypeCodeRspMsg_s
message 108000. Specifically, this figure depicts the arrangement
and hierarchy of various components such as one or more levels of
packages, entities, and datatypes, shown here as 108002 through
108016. As described above, packages may be used to represent
hierarchy levels. Entities are discrete business elements that are
used during a business transaction. Data types are used to type
object entities and interfaces with a structure. For example,
MaintTskListERPByIDAndGrpIDAndTypeCodeRspMsg_s message 108000
includes, among other things, Relationship 108012. Accordingly,
heterogeneous applications may communicate using this consistent
message configured as such.
[0866] FIGS. 109-1 through 109-7 show an example configuration of
an Element Structure that includes a
MaintenanceTaskListMessage_sync 109000 package. The
MaintenanceTaskListMessage_sync 109000 package is a
<MessageDataType> 109004 data type. The
MaintenanceTaskListMessage_sync 109000 package includes a
MaintenanceTaskListMessage_sync 109002 entity. The
MaintenanceTaskListMessage_sync 109000 package includes various
packages, namely a MessageHeader 109006, a MaintenanceTaskList
109012 and a Log 109180.
[0867] The MessageHeader 109006 package can be a
BasicBusinessDocumentMessageHeader 109010 data type. The
MessageHeader 109006 package includes a MessageHeader 109008
entity. The MaintenanceTaskList 109012 package includes a
MaintenanceTaskList 109014 entity. The MaintenanceTaskList 109012
package includes various packages, namely an Operation 109076 and a
ProcessingConditions 109156. The MaintenanceTaskList 109014 entity
includes various attributes, namely an ID 109016, a GroupID 109020,
a MaintenancePlanningPlantID 109024, a MaintenanceWorkCentreID
109028, a MaintenanceWorkCentrePlantID 109032, a MaterialInternalID
109036, an InstallationPointID 109040, an IndividualMaterialID
109044, a TypeCode 109048, a MaintenancePlannerGroupCode 109052, a
ProcessingStatusCode 109056, an InstallationPointDescription
109060, an IndividualMaterialDescription 109064, a
MaterialDescription 109068 and a Description 109072.
[0868] The ID 109016 attribute can be a MaintenanceTaskListID
109018 data type. The MaintenanceTaskListID can be an identifier
for a maintenance task list in a MaintenanceTaskList Group. The
GroupID 109020 attribute can be a
BusinessTransactionDocumentGroupID 109022 data type. The
BusinessTransactionDocumentGroupID can be an identifier for a
TaskListGroup. The MaintenancePlanningPlantID 109024 attribute can
be a PlantID 109026 data type. The MaintenancePlanningPlantID can
be an identifier of a plant in which planning and supervision of
the execution of maintenance work is done. The
MaintenanceWorkCentreID 109028 attribute can be a WorkCentreID
109030 data type.
[0869] The MaintenanceWorkCentreID can be an identifier of a work
centre where the execution of maintenance work is done. The
MaintenanceWorkCentrePlantID 109032 attribute can be a PlantID
109034 data type. The MaintenanceWorkCentrePlantID can be an
identifier of a plant where a work centre which is responsible for
the execution of maintenance work is present. The
MaterialInternalID 109036 attribute can be a ProductInternalID
109038 data type. The MaterialInternalID can be a proprietary
identifier for a material. The InstallationPointID 109040 attribute
can be an InstallationPointID 109042 data type. The
InstallationPointID can be a unique identifier for an installation
point. The IndividualMaterialID 109044 attribute can be a
ProductInternalD 109046 data type. The IndividualMaterialID can be
a proprietary identifier for an individual material. The TypeCode
109048 attribute can be a BusinessObjectTypeCode 109050 data type.
The BusinessObjectTypeCode can be a coded representation of the
type of a maintenance task list. The MaintenancePlannerGroupCode
109052 attribute can be a MaintenancePlannerGroupCode 109054 data
type.
[0870] The MaintenancePlannerGroupCode can be a coded
representation of a MaintenancePlannerGroup. The
ProcessingStatusCode 109056 attribute can be a
MaintenanceTaskListLifeCycleStatusCode 109058 data type. The
MaintenanceTaskListLifeCycleStatusCode can be used to indicate the
processing status of a task list. The InstallationPointDescription
109060 attribute can be a SHORT_Description 109062 data type. The
InstallationPointDescription can be a representation of properties
of an InstallationPoint in natural language. The
IndividualMaterialDescription 109064 attribute can be a
SHORT_Description 109066 data type. The
IndividualMaterialDescription can be a representation of properties
of a IndividualMaterial in natural language. The
MaterialDescription 109068 attribute can be a SHORT_Description
109070 data type. The MaterialDescription can be a representation
of properties of a material in natural language. The Description
109072 attribute can be a SHORT_Description 109074 data type. The
Description can be a representation of properties of a maintenance
task list in natural language.
[0871] The Operation 109076 package includes an Operation 109078
entity. The Operation 109076 package includes various packages,
namely an OperationRelationship 109112 and a MaterialInput 109140.
The Operation 109078 entity includes various attributes, namely an
ID 109080, an ActivityID 109084, a MaintenanceWorkCentreID 109088,
a MaintenanceWorkCentrePlantID 109092, a ControlProfileCode 109096,
a PlannedDurationQuantity 109100, a PlannedWorkQuantity 109104 and
a Description 109108. The ID 109080 attribute can be an OperationID
109082 data type. The OperationID can be a unique identifier of an
operation within a MaintenanceTaskList. The ActivityID 109084
attribute can be an OperationActivityID 109086 data type. The
ActivityID can be a unique identifier of an activity in an
operation. The MaintenanceWorkCentreID 109088 attribute can be a
WorkCentreID 109090 data type. The MaintenanceWorkCentreID can be
an identifier of a work centre where the execution of maintenance
work is done.
[0872] The MaintenanceWorkCentrePlantID 109092 attribute can be a
PlantID 109094 data type. The MaintenanceWorkCentrePlantID can be
an identifier of a plant where a work centre which is responsible
for the execution of maintenance work is present. The
ControlProfileCode 109096 attribute can be an
OperationControlProfileCode 109098 data type. The
OperationControlProfileCode can be a coded representation of a
ControlProfile of an operation, which can combine controlling
elements of business transactions in an operation. The
PlannedDurationQuantity 109100 attribute can be a Quantity 109102
data type. The PlannedDurationQuantity can be a non-monetary
numerical specification of an amount in a unit of measurement. The
PlannedWorkQuantity 109104 attribute can be a Quantity 109106 data
type. The PlannedWorkQuantity can be a non-monetary numerical
specification of an amount in a unit of measurement. The
Description 109108 attribute can be a SHORT_Description 109110 data
type. The Description can be a representation of properties of a
maintenance task list in natural language.
[0873] The OperationRelationship 109112 package includes a
Relationship 109114 entity. The Relationship 109114 entity includes
various attributes, namely an OperationID 109116, a
MaintenanceWorkCentreID 109120, a MaintenanceWorkCentrePlantID
109124, a NetworkPlanElementSuccessionTypeCode 109128, a
LagDuration 109132 and a @actionCode 109136. The OperationID 109116
attribute can be an OperationID 109118 data type. The OperationID
can be a unique identifier of an operation. The
MaintenanceWorkCentreID 109120 attribute can be a WorkCentreID
109122 data type. The MaintenanceWorkCentreID can be an identifier
of a work centre where the execution of maintenance work is done.
The MaintenanceWorkCentrePlantID 109124 attribute can be a PlantID
109126 data type.
[0874] The MaintenanceWorkCentrePlantID can be an identifier of a
plant where a work centre which is responsible for the execution of
maintenance work is present. The
NetworkPlanElementSuccessionTypeCode 109128 attribute can be a
NetworkPlanElementSuccessionTypeCode 109130 data type. The
MaintenanceTaskListOperationSuccessionTypeCode can be a coded
representation of the type of a directed relationship between two
successive operations in a maintenance task list. The LagDuration
109132 attribute can be a LagDuration 109134 data type. LagDuration
can be a time span between a preceding and succeeding operation,
which are linked by a relationship. The @actionCode 109136
attribute can be an ActionCode 109138 data type. The ActionCode can
be a coded representation of an instruction to the recipient of a
message describing how to process a transmitted element.
[0875] The MaterialInput 109140 package includes a MaterialInput
109142 entity. The MaterialInput 109142 entity includes various
attributes, namely a MaterialInternalID 109144, a RequiredQuantity
109148 and a Description 109152. The MaterialInternalID 109144
attribute can be a ProductInternalID 109146 data type. The
MaterialInternalID can be a proprietary identifier for a material.
The RequiredQuantity 109148 attribute can be a Quantity 109150 data
type. The Quantity can be a non-monetary numerical specification of
an amount in a unit of measurement. The Description 109152
attribute can be a SHORT_Description 109154 data type. The
Description can be a representation of properties of a maintenance
task list in natural language.
[0876] The ProcessingConditions 109156 package includes a
ProcessingConditions 109158 entity. The ProcessingConditions 109158
entity includes various attributes, namely a
QueryHitsMaximumNumberValue 109160, an UnlimitedQueryHitsIndicator
109164, a ReturnedQueryHitsNumberValue 109168, a
MoreElementsAvailablelndicator 109172 and a
LastProvidedMaintenanceTaskListID 109176. The
QueryHitsMaximumNumberValue 109160 attribute can be a NumberValue
109162 data type. The NumberValue can be a number used for cardinal
numbers. The UnlimitedQueryHitsIndicator 109164 attribute can be an
Indicator 109166 data type. The Indicator can be a representation
of a situation that has exactly two mutually exclusive Boolean
values.
[0877] The ReturnedQueryHitsNumberValue 109168 attribute can be a
NumberValue 109170 data type. The NumberValue can be a number used
for cardinal numbers. The MoreElementsAvailablelndicator 109172
attribute can be a MoreElementsAvailablelndicator 109174 data type.
An Indicator can be a representation of a situation that has
exactly two mutually exclusive Boolean values. The
LastProvidedMaintenanceTaskListID 109176 attribute can be a
MaintenanceTaskListID 109178 data type. The MaintenanceTaskListID
can be an identifier for a maintenance task list in a
MaintenanceTaskList Group.
[0878] The Log 109180 package can be a Log 109184 data type. The
Log 109180 package includes a Log 109182 entity. The Log can be a
sequence of messages that result when an application executes a
task.
[0879] FIGS. 110-1 through 110-2 show an example configuration of
an Element Structure that includes a
MaintTskListERPSimplElmntsQryMsg_s 110000 package. The
MaintTskListERPSimplElmntsQryMsg_s 110000 package includes a
MaintTskListERPSimplElmntsQryMsg_s 110002 entity. The
MaintTskListERPSimplElmntsQryMsg_s 110000 package includes various
packages, namely a Selection 110004, and a ProcessingConditions
110034.
[0880] The Selection 110004 package includes a
MaintenanceTaskListSimpleSelectionByElements 110006 entity. The
MaintenanceTaskListSimpleSelectionByElements 110006 entity has a
cardinality of 1 110008 meaning that for each instance of the
Selection 110004 package there is one
MaintenanceTaskListSimpleSelectionByElements 110006 entity. The
MaintenanceTaskListSimpleSelectionByElements 110006 entity includes
various attributes, namely a ProcessingStatusCode 110010, a
MaintenanceTaskListID 110014, an InstallationPointID 110018, an
IndividualMaterialID 110022, a MaintenanceTaskListGroupID 110026
and a MaintenanceTaskListTypeCode 110030.
[0881] The ProcessingStatusCode 110010 attribute has a cardinality
of 0..1 110012 meaning that for each instance of the
MaintenanceTaskListSimpleSelectionByElements 110006 entity there
may be one ProcessingStatusCode 110010 attribute. The
MaintenanceTaskListID 110014 attribute has a cardinality of 0..1
110016 meaning that for each instance of the
MaintenanceTaskListSimpleSelectionByElements 110006 entity there
may be one MaintenanceTaskListID 110014 attribute. The
InstallationPointID 110018 attribute has a cardinality of 0..1
110020 meaning that for each instance of the
MaintenanceTaskListSimpleSelectionByElements 110006 entity there
may be one InstallationPointID 110018 attribute. The
IndividualMaterialID 110022 attribute has a cardinality of 0..1
110024 meaning that for each instance of the
MaintenanceTaskListSimpleSelectionByElements 110006 entity there
may be one IndividualMaterialID 110022 attribute.
[0882] The MaintenanceTaskListGroupID 110026 attribute has a
cardinality of 0..1 110028 meaning that for each instance of the
MaintenanceTaskListSimpleSelectionByElements 110006 entity there
may be one MaintenanceTaskListGroupID 110026 attribute. The
MaintenanceTaskListTypeCode 110030 attribute has a cardinality of
0..1 110032 meaning that for each instance of the
MaintenanceTaskListSimpleSelectionByElements 110006 entity there
may be one MaintenanceTaskListTypeCode 110030 attribute.
[0883] The ProcessingConditions 110034 package includes a
ProcessingConditions 110036 entity. The ProcessingConditions 110036
entity has a cardinality of 0..1 110038 meaning that for each
instance of the ProcessingConditions 110034 package there may be
one ProcessingConditions 110036 entity. The ProcessingConditions
110036 entity includes various attributes, namely a
QueryHitsMaximumNumberValue 110040, an UnlimitedQueryHitsIndicator
110044 and a LastProvidedMaintenanceTaskListID 110048.
[0884] The QueryHitsMaximumNumberValue 110040 attribute has a
cardinality of 0..1 110042 meaning that for each instance of the
ProcessingConditions 110036 entity there may be one
QueryHitsMaximumNumberValue 110040 attribute. The
UnlimitedQueryHitsIndicator 110044 attribute has a cardinality of
0..1 110046 meaning that for each instance of the
ProcessingConditions 110036 entity there may be one
UnlimitedQueryHitsIndicator 110044 attribute. The
LastProvidedMaintenanceTaskListID 110048 attribute has a
cardinality of 0..1 110050 meaning that for each instance of the
ProcessingConditions 110036 entity there may be one
LastProvidedMaintenanceTaskListID 110048 attribute. The data types
of the various packages, entities, and attributes are described
with respect to FIG. 109.
[0885] FIGS. 111-1 through 111-2 show an example configuration of
an Element Structure that includes a
MaintTskListERPSimplElmntsRspMsg_s 111000 package. The
MaintTskListERPSimplElmntsRspMsg_s 111000 package includes a
MaintTskListERPSimplElmntsRspMsg_s 111002 entity. The
MaintTskListERPSimplElmntsRspMsg_s 111000 package includes various
packages, namely a MaintenanceTaskList 111004, a
ProcessingConditions 111026 and a Log 111044. The
MaintenanceTaskList 111004 package includes a MaintenanceTaskList
111006 entity. The MaintenanceTaskList 111006 entity has a
cardinality of 0..n 111008 meaning that for each instance of the
MaintenanceTaskList 111004 package there may be one or more
MaintenanceTaskList 111006 entities. The MaintenanceTaskList 111006
entity includes various attributes, namely an ID 111010, a GroupID
111014, a TypeCode 111018 and a Description 111022. The ID 111010
attribute has a cardinality of 1 111012 meaning that for each
instance of the MaintenanceTaskList 111006 entity there is one ID
111010 attribute. The GroupID 111014 attribute has a cardinality of
1 111016 meaning that for each instance of the MaintenanceTaskList
111006 entity there is one GroupID 111014 attribute. The TypeCode
111018 attribute has a cardinality of 1 111020 meaning that for
each instance of the MaintenanceTaskList 111006 entity there is one
TypeCode 111018 attribute. The Description 111022 attribute has a
cardinality of 0..1 111024 meaning that for each instance of the
MaintenanceTaskList 111006 entity there may be one Description
111022 attribute.
[0886] The ProcessingConditions 111026 package includes a
ProcessingConditions 111028 entity. The ProcessingConditions 111028
entity has a cardinality of 1 111030 meaning that for each instance
of the ProcessingConditions 111026 package there is one
ProcessingConditions 111028 entity. The ProcessingConditions 111028
entity includes various attributes, namely a
ReturnedQueryHitsNumberValue 111032, a
MoreElementsAvailablelndicator 111036 and a
LastProvidedMaintenanceTaskListID 111040. The
ReturnedQueryHitsNumberValue 111032 attribute has a cardinality of
1 111034 meaning that for each instance of the ProcessingConditions
111028 entity there is one ReturnedQueryHitsNumberValue 111032
attribute. The MoreElementsAvailablelndicator 111036 attribute has
a cardinality of 1 111038 meaning that for each instance of the
ProcessingConditions 111028 entity there is one
MoreElementsAvailablelndicator 111036 attribute. The
LastProvidedMaintenanceTaskListID 111040 attribute has a
cardinality of 0..1 111042 meaning that for each instance of the
ProcessingConditions 111028 entity there may be one
LastProvidedMaintenanceTaskListID 111040 attribute.
[0887] The Log 111044 package includes a Log 111046 entity. The Log
111046 entity has a cardinality of 1 111048 meaning that for each
instance of the Log 111044 package there is one Log 111046 entity.
The data types of the various packages, entities, and attributes
are described with respect to FIG. 109.
[0888] FIG. 112 shows an example configuration of an Element
Structure that includes a
ParMaintTskListERPSimplByMaintTskListQryMsg_s 112000 package. The
ParMaintTskListERPSimplByMaintTskListQryMsg_s 112000 package
includes a ParMaintTskListERPSimplByMaintTskListQryMsg_s 112002
entity. The ParMaintTskListERPSimplByMaintTskListQryMsg_s 112000
package includes various packages, namely a Selection 112004.
[0889] The Selection 112004 package includes a
ParMaintenanceTaskListSimpleSelectionByMaintenanceTaskList 112006
entity. The
ParMaintenanceTaskListSimpleSelectionByMaintenanceTaskList 112006
entity has a cardinality of 1 112008 meaning that for each instance
of the Selection 112004 package there is one
ParMaintenanceTaskListSimpleSelectionByMaintenanceTaskList 112006
entity. The
ParMaintenanceTaskListSimpleSelectionByMaintenanceTaskList 112006
entity includes various attributes, namely a MaintenanceTaskListID
112010, a MaintenanceTaskListGroupID 112014, a
MaintenanceTaskListTypeCode 112018 and a LevelNumberValue 112022.
The MaintenanceTaskListID 112010 attribute has a cardinality of 1
112012 meaning that for each instance of the
ParMaintenanceTaskListSimpleSelectionByMaintenanceTaskList 112006
entity there is one MaintenanceTaskListID 112010 attribute.
[0890] The MaintenanceTaskListGroupID 112014 attribute has a
cardinality of 1 112016 meaning that for each instance of the
ParMaintenanceTaskListSimpleSelectionByMaintenanceTaskList 112006
entity there is one MaintenanceTaskListGroupID 112014 attribute.
The MaintenanceTaskListTypeCode 112018 attribute has a cardinality
of 1 112020 meaning that for each instance of the
ParMaintenanceTaskListSimpleSelectionByMaintenanceTaskList 112006
entity there is one MaintenanceTaskListTypeCode 112018 attribute.
The LevelNumberValue 112022 attribute has a cardinality of 1 112024
meaning that for each instance of the
ParMaintenanceTaskListSimpleSelectionByMaintenanceTaskList 112006
entity there is one LevelNumberValue 112022 attribute. The data
types of the various packages, entities, and attributes are
described with respect to FIG. 109.
[0891] FIGS. 113-1 through 113-2 show an example configuration of
an Element Structure that includes a
ParMaintTskListERPSimplByMaintTskListRspMsg_s 113000 package. The
ParMaintTskListERPSimplByMaintTskListRspMsg_s 113000 package
includes a ParMaintTskListERPSimplByMaintTskListRspMsg_s 113002
entity. The ParMaintTskListERPSimplByMaintTskListRspMsg_s 113000
package includes various packages, namely a MaintenanceTaskList
113004, and a Log 113030.
[0892] The MaintenanceTaskList 113004 package includes a
MaintenanceTaskList 113006 entity. The MaintenanceTaskList 113006
entity has a cardinality of 0..n 113008 meaning that for each
instance of the MaintenanceTaskList 113004 package there may be one
or more MaintenanceTaskList 113006 entities. The
MaintenanceTaskList 113006 entity includes various attributes,
namely an ID 113010, a GroupID 113014, a TypeCode 113018, a
LevelNumberValue 113022 and a Description 113026. The ID 113010
attribute has a cardinality of 1 113012 meaning that for each
instance of the MaintenanceTaskList 113006 entity there is one ID
113010 attribute.
[0893] The GroupID 113014 attribute has a cardinality of 1 113016
meaning that for each instance of the MaintenanceTaskList 113006
entity there is one GroupID 113014 attribute. The TypeCode 113018
attribute has a cardinality of 1 113020 meaning that for each
instance of the MaintenanceTaskList 113006 entity there is one
TypeCode 113018 attribute. The LevelNumberValue 113022 attribute
has a cardinality of 1 113024 meaning that for each instance of the
MaintenanceTaskList 113006 entity there is one LevelNumberValue
113022 attribute. The Description 113026 attribute has a
cardinality of 0..1 113028 meaning that for each instance of the
MaintenanceTaskList 113006 entity there may be one Description
113026 attribute.
[0894] The Log 113030 package includes a Log 113032 entity. The Log
113032 entity has a cardinality of 1 113034 meaning that for each
instance of the Log 113030 package there is one Log 113032 entity.
The data types of the various packages, entities, and attributes
are described with respect to FIG. 109.
[0895] FIG. 114 shows an example configuration of an Element
Structure that includes a
SubordMaintTskListERPSimplByMaintTskListQryMsg_s 114000 package.
The SubordMaintTskListERPSimplByMaintTskListQryMsg_s 114000 package
includes a SubordMaintTskListERPSimplByMaintTskListQryMsg_s 114002
entity. The SubordMaintTskListERPSimplByMaintTskListQryMsg_s 114000
package includes various packages, namely a Selection 114004.
[0896] The Selection 114004 package includes a
SubordinateMaintenanceTaskListSimpleSelectionByMaintenanceTaskList
114006 entity. The
SubordinateMaintenanceTaskListSimpleSelectionByMaintenanceTaskList
114006 entity has a cardinality of 1 114008 meaning that for each
instance of the Selection 114004 package there is one
SubordinateMaintenanceTaskListSimpleSelectionByMaintenanceTaskList
114006 entity. The
SubordinateMaintenanceTaskListSimpleSelectionByMaintenanceTaskList
114006 entity includes various attributes, namely a
MaintenanceTaskListID 114010, a MaintenanceTaskListGroupID 114014,
a MaintenanceTaskListTypeCode 114018 and a LevelNumberValue 114022.
The MaintenanceTaskListID 114010 attribute has a cardinality of 1
114012 meaning that for each instance of the
SubordinateMaintenanceTaskListSimpleSelectionByMaintenanceTaskList
114006 entity there is one MaintenanceTaskListID 114010
attribute.
[0897] The MaintenanceTaskListGroupID 114014 attribute has a
cardinality of 1 114016 meaning that for each instance of the
SubordinateMaintenanceTaskListSimpleSelectionByMaintenanceTaskList
114006 entity there is one MaintenanceTaskListGroupID 114014
attribute. The MaintenanceTaskListTypeCode 114018 attribute has a
cardinality of 1 114020 meaning that for each instance of the
SubordinateMaintenanceTaskListSimpleSelectionByMaintenanceTaskList
114006 entity there is one MaintenanceTaskListTypeCode 114018
attribute. The LevelNumberValue 114022 attribute has a cardinality
of 1 114024 meaning that for each instance of the
SubordinateMaintenanceTaskListSimpleSelectionByMaintenanceTaskList
114006 entity there is one LevelNumberValue 114022 attribute. The
data types of the various packages, entities, and attributes are
described with respect to FIG. 109.
[0898] FIGS. 115-1 through 115-2 show an example configuration of
an Element Structure that includes a
SubordMaintTskListERPSimplByMaintTskListRspMsg_s115000 package. The
SubordMaintTskListERPSimplByMaintTskListRspMsg_s 115000 package
includes a SubordMaintTskListERPSimplByMaintTskListRspMsg_s 115002
entity. The SubordMaintTskListERPSimplByMaintTskListRspMsg_s 115000
package includes various packages, namely a MaintenanceTaskList
115004, and a Log 115030.
[0899] The MaintenanceTaskList 115004 package includes a
MaintenanceTaskList 115006 entity. The MaintenanceTaskList 115006
entity has a cardinality of 0..N 115008 meaning that for each
instance of the MaintenanceTaskList 115004 package there may be one
or more MaintenanceTaskList 115006 entities. The
MaintenanceTaskList 115006 entity includes various attributes,
namely an ID 115010, a GroupID 115014, a TypeCode 115018, a
LevelNumberValue 115022 and a Description 115026. The ID 115010
attribute has a cardinality of 1 115012 meaning that for each
instance of the MaintenanceTaskList 115006 entity there is one ID
115010 attribute.
[0900] The GroupID 115014 attribute has a cardinality of 1 115016
meaning that for each instance of the MaintenanceTaskList 115006
entity there is one GroupID 115014 attribute. The TypeCode 115018
attribute has a cardinality of 1 115020 meaning that for each
instance of the MaintenanceTaskList 115006 entity there is one
TypeCode 115018 attribute. The LevelNumberValue 115022 attribute
has a cardinality of 1 115024 meaning that for each instance of the
MaintenanceTaskList 115006 entity there is one LevelNumberValue
115022 attribute. The Description 115026 attribute has a
cardinality of 0..1 115028 meaning that for each instance of the
MaintenanceTaskList 115006 entity there may be one Description
115026 attribute.
[0901] The Log 115030 package includes a Log 115032 entity. The Log
115032 entity has a cardinality of 1 115034 meaning that for each
instance of the Log 115030 package there is one Log 115032 entity.
The data types of the various packages, entities, and attributes
are described with respect to FIG. 109.
[0902] FIG. 116 shows an example configuration of an Element
Structure that includes a
TopLvlMaintTskListERPSimplByMaintTskListQryMsg_s 116000 package.
The TopLvlMaintTskListERPSimplByMaintTskListQryMsg_s 116000 package
includes a TopLvlMaintTskListERPSimplByMaintTskListQryMsg_s 116002
entity. The TopLvlMaintTskListERPSimplByMaintTskListQryMsg_s 116000
package includes various packages, namely a Selection 116004.
[0903] The Selection 116004 package includes a
TopLevelMaintenanceTaskListSimpleSelectionByMaintenanceTaskList
116006 entity. The
TopLevelMaintenanceTaskListSimpleSelectionByMaintenanceTaskList
116006 entity has a cardinality of 1 116008 meaning that for each
instance of the Selection 116004 package there is one
TopLevelMaintenanceTaskListSimpleSelectionByMaintenanceTaskList
116006 entity. The
TopLevelMaintenanceTaskListSimpleSelectionByMaintenanceTaskList
116006 entity includes various attributes, namely a
MaintenanceTaskListID 116010, a MaintenanceTaskListGroupID 116014
and a MaintenanceTaskListTypeCode 116018. The MaintenanceTaskListID
116010 attribute has a cardinality of 1 116012 meaning that for
each instance of the
TopLevelMaintenanceTaskListSimpleSelectionByMaintenanceTaskList
116006 entity there is one MaintenanceTaskListID 116010
attribute.
[0904] The MaintenanceTaskListGroupID 116014 attribute has a
cardinality of 1 116016 meaning that for each instance of the
TopLevelMaintenanceTaskListSimpleSelectionByMaintenanceTaskList
116006 entity there is one MaintenanceTaskListGroupID 116014
attribute. The MaintenanceTaskListTypeCode 116018 attribute has a
cardinality of 1 116020 meaning that for each instance of the
TopLevelMaintenanceTaskListSimpleSelectionByMaintenanceTaskList
116006 entity there is one MaintenanceTaskListTypeCode 116018
attribute. The data types of the various packages, entities, and
attributes are described with respect to FIG. 109.
[0905] FIG. 117 shows an example configuration of an Element
Structure that includes a
TopLvlMaintTskListERPSimplByMaintTskListRspMsg_s 117000 package.
The TopLvlMaintTskListERPSimplByMaintTskListRspMsg_s 117000 package
includes a TopLvlMainTskListERPSimplByMaintTskListRspMsg_s 117002
entity. The TopLvlMaintTskListERPSimplByMaintTskListRspMsg_s 117000
package includes various packages, namely a MaintenanceTaskList
117004, and a Log 117026.
[0906] The MaintenanceTaskList 117004 package includes a
MaintenanceTaskList 117006 entity. The MaintenanceTaskList 117006
entity has a cardinality of 0..1 117008 meaning that for each
instance of the MaintenanceTaskList 117004 package there may be one
MaintenanceTaskList 117006 entity. The MaintenanceTaskList 117006
entity includes various attributes, namely an ID 117010, a GroupID
117014, a TypeCode 117018 and a Description 117022.
[0907] The ID 117010 attribute has a cardinality of 1 117012
meaning that for each instance of the MaintenanceTaskList 117006
entity there is one ID 117010 attribute. The GroupID 117014
attribute has a cardinality of 1 117016 meaning that for each
instance of the MaintenanceTaskList 117006 entity there is one
GroupID 117014 attribute. The TypeCode 117018 attribute has a
cardinality of 1 117020 meaning that for each instance of the
MaintenanceTaskList 117006 entity there is one TypeCode 117018
attribute. The Description 117022 attribute has a cardinality of
0..1 117024 meaning that for each instance of the
MaintenanceTaskList 117006 entity there may be one Description
117022 attribute.
[0908] The Log 117026 package includes a Log 117028 entity. The Log
117028 entity has a cardinality of 1 117030 meaning that for each
instance of the Log 117026 package there is one Log 117028 entity.
The data types of the various packages, entities, and attributes
are described with respect to FIG. 109.
[0909] FIG. 118 shows an example configuration of an Element
Structure that includes a
MaintTskListERPByIDAndGrpIDAndTypeCodeQryMsg_s 118000 package. The
MaintTskListERPByIDAndGrpIDAndTypeCodeQryMsg_s 118000 package
includes a MaintTskListERPByIDAndGrpIDAndTypeCodeQryMsg_s 118002
entity. The MaintTskListERPByIDAndGrpIDAndTypeCodeQryMsg_s 118000
package includes various packages, namely a Selection 118004.
[0910] The Selection 118004 package includes a
MaintenanceTaskListSelectionByIDAndGrpIDAndTypeCode 118006 entity.
The MaintenanceTaskListSelectionByIDAndGrpIDAndTypeCode 118006
entity has a cardinality of 1 118008 meaning that for each instance
of the Selection 118004 package there is one
MaintenanceTaskListSelectionByIDAndGrpIDAndTypeCode 118006 entity.
The MaintenanceTaskListSelectionByIDAndGrpIDAndTypeCode 118006
entity includes various attributes, namely a MaintenanceTaskListID
118010, a MaintenanceTaskListGroupID 118014 and a
MaintenanceTaskListTypeCode 118018.
[0911] The MaintenanceTaskListID 118010 attribute has a cardinality
of 1 118012 meaning that for each instance of the
MaintenanceTaskListSelectionByIDAndGrpIDAndTypeCode 118006 entity
there is one MaintenanceTaskListID 118010 attribute. The
MaintenanceTaskListGroupID 118014 attribute has a cardinality of 1
118016 meaning that for each instance of the
MaintenanceTaskListSelectionByIDAndGrpIDAndTypeCode 118006 entity
there is one MaintenanceTaskListGroupID 118014 attribute. The
MaintenanceTaskListTypeCode 118018 attribute has a cardinality of 1
118020 meaning that for each instance of the
MaintenanceTaskListSelectionByIDAndGrpIDAndTypeCode 118006 entity
there is one MaintenanceTaskListTypeCode 118018 attribute. The data
types of the various packages, entities, and attributes are
described with respect to FIG. 109.
[0912] FIGS. 119-1 through 119-6 show an example configuration of
an Element Structure that includes a
MaintTskListERPByIDAndGrpIDAndTypeCodeRspMsg_s119000 package. The
MaintTskListERPByIDAndGrpIDAndTypeCodeRspMsg_s 119000 package
includes a MaintTskListERPByIDAndGrpIDAndTypeCodeRspMsg_s 119002
entity. The MaintTskListERPByIDAndGrpIDAndTypeCodeRspMsg_s 119000
package includes various packages, namely a MaintenanceTaskList
119004 and a Log 119146.
[0913] The MaintenanceTaskList 119004 package includes a
MaintenanceTaskList 119006 entity. The MaintenanceTaskList 119006
entity has a cardinality of 0..1 119008 meaning that for each
instance of the MaintenanceTaskList 119004 package there may be one
MaintenanceTaskList 119006 entity. The MaintenanceTaskList 119006
entity includes various attributes, namely an ID 119010, a GroupID
119014, a MaintenancePlanningPlantID 119018, a
MaintenanceWorkCentreID 119022, a MaintenanceWorkCentrePlantID
119026, a MaterialInternalID 119030, an InstallationPointID 119034,
an IndividualMaterialID 119038, a TypeCode 119042, a
MaintenancePlannerGroupCode 119046, a ProcessingStatusCode 119050,
an InstallationPointDescription 119054, an
IndividualMaterialDescription 119058, a MaterialDescription 119062
and a Description 119066. The MaintenanceTaskList 119006 entity
includes an Operation 119070 subordinate entity.
[0914] The ID 119010 attribute has a cardinality of 1 119012
meaning that for each instance of the MaintenanceTaskList 119006
entity there is one ID 119010 attribute. The GroupID 119014
attribute has a cardinality of 1 119016 meaning that for each
instance of the MaintenanceTaskList 119006 entity there is one
GroupID 119014 attribute. The MaintenancePlanningPlantID 119018
attribute has a cardinality of 1 119020 meaning that for each
instance of the MaintenanceTaskList 119006 entity there is one
MaintenancePlanningPlantID 119018 attribute. The
MaintenanceWorkCentreID 119022 attribute has a cardinality of 0..1
119024 meaning that for each instance of the MaintenanceTaskList
119006 entity there may be one MaintenanceWorkCentreID 119022
attribute. The MaintenanceWorkCentrePlantID 119026 attribute has a
cardinality of 0..1 119028 meaning that for each instance of the
MaintenanceTaskList 119006 entity there may be one
MaintenanceWorkCentrePlantID 119026 attribute. The
MaterialInternalID 119030 attribute has a cardinality of 0..1
119032 meaning that for each instance of the MaintenanceTaskList
119006 entity there may be one MaterialInternalID 119030
attribute.
[0915] The InstallationPointID 119034 attribute has a cardinality
of 0..1 119036 meaning that for each instance of the
MaintenanceTaskList 119006 entity there may be one
InstallationPointID 119034 attribute. The IndividualMaterialID
119038 attribute has a cardinality of 0..1 119040 meaning that for
each instance of the MaintenanceTaskList 119006 entity there may be
one IndividualMaterialID 119038 attribute. The TypeCode 119042
attribute has a cardinality of 1 119044 meaning that for each
instance of the MaintenanceTaskList 119006 entity there is one
TypeCode 119042 attribute. The MaintenancePlannerGroupCode 119046
attribute has a cardinality of 0..1 119048 meaning that for each
instance of the MaintenanceTaskList 119006 entity there may be one
MaintenancePlannerGroupCode 119046 attribute. The
ProcessingStatusCode 119050 attribute has a cardinality of 1 119052
meaning that for each instance of the MaintenanceTaskList 119006
entity there is one ProcessingStatusCode 119050 attribute. The
InstallationPointDescription 119054 attribute has a cardinality of
0..1 119056 meaning that for each instance of the
MaintenanceTaskList 119006 entity there may be one
InstallationPointDescription 119054 attribute.
[0916] The IndividualMaterialDescription 119058 attribute has a
cardinality of 0..1 119060 meaning that for each instance of the
MaintenanceTaskList 119006 entity there may be one
IndividualMaterialDescription 119058 attribute. The
MaterialDescription 119062 attribute has a cardinality of 0..1
119064 meaning that for each instance of the MaintenanceTaskList
119006 entity there may be one MaterialDescription 119062
attribute. The Description 119066 attribute has a cardinality of
0..1 119068 meaning that for each instance of the
MaintenanceTaskList 119006 entity there may be one Description
119066 attribute. The Operation 119070 entity has a cardinality of
0..n 119072 meaning that for each instance of the
MaintenanceTaskList 119006 entity there may be one or more
Operation 119070 entities. The Operation 119070 entity includes
various attributes, namely an ID 119074, an ActivityID 119078, a
MaintenanceWorkCentreID 119082, a MaintenanceWorkCentrePlantID
119086, a ControlProfileCode 119090, a PlannedDurationQuantity
119094, a PlannedWorkQuantity 119098 and a Description 119102. The
Operation 119070 entity includes various subordinate entities,
namely a Relationship 119106 and a MaterialInput 119130.
[0917] The ID 119074 attribute has a cardinality of 1 119076
meaning that for each instance of the Operation 119070 entity there
is one ID 119074 attribute. The ActivityID 119078 attribute has a
cardinality of 0..1 119080 meaning that for each instance of the
Operation 119070 entity there may be one ActivityID 119078
attribute. The MaintenanceWorkCentreID 119082 attribute has a
cardinality of 1 119084 meaning that for each instance of the
Operation 119070 entity there is one MaintenanceWorkCentreID 119082
attribute. The MaintenanceWorkCentrePlantID 119086 attribute has a
cardinality of 1 119088 meaning that for each instance of the
Operation 119070 entity there is one MaintenanceWorkCentrePlantID
119086 attribute. The ControlProfileCode 119090 attribute has a
cardinality of 1 119092 meaning that for each instance of the
Operation 119070 entity there is one ControlProfileCode 119090
attribute. The PlannedDurationQuantity 119094 attribute has a
cardinality of 0..1 119096 meaning that for each instance of the
Operation 119070 entity there may be one PlannedDurationQuantity
119094 attribute. The PlannedWorkQuantity 119098 attribute has a
cardinality of 0..1 119100 meaning that for each instance of the
Operation 119070 entity there may be one PlannedWorkQuantity 119098
attribute. The Description 119102 attribute has a cardinality of
0..1 119104 meaning that for each instance of the Operation 119070
entity there may be one Description 119102 attribute.
[0918] The Relationship 119106 entity has a cardinality of 0..n
119108 meaning that for each instance of the Operation 119070
entity there may be one or more Relationship 119106 entities. The
Relationship 119106 entity includes various attributes, namely an
OperationID 119110, a MaintenanceWorkCentreID 119114, a
MaintenanceWorkCentrePlantID 119118, a
NetworkPlanElementSuccessionTypeCode 119122 and a LagDuration
119126. The OperationID 119110 attribute has a cardinality of 1
119112 meaning that for each instance of the Relationship 119106
entity there is one OperationID 119110 attribute. The
MaintenanceWorkCentreID 119114 attribute has a cardinality of 0..1
119116 meaning that for each instance of the Relationship 119106
entity there may be one MaintenanceWorkCentreID 119114 attribute.
The MaintenanceWorkCentrePlantID 119118 attribute has a cardinality
of 0..1 119120 meaning that for each instance of the Relationship
119106 entity there may be one MaintenanceWorkCentrePlantID 119118
attribute.
[0919] The NetworkPlanElementSuccessionTypeCode 119122 attribute
has a cardinality of 0..1 119124 meaning that for each instance of
the Relationship 119106 entity there may be one
NetworkPlanElementSuccessionTypeCode 119122 attribute. The
LagDuration 119126 attribute has a cardinality of 0..1 119128
meaning that for each instance of the Relationship 119106 entity
there may be one LagDuration 119126 attribute. The MaterialInput
119130 entity has a cardinality of 0..n 119132 meaning that for
each instance of the Operation 119070 entity there may be one or
more MaterialInput 119130 entities. The MaterialInput 119130 entity
includes various attributes, namely a MaterialInternalID 119134, a
RequiredQuantity 119138 and a MaterialDescription 119142.
[0920] The MaterialInternalID 119134 attribute has a cardinality of
1 119136 meaning that for each instance of the MaterialInput 119130
entity there is one MaterialInternalID 119134 attribute. The
RequiredQuantity 119138 attribute has a cardinality of 1 119140
meaning that for each instance of the MaterialInput 119130 entity
there is one RequiredQuantity 119138 attribute. The
MaterialDescription 119142 attribute has a cardinality of 0..1
119144 meaning that for each instance of the MaterialInput 119130
entity there may be one MaterialDescription 119142 attribute.
[0921] The Log 119146 package includes a Log 119148 entity. The Log
119148 entity has a cardinality of 1 119150 meaning that for each
instance of the Log 119146 package there is one Log 119148 entity.
The data types of the various packages, entities, and attributes
are described with respect to FIG. 109.
RequestForSupplierFreightQuote Interfaces
[0922] A RequestForSupplierFreightQuote can be part of a
Transportation Management subcontracting and tendering process,
where transportation services can be tendered between
transportation service providers. The terms and conditions of a
transportation service, as well as the bidding rules of the
tendering process, can be specified in the
RequestForSupplierFreightQuote. The response of a supplier of the
transportation service to a customer is included in the
SupplierFreightQuote. A customer, such as Transportation Supplier
Quote Processing, can request a freight quote from a supplier, such
as Transportation Customer Quote Processing, by using the
interfaces supplied by RequestForSupplierFreightQuote.
[0923] A RequestForSupplierFreightQuoteRequest can be a request to
a supplier to provide a SupplierFreightQuote. The structure of the
RequestForSupplierFreightQuoteRequest can be specified by the
message data type RequestForSupplierFreightQuoteRequestMessage.
[0924] A RequestForSupplierFreightQuoteCancelRequest can be a
request to a supplier to cancel a RequestForSupplierFreightQuote.
The structure of the RequestForSupplierFreightQuoteCancelRequest
can be specified by the message data type
RequestForSupplierFreightQuoteCancelRequestMessage.
[0925] The message interfaces on the customer side include
RequestForSupplierFreightQuoteRequest_Out and
RequestForSupplierFreightQuoteCancelRequest_Out. The message
interfaces on the supplier side include
RequestForSupplierFreightQuoteRequest_In and
RequestForSupplierFreightQuoteCancelRequest_In.
[0926] The message choreography of FIG. 120 describes a possible
logical sequence of messages that can be used to realize a
Transportation Management business scenario. A "Customer" system
120000 can request a freight quote from a "Supplier" system 120002,
using a RequestForSupplierFreightQuoteRequest message 120004 as
shown, for example in FIG. 120. The "Customer" system 120000 can
request to cancel a freight quote request from the "Supplier"
system 120002, using a RequestForSupplierFreightQuoteCancelRequest
message 120006 as shown, for example in FIG. 120.
[0927] FIGS. 121-1 through 121-21 illustrate one example logical
configuration of RequestForSupplierFreightQuoteRequestMessage
message 121000. Specifically, this figure depicts the arrangement
and hierarchy of various components such as one or more levels of
packages, entities, and datatypes, shown here as 121002 through
121420. As described above, packages may be used to represent
hierarchy levels. Entities are discrete business elements that are
used during a business transaction. Data types are used to type
object entities and interfaces with a structure. For example,
RequestForSupplierFreightQuoteRequestMessage message 121000
includes, among other things, RequestForSupplierFreightQuote
121056. Accordingly, heterogeneous applications may communicate
using this consistent message configured as such.
[0928] Additionally, FIG. 122 illustrates one example logical
configuration of RequestForSupplierFreightQuoteCancelRequestMessage
message 122000. Specifically, this figure depicts the arrangement
and hierarchy of various components such as one or more levels of
packages, entities, and datatypes, shown here as 122002 through
122014. As described above, packages may be used to represent
hierarchy levels. Entities are discrete business elements that are
used during a business transaction. Data types are used to type
object entities and interfaces with a structure. For example,
RequestForSupplierFreightQuoteCancelRequestMessage message 122000
includes, among other things, RequestForSupplierFreightQuote
122004. Accordingly, heterogeneous applications may communicate
using this consistent message configured as such.
[0929] FIGS. 123-1 through 123-123 illustrate one example logical
configuration of a RequestForSupplierFreightQuoteRequestMessage
1230000 element structure. Specifically, these figures depict the
arrangement and hierarchy of various components such as one or more
levels of packages, entities, and datatypes, shown here as 1230000
through 1234666. As described above, packages may be used to
represent hierarchy levels. Entities are discrete business elements
that are used during a business transaction. Data types are used to
type object entities and interfaces with a structure. For example,
the RequestForSupplierFreightQuoteRequestMessage 1230000 includes,
among other things, a RequestForSupplierFreightQuoteRequestMessage
entity 1230002. Accordingly, heterogeneous applications may
communicate using this consistent message configured as such.
[0930] FIG. 124 illustrates one example logical configuration of a
RequestForSupplierFreightQuoteCancelRequestMessage 124000 element
structure. Specifically, this figure depicts the arrangement and
hierarchy of various components such as one or more levels of
packages, entities, and datatypes, shown here as 124000 through
124024. As described above, packages may be used to represent
hierarchy levels. Entities are discrete business elements that are
used during a business transaction. Data types are used to type
object entities and interfaces with a structure. For example, the
RequestForSupplierFreightQuoteCancelRequestMessage 124000 includes,
among other things, a
RequestForSupplierFreightQuoteCancelRequestMessage entity 124002.
Accordingly, heterogeneous applications may communicate using this
consistent message configured as such.
Message Data Type RequestForSupplierFreightQuoteRequestMessage
[0931] The message data type
RequestForSupplierFreightQuoteRequestMessage includes business
information relevant for sending a business document in a message,
and the RequestForSupplierFreightQuote included in a business
document. The message data type
RequestForSupplierFreightQuoteRequestMessage includes the
MessageHeader and RequestForSupplierFreightQuote packages.
[0932] A MessageHeader package can group together business
information relevant for sending a business document in a message.
The MessageHeader package includes the MessageHeader entity. A
MessageHeader can group together business information from the
perspective of a sending application, to identify a business
document in a message, to provide information about the sender, to
provide information about the recipient. The MessageHeader can be
divided up into the following entities: SenderParty and
RecipientParty. MessageHeader can be of type GDT:
BusinessDocumentMessageHeader. The MessageHeader includes the
following elements: ID, ReferenceID, and CreationDateTime. The
MessageID can be set by the sending application. With the
ReferencedMessageID, reference can be made in the current
BusinessDocument to a previous BusinessDocument.
[0933] A SenderParty can be a party responsible for sending a
business document at a business application level. The SenderParty
can be of type GDT: BusinessDocumentMessageHeaderParty. The
SenderParty includes the following elements: InternalID,
StandardID, and ContactPerson. The SenderParty can be filled by a
sending application to name a contact person for problems with the
message. A contact person can be useful if an additional
infrastructure, such as a marketplace, is located between the
sender and the recipient. The SenderParty can be used to transfer a
message and can be ignored by the receiving application.
SenderParty can be filled by the sender if the participating
parties are not transferred with the ShipmentRequest package.
[0934] A RecipientParty can be a party responsible for receiving a
business document at a business application level. The
RecipientParty can be of type GDT:
BusinessDocumentMessageHeaderParty. The RecipientParty includes the
following elements: InternalID, StandardID, and ContactPerson. The
RecipientParty can be filled by the sending application to name a
contact person for problems that occur with the message. A contact
person can be useful if an additional infrastructure, such as a
marketplace, is located between the sender and the recipient. The
RecipientParty can be used to transfer the message and can be
ignored by the receiving application. RecipientParty can be filled
by the sender if the ShipmentRequest package cannot be used to
transfer the participating parties.
[0935] The RequestForSupplierFreightQuote package can group the
RequestForSupplierFreightQuote together with its packages. The
RequestForSupplierFreightQuote package includes the
RequestForSupplierFreightQuote entity and the following packages:
HeaderInformation, GovernmentalRequirementInformation,
PartyInformation, TransportationStageInformation,
TransportationUnitResourceInformation,
TransportationChargesInformation, and
RequestForSupplierShipmentQuote.
[0936] RequestForSupplierFreightQuote can be a request from an
ordering party to a supplier of a transportation service to submit
a quote for the transportation of goods from one or multiple
ship-from parties to one or multiple ship-to parties with requested
terms and conditions. The structure of
RequestForSupplierFreightQuote includes the elements @actioncode
and ID. The @actioncode element can be a coded representation of an
instruction to a message recipient describing how to process the
transmitted element. The @actioncode element can be based on GDT:
ActionCode. ID can be a unique identifier for a
RequestForSupplierFreightQuote. ID can be based on GDT:
BusinessTransactionDocumentID. In some implementations, @actioncode
"01" (Create) is supported.
[0937] The HeaderInformation package can group dates, total values,
document and references related to a shipment request. The
HeaderInformation package includes the following entities:
DateTimePeriods, NatureOfCargo, TotalQuantity, TotalAmount,
TextCollection, TransportationServiceRequirement,
TransportationDocumentInformation, and
BusinessTransactionDocumentReference.
[0938] DateTimePeriods can specify a requested and an acceptable
date, time and period applying to a shipment request (e.g., date
and time of document issue). A requested period can be a period in
which an event is requested to take place. An acceptable period can
be a period in which an event may take place at an earliest start
date/time to a latest end date/time. The elements located directly
at the DateTimePeriods entity include RequestedFulfillmentPeriod,
AcceptableFulfillmentPeriod, and PeriodRoleCode.
RequestedFulfillmentPeriod can be a period which is requested
depending on semantics of the PeriodRoleCode.
RequestedFulfillmentPeriod can be based on GDT: DATETIMEPERIOD,
Qualifier: RequestedFulfillment. AcceptableFulfillmentPeriod can be
a period which is acceptable depending on semantics of the
PeriodRoleCode. AcceptableFulfillmentPeriod can be based on GDT:
DATETIMEPERIOD, Qualifier: AcceptableFulfillment. PeriodRoleCode
can be a coded representation of business semantics of the two
periods defined by the entities RequestedFulfillmentPeriod and
AcceptableFulfillmentPeriod. PeriodRoleCode can be based on GDT:
PeriodRoleCode. In some implementations, RequestedFulfillmentPeriod
and AcceptableFulfillmentPeriod are optional, but in every instance
one of them can be filled.
[0939] NatureOfCargo can indicate a nature of cargo related to a
shipment request (e.g., palletized, containerized, documents). The
structure of NatureOfCargo includes the element ClassificationCode.
ClassificationCode can be a coded representation of a
classification of a nature of cargo. ClassificationCode can be
based on GDT: NatureOfCargoClassificationCode.
[0940] TotalQuantity can specify a total quantity which is related
to a whole shipment request (e.g., total number of equipment, total
number of items). The structure of TotalQuantity includes the
Quantity, RoleCode, and TypeCode elements. Quantity can be a
non-monetary numerical specification of an amount in a unit of
measurement. Quantity can be based on GDT: Quantity. RoleCode can
be a coded representation of a role of a quantity, and can be based
on GDT: QuantityRoleCode. TypeCode can be a coded representation of
a type of quantity that is based on a measurable characteristic of
an object or physical phenomenon. TypeCode can be based on GDT:
QuantityTypeCode. In some implementations, QuantityRoleCode and
QuantityTypeCode are optional, but in every instance one of them
can be filled.
[0941] TotalAmount can specify a cumulated monetary amount related
to a shipment request (e.g., duty amount, insurance amount, total
value). The structure of TotalAmount includes the elements Amount
and RoleCode. Amount can be an amount with a corresponding currency
unit, and can be based on CDT: Amount. RoleCode can be a coded
representation of a role of an amount, and can be based on GDT:
AmountRoleCode.
[0942] TextCollection can be a group of textual information that
relates to a shipment request. The structure of the TextCollection
entity includes the TextCollection element. TextCollection can be
based on GDT: TextCollection.
[0943] TransportationServiceRequirement can specify a contract and
carriage condition and service and priority requirements for a
transport which apply to a whole shipment request. The structure of
TransportationServiceRequirement includes the elements
TransportationServiceRequirementCode,
AdditionalTransportationServiceRequirementCode,
TransportationContractConditionCode, TransportServiceLevelCode, and
NatureOfCargoClassificationCode.
TransportationServiceRequirementCode can be a coded representation
of a requirement related to a transportation service.
TransportationServiceRequirementCode can be based on GDT
TransportationServiceRequirementCode.
[0944] AdditionalTransportationServiceRequirementCode can be a
coded representation of an additional requirement related to a
transportation service, and can be based on GDT:
TransportationServiceRequirementCode, Qualifier: Additional.
TransportationContractConditionCode can be a coded representation
of a contract and carriage condition, and can be based on GDT:
TransportationContractConditionCode. TransportServiceLevelCode can
be a coded representation of agreed or defined services in terms of
the delivery of goods with respect to the speed of the delivery.
TransportServiceLevelCode can be based on GDT:
TransportServiceLevelCode. NatureOfCargoClassificationCode can be a
coded representation of a classification of a nature of cargo.
NatureOfCargoClassificationCode can be based on GDT:
NatureOfCargoClassificationCode.
[0945] TransportationDocumentInformation can specify information on
a transportation document related to a shipment request.
TransportationDocumentInformation includes the DateTimePeriod
entity. The structure of TransportationDocumentInformation includes
the following elements: TransportationDocumentTypeCode,
TransportationDocumentNote, TransportationDocumentID,
TransportationDocumentStatusCode, LanguageCode,
CommunicationMediumTypeCode, RequiredIndicator,
OutputCopyNumberValue, and OutputOriginalNumberValue.
TransportationDocumentTypeCode can be a coded representation of a
documentation type, and can be based on GDT:
TransportationDocumentTypeCode.
[0946] TransportationDocumentNote can be a short note on
documentation, and can be based on GDT: SHORT_Note.
TransportationDocumentID can be a unique identifier for a
transportation document, and can be based on GDT:
TransportationDocumentID. TransportationDocumentStatusCode can be a
coded representation of the status of a transportation document
(e.g., to be printed, document complete).
TransportationDocumentStatusCode can be based on GDT:
TransportationDocumentStatusCode. LanguageCode can be a coded
representation of the language of a documentation, and can be based
on GDT: LanguageCode. CommunicationMediumTypeCode can be a coded
representation of a type of a medium used for communication of a
documentation, such as Fax, mail, EDI, or Letter.
CommunicationMediumTypeCode can be based on GDT
CommunicationMediumTypeCode.
[0947] RequiredIndicator can indicate whether a documentation is
required or not. RequiredIndicator can be based on GDT: Indicator
Qualifier: Required. OutputCopyNumberValue can be a number
specifying the number of copies of a document that may be issued.
OutputCopyNumberValue can be based on GDT: NumberValue, Qualifier:
OutputCopy. OutputOriginalNumberValue can be a number specifying
the number of originals of a document that may be issued.
OutputOriginalNumberValue can be based on GDT: NumberValue,
Qualifier: OutputOriginal. In some implementations, TypeCode and
TypeDescription are both optional, but at least one of them can be
used. In some implementations, if the RequiredIndicator is set to
true, at least one of NumberValues, OutputCopyNumberValue or
OutputOriginalNumberValue may be filled.
[0948] DateTimePeriod can specify a date, time and/or period (e.g.,
validity date) related to business documentation. The structure of
the DateTimePeriod entity includes the elements DateTimePeriod and
PeriodRoleCode. DateTimePeriod can be a period that is defined by
two points in time, and can be based on GDT: DateTimePeriod.
PeriodRoleCode can be a coded representation of business semantics
of a period, and can be based on GDT: PeriodRoleCode.
[0949] BusinessTransactionDocumentReference can specify a business
document reference that is related to a whole shipment request.
BusinessTransactionDocumentReference includes the DateTimePeriod
entity. The structure of the BusinessTransactionDocumentReference
entity includes the following elements:
BusinessTransactionDocumentReference,
BusinessTransactionDocumentRelationshipRoleCode,
BusinessTransactionDocumentRelationshipTypeCode,
TransportationDocumentTypeCode, TransportationDocumentNote, and
TransportationDocumentID. BusinessTransactionDocumentReference can
be a unique reference to other business documents or business
document items that are of significance within each respective
business process. BusinessTransactionDocumentReference can be based
on GDT: BusinessTransactionDocumentReference.
[0950] BusinessTransactionDocumentRelationshipRoleCode can be a
coded representation of a role that a business document or a
business document item has when set against another business
document or business document item with a relationship.
BusinessTransactionDocumentRelationshipRoleCode can be based on
GDT: BusinessTransactionDocumentRelationshipRoleCode.
BusinessTransactionDocumentRelationshipTypeCode can be a coded
representation of a relationship between two business documents or
business document items.
BusinessTransactionDocumentRelationshipTypeCode can be based on
GDT: BusinessTransactionDocumentRelationshipTypeCode.
TransportationDocumentTypeCode can be a coded representation of a
documentation type.
[0951] TransportationDocumentTypeCode can be based on GDT:
TransportationDocumentTypeCode. TransportationDocumentNote can be a
short Note on documentation. TransportationDocumentNote can be
based on GDT: SHORT_Note. TransportationDocumentID can be a unique
identifier for a transportation document. TransportationDocumentID
can be based on GDT: TransportationDocumentID. RelationshipTypeCode
and RelationshipRoleCode are both optional. In some
implementations, if used, both may be filled. Either the
combination BusinessTransactionDocumentReference,
BusinessTransactionDocumentRelationshipRoleCode,
BusinessTransactionDocumentRelationshipTypeCode or
TransportationDocumentTypeCode, TransportationDocumentNote,
TransportationDocumentID may be filled.
[0952] DateTimePeriod can specify a date, time and/or period
related to a DocumentReference. The elements located directly at
the DateTimePeriods entity include RequestedFulfillmentPeriod,
AcceptableFulfillmentPeriod, and PeriodRoleCode.
RequestedFulfillmentPeriod can be a period which is requested
depending on semantics of the PeriodRoleCode.
RequestedFulfillmentPeriod can be based on GDT: DATETIMEPERIOD,
Qualifier: RequestedFulfillment. AcceptableFulfillmentPeriod can be
a period which is acceptable depending on semantics of the
PeriodRoleCode. AcceptableFulfillmentPeriod can be based on GDT:
DATETIMEPERIOD, Qualifier: AcceptableFulfillment. PeriodRoleCode
can be a coded representation of business semantics of the two
periods defined by the entities RequestedFulfillmentPeriod and
AcceptableFulfillmentPeriod. PeriodRoleCode can be based on GDT:
PeriodRoleCode. In some implementations, RequestedFulfillmentPeriod
and AcceptableFulfillmentPeriod are optional, but in every instance
one of them may be filled.
[0953] The GovernmentalRequirementInformation package can specify
applicable governmental procedures related to import, export and
transport of goods of a shipment request. The
GovernmentalRequirementInformation package includes the
GovernmentalProcedure entity.
[0954] GovernmentalProcedure can specify applicable governmental
procedures related to import, export and transport of goods of a
shipment request. GovernmentalProcedure includes the entities
Location, DateTimePeriod, TextCollection, and
TransportationDocumentInformation. The structure of
GovernmentalProcedure includes the following elements:
TransportationGovernmentAgencyTypeCode,
TransportationMovementTypeCode,
TransportationGovernmentAgencyInvolvementStatusCode,
TransportationGovernmentAgencyActionCode, and
TransportationGovernmentAgencyProcedureStatusCode.
TransportationGovernmentAgencyTypeCode can be a coded
representation of a government agency type, and can be based on
GDT: TransportationGovernmentAgencyTypeCode.
[0955] TransportationMovementTypeCode can be a coded representation
of a transport movement type. Example transport movement types
include Import, Export, Transit, and Transshipment.
TransportationMovementTypeCode can be based on GDT:
TransportationMovementTypeCode.
TransportationGovernmentAgencyInvolvementStatusCode can be a coded
representation for an involvement status of a transportation
related government agency.
TransportationGovernmentAgencyInvolvementStatusCode can be based on
GDT: TransportationGovernmentAgencyInvolvementStatusCode.
TransportationGovernmentAgencyActionCode can be a coded
representation of an action of a transportation related government
agency.
[0956] TransportationGovernmentAgencyActionCode can be based on
GDT: TransportationGovernmentAgencyActionCode.
TransportationGovernmentAgencyProcedureStatusCode can be a coded
representation of a status of a procedure related to a
transportation government agency.
TransportationGovernmentAgencyProcedureStatusCode can be based on
GDT: TransportationGovernmentAgencyProcedureStatusCode.
[0957] Location can be a physical place related to a
GovernmentalProcedure. The structure of the Location entity
includes the following elements: Location, RoleCode, TypeCode, and
Name. Location includes information exchanged in business documents
about a location relevant for business transactions. Location can
be based on GDT: BusinessTransactionDocumentLocation. RoleCode can
be a coded representation of a LocationRole. RoleCode can be based
on GDT: LocationRoleCode. TypeCode can be a coded representation of
a type of a physical location. TypeCode can be based on GDT:
LocationTypeCode. Name can be a name of a location. Name can be
based on GDT: MEDIUM_Name, Qualifier: Location.
[0958] DateTimePeriod can specify a date, time and/or period
related to a GovernmentalProcedure. The elements located directly
at the DateTimePeriods entity include RequestedFulfillmentPeriod,
AcceptableFulfillmentPeriod, and PeriodRoleCode.
RequestedFulfillmentPeriod can be a period which is requested
depending on semantics of the PeriodRoleCode.
RequestedFulfillmentPeriod can be based on GDT: DATETIMEPERIOD,
Qualifier: RequestedFulfillment. AcceptableFulfillmentPeriod can be
a period which is acceptable depending on semantics of the
PeriodRoleCode. AcceptableFulfillmentPeriod can be based on GDT:
DATETIMEPERIOD, Qualifier: AcceptableFulfillment. PeriodRoleCode
can be a coded representation of business semantics of the two
periods defined by the entities RequestedFulfillmentPeriod and
AcceptableFulfillmentPeriod. PeriodRoleCode can be based on GDT:
PeriodRoleCode. In some implementations, RequestedFulfillmentPeriod
and AcceptableFulfillmentPeriod are optional, but in every instance
one of them may be filled.
[0959] TextCollection can be a group of textual information that
relates to a GovernmentalProcedure. The structure of the
TextCollection entity includes the element TextCollection.
TextCollection can be based on GDT: TextCollection.
[0960] TransportationDocumentInformation can specify information on
a transportation document related to the GovernmentalProcedure. It
includes the DateTimePeriod entity. The structure of
TransportationDocumentInformation includes the elements:
TransportationDocumentTypeCode, TransportationDocumentNote,
TransportationDocumentID, TransportationDocumentStatusCode,
LanguageCode, CommunicationMediumTypeCode, RequiredIndicator,
OutputCopyNumberValue, and OutputOriginalNumberValue.
TransportationDocumentTypeCode can be a coded representation of the
type of a documentation, and can be based on GDT:
TransportationDocumentTypeCode. TransportationDocumentNote can be a
short Note on the documentation, and can be based on GDT:
SHORT_Note. TransportationDocumentID can be a unique identifier for
a transportation document, and can be based on GDT:
TransportationDocumentID.
[0961] TransportationDocumentStatusCode can be a coded
representation of the status of a transportation document, e.g., To
be printed, or Document Complete. TransportationDocumentStatusCode
can be based on GDT: TransportationDocumentStatusCode. LanguageCode
can be a coded representation of the language of a documentation,
and can be based on GDT: LanguageCode. CommunicationMediumTypeCode
can be a coded representation of the type of a medium used for
communication of the documentation, such as, Fax, mail, EDI, or
Letter. CommunicationMediumTypeCode can be based on GDT
CommunicationMediumTypeCode. RequiredIndicator can indicate whether
a documentation is required or not. RequiredIndicator can be based
on GDT: Indicator Qualifier: Required.
[0962] OutputCopyNumberValue can be a number specifying the number
of copies of the document that should be issued.
OutputCopyNumberValue can be based on GDT: NumberValue, Qualifier:
OutputCopy. OutputOriginalNumberValue can be a number specifying
the number of originals of the document that should be issued.
OutputOriginalNumberValue can be based on GDT: NumberValue,
Qualifier: OutputOriginal. In some implementations, TypeCode and
TypeDescription are both optional, but at least one of them has to
be used. In some implementations, if the RequiredIndicator is set
to true, at least one of the both NumberValues
OutputCopyNumberValue or OutputOriginalNumberValue has to be
filled.
[0963] DateTimePeriod can specify date, time and/or period related
to the Documentation. The elements located directly at the
DateTimePeriods entity include: RequestedFulfillmentPeriod,
AcceptableFulfillmentPeriod, and PeriodRoleCode.
RequestedFulfillmentPeriod can be a period which is requested
depending on the semantic of the PeriodRoleCode.
RequestedFulfillmentPeriod can be based on GDT: DATETIMEPERIOD,
Qualifier: RequestedFulfillment. AcceptableFulfillmentPeriod can be
a period which is still acceptable depending on the semantic of the
PeriodRoleCode. AcceptableFulfillmentPeriod can be based on GDT:
DATETIMEPERIOD, Qualifier: AcceptableFulfillment. PeriodRoleCode
can be a coded representation of the business semantic of the two
periods defined by the entities RequestedFulfillmentPeriod and
AcceptableFulfillmentPeriod. PeriodRoleCode can be based on GDT:
PeriodRoleCode. In some implementations, RequestedFulfillmentPeriod
and AcceptableFulfillmentPeriod are optional, but in every instance
one of them has to be filled.
[0964] The PartyInformation package includes information regarding
a party of the shipment request, i.e., Shipper, Carrier, or Agent.
It includes the Party entity. Party includes information exchanged,
in accordance with common business understanding, in business
documents about a party involved in business transactions. This
information can be used to identify the party and the party's
address, as well as the party's contact person and the contact
person's address. This identification can take place using an
internal ID, a standardized ID, or IDs assigned by the parties
involved. It includes the entities: Amount, DateTimePeriods,
TransportationDocumentInformation, and
BusinessTransactionDocumentReference. The structure of the Party
entity includes the Party, RoleCode, and FormattedName
entities.
[0965] A Party includes information exchanged, in accordance with
common business understanding, in business documents about a party
involved in business transactions. This information can be used to
identify the party and the party's address, as well as the party's
contact person and the contact person's address. This
identification can take place using an internal ID, a standardized
ID, or IDs assigned by the parties involved. Party can be based on
GDT: BusinessTransactionDocumentParty. RoleCode can be a coded
representation of a PartyRoleCode which specifies which rights and
obligations the party has regarding a business object and
corresponding processes. In some implementations, a PartyRole is
assigned to a PartyRoleCategory and refines its semantics. RoleCode
can be based on GDT: PartyRoleCode. FormattedName can be a
complete, formatted name of a party, and can be based on GDT:
LONG_Name, Qualifier: PartyFormatted.
[0966] Amount can specify an amount related to a party. The
structure of the Amount entity includes the elements Amount and
RoleCode. Amount can be an amount with a corresponding currency
unit, and can be based on CDT: Amount. RoleCode can be a coded
representation of a role of an amount, and can be based on GDT:
AmountRoleCode. DateTimePeriods can specify a requested and an
acceptable date, time and period related to a party. A requested
period can be a period in which an event is requested to take
place. An acceptable period is a period in which an event may take
place at an earliest start date/time to a latest end date/time. The
elements located directly at the DateTimePeriods entity include
RequestedFulfillmentPeriod, AcceptableFulfillmentPeriod, and
PeriodRoleCode. RequestedFulfillmentPeriod can be a period which is
requested depending on semantics of the PeriodRoleCode.
RequestedFulfillmentPeriod can be based on GDT: DATETIMEPERIOD,
Qualifier: RequestedFulfillment. AcceptableFulfillmentPeriod can be
a period which is acceptable depending on semantics of the
PeriodRoleCode. AcceptableFulfillmentPeriod can be based on GDT:
DATETIMEPERIOD, Qualifier: AcceptableFulfillment. PeriodRoleCode
can be a coded representation of business semantics of the two
periods defined by the entities RequestedFulfillmentPeriod and
AcceptableFulfillmentPeriod. PeriodRoleCode can be based on GDT:
PeriodRoleCode. In some implementations, RequestedFulfillmentPeriod
and AcceptableFulfillmentPeriod are optional, but in every instance
one of them may be filled.
[0967] TransportationDocumentInformation can specify business
documentation related to a party according to a documentation type.
TransportationDocumentInformation includes the DateTimePeriod
entity. The structure of TransportationDocumentInformation includes
the following elements: TransportationDocumentTypeCode,
TransportationDocumentNote, TransportationDocumentID,
TransportationDocumentStatusCode, LanguageCode,
CommunicationMediumTypeCode, RequiredIndicator,
OutputCopyNumberValue, and OutputOriginalNumberValue.
TransportationDocumentTypeCode can be a coded representation of a
documentation type, and can be based on GDT:
TransportationDocumentTypeCode. TransportationDocumentNote can be a
short note on documentation, and can be based on GDT: SHORT_Note.
TransportationDocumentID can be a unique identifier for a
transportation document, and can be based on GDT:
TransportationDocumentID.
[0968] TransportationDocumentStatusCode can be a coded
representation of a status of a transportation document (e.g., to
be printed, document complete). TransportationDocumentStatusCode
can be based on GDT: TransportationDocumentStatusCode. LanguageCode
can be a coded representation of the language of a documentation,
and can be based on GDT: LanguageCode. CommunicationMediumTypeCode
can be a coded representation of the type of a medium used for
communication of a documentation, such as Fax, mail, EDI, or
Letter. CommunicationMediumTypeCode can be based on GDT
CommunicationMediumTypeCode. RequiredIndicator can indicate whether
a documentation is required or not. RequiredIndicator can be based
on GDT: Indicator Qualifier: Required.
[0969] OutputCopyNumberValue can be a number specifying the number
of copies of a document that may be issued. OutputCopyNumberValue
can be based on GDT: NumberValue, Qualifier: OutputCopy.
OutputOriginalNumberValue can be a number specifying the number of
originals of a document that may be issued.
OutputOriginalNumberValue can be based on GDT: NumberValue,
Qualifier: OutputOriginal. In some implementations, TypeCode and
TypeDescription are both optional, but at least one of them can be
used. In some implementations, if the RequiredIndicator is set to
true, at least one of NumberValues, OutputCopyNumberValue or
OutputOriginalNumberValue may be filled.
[0970] DateTimePeriod can specify date, time and/or period (e.g.,
validity date) related to a business documentation of a party. The
elements located directly at the DateTimePeriods entity include
RequestedFulfillmentPeriod, AcceptableFulfillmentPeriod, and
PeriodRoleCode. RequestedFulfillmentPeriod can be a period which is
requested depending on semantics of the PeriodRoleCode.
RequestedFulfillmentPeriod can be based on GDT: DATETIMEPERIOD,
Qualifier: RequestedFulfillment. AcceptableFulfillmentPeriod can be
a period which is acceptable depending on semantics of the
PeriodRoleCode. AcceptableFulfillmentPeriod can be based on GDT:
DATETIMEPERIOD, Qualifier: AcceptableFulfillment. PeriodRoleCode
can be a coded representation of business semantics of the two
periods defined by the entities RequestedFulfillmentPeriod and
AcceptableFulfillmentPeriod. PeriodRoleCode can be based on GDT:
PeriodRoleCode. In some implementations, RequestedFulfillmentPeriod
and AcceptableFulfillmentPeriod are optional, but in every instance
one of them may be filled.
[0971] BusinessTransactionDocumentReference can specify a business
document reference that is related to a party.
BusinessTransactionDocumentReference includes the DateTimePeriod
entity. The structure of the BusinessTransactionDocumentReference
entity includes the following elements:
BusinessTransactionDocumentReference,
BusinessTransactionDocumentRelationshipRoleCode,
BusinessTransactionDocumentRelationshipTypeCode,
TransportationDocumentTypeCode, TransportationDocumentNote, and
TransportationDocumentID. BusinessTransactionDocumentReference can
be a unique reference to other business documents or business
document items that are of significance within each respective
business process. BusinessTransactionDocumentReference can be based
on GDT: BusinessTransactionDocumentReference.
[0972] BusinessTransactionDocumentRelationshipRoleCode can be a
coded representation of a role that a business document or a
business document item has when set against another business
document or business document item with a relationship.
BusinessTransactionDocumentRelationshipRoleCode can be based on
GDT: BusinessTransactionDocumentRelationshipRoleCode.
BusinessTransactionDocumentRelationshipTypeCode can be a coded
representation of a relationship between two business documents or
business document items.
BusinessTransactionDocumentRelationshipTypeCode can be based on
GDT: BusinessTransactionDocumentRelationshipTypeCode.
[0973] TransportationDocumentTypeCode can be a coded representation
of a documentation type. TransportationDocumentTypeCode can be
based on GDT: TransportationDocumentTypeCode.
TransportationDocumentNote can be a short Note on documentation.
TransportationDocumentNote can be based on GDT: SHORT_Note.
TransportationDocumentID can be a unique identifier for a
transportation document. TransportationDocumentID can be based on
GDT: TransportationDocumentID. RelationshipTypeCode and
RelationshipRoleCode are both optional. In some implementations, if
used, both may be filled. Either the combination
BusinessTransactionDocumentReference,
BusinessTransactionDocumentRelationshipRoleCode,
BusinessTransactionDocumentRelationshipTypeCode or
TransportationDocumentTypeCode, TransportationDocumentNote,
TransportationDocumentID may be filled.
[0974] DateTimePeriod can specify date, time and/or period related
to a document referenced by a party. The elements located directly
at the DateTimePeriods entity include RequestedFulfillmentPeriod,
AcceptableFulfillmentPeriod, and PeriodRoleCode.
RequestedFulfillmentPeriod can be a period which is requested
depending on semantics of the PeriodRoleCode.
RequestedFulfillmentPeriod can be based on GDT: DATETIMEPERIOD,
Qualifier: RequestedFulfillment. AcceptableFulfillmentPeriod can be
a period which is acceptable depending on semantics of the
PeriodRoleCode. AcceptableFulfillmentPeriod can be based on GDT:
DATETIMEPERIOD, Qualifier: AcceptableFulfillment. PeriodRoleCode
can be a coded representation of business semantics of the two
periods defined by the entities RequestedFulfillmentPeriod and
AcceptableFulfillmentPeriod. PeriodRoleCode can be based on GDT:
PeriodRoleCode. In some implementations, RequestedFulfillmentPeriod
and AcceptableFulfillmentPeriod are optional, but in every instance
one of them may be filled.
[0975] The TransportationStageInformation package includes
information regarding a transportation stage of a shipment request.
A transportation stage can represent a section of a transport. The
TransportationStageInformation package includes the Stage entity.
TransportationStage can specify the details related to a stage of a
transport which is part of a shipment request. TransportationStage
includes the entities Location, TransportationDocumentInformation,
and TransportationServiceRequirement. The structure of
TransportationStage includes the following elements: ID,
OutputOriginalNumberValue, TypeCode, JourneyID, TransportModeCode,
TransportMeansDescriptionCode, TransportMeansDescription,
TransportMeansID, TransportMeansHomeCountryCode,
TransportMeansOwnershipTypeCode, CarrierStandardID,
CarrierFormattedName, TransportationTransitDirectionCode,
CalculatedDistanceMeasure, and GivenDistanceMeasure. ID can be a
unique identifier of a stage in a shipment request. ID can be based
on GDT: TransportationStageID. OrdinalNumberValue can be an ordinal
number to indicate a position of a transportation stage in a set of
transportation stages.
[0976] OrdinalNumberValue can be based on GDT: OrdinalNumberValue,
Qualifier: TransportationStage. TypeCode can be a coded
representation of a type of a TransportationStage. TypeCode can be
based on GDT: TransportationStageTypeCode. JourneyID can be an
identifier of a Journey. JourneyID can be based on GDT: JourneyID.
TransportModeCode can be a coded representation of a mode of
transportation used for delivery. TransportModeCode can be based on
GDT: TransportModeCode. TransportMeansDescriptionCode can be a
coded representation of a transport means type with which goods or
persons can be transported. TransportMeansDescriptionCode can be
based on GDT: TransportMeansDescriptionCode.
TransportMeansDescription can be a description of a means of
transport, and can be based on GDT: SHORT_Description, Qualifier:
TransportMeans. TransportMeansID can be a unique identifier of a
means of transport, and can be based on GDT: TransportMeansID.
[0977] TransportMeansHomeCountryCode can be a coded representation
of the home country of a transport means, and can be based on GDT:
CountryCode, Qualifier: TransportMeansHome.
TransportMeansOwnershipTypeCode can be a coded representation of a
type of ownership for a means of transport, and can be based on
GDT: TransportMeansOwnershipTypeCode. CarrierStandardID can be a
standard identifier of a carrier, and can be based on GDT:
PartyStandardID. CarrierFormattedName can be a name of a carrier,
and can be based on GDT: LONG_Name, Qualifier: PartyFormatted.
TransportationTransitDirectionCode can be a coded representation
for a transportation transit direction.
TransportationTransitDirectionCode can be based on GDT:
TransportationTransitDirectionCode. CalculatedDistanceMeasure can
be a calculated distance measure, and can be based on GDT: Measure,
Qualifier: CalculatedDistance. GivenDistanceMeasure can be a given
distance measure, and can be based on GDT: Measure, Qualifier:
GivenDistance.
[0978] StageLocation can specify a physical place related to a
stage. StageLocation includes the DateTimePeriods entity. The
structure of the Location entity includes the following elements:
Location, RoleCode, TypeCode, and Name. Location includes
information exchanged in business documents about a location
relevant for business transactions. Location can be based on GDT:
BusinessTransactionDocumentLocation. RoleCode can be a coded
representation of a LocationRole, and can be based on GDT:
LocationRoleCode. TypeCode can be a coded representation of a type
of a physical location. TypeCode can be based on GDT:
LocationTypeCode. Name can be a name of a location, and can be
based on GDT: MEDIUM_Name, Qualifier: Location.
[0979] DateTimePeriods can specify a date, time and/or period
related to a Location. The elements located directly at the
DateTimePeriods entity include RequestedFulfillmentPeriod,
AcceptableFulfillmentPeriod, and PeriodRoleCode.
RequestedFulfillmentPeriod can be a period which is requested
depending on semantics of a PeriodRoleCode.
RequestedFulfillmentPeriod can be based on GDT: DATETIMEPERIOD,
Qualifier: RequestedFulfillment. AcceptableFulfillmentPeriod can be
a period which is acceptable depending on semantics of a
PeriodRoleCode. AcceptableFulfillmentPeriod can be based on GDT:
DATETIMEPERIOD, Qualifier: AcceptableFulfillment. PeriodRoleCode
can be a coded representation of business semantics of the two
periods defined by the entities RequestedFulfillmentPeriod and
AcceptableFulfillmentPeriod. PeriodRoleCode can be based on GDT:
PeriodRoleCode. In some implementations, RequestedFulfillmentPeriod
and AcceptableFulfillmentPeriod are optional, but in every instance
one of them may be filled.
[0980] BusinessTransactionDocumentReference can specify a business
document reference that is related to a Stage.
BusinessTransactionDocumentReference includes the DateTimePeriod
entity. The structure of the BusinessTransactionDocumentReference
entity includes the elements BusinessTransactionDocumentReference,
BusinessTransactionDocumentRelationshipRoleCode,
BusinessTransactionDocumentRelationshipTypeCode,
TransportationDocumentTypeCode, TransportationDocumentNote, and
TransportationDocumentID. BusinessTransactionDocumentReference can
be a unique reference to other business documents or business
document items that are of significance within each respective
business process. BusinessTransactionDocumentReference can be based
on GDT: BusinessTransactionDocumentReference.
[0981] BusinessTransactionDocumentRelationshipRoleCode can be a
coded representation of a role that a business document or a
business document item has when set against another business
document or business document item with a relationship.
BusinessTransactionDocumentRelationshipRoleCode can be based on
GDT: BusinessTransactionDocumentRelationshipRoleCode.
BusinessTransactionDocumentRelationshipTypeCode can be a coded
representation of a relationship between two business documents or
business document items.
BusinessTransactionDocumentRelationshipTypeCode can be based on
GDT: BusinessTransactionDocumentRelationshipTypeCode.
[0982] TransportationDocumentTypeCode can be a coded representation
of a documentation type. TransportationDocumentTypeCode can be
based on GDT: TransportationDocumentTypeCode.
TransportationDocumentNote can be a short Note on documentation.
TransportationDocumentNote can be based on GDT: SHORT_Note.
TransportationDocumentID can be a unique identifier for a
transportation document. TransportationDocumentID can be based on
GDT: TransportationDocumentID. RelationshipTypeCode and
RelationshipRoleCode are both optional. In some implementations, if
used, both may be filled. Either the combination
BusinessTransactionDocumentReference,
BusinessTransactionDocumentRelationshipRoleCode,
BusinessTransactionDocumentRelationshipTypeCode or
TransportationDocumentTypeCode, TransportationDocumentNote,
TransportationDocumentID may be filled.
[0983] DateTimePeriod can specify a date, time and/or period
related to a BusinessTransactionDocumentReference. The elements
located directly at the DateTimePeriods entity include
RequestedFulfillmentPeriod, AcceptableFulfillmentPeriod, and
PeriodRoleCode. RequestedFulfillmentPeriod can be a period which is
requested depending on semantics of the PeriodRoleCode.
RequestedFulfillmentPeriod can be based on GDT: DATETIMEPERIOD,
Qualifier: RequestedFulfillment. AcceptableFulfillmentPeriod can be
a period which is acceptable depending on semantics of the
PeriodRoleCode. AcceptableFulfillmentPeriod can be based on GDT:
DATETIMEPERIOD, Qualifier: AcceptableFulfillment. PeriodRoleCode
can be a coded representation of business semantics of the two
periods defined by the entities RequestedFulfillmentPeriod and
AcceptableFulfillmentPeriod. PeriodRoleCode can be based on GDT:
PeriodRoleCode. In some implementations, RequestedFulfillmentPeriod
and AcceptableFulfillmentPeriod are optional, but in every instance
one of them may be filled.
[0984] TransportationServiceRequirement can specify a contract and
carriage condition and service and priority requirements related to
a stage. The structure of TransportationServiceRequirement includes
the following elements: TransportationServiceRequirementCode,
AdditionalTransportationServiceRequirementCode,
TransportationContractConditionCode, TransportServiceLevelCode, and
NatureOfCargoClassificationCode.
TransportationServiceRequirementCode can be a coded representation
of a requirement related to a transportation service, and can be
based on GDT: TransportationServiceRequirementCode.
[0985] AdditionalTransportationServiceRequirementCode can be a
coded representation of an additional requirement related to a
transportation service, and can be based on GDT:
TransportationServiceRequirementCode, Qualifier: Additional.
TransportationContractConditionCode can be a coded representation
of a contract and carriage condition, and can be based on GDT:
TransportationContractConditionCode. TransportServiceLevelCode can
be a coded representation of agreed or defined services in terms of
the delivery of goods with respect to the speed of the delivery.
TransportServicesLevelCode can be based on GDT:
TransportServiceLevelCode. NatureOfCargoClassificationCode can be a
coded representation of a classification of the nature of cargo.
NatureOfCargoClassificationCode can be based on GDT:
NatureOfCargoClassificationCode.
[0986] The TransportationUnitResourceInformation package includes
information regarding a transportation unit resource that is
relevant for a shipment request (e.g., a container). The
TransportationUnitResourceInformation package includes the
TransportationUnitResourceInformation entity.
TransportationUnitResourceInformation includes information on one
or more transportation unit resources, such as a resource type and
related properties, related measures or handling instructions. A
Transportation Unit Resource can be a unit into which goods are
loaded and/or from which goods are unloaded. In some
implementations, this unit can provide transportation capacity for
goods but may or may not move by itself.
TransportationUnitResourceInformation includes the following
entities: TransportationStageAssignment, AttachedEquipment,
Quantity, Seal, BusinessTransactionDocumentReference,
TextCollection, Location, and Dangerous Goods. The structure of
TransportationUnitResourceInformation includes the following
elements: ID, ResourceNumberValue, ResourceID,
ResourceHomeCountryCode, TransportationUnitResourceCategoryCode,
TransportationUnitResourceTypeCode, FillLevelCode,
ShippingTypeCode, HaulageArrangerCode,
TransportationHandlingInstructionCode, and
TransportationHandlingInstructionNote.
[0987] ID can be a unique identifier for a resource information,
and can be based on GDT ResourceInformationID. ResourceNumberValue
can be a count of resources, and can be based on GDT: NumberValue,
Qualifier: Resource. ResourceID can be a unique identifier for a
resource, and can be based on GDT: ResourceID.
ResourceHomeCountryCode can be a coded representation of the home
country of a resource, and can be based on GDT: CountryCode,
Qualifier: ResourceHome. TransportationUnitResourceCategoryCode can
be a coded representation of a category of transportation unit
resources, and can be based on GDT:
TransportationUnitResourceCategoryCode.
TransportationUnitResourceTypeCode can be a coded representation of
the type of a transportation unit resource.
TransportationUnitResourceTypeCode can be based on GDT:
TransportationUnitResourceTypeCode.
[0988] FillLevelCode can be a coded representation of a fill level
of a resource, and can be based on GDT: FillLevelCode.
ShippingTypeCode can be a coded representation of a shipping type.
A shipping type can specify how planning and execution of a
transportation can be performed. Transportation terms include
detailed specifications on agreed means of transportation, such as
shipping or transport type, and means of transport to be used.
ShippingTypeCode can be based on GDT: ShippingTypeCode.
HaulageArrangerCode can be a coded representation of an arranger of
a haulage. Haulage can be inland transport of cargo.
HaulageArrangerCode can be based on GDT: HaulageArrangerCode.
TransportationHandlingInstructionCode can be a coded representation
of a type of a transportation handling instruction, and can be
based on GDT: TransportationHandlingInstructionCode.
TransportationHandlingInstructionNote can be a note regarding a
transportation handling instruction, and can be based on GDT:
LONG_Note, Qualifier: TransportationHandlingInstruction.
[0989] TransportationStageAssignment can specify an assignment of a
transportation stage to a transportation unit resource information.
The structure of TransportationStageAssignment includes the element
ShipmentRequestTransportationStageID.
ShipmentRequestTransportationStageID can be a unique identifier of
a TransportationStage in a shipment request, and can be based on
GDT: TransportationStageID.
[0990] AttachedEquipment can specify equipment attached to a
TransportationUnitResource. The structure of AttachedEquipment
includes the element ShipmentRequestResourceInformationID.
ShipmentRequestResourceInformationID can be a unique identifier of
a resource information in a ShipmentRequest, and can be based on
GDT: ResourceInformationID.
[0991] Quantity can specify a quantity related to the
TransportationUnitResourceInformation. The structure of the
Quantity entity includes the following elements: Quantity,
RoleCode, and TypeCode. Quantity can be a non-monetary numerical
specification of an amount in a unit of measurement. Quantity can
be based on GDT: Quantity. RoleCode can be a coded representation
of the role of a quantity, and can be based on GDT:
QuantityRoleCode. TypeCode can be a coded representation of a type
of a quantity that is based on a measurable characteristic of an
object or physical phenomenon. TypeCode can be based on GDT:
QuantityTypeCode. In some implementations, QuantityRoleCode and
QuantityTypeCode are optional, but in every instance one of them
can be filled.
[0992] BusinessTransactionDocumentReference can specify a business
document reference that is related to the
TransportationUnitResource. BusinessTransactionDocumentReference
includes the DateTimePeriodentity. The structure of the
BusinessTransactionDocumentReference entity includes the following
elements: BusinessTransactionDocumentReference,
BusinessTransactionDocumentRelationshipRoleCode,
BusinessTransactionDocumentRelationshipTypeCode,
TransportationDocumentTypeCode, TransportationDocumentNote, and
TransportationDocumentID. BusinessTransactionDocumentReference can
be a unique reference to other business documents or business
document items that are of significance within each respective
business process. BusinessTransactionDocumentReference can be based
on GDT: BusinessTransactionDocumentReference.
[0993] BusinessTransactionDocumentRelationshipRoleCode can be a
coded representation of a role that a business document or a
business document item has when set against another business
document or business document item with a relationship.
BusinessTransactionDocumentRelationshipRoleCode can be based on
GDT: BusinessTransactionDocumentRelationshipRoleCode.
BusinessTransactionDocumentRelationshipTypeCode can be a coded
representation of a relationship between two business documents or
business document items.
BusinessTransactionDocumentRelationshipTypeCode can be based on
GDT: BusinessTransactionDocumentRelationshipTypeCode.
TransportationDocumentTypeCode can be a coded representation of a
documentation type. TransportationDocumentTypeCode can be based on
GDT: TransportationDocumentTypeCode.
[0994] TransportationDocumentNote can be a short Note on
documentation. TransportationDocumentNote can be based on GDT:
SHORT_Note. TransportationDocumentID can be a unique identifier for
a transportation document. TransportationDocumentID can be based on
GDT: TransportationDocumentID. RelationshipTypeCode and
RelationshipRoleCode are both optional. In some implementations, if
used, both may be filled. Either the combination
BusinessTransactionDocumentReference,
BusinessTransactionDocumentRelationshipRoleCode,
BusinessTransactionDocumentRelationshipTypeCode or
TransportationDocumentTypeCode, TransportationDocumentNote,
TransportationDocumentID may be filled.
[0995] DateTimePeriod can specify a date, time and/or period
related to a BusinessTransactionDocumentReference. The elements
located directly at the DateTimePeriods entity include
RequestedFulfillmentPeriod, AcceptableFulfillmentPeriod, and
PeriodRoleCode. RequestedFulfillmentPeriod can be a period which is
requested depending on semantics of the PeriodRoleCode.
RequestedFulfillmentPeriod can be based on GDT: DATETIMEPERIOD,
Qualifier: RequestedFulfillment. AcceptableFulfillmentPeriod can be
a period which is acceptable depending on semantics of a
PeriodRoleCode. AcceptableFulfillmentPeriod can be based on GDT:
DATETIMEPERIOD, Qualifier: AcceptableFulfillment. PeriodRoleCode
can be a coded representation of business semantics of the two
periods defined by the entities RequestedFulfillmentPeriod and
AcceptableFulfillmentPeriod. PeriodRoleCode can be based on GDT:
PeriodRoleCode. In some implementations, RequestedFulfillmentPeriod
and AcceptableFulfillmentPeriod are optional, but in every instance
one of them may be filled.
[0996] TextCollection can be a group of textual information that
relates to a TransportationUnitResource. The structure of the
TextCollection entity includes the TextCollection element.
TextCollection can be based on GDT: TextCollection. Location can
specify a physical place related to the TransportationUnitResource.
The structure of the Location entity includes the following
elements: Location, RoleCode, TypeCode, and Name. Location includes
information exchanged in business documents about a location
relevant for business transactions. Location can be based on GDT:
BusinessTransactionDocumentLocation. RoleCode can be a coded
representation of a LocationRole, and can be based on GDT:
LocationRoleCode. TypeCode can be a coded representation of a type
of a physical location, and can be based on GDT: LocationTypeCode.
Name can be a name of a location, and can be based on GDT:
MEDIUM_Name, Qualifier: Location.
[0997] DateTimePeriods can specify a requested and an acceptable
date, time and period related to a Location of a resource. The
elements located directly at the DateTimePeriods entity include
RequestedFulfillmentPeriod, AcceptableFulfillmentPeriod, and
PeriodRoleCode. RequestedFulfillmentPeriod can be a period which is
requested depending on semantics of a PeriodRoleCode.
RequestedFulfillmentPeriod can be based on GDT: DATETIMEPERIOD,
Qualifier: RequestedFulfillment. AcceptableFulfillmentPeriod can be
a period which is acceptable depending on semantics of a
PeriodRoleCode. AcceptableFulfillmentPeriod can be based on GDT:
DATETIMEPERIOD, Qualifier: AcceptableFulfillment. PeriodRoleCode
can be a coded representation of business semantics of the two
periods defined by the entities RequestedFulfillmentPeriod and
AcceptableFulfillmentPeriod. PeriodRoleCode can be based on GDT:
PeriodRoleCode. In some implementations, RequestedFulfillmentPeriod
and AcceptableFulfillmentPeriod are optional, but in every instance
one of them may be filled.
[0998] DangerousGoods can specify dangerous goods included in a
resource. DangerousGoods includes the ContactInformation and
TextCollection entities. The structure of DangerousGoods includes
the following elements: ID, RegulationsCode, HazardCode,
FlashpointMeasureInterval, PackagingGroupCode, EmergencySchedule,
TransportEmergencyCardCode, DangerousGoodsLabelCode,
DangerousGoodsLabelCode2, DangerousGoodsLabelCode3,
PackagingInstructionTypeCode, TransportMeansDescriptionCode, and
TransportAuthorisationCode. ID can be a unique identifier for a
dangerous good, using the United Nations Dangerous Goods Number. ID
can be based on GDT: DangerousGoodsID. RegulationsCode can be a
coded representation of national or international dangerous goods
rules or regulations.
[0999] RegulationsCode can be based on GDT:
DangerousGoodsRegulationsCode. HazardCode can be a coded
representation of a hazard that is imminent in a dangerous good.
HazardCode can be based on GDT: DangerousGoodsHazardCode.
FlashpointMeasureInterval can be an interval of measures defined by
a lower and an upper boundary indicating a flashpoint of a
dangerous good. FlashpointMeasureInterval can be based on GDT:
MeasureInterval, Qualifier: Flashpoint. PackagingGroupCode can be a
coded representation of the effectiveness of a packaging to
transport dangerous goods depending on a degree of danger of the
goods. PackagingGroupCode can be based on GDT:
DangerousGoodsPackagingGroupCode.
[1000] EmergencySchedule can be a coded representation of an
emergency schedule for dangerous goods. EmergencySchedule can
identify an emergency schedule. The DangerousGoodsEmergencySchedule
can be used for transports of dangerous goods by sea similar to a
Transport Emergency Card which is used for transports of dangerous
goods by road. EmergencySchedule can be based on GDT:
DangerousGoodsEmergencySchedule. TransportEmergencyCardCode can be
a coded representation of a transport emergency card which
specifies how to react in case of an accident.
TransportEmergencyCardCode can be based on GDT:
TransportEmergencyCardCode. DangerousGoodsLabelCode can be a coded
representation of a label for a dangerous good. In some
implementations, DangerousGoodsLabelCode's values are dependant on
the DangerousGoodsRegulationsCode. DangerousGoodsLabelCode can be
based on GDT: DangerousGoodsLabelCode.
[1001] DangerousGoodsLabelCode2 can be a coded representation of a
label for a dangerous good. In some implementations,
DangerousGoodsLabelCode's values are dependant on the
DangerousGoodsRegulationsCode. DangerousGoodsLabelCode2 can be
based on GDT: DangerousGoodsLabelCode. DangerousGoodsLabelCode3 can
be a coded representation of a label for a dangerous good. In some
implementations, DangerousGoodsLabelCode's values are dependant on
the DangerousGoodsRegulationsCode. DangerousGoodsLabelCode3 can be
based on GDT: DangerousGoodsLabelCode. PackagingInstructionTypeCode
can be a coded representation of a packaging instruction. In some
implementations, a packaging instruction can be an instruction
defining which packaging can be used to pack a dangerous good.
PackagingInstructionTypeCode can be based on GDT:
PackagingInstructionTypeCode. TransportMeansDescriptionCode can be
a coded representation of a transport means type with which goods
or persons can be transported. TransportMeansDescriptionCode can be
based on GDT: TransportMeansDescriptionCode.
TransportAuthorisationCode can be a coded representation of an
authorisation for the transportation of dangerous goods. This code
can specify an authorisation for the transportation of a particular
dangerous good. TransportAuthorisationCode can be based on GDT:
DangerousGoodsTransportAuthorisationCode.
[1002] ContactInformation can specify information on a department
or person to whom information regarding dangerous goods can be
directed. The structure of ContactInformation includes the elements
ContactPersonFunctionTypeCode, and Address.
ContactPersonFunctionTypeCode can be a coded representation of the
type of function that a contact person has.
ContactPersonFunctionTypeCode can be based on GDT:
ContactPersonFunctionTypeCode. Address can be an address related to
the contact information defined by a corresponding
FunctionTypeCode. Address can be based on GDT: Address.
[1003] TextCollection can be a group of textual information that
relates to DangerousGoods. The structure of the TextCollection
entity includes the TextCollection element. TextCollection can be
based on GDT: TextCollection.
[1004] The TransportationChargesInformation package includes
information regarding transportation charge calculation specific
components related to a FreightRequest. The
TransportationChargesInformation package includes the
TransportationChargesInformation entity. The entity
TransportationChargesInformation can define a relationship between
transportation charges and the origin of these charges.
TransportationChargesInformation includes the TransportationCharges
entity. The structure of TransportationChargesInformation includes
the following elements: TransportationChargesUsageCode,
RequestForSupplierFreightQuotePartyStandardID,
RequestForSupplierFreightQuoteTransportationUnitResourceID and
RequestForSupplierFreightQuoteTransportationStageID.
[1005] TransportationChargesUsageCode can be a coded representation
of the usage of TransportationCharges. The usage can point out if
subsequent information represents a revenue view or cost view on
transportation charges. TransportationChargesUsageCode can be based
on GDT: TransportationChargesUsageCode.
RequestForSupplierFreightQuotePartyStandardID can be a unique
identifier of a Party in a FreightRequest, and can be based on GDT:
PartyStandardID.
RequestForSupplierFreightQuoteTransportationUnitResourceID can be a
unique identification of a TransportationUnitResource in a
FreightRequest, and can be based on GDT: ResourceID.
RequestForSupplierFreightQuoteTransportationStageID can be a unique
identification of a TransportationStage in a FreightRequest, and
can be based on GDT: TransportationStageID. If none of the IDs is
maintained, the transportation charges may be related to an entire
freight request.
[1006] TransportationCharges can be a summary of determined
transportation charge specific components for a transportation
business case. TransportationCharges includes the following
entities: Location, TextCollection, Currency, ExchangeRate,
PercentElement, DateTimePeriod,
BusinessTransactionDocumentReference, TaxDetail,
PaymentInstruction, CashDiscountTerms, and Element. The structure
of TransportationCharges includes the following elements: ID,
FreightAgreementID, CalculationOriginCode, TariffID, and
CalculationSheetID. ID can be a unique identifier of
TransportationCharges in a ShipmentRequest, and can be based on
GDT: TransportationChargesID. FreightAgreementID can be an
identification of a Freight Agreement which includes and points to
a configuration for the Transportation Charges Calculation.
[1007] FreightAgreementID can be based on GDT: FreightAgreementID.
CalculationOriginCode can be a coded representation of an origin of
a transportation charges calculation. The calculation can be done
automatically based on a system configuration. Data for the
calculation, including the results, can be manually entered or
received from another business system via a message. In some
implementations, a clear distinction of the origin of
TransportationCharges Calculation details such as the
TransportationChargesCalculationSheet and its
TransportationChargeElements can be included. The included details
can give information whether the calculation was done completely
automatically, or if the results were manually adopted.
CalculationOriginCode can be based on GDT:
TransportationChargesOriginCode.
[1008] TariffID can be an identifier for a transportation charges
tariff. A transportation charges tariff can be a specific
combination of a transportation charges calculation sheet and terms
and conditions. The terms and conditions can define if a certain
transportation charges calculation sheet and its related rates are
applicable for a transportation business case. TariffID can be
based on GDT: TransportationChargesTariffID. CalculationSheetID can
be a unique Identifier for a transportation charges calculation
sheet. A TransportationChargesCalculationSheet can represent a
configuration how to calculate transportation charges for a
transportation business case. A
TransportationChargesCalculationSheet includes instructions
describing which charges are applicable, which data from a
transportation business case may be considered for a calculation,
how the underlying transportation charge rates are determined and
which special calculation methods can be considered.
CalculationSheetID can be based on GDT:
TransportationChargesCalculationSheetID.
[1009] A Location can specify a physical place to which
TransportationCharges and their calculation can refer. Location
includes the DateTimePeriod entity. The structure of the Location
entity includes the following elements: Location, RoleCode,
TypeCode, and Name. Location includes information exchanged in
business documents about a location relevant for business
transactions. Location can be based on GDT:
BusinessTransactionDocumentLocation. RoleCode can be a coded
representation of a LocationRole, and can be based on GDT:
LocationRoleCode. TypeCode can be a coded representation of a type
of a physical location, and can be based on GDT: LocationTypeCode.
Name can be a name of a location, and can be based on GDT:
MEDIUM_Name, Qualifier: Location.
[1010] DateTimePeriods can specify a date, time and/or period
related to a TransportationChargesLocation. The elements located
directly at the DateTimePeriods entity include
RequestedFulfillmentPeriod, AcceptableFulfillmentPeriod, and
PeriodRoleCode. RequestedFulfillmentPeriod can be a period which is
requested depending on semantics of a PeriodRoleCode.
RequestedFulfillmentPeriod can be based on GDT: DATETIMEPERIOD,
Qualifier: RequestedFulfillment. AcceptableFulfillmentPeriod can be
a period which is acceptable depending on semantics of the
PeriodRoleCode. AcceptableFulfillmentPeriod can be based on GDT:
DATETIMEPERIOD, Qualifier: AcceptableFulfillment. PeriodRoleCode
can be a coded representation of business semantics of the two
periods defined by the entities RequestedFulfillmentPeriod and
AcceptableFulfillmentPeriod. PeriodRoleCode can be based on GDT:
PeriodRoleCode. In some implementations, RequestedFulfillmentPeriod
and AcceptableFulfillmentPeriod are optional, but in every instance
one of them may be filled.
[1011] TextCollection can be a group of textual information that
relates to the TransportationCharges. The structure of the
TextCollection entity includes the TextCollection element.
TextCollection can be based on GDT: TextCollection.
[1012] Currency can be a currency which is valid for transportation
charges. The structure of Currency includes the following elements:
Code, RoleCode, and UsageCode. Code can be a coded representation
of a currency, and can be based on GDT: CurrencyCode. RoleCode can
be a coded representation of a role of a Currency, and can be based
on GDT: CurrencyRoleCode. UsageCode can be a coded representation
of how a currency is used, and can be based on GDT:
CurrencyUsageCode. This currency can be valid for transportation
charges, as long as there is no currency information on a charge
element level.
[1013] ExchangeRate can be an exchange rate that has been
especially negotiated for transportation charges. The structure of
ExchangeRate includes the ExchangeRate and TypeCode elements.
ExchangeRate can be a rate at which one unit of a currency can be
changed into another currency. ExchangeRate can be based on GDT:
ExchangeRate. TypeCode can be a coded representation of a type of
an exchange rate. The actual exchange rate between two currencies
can depend on an exchange rate type and currency conversion type.
The exchange rate type can define characteristics of an exchange
rate according to currencies that get converted. TypeCode can be
based on GDT: ExchangeRateTypeCode.
[1014] PercentElement can be a detail about Transportation Charges,
represented as a percentage. The structure of PercentElement
includes the elements PercentRoleCode, Percent,
TransportationChargesPercentCalculationBaseCode, and StatusCode.
PercentRoleCode can be a coded representation of a role of a
percent, and can be based on GDT: PercentRoleCode. Percent can be a
number that relates to the comparison FIG. 100. Percent can be
based on CDT: Percent.
TransportationChargesPercentCalculationBaseCode can be a coded
representation of a calculation base for a transportation charges
percent. TransportationChargesPercentCalculationBaseCode can be
based on GDT: TransportationChargesPercentCalculationBaseCode.
StatusCode can be a coded representation of a status for a
transportation charges percent element, and can be based on GDT:
TransportationChargesPercentElementStatusCode.
[1015] DateTimePeriod can specify a date, time and/or period that
is relevant for a transportation charges calculation. The elements
located directly at the DateTimePeriods entity include
RequestedFulfillmentPeriod, AcceptableFulfillmentPeriod, and
PeriodRoleCode. RequestedFulfillmentPeriod can be a period which is
requested depending on semantics of the PeriodRoleCode.
RequestedFulfillmentPeriod can be based on GDT: DATETIMEPERIOD,
Qualifier: RequestedFulfillment. AcceptableFulfillmentPeriod can be
a period which is acceptable depending on semantics of the
PeriodRoleCode. AcceptableFulfillmentPeriod can be based on GDT:
DATETIMEPERIOD, Qualifier: AcceptableFulfillment. PeriodRoleCode
can be a coded representation of business semantics of the two
periods defined by the entities RequestedFulfillmentPeriod and
AcceptableFulfillmentPeriod. PeriodRoleCode can be based on GDT:
PeriodRoleCode. In some implementations, RequestedFulfillmentPeriod
and AcceptableFulfillmentPeriod are optional, but in every instance
one of them may be filled.
[1016] A BusinessTransactionDocumentReference can specify a
business document reference that is related to a transportation
charges calculation. The structure of the
BusinessTransactionDocumentReference entity includes the following
elements: BusinessTransactionDocumentReference,
BusinessTransactionDocumentRelationshipRoleCode,
BusinessTransactionDocumentRelationshipTypeCode,
TransportationDocumentTypeCode, TransportationDocumentNote, and
TransportationDocumentID. BusinessTransactionDocumentReference can
be a unique reference to other business documents or business
document items that are of significance within each respective
business process. BusinessTransactionDocumentReference can be based
on GDT: BusinessTransactionDocumentReference.
[1017] BusinessTransactionDocumentRelationshipRoleCode can be a
coded representation of a role that a business document or a
business document item has when set against another business
document or business document item with a relationship.
BusinessTransactionDocumentRelationshipRoleCode can be based on
GDT: BusinessTransactionDocumentRelationshipRoleCode.
BusinessTransactionDocumentRelationshipTypeCode can be a coded
representation of a relationship between two business documents or
business document items.
BusinessTransactionDocumentRelationshipTypeCode can be based on
GDT: BusinessTransactionDocumentRelationshipTypeCode.
TransportationDocumentTypeCode can be a coded representation of a
documentation type.
[1018] TransportationDocumentTypeCode can be based on GDT:
TransportationDocumentTypeCode. TransportationDocumentNote can be a
short Note on documentation. TransportationDocumentNote can be
based on GDT: SHORT_Note. TransportationDocumentID can be a unique
identifier for a transportation document. TransportationDocumentID
can be based on GDT: TransportationDocumentID. RelationshipTypeCode
and RelationshipRoleCode are both optional. In some
implementations, if used, both may be filled. Either the
combination BusinessTransactionDocumentReference,
BusinessTransactionDocumentRelationshipRoleCode,
BusinessTransactionDocumentRelationshipTypeCode or
TransportationDocumentTypeCode, TransportationDocumentNote,
TransportationDocumentID may be filled.
[1019] A TaxDetail can be tax-relevant information which is
applicable for each ChargeElement. The structure of TaxDetail
includes the ProductTax element. ProductTax can be a tax that is
incurred for product-related business transactions, such as
purchasing, sales, or consumption. The ProductTax can be used to
display different tax components in calculated and invoiced
amounts, and to inform about tax declarations and payments of a
company to responsible tax authorities. ProductTax can be based on
GDT: ProductTax. In some implementations, within TaxDetail, the
BusinessTransactionDocumentItemGroupID of the GDT ProductTax is not
used.
[1020] PaymentInstruction can be an instruction about how a payment
can be carried out or which additional activities can be carried
out within a payment. There can be a separate instance for each
Charge Category Code, such as Basic Freight, Origin haulage, or
charges. The structure of PaymentInstruction includes the following
elements: PaymentInstruction,
TransportationChargesElementCategoryCode,
TransportationChargesElementSubCategoryCode, and
TransportationChargesPaymentArrangementCode. PaymentInstruction can
be an instruction about how a payment can be carried out or which
additional activities can be carried out within a payment.
PaymentInstruction can be based on GDT: PaymentInstruction.
TransportationChargesElementCategoryCode can be a coded
representation of a category of a TransportationChargeElement.
[1021] The TransportationChargeElementCategoryCode can be used to
group TransportationChargeElements. PaymentInstructions can be
different per TransportationChargeElementCategory.
TransportationChargesElementCategoryCode can be based on GDT:
TransportationChargesElementCategoryCode.
TransportationChargesElementSubCategoryCode can be a coded
representation of a subcategory of a transportation charges
element. TransportationChargesElementSubCategoryCode can be based
on GDT: TransportationChargesElementSubCategoryCode.
TransportationChargesPaymentArrangementCode can be a coded
representation of an arrangement of a payment for transportation
charges. TransportationChargesPaymentArrangementCode can be based
on GDT: TransportationChargesPaymentArrangementCode.
[1022] CashDiscountTerms can be an agreement on a percentage of a
cash discount that is granted during a transportation transaction
when a payment takes place within a certain number of days after a
baseline date for payment has passed. The structure of
CashDiscountTerms includes the following elements:
CashDiscountTerms, TransportationChargesElementCategoryCode, and
TransportationChargesElementSubCategoryCode. CashDiscountTerms can
be an agreement of cash discounts for a payment, and can be based
on GDT: CashDiscountTerms. TransportationChargesElementCategoryCode
can be a coded representation of a category of a
TransportationChargesElement.
[1023] The TransportationChargesElementCategoryCode can be used to
group TransportationChargesElements. PaymentInstructions can be
different per TransportationChargesElementCategory.
TransportationChargesElementCategoryCode can be based on GDT:
TransportationChargesElementCategoryCode.
TransportationChargesElementSubCategoryCode can be a coded
representation of a subcategory of a transportation charges
element. TransportationChargesElementSubCategoryCode can be based
on GDT: TransportationChargesElementSubCategoryCode.
[1024] Element can be, together with its sub nodes, a single
building block of a transportation charge calculation. A Charge
Element can result from a manually created charge, an automatically
determined charge, or another Charge Element distributed from an
entire document. A Charge Element includes the following entities:
Location, TextCollection, Currency, RateElement, PercentElement,
AmountElement, CalculationBase, TaxDetail, DateTimePeriod, and
CostDistribution. The structure of Element includes the following
elements: CategoryCode, SubCategoryCode, TypeCode,
CalculationResolutionCode, and
TransportationChargesPaymentArrangementCode. CategoryCode can be a
coded representation of a category of a
TransportationChargesElement.
[1025] The TransportationChargesElementCategoryCode can be used to
group TransportationChargesElements. PaymentInstructions can be
different per TransportationChargesElementCategory. CategoryCode
can be based on GDT: TransportationChargesElementCategoryCode.
SubCategoryCode can be a coded representation of a subcategory of a
transportation charges element. SubCategoryCode can be based on
GDT: TransportationChargesElementSubCategoryCode. TypeCode can be a
coded representation of a type of a transportation charge element.
TypeCode can be based on GDT: TransportationChargesElementTypeCode.
CalculationResolutionCode can be a coded representation of a
resolution for a transportation charges element calculation.
CalculationResolutionCode can be based on GDT:
TransportationChargesElementCalculationResolutionCode.
TransportationChargesPaymentArrangementCode can be a coded
representation of an arrangement of a payment for transportation
charges. TransportationChargesPaymentArrangementCode can be based
on GDT: TransportationChargesPaymentArrangementCode.
[1026] Location can specify a physical place a specific
ChargeElement refers to. Location includes the DateTimePeriod
entity. The structure of the Location entity includes the following
elements: Location, RoleCode, TypeCode, and Name. Location includes
information exchanged in business documents about a location
relevant for business transactions. Location can be based on GDT:
BusinessTransactionDocumentLocation. RoleCode can be a coded
representation of a LocationRole, and can be based on GDT:
LocationRoleCode. TypeCode can be a coded representation of a type
of a physical location. TypeCode can be based on GDT:
LocationTypeCode. Name can be a name of a location, and can be
based on GDT: MEDIUM_Name, Qualifier: Location.
[1027] DateTimePeriods can specify a date, time and/or period
related to a location. The elements located directly at the
DateTimePeriods entity include RequestedFulfillmentPeriod,
AcceptableFulfillmentPeriod, and PeriodRoleCode.
RequestedFulfillmentPeriod can be a period which is requested
depending on semantics of the PeriodRoleCode.
RequestedFulfillmentPeriod can be based on GDT: DATETIMEPERIOD,
Qualifier: RequestedFulfillment. AcceptableFulfillmentPeriod can be
a period which is acceptable depending on semantics of the
PeriodRoleCode. AcceptableFulfillmentPeriod can be based on GDT:
DATETIMEPERIOD, Qualifier: AcceptableFulfillment. PeriodRoleCode
can be a coded representation of business semantics of the two
periods defined by the entities RequestedFulfillmentPeriod and
AcceptableFulfillmentPeriod. PeriodRoleCode can be based on GDT:
PeriodRoleCode. In some implementations, RequestedFulfillmentPeriod
and AcceptableFulfillmentPeriod are optional, but in every instance
one of them may be filled.
[1028] TextCollection can be a group of textual information that
relates to a ChargeElement. The structure of the TextCollection
entity includes the TextCollection element. TextCollection can be
based on GDT: TextCollection.
[1029] Currency can emphasize if the ChargeElement may be
considered with relation to a certain currency. The structure of
Currency includes the following elements: Code, RoleCode, and
UsageCode. Code can be a coded representation of a currency, and
can be based on GDT: CurrencyCode. RoleCode can be a coded
representation of a role of a Currency, and can be based on GDT:
CurrencyRoleCode. UsageCode can be a coded representation of how a
currency is used. UsageCode can be based on GDT: CurrencyUsageCode.
This currency can be valid for transportation charges, as long as
there is no currency information on a charge element level.
[1030] RateDetail can specify a rate with which the ChargeElement
is calculated. The structure of RateElement includes the following
elements: ID, Amount, BaseQuantity,
TransportationChargesRateTypeCode,
TransportationChargesRateRoleCode, and
TransportationChargesRateElementStatusCode. ID can be a unique
identifier of a rate element of a transportation charges element,
and can be based on GDT: TransportationChargesElementRateElementID.
Amount can be an amount with a corresponding currency unit, or a
monetary amount of a rate. Amount can be based on CDT: Amount.
BaseQuantity can be a non-monetary numerical specification of an
amount in a unit of measurement, or a quantity to which an amount
refers.
[1031] BaseQuantity can be based on CDT: Quantity, Qualifier: Base.
TransportationChargesRateTypeCode can be a coded representation of
a TransportationChargeRate type. Examples include gross weight rate
and net weight rate. TransportationChargesRateTypeCode can be based
on GDT: TransportationChargesRateTypeCode.
TransportationChargesRateRoleCode can be a coded representation of
a role of a TransportationChargeRate. Examples include an invoice
rate and a rate for calculation purposes.
TransportationChargesRateRoleCode can be based on GDT:
TransportationChargesRateRoleCode.
TransportationChargesRateElementStatusCode can be a coded
representation of a status of a transportation charges rate
element. TransportationChargesRateElementStatusCode can be based on
GDT: TransportationChargesRateElementStatusCode.
[1032] PercentElement can be a detail about a transportation
charges element represented as a percentage. The structure of
PercentElement includes the following elements: PercentRoleCode,
Percent, TransportationChargesPercentCalculationBaseCode, and
StatusCode. PercentRoleCode can be a coded representation of a role
of a percent, and can be based on GDT: PercentRoleCode. Percent can
be a number that relates to the comparison FIG. 100. Percent can be
based on CDT: Percent.
TransportationChargesPercentCalculationBaseCode can be a coded
representation of a calculation base for a transportation charges
percent. TransportationChargesPercentCalculationBaseCode can be
based on GDT: TransportationChargesPercentCalculationBaseCode.
StatusCode can be a coded representation of a status for a
transportation charges percent element, and can be based on GDT:
TransportationChargesPercentElementStatusCode.
[1033] AmountElement can represent a monetary aspect of a
Transportation Charge. AmountElement can be a result of a
transportation charge calculation. There can be a separate instance
for each monetary amount per AmountRoleCode. AmountElement includes
the RateElementAssignment entity. The structure of AmountElement
includes the following elements: Amount, AmountRoleCode, and
TransportationChargesAmountElementStatusCode. Amount can be an
amount with a corresponding currency unit, and can be based on CDT:
Amount. AmountRoleCode can be a coded representation of a role of
an amount, and can be based on GDT: AmountRoleCode.
TransportationChargesAmountElementStatusCode can be a coded
representation of a status of an amount element of transportation
charges or its transportation charges element.
TransportationChargesAmountElementStatusCode can be based on GDT:
TransportationChargesAmountElementStatusCode.
[1034] RateElementAssignment can be an assignment of an amount to a
RateElement. TransportationChargesElementRateElementID can be a
unique Identifier of a rate element of a transportation charges
element. TransportationChargesElementRateElementID can be based on
GDT: TransportationChargesElementRateElementID.
[1035] CalculationBase can be data which can be included with the
RateDetail as a basis for calculating an Amount. The structure of
CalculationBase includes the following elements:
TransportationChargesElementCalculationBaseCode, BaseQuantity,
BaseQuantityRoleCode, and BaseQuantityTypeCode.
TransportationChargesElementCalculationBaseCode can be a coded
representation of a calculation base of a transportation charges
element. TransportationChargesElementCalculationBaseCode can be
based on GDT: TransportationChargesElementCalculationBaseCode.
BaseQuantity can be a non-monetary numerical specification of an
amount in a unit of measurement. BaseQuantity can be the value of a
calculation base as a quantity. BaseQuantity can be based on GDT:
Quantity, Qualifier: Base. BaseQuantityRoleCode can be a coded
representation of a role of a quantity. BaseQuantityRoleCode can be
based on GDT: QuantityRoleCode. BaseQuantityTypeCode can be a coded
representation of a type of quantity that is based on a measurable
characteristic of an object or physical phenomenon.
BaseQuantityTypeCode can be based on GDT: QuantityTypeCode.
[1036] TaxDetail can be tax-relevant information which is
applicable for each ChargeElement. The structure of TaxDetail
includes the ProductTax element. ProductTax can be a tax that is
incurred for product-related business transactions, such as
purchasing, sales, or consumption. The ProductTax can be used to
display different tax components in calculated and invoiced
amounts, and to inform about tax declarations and payments of a
company to responsible tax authorities. ProductTax can be based on
GDT: ProductTax. In some implementations, within TaxDetail, the
BusinessTransactionDocumenthemGroupID of the GDT ProductTax is not
used.
[1037] DateTimePeriod can specify a date, time and/or period
related to a ChargeElement. The elements located directly at the
DateTimePeriods entity include RequestedFulfillmentPeriod,
AcceptableFulfillmentPeriod, and PeriodRoleCode.
RequestedFulfillmentPeriod can be a period which is requested
depending on semantics of the PeriodRoleCode.
RequestedFulfillmentPeriod can be based on GDT: DATETIMEPERIOD,
Qualifier: RequestedFulfillment. AcceptableFulfillmentPeriod can be
a period which is acceptable depending on semantics of the
PeriodRoleCode. AcceptableFulfillmentPeriod can be based on GDT:
DATETIMEPERIOD, Qualifier: AcceptableFulfillment. PeriodRoleCode
can be a coded representation of business semantics of the two
periods defined by the entities RequestedFulfillmentPeriod and
AcceptableFulfillmentPeriod. PeriodRoleCode can be based on GDT:
PeriodRoleCode. In some implementations, RequestedFulfillmentPeriod
and AcceptableFulfillmentPeriod are optional, but in every instance
one of them may be filled.
[1038] CostDistribution can be information on how a ChargeElement
can be allocated or distributed from a financial accounting point
of view. The structure of CostDistribution includes the
AccountingCodingBlockAssignment element. An
AccountingCodingBlockAssignment can be an assignment of an item to
a coding block. Items that are typically assigned to a coding block
can be an amount that is known from context, a quantity, or a
company resource such as office space or working time. A coding
block can be a set of account assignment objects of different
types. An account assignment object can be a business object to
which value changes from business transactions are assigned in
Accounting. AccountingCodingBlockAssignment can be based on GDT:
AccountingCodingBlockAssignment.
[1039] In some implementations, the RequestForSupplierShipmentQuote
package includes a SupplierFreightQuoteAssignmentInformation
package which can include information for supplier freight quote
assignments. The
RequestForSupplierFreightQuoteAssignmentInformation package
includes the TransportationStageAssignment and
TransportationUnitResourceInformationAssignment entities.
[1040] TransportationStageAssignment can specify an assignment of
the RequestForSupplierShipmentQuote to a stage of the
RequestForSupplierFreightQuote. The structure of
RequestForSupplierFreightQuoteAssignmentInformation includes the
element RequestForSupplierFreightQuoteTransportationStageID.
RequestForSupplierFreightQuoteTransportationStageID can be a unique
identifier of a TransportationStage in a
RequestForSupplierFreightQuote, and can be based on GDT:
TransportationStageID.
TransportationUnitResourceInformationAssignment can specify an
assignment of a RequestForSupplierShipmentQuote to a
TransportationUnitResourceInformation of a
RequestForSupplierFreightQuote. The structure of
TransportationUnitResourceInformationAssignment includes the
element
RequestForSupplierFreightQuoteTransportationUnitResourceInformationID.
RequestForSupplierFreightQuoteTransportationUnitResourceInformationID
can be a unique identifier of a
TransportationUnitResourceInformation in a
RequestForSupplierFreightQuote.
RequestForSupplierFreightQuoteTransportationUnitResourceInformationID
can be based on GDT: TransportationUnitResourceID.
[1041] The TransportationUnitResourceInformation package includes
information regarding a transportation unit resource relevant for a
shipment request (e.g., a container). The
TransportationUnitResourceInformation package includes the
TransportationUnitResourceInformation entity.
TransportationUnitResourceInformation includes information on one
or more transportation unit resources, such as a resource type and
related properties, related measures or handling instructions. A
Transportation Unit Resource can be a unit into which goods are
loaded and/or from which goods are unloaded. In some
implementations, this unit can provide transportation capacity for
goods but might not move by itself.
TransportationUnitResourceInformation includes the following
entities: TransportationStageAssignment, AttachedEquipment,
Quantity, Seal, BusinessTransactionDocumentReference,
TextCollection, Location, and Dangerous Goods. The structure of
TransportationUnitResourceInformation includes the following
elements: ID, ResourceNumberValue, ResourceID,
ResourceHomeCountryCode, TransportationUnitResourceCategoryCode,
TransportationUnitResourceTypeCode, FillLevelCode,
ShippingTypeCode, HaulageArrangerCode,
TransportationHandlingInstructionCode, and
TransportationHandlingInstructionNote. ID can be a unique
identifier for a resource information, and can be based on GDT
ResourceInformationID. ResourceNumberValue can be a number of
resources, and can be based on GDT: NumberValue, Qualifier:
Resource. ResourceID can be a unique identifier for a resource, and
can be based on GDT: ResourceID. ResourceHomeCountryCode can be a
coded representation of the home country of a resource, and can be
based on GDT: CountryCode, Qualifier: ResourceHome.
TransportationUnitResourceCategoryCode can be a coded
representation of a category of transportation unit resources, and
can be based on GDT: TransportationUnitResourceCategoryCode.
TransportationUnitResourceTypeCode can be a coded representation of
a transportation unit resource type.
[1042] TransportationUnitResourceTypeCode can be based on GDT:
TransportationUnitResourceTypeCode. FillLevelCode can be a coded
representation of a fill level of a resource, and can be based on
GDT: FillLevelCode. ShippingTypeCode can be a coded representation
of a shipping type. A shipping type can specify how planning and
execution of a transportation can be performed. Transportation
terms include detailed specifications on agreed means of
transportation, such as shipping or transport type and means of
transport to be used. ShippingTypeCode can be based on GDT:
ShippingTypeCode. HaulageArrangerCode can be a coded representation
of an arranger of a haulage. Haulage can be inland transport of
cargo. HaulageArrangerCode can be based on GDT:
HaulageArrangerCode. TransportationHandlingInstructionCode can be a
coded representation of a type of a transportation handling
instruction, and can be based on GDT:
TransportationHandlingInstructionCode.
TransportationHandlingInstructionNote can be a note regarding a
transportation handling instruction, and can be based on GDT:
LONG_Note, Qualifier: TransportationHandlingInstruction.
[1043] TransportationStageAssignment can specify an assignment of a
transportation stage to a transportation unit resource information.
The structure of TransportationStageAssignment includes the
ShipmentRequestTransportationStageID element.
ShipmentRequestTransportationStageID can be a unique identifier of
a TransportationStage in a shipment request, and can be based on
GDT: TransportationStageID.
[1044] AttachedEquipment can specify equipment attached to a
TransportationUnitResource. The structure of AttachedEquipment
includes the element ShipmentRequestResourceInformationID.
ShipmentRequestResourceInformationID can be a unique identifier of
a resource information in a ShipmentRequest, and can be based on
GDT: ResourceInformationID.
[1045] Quantity can specify a quantity related to
TransportationUnitResourceInformation. The structure of the
Quantity entity includes the following elements: Quantity,
RoleCode, and TypeCode. Quantity can be a non-monetary numerical
specification of an amount in a unit of measurement. Quantity can
be based on GDT: Quantity. RoleCode can be a coded representation
of a role of a quantity, and can be based on GDT: QuantityRoleCode.
TypeCode can be a coded representation of a type of quantity that
is based on a measurable characteristic of an object or physical
phenomenon. TypeCode can be based on GDT: QuantityTypeCode. In some
implementations, QuantityRoleCode and QuantityTypeCode are
optional, but in every instance one of them may be filled.
[1046] Seal can specify a seal related to a
TransportationUnitResource. The structure of Seal includes the
following elements: ID, PartyRoleCode, PartyFormattedName, and
StatusCode. ID can be a unique identifier of a seal, and can be
based on GDT: SealID. PartyRoleCode can be a coded representation
of a party role, and can be based on GDT: PartyRoleCode.
PartyFormattedName can be a complete, formatted name of a party, or
the name of a SealingParty. PartyFormattedName can be based on GDT:
LONG_Name, Qualifier: PartyFormatted. StatusCode can be a coded
representation of a status of a seal, and can be based on GDT:
SealStatusCode.
[1047] BusinessTransactionDocumentReference can specify a business
document reference that is related to a TransportationUnitResource.
BusinessTransactionDocumentReference includes the
DateTimePeriodentity. The structure of the
BusinessTransactionDocumentReference entity includes the following
elements: BusinessTransactionDocumentReference,
BusinessTransactionDocumentRelationshipRoleCode,
BusinessTransactionDocumentRelationshipTypeCode,
TransportationDocumentTypeCode, TransportationDocumentNote, and
TransportationDocumentID. BusinessTransactionDocumentReference can
be a unique reference to other business documents or business
document items that are of significance within each respective
business process. BusinessTransactionDocumentReference can be based
on GDT: BusinessTransactionDocumentReference.
BusinessTransactionDocumentRelationshipRoleCode can be a coded
representation of a role that a business document or a business
document item has when set against another business document or
business document item with a relationship.
BusinessTransactionDocumentRelationshipRoleCode can be based on
GDT: BusinessTransactionDocumentRelationshipRoleCode.
BusinessTransactionDocumentRelationshipTypeCode can be a coded
representation of a relationship between two business documents or
business document items.
BusinessTransactionDocumentRelationshipTypeCode can be based on
GDT: BusinessTransactionDocumentRelationshipTypeCode.
[1048] TransportationDocumentTypeCode can be a coded representation
of a documentation type. TransportationDocumentTypeCode can be
based on GDT: TransportationDocumentTypeCode.
TransportationDocumentNote can be a short Note on documentation.
TransportationDocumentNote can be based on GDT: SHORT_Note.
TransportationDocumentID can be a unique identifier for a
transportation document. TransportationDocumentID can be based on
GDT: TransportationDocumentID. RelationshipTypeCode and
RelationshipRoleCode are both optional. In some implementations, if
used, both may be filled. Either the combination
BusinessTransactionDocumentReference,
BusinessTransactionDocumentRelationshipRoleCode,
BusinessTransactionDocumentRelationshipTypeCode or
TransportationDocumentTypeCode, TransportationDocumentNote,
TransportationDocumentID may be filled.
[1049] DateTimePeriod can specify a date, time and/or period
related to a BusinessTransactionDocumentReference. The elements
located directly at the DateTimePeriods entity include
RequestedFulfillmentPeriod, AcceptableFulfillmentPeriod, and
PeriodRoleCode. RequestedFulfillmentPeriod can be a period which is
requested depending on semantics of the PeriodRoleCode.
RequestedFulfillmentPeriod can be based on GDT: DATETIMEPERIOD,
Qualifier: RequestedFulfillment. AcceptableFulfillmentPeriod can be
a period which is acceptable depending on semantics of a
PeriodRoleCode. AcceptableFulfillmentPeriod can be based on GDT:
DATETIMEPERIOD, Qualifier: AcceptableFulfillment. PeriodRoleCode
can be a coded representation of business semantics of the two
periods defined by the entities RequestedFulfillmentPeriod and
AcceptableFulfillmentPeriod. PeriodRoleCode can be based on GDT:
PeriodRoleCode. In some implementations, RequestedFulfillmentPeriod
and AcceptableFulfillmentPeriod are optional, but in every instance
one of them may be filled.
[1050] TextCollection can be a group of textual information that
relates to a TransportationUnitResource. The structure of the
TextCollection entity includes the TextCollection element.
TextCollection can be based on GDT: TextCollection.
[1051] Location can specify a physical place related to the
TransportationUnitResource. The structure of Location includes the
following elements: Location, RoleCode, TypeCode, and Name.
Location includes information exchanged in business documents about
a location relevant for business transactions. Location can be
based on GDT: BusinessTransactionDocumentLocation. RoleCode can be
a coded representation of a LocationRole, and can be based on GDT:
LocationRoleCode. TypeCode can be a coded representation of a type
of a physical location. TypeCode can be based on GDT:
LocationTypeCode. Name can be a name of a location, and can be
based on GDT: MEDIUM_Name, Qualifier: Location.
[1052] DateTimePeriods can specify a requested and an acceptable
date, time and period related to a Location of a resource. The
elements located directly at the DateTimePeriods entity include
RequestedFulfillmentPeriod, AcceptableFulfillmentPeriod, and
PeriodRoleCode. RequestedFulfillmentPeriod can be a period which is
requested depending on semantics of the PeriodRoleCode.
RequestedFulfillmentPeriod can be based on GDT: DATETIMEPERIOD,
Qualifier: RequestedFulfillment. AcceptableFulfillmentPeriod can be
a period which is acceptable depending on semantic of the
PeriodRoleCode. AcceptableFulfillmentPeriod can be based on GDT:
DATETIMEPERIOD, Qualifier: AcceptableFulfillment. PeriodRoleCode
can be a coded representation of business semantics of the two
periods defined by the entities RequestedFulfillmentPeriod and
AcceptableFulfillmentPeriod. PeriodRoleCode can be based on GDT:
PeriodRoleCode. In some implementations, RequestedFulfillmentPeriod
and AcceptableFulfillmentPeriod are optional, but in every instance
one of them may be filled.
[1053] DangerousGoods can specify dangerous goods included in a
resource. DangerousGoods includes the ContactInformation and
TextCollection entities. The structure of DangerousGoods includes
the following elements: ID, RegulationsCode, HazardCode,
FlashpointMeasureInterval, PackagingGroupCode, EmergencySchedule,
TransportEmergencyCardCode, DangerousGoodsLabelCode,
DangerousGoodsLabelCode2, DangerousGoodsLabelCode3,
PackagingInstructionTypeCode, TransportMeansDescriptionCode, and
TransportAuthorisationCode. ID can be a unique identifier for a
dangerous good, using the United Nations Dangerous Goods Number. ID
can be based GDT: DangerousGoodsID. RegulationsCode can be a coded
representation of to national or international dangerous goods
rules or regulations, and can be based on GDT:
DangerousGoodsRegulationsCode. HazardCode can be a coded
representation of a hazard that is imminent in a dangerous good.
HazardCode can be based on GDT: DangerousGoodsHazardCode.
FlashpointMeasureInterval can be an interval of measures defined by
a lower and an upper boundary indicating a flashpoint of a
dangerous good.
[1054] FlashpointMeasureInterval can be based on GDT:
MeasureInterval, Qualifier: Flashpoint. PackagingGroupCode can be a
coded representation of the effectiveness of a packaging to
transport dangerous goods depending on the degree of danger of the
goods. PackagingGroupCode can be based on GDT:
DangerousGoodsPackagingGroupCode. EmergencySchedule can be a coded
representation of an emergency schedule for dangerous goods.
EmergencySchedule can identify an emergency schedule. The
DangerousGoodsEmergencySchedule can be used for transports of
dangerous goods by sea similar to a Transport Emergency Card which
is used for transports of dangerous goods by road.
EmergencySchedule can be based on GDT:
DangerousGoodsEmergencySchedule. TransportEmergencyCardCode can be
a coded representation of a transport emergency card which
specifies how to react in case of an accident.
TransportEmergencyCardCode can be based on GDT:
TransportEmergencyCardCode.
[1055] DangerousGoodsLabelCode can be a coded representation of a
label for a dangerous good. In some implementations,
DangerousGoodsLabelCode's values are dependant on the
DangerousGoodsRegulationsCode. DangerousGoodsLabelCode can be based
on GDT: DangerousGoodsLabelCode. DangerousGoodsLabelCode2 can be a
coded representation of a label for a dangerous good. In some
implementations, DangerousGoodsLabelCode's values are dependant on
the DangerousGoodsRegulationsCode. DangerousGoodsLabelCode2 can be
based on GDT: DangerousGoodsLabelCode. DangerousGoodsLabelCode3 can
be a coded representation of a label for a dangerous good. In some
implementations, DangerousGoodsLabelCode's values are dependant on
the DangerousGoodsRegulationsCode. DangerousGoodsLabelCode3 can be
based on GDT: DangerousGoodsLabelCode.
[1056] PackagingInstructionTypeCode can be a coded representation
of a packaging instruction. In some implementations, a packaging
instruction is an instruction defining which packagings may be used
to pack a dangerous good. PackagingInstructionTypeCode can be based
on GDT: PackagingInstructionTypeCode. TransportMeansDescriptionCode
can be a coded representation of a transport means type with which
goods or persons can be transported. TransportMeansDescriptionCode
can be based on GDT: TransportMeansDescriptionCode.
TransportAuthorisationCode can be a coded representation of an
authorisation for the transportation of dangerous goods. This code
can specify an authorisation for the transportation of a particular
dangerous good. TransportAuthorisationCode can be based on GDT:
DangerousGoodsTransportAuthorisationCode.
[1057] ContactInformation can specify information on a department
or person to whom information regarding dangerous goods can be
directed. The structure of ContactInformation includes the
ContactPersonFunctionTypeCode and Address elements.
ContactPersonFunctionTypeCode can be a coded representation of a
type of function that a contact person has.
ContactPersonFunctionTypeCode can be based on GDT:
ContactPersonFunctionTypeCode. Address can be an address related to
contact information defined by a corresponding FunctionTypeCode.
Address can be based on GDT: Address.
[1058] TextCollection can be a group of textual information that
relates to the DangerousGoods. The structure of the TextCollection
entity includes the TextCollection element. TextCollection can be
based on GDT: TextCollection.
Message Data Type
RequestForSupplierFreightQuoteCancelRequestMessage
[1059] The message data type
RequestForSupplierFreightQuoteCancelRequestMessage can group
together business information relevant for sending a business
document in a message, and the RequestForSupplierFreightQuote
object in a business document. The message data type
RequestForSupplierFreightQuoteCancelRequestMessage includes the
MessageHeader and RequestForSupplierFreightQuote packages.
[1060] A MessageHeader package can group together business
information relevant for sending a business document in a message.
The MessageHeader package includes the MessageHeader entity. A
MessageHeader can group together business information from a
perspective of the sending application, to identify a business
document in a message, to provide information about the sender, and
to provide information about the recipient. The MessageHeader can
be divided up into the SenderParty and RecipientParty entities.
MessageHeader can be of type GDT: BusinessDocumentMessageHeader.
The MessageHeader includes the following elements: ID, ReferenceID,
and CreationDateTime. The MessageID can be set by the sending
application. With the ReferencedMessageID, reference can be made in
the current BusinessDocument to a previous BusinessDocument.
[1061] A SenderParty can be a party responsible for sending a
business document at a business application level. The SenderParty
can be of type GDT: BusinessDocumentMessageHeaderParty. The
SenderParty includes the following elements: InternalID,
StandardID, and ContactPerson. The SenderParty can be filled by the
sending application to name a contact person for problems with the
message. A contact person can be useful if an additional
infrastructure, such as a marketplace, is located between the
sender and the recipient. The SenderParty can be used to transfer a
message and can be ignored by the receiving application.
SenderParty can be filled by the sender if the participating
parties are not transferred with the ShipmentRequest package.
[1062] A RecipientParty can be a party responsible for receiving a
business document at a business application level. The
RecipientParty can be of type GDT:
BusinessDocumentMessageHeaderParty. The RecipientParty includes the
following elements: InternalID, StandardID, and ContactPerson. The
RecipientParty can be filled by the sending application to name a
contact person for problems that may occur with the message. A
contact person can be useful if an additional infrastructure, such
as a marketplace, is located between the sender and the recipient.
The RecipientParty can be used to transfer a message and can be
ignored by the receiving application. RecipientParty can be filled
by the sender if the ShipmentRequest package cannot be used to
transfer the participating parties
[1063] The RequestForSupplierFreightQuote package can group
together information about the RequestForSupplierFreightQuote. The
RequestForSupplierFreightQuote package includes the
RequestForSupplierFreightQuote entity.
RequestForSupplierFreightQuote can be a request from an ordering
party to a supplier of a transportation service to submit a quote
for the transportation of goods from one or more ship-from parties
to one or more ship-to parties with requested terms and conditions.
The structure of RequestForSupplierFreightQuote includes the ID
element. ID can be a unique identifier for a
RequestForSupplierFreightQuote. ID can be based on GDT:
BusinessTransactionDocumentID.
SupplierFreightQuote Interfaces
[1064] A SupplierFreightQuote can be part of a Transportation
Management subcontracting and tendering process, where
transportation services can be tendered between transportation
service providers. The terms and conditions of a transportation
service, as well as the bidding rules of the tendering process, are
included in the RequestForSupplierFreightQuote. The response of a
supplier of a transportation service to a customer is included in
the SupplierFreightQuote. A supplier, such as Transportation
Customer Quote Processing, can respond to a customer, such as
Transportation Supplier Quote Processing, with a freight quote by
using the interfaces described below.
[1065] A SupplierFreightQuoteNotification can be a notification
from a Supplier about a SupplierFreightQuote. The structure of the
SupplierFreightQuoteNotification can be specified by the message
data type SupplierFreightQuoteNotificationMessage. The message
interface on the Supplier side includes
SupplierFreightQuoteNotification_Out. The message interface on the
Customer side includes SupplierFreightQuoteNotification_In.
[1066] The message choreography of FIG. 125 describes a possible
logical sequence of messages that can be used to realize a
Transportation Management business scenario. A "Supplier" system
125000 can notify a "Customer" system 125002 about a freight quote,
using a SupplierFreightQuoteNotification message 125004 as shown,
for example in FIG. 125.
[1067] FIGS. 126-1 through 126-21 illustrate one example logical
configuration of SupplierFreightQuoteNotificationMessage message
126000. Specifically, this figure depicts the arrangement and
hierarchy of various components such as one or more levels of
packages, entities, and datatypes, shown here as 126002 through
126422. As described above, packages may be used to represent
hierarchy levels. Entities are discrete business elements that are
used during a business transaction. Data types are used to type
object entities and interfaces with a structure. For example,
SupplierFreightQuoteNotificationMessage message 126000 includes,
among other things, SupplierFreightQuote 126056. Accordingly,
heterogeneous applications may communicate using this consistent
message configured as such.
[1068] Additionally, FIGS. 127-1 through 127-123 illustrate one
example logical configuration of a
SupplierFreightQuoteNotificationMessage 1270000 element structure.
Specifically, these figures depict the arrangement and hierarchy of
various components such as one or more levels of packages,
entities, and datatypes, shown here as 1270000 through 1274676. As
described above, packages may be used to represent hierarchy
levels. Entities are discrete business elements that are used
during a business transaction. Data types are used to type object
entities and interfaces with a structure. For example, the
SupplierFreightQuoteNotificationMessage 1270000 includes, among
other things, a SupplierFreightQuoteNotificationMessage entity
1270002. Accordingly, heterogeneous applications may communicate
using this consistent message configured as such.
Message Data Type SupplierFreightQuoteNotificationMessage
[1069] The message data type
SupplierFreightQuoteNotificationMessage includes business
information relevant for sending a business document in a message
and a SupplierFreightQuote included in a business document. The
message data type SupplierFreightQuoteNotificationMessage includes
the MessageHeader and SupplierFreightQuote packages.
[1070] A MessageHeader package can group together business
information relevant for sending a business document in a message.
The MessageHeader package includes the MessageHeader entity. A
MessageHeader can group together business information from a
perspective of the sending application to identify a business
document in a message, to provide information about the sender, and
to provide information about a recipient. The MessageHeader can be
divided up into the SenderParty and RecipientParty. MessageHeader
can be of type GDT: BusinessDocumentMessageHeader. The
MessageHeader includes the following elements: ID, ReferenceID, and
CreationDateTime. The MessageID can be set by the sending
application. With the ReferencedMessageID, reference can be made in
the current BusinessDocument to a previous BusinessDocument.
[1071] A SenderParty can be a party responsible for sending a
business document at a business application level. The SenderParty
can be of type GDT: BusinessDocumentMessageHeaderParty. The
SenderParty includes the following elements: InternalID,
StandardID, and ContactPerson. The SenderParty can be filled by the
sending application to name a contact person for problems with a
message. A contact person can be useful if an additional
infrastructure, such as a marketplace, is located between the
sender and the recipient. The SenderParty can be used to transfer a
message and can be ignored by the receiving application.
SenderParty can be filled by the sender if the participating
parties are not transferred with the ShipmentRequest package.
[1072] A RecipientParty can be a party responsible for receiving a
business document at a business application level. The
RecipientParty can be of type GDT:
BusinessDocumentMessageHeaderParty. The RecipientParty includes the
following elements: InternalID, StandardID, and ContactPerson. The
RecipientParty can be filled by the sending application to name a
contact person for problems that may occur with a message. A
contact person can be useful if an additional infrastructure, such
as a marketplace, is located between the sender and the recipient.
The RecipientParty can be used to transfer a message and can be
ignored by the receiving application. In some implementations,
RecipientParty may be filled by the sender if the ShipmentRequest
package cannot be used to transfer the participating parties.
[1073] The SupplierFreightQuote package can group the
SupplierFreightQuote together with its packages. The
SupplierFreightQuote package includes the SupplierFreightQuote
entity and the following packages: HeaderInformation,
GovernmentalRequirementInformation, PartyInformation,
TransportationStageInformation,
TransportationUnitResourceInformation,
TransportationChargesInformation, and SupplierShipmentQuote.
[1074] SupplierFreightQuote can be a quote from a supplier to an
ordering party of a transportation service for the transportation
of goods from one or more ship-from parties to one or more ship-to
parties with requested terms and conditions. The structure of
SupplierFreightQuote includes the ID element. ID can be a unique
identifier for a SupplierFreightQuote. ID can be based on GDT:
BusinessTransactionDocumentID.
[1075] The HeaderInformation package can group dates, total values,
documents and references related to a shipment request. The
HeaderInformation package includes the following entities:
DateTimePeriods, NatureOfCargo, TotalQuantity, TotalAmount,
TextCollection, TransportationServiceRequirement,
TransportationDocumentInformation, and
BusinessTransactionDocumentReference.
[1076] DateTimePeriods can specify a requested and an acceptable
date, time and period applying to a shipment request (e.g., date
and time of document issue). A requested period can be a period in
which an event is requested to take place. An acceptable period can
be a period in which an event may take place at an earliest start
date/time to a latest end date/time. The elements located directly
at the DateTimePeriods entity include RequestedFulfillmentPeriod,
AcceptableFulfillmentPeriod, and PeriodRoleCode.
RequestedFulfillmentPeriod can be a period which is requested
depending on semantics of the PeriodRoleCode.
RequestedFulfillmentPeriod can be based on GDT: DATETIMEPERIOD,
Qualifier: RequestedFulfillment. AcceptableFulfillmentPeriod can be
a period which is acceptable depending on semantics of the
PeriodRoleCode. AcceptableFulfillmentPeriod can be based on GDT:
DATETIMEPERIOD, Qualifier: AcceptableFulfillment. PeriodRoleCode
can be a coded representation of business semantics to of the two
periods defined by the entities RequestedFulfillmentPeriod and
AcceptableFulfillmentPeriod. PeriodRoleCode can be based on GDT:
PeriodRoleCode. In some implementations, RequestedFulfillmentPeriod
and AcceptableFulfillmentPeriod are optional, but in every instance
one of them may be filled.
[1077] NatureOfCargo can indicate a nature of cargo related to a
shipment request (e.g., palletized, containerized, documents). The
structure of NatureOfCargo includes the ClassificationCode element.
ClassificationCode can be a coded representation of a
classification of a nature of cargo. ClassificationCode can be
based on GDT: NatureOfCargoClassificationCode.
[1078] TotalQuantity can specify a total quantity which is related
to a whole shipment request (e.g., total number of equipment, total
number of items). The structure of TotalQuantity includes the
following elements: Quantity, RoleCode, and TypeCode. Quantity can
be a non-monetary numerical specification of an amount in a unit of
measurement. Quantity can be based on GDT: Quantity. RoleCode can
be a coded representation of a role of a quantity. RoleCode can be
based on GDT: QuantityRoleCode. TypeCode can be a coded
representation of a type of quantity that is based on a measurable
characteristic of an object or physical phenomenon. TypeCode can be
based on GDT: QuantityTypeCode. In some implementations,
QuantityRoleCode and QuantityTypeCode are optional, but in every
instance one of them may be filled.
[1079] TotalAmount can specify a cumulated monetary amount related
to a shipment request (e.g., duty amount, insurance amount, total
value). The structure of TotalAmount includes the Amount and
RoleCode elements. Amount can be an amount with a corresponding
currency unit. Amount can be based on CDT: Amount. RoleCode can be
a coded representation of a role of an amount. RoleCode can be
based on GDT: AmountRoleCode.
[1080] TextCollection can be a group of textual information that
relates to a shipment request. The structure of the TextCollection
entity includes the TextCollection element. TextCollection can be
based on GDT: TextCollection.
[1081] TransportationServiceRequirement can specify a contract and
carriage condition and service and priority requirements for a
transport which apply to a whole shipment request. The structure of
TransportationServiceRequirement includes the following elements:
TransportationServiceRequirementCode,
AdditionalTransportationServiceRequirementCode,
TransportationContractConditionCode, TransportServiceLevelCode, and
NatureOfCargoClassificationCode.
TransportationServiceRequirementCode can be a coded representation
of a requirement related to a transportation service.
TransportationServiceRequirementCode can be based on GDT
TransportationServiceRequirementCode.
[1082] AdditionalTransportationServiceRequirementCode can be a
coded representation of an additional requirement related to a
transportation service.
AdditionalTransportationServiceRequirementCode can be based on GDT:
TransportationServiceRequirementCode, Qualifier: Additional.
TransportationContractConditionCode can be a coded representation
of a contract and carriage condition.
TransportationContractConditionCode can be based on GDT:
TransportationContractConditionCode. TransportServiceLevelCode can
be a coded representation of agreed or defined services in terms of
the delivery of goods with respect to the speed of the delivery.
TransportServiceLevelCode can be based on GDT:
TransportServiceLevelCode. NatureOfCargoClassificationCode can be a
coded representation of the classification of a nature of cargo.
NatureOfCargoClassificationCode can be based on GDT:
NatureOfCargoClassificationCode.
[1083] TransportationDocumentInformation can specify information on
a transportation document related to a shipment request.
TransportationDocumentInformation includes the DateTimePeriod
entity. TransportationDocumentTypeCode can be a coded
representation of a documentation type.
TransportationDocumentTypeCode can be based on GDT:
TransportationDocumentTypeCode. TransportationDocumentNote can be a
short note on documentation. TransportationDocumentNote can be
based on GDT: SHORT_Note. TransportationDocumentID can be a unique
identifier for a transportation document. TransportationDocumentID
can be based on GDT: TransportationDocumentID.
TransportationDocumentStatusCode can be a coded representation of a
status of a transportation document (e.g., to be printed, document
complete).
[1084] TransportationDocumentStatusCode can be based on GDT:
TransportationDocumentStatusCode. LanguageCode can be a coded
representation of the language of a documentation. LanguageCode can
be based on GDT: LanguageCode. CommunicationMediumTypeCode can be a
coded representation of the type of a medium used for communication
of documentation, such as Fax, mail, EDI, or Letter.
CommunicationMediumTypeCode can be based on GDT
CommunicationMediumTypeCode. RequiredIndicator can indicate whether
a documentation is required or not. RequiredIndicator can be based
on GDT: Indicator Qualifier: Required.
[1085] OutputCopyNumberValue can be a number specifying the number
of copies of a document that may be issued. OutputCopyNumberValue
can be based on GDT: NumberValue, Qualifier: OutputCopy.
OutputOriginalNumberValue can be a number specifying the number of
originals of a document that may be issued.
OutputOriginalNumberValue can be based on GDT: NumberValue,
Qualifier: OutputOriginal. In some implementations, TypeCode and
TypeDescription are both optional, but at least one of them may be
used. In some implementations, if the RequiredIndicator is set to
true, at least one of the NumberValues OutputCopyNumberValue or
OutputOriginalNumberValue may be filled.
[1086] DateTimePeriod can specify a date, time and/or period (e.g.,
validity date) related to required business documentation. The
structure of the DateTimePeriod entity includes the DateTimePeriod
and PeriodRoleCode elements. DateTimePeriod can be a period that is
defined by two points in time. DateTimePeriod can be based on GDT:
DateTimePeriod. PeriodRoleCode can be a coded representation of
business semantics of a period. PeriodRoleCode can be based on GDT:
PeriodRoleCode.
[1087] BusinessTransactionDocumentReference can specify a business
document reference related to a whole shipment request.
BusinessTransactionDocumentReference includes the DateTimePeriod
entity. The structure of the BusinessTransactionDocumentReference
entity includes the following elements:
BusinessTransactionDocumentReference,
BusinessTransactionDocumentRelationshipRoleCode,
BusinessTransactionDocumentRelationshipTypeCode,
TransportationDocumentTypeCode, TransportationDocumentNote, and
TransportationDocumentID. BusinessTransactionDocumentReference can
be a unique reference to other business documents or business
document items that are of significance within each respective
business process. BusinessTransactionDocumentReference can be based
on GDT: BusinessTransactionDocumentReference.
[1088] BusinessTransactionDocumentRelationshipRoleCode can be a
coded representation of a role that a business document or a
business document item has when set against another business
document or business document item with a relationship.
BusinessTransactionDocumentRelationshipRoleCode can be based on
GDT: BusinessTransactionDocumentRelationshipRoleCode.
BusinessTransactionDocumentRelationshipTypeCode can be a coded
representation of a relationship between two business documents or
business document items.
BusinessTransactionDocumentRelationshipTypeCode can be based on
GDT: BusinessTransactionDocumentRelationshipTypeCode.
TransportationDocumentTypeCode can be a coded representation of a
documentation type.
[1089] TransportationDocumentTypeCode can be based on GDT:
TransportationDocumentTypeCode. TransportationDocumentNote can be a
short note on documentation. TransportationDocumentNote can be
based on GDT: SHORT_Note. TransportationDocumentID can be a unique
identifier for a transportation document. TransportationDocumentID
can be based on GDT: TransportationDocumentID. In some
implementations, RelationshipTypeCode and RelationshipRoleCode are
both optional. If used, both may be filled. Either the combination
BusinessTransactionDocumentReference,
BusinessTransactionDocumentRelationshipRoleCode,
BusinessTransactionDocumentRelationshipTypeCode, or
TransportationDocumentTypeCode, TransportationDocumentNote,
TransportationDocumentID may be filled.
[1090] DateTimePeriod can specify a date, time and/or period
related to a DocumentReference. The structure of the DateTimePeriod
entity includes the DateTimePeriod and PeriodRoleCode elements.
DateTimePeriod can be a period that is defined by two points in
time. DateTimePeriod can be based on GDT: DateTimePeriod.
PeriodRoleCode can be a coded representation of business semantics
of a period. PeriodRoleCode can be based on GDT: PeriodRoleCode.
PeriodRoleCode includes the modified entity
BusinessTransactionDocumentReference.
[1091] BusinessTransactionDocumentReference can specify a business
document reference related to a whole shipment request.
BusinessTransactionDocumentReference includes the DateTimePeriod
entity. The structure of the BusinessTransactionDocumentReference
entity includes the following elements:
BusinessTransactionDocumentReference,
BusinessTransactionDocumentRelationshipRoleCode,
BusinessTransactionDocumentRelationshipTypeCode,
TransportationDocumentTypeCode, TransportationDocumentNote, and
TransportationDocumentID. BusinessTransactionDocumentReference can
be a unique reference to other business documents or business
document items that are of significance within each respective
business process. BusinessTransactionDocumentReference can be based
on GDT: BusinessTransactionDocumentReference.
[1092] BusinessTransactionDocumentRelationshipRoleCode can be a
coded representation of a role that a business document or a
business document item has when set against another business
document or business document item with a relationship.
BusinessTransactionDocumentRelationshipRoleCode can be based on
GDT: BusinessTransactionDocumentRelationshipRoleCode.
BusinessTransactionDocumentRelationshipTypeCode can be a coded
representation of a relationship between two business documents or
business document items.
BusinessTransactionDocumentRelationshipTypeCode can be based on
GDT: BusinessTransactionDocumentRelationshipTypeCode.
TransportationDocumentTypeCode can be a coded representation of a
documentation type.
[1093] TransportationDocumentTypeCode can be based on GDT:
TransportationDocumentTypeCode. TransportationDocumentNote can be a
short note on documentation. TransportationDocumentNote can be
based on GDT: SHORT_Note. TransportationDocumentID can be a unique
identifier for a transportation document. TransportationDocumentID
can be based on GDT: TransportationDocumentID. In some
implementations, RelationshipTypeCode and RelationshipRoleCode are
both optional. If used, both may be filled. Either the combination
BusinessTransactionDocumentReference,
BusinessTransactionDocumentRelationshipRoleCode,
BusinessTransactionDocumentRelationshipTypeCode, or
TransportationDocumentTypeCode, TransportationDocumentNote,
TransportationDocumentID, may be filled. The additional entity
RequestForSupplierFreightQuoteAcceptanceStatus may be included.
[1094] RequestForSupplierFreightQuoteAcceptanceStatus can specify
an acceptance status of a referenced request for a supplier freight
quote. The structure of
RequestForSupplierFreightQuoteAcceptanceStatus includes the
AcceptanceStatusCode and RequestForQuoteRejectionReasonCode
elements. The AcceptanceStatusCode can be a coded representation of
a status of an acceptance by a communication partner regarding a
business transaction that has been transmitted to that partner.
AcceptanceStatusCode can be based on GDT: AcceptanceStatusCode. The
RequestForQuoteRejectionReasonCode can be a coded representation of
a reason for rejection of a request for a supplier freight quote.
RequestForQuoteRejectionReasonCode can be based on GDT:
RequestForQuoteRejectionReasonCode. In some implementations, the
AcceptanceStatusCode values `AP` (accepted) and `RE` (rejected) are
supported. GovernmentalProcedureInformation can specify applicable
governmental procedures related to import, export and transport of
the goods of a shipment request. GovernmentalProcedureInformation
includes the GovernmentalProcedure entity. GovernmentalProcedure
can specify applicable governmental procedures related to import,
export and transport of the goods of a shipment request.
GovernmentalProcedure includes the following entities: Location,
DateTimePeriod, Seal, TextCollection, and
TransportationDocumentInformation. The structure of
GovernmentalProcedure includes the following elements:
TransportationGovernmentAgencyTypeCode,
TransportationMovementTypeCode,
TransportationGovernmentAgencyInvolvementStatusCode,
TransportationGovernmentAgencyActionCode, and
TransportationGovernmentAgencyProcedureStatusCode.
[1095] TransportationGovernmentAgencyTypeCode can be a coded
representation of the type of a government agency, and can be based
on GDT: TransportationGovernmentAgencyTypeCode.
TransportationMovementTypeCode can be a coded representation of the
type of a transport movement (e.g., Import, Export, Transit,
Transshipment). TransportationMovementTypeCode can be based on GDT:
TransportationMovementTypeCode.
TransportationGovernmentAgencyInvolvementStatusCode can be a coded
representation for an involvement status of a transportation
related government agency.
TransportationGovernmentAgencyInvolvementStatusCode can be based on
GDT: TransportationGovernmentAgencyInvolvementStatusCode.
[1096] TransportationGovernmentAgencyActionCode can be a coded
representation of an action of a transportation related government
agency. TransportationGovernmentAgencyActionCode can be based on
GDT: TransportationGovernmentAgencyActionCode.
TransportationGovernmentAgencyProcedureStatusCode can be a coded
representation of a status of a procedure related to a
transportation government agency.
TransportationGovernmentAgencyProcedureStatusCode can be based on
GDT: TransportationGovernmentAgencyProcedureStatusCode.
[1097] Location can be a physical place related to a
GovernmentalProcedure. The structure of the Location entity
includes the following elements: Location, RoleCode, TypeCode, and
Name. Location includes information exchanged in business documents
about a location relevant for business transactions. Location can
be based on GDT: BusinessTransactionDocumentLocation. RoleCode can
be a coded representation of a LocationRole. RoleCode can be based
on GDT: LocationRoleCode. TypeCode can be a coded representation of
a type of a physical location. TypeCode can be based on GDT:
LocationTypeCode. Name can be a name of a location. Name can be
based on GDT: MEDIUM_Name, Qualifier: Location.
[1098] DateTimePeriod specifies a date, time and/or period related
to a GovernmentalProcedure. The structure of DateTimePeriod
includes the DateTimePeriod and PeriodRoleCode elements.
DateTimePeriod can be a period that is defined by two points in
time. DateTimePeriod can be based on GDT: DateTimePeriod.
PeriodRoleCode can be a coded representation of business semantics
of a period. PeriodRoleCode can be based on GDT:
PeriodRoleCode.
[1099] TextCollection can be a group of textual information that
relates to a GovernmentalProcedure. The structure of the
TextCollection entity includes the TextCollection element.
TextCollection can be based on GDT: TextCollection.
[1100] TransportationDocumentInformation can specify information on
a transportation document related to the GovernmentalProcedure.
TransportationDocumentInformation includes the
DateTimePeriodentity. The structure of the
TransportationDocumentInformation entity includes the following
elements: TransportationDocumentTypeCode,
TransportationDocumentNote, TransportationDocumentID,
TransportationDocumentStatusCode, LanguageCode,
CommunicationMediumTypeCode, RequiredIndicator,
OutputCopyNumberValue, and OutputOriginalNumberValue.
TransportationDocumentTypeCode can be a coded representation of a
documentation type. TransportationDocumentTypeCode can be based on
GDT: TransportationDocumentTypeCode.
[1101] TransportationDocumentNote can be a short note on
documentation. TransportationDocumentNote can be based on GDT:
SHORT_Note. TransportationDocumentID can be a unique identifier for
a transportation document. TransportationDocumentID can be based on
GDT: TransportationDocumentID. TransportationDocumentStatusCode can
be a coded representation of a status of a transportation document
(e.g., to be printed, document complete).
TransportationDocumentStatusCode can be based on GDT:
TransportationDocumentStatusCode. LanguageCode can be a coded
representation of the language of a documentation. LanguageCode can
be based on GDT: LanguageCode. CommunicationMediumTypeCode can be a
coded representation of the type of a medium used for communication
of the documentation, such as Fax, mail, EDI, or Letter.
CommunicationMediumTypeCode can be based on GDT:
CommunicationMediumTypeCode.
[1102] RequiredIndicator can indicate whether a documentation is
required or not. RequiredIndicator can be based on GDT: Indicator
Qualifier: Required. OutputCopyNumberValue can be a number
specifying the number of copies of a document that may be issued.
OutputCopyNumberValue can be based on GDT: NumberValue, Qualifier:
OutputCopy. OutputOriginalNumberValue can be a number specifying
the number of originals of a document that may be issued.
OutputOriginalNumberValue can be based on GDT: NumberValue,
Qualifier: OutputOriginal. In some implementations, TypeCode and
TypeDescription are both optional, but at least one of them may be
used. In some implementations, if the RequiredIndicator is set to
true, at least one of the NumberValues OutputCopyNumberValue or
OutputOriginalNumberValue may be filled.
[1103] DateTimePeriod can specify a date, time and/or period
related to documentation. The structure of the DateTimePeriod
entity includes the DateTimePeriod and PeriodRoleCode elements.
DateTimePeriod can be a period that is defined by two points in
time. DateTimePeriod can be based on GDT: DateTimePeriod.
PeriodRoleCode can be a coded representation of business semantics
of a period. PeriodRoleCode can be based on GDT:
PeriodRoleCode.
[1104] The PartyInformation package includes information regarding
a party of a shipment request (e.g., Shipper, Carrier, Agent).
PartyInformation includes the Party entity. Party includes
information exchanged, in accordance with common business
understanding, in business documents, about a party involved in
business transactions. This information can be used to identify the
party and the party's address, as well as the party's contact
person and the contact person's address. This identification can
take place using an internal ID, a standardized ID, or IDs assigned
by the parties involved. The Party entity includes the following
entities: Amount, DateTimePeriods,
TransportationDocumentInformation, and
BusinessTransactionDocumentReference. The structure of the Party
entity includes the following elements: Party, RoleCode, and
FormattedName.
[1105] A Party includes information exchanged, in accordance with
common business understanding, in business documents, about a party
involved in business transactions. This information can be used to
identify the party and the party's address, as well as the party's
contact person and the contact person's address. This
identification can take place using an internal ID, a standardized
ID, or IDs assigned by the parties involved. Party can be based on
GDT: BusinessTransactionDocumentParty. RoleCode can be a coded
representation of a PartyRoleCode which specifies which rights and
obligations the party has regarding a business object and
corresponding processes. In some implementations, a PartyRole is
assigned to exactly one PartyRoleCategory and refines its
semantics. RoleCode can be based on GDT: PartyRoleCode.
FormattedName can be a complete, formatted name of a party.
FormattedName can be based on GDT: LONG_Name, Qualifier:
PartyFormatted.
[1106] Amount can specify an amount related to a party. Amount can
be an amount with a corresponding currency unit, and can be based
on CDT: Amount. RoleCode can be a coded representation of a role of
an amount, and can be based on GDT: AmountRoleCode.
[1107] DateTimePeriods can specify a requested and an acceptable
date, time and period related to a party. A requested period can be
a period in which an event is requested to take place. An
acceptable period can be a period in which an event may take place
at an earliest start date/time to a latest end date/time. The
elements located directly at the DateTimePeriods entity include
RequestedFulfillmentPeriod, AcceptableFullfilmentPeriod, and
PeriodRoleCode. RequestedFulfillmentPeriod can be a period which is
requested depending on semantics of the PeriodRoleCode.
RequestedFulfillmentPeriod can be based on GDT: DATETIMEPERIOD,
Qualifier: RequestedFulfillment.
[1108] AcceptableFulfillmentPeriod can be a period which is
acceptable depending on semantics of the PeriodRoleCode.
AcceptableFulfillmentPeriod can be based on GDT: DATETIMEPERIOD,
Qualifier: AcceptableFulfillment. PeriodRoleCode can be a coded
representation of business semantics of the two periods defined by
the entities RequestedFulfillmentPeriod and
AcceptableFulfillmentPeriod. PeriodRoleCode can be based on GDT:
PeriodRoleCode. In some implementations, RequestedFulfillmentPeriod
and AcceptableFulfillmentPeriod are optional, but in every instance
one of them may be filled.
[1109] TransportationDocumentInformation can specify business
documentation related to a party according to a documentation type.
TransportationDocumentInformation includes the DateTimePeriod
entity. The structure of TransportationDocumentInformation includes
the following elements: TransportationDocumentTypeCode,
TransportationDocumentNote, TransportationDocumentID,
TransportationDocumentStatusCode, LanguageCode,
CommunicationMediumTypeCode, RequiredIndicator,
OutputCopyNumberValue, and OutputOriginalNumberValue.
TransportationDocumentTypeCode can be a coded representation of a
documentation type. TransportationDocumentTypeCode can be based on
GDT: TransportationDocumentTypeCode. TransportationDocumentNote can
be a short note on documentation. TransportationDocumentNote can be
based on GDT: SHORT_Note. TransportationDocumentID can be a unique
identifier for a transportation document. TransportationDocumentID
can be based on GDT: TransportationDocumentID.
TransportationDocumentStatusCode can be a coded representation of a
status of a transportation document (e.g., to be printed, document
complete).
[1110] TransportationDocumentStatusCode can be based on GDT:
TransportationDocumentStatusCode. LanguageCode can be a coded
representation of the language of a documentation. LanguageCode can
be based on GDT: LanguageCode. CommunicationMediumTypeCode can be a
coded representation of the type of a medium used for communication
of documentation, such as Fax, mail, EDI, or Letter.
CommunicationMediumTypeCode can be based on GDT
CommunicationMediumTypeCode. RequiredIndicator can indicate whether
a documentation is required or not. RequiredIndicator can be based
on GDT: Indicator Qualifier: Required. OutputCopyNumberValue can be
a number specifying the number of copies of a document that may be
issued.
[1111] OutputCopyNumberValue can be based on GDT: NumberValue,
Qualifier: OutputCopy. OutputOriginalNumberValue can be a number
specifying the number of originals of a document that may be
issued. OutputOriginalNumberValue can be based on GDT: NumberValue,
Qualifier: OutputOriginal. In some implementations, TypeCode and
TypeDescription are both optional, but at least one of them may be
used. In some implementations, if the RequiredIndicator is set to
true, at least one of the NumberValues OutputCopyNumberValue or
OutputOriginalNumberValue may be filled.
[1112] DateTimePeriod can specify a date, time and/or period (e.g.,
validity date) related to business documentation of a party.
DateTimePeriod can be a period that is defined by two points in
time. DateTimePeriod can be based on GDT: DateTimePeriod.
PeriodRoleCode can be a coded representation of the business
semantic of a period. PeriodRoleCode can be based on GDT:
PeriodRoleCode.
[1113] BusinessTransactionDocumentReference can specify a business
document reference related to a party.
BusinessTransactionDocumentReference includes the DateTimePeriod
entity. The structure of the BusinessTransactionDocumentReference
entity includes the following elements:
BusinessTransactionDocumentReference,
BusinessTransactionDocumentRelationshipRoleCode,
BusinessTransactionDocumentRelationshipTypeCode,
TransportationDocumentTypeCode, TransportationDocumentNote, and
TransportationDocumentID. BusinessTransactionDocumentReference can
be a unique reference to other business documents or business
document items that are of significance within each respective
business process. BusinessTransactionDocumentReference can be based
on GDT: BusinessTransactionDocumentReference.
[1114] BusinessTransactionDocumentRelationshipRoleCode can be a
coded representation of a role that a business document or a
business document item has when set against another business
document or business document item with a relationship.
BusinessTransactionDocumentRelationshipRoleCode can be based on
GDT: BusinessTransactionDocumentRelationshipRoleCode.
BusinessTransactionDocumentRelationshipTypeCode can be a coded
representation of a relationship between two business documents or
business document items.
BusinessTransactionDocumentRelationshipTypeCode can be based on
GDT: BusinessTransactionDocumentRelationshipTypeCode.
TransportationDocumentTypeCode can be a coded representation of a
documentation type.
[1115] TransportationDocumentTypeCode can be based on GDT:
TransportationDocumentTypeCode. TransportationDocumentNote can be a
short note on documentation. TransportationDocumentNote can be
based on GDT: SHORT_Note. TransportationDocumentID can be a unique
identifier for a transportation document. TransportationDocumentID
can be based on GDT: TransportationDocumentID. In some
implementations, RelationshipTypeCode and RelationshipRoleCode are
both optional. If used, both may be filled. Either the combination
BusinessTransactionDocumentReference,
BusinessTransactionDocumentRelationshipRoleCode,
BusinessTransactionDocumentRelationshipTypeCode, or
TransportationDocumentTypeCode, TransportationDocumentNote,
TransportationDocumentID may be filled.
[1116] DateTimePeriod can specify a date, time and/or period
related to a document referenced by a party. DateTimePeriod can be
a period that is defined by two points in time. DateTimePeriod can
be based on GDT: DateTimePeriod. PeriodRoleCode can be a coded
representation of business semantics of a period. PeriodRoleCode
can be based on GDT: PeriodRoleCode.
[1117] The TransportationStageInformation package includes
information regarding a transportation stage of a shipment request.
A transportation stage represents a section of a transport. The
TransportationStageInformation package includes the Stage entity.
TransportationStage can specify details related to a stage of a
transport which is part of a shipment request. TransportationStage
includes the following entities: Location,
TransportationDocumentInformation, and
TransportationServiceRequirement. The structure of
TransportationStage includes the following elements: ID,
OrdinalNumberValue, TypeCode, JourneyID, TransportModeCode,
TransportMeansDescriptionCode, TransportMeansDescription,
TransportMeansID, TransportMeansHomeCountryCode, TransportMeans
OwnershipTypeCode, CarrierStandardID, CarrierFormattedName,
TransportationTransitDirectionCode, CalculatedDistanceMeasure, and
GivenDistanceMeasure.
[1118] ID can be a unique identifier of a stage in a shipment
request. ID can be based on GDT: TransportationStageID.
OrdinalNumberValue can be an ordinal number to indicate a position
of a transportation stage in a set of transportation stages.
OrdinalNumberValue can be based on GDT: OrdinalNumberValue,
Qualifier: TransportationStage. TypeCode can be a coded
representation of the type of a TransportationStage. TypeCode can
be based on GDT: TransportationStageTypeCode. JourneyID can be an
identifier of a journey. JourneyID can be based on GDT: JourneyID.
TransportModeCode can be a coded representation of a mode of
transportation used for delivery. TransportModeCode can be based on
GDT: TransportModeCode. TransportMeansDescriptionCode can be a
coded representation of a transport means type with which goods or
persons can be transported. TransportMeansDescriptionCode can be
based on GDT: TransportMeansDescriptionCode.
[1119] TransportMeansDescription can be a description of a means of
transport. TransportMeansDescription can be based on GDT:
SHORT_Description, Qualifier: TransportMeans. TransportMeansID can
be a unique identifier of a means of transport. TransportMeansID
can be based on GDT: TransportMeansID.
TransportMeansHomeCountryCode can be a coded representation of the
home country of a transport means. TransportMeansHomeCountryCode
can be based on GDT: CountryCode, Qualifier: TransportMeansHome.
TransportMeansOwnershipTypeCode can be a coded representation of
the type of ownership for a means of transport.
TransportMeansOwnershipTypeCode can be based on GDT:
TransportMeansOwnershipTypeCode.
[1120] CarrierStandardID can be a standard identifier of a carrier.
CarrierStandardID can be based on GDT: PartyStandardID.
CarrierFormattedName can be a name of a carrier.
CarrierFormattedName can be based on GDT: LONG_Name, Qualifier:
PartyFormatted. TransportationTransitDirectionCode can be a coded
representation for a transportation transit direction.
TransportationTransitDirectionCode can be based on GDT:
TransportationTransitDirectionCode. CalculatedDistanceMeasure can
be a calculated distance measure. CalculatedDistanceMeasure can be
based on GDT: Measure, Qualifier: CalculatedDistance.
GivenDistanceMeasure can be a given distance measure.
GivenDistanceMeasure can be based on GDT: Measure, Qualifier:
GivenDistance.
[1121] StageLocation can specify a physical place related to a
stage. StageLocation includes the DateTimePeriods entity. The
structure of the Location entity includes the following elements:
Location, RoleCode, TypeCode, and Name. Location includes
information exchanged in business documents about a location
relevant for business transactions. Location can be based on GDT:
BusinessTransactionDocumentLocation. RoleCode can be a coded
representation of a LocationRole. RoleCode can be based on GDT:
LocationRoleCode. TypeCode can be a coded representation of a type
of a physical location. TypeCode can be based on GDT:
LocationTypeCode. Name can be a name of a location. Name can be
based on GDT: MEDIUM_Name, Qualifier: Location.
[1122] DateTimePeriods can specify a date, time and/or period
related to a Location. The elements located directly at the
DateTimePeriods entity include RequestedFulfillmentPeriod,
AcceptableFullfilmentPeriod, and PeriodRoleCode.
RequestedFulfillmentPeriod can be a period which is requested
depending on semantics of the PeriodRoleCode.
RequestedFulfillmentPeriod can be based on GDT: DATETIMEPERIOD,
Qualifier: RequestedFulfillment. AcceptableFulfillmentPeriod can be
a period which is acceptable depending on semantics of the
PeriodRoleCode. AcceptableFulfillmentPeriod can be based on GDT:
DATETIMEPERIOD, Qualifier: AcceptableFulfillment. PeriodRoleCode
can be a coded representation of business semantics of the two
periods defined by the entities RequestedFulfillmentPeriod and
AcceptableFulfillmentPeriod. PeriodRoleCode can be based on GDT:
PeriodRoleCode. In some implementations, RequestedFulfillmentPeriod
and AcceptableFulfillmentPeriod are optional, but in every instance
one of them may be filled.
[1123] BusinessTransactionDocumentReference can specify a business
document reference related to a Stage.
BusinessTransactionDocumentReference includes the DateTimePeriod
entity. The structure of the BusinessTransactionDocumentReference
entity includes the following elements:
BusinessTransactionDocumentReference,
BusinessTransactionDocumentRelationshipRoleCode,
BusinessTransactionDocumentRelationshipTypeCode,
TransportationDocumentTypeCode, TransportationDocumentNote, and
TransportationDocumentID. BusinessTransactionDocumentReference can
be a unique reference to other business documents or business
document items that are of significance within each respective
business process. BusinessTransactionDocumentReference can be based
on GDT: BusinessTransactionDocumentReference.
[1124] BusinessTransactionDocumentRelationshipRoleCode can be a
coded representation of a role that a business document or a
business document item has when set against another business
document or business document item with a relationship.
BusinessTransactionDocumentRelationshipRoleCode can be based on
GDT: BusinessTransactionDocumentRelationshipRoleCode.
BusinessTransactionDocumentRelationshipTypeCode can be a coded
representation of a relationship between two business documents or
business document items.
BusinessTransactionDocumentRelationshipTypeCode can be based on
GDT: BusinessTransactionDocumentRelationshipTypeCode.
[1125] TransportationDocumentTypeCode can be a coded representation
of a documentation type. TransportationDocumentTypeCode can be
based on GDT: TransportationDocumentTypeCode.
TransportationDocumentNote can be a short note on documentation.
TransportationDocumentNote can be based on GDT: SHORT_Note.
TransportationDocumentID can be a unique identifier for a
transportation document. TransportationDocumentID can be based on
GDT: TransportationDocumentID. In some implementations,
RelationshipTypeCode and RelationshipRoleCode are both optional. If
used, both may be filled. Either the combination
BusinessTransactionDocumentReference,
BusinessTransactionDocumentRelationshipRoleCode,
BusinessTransactionDocumentRelationshipTypeCode, or
TransportationDocumentTypeCode, TransportationDocumentNote,
TransportationDocumentID may be filled.
[1126] DateTimePeriod specifies a date, time and/or period related
to a BusinessTransactionDocumentReference. The structure of the
DateTimePeriod entity includes the elements DateTimePeriod and
PeriodRoleCode. DateTimePeriod can be a period that is defined by
two points in time. DateTimePeriod can be based on GDT:
DateTimePeriod. PeriodRoleCode can be a coded representation of
business semantics of a period. PeriodRoleCode can be based on GDT:
PeriodRoleCode.
[1127] TransportationServiceRequirement specifies a contract and
carriage condition and service and priority requirements related to
a stage. The structure of TransportationServiceRequirement includes
the following elements: TransportationServiceRequirementCode,
AdditionalTransportationServiceRequirementCode,
TransportationContractConditionCode, TransportServiceLevelCode, and
NatureOfCargoClassificationCode.
TransportationServiceRequirementCode can be a coded representation
of a requirement related to a transportation service.
TransportationServiceRequirementCode can be based on GDT
TransportationServiceRequirementCode.
[1128] AdditionalTransportationServiceRequirementCode can be a
coded representation of an additional requirement related to a
transportation service.
AdditionalTransportationServiceRequirementCode can be based on GDT:
TransportationServiceRequirementCode, Qualifier: Additional.
TransportationContractConditionCode can be a coded representation
of a contract and carriage condition.
TransportationContractConditionCode can be based on GDT:
TransportationContractConditionCode. TransportServiceLevelCode can
be a coded representation of agreed or defined services in terms of
the delivery of goods with respect to the speed of the delivery.
TransportServiceLevelCode can be based on GDT:
TransportServiceLevelCode. NatureOfCargoClassificationCode can be a
coded representation of a classification of the nature of cargo.
NatureOfCargoClassificationCode can be based on GDT:
NatureOfCargoClassificationCode.
[1129] The TransportationUnitResourceInformation package includes
information regarding a transportation unit resource that is
relevant for a shipment request (e.g., a container). The
TransportationUnitResourceInformation package includes the
TransportationUnitResourceInformation entity.
TransportationUnitResourceInformation includes information on one
or more transportation unit resources, such as a resource type and
related properties, or related measures or handling instructions. A
Transportation Unit Resource can be a unit into which goods are
loaded and/or from which goods are unloaded. In some
implementations, this unit can provide transportation capacity for
goods but might move by itself
TransportationUnitResourceInformation includes the following
entities: TransportationStageAssignment, AttachedEquipment,
Quantity, BusinessTransactionDocumentReference, TextCollection,
Location, and DangerousGoods. The structure of
TransportationUnitResourceInformation includes the following
elements: ID, ResourceNumberValue, ResourceID,
ResourceHomeCountryCode, TransportationUnitResourceCategoryCode,
TransportationUnitResourceTypeCode, FillLevelCode,
ShippingTypeCode, HaulageArrangerCode,
TransportationHandlingInstructionCode, and
TransportationHandlingInstructionNote.
[1130] ID can be a unique identifier for a resource information. ID
can be based on GDT ResourceInformationID. ResourceNumberValue can
be a count of resources. ResourceNumberValue can be based on GDT:
NumberValue, Qualifier: Resource. ResourceID can be a unique
identifier for a resource. ResourceID can be based on GDT:
ResourceID. ResourceHomeCountryCode can be a coded representation
of the home country of a resource. ResourceHomeCountryCode can be
based on GDT: CountryCode, Qualifier: ResourceHome.
TransportationUnitResourceCategoryCode can be a coded
representation of a category of transportation unit resources.
TransportationUnitResourceCategoryCode can be based on GDT:
TransportationUnitResourceCategoryCode.
TransportationUnitResourceTypeCode can be a coded representation of
the type of a transportation unit resource.
[1131] TransportationUnitResourceTypeCode can be based on GDT:
TransportationUnitResourceTypeCode. FillLevelCode can be a coded
representation of a fill level of a resource. FillLevelCode can be
based on GDT: FillLevelCode. ShippingTypeCode can be a coded
representation of a shipping type. A shipping type can specify how
the planning and execution of a transportation can be performed.
Transportation terms include detailed specifications on agreed
means of transportation, such as shipping or transport type and
means of transport to be used. ShippingTypeCode can be based on
GDT: ShippingTypeCode. HaulageArrangerCode can be a coded
representation of an arranger of a haulage. Haulage can be inland
transport of cargo. HaulageArrangerCode can be based on GDT:
HaulageArrangerCode. TransportationHandlingInstructionCode can be a
coded representation of a type of a transportation handling
instruction. TransportationHandlingInstructionCode can be based on
GDT: TransportationHandlingInstructionCode.
TransportationHandlingInstructionNote can be a note regarding a
transportation handling instruction.
TransportationHandlingInstructionNote can be based on GDT:
LONG_Note, Qualifier: TransportationHandlingInstruction.
[1132] TransportationStageAssignment can specify an assignment of a
transportation stage to a transportation unit resource information.
The structure of TransportationStageAssignment includes the element
ShipmentRequestTransportationStageID.
ShipmentRequestTransportationStageID can be a unique identifier of
a TransportationStage in a shipment request.
ShipmentRequestTransportationStageID can be based on GDT:
TransportationStageID.
[1133] AttachedEquipment can specify equipment attached to a
TransportationUnitResource. The structure of AttachedEquipment
includes the ShipmentRequestResourceInformationID.
ShipmentRequestResourceInformationID can be a unique identifier of
a resource information in a ShipmentRequest.
ShipmentRequestResourceInformationID can be based on GDT:
ResourceInformationID.
[1134] Quantity can specify a quantity related to
TransportationUnitResourceInformation. The structure of the
Quantity entity includes the Quantity, RoleCode, and TypeCode
elements. Quantity can be a non-monetary numerical specification of
an amount in a unit of measurement. Quantity can be based on GDT:
Quantity. RoleCode can be a coded representation of a role of a
quantity. RoleCode can be based on GDT: QuantityRoleCode. TypeCode
can be a coded representation of a type of quantity that is based
on a measurable characteristic of an object or physical phenomenon.
TypeCode can be based on GDT: QuantityTypeCode. In some
implementations, QuantityRoleCode and QuantityTypeCode are
optional, but in every instance one of them may be filled.
[1135] BusinessTransactionDocumentReference can specify a business
document reference related to a TransportationUnitResource.
BusinessTransactionDocumentReference includes the DateTimePeriod
entity. The structure of the BusinessTransactionDocumentReference
entity includes the following elements:
BusinessTransactionDocumentReference,
BusinessTransactionDocumentRelationshipRoleCode,
BusinessTransactionDocumentRelationshipTypeCode,
TransportationDocumentTypeCode, TransportationDocumentNote, and
TransportationDocumentID. BusinessTransactionDocumentReference can
be a unique reference to other business documents or business
document items that are of significance within each respective
business process. BusinessTransactionDocumentReference can be based
on GDT: BusinessTransactionDocumentReference.
[1136] BusinessTransactionDocumentRelationshipRoleCode can be a
coded representation of a role that a business document or a
business document item has when set against another business
document or business document item with a relationship.
BusinessTransactionDocumentRelationshipRoleCode can be based on
GDT: BusinessTransactionDocumentRelationshipRoleCode.
BusinessTransactionDocumentRelationshipTypeCode can be a coded
representation of a relationship between two business documents or
business document items.
BusinessTransactionDocumentRelationshipTypeCode can be based on
GDT: BusinessTransactionDocumentRelationshipTypeCode.
TransportationDocumentTypeCode can be a coded representation of a
documentation type.
[1137] TransportationDocumentTypeCode can be based on GDT:
TransportationDocumentTypeCode. TransportationDocumentNote can be a
short note on documentation. TransportationDocumentNote can be
based on GDT: SHORT_Note. TransportationDocumentID can be a unique
identifier for a transportation document. TransportationDocumentID
can be based on GDT: TransportationDocumentID. In some
implementations, RelationshipTypeCode and RelationshipRoleCode are
both optional. If used, both may be filled. Either the combination
BusinessTransactionDocumentReference,
BusinessTransactionDocumentRelationshipRoleCode,
BusinessTransactionDocumentRelationshipTypeCode, or
TransportationDocumentTypeCode, TransportationDocumentNote,
TransportationDocumentID may be filled.
[1138] DateTimePeriod can specify a date, time and/or period
related to a BusinessTransactionDocumentReference. The structure of
the DateTimePeriod entity includes the DateTimePeriod and
PeriodRoleCode. DateTimePeriod can be a period that is defined by
two points in time. DateTimePeriod can be based on GDT:
DateTimePeriod. PeriodRoleCode can be a coded representation of
business semantics of a period. PeriodRoleCode can be based on GDT:
PeriodRoleCode.
[1139] TextCollection can be a group of textual information that
relates to a TransportationUnitResource. The structure of the
TextCollection entity includes the TextCollection element.
TextCollection can be based on GDT: TextCollection.
[1140] Location can specify a physical place related to a
TransportationUnitResource. The structure of the Location entity
includes the following elements: Location, RoleCode, TypeCode, and
Name. Location includes information exchanged in business documents
about a location relevant for business transactions. Location can
be based on GDT: BusinessTransactionDocumentLocation. RoleCode can
be a coded representation of a LocationRole. RoleCode can be based
on GDT: LocationRoleCode. TypeCode can be a coded representation of
a type of a physical location. TypeCode can be based on GDT:
LocationTypeCode. Name can be a name of a location. Name can be
based on GDT: MEDIUM_Name, Qualifier: Location.
[1141] DateTimePeriods can specify a requested and an acceptable
date, time and period related to a Location of a resource. The
elements located directly at the DateTimePeriods entity include
RequestedFulfillmentPeriod, AcceptableFullfilmentPeriod, and
PeriodRoleCode. RequestedFulfillmentPeriod can be a period which is
requested depending on semantics of the PeriodRoleCode.
RequestedFulfillmentPeriod can be based on GDT: DATETIMEPERIOD,
Qualifier: RequestedFulfillment. AcceptableFulfillmentPeriod can be
a period which is acceptable depending on semantics of the
PeriodRoleCode. AcceptableFulfillmentPeriod can be based on GDT:
DATETIMEPERIOD, Qualifier: AcceptableFulfillment. PeriodRoleCode
can be a coded representation of business semantics of the two
periods defined by the entities RequestedFulfillmentPeriod and
AcceptableFulfillmentPeriod. PeriodRoleCode can be based on GDT:
PeriodRoleCode. In some implementations, RequestedFulfillmentPeriod
and AcceptableFulfillmentPeriod are optional, but in every instance
one of them may be filled.
[1142] DangerousGoods can specify dangerous goods included in a
resource. DangerousGoods includes the ContactInformation and
TextCollection entities. The structure of DangerousGoods includes
the following elements: ID, RegulationsCode, HazardCode,
FlashpointMeasureInterval, PackagingGroupCode, EmergencySchedule,
TransportEmergencyCardCode, DangerousGoodsLabelCode,
DangerousGoodsLabelCode2, DangerousGoodsLabelCode3,
PackagingInstructionTypeCode, TransportMeansDescriptionCode, and
TransportAuthorisationCode. ID can be a unique identifier for a
dangerous good, using the United Nations Dangerous Goods Number. ID
can be based on GDT: DangerousGoodsID. RegulationsCode can be a
coded representation of national or international dangerous goods
rules or regulations. RegulationsCode can be based on GDT:
DangerousGoodsRegulationsCode.
[1143] HazardCode can be a coded representation of a hazard that is
imminent in a dangerous good. HazardCode can be based on GDT:
DangerousGoodsHazardCode. FlashpointMeasureInterval can be an
interval of measures defined by a lower and an upper boundary
indicating a flashpoint of a dangerous good.
FlashpointMeasureInterval can be based on GDT: MeasureInterval,
Qualifier: Flashpoint. PackagingGroupCode can be a coded
representation of the effectiveness of a packaging to transport
dangerous goods depending on the degree of danger of the goods.
PackagingGroupCode can be based on GDT:
DangerousGoodsPackagingGroupCode. EmergencySchedule can be a coded
representation of an emergency schedule for dangerous goods.
EmergencySchedule can identify an emergency schedule. The
DangerousGoodsEmergencySchedule can be used for transports of
dangerous goods by sea similar to a Transport Emergency Card which
is used for transports of dangerous goods by road.
EmergencySchedule can be based on GDT:
DangerousGoodsEmergencySchedule. TransportEmergencyCardCode can be
a coded representation of a transport emergency card which
specifies how to react in case of an accident.
[1144] TransportEmergencyCardCode can be based on GDT:
TransportEmergencyCardCode. DangerousGoodsLabelCode can be a coded
representation of a label for a dangerous good. In some
implementations, DangerousGoodsLabelCode's values are dependant on
the DangerousGoodsRegulationsCode. DangerousGoodsLabelCode can be
based on GDT: DangerousGoodsLabelCode. DangerousGoodsLabelCode2 can
be a coded representation of a label for a dangerous good. In some
implementations, DangerousGoodsLabelCode's values are dependant on
the DangerousGoodsRegulationsCode. DangerousGoodsLabelCode2 can be
based on GDT: DangerousGoodsLabelCode. DangerousGoodsLabelCode3 can
be a coded representation of a label for a dangerous good. In some
implementations, DangerousGoodsLabelCode's values are dependant on
the DangerousGoodsRegulationsCode. DangerousGoodsLabelCode3 can be
based on GDT: DangerousGoodsLabelCode.
[1145] PackagingInstructionTypeCode can be a coded representation
of a packaging instruction. In some implementations, a packaging
instruction can be an instruction defining which packaging may be
used to pack a dangerous good. PackagingInstructionTypeCode can be
based on GDT: PackagingInstructionTypeCode.
TransportMeansDescriptionCode can be a coded representation of a
transport means type with which goods or persons can be
transported. TransportMeansDescriptionCode can be based on GDT:
TransportMeansDescriptionCode. TransportAuthorisationCode can be a
coded representation of an authorisation for the transportation of
dangerous goods. This code can specify an authorisation for the
transportation of a particular dangerous good.
TransportAuthorisationCode can be based on GDT:
DangerousGoodsTransportAuthorisationCode.
[1146] ContactInformation can specify information on a department
or person to whom information regarding the dangerous goods can be
directed. The structure of ContactInformation includes the
ContactPersonFunctionTypeCode and Address elements.
ContactPersonFunctionTypeCode can be a coded representation of a
type of function that a contact person has.
ContactPersonFunctionTypeCode can be based on GDT:
ContactPersonFunctionTypeCode. Address can be an address related to
the contact information defined by a corresponding
FunctionTypeCode. Address can be based on GDT: Address.
[1147] TextCollection can be a group of textual information that
relates to DangerousGoods. The structure of the TextCollection
entity includes the TextCollection element. TextCollection can be
based on GDT: TextCollection.
[1148] The TransportationChargesInformation package includes
information regarding transportation charge calculation specific
components related to a ShipmentRequest. The
TransportationChargesInformation package includes the
TransportationChargesInformation entity. The
TransportationChargesInformation entity can define a relationship
between the transportation charges and the origin of these charges.
The TransportationChargesInformation entity includes the
TransportationCharges entity. The structure of
TransportationChargesInformation includes the following elements:
TransportationChargesUsageCode, ShipmentRequestItemID,
ShipmentRequestPartyStandardID, ShipmentRequestPartyInternalID,
ShipmentRequestResourceInformationID,
ShipmentRequestPackageInformationID, and
ShipmentRequestTransportationStageID.
TransportationChargesUsageCode can be a coded representation of the
usage of TransportationCharges.
[1149] The usage can point out if the subsequent information
represents a revenue- or cost-view on transportation charges.
TransportationChargesUsageCode can be based on GDT:
TransportationChargesUsageCode. ShipmentRequestItemID can be a
unique identifier of an Item in a ShipmentRequest.
ShipmentRequestItemID can be based on GDT:
BusinessTransactionDocumentItemID ShipmentRequestPartyStandardID
can be a unique identifier of a Party in a ShipmentRequest.
ShipmentRequestPartyStandardID can be based on GDT:
PartyStandardID. ShipmentRequestPartyInternalID can be based on
GDT: PartyInternalID. ShipmentRequestResourceInformationID can be a
unique identification of a TransportationUnitResource in a
ShipmentRequest. ShipmentRequestResourceInformationID can be based
on GDT: ResourceInformationID. ShipmentRequestPackageInformationID
can be a unique identification of a PackageInformation in a
ShipmentRequest. ShipmentRequestPackageInformationID can be based
on GDT: PackageInformationID. ShipmentRequestTransportationStageID
can be a unique identification of a TransportationStage in a
ShipmentRequest. ShipmentRequestTransportationStageID can be based
on GDT: TransportationStageID. In some implementations, if none of
the IDs is maintained, the transportation charges are related to
the whole shipment request.
[1150] TransportationCharges can be a summary of determined
transportation charge specific components for a transportation
business case. TransportationCharges includes the following
entities: Location, TextCollection, Currency, ExchangeRate,
PercentElement, DateTimePeriod,
BusinessTransactionDocumentReference, TaxDetail,
PaymentInstruction, CashDiscountTerms, and Element. The structure
of TransportationCharges includes the following elements: ID,
FreightAgreementID, CalculationOriginCode, TariffID, and
CalculationSheetID. ID can be a unique identifier of
TransportationCharges in a ShipmentRequest. ID can be based on GDT:
TransportationChargesID. FreightAgreementID can be an
identification of a Freight Agreement which includes and points to
a configuration for the Transportation Charges Calculation.
FreightAgreementID can be based on GDT: FreightAgreementID.
[1151] CalculationOriginCode can be a coded representation of an
origin of a transportation charges calculation. The calculation can
be done automatically based on the system configuration. Data for
the calculation, including the results, can be manually entered or
received from another business system via a message. In some
implementations, a clear distinction of the origin of
TransportationChargesCalculation details like the
TransportationChargesCalculationSheet and its
TransportationChargeElements may be included. CalculationOriginCode
can give information whether the calculation was done completely
automatically, or if the results were manually adopted.
CalculationOriginCode can be based on GDT:
TransportationChargesOriginCode.
[1152] TariffID can be an identifier for a transportation charges
tariff. A transportation charges tariff can be a specific
combination of a transportation charges calculation sheet and terms
and conditions. The terms and conditions can define if a certain
transportation charges calculation sheet and its related rates are
applicable for a transportation business case. TariffID can be
based on GDT: TransportationChargesTariffID. CalculationSheetID can
be a unique identifier for a transportation charges calculation
sheet. A TransportationChargesCalculationSheet can represent a
configuration describing how to calculate transportation charges
for a transportation business case.
TransportationChargesCalculationSheet includes instructions
describing which charges are applicable, which data from a
transportation business case may be considered for a calculation,
how underlying transportation charge rates are determined, and
which special calculation methods may be considered.
CalculationSheetID can be based on GDT:
TransportationChargesCalculationSheetID.
[1153] A Location can specify a physical place to which
TransportationCharges and their calculation can refer. Location
includes the DateTimePeriod entity. The structure of the Location
entity includes the following elements: Location, RoleCode,
TypeCode, and Name. Location includes information exchanged in
business documents about a location relevant for business
transactions. Location can be based on GDT:
BusinessTransactionDocumentLocation. RoleCode can be a coded
representation of a LocationRole. RoleCode can be based on GDT:
LocationRoleCode. TypeCode can be a coded representation of a type
of a physical location. TypeCode can be based on GDT:
LocationTypeCode. Name can be a name of a location. Name can be
based on GDT: MEDIUM_Name, Qualifier: Location.
[1154] DateTimePeriods can specify a date, time and/or period
related to a TransportationChargesLocation. The elements located
directly at the DateTimePeriods entity include
RequestedFulfillmentPeriod, AcceptableFullfilmentPeriod, and
PeriodRoleCode. RequestedFulfillmentPeriod can be a period which is
requested depending on semantics of the PeriodRoleCode.
RequestedFulfillmentPeriod can be based on GDT: DATETIMEPERIOD,
Qualifier: RequestedFulfillment. AcceptableFulfillmentPeriod can be
a period which is acceptable depending on semantics of the
PeriodRoleCode. AcceptableFulfillmentPeriod can be based on GDT:
DATETIMEPERIOD, Qualifier: AcceptableFulfillment. PeriodRoleCode
can be a coded representation of business semantics of the two
periods defined by the entities RequestedFulfillmentPeriod and
AcceptableFulfillmentPeriod. PeriodRoleCode can be based on GDT:
PeriodRoleCode. In some implementations, RequestedFulfillmentPeriod
and AcceptableFulfillmentPeriod are optional, but in every instance
one of them may be filled.
[1155] TextCollection can be a group of textual information that
relates to TransportationCharges. The structure of the
TextCollection entity includes the TextCollection element.
TextCollection can be based on GDT: TextCollection.
[1156] Currency can be a currency which is valid for transportation
charges. The structure of Currency includes the following elements:
Code, RoleCode, and UsageCode. Code can be a coded representation
of a currency. Code can be based on GDT: CurrencyCode. RoleCode can
be a coded representation of a role of a Currency. RoleCode can be
based on GDT: CurrencyRoleCode. UsageCode can be a coded
representation of how a currency is used. UsageCode can be based on
GDT: CurrencyUsageCode. In some implementations, a currency can be
valid for transportation charges, as long as there is no currency
information on a charge element level.
[1157] ExchangeRate can be an exchange rate that has been
especially negotiated for transportation charges. The structure of
the ExchangeRate entity includes the ExchangeRate and TypeCode
elements. ExchangeRate can be a rate at which one unit of a
currency can be changed into another currency. ExchangeRate can be
based on GDT: ExchangeRate. TypeCode can be a coded representation
of a type of an exchange rate. The actual exchange rate between two
currencies can depend on an exchange rate type and currency
conversion type. The exchange rate type can define characteristics
of an exchange rate according to the currencies that get converted.
TypeCode can be based on GDT: ExchangeRateTypeCode.
[1158] PercentElement is a detail about Transportation Charges
represented as a percentage. The structure of PercentElement
includes the following elements: PercentRoleCode, Percent,
TransportationChargesPercentCalculationBaseCode, and Status.
PercentRoleCode can be a coded representation of a role of a
percent. PercentRoleCode can be based on GDT: PercentRoleCode.
Percent can be a number that relates to the comparison FIG. 100.
Percent can be based on CDT: Percent.
TransportationChargesPercentCalculationBaseCode can be a coded
representation of a calculation base for a transportation charges
percent. TransportationChargesPercentCalculationBaseCode can be
based on GDT: TransportationChargesPercentCalculationBaseCode.
StatusCode can be a coded representation of a status for a
transportation charges percent element. StatusCode can be based on
GDT: TransportationChargesPercentElementStatusCode.
[1159] DateTimePeriod can specify a date, time and/or period that
is relevant for a transportation charges calculation. The structure
of the DateTimePeriod entity includes the DateTimePeriod and
PeriodRoleCode. DateTimePeriod can be a period that is defined by
two points in time. DateTimePeriod can be based on GDT:
DateTimePeriod. PeriodRoleCode can be a coded representation of
business semantics of a period. PeriodRoleCode can be based on GDT:
PeriodRoleCode.
[1160] A BusinessTransactionDocumentReference can specify a
business document reference related to a transportation charges
calculation. The structure of the
BusinessTransactionDocumentReference entity includes the following
elements: BusinessTransactionDocumentReference,
BusinessTransactionDocumentRelationshipRoleCode,
BusinessTransactionDocumentRelationshipTypeCode,
TransportationDocumentTypeCode, TransportationDocumentNote, and
TransportationDocumentID. BusinessTransactionDocumentReference can
be a unique reference to other business documents or business
document items that are of significance within each respective
business process. BusinessTransactionDocumentReference can be based
on GDT: BusinessTransactionDocumentReference.
[1161] BusinessTransactionDocumentRelationshipRoleCode can be a
coded representation of a role that a business document or a
business document item has when set against another business
document or business document item with a relationship.
BusinessTransactionDocumentRelationshipRoleCode can be based on
GDT: BusinessTransactionDocumentRelationshipRoleCode.
BusinessTransactionDocumentRelationshipTypeCode can be a coded
representation of a relationship between two business documents or
business document items.
BusinessTransactionDocumentRelationshipTypeCode can be based on
GDT: BusinessTransactionDocumentRelationshipTypeCode.
TransportationDocumentTypeCode can be a coded representation of a
documentation type.
[1162] TransportationDocumentTypeCode can be based on GDT:
TransportationDocumentTypeCode. TransportationDocumentNote can be a
short note on documentation. TransportationDocumentNote can be
based on GDT: SHORT_Note. TransportationDocumentID can be a unique
identifier for a transportation document. TransportationDocumentID
can be based on GDT: TransportationDocumentID. In some
implementations, RelationshipTypeCode and RelationshipRoleCode are
both optional. If used, both may be filled. Either the combination
BusinessTransactionDocumentReference,
BusinessTransactionDocumentRelationshipRoleCode,
BusinessTransactionDocumentRelationshipTypeCode, or
TransportationDocumentTypeCode, TransportationDocumentNote,
TransportationDocumentID may be filled.
[1163] A TaxDetail can be a tax-relevant information which is
applicable for each ChargeElement. The structure of TaxDetail
includes the ProductTax element. ProductTax can be a tax incurred
for product-related business transactions, such as purchasing,
sales, or consumption. ProductTax can be used to display different
tax components in calculated and invoiced amounts, and to inform
about tax declarations and payments of a company to responsible tax
authorities. ProductTax can be based on GDT: ProductTax. In some
implementations, within TaxDetail, the
BusinessTransactionDocumentItemGroupID of the GDT ProductTax is not
used.
[1164] PaymentInstruction can be an instruction about how a payment
may be carried out or which additional activities may be carried
out within a payment. In some implementations, there is a separate
instance for each Charge Category Code, such as Basic Freight, or
Origin haulage charges. The structure of the PaymentInstruction
entity includes the following elements: PaymentInstruction,
TransportationChargesElementCategoryCode,
TransportationChargesElementSubCategoryCode, and
TransportationChargesPaymentArrangementCode.
[1165] PaymentInstruction can be an instruction about how a payment
may be carried out, or which additional activities may be carried
out within a payment. PaymentInstruction can be based on GDT:
PaymentInstruction. TransportationChargesElementCategoryCode can be
a coded representation of a category of a
TransportationChargeElement. The
TransportationChargeElementCategoryCode can be used to group
TransportationChargeElements. PaymentInstructions can be different
per TransportationChargeElementCategory.
TransportationChargesElementCategoryCode can be based on GDT:
TransportationChargesElementCategoryCode.
TransportationChargesElementSubCategoryCode can be a coded
representation of a subcategory of a transportation charges
element. TransportationChargesElementSubCategoryCode can be based
on GDT: TransportationChargesElementSubCategoryCode.
TransportationChargesPaymentArrangementCode can be a coded
representation of an arrangement of a payment for transportation
charges. TransportationChargesPaymentArrangementCode can be based
on GDT: TransportationChargesPaymentArrangementCode.
[1166] CashDiscountTerms can be an agreement on a percentage of
cash discount that is granted during a transportation transaction
when payment takes place within a certain number of days after a
baseline date for payment has passed. The structure of the
CashDiscountTerms entity includes the following elements:
CashDiscountTerms, TransportationChargesElementCategoryCode, and
TransportationChargesElementSubCategoryCode. CashDiscountTerms can
be an agreement of cash discounts for a payment. CashDiscountTerms
can be based on GDT: CashDiscountTerms.
TransportationChargesElementCategoryCode can be a coded
representation of a category of a TransportationChargesElement. The
TransportationChargesElementCategoryCode can be used to group
TransportationChargesElements. PaymentInstructions can be different
per TransportationChargesElementCategory.
TransportationChargesElementCategoryCode can be based on GDT:
TransportationChargesElementCategoryCode.
TransportationChargesElementSubCategoryCode can be a coded
representation of a subcategory of a transportation charges
element. TransportationChargesElementSubCategoryCode can be based
on GDT: TransportationChargesElementSubCategoryCode.
[1167] Element can be, together with its sub nodes, a single
building block of a transportation charge calculation. A Charge
Element can result from a manually created charge, an automatically
determined charge, or another Charge Element distributed from an
entire document. Charge Element includes the following entities:
Location, TextCollection, Currency, RateElement, PercentElement,
AmountElement, CalculationBase, TaxDetail, DateTimePeriod, and
CostDistribution. The structure of Element includes CategoryCode,
SubCategoryCode, TypeCode, CalculationResolutionCode, and
TransportationChargesPaymentArrangementCode. CategoryCode can be a
coded representation of a category of a
TransportationChargesElement. The
TransportationChargesElementCategoryCode can be used to group
TransportationChargesElements.
[1168] PaymentInstructions can be different per
TransportationChargesElementCategory. CategoryCode can be based on
GDT: TransportationChargesElementCategoryCode. SubCategoryCode can
be a coded representation of a subcategory of a transportation
charges element. SubCategoryCode can be based on GDT:
TransportationChargesElementSubCategoryCode. TypeCode can be a
coded representation of a type of a transportation charge element.
TypeCode can be based on GDT: TransportationChargesElementTypeCode.
CalculationResolutionCode can be a coded representation of a
resolution for a transportation charges element calculation.
CalculationResolutionCode can be based on GDT:
TransportationChargesElementCalculationResolutionCode.
TransportationChargesPaymentArrangementCode can be a coded
representation of an arrangement of payment for transportation
charges. TransportationChargesPaymentArrangementCode can be based
on GDT: TransportationChargesPaymentArrangementCode.
[1169] Location can specify a physical place a specific
ChargeElement refers to. Location includes the DateTimePeriod
entity. The structure of the Location entity includes the following
elements: Location, RoleCode, TypeCode, and Name. Location includes
information exchanged in business documents about a location
relevant for business transactions. Location can be based on GDT:
BusinessTransactionDocumentLocation. RoleCode can be a coded
representation of a LocationRole. RoleCode can be based on GDT:
LocationRoleCode. TypeCode can be a coded representation of a type
of a physical location. TypeCode can be based on GDT:
LocationTypeCode. Name can be a name of a location. Name can be
based on GDT: MEDIUM_Name, Qualifier: Location. DateTimePeriods can
specify a date, time and/or period related to a location.
[1170] The elements located directly at the DateTimePeriods entity
include RequestedFulfillmentPeriod, AcceptableFullfilmentPeriod,
and PeriodRoleCode. RequestedFulfillmentPeriod can be a period
which is requested depending on semantics of the PeriodRoleCode.
RequestedFulfillmentPeriod can be based on GDT: DATETIMEPERIOD,
Qualifier: RequestedFulfillment. AcceptableFulfillmentPeriod can be
a period which is acceptable depending on semantics of the
PeriodRoleCode. AcceptableFulfillmentPeriod can be based on GDT:
DATETIMEPERIOD, Qualifier: AcceptableFulfillment. PeriodRoleCode
can be a coded representation of business semantics of the two
periods defined by the entities RequestedFulfillmentPeriod and
AcceptableFulfillmentPeriod. PeriodRoleCode can be based on GDT:
PeriodRoleCode. In some implementations, RequestedFulfillmentPeriod
and AcceptableFulfillmentPeriod are optional, but in every instance
one of them may be filled.
[1171] TextCollection can be a group of textual information that
relates to a ChargeElement. The structure of the TextCollection
entity includes the TextCollection element. TextCollection can be
based on GDT: TextCollection.
[1172] Currency can emphasize if a ChargeElement may be considered
with relation to a certain currency. The structure of Currency
includes the following elements: Code, RoleCode, and UsageCode.
Code can be a coded representation of a currency. Code can be based
on GDT: CurrencyCode. RoleCode can be a coded representation of a
role of a Currency. RoleCode can be based on GDT: CurrencyRoleCode.
UsageCode can be a coded representation of how a currency is used.
UsageCode can be based on GDT: CurrencyUsageCode. In some
implementations, this currency can be valid for transportation
charges, as long as there is no currency information on a charge
element level.
[1173] RateDetail can specify a rate with which a ChargeElement is
calculated. The structure of RateDetail includes the following
elements: ID, Amount, BaseQuantity,
TransportationChargesRateTypeCode,
TransportationChargesRateRoleCode, and
TransportationChargesRateElementStatusCode. ID can be a unique
identifier of a rate element of a transportation charges element.
ID can be based on GDT: TransportationChargesElementRateElementID.
Amount can be an amount with a corresponding currency unit, or a
monetary amount of a rate. Amount can be based on CDT: Amount.
BaseQuantity can be a non-monetary numerical specification of an
amount in a unit of measurement. BaseQuantity can be a quantity to
which an amount refers. BaseQuantity can be based on CDT: Quantity,
Qualifier: Base.
[1174] TransportationChargesRateTypeCode can be a coded
representation of a TransportationChargeRate type. Examples include
gross weight rate and net weight rate.
TransportationChargesRateTypeCode can be based on GDT:
TransportationChargesRateTypeCode.
TransportationChargesRateRoleCode can be a coded representation of
the role of a TransportationChargeRate. Examples include an invoice
rate or a rate for calculation purposes.
TransportationChargesRateRoleCode can be based on GDT:
TransportationChargesRateRoleCode.
TransportationChargesRateElementStatusCode can be a coded
representation of a status of a transportation charges rate
element. TransportationChargesRateElementStatusCode can be based on
GDT: TransportationChargesRateElementStatusCode.
[1175] PercentElement can be a detail about a transportation
charges element represented as a percentage. The structure of
PercentElement includes the following elements: PercentRoleCode,
Percent, TransportationChargesPercentCalculationBaseCode, and
Status. PercentRoleCode can be a coded representation of a role of
a percent. PercentRoleCode can be based on GDT: PercentRoleCode.
Percent can be a number that relates to the comparison FIG. 100.
Percent can be based on CDT: Percent.
TransportationChargesPercentCalculationBaseCode can be a coded
representation of a calculation base for a transportation charges
percent. TransportationChargesPercentCalculationBaseCode can be
based on GDT: TransportationChargesPercentCalculationBaseCode.
StatusCode can be a coded representation of a status for a
transportation charges percent element. StatusCode can be based on
GDT: TransportationChargesPercentElementStatusCode.
[1176] AmountElement can represent a monetary aspect of a
Transportation Charge. AmountElement can be a result of a
transportation charge calculation. There can be a separate
AmountElement instance for each monetary amount per AmountRoleCode.
AmountElement includes the RateElementAssignment entity. The
structure of AmountElement includes the following elements: Amount,
AmountRoleCode, and TransportationChargesAmountElementStatusCode.
Amount can be an amount with a corresponding currency unit. Amount
can be based on CDT: Amount. AmountRoleCode can be a coded
representation of a role of an amount. AmountRoleCode can be based
on GDT: AmountRoleCode.
TransportationChargesAmountElementStatusCode can be a coded
representation of a status of an amount element of transportation
charges or its transportation charges element.
TransportationChargesAmountElementStatusCode can be based on GDT:
TransportationChargesAmountElementStatusCode.
[1177] RateElementAssignment can be an assignment of an amount to a
RateElement. The structure of RateElementAssignment includes the
element TransportationChargesElementRateElementID.
TransportationChargesElementRateElementID can be a unique
identifier of a rate element of a transportation charges element.
TransportationChargesElementRateElementID can be based on GDT:
TransportationChargesElementRateElementID.
[1178] CalculationBase can be data which, included with RateDetail,
is a basis for calculating an Amount. The structure of
CalculationBase includes the following elements:
TransportationChargesElementCalculationBaseCode, BaseQuantity,
BaseQuantityRoleCode, and BaseQuantityTypeCode.
TransportationChargesElementCalculationBaseCode can be a coded
representation of a calculation base of a transportation charges
element. TransportationChargesElementCalculationBaseCode can be
based on GDT: TransportationChargesElementCalculationBaseCode.
BaseQuantity can be a non-monetary numerical specification of an
amount in a unit of measurement. BaseQuantity can be a value of a
calculation base as a quantity. BaseQuantity can be based on GDT:
Quantity, Qualifier: Base. BaseQuantityRoleCode can be a coded
representation of a role of a quantity. BaseQuantityRoleCode can be
based on GDT: QuantityRoleCode. BaseQuantityTypeCode can be a coded
representation of a type of quantity that is based on a measurable
characteristic of an object or physical phenomenon.
BaseQuantityTypeCode can be based on GDT: QuantityTypeCode.
[1179] TaxDetail can be tax-relevant information which is
applicable for each ChargeElement. The structure of TaxDetail
includes the ProductTax element. ProductTax can be a tax incurred
for product-related business transactions, such as purchasing,
sales, or consumption. The ProductTax can be used to display
different tax components in calculated and invoiced amounts, and to
inform about tax declarations and payments of a company to
responsible tax authorities. ProductTax can be based on GDT:
ProductTax. In some implementations, within TaxDetail, the
BusinessTransactionDocumenthemGroupID of the GDT ProductTax is not
used.
[1180] DateTimePeriod can specify a date, time and/or period
related to a ChargeElement. The structure of the DateTimePeriod
entity includes DateTimePeriod and PeriodRoleCode. DateTimePeriod
can be a period that is defined by two points in time.
DateTimePeriod can be based on GDT: DateTimePeriod. PeriodRoleCode
can be a coded representation of business semantics of a period.
PeriodRoleCode can be based on GDT: PeriodRoleCode.
[1181] CostDistribution can be information describing how a
ChargeElement can be allocated or distributed from a financial
accounting point of view. The structure of CostDistribution
includes the AccountingCodingBlockAssignment element.
[1182] An AccountingCodingBlockAssignment can be an assignment of
an item to a coding block. Items typically assigned to a coding
block can be an amount that is known from context, a quantity, or a
company resource such as office space or working time. A coding
block can be a set of account assignment objects of different
types. An account assignment object can be a business object to
which value changes from business transactions are assigned in
accounting. AccountingCodingBlockAssignment can be based on GDT:
AccountingCodingBlockAssignment.
[1183] In some implementations, the SupplierShipmentQuote package
includes a SupplierFreightQuoteAssignmentInformation package which
can include information for supplier freight quote assignments. The
SupplierFreightQuoteAssignmentInformation package includes the
TransportationStageAssignment and
TransportationUnitResourceInformationAssignment entities.
TransportationStageAssignment can specify an assignment of the
SupplierShipmentQuote to a stage of the SupplierFreightQuote. The
structure of TransportationStageAssignment includes the element
SupplierFreightQuoteTransportationStageID.
SupplierFreightQuoteTransportationStageID can be a unique
identifier of a TransportationStage in a SupplierFreightQuote, and
can be based on GDT: TransportationStageID.
TransportationUnitResourceInformationAssignment can specify an
assignment of the SupplierShipmentQuote to a
TransportationUnitResourceInformation of the SupplierFreightQuote.
The structure of TransportationUnitResourceInformationAssignment
includes the
SupplierFreightQuoteTransportationUnitResourceInformationID
element.
SupplierFreightQuoteTransportationUnitResourceInformationID can be
a unique identifier of a TransportationUnitResourceInformation in a
SupplierFreightQuote, and can be based on GDT:
TransportationUnitResourceID.
[1184] The TransportationUnitResourceInformation package includes
information regarding a transportation unit resource relevant for a
shipment request (e.g., a container. The
TransportationUnitResourceInformation package includes the
TransportationUnitResourceInformation entity.
TransportationUnitResourceInformation includes information on one
or more transportation unit resources, such as a resource type and
related properties (e.g., related measures or handling
instructions). A Transportation Unit Resource can be a unit into
which goods are loaded and/or from which goods are unloaded. In
some implementations, this unit can provide transportation capacity
for goods but might not move by itself.
TransportationUnitResourceInformation includes the following
entities: TransportationStageAssignment, AttachedEquipment,
Quantity, BusinessTransactionDocumentReference, TextCollection,
Location, and Dangerous Goods. The structure of
TransportationUnitResourceInformation includes the following
elements: ID, ResourceNumberValue, ResourceID,
ResourceHomeCountryCode, TransportationUnitResourceCategoryCode,
TransportationUnitResourceTypeCode, FillLevelCode,
ShippingTypeCode, HaulageArrangerCode,
TransportationHandlingInstructionCode, and
TransportationHandlingInstructionNote.
[1185] ID can be a unique identifier for a resource information. ID
can be based on GDT to ResourceInformationID. ResourceNumberValue
can be a count of resources. ResourceNumberValue can be based on
GDT: NumberValue, Qualifier: Resource. ResourceID can be a unique
identifier for a resource. ResourceID can be based on GDT:
ResourceID. ResourceHomeCountryCode can be a coded representation
of the home country of a resource. ResourceHomeCountryCode can be
based on GDT: CountryCode, Qualifier: ResourceHome.
TransportationUnitResourceCategoryCode can be a coded
representation of a category of transportation unit resources.
TransportationUnitResourceCategoryCode can be based on GDT:
TransportationUnitResourceCategoryCode.
TransportationUnitResourceTypeCode can be a coded representation of
the type of a transportation unit resource.
TransportationUnitResourceTypeCode can be based on GDT:
TransportationUnitResourceTypeCode.
[1186] FillLevelCode can be a coded representation of a fill level
of a resource. FillLevelCode can be based on GDT: FillLevelCode.
ShippingTypeCode can be a coded representation of a shipping type.
A shipping type can specify how planning and execution of a
transportation may be performed. Transportation terms include
detailed specifications on agreed means of transportation, such as
shipping/transport type and means of transport to be used.
ShippingTypeCode can be based on GDT: ShippingTypeCode.
HaulageArrangerCode can be a coded representation of an arranger of
a haulage. Haulage can be inland transport of cargo.
HaulageArrangerCode can be based on GDT: HaulageArrangerCode.
TransportationHandlingInstructionCode can be a coded representation
of a type of transportation handling instruction.
TransportationHandlingInstructionCode can be based on GDT:
TransportationHandlingInstructionCode.
TransportationHandlingInstructionNote can be a note regarding a
transportation handling instruction.
TransportationHandlingInstructionNote can be based on GDT:
LONG_Note, Qualifier: TransportationHandlingInstruction.
[1187] TransportationStageAssignment can specify an assignment of a
transportation stage to a transportation unit resource information.
The structure of TransportationStageAssignment includes the
ShipmentRequestTransportationStageID element.
ShipmentRequestTransportationStageID can be a unique identifier of
a TransportationStage in a shipment request.
ShipmentRequestTransportationStageID can be based on GDT:
TransportationStageID.
[1188] AttachedEquipment can specify equipment attached to a
TransportationUnitResource. The structure of AttachedEquipment
includes the element ShipmentRequestResourceInformationID.
ShipmentRequestResourceInformationID can be a unique identifier of
a resource information in a ShipmentRequest.
ShipmentRequestResourceInformationID can be based on GDT:
ResourceInformationID.
[1189] Quantity can specify a quantity related to a
TransportationUnitResourceInformation. The structure of the
Quantity entity includes the Quantity, RoleCode, and TypeCode
elements. Quantity can be a non-monetary numerical specification of
an amount in a unit of measurement. Quantity can be based on GDT:
Quantity. RoleCode can be a coded representation of a role of a
quantity. RoleCode can be based on GDT: QuantityRoleCode. TypeCode
can be a coded representation of a type of quantity that is based
on a measurable characteristic of an object or physical phenomenon.
TypeCode can be based on GDT: QuantityTypeCode. In some
implementations, QuantityRoleCode and QuantityTypeCode are
optional, but in every instance one of them may be filled.
[1190] BusinessTransactionDocumentReference can specify a business
document reference related to a TransportationUnitResource.
BusinessTransactionDocumentReference includes the DateTimePeriod
entity. The structure of the BusinessTransactionDocumentReference
entity includes the following elements:
BusinessTransactionDocumentReference,
BusinessTransactionDocumentRelationshipRoleCode,
BusinessTransactionDocumentRelationshipTypeCode,
TransportationDocumentTypeCode, TransportationDocumentNote, and
TransportationDocumentID. BusinessTransactionDocumentReference can
be a unique reference to other business documents or business
document items that are of significance within each respective
business process. BusinessTransactionDocumentReference can be based
on GDT: BusinessTransactionDocumentReference.
[1191] BusinessTransactionDocumentRelationshipRoleCode can be a
coded representation of a role that a business document or a
business document item has when set against another business
document or business document item with a relationship.
BusinessTransactionDocumentRelationshipRoleCode can be based on
GDT: BusinessTransactionDocumentRelationshipRoleCode.
BusinessTransactionDocumentRelationshipTypeCode can be a coded
representation of a relationship between two business documents or
business document items.
BusinessTransactionDocumentRelationshipTypeCode can be based on
GDT: BusinessTransactionDocumentRelationshipTypeCode.
TransportationDocumentTypeCode can be a coded representation of a
documentation type. TransportationDocumentTypeCode can be based on
GDT: TransportationDocumentTypeCode.
[1192] TransportationDocumentNote can be a short note on
documentation. TransportationDocumentNote can be based on GDT:
SHORT_Note. TransportationDocumentID can be a unique identifier for
a transportation document. TransportationDocumentID can be based on
GDT: TransportationDocumentID. In some implementations,
RelationshipTypeCode and RelationshipRoleCode are both optional. If
used, both may be filled. Either the combination
BusinessTransactionDocumentReference,
BusinessTransactionDocumentRelationshipRoleCode,
BusinessTransactionDocumentRelationshipTypeCode, or
TransportationDocumentTypeCode, TransportationDocumentNote,
TransportationDocumentID may be filled.
[1193] DateTimePeriod can specify a date, time and/or period
related to a BusinessTransactionDocumentReference. The structure of
the DateTimePeriod entity includes the DateTimePeriod and
PeriodRoleCode. DateTimePeriod can be a period that is defined by
two points in time. DateTimePeriod can be based on GDT:
DateTimePeriod. PeriodRoleCode can be a coded representation of
business semantics of a period. PeriodRoleCode can be based on GDT:
PeriodRoleCode.
[1194] TextCollection can be a group of textual information that
relates to a TransportationUnitResource. The structure of the
TextCollection entity includes the TextCollection element.
TextCollection can be based on GDT: TextCollection.
[1195] Location can specify a physical place related to a
TransportationUnitResource. The structure of the Location entity
includes the following elements: Location, RoleCode, TypeCode, and
Name. Location includes information exchanged in business documents
about a location relevant for business transactions. Location can
be based on GDT: BusinessTransactionDocumentLocation. RoleCode can
be a coded representation of a LocationRole. RoleCode can be based
on GDT: LocationRoleCode. TypeCode can be a coded representation of
a type of a physical location. TypeCode can be based on GDT:
LocationTypeCode. Name can be a name of a location. Name can be
based on GDT: MEDIUM_Name, Qualifier: Location.
[1196] DateTimePeriods can specify a requested and an acceptable
date, time and period related to a Location of a resource. The
elements located directly at the DateTimePeriods entity include
RequestedFulfillmentPeriod, AcceptableFullfilmentPeriod, and
PeriodRoleCode. RequestedFulfillmentPeriod can be a period which is
requested depending on semantics of the PeriodRoleCode.
RequestedFulfillmentPeriod can be based on GDT: DATETIMEPERIOD,
Qualifier: RequestedFulfillment. AcceptableFulfillmentPeriod can be
a period which is acceptable depending on semantics of the
PeriodRoleCode. AcceptableFulfillmentPeriod can be based on GDT:
DATETIMEPERIOD, Qualifier: AcceptableFulfillment. PeriodRoleCode
can be a coded representation of business semantics of the two
periods defined by the entities RequestedFulfillmentPeriod and
AcceptableFulfillmentPeriod. PeriodRoleCode can be based on GDT:
PeriodRoleCode. In some implementations, RequestedFulfillmentPeriod
and AcceptableFulfillmentPeriod are optional, but in every instance
one of them may be filled.
[1197] DangerousGoods can specify dangerous goods included in a
resource. DangerousGoods includes the ContactInformation and
TextCollection entities. The structure of DangerousGoods includes
the following elements: ID, RegulationsCode, HazardCode,
FlashpointMeasureInterval, PackagingGroupCode, EmergencySchedule,
TransportEmergencyCardCode, DangerousGoodsLabelCode,
DangerousGoodsLabelCode2, DangerousGoodsLabelCode3,
PackagingInstructionTypeCode, TransportMeansDescriptionCode, and
TransportAuthorisationCode. ID can be a unique identifier for a
dangerous good, using the United Nations Dangerous Goods Number. ID
can be based on GDT: DangerousGoodsID. RegulationsCode can be a
coded representation of national or international dangerous goods
rules or regulations. RegulationsCode can be based on GDT:
DangerousGoodsRegulationsCode.
[1198] HazardCode can be a coded representation of a hazard that is
imminent in a dangerous good. HazardCode can be based on GDT:
DangerousGoodsHazardCode. FlashpointMeasureInterval can be an
interval of measures defined by a lower and an upper boundary
indicating a flashpoint of a dangerous good.
FlashpointMeasureInterval can be based on GDT: MeasureInterval,
Qualifier: Flashpoint. PackagingGroupCode can be a coded
representation of the effectiveness of a packaging to transport
dangerous goods depending on the degree of danger of the goods.
PackagingGroupCode can be based on GDT:
DangerousGoodsPackagingGroupCode. EmergencySchedule can be a coded
representation of an emergency schedule for dangerous goods.
EmergencySchedule can identify an emergency schedule. The
DangerousGoodsEmergencySchedule can be used for transports of
dangerous goods by sea similar to a Transport Emergency Card which
is used for transports of dangerous goods by road.
EmergencySchedule can be based on GDT:
DangerousGoodsEmergencySchedule. TransportEmergencyCardCode can be
a coded representation of a transport emergency card which
specifies how to react in case of an accident.
[1199] TransportEmergencyCardCode can be based on GDT:
TransportEmergencyCardCode. DangerousGoodsLabelCode can be a coded
representation of a label for a dangerous good. In some
implementations, DangerousGoodsLabelCode's values are dependant on
the DangerousGoodsRegulationsCode. DangerousGoodsLabelCode can be
based on GDT: DangerousGoodsLabelCode. DangerousGoodsLabelCode2 can
be a coded representation of a label for a dangerous good. In some
implementations, DangerousGoodsLabelCode's values are dependant on
the DangerousGoodsRegulationsCode. DangerousGoodsLabelCode2 can be
based on GDT: DangerousGoodsLabelCode. DangerousGoodsLabelCode3 can
be a coded representation of a label for a dangerous good. In some
implementations, DangerousGoodsLabelCode's values are dependant on
the DangerousGoodsRegulationsCode. DangerousGoodsLabelCode3 can be
based on GDT: DangerousGoodsLabelCode. PackagingInstructionTypeCode
can be a coded representation of a packaging instruction.
[1200] In some implementations, a packaging instruction is an
instruction defining which packagings may be used to pack a
dangerous good. PackagingInstructionTypeCode can be based on GDT:
PackagingInstructionTypeCode. TransportMeansDescriptionCode can be
a coded representation of a transport means type with which goods
or persons are to be transported. TransportMeansDescriptionCode can
be based on GDT: TransportMeansDescriptionCode.
TransportAuthorisationCode can be a coded representation of an
authorisation for the transportation of dangerous goods. This code
can specify an authorisation for the transportation of a particular
dangerous good. TransportAuthorisationCode can be based on GDT:
DangerousGoodsTransportAuthorisationCode.
[1201] ContactInformation can specify information on a department
or person to whom information regarding dangerous goods can be
directed. The structure of ContactInformation includes the
ContactPersonFunctionTypeCode and Address elements.
ContactPersonFunctionTypeCode can be a coded representation of the
type of function that a contact person has.
ContactPersonFunctionTypeCode can be based on GDT:
ContactPersonFunctionTypeCode. Address can be an address related to
contact information defined by the corresponding FunctionTypeCode.
Address can be based on GDT: Address.
[1202] TextCollection can be a group of textual information that
relates to DangerousGoods.
[1203] The structure of the TextCollection entity includes the
TextCollection element. TextCollection can be based on GDT:
TextCollection.
[1204] A number of implementations have been described.
Nevertheless, it will be understood that various modifications may
be made without departing from the spirit and scope of the
disclosure. Accordingly, other implementations are within the scope
of the following claims.
* * * * *