Patent Application
20090327009
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.
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.
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.
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.
In a first aspect, a computer readable medium includes program code for providing a message-based interface for performing a freight request service. The interface exposes 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. The program code receives, from a service consumer, a first message for processing freight requests from an ordering party to a transportation service provider to ship goods from shippers to consignees. The program code invokes a freight request business object. The business object is a logically centralized, semantically disjointed object for representing a request from an ordering party to a transportation service provider to ship goods from shippers to consignees. The business object comprises data logically organized as a freight request root node and at least one subordinate node, including a confirmation 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 freight request business object. The message comprises a freight request request message entity, a message header package, and a freight request package.
In a second aspect, a computer readable medium includes program code for providing a message-based interface for performing a freight request service. The interface exposes 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. 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 data in a freight request business object invoked by the second application. The business object is a logically centralized, semantically disjointed object for representing a request from an ordering party to a transportation service provider to ship goods from shippers to consignees. The business object comprises data logically organized as a freight request root node and at least one subordinate node, including a confirmation subordinate node, each subordinate node having zero or more hierarchically more structured subordinate nodes. The message comprises a freight request request message entity, a message header package, and a freight request package. Program code receives a second message from the second application, the second message associated with the invoked freight request business object and in response to the first message.
In a third aspect, a distributed system operates in a landscape of computer systems provides message-based services. The system processes business objects involving processing freight requests from an ordering party to a transportation service provider to ship goods from shippers to consignees. 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 of a particular business object type. At least one of the business objects is for representing a request from an ordering party to a transportation service provider to ship goods from shippers to consignees. The business object comprises data logically organized as a freight request root node and at least one subordinate node, including a confirmation 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 house shipment business object, the message comprising a waybill notification message entity, a message header package, and a house shipment package. The graphical user interface presents data associated with an invoked instance of the house shipment business object, the interface comprising computer readable instructions embodied on tangible media.
In a fourth aspect, a computer readable medium includes program code for providing a message-based interface for performing a house shipment service. The interface exposes 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. The program code receives, from a service consumer, a first message for processing information for transportation services tendered between transportation service providers. The program code invokes a house shipment business object. The business object is a logically centralized, semantically disjointed object for representing information for transportation services tendered between transportation service providers. The business object comprises data logically organized as a house shipment 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 house shipment business object. The message comprises a waybill notification message entity, a message header package, and a house shipment package.
In a fifth aspect, a computer readable medium includes program code for providing a message-based interface for performing a house shipment service. The interface exposes 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. 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 data in a house shipment business object invoked by the second application. The business object is a logically centralized, semantically disjointed object for representing transportation services tendered between transportation service providers. The business object comprises data logically organized as a house shipment 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 waybill notification message entity, a message header package, and a house shipment package. Program code receives a second message from the second application, the second message associated with the invoked house shipment business object and in response to the first message.
In a sixth aspect, a distributed system operates in a landscape of computer systems provides message-based services. The system processes business objects involving processing information for transportation services tendered between transportation service providers. 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 of a particular business object type. At least one of the business objects is for representing transportation services tendered between transportation service providers. The business object comprises data logically organized as a house shipment 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 house shipment business object, the interface comprising computer readable instructions embodied on tangible media.
In a seventh aspect, a computer readable medium includes program code for providing a message-based interface for performing a shipment request service. The interface exposes 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. The program code receives, from a service consumer, a first message for processing information used for exchange agreements and corresponding confirmations and receipt notifications on the transportation of goods from a single ship-from party to a single ship-to party between an ordering party and a transportation service provider. The program code invokes a shipment request business object. The business object is a logically centralized, semantically disjointed object for representing exchange agreements and corresponding confirmations and receipt notifications on the transportation of goods from a single ship-from party to a single ship-to party between an ordering party and a transportation service provider. The business object comprises data logically organized as a shipment request root node and at least one subordinate node, including a request 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 shipment request business object. The message comprises a shipment request request message entity, a message header package, and a shipment request package.
In an eighth aspect, a computer readable medium includes program code for providing a message-based interface for performing a shipment request service. The interface exposes 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. 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 data in a shipment request business object invoked by the second application. The business object is a logically centralized, semantically disjointed object for representing exchange agreements and corresponding confirmations and receipt notifications on the transportation of goods from a single ship-from party to a single ship-to party between an ordering party and a transportation service provider. The business object comprises data logically organized as a shipment request root node and at least one subordinate node, including a request subordinate node, each subordinate node having zero or more hierarchically more structured subordinate nodes. The message comprises a shipment request request message entity, a message header package, and a shipment request package. Program code receives a second message from the second application, the second message associated with the invoked shipment request business object and in response to the first message.
In a ninth aspect, a distributed system operates in a landscape of computer systems provides message-based services. The system processes business objects involving processing information used for exchange agreements and corresponding confirmations and receipt notifications on the transportation of goods from a single ship-from party to a single ship-to party between an ordering party and a transportation service provider. 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 of a particular business object type. At least one of the business objects is for exchange agreements and corresponding confirmations and receipt notifications on the transportation of goods from a single ship-from party to a single ship-to party between an ordering party and a transportation service provider. The business object comprises data logically organized as a shipment request root node and at least one subordinate node, including a request 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 shipment request business object, the interface comprising computer readable instructions embodied on tangible media.
In a tenth aspect, a computer readable medium includes program code for providing a message-based interface for performing a supplier freight invoice request service. The interface exposes 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. The program code receives, from a service consumer, a first message for processing information for supplier invoice processing, including calculated transportation charges and transportation data. The program code invokes a supplier freight invoice request business object. The business object is a logically centralized, semantically disjointed object for representing supplier invoice processing, including calculated transportation charges and transportation data. The business object comprises data logically organized as a supplier freight invoice request root node and at least one subordinate node, including a request 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 invoice request business object. The message comprises a supplier freight invoice request request message entity, a message header package, and a supplier freight invoice request package.
In an eleventh aspect, a computer readable medium includes program code for providing a message-based interface for performing a supplier freight invoice request service. The interface exposes 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. 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 data in a supplier freight invoice request business object invoked by the second application. The business object is a logically centralized, semantically disjointed object for representing supplier invoice processing, including calculated transportation charges and transportation data. The business object comprises data logically organized as a supplier freight invoice request root node and at least one subordinate node, including a request subordinate node, each subordinate node having zero or more hierarchically more structured subordinate nodes. The message comprises a supplier freight invoice request request message entity, a message header package, and a supplier freight invoice request package. Program code receives a second message from the second application, the second message associated with the invoked supplier freight invoice request business object and in response to the first message.
In a twelfth aspect, a distributed system operates in a landscape of computer systems provides message-based services. The system processes business objects involving processing information for supplier invoice processing, including calculated transportation charges and transportation data. 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 of a particular business object type. At least one of the business objects is for representing supplier invoice processing, including calculated transportation charges and transportation data. The business object comprises data logically organized as a supplier freight invoice request root node and at least one subordinate node, including a request 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 invoice request business object, the interface comprising computer readable instructions embodied on tangible media.
In a thirteenth aspect, a computer readable medium includes program code for providing a message-based interface for performing a transportation booking request service. The interface exposes 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. The program code receives, from a service consumer, a first message for processing information used to exchange agreements and the corresponding confirmations and receipt notifications to provide transportation services from an ordering party to another party. The program code invokes a transportation booking request business object. The business object is a logically centralized, semantically disjointed object for representing information used to exchange agreements and the corresponding confirmations and receipt notifications to provide transportation services from an ordering party to another party. The business object comprises data logically organized as a transportation booking request root node and at least one subordinate node, including a request 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 transportation booking request business object. The message comprises a transportation booking request request message entity, a message header package, and a transportation booking request package.
In a fourteenth aspect, a computer readable medium includes program code for providing a message-based interface for performing a transportation booking request service. The interface exposes 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. 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 data in a transportation booking request business object invoked by the second application. The business object is a logically centralized, semantically disjointed object for representing information used to exchange agreements and the corresponding confirmations and receipt notifications to provide transportation services from an ordering party to another party. The business object comprises data logically organized as a transportation booking request root node and at least one subordinate node, including a request subordinate node, each subordinate node having zero or more hierarchically more structured subordinate nodes. The message comprises a transportation booking request request message entity, a message header package, and a transportation booking request package. Program code receives a second message from the second application, the second message associated with the invoked transportation booking request business object and in response to the first message.
In a fifteenth aspect, a distributed system operates in a landscape of computer systems provides message-based services. The system processes business objects involving processing information used to exchange agreements and the corresponding confirmations and receipt notifications to provide transportation services from an ordering party to another party. 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 of a particular business object type. At least one of the business objects is for representing information used to exchange agreements and the corresponding confirmations and receipt notifications to provide transportation services from an ordering party to another party. The business object comprises data logically organized as a transportation booking request root node and at least one subordinate node, including a request 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 transportation booking request business object, the interface comprising computer readable instructions embodied on tangible media.
In some implementations, processing business objects includes creating, updating and/or retrieving information associated with the business objects.
A. Overview
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. For example, the methods and systems consistent with the subject matter described herein can be used in Supply Chain Management (SCM). 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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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
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.
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.
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
B. Implementation Details
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.
Turning to the illustrated embodiment in
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.
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.
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.
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.
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
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
More specifically, as illustrated in
Returning to
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.
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.
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.
More generally in environment 300 as depicted in
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.
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.
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.
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.
Turning to the illustrated embodiment in
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.
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.
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.
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.
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.
For example, as depicted in example
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.
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.
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.
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.
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.
1. Message Overview
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.
a) Message Categories
As depicted in
(1) Information
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.
(2) Notification
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.
(3) Query
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.
(4) Response
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.
(5) Request
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.
(6) Confirmation
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.
b) Message Choreography
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.
2. Components of the Business Object Model
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.
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).
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.
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.
a) Data Types
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.
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.
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.
b) Entities
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.
c) Packages
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.
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
Packages also may combine different components that result in a new object. For example, as depicted in
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
Packages also may be used to represent hierarchy levels. For example, as depicted in
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
d) Relationships
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
(2) Types of Relationships
(a) Composition
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
(b) Aggregation
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
(c) Association
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
(3) Specialization
Entity types may be divided into subtypes based on characteristics of the entity types. For example,
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.
As depicted in
e) Structural Patterns
(1) Item
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.
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.
(2) Hierarchy
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
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.
3. Creation of the Business Object Model
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,
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.
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.
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.
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.
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.
The system then determines whether the component is one of the object nodes in the business object model (step 2116,
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).
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).
4. Structure of the Business Object Model
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.
5. Interfaces Derived from Business Object Model
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
As illustrated in
To illustrate the hierarchization process,
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.”
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.
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,
The newly created business document object contains all required information, including the incorporated master data information of the referenced objects. As depicted in
The following provides certain rules that can be adopted singly or in combination with regard to the hierarchization process:
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).
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.
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.
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.
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.”
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.
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.
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.
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.
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).
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,
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,
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,
The system then selects a leading object from the package template (step 2240,
The system then selects an entity that is subordinate to the leading object (step 2250,
6. Use of an Interface
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
From the component's perspective, the interface is represented by an interface proxy 2400, as depicted in
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.
As depicted in
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.
As depicted in
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.
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.
7. Use of Interfaces Across Industries
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 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.
For example,
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.
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.
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.
A FreightRequest can be a request from an ordering party to a transportation service provider to ship goods from shippers to consignees. It can be a combination of shipment requests, which can be assigned to stages and resources. The combination can be based on transportation planning or transportation charges calculation. The FreightRequest interfaces can be part of Shipper and Transportation Service Provision scenarios. In some implementations, FreightRequest interfaces are used to exchange FreightRequest requests and corresponding confirmations and receipt notifications between an ordering party and a transportation service provider. An ordering party can request a receipt notification about a FreightRequest request from a transportation service provider to assure that the transportation service provider has received the FreightRequest request and that it did not include any errors. At a later time, the transportation service provider can send a confirmation to the ordering party to confirm the FreightRequest. The confirmation can be an acceptance of the FreightRequest with its transport and carriage conditions, a rejection if the transportation service provider cannot ensure the transport service, a conditional acceptance in case the transportation service provider generally accepts the FreightRequest, but can send more information about the way they intend to fulfill the requested transportation service, i.e., the transportation details later on. The transportation service provider may request a receipt notification about the FreightRequest confirmation from the ordering party.
A FreightRequestRequest Message Type can be a request for a FreightRequest from an ordering party to a transportation provider. It can also be an update to a previous FreightRequestRequest. The structure of the FreightRequestRequest can be specified by the message data type FreightRequestRequestMessage. A FreightRequestCancelRequest can be a cancellation of a FreightRequest. The structure of the FreightRequestCancelRequest can be specified by the message data type FreightRequestCancelRequestMessage. A FreightRequestConfirmation can be a confirmation of a FreightRequest from a transportation service provider to an ordering party. Through a confirmation, a FreightRequest can be accepted, rejected, or conditionally accepted. A confirmation can include information on transport and carriage conditions such as carrier, mode of transport, or stages. A confirmation can also be related to a part of the FreightRequest, in case of a split scenario. The structure of the FreightRequestConfirmation can be specified by the message data type FreightRequestConfirmationMessage.
A FreightRequestReceiptNotification can be a message from a transportation service provider to an ordering party, confirming receipt of a FreightRequestRequest message or of a FreightRequestCancelRequest message, and reporting administrative errors included in a received message. The structure of the FreightRequestReceiptNotification can be specified by the message data type FreightRequestReceiptNotificationMessage. A FreightRequestConfirmationReceiptNotification can be a message from an ordering party to a transportation service provider confirming receipt of a FreightRequestConfirmation message, and reporting administrative errors included in the received message. The structure of the FreightRequestConfirmationReceiptNotification can be specified by the message data type FreightRequestConfirmationReceiptNotificationMessage. The FreightRequest messages can be implemented by the following message interfaces that are equally distributed on the ordering party side and on the transportation service provider side. All the message interfaces of both sides can be implemented in transportation management. On the ordering party side, the message interfaces include: FreightRequestRequest_Out, FreightRequestCancelRequest_Out, FreightRequestConfirmation_In, FreightRequestReceiptNotification_In, and FreightRequestConfirmationReceiptNotification_Out. On the Transportation service provider side, the message interfaces include: FreightRequestRequest_In, FreightRequestCancelRequest_In, FreightRequestConfirmation_Out, FreightRequestReceiptNotification_Out, and FreightRequestConfirmationReceiptNotification_In.
The message choreography of
The “Transportation Service Provider” system 32002 can confirm the freight request using a FreightRequestConfirmation message 32010 as shown, for example, in
Additionally,
Additionally,
Additionally,
The message data type FreightRequestRequestMessage includes business information that is relevant for sending a business document in a message, and a FreightRequest included in a business document. It includes the MessageHeader and FreightRequest packages. The message data type FreightRequestRequestMessage can provide a structure for the message type FreightRequestRequest and for interfaces that are based on it.
A MessageHeader package can group together business information that is relevant for sending a business document in a message. It includes the MessageHeader entity. A MessageHeader can group together business information from the perspective of a sending application in order to identify a business document in a message, provide information about the sender, and to provide information about the recipient. The MessageHeader can be divided up into the SenderParty and RecipientParty entities. It can be of type GDT: BusinessDocumentMessageHeader. The MessageHeader can include 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.
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 can include 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. This 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. In some implementations, SenderParty is filled by the sender, particularly if the participating parties are not transferred with the FreightRequest package.
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 can include the following elements: InternalID, StandardID, and ContactPerson. The RecipientParty can be filled by a sending application to name a contact person for problems that may occur with the 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. In some implementations, RecipientParty can be filled by the sender if the FreightRequest package cannot be used to transfer the participating parties.
The FreightRequest package groups the FreightRequest with its packages. It includes the FreightRequest entity and the Request package. FreightRequest can be an agreement between an ordering party and a transportation service provider on the shipment of goods from shippers to consignees. The attributes and elements located directly at the FreightRequest entity can include @actioncode and ID. @actioncode can be a coded representation of an instruction to a message recipient describing how to process a transmitted element, and can be based on GDT: ActionCode. ID can be a unique identifier of a FreightRequest, and can be based on GDT: BusinessTransactionDocumentID. In some implementations, the attribute @actioncode includes the two values “01—Create” and “02—Change. In some implementations, the ID is not changed once a FreightRequest 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.
The Request package can group the Request with its packages. It includes the Request entity. It includes the packages HeaderInformation, GovernmentalRequirementInformation, PartyInformation, TransportationStageInformation, TransportationUnitResourceInformation, TransportationChargesInformation, and ShipmentRequest. The HeaderInformation package groups dates, total values, documents and references related to a freight request. It includes the entities DateTimePeriods, NatureOfCargo, TotalQuantity, TotalAmount, TextCollection, and BusinessTransactionDocumentReference. 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 RequestedFulfillmentPeriod, AcceptableFulfillmentPeriod, and PeriodRoleCode. RequestedFulfillmentPeriod can be a period which is requested depending on a semantic of a PeriodRoleCode, and can be based on GDT: DATETIMEPERIOD, Qualifier: RequestedFulfillment. AcceptableFulfillmentPeriod can be a period which is acceptable depending on a semantic of a PeriodRoleCode, and can be based on GDT: DATETIMEPERIOD, Qualifier: AcceptableFulfillment.
PeriodRoleCode can be a coded representation of a business semantic of the two periods defined by the entities RequestedFulfillmentPeriod and AcceptableFulfillmentPeriod, and can be based on GDT: PeriodRoleCode. In some implementations, RequestedFulfillmentPeriod and AcceptableFulfillmentPeriod are optional, but in every instance one of them can be filled. NatureOfCargo can indicate a nature of cargo related to a shipment request, for example, palletized, containerized, documents. The structure of the NatureOfCargo entity includes the ClassificationCode element. ClassificationCode can be a coded representation of a classification of a nature of cargo, and can be based on GDT: NatureOfCargoClassificationCode. TotalQuantity can specify the total quantity which is related to a whole shipment request, for example, total number of equipment, or total number of items. The structure of the TotalQuantity entity can include the elements Quantity, RoleCode, and TypeCode. 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 can be filled.
TotalAmount can specify a cumulated monetary amount related to a shipment request, for example duty amount, insurance amount, total value. The structure of the TotalAmount entity can include 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. TextCollection can be a group of textual information that relates to a shipment request. The structure of the TextCollection entity can include the element TextCollection. TextCollection can be based on GDT: TextCollection. BusinessTransactionDocumentReference can specify a business document reference that is related to a whole shipment request. It includes the DateTimePeriod entity. The structure of the BusinessTransactionDocumentReference entity can include 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, and 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, and can be based on GDT: BusinessTransactionDocumentRelationshipRoleCode. BusinessTransactionDocumentRelationshipTypeCode can be a coded representation of a relationship between two business documents or business document items, and can be based on GDT: BusinessTransactionDocumentRelationshipTypeCode. TransportationDocumentTypeCode can be a coded representation of a type of a document, and can be based on GDT: TransportationDocumentTypeCode. TransportationDocumentNote can be a short Note regarding 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. In some implementations, RelationshipTypeCode and RelationshipRoleCode are both optional. If used, both may be filled. In some implementations, either the combination BusinessTransactionDocumentReference, BusinessTransactionDocumentRelationshipRoleCode, BusinessTransactionDocumentRelationshipTypeCode or TransportationDocumentTypeCode, TransportationDocumentNote, TransportationDocumentID may be filled.
The GovernmentalProcedure package can specify applicable governmental procedures related to import, export and transport of the goods of the shipment request. It includes the entities: Location, DateTimePeriod, Seal, TextCollection, and TransportationDocumentInformation. TransportationGovernmentAgencyTypeCode can be a coded representation of a type of a government agency, and 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, and can be based on GDT: TransportationGovernmentAgencyInvolvementStatusCode. TransportationGovernmentAgencyActionCode can be a coded representation of an action of a transportation related government agency, and can be based on GDT: TransportationGovernmentAgencyActionCode. TransportationGovernmentAgencyProcedureStatusCode can be a coded representation of the status of a procedure related to a transportation government agency, and can be based on GDT: TransportationGovernmentAgencyProcedureStatusCode.
The PartyInformation package includes information regarding a party of a freight request (e.g., Shipper, Carrier, Agent). The PartyInformation package includes the Party entity. Party includes information that is exchanged, in accordance with common business understanding, in business documents, about a party involved in business transactions. This information can be used to identify a 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 can include the elements Party, RoleCode, and FormattedName. A Party includes information that is exchanged, in accordance with common business understanding, in business documents, about a party involved in business transactions. This information is used to identify a 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, 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. 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 can include 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, and 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, and can be based on GDT: BusinessTransactionDocumentRelationshipRoleCode.
BusinessTransactionDocumentRelationshipTypeCode can be a coded representation of a relationship between two business documents or business document items, and can be based on GDT: BusinessTransactionDocumentRelationshipTypeCode. TransportationDocumentTypeCode can be a coded representation of a type of a document, and can be based on GDT: TransportationDocumentTypeCode. TransportationDocumentNote can be a short Note regarding 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. In some implementations, RelationshipTypeCode and RelationshipRoleCode are both optional. If used, both may be filled. In some implementations, either the combination BusinessTransactionDocumentReference, BusinessTransactionDocumentRelationshipRoleCode, BusinessTransactionDocumentRelationshipTypeCode or TransportationDocumentTypeCode, TransportationDocumentNote, TransportationDocumentID may be filled.
The TransportationStageInformation package includes information regarding a stage of a freight request. A stage can represent a section of a transport. It includes the TransportationStage entity. TransportationStage can specify details related to a stage of a transport which is part of a freight request. It includes the entities ContactInformation, Quantity, Party, Location, Seal, TextCollection, BusinessTransactionDocumentReference, and TransportationServiceRequirement. The structure of the TransportationState entity can include the elements ID, OrdinalNumberValue, 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, 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, and 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. 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, and 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.
ContactInformation can specify information on a department or person to whom information regarding a Stage can be directed. The structure of the ContactInformation entity can include the ContactPersonFunctionTypeCode and Address elements. ContactPersonFunctionTypeCode can be a coded representation of a type of function that a contact person has, and can be based on GDT: ContactPersonFunctionTypeCode. Address can be an address related to contact information defined by the corresponding FunctionTypeCode, and can be based on GDT: Address. Quantity can specify a quantity related to a Stage. The structure of the Quantity entity can include the elements Quantity, RoleCode, and TypeCode. 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.
Party includes information that is exchanged, in accordance with common business understanding, in business documents, about a party involved in the current stage. This information can be used to identify the party and the party's address. It includes the TransportationDocumentInformation and BusinessTransactionDocumentReference entities. The structure of the Party entity can include the elements Party, RoleCode, and FormattedName. A Party includes information that is exchanged, in accordance with common business understanding, in business documents, about a party involved in business transactions. This information is 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, 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. TransportationDocumentInformation can specify information on a transportation document related to a shipment request. It includes the DateTimePeriod entity. The structure of the TransportationDocumentInformation entity can include the elements TransportationDocumentTypeCode, TransportationDocumentNote, TransportationDocumentID, TransportationDocumentStatusCode, LanguageCode, CommunicationMediumTypeCode, RequiredIndicator, OutputCopyNumberValue, and OutputOriginalNumberValue. TransportationDocumentTypeCode can be a coded representation of a type of a document, and can be based on GDT: TransportationDocumentTypeCode. TransportationDocumentNote can be a short Note regarding 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 document, and can be based on GDT: LanguageCode. CommunicationMediumTypeCode can be a coded representation of a 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 documentation is required or not, and can be based on GDT: Indicator Qualifier: Required. OutputCopyNumberValue can be a number specifying the number of copies of the document that may be issued, and can be based on GDT: NumberValue, Qualifier: OutputCopy. OutputOriginalNumberValue can be a number specifying the number of originals of the document that can be issued, and 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 both NumberValues OutputCopyNumberValue or OutputOriginalNumberValue is filled.
BusinessTransactionDocumentReference can specify a business document reference that is related to the whole shipment request. It includes the DateTimePeriod entity. The structure of the BusinessTransactionDocumentReference entity can include 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, and 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, and can be based on GDT: BusinessTransactionDocumentRelationshipRoleCode. BusinessTransactionDocumentRelationshipTypeCode can be a coded representation of a relationship between two business documents or business document items, and can be based on GDT: BusinessTransactionDocumentRelationshipTypeCode.
TransportationDocumentTypeCode can be a coded representation of a type of a document, and can be based on GDT: TransportationDocumentTypeCode. TransportationDocumentNote can be a short Note regarding 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. In some implementations, RelationshipTypeCode and RelationshipRoleCode are both optional. If used, both may be filled. In some implementations, either the combination BusinessTransactionDocumentReference, BusinessTransactionDocumentRelationshipRoleCode, BusinessTransactionDocumentRelationshipTypeCode or TransportationDocumentTypeCode, TransportationDocumentNote, TransportationDocumentID may be filled. The Location can specify a physical place to which the TransportationCharges and their calculation can refer. It includes the DateTimePeriod entity. The structure of the Location entity can include the elements Location, RoleCode, TypeCode, and Name. Location includes information that is 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. Seal can specify seal information related to a Stage. The structure of the Seal entity can include the 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, such as a role of a sealing party. PartyRoleCode can be based on GDT: PartyRoleCode. PartyFormattedName can be a complete, formatted name of a party, such as a role of a sealing party. PartyFormattedName can be based on GDT: LONG_Name, Qualifier: PartyFormatted. StatusCode can be a coded representation of the status of a seal, and can be based on GDT: SealStatusCode. TextCollection can be a group of textual information of any type that relates to a Stage. The structure of the TextCollection entity includes the element TextCollection. TextCollection can be based on GDT: TextCollection.
BusinessTransactionDocumentReference can specify a business document reference that is related to a whole shipment request. It includes the DateTimePeriod entity. The structure of the BusinessTransactionDocumentReference entity can include 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, and 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, and can be based on GDT: BusinessTransactionDocumentRelationshipRoleCode. BusinessTransactionDocumentRelationshipTypeCode can be a coded representation of a relationship between two business documents or business document items, and can be based on GDT: BusinessTransactionDocumentRelationshipTypeCode.
TransportationDocumentTypeCode can be a coded representation of a type of a document, and can be based on GDT: TransportationDocumentTypeCode. TransportationDocumentNote can be a short Note regarding 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. In some implementations, RelationshipTypeCode and RelationshipRoleCode are both optional. If used, both may be filled. In some implementations, either the combination BusinessTransactionDocumentReference, BusinessTransactionDocumentRelationshipRoleCode, BusinessTransactionDocumentRelationshipTypeCode or TransportationDocumentTypeCode, TransportationDocumentNote, TransportationDocumentID may be filled. 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 the TransportationServiceRequirement entity can include the 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. TransportServiceLevelCode can be a coded representation of agreed or defined services in terms of delivery of goods with respect to the speed of the delivery, and can be based on GDT: TransportServiceLevelCode. NatureOfCargoClassificationCode can be a coded representation of a classification of the nature of cargo, and can be based on GDT: NatureOfCargoClassificationCode.
The TransportationUnitResourceInformation package includes information regarding a transportation unit resource that is relevant for a freight request (e.g., a container). It includes the TransportationUnitResourceInformation entity. TransportationUnitResourceInformation includes information on one or more transportation unit resources, such as resource type and related properties. For example, TransportationUnitResourceInformation can be 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. Transportation Unit Resource includes the entities TransportationStageAssignment, AttachedEquipment, Quantity, Seal, BusinessTransactionDocumentReference, TextCollection, Party, Location, and DangerousGoods. The structure of the TransportationUnitResourceInformation entity can include the 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. 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. The shipping type can specify how planning and execution of a transportation can be performed. Transportation terms can 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. TransportationStageAssignment can specify an assignment of a resource to a stage.
The structure of the TransportationStageAssignment entity includes the FreightRequestTransportationStageID element. FreightRequestTransportationStageID can be a unique identifier of a TransportationStage in a freight request, and can be based on GDT: TransportationStageID. AttachedEquipment can specify an equipment that is attached to a TransportationUnitResource. The structure of the AttachedEquipment entity can include the ShipmentRequestResourceInformationID element. ShipmentRequestResourceInformationID can be a unique identifier of a resource information in a ShipmentRequest, and can be based on GDT: ResourceInformationID. Quantity specifies a quantity related to TransportationUnitResourceInformation. The structure of the Quantity entity can include the elements Quantity, RoleCode, and TypeCode. 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. Seal specifies a seal related to a TransportationUnitResource. The structure of the Seal entity can include the 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, such as the role of the sealing party. PartyRoleCode can be based on GDT: PartyRoleCode. PartyFormattedName can be a complete, formatted name of a party, such as the role of a sealing party. 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.
BusinessTransactionDocumentReference specifies a business document reference that is related to a TransportationUnitResource. BusinessTransactionDocumentReference includes the DateTimePeriod entity. The structure of the BusinessTransactionDocumentReference entity can include 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, and 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, and can be based on GDT: BusinessTransactionDocumentRelationshipRoleCode.
BusinessTransactionDocumentRelationshipTypeCode can be a coded representation of a relationship between two business documents or business document items, and can be based on GDT: BusinessTransactionDocumentRelationshipTypeCode. TransportationDocumentTypeCode can be a coded representation of a type of a document, and can be based on GDT: TransportationDocumentTypeCode. TransportationDocumentNote can be a short Note regarding 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. In some implementations, RelationshipTypeCode and RelationshipRoleCode are both optional. If used, both may be filled. In some implementations, either the combination BusinessTransactionDocumentReference, BusinessTransactionDocumentRelationshipRoleCode, BusinessTransactionDocumentRelationshipTypeCode or TransportationDocumentTypeCode, TransportationDocumentNote, TransportationDocumentID may be filled. TextCollection is a group of textual information that relates to the TransportationUnitResource. The structure of the TextCollection entity includes the element TextCollection. TextCollection can be based on GDT: TextCollection.
Party includes information that is exchanged, in accordance with common business understanding, in business documents, about a party involved in the current TransportationUnitResource. This information is used to identify the party and the party's address. The structure of the Party entity can include the elements Party, RoleCode, and FormattedName. A Party includes information that is exchanged, in accordance with common business understanding, in business documents, about a party involved in business transactions. This information is 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, 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. Location specifies a physical place related to a TransportationUnitResource. The structure of the Location entity can include the elements Location, RoleCode, TypeCode, and Name. Location includes information that is 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. DangerousGoods can specify dangerous goods included in a resource. DangerousGoods includes the ContactInformation and TextCollection entities. The structure of the DangerousGoods entity can include the 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, and 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. 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 the 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 the degree of danger of the goods, and can be based on GDT: DangerousGoodsPackagingGroupCode. EmergencySchedule can be a coded representation of an emergency schedule for dangerous goods. It can identify 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.
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 dependent 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 dependent 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 dependent on the DangerousGoodsRegulationsCode. DangerousGoodsLabelCode3 can be based on GDT: DangerousGoodsLabelCode. PackagingInstructionTypeCode can be a coded representation of a packaging instruction. A packaging instruction can be an instruction defining which packagings are 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, 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 a transportation of a particular dangerous good. TransportAuthorisationCode can be based on GDT: DangerousGoodsTransportAuthorisationCode.
The TransportationChargesInformation package includes information regarding a transportation charge calculation specific to components related to a FreightRequest. 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 TransportationCharges entity. The structure of the TransportationChargesInformation entity can include the elements TransportationChargesUsageCode, FreightRequestPartyStandardID, FreightRequestTransportationUnitResourceID, and FreightRequestTransportationStageID. TransportationChargesUsageCode can be a coded representation of usage of TransportationCharges. A usage can point out if subsequent information represents a revenue view or cost view on transportation charges. TransportationChargesUsageCode can be based on GDT: TransportationChargesUsageCode.
FreightRequestPartyStandardID can be a unique identifier of a Party in a FreightRequest, and can be based on GDT: PartyStandardID. FreightRequestTransportationUnitResourceID can be a unique identification of a TransportationUnitResource in a FreightRequest, and can be based on GDT: ResourceID. FreightRequestTransportationStageID can be a unique identification of a TransportationStage in a FreightRequest, 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 request. TransportationCharges can be a summary of determined transportation charge specific components for a transportation business case. TransportationCharges includes the entities Location, TextCollection, Currency, ExchangeRate, PercentElement, DateTimePeriod, BusinessTransactionDocumentReference, TaxDetail, PaymentInstruction, CashDiscountTerms, and Element. The structure of the TransportationCharges entity can include the 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.
FreightAgreementID can be based on GDT: FreightAgreementID. CalculationOriginCode can be a coded representation of the origin of a transportation charges calculation. A 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, there is a clear distinction of the origin of TransportationChargesCalculation details, such as the TransportationChargesCalculationSheet and its TransportationChargeElements. TransportationChargesCalculationSheet gives information about whether a calculation was done completely automatically, for example, or if the results were manually adopted. CalculationOriginCode can be based on GDT: TransportationChargesOriginCode. 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. 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, such as for which charges are applicable, which data from the transportation business case can be considered for the calculation, how the underlying transportation charge rates can be determined and which special calculation methods can be considered. CalculationSheetID can be based on GDT: TransportationChargesCalculationSheetID.
A ShipmentRequest package can specify or group together data related to a shipment request which is assigned to a freight request. The ShipmentRequest package includes the ShipmentRequest entity and the Request package. ShipmentRequest 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. ShipmentRequest includes the TransportationStageAssignment and TransportationUnitResourceInformationAssignment entities. The structure of the ShipmentRequest can include the ID element. ID can be a unique identifier of a ShipmentRequest, and can be based on GDT: BusinessTransactionDocumentID. TransportationStageAssignment can specify an assignment of a shipment request to a transportation stage of a freight request. The structure of the TransportationStageAssignment entity can include the FreightRequestTransportationStageID element. FreightRequestTransportationStageID can be a unique identifier of a TransportationStage in a freight request, and can be based on GDT: TransportationStageID. TransportationUnitResourceInformationAssignment can specify an assignment of a shipment request to a TransportationUnitResourceInformation of a freight request. The structure of the TransportationUnitResourceInformationAssignment entity can include the element FreightRequestTransportationUnitResourceID. FreightRequestTransportationUnitResourceID can be a unique identifier of a TransportationUnitResource in a freight request, and can be based on GDT: ResourceID.
The Request package can group the Request with its packages. It can include the Request entity. The Request package includes the packages HeaderInformation, TransportationChargesInformation, GovemmentalRequirementInformation, 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 request. In the first case, a short form message, ShipmentRequest and its sub entities, identify the ShipmentRequest requests that have been already sent. In the second case, an extended form message, the Request package includes all ShipmentRequest request data, and in a standard process the sub entities of entity ShipmentRequest may not be filled.
The message data type FreightRequestCancelRequestMessage can group together business information that is relevant for sending a business document in a message, and a FreightRequest object in a business document. FreightRequestCancelRequestMessage includes the MessageHeader and FreightRequest packages. The message data type FreightRequestCancelRequestMessage can provide a structure for the message type FreightRequestCancelRequest and for interfaces that are based on it.
A MessageHeader package can group together business information that is 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, 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.
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. This 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. In some implementations, SenderParty can be filled by the sender, particularly if the participating parties are not transferred with the FreightRequest package.
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 a sending application to name a contact person for problems that may occur with the message. This is 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 is filled by the sender if the FreightRequest package cannot be used to transfer the participating parties.
The FreightRequest package can group together information about a FreightRequest. The FreightRequest package includes the FreightRequest entity and the BusinessTransactionDocumentReference package. FreightRequest can be an agreement between an ordering party and a transportation service provider on the shipment of goods from shippers to consignees. The attributes and elements located directly at the FreightRequest entity include the ID element. ID can be a unique identifier of a FreightRequest, and can be based on GDT: BusinessTransactionDocumentID.
The Request package can group a Request with its packages. It includes the Request entity and the BusinessTransactionDocumentReference package. 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.
A BusinessTransactionDocumentReference package can group references to business documents. It includes the BusinessTransactionDocumentReference entity. The structure of the BusinessTransactionDocumentReference entity can include 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, and 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, and can be based on GDT: BusinessTransactionDocumentRelationshipRoleCode. BusinessTransactionDocumentRelationshipTypeCode can be a coded representation of a relationship between two business documents or business document items, and can be based on GDT: BusinessTransactionDocumentRelationshipTypeCode. TransportationDocumentTypeCode can be a coded representation of a type of a document, and can be based on GDT: TransportationDocumentTypeCode. TransportationDocumentNote can be a short Note regarding 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. In some implementations, RelationshipTypeCode and RelationshipRoleCode are both optional. If used, both may be filled. In some implementations, either the combination BusinessTransactionDocumentReference, BusinessTransactionDocumentRelationshipRoleCode, BusinessTransactionDocumentRelationshipTypeCode or TransportationDocumentTypeCode, TransportationDocumentNote, TransportationDocumentID may be filled.
Message Data Type FreightRequestConfirmationMessage The message data type FreightRequestConfirmationMessage includes business information that is relevant for sending a business document in a message, and the FreightRequest included in a business document. It includes the MessageHeader and FreightRequest packages. The message data type FreightRequestConfirmationMessage can provide a structure for the message type FreightRequestConfirmation and for interfaces that are based on it.
A MessageHeader package can group together business information that is relevant for sending a business document in a message. It 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, and to provide information about the recipient. The MessageHeader can be divided up into the SenderParty and RecipientParty entities. It 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.
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. This 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. In some implementations, SenderParty can be filled by the sender particularly if the participating parties are not transferred with the FreightRequest package.
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 a sending application to name a contact person for problems that may occur with the 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. In some implementations, RecipientParty can be filled by the sender if the FreightRequest package cannot be used to transfer the participating parties.
The FreightRequest package can group a FreightRequest together with its packages. It includes the FreightRequest entity and the Confirmation package. FreightRequest can be an agreement between an ordering party and a transportation service provider on the shipment of goods from shippers to consignees. The attributes and elements located directly at the FreightRequest entity can include the ID element. ID can be a unique identifier of a FreightRequest, and can be based on GDT: BusinessTransactionDocumentID. In some implementations, the attribute @actioncode fits to the message process. In some implementations, a FreightRequest can have at most one Confirmation. In some implementations, several FreightRequest confirmation messages for the same FreightRequest may be sent successively. In some implementations, from the second confirmation message for a freight request on, the attribute @actioncode contains the value “02—Change”. The first confirmation message may contain the value “01”.
The Confirmation package can group a Confirmation with its packages. The Confirmation package includes the Confirmation entity and the packages HeaderInformation, GovernmentalRequirementInformation, PartyInformation, TransportationStageInformation, TransportationUnitResourceInformation, TransportationChargesInformation, and ShipmentRequest. Confirmation can be a confirmation of an agreement between an ordering party and a transportation service provider on the shipment of goods from shippers to consignees. The confirmation entity includes the AcceptanceStatusCode element. 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: AcceptanceStatusCode.
The HeaderInformation package groups dates, total values, documents and references related to a freight request. It includes the following entities: DateTimePeriods, NatureOfCargo, TotalQuantity, TotalAmount, TextCollection, and BusinessTransactionDocumentReference. 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 are RequestedFulfillmentPeriod, AcceptableFulfillmentPeriod, and PeriodRoleCode. RequestedFulfillmentPeriod can be a period which is requested depending on a semantic of a PeriodRoleCode, and can be based on GDT: DATETIMEPERIOD, Qualifier: RequestedFulfillment. AcceptableFulfillmentPeriod can be a period which is acceptable depending on the semantics of the PeriodRoleCode, and can be based on GDT: DATETIMEPERIOD, Qualifier: AcceptableFulfillment.
PeriodRoleCode can be a coded representation of the business semantics of the two periods defined by the entities RequestedFulfillmentPeriod and AcceptableFulfillmentPeriod, and can be based on GDT: PeriodRoleCode. In some implementations, RequestedFulfillmentPeriod and AcceptableFulfillmentPeriod are optional, but in every instance one of them may be filled. NatureOfCargo can indicate a nature of cargo related to a shipment request, for example, palletized, containerized, documents. The structure of the NatureOfCargo entity includes the ClassificationCode element. ClassificationCode can be a coded representation of a classification of a nature of cargo, and can be based on GDT: NatureOfCargoClassificationCode. TotalQuantity can specify a total quantity which is related to a whole shipment request, for example, total number of equipment, total number of items. The structure of the TotalQuantity entity can include the elements Quantity, RoleCode, and TypeCode. 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 may be filled. TotalAmount can specify a cumulated monetary amount related to a shipment request, for example duty amount, insurance amount, total value. The structure of the TotalAmount entity can include 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. TextCollection can be a group of textual information that relates to a shipment request. The structure of the TextCollection entity includes the element TextCollection. TextCollection can be based on GDT: TextCollection. 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 can include 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, and 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, and can be based on GDT: BusinessTransactionDocumentRelationshipRoleCode. BusinessTransactionDocumentRelationshipTypeCode can be a coded representation of a relationship between two business documents or business document items, and can be based on GDT: BusinessTransactionDocumentRelationshipTypeCode. TransportationDocumentTypeCode can be a coded representation of a type of a document, and can be based on GDT: TransportationDocumentTypeCode. TransportationDocumentNote can be a short Note regarding 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. In some implementations, RelationshipTypeCode and RelationshipRoleCode are both optional. If used, both may be filled. In some implementations, either the combination BusinessTransactionDocumentReference, BusinessTransactionDocumentRelationshipRoleCode, BusinessTransactionDocumentRelationshipTypeCode or TransportationDocumentTypeCode, TransportationDocumentNote, TransportationDocumentID may be filled.
GovernmentalProcedure can specify applicable governmental procedures related to import, export and transport of goods of a shipment request. GovernmentalProcedure includes the entities Location, DateTimePeriod, Seal, TextCollection, and TransportationDocumentInformation. TransportationGovernmentAgencyTypeCode can be a coded representation of a type of a government agency, and 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, Transshipment. TransportationMovementTypeCode can be based on GDT: TransportationMovementTypeCode. TransportationGovernmentAgencyInvolvementStatusCode can be a coded representation for an involvement status of a transportation related government agency, and can be based on GDT: TransportationGovernmentAgencyInvolvementStatusCode. TransportationGovernmentAgencyActionCode can be a coded representation of an action of a transportation related government agency, and can be based on GDT: TransportationGovernmentAgencyActionCode. TransportationGovernmentAgencyProcedureStatusCode can be a coded representation of a status of a procedure related to a transportation government agency, and can be based on GDT: TransportationGovernmentAgencyProcedureStatusCode.
The PartyInformation package includes information regarding a party of a freight request (e.g., Shipper, Carrier, Agent). The PartyInformation package includes the Party entity. Party includes information that is 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 can include the elements Party, RoleCode, and FormattedName. A Party includes information that is exchanged, in accordance with common business understanding, in business documents about a party involved in business transactions. This information is 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 the 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. BusinessTransactionDocumentReference can specify a business document reference that is related to a whole shipment request. It includes the DateTimePeriod entity. The structure of the BusinessTransactionDocumentReference entity can include 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, and 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, and can be based on GDT: BusinessTransactionDocumentRelationshipRoleCode. BusinessTransactionDocumentRelationshipTypeCode can be a coded representation of a relationship between two business documents or business document items, and can be based on GDT: BusinessTransactionDocumentRelationshipTypeCode. TransportationDocumentTypeCode can be a coded representation of a type of a document, and can be based on GDT: TransportationDocumentTypeCode.
TransportationDocumentNote can be a short Note regarding 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. In some implementations, RelationshipTypeCode and RelationshipRoleCode are both optional. If used, both may be filled. In some implementations, either the combination BusinessTransactionDocumentReference, BusinessTransactionDocumentRelationshipRoleCode, BusinessTransactionDocumentRelationshipTypeCode or TransportationDocumentTypeCode, TransportationDocumentNote, TransportationDocumentID may be filled.
The TransportationStageInformation package includes information regarding a stage of a freight request. A stage can represent a section of a transport. It includes the TransportationStage entity. TransportationStage can specify details related to a stage of a transport which is part of a freight request. TransportationStage includes the entities ContactInformation, Quantity, Party, Location, Seal, TextCollection, BusinessTransactionDocumentReference, and TransportationServiceRequirement. The structure of the TransportationState entity can include the elements ID, OrdinalNumberValue, 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, 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 can be transported, and 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. 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, and 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. ContactInformation can specify information on a department or person to whom information regarding a Stage can be directed. The structure of the ContactInformation entity can include the ContactPersonFunctionTypeCode and Address elements. ContactPersonFunctionTypeCode can be a coded representation of a type of function that a contact person has, and can be based on GDT: ContactPersonFunctionTypeCode. Address can be an address related to contact information defined by a corresponding FunctionTypeCode, and can be based on GDT: Address. Quantity can specify a quantity related to a Stage. The structure of the Quantity entity can include the elements Quantity, RoleCode, and TypeCode. 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.
Party includes information that is 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. It includes the TransportationDocumentInformation and BusinessTransactionDocumentReference entities. The structure of the Party entity can include the elements Party, RoleCode, and FormattedName. A Party includes information that is exchanged, in accordance with common business understanding, in business documents about a party involved in business transactions. This information is 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, 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. TransportationDocumentInformation can specify information on a transportation document related to a shipment request. It includes the DateTimePeriod entity. The structure of the TransportationDocumentInformation entity can include the elements TransportationDocumentTypeCode, TransportationDocumentNote, TransportationDocumentID, TransportationDocumentStatusCode, LanguageCode, CommunicationMediumTypeCode, RequiredIndicator, OutputCopyNumberValue, and OutputOriginalNumberValue. TransportationDocumentTypeCode can be a coded representation of a type of a document, and can be based on GDT: TransportationDocumentTypeCode.
TransportationDocumentNote can be a short Note regarding 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 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 document, and can be based on GDT: LanguageCode. CommunicationMediumTypeCode can be a coded representation of a 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 documentation is required or not, and can be based on GDT: Indicator Qualifier: Required.
OutputCopyNumberValue can be a number specifying a number of copies of a document that may be issued, and can be based on GDT: NumberValue, Qualifier: OutputCopy. OutputOriginalNumberValue can be a number specifying a number of originals of a document that may be issued, and 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 both NumberValues OutputCopyNumberValue or OutputOriginalNumberValue may be filled. 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 can include 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, and 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, and can be based on GDT: BusinessTransactionDocumentRelationshipRoleCode. BusinessTransactionDocumentRelationshipTypeCode can be a coded representation of a relationship between two business documents or business document items, and can be based on GDT: BusinessTransactionDocumentRelationshipTypeCode. TransportationDocumentTypeCode can be a coded representation of a type of a document, and can be based on GDT: TransportationDocumentTypeCode. TransportationDocumentNote can be a short Note regarding 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. In some implementations, RelationshipTypeCode and RelationshipRoleCode are both optional. If used, both may be filled. In some implementations, either the combination BusinessTransactionDocumentReference, BusinessTransactionDocumentRelationshipRoleCode, BusinessTransactionDocumentRelationshipTypeCode or TransportationDocumentTypeCode, TransportationDocumentNote, TransportationDocumentID may be filled.
The 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 can include the elements Location, RoleCode, TypeCode, and Name. Location includes information that is 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. Seal can specify seal information related to a Stage. The structure of the Seal entity can include the 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, such as a role of a sealing party. PartyRoleCode can be based on GDT: PartyRoleCode.
PartyFormattedName can be a complete, formatted name of a party, such as the role of a sealing party. 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. TextCollection can be a group of textual information that relates to a Stage. The structure of the TextCollection entity includes the element TextCollection. TextCollection can be based on GDT: TextCollection. 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 can include 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, and 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, and can be based on GDT: BusinessTransactionDocumentRelationshipRoleCode. BusinessTransactionDocumentRelationshipTypeCode can be a coded representation of a relationship between two business documents or business document items, and can be based on GDT: BusinessTransactionDocumentRelationshipTypeCode. TransportationDocumentTypeCode can be a coded representation of a type of a document, and can be based on GDT: TransportationDocumentTypeCode. TransportationDocumentNote can be a short Note regarding 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. In some implementations, RelationshipTypeCode and RelationshipRoleCode are both optional. If used, both may be filled. In some implementations, either the combination BusinessTransactionDocumentReference, BusinessTransactionDocumentRelationshipRoleCode, BusinessTransactionDocumentRelationshipTypeCode or TransportationDocumentTypeCode, TransportationDocumentNote, TransportationDocumentID may be filled.
TransportationServiceRequirement can specify a contract and carriage condition and service and priority requirements for a transport which may apply to a whole shipment request. The structure of the TransportationServiceRequirement entity includes the 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. 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, and 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.
The TransportationUnitResourceInformation package includes information regarding a transportation unit resource that is relevant for a freight request (e.g., a container). The TransportationUnitResourceInformation package includes the TransportationUnitResourceInformation entity. TransportationUnitResourceInformation includes information on one or more transportation unit resources, such as resource type and related properties. For example, it can be 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. It includes the entities TransportationStageAssignment, AttachedEquipment, Quantity, Seal, BusinessTransactionDocumentReference, TextCollection, Party, Location, DangerousGoods. The structure of the TransportationUnitResourceInformation entity can include the 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 type of a transportation unit resource, and can be based on GDT: TransportationUnitResourceTypeCode. FilILevelCode 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. The shipping type can specify how planning and execution of a transportation can be performed. Transportation terms can 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. TransportationStageAssignment can specify an assignment of a resource to a stage. The structure of the TransportationStageAssignment entity includes a FreightRequestTransportationStageID element. FreightRequestTransportationStageID can be a unique identifier of a TransportationStage in a freight request, and can be based on GDT: TransportationStageID.
AttachedEquipment can specify an item of equipment that is attached to a TransportationUnitResource. The structure of the AttachedEquipment entity can include the ShipmentRequestResourceInformationID element. ShipmentRequestResourceInformationID can be a unique identifier of a resource information in a ShipmentRequest, and can be based on GDT: ResourceInformationID. Quantity specifies the quantity related to the TransportationUnitResourceInformation. The structure of the Quantity entity can include the elements Quantity, RoleCode, and TypeCode. 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. Seal specifies a seal related to a TransportationUnitResource. The structure of a Seal entity can include the 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, such as a role of a sealing party. PartyRoleCode can be based on GDT: PartyRoleCode.
PartyFormattedName can be a complete, formatted name of a party, such as a role of a sealing party. 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. BusinessTransactionDocumentReference specifies a business document reference that is related to a TransportationUnitResource. It includes the DateTimePeriod entity. The structure of the BusinessTransactionDocumentReference entity can include 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, and 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, and can be based on GDT: BusinessTransactionDocumentRelationshipRoleCode. BusinessTransactionDocumentRelationshipTypeCode can be a coded representation of a relationship between two business documents or business document items, and can be based on GDT: BusinessTransactionDocumentRelationshipTypeCode. TransportationDocumentTypeCode can be a coded representation of a type of a document, and can be based on GDT: TransportationDocumentTypeCode. TransportationDocumentNote can be a short Note regarding 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. In some implementations, RelationshipTypeCode and RelationshipRoleCode are both optional. If used, both can be filled. In some implementations, either the combination BusinessTransactionDocumentReference, BusinessTransactionDocumentRelationshipRoleCode, BusinessTransactionDocumentRelationshipTypeCode or TransportationDocumentTypeCode, TransportationDocumentNote, TransportationDocumentID may be filled.
TextCollection is a group of textual information that relates to the TransportationUnitResource. The structure of the TextCollection entity includes the element TextCollection. TextCollection can be based on GDT: TextCollection. Party includes information that is exchanged, in accordance with common business understanding, in business documents, about a party involved in the current TransportationUnitResource. This information is used to identify the party and the party's address. The structure of the Party entity can include the elements Party, RoleCode, and FormattedName. A Party includes information that is exchanged, in accordance with common business understanding, in business documents, about a party involved in business transactions. This information is 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, 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. Location specifies a physical place related to the TransportationUnitResource. The structure of the Location entity can include the elements Location, RoleCode, TypeCode, and Name. Location includes information that is 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.
DangerousGoods can specify dangerous goods included in a resource. DangerousGoods includes the ContactInformation and TextCollection entities. The structure of the DangerousGoods entity can include the 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, and 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. 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 the degree of danger of the goods, and can be based on GDT: DangerousGoodsPackagingGroupCode.
EmergencySchedule can be a coded representation of an emergency schedule for dangerous goods. It can identify 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. 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 dependent 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 dependent 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. 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, 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.
The TransportationChargesInformation package includes information regarding a transportation charge calculation specific to components related to a FreightRequest. 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 TransportationCharges entity. The structure of the TransportationChargesInformation entity can include the elements TransportationChargesUsageCode, FreightRequestPartyStandardID, FreightRequestTransportationUnitResourceID, and FreightRequestTransportationStageID. TransportationChargesUsageCode can be a coded representation of the 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. FreightRequestPartyStandardID can be a unique identifier of a Party in a FreightRequest, and can be based on GDT: PartyStandardID. FreightRequestTransportationUnitResourceID can be a unique identification of a TransportationUnitResource in a FreightRequest, and can be based on GDT: ResourceID. FreightRequestTransportationStageID can be a unique identification of a TransportationStage in a FreightRequest, and can be based on GDT: TransportationStageID.
In some implementations, if none of the IDs is maintained, the transportation charges are related to the entire freight request. TransportationCharges can be a summary of determined transportation charge specific components for a transportation business case. TransportationCharges includes the entities: Location, TextCollection, Currency, ExchangeRate, PercentElement, DateTimePeriod, BusinessTransactionDocumentReference, TaxDetail, PaymentInstruction, CashDiscountTerms, and Element. The structure of the TransportationCharges entity can include the 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. 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 a calculation, including results, can be manually entered or received from another business system via a message. In some implementations, there is a clear distinction of the origin of TransportationChargesCalculation details such as the TransportationChargesCalculationSheet and its TransportationChargeElements. TransportationChargesCalculationSheet gives information whether a calculation was done completely automatically, for example, or if results were manually adopted. CalculationOriginCode can be based on GDT: TransportationChargesOriginCode. 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. 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 which describes how to calculate transportation charges for a transportation business case. A TransportationChargesCalculationSheet includes instructions regarding which charges are applicable, which data from a transportation business case can be considered for a calculation, how underlying transportation charge rates can be determined, and which special calculation methods can be considered. CalculationSheetID can be based on GDT: TransportationChargesCalculationSheetID.
A ShipmentRequest package can specify or group together data related to a shipment request which is assigned to a freight request. A ShipmentRequest package includes the ShipmentRequest entity and the Confirmation package. ShipmentRequest 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. ShipmentRequest includes the TransportationStageAssignment and TransportationUnitResourceInformationAssignment entities. The structure of the ShipmentRequest entity includes the ID element. ID can be a unique identifier of a ShipmentRequest, and can be based on GDT: BusinessTransactionDocumentID. TransportationStageAssignment can specify an assignment of a shipment request to a transportation stage of a freight request.
The structure of the TransportationStageAssignment entity includes the FreightRequestTransportationStageID element. FreightRequestTransportationStageID can be a unique identifier of a TransportationStage in a freight request, and can be based on GDT: TransportationStageID. TransportationUnitResourceInformationAssignment can specify an assignment of a shipment request to a TransportationUnitResourceInformation of a freight request. The structure of the TransportationUnitResourceInformationAssignment entity includes the FreightRequestTransportationUnitResourceInformationID element. FreightRequestTransportationUnitResourceInformationID can be a unique identifier of a TransportationUnitResource in a freight request, and can be based on GDT: ResourceInformationID.
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 packages HeaderInformation, TransportationChargesInformation, GovernmentalRequirementInformation, PartyInformation, LocationInformation, TransportationStageInformation, TransportationUnitResourceInformation, PackagingInformation, and Item. In some implementations, the Confirmation package is filled either for none or for all of the shipment requests which are assigned to a freight request. In the first case, short form message, ShipmentRequest and its sub entities identify ShipmentRequest confirmations that have already been sent before. In the second case, extended form message, the Confirmation package includes ShipmentRequest confirmation data, and in a standard process the sub entities of entity ShipmentRequest may not be filled.
The message data type FreightRequestReceiptNotificationMessage includes business information that is relevant for sending a business document in a message, and a FreightRequest included in a business document. FreightRequestReceiptNotificationMessage includes the MessageHeader and FreightRequest packages. The message data type FreightRequestReceiptNotificationMessage can provide a structure for the message type FreightRequestReceiptNotification and for interfaces that are based on it.
A MessageHeader package can group together business information that is 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, provide information about the sender, and provide information about the recipient. The MessageHeader can be divided up into the SenderParty and RecipientParty entities. It 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.
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. This 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. In some implementations, SenderParty is filled by the sender, particularly if the participating parties are not transferred with the FreightRequest package.
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. 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. In some implementations, RecipientParty can be filled by the sender if a FreightRequest package cannot be used to transfer the participating parties.
The FreightRequest package can group a FreightRequest with its packages. It includes the FreightRequest entity and the Request package. FreightRequest can be an agreement between an ordering party and a transportation service provider on the shipment of goods from shippers to consignees. The structure of the FreightRequest entity includes the ID element. ID can be a unique identifier of a FreightRequest, and can be based on GDT: BusinessTransactionDocumentID. The Request package can group the Request with its packages. It includes the Request entity and the HeaderInformation and PartyInformation packages.
The HeaderInformation package can group dates, total values, documents and references related to a FreightRequest. The HeaderInformation package includes the entities DateTimePeriods, TextCollection, and BusinessTransactionDocumentReference. DateTimePeriods can specify a requested and an acceptable date, time and period applying to a FreightRequest (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 are RequestedFulfillmentPeriod, AcceptableFulfillmentPeriod, and PeriodRoleCode. RequestedFulfillmentPeriod can be a period which is requested depending on the semantics of the PeriodRoleCode, and can be based on GDT: DATETIMEPERIOD, Qualifier: RequestedFulfillment. AcceptableFulfillmentPeriod can be a period which is acceptable depending on the semantics of the PeriodRoleCode, and can be based on GDT: DATETIMEPERIOD, Qualifier: AcceptableFulfillment. PeriodRoleCode can be a coded representation of the business semantics of the two periods defined by the entities RequestedFulfillmentPeriod and AcceptableFulfillmentPeriod, and can be based on GDT: PeriodRoleCode. In some implementations, RequestedFulfillmentPeriod and AcceptableFulfillmentPeriod are optional, but in every instance one of them may be filled.
TextCollection can be a group of textual information that relates to a FreightRequest. The structure of the TextCollection entity can be based on the TextCollection element. TextCollection can be based on GDT: TextCollection. BusinessTransactionDocumentReference can specify a business document reference that is related to an entire FreightRequest. The structure of the BusinessTransactionDocumentReference entity can include 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, and 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, and can be based on GDT: BusinessTransactionDocumentRelationshipRoleCode. BusinessTransactionDocumentRelationshipTypeCode can be a coded representation of a relationship between two business documents or business document items, and can be based on GDT: BusinessTransactionDocumentRelationshipTypeCode. TransportationDocumentTypeCode can be a coded representation of a type of a document, and can be based on GDT: TransportationDocumentTypeCode. TransportationDocumentNote can be a short Note regarding 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. In some implementations, RelationshipTypeCode and RelationshipRoleCode are both optional. If used, both may be filled. In some implementations, either the combination BusinessTransactionDocumentReference, BusinessTransactionDocumentRelationshipRoleCode, BusinessTransactionDocumentRelationshipTypeCode or TransportationDocumentTypeCode, TransportationDocumentNote, TransportationDocumentID may be filled.
The PartyInformation package includes information regarding a party of a freight request, (e.g., Shipper, Carrier, Agent). The PartyInformation package includes the Party entity. Party includes information that is 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 structure of the Party entity includes the Party and RoleCode elements. A Party includes information that is 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, PartyRole is assigned to exactly one PartyRoleCategory and refines its semantics. Party can be based on GDT: PartyRoleCode.
The message data type FreightRequestConfirmationReceiptNotificationMessage includes business information that is relevant for sending a business document in a message and the FreightRequest included in the business document. It includes the MessageHeader and FreightRequest packages. The message data type FreightRequestConfirmationReceiptNotification can provide a structure for the message type FreightRequestConfirmationReceiptNotification and for interfaces that are based on it.
A MessageHeader package can group together business information that is 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.
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. This 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. In some implementations, it can be filled by the sender, particularly if the participating parties are not transferred with the FreightRequest package.
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. 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 the message and can be ignored by the receiving application. In some implementations, RecipientParty can be filled by the sender if the FreightRequest package cannot be used to transfer the participating parties.
The FreightRequest package can group a FreightRequest with its packages. The FreightRequest package includes the FreightRequest entity and the Confirmation package. FreightRequest can be an agreement between an ordering party and a transportation service provider on the shipment of goods from shippers to consignees. The structure of the FreightRequest entity include the ID element. ID can be a unique identifier of a FreightRequest, and can be based on GDT: BusinessTransactionDocumentID.
The Confirmation package can group the Confirmation with its packages. The Confirmation package includes the Confirmation entity and the HeaderInformation and PartyInformation packages. Confirmation can be a confirmation of an agreement between an ordering party and a transportation service provider on the shipment of goods from a shipper to consignees.
The HeaderInformation package groups dates, total values, documents and references related to a freight request. The HeaderInformation package includes the following entities: DateTimePeriods, TextCollection, and BusinessTransactionDocumentReference. DateTimePeriods can specify a requested and an acceptable date, time and period applying to a freight 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 RequestedFulfillmentPeriod, AcceptableFulfillmentPeriod, and PeriodRoleCode. RequestedFulfillmentPeriod can be a period which is requested depending on the semantics of the PeriodRoleCode, and can be based on GDT: DATETIMEPERIOD, Qualifier: RequestedFulfillment. AcceptableFulfillmentPeriod can be a period which is acceptable depending on the semantics of the PeriodRoleCode, and can be based on GDT: DATETIMEPERIOD, Qualifier: AcceptableFulfillment. PeriodRoleCode can be a coded representation of the business semantics of the two periods defined by the entities RequestedFulfillmentPeriod and AcceptableFulfillmentPeriod, and can be based on GDT: PeriodRoleCode. In some implementations, RequestedFulfillmentPeriod and AcceptableFulfillmentPeriod are optional, but in every instance one of them may be filled. TextCollection can be a group of textual information that relates to a FreightRequestConfirmation. The structure of the TextCollection entity includes the TextCollection element. TextCollection can be based on GDT: TextCollection.
BusinessTransactionDocumentReference can specify a business document reference that is related to an entire freight request. The structure of the BusinessTransactionDocumentReference entity can include 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, and 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, and can be based on GDT: BusinessTransactionDocumentRelationshipRoleCode.
BusinessTransactionDocumentRelationshipTypeCode can be a coded representation of a relationship between two business documents or business document items, and can be based on GDT: BusinessTransactionDocumentRelationshipTypeCode. TransportationDocumentTypeCode can be a coded representation of a type of a document, and can be based on GDT: TransportationDocumentTypeCode. TransportationDocumentNote can be a short Note regarding 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. In some implementations, RelationshipTypeCode and RelationshipRoleCode are both optional. If used, both may be filled. In some implementations, either the combination BusinessTransactionDocumentReference, BusinessTransactionDocumentRelationshipRoleCode, BusinessTransactionDocumentRelationshipTypeCode or TransportationDocumentTypeCode, TransportationDocumentNote, TransportationDocumentID may be filled.
The PartyInformation package includes information regarding a party of a freight request, (i.e., Shipper, Carrier, Agent). The PartyInformation package includes the Party entity. Party includes information that is 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 structure of the Party entity can include the Party and RoleCode elements. A Party includes information that is 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.
The HouseShipment interfaces can be part of the Shipper and Transportation Service Provision scenarios, where transportation services can be tendered between transportation service providers. A consignment of an ordering party can be specified in a WaybillNotification. A transportation service provider can issue a waybill for an ordering party by using the interfaces described in this document. A WaybillNotification can be a contractual document issued by a transportation service provider for a consignment of an ordering party. The structure of a WaybillNotification can be specified by the message data type WaybillNotificationMessage.
The waybill notification message can be implemented by the message interface Transportation Service Provider side: WaybillNotification_Out.
The message choreography of
A “Transportation Service Provider” system 43000 can issue a contractual document for a consignment to an “Ordering Party” system 43002, using a WaybillNotification message 43004 as shown, for example, in
The message data type WaybillNotificationMessage includes the business information that is relevant for sending a business document in a message and the WaybillNotification included in the business document. It includes the following packages: MessageHeader and WaybillNotification. The message data type WaybillNotificationMessage can provide the structure for the message type WaybillNotificationMessage and the interfaces that are based on it.
The WaybillNotification package groups the HouseShipment with its packages. It can include the HouseShipment entity. It includes the following packages: HeaderInformation, TransportationChargesInformation, GovemmentalRequirementInformation, PartyInformation, LocationInformation, TransportationStageInformation, TransportationUnitResourceInformation, PackagingInformation, and Item.
HouseShipment can be a logistic contractual document that can be sent from a transportation service provider to an ordering party. It includes information about goods which can be transported together across the entire transportation chain on one or multiple means of transport from a single ship-from party to a single ship-to party and in accordance with the agreed terms and conditions. It includes the following elements: @actioncode, ID, and DeliveryTerms. @actioncode can be a coded representation of an instruction to a message recipient telling it how it can process the transmitted element. @actioncode can be based on GDT: ActionCode. In some implementations, ID can be a unique identifier for a HouseShipment and can be based on GDT: BusinessTransactionDocumentID. DeliveryTerms can be based on GDT: DeliveryTerms.
The Item package can specify products included in the house shipment and additional information about the product. In some implementations, each house shipment item can be linked to exactly one item of a freight unit.
The ShipmentRequest interfaces can be part of the Shipper and Transportation Service Provision scenarios. In some implementations, ShipmentRequest interfaces are used to exchange agreements and corresponding confirmations and receipt notifications on the transportation of goods from a single ship-from party to a single ship-to party between an ordering party and a transportation service provider.
An ordering party can request a receipt notification from a transportation service provider to assure that the transportation service provider has received a ShipmentRequest and that the ShipmentRequest did not include any errors. At a later time, the transportation service provider can send a confirmation to the ordering party to confirm the shipment request. The confirmation can be an acceptance of the ShipmentRequest with its transport and carriage conditions, a rejection if the transportation service provider cannot ensure the transport service, or conditionally accepted in case the transportation service provider generally accepts the request, but may send more information about the way the provider intends to fulfill the requested transportation service, i.e., the transport details, at a later time. The transportation service provider can request a receipt notification from the ordering party about the ShipmentRequestConfirmation.
A ShipmentRequestRequest can be an ordering party's request to a transportation service provider to provide a transportation service. It can be an update to a previously received ShipmentRequest. The structure of the ShipmentRequestRequest can be specified by the message data type ShipmentRequestRequestMessage.
A ShipmentRequestCancelRequest can be a cancellation of an ordering party's request to a transportation service provider to provide a transportation service. The structure of the ShipmentRequestCancelRequest can be specified by the message data type ShipmentRequestCancelRequestMessage.
A ShipmentRequestConfirmation can be a confirmation of a ShipmentRequest from a transportation service provider to an ordering party. Through the confirmation, a ShipmentRequest can be Accepted, Rejected, or Conditionally Accepted. The confirmation can include information on the transport and carriage conditions such as carrier, mode of transport, or stages. The confirmation can also be related to a part of the shipment request (in the case of a split scenario). The structure of the ShipmentRequestConfirmation can be specified by the message data type ShipmentRequestConfirmationMessage.
A ShipmentRequestReceiptNotification can be a message from a transportation service provider to an ordering party confirming the receipt of the message and reporting any administrative errors included in the previous ShipmentRequestRequest message. The structure of the ShipmentRequestReceiptNotification can be specified by the message data type ShipmentRequestRequestMessage.
A ShipmentRequestConfirmationReceiptNotification can be a message from a transportation service provider to an ordering party confirming the receipt of the message and/or reporting administrative errors included in the previous ShipmentRequestRequest message. The structure of the ShipmentRequestConfirmationReceiptNotification can be specified by the message data type ShipmentRequestRequestMessage.
The shipment request messages are implemented by ten message interfaces: five on the ordering party side and five on the transportation service provider side. The message interfaces on the Ordering Party side include the following: ShipmentRequestRequest_Out, ShipmentRequestCancelRequest_Out, ShipmentRequestConfirmation_In, ShipmentRequestReceiptNotification_In, and ShipmentRequestConfirmationReceiptNotification_Out. The message interfaces on the Transportation Service Provider side include the following: ShipmentRequestRequest_In, ShipmentRequestCancelRequest_In, ShipmentRequestConfirmation_Out, ShipmentRequestReceiptNotification_Out, and ShipmentRequestConfirmationReceiptNotification_In.
The message choreography of
An “Ordering Party” system 46000 can request a shipment request, or update a previous request, using a ShipmentRequestRequest message 46004, as shown, for example, in
The “Ordering Party” system 46000 can request the cancellation of a shipment request using a ShipmentRequestCancelRequest message 46006 as shown, for example, in
The “Transportation Service Provider” system 46002 can confirm the shipment request using a ShipmentRequestConfirmation message 46010 as shown, for example, in
Additionally,
Additionally,
Additionally,
The message data type ShipmentRequestRequestMessage includes business information that is relevant for sending a business document in a message and the ShipmentRequest included in the business document. It includes the MessageHeader and ShipmentRequest packages. The message data type ShipmentRequestRequestMessage can provide a structure for the message type ShipmentRequestRequestMessage and interfaces that are based on it.
A MessageHeader package can group together business information that can be relevant for sending a business document in a message. It includes the MessageHeader entity. A MessageHeader can group together business information from the perspective of a sending application to identify the business document in a message, to provide information about the sender, or to provide any information about the recipient. The MessageHeader can be divided up into the SenderParty and RecipientParty entities. It 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.
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. In some implementations, the SenderParty can be filled by the sending application to name a contact person for problems with the message. This 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. In some implementations, SenderParty can be filled by the sender, particularly if the participating parties are not transferred with the ShipmentRequest package.
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. 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. In some implementations, it can be filled by the sender if the ShipmentRequest package cannot be used to transfer the participating parties.
The ShipmentRequest package can group the ShipmentRequest with its packages. It includes the ShipmentRequest entity and the Request package. The ShipmentRequest 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 attributes and elements located directly at the ShipmentRequest entity can include @actioncode and ID. @actioncode can be a coded representation of an instruction to a message recipient telling the message recipient how to process a transmitted element, and it can be based on GDT: ActionCode. ID can be a unique identifier of a ShipmentRequest and can be based on GDT: BusinessTransactionDocumentTypeCode. In some implementations, the attribute actioncode can include the two values, 01—Create, and 02—Change. In some implementations the ID may not be changed once a ShipmentRequest has been created. In some implementations, the Complete Transmission Indicator might not be included, as it may be set to true (i.e., there may be no delta transmissions, and the complete message content can be transmitted in every message). As a consequence, if an item is missing in the message, the corresponding item may be deleted.
The Request package can group the Request with its packages and it includes the Request entity. The packages include the following: HeaderInformation, TransportationChargesInformation, GovemmentalRequirementInformation, PartyInformation, LocationInformation, TransportationStageInformation, TransportationUnitResourceInformation, PackagingInformation, and Item. A 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 element located directly at the Request entity can be the DeliveryTerms element. Collection of the conditions and agreements can apply when delivering the ordered goods and providing necessary services and activities of this element. The DeliveryTerms element can be based on GDT: DeliveryTerms.
HeaderInformation can group dates, total values, document and references related to a shipment request. It includes the entities: DateTimePeriods, NatureOfCargo, TotalQuantity, TotalAmount, TextCollection, TransportationServiceRequirement, TransportationDocumentInformation, and BusinessTransactionDocumentReference. In some implementations, 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 at the DateTimePeriods entity can include RequestedFulfillmentPeriod, AcceptableFulfillmentPeriod, and PeriodRoleCode. The RequestedFulfillmentPeriod can be a period which is requested depending on the semantic of the PeriodRoleCode and can be based on GDT: DATETIMEPERIOD, Qualifier: RequestedFulfillment. The AcceptableFulfillmentPeriod can be a period which is acceptable depending on the semantic of the PeriodRoleCode. It can be based on GDT: DATETIMEPERIOD, Qualifier: AcceptableFulfillment. The PeriodRoleCode can be a coded representation of the business semantic of two periods defined by the entities RequestedFulfillmentPeriod and AcceptableFulfillmentPeriod. The 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. NatureOfCargo can indicate a nature of cargo related to the shipment request. For example, cargo can be palletized, containerized, or documents. ClassificationCode can be a coded representation of a classification of the nature of cargo and can be based on GDT: NatureOfCargoClassificationCode. 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 Quantity can be a non-monetary numerical specification of an amount in a unit of measurement and can be based on GDT: Quantity. The RoleCode can be a coded representation of the role of a quantity and can be based on GDT: QuantityRoleCode. The TypeCode can be a coded representation of a type of quantity that is based on the measurable characteristic of an object or physical phenomenon. It can be based on GDT: QuantityTypeCode. In some implementations, QuantityRoleCode and QuantityTypeCode are optional, but in every instance one of them can be filled. TotalAmount can specify a cumulated monetary amount related to a shipment request (e.g., duty amount, insurance amount, or total value). Amount can be an amount with a corresponding currency unit based on CDT: Amount. RoleCode can be a coded representation of a role of an amount and can be based on GDT: AmountRoleCode. TextCollection can be a group of textual information that relates to a shipment request. TextCollection can be based on GDT: TextCollection. TransportationServiceRequirement can specify a contract and carriage condition and the service and priority requirements for a transport which apply to a whole shipment request. The TransportationServiceRequirementCode can be a coded representation of a requirement related to a transportation service, and can be based on GDT: TransportationServiceRequirementCode. The AdditionalTransportationServiceRequirementCode can be a coded representation of an additional requirement related to a transportation service. It 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 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. It can be based on GDT: NatureOfCargoClassificationCode. TransportationDocumentInformation can specify information on a transportation document related to a shipment request. It includes the DateTimePeriod entity. Its structure can be based on 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 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). It 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. In some implementations, RequiredIndicator can indicate whether a documentation is required or not. It can be based on GDT: Indicator Qualifier: Required. OutputCopyNumberValue can be a number specifying the number of copies of a document that can be issued and can be based on GDT: NumberValue, Qualifier: OutputCopy. OutputOriginalNumberValue can be a number specifying the number of originals of a document that can be issued. It 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 are filled. DateTimePeriod can specify date, time and/or period (e.g., validity date related to the required business documentation). 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 the business semantic of a period. It can be based on GDT: PeriodRoleCode. BusinessTransactionDocumentReference can specify a business document reference that is related to a whole shipment request. It includes the DateTimePeriod entity. BusinessTransactionDocumentReference can be a unique reference to other business documents or business document items that are of significance within each respective business process. It 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. It can be based on GDT: BusinessTransactionDocumentRelationshipRoleCode. BusinessTransactionDocumentRelationshipTypeCode can be a coded representation of the relationship between two business documents or business document items. It can be based on GDT: BusinessTransactionDocumentRelationshipTypeCode. TransportationDocumentTypeCode can be a coded representation of a type of a documentation 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. In some implementations, RelationshipTypeCode and RelationshipRoleCode are both optional. If used, both can be filled. In some implementations, either the combination of BusinessTransactionDocumentReference, BusinessTransactionDocumentRelationshipRoleCode, BusinessTransactionDocumentRelationshipTypeCode or TransportationDocumentTypeCode, TransportationDocumentNote, TransportationDocumentID may be filled. DateTimePeriod can specify date, time and/or period information related to a DocumentReference.
GovemmentalProcedureInformation can specify applicable governmental procedures related to import, export and transport of the goods of the shipment request. It includes the GovernmentalProcedure entity. GovernmentalProcedure can specify applicable governmental procedures related to import, export and transport of the goods of the shipment request. It includes the entities Location, DateTimePeriod, Seal, TextCollection, and TransportationDocumentInformation. 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. Examples are 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 and can be based on GDT: TransportationGovemmentAgencyInvolvementStatusCode. TransportationGovernmentAgencyActionCode can be a coded representation of an action of a transportation related government agency and can be based on GDT: TransportationGovernmentAgencyActionCode. TransportationGovernmentAgencyProcedureStatusCode can be a coded representation of the status of a procedure related to a transportation government agency and can be based on GDT: TransportationGovemmentAgencyProcedureStatusCode. Location can be a physical place related to the GovernmentalProcedure. DateTimePeriod can specify a date, time and/or period related to a GovernmentalProcedure. Seal can specify seal information related to a GovernmentalProcedure. 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, such as the role of a sealing party, and can be based on GDT: PartyRoleCode. PartyFormattedName can be a complete, formatted name of a party, such as of the sealing party, and can be a Name of the SealingParty. PartyFormattedName can be based on GDT: LONG_Name, Qualifier: PartyFormatted. StatusCode can be a coded representation of the status of a seal and can be based on GDT: SealStatusCode. TextCollection can be a group of textual information that relates to the GovernmentalProcedure. TextCollection can be based on GDT: TextCollection. TransportationDocumentInformation can specify information on a transportation document related to the GovernmentalProcedure. It includes the DateTimePeriod entity. DateTimePeriod can specify date, time and/or period information related to the Documentation.
The PartyInformation package includes information regarding a party of a shipment request (i.e., Shipper, Carrier, Agent). It includes the Party entity. Party includes information that is 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. A Party includes information that is 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 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 the business object and corresponding processes. In some implementations, PartyRole can be assigned to exactly one PartyRoleCategory and can refine its semantics. PartyRole 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. Amount can specify an amount related to the party. 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. TransportationDocumentInformation can specify business documentation related to a party according to a documentation type. TransportationDocumentInformation includes the DateTimePeriod entity. DateTimePeriod can specify date, time and/or period information (e.g., validity date) related to business documentation of a party. BusinessTransactionDocumentReference can specify a business document reference that is related to a party. It includes the DateTimePeriod entity. DateTimePeriod can specify date, time and/or period information related to a document referenced by a party.
The LocationInformation package includes information regarding a location of a shipment request (i.e., Ship-from location). LocationInformation includes the Location entity. Location can specify a physical place a shipment request refers to as it is relevant for its processing. It includes the DateTimePeriod entity. DateTimePeriods can specify a requested and an acceptable date, time and period related to the location.
The TransportationStageInformation package includes information regarding a transportation stage of a shipment request. A transportation stage can represent a section of a transport. It includes the Stage entity. Transportation Stage can specify details related to a stage of a transport which is part of a shipment request. It includes the entities Location, TransportationDocumentInformation, and TransportationServiceRequirement. ID can be a unique identifier of a stage in a shipment request and can be based on GDT: TransportationStageID. OrdinalNumberValue can be used to indicate a position of a transportation stage in a set of transportation stages. It 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 (Voyage) 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 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. 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 and 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. StageLocation can specify a physical place related to a stage. StageLocation includes the DateTimePeriods entity. DateTimePeriods can specify a date, time and/or period related to the Location. BusinessTransactionDocumentReference can specify a business document reference that is related to a Stage. It includes the DateTimePeriod entity. DateTimePeriod can specify date, time and/or period information related to a BusinessTransactionDocumentReference. TransportationServiceRequirement can specify a contract and carriage condition and service and priority requirements related to a stage.
The TransportationUnitResourceInformation package includes information regarding a transportation unit resource that can be relevant for a shipment request (i.e., a container). TransportationUnitResourceInformation includes the TransportationUnitResourceInformation entity. Transportation Unit ResourceInformation includes information on one to multiple transportation unit resources, such as resource type and related properties. For example, related measures or handling instructions can be included. 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 cannot move by itself. It includes the entities TransportationStageAssignment, AttachedEquipment, Quantity, Seal, BusinessTransactionDocumentReference, TextCollection, Location, and DangerousGoods. 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 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. In some implementations, the shipping type can specify the how the planning and execution of a transportation can be performed. The 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 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. TransportationStageAssignment can specify an assignment of a transportation stage to a transportation unit resource information. ShipmentRequestTransportationStageID can be a unique identifier of a TransportationStage in a shipment request and can be based on GDT: TransportationStageID. AttachedEquipment can specify an equipment that is attached to a TransportationUnitResource. ShipmentRequestResourceInformationID can be a unique identifier of a resource information in a ShipmentRequest and can be based on GDT: ResourceInformationID. Quantity can specify a quantity related to a TransportationUnitResourceInformation. Seal can specify a seal related to a TransportationUnitResource. BusinessTransactionDocumentReference can specify a business document reference that is related to a TransportationUnitResource. It includes the DateTimePeriod entity. DateTimePeriod can specify date, time and/or period related to a BusinessTransactionDocumentReference. TextCollection can be a group of textual information that relates to a TransportationUnitResource. TextCollection can be based on GDT: TextCollection. Location can specify a physical place related to a TransportationUnitResource. DateTimePeriods can specify a requested and an acceptable date, time and period related to a Location of a resource. DangerousGoods can specify dangerous goods included in a resource. DangerousGoods includes the ContactInformation and TextCollection entities. The structure of DangerousGoods includes 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. 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. 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. It can be based on GDT: DangerousGoodsPackagingGroupCode. EmergencySchedule can be a coded representation of an emergency schedule for dangerous goods. It can identify an emergency schedule. The DangerousGoodsEmergencySchedule can be used for transport of dangerous goods by sea similar to the 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. It 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, and 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, and can be based on GDT: DangerousGoodsLabelCode. 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 can be transported. It 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. It can be based on GDT: DangerousGoodsTransportAuthorisationCode. ContactInformation can specify information on a department or person to whom information regarding dangerous goods can be directed. The structure of ContactInformation includes ContactPersonFunctionTypeCode and Address. ContactPersonFunctionTypeCode can be a coded representation of a type of function that a contact person has, and can be based on GDT: ContactPersonFunctionTypeCode. Address can be an address related to the contact information defined by the corresponding FunctionTypeCode, and can be based on GDT: Address. TextCollection can be a group of textual information that relates to the DangerousGoods. TextCollection can be based on GDT: TextCollection.
The PackageInformation package includes information regarding the packages of the goods that are to be transported. It includes the PackageInformation entity. PackageInformation can describe package information related to a whole shipment request. PackageInformation includes the entities ItemAssignment, TransportationUnitResourceInformationAssignment, Quantity, and TextCollection. 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 the position of a package in a set of packages. In a transportation document, the position of a package can be a position that has been specified at shipping time. PackageOrdinalNumberValue can be based on GDT: OrdinalNumberValue, Qualifier: Package. PackageNumberValue can be 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 package type, 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. ItemAssignment can specify an assignment of a packaging to an item with corresponding information on measures, quantities, contents and references on related documents. PredecessorPackageID includes the entities Quantity, BusinessTransactionDocumentReference, and TransportationGoodsIdentification. The structure of ItemAssignment includes ShipmentRequestItemID. ShipmentRequestItemID can be a unique identifier of an item of a ShipmentRequest, and can be based on GDT: BusinessTransactionDocumentItemID. Quantity can specify a quantity related to an assignment of a packaging to an item. BusinessTransactionDocumentReference can specify a business document reference that is related to an assignment of a packaging to an_Item. BusinessTransactionDocumentReference includes the DateTimePeriod entity. DateTimePeriod can describe date, time and/or period information related to a BusinessTransactionDocumentReference. TransportationGoodsIdentification can describe content identification related to a PackagingItem. The structure of TransportationGoodsIdentification includes 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. 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, it can 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, and can be based on GDT: TransportationGoodsID, Qualifier: UpperBoundary. TransportationUnitResourceInformationAssignment can specify the assignment of a packaging to a TransportationUnitResourceInformation with corresponding quantity information. The structure of TransportationUnitResourceInformationAssignment can include ShipmentRequestResourceInformationID. ShipmentRequestResourceInformationID can be a unique identifier of a TransportationUnitResourceInformation in a shipment request, and can be based on GDT: ResourceInformationID. Quantity can specify a quantity related to the TransportationUnitResourceAssignment. Quantity can specify a quantity related to packaging. TextCollection can be a group of textual information of any type that relates to the Packaging. TextCollection can be based on GDT: TextCollection.
The TransportationChargesInformation package includes information regarding transportation charge calculation specific components related to the ShipmentRequest. It includes the TransportationChargesInformation entity. In some implementations, the TransportationChargesInformation entity defines a relationship between transportation charges and the origin of those charges. It includes the TransportationCharges entity. The structure of TransportationChargesInformation can include TransportationChargesUsageCode, ShipmentRequestItemID, ShipmentRequestPartyStandardID, ShipmentRequestPartyInternalID, ShipmentRequestResourceInformationID, ShipmentRequestPackageInformationID, and ShipmentRequestTransportationStageID. TransportationChargesUsageCode can be a coded representation of usage of TransportationCharges. The usage can point out if 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, and can be based on GDT: BusinessTransactionDocumentItemID. ShipmentRequestPartyStandardID can be a unique identifier of a Party in a ShipmentRequest, and 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. It can be based on GDT: ResourceInformationID. ShipmentRequestPackageInformationID can be a unique identification of a PackageInformation in a ShipmentRequest, and can be based on GDT: PackageInformationID. ShipmentRequestTransportationStageID can be a unique identification of a TransportationStage in a ShipmentRequest, and can be based on GDT: TransportationStageID. In some implementations, the following Integrity Condition can exist: in case none of the IDs is maintained, the transportation charges are related to the whole shipment request. TransportationCharges can be a summary of determined transportation charge specific components for a transportation business case. It can include the entities Location, TextCollection, Currency, ExchangeRate, PercentElement, DateTimePeriod, BusinessTransactionDocumentReference, TaxDetail, PaymentInstruction, CashDiscountTerms, and Element. The structure of TransportationCharges includes ID, FreightAgreementID, CalculationOriginCode, TariffID, and CalculationSheetID. ID can be a unique identifier of TransportationCharges in a ShipmentRequest, and can be a GDT: TransportationChargesID. FreightAgreementID can be an identification of a Freight Agreement which includes and points to a configuration for a Transportation Charges Calculation. FreightAgreementID can be based on GDT: FreightAgreementID. CalculationOriginCode can be a coded representation of the origin of the transportation charges calculation. The calculation can be done automatically based on a 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 is a distinction of the origin of TransportationChargesCalculation details such as the TransportationChargesCalculationSheet and its TransportationChargeElements. It can give information whether the calculation was done completely automatically, or if the results were manually adopted. TransportationOriginCode can be based on GDT: TransportationChargesOriginCode. 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 can be 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. It includes instructions, which charges are applicable, which data from the transportation business case can be considered for the calculation, how the underlying transportation charge rates are determined, and which special calculation methods can be considered. CalculationSheetID can be based on GDT: TransportationChargesCalculationSheetID. The Location can specify a physical place to which the TransportationCharges and their calculation can refer. Location includes the DateTimePeriod entity. The structure of Location can include the elements Location, RoleCode, TypeCode, and Name. Location can include information that is 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. DateTimePeriods can specify a date, time and/or period related to the TransportationChargesLocation. TextCollection can be a group of textual information that relates to the TransportationCharges. TextCollection can be based on GDT: TextCollection. Currency can be a currency which is valid for transportation charges. The structure of Currency includes 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 the 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. In some implementations, this currency is valid for transportation charges, as long as there is no currency information on a charge element level. ExchangeRate can be an exchange rate that has been negotiated for transportation charges. The structure of ExchangeRate includes ExchangeRate and TypeCode. ExchangeRate can be a rate at which one unit of a currency can be changed into another currency, and can be based on GDT: ExchangeRate. TypeCode can be a coded representation of a type of an exchange rate. In some implementations, the actual exchange rate between two currencies depends on 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. PercentElement can be a detail, represented as a percentage, about Transportation Charges. The structure of PercentElement can include PercentRoleCode, Percent, TransportationChargesCalculationsBaseCode, and StatusCode. PercentRoleCode can be a coded representation of the role of a percent, and can be based on GDT: PercentRoleCode. Percent can be a number that relates to the comparison
Element can be, together with its sub nodes, a single ‘building block’ of a transportation charge calculation. A Charge Element can result from either a manually created charge, an automatically determined charge, or another Charge Element distributed from an entire document. Charge Element can include the entities Location, TextCollection, Currency, RateElement, PercentElement, AmountElement, CalculationBase, TaxDetail, DateTimePeriod, and CostDistribution. The structure of Element can include 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. In some implementations, 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, and 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, and can be based on GDT: TransportationChargesElementCalculationResolutionCode. TransportationChargesPaymentArrangementCode can be a coded representation of an arrangement of a payment for transportation charges. It can be based on GDT: TransportationChargesPaymentArrangementCode. Location can specify a physical place a specific ChargeElement refers to. It includes the DateTimePeriod entity. DateTimePeriods can specify a date, time and/or period related to a location. TextCollection can be a group of textual information that relates to a ChargeElement. TextCollection can be based on GDT: TextCollection. Currency can emphasize if a ChargeElement can be considered with relation to a certain currency. RateElement can specify a rate with which a ChargeElement is calculated. The structure of RateElement can include 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. It can be 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. It can be a quantity to which an amount refers. BaseQuantity can be based on CDT: Quantity, Qualifier: Base. TransportationChargesRateTypeCode can be a coded representation of a TransportationChargeRate type. Examples can include ‘gross weight rate’ or ‘net weight rate’. TransportationChargesRateTypeCode can be based on GDT: TransportationChargesRateTypeCode. TransportationChargesRateRoleCode can be a coded representation of a role of a TransportationChargeRate. Examples can include an ‘invoice rate’ or a ‘rate only for calculation purpose’. TransportationChargesRateRoleCode can be based on GDT: TransportationChargesRateRoleCode. TransportationChargesRateElementStatusCode can be a coded representation of a status of a transportation charges rate element, and can be based on GDT: TransportationChargesRateElementStatusCode. PercentElement can be a detail about a transportation charges element, represented as a percentage. AmountElement can represent a monetary aspect of a Transportation Charge. It can be a result of a transportation charge calculation. In some implementations, there can be a separate instance for each monetary amount per AmountRoleCode. AmountElement includes the RateElementAssignment entity. The structure of AmountElement can include 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. 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. TransportationChargesElementRateID can be based on GDT: TransportationChargesElementRateElementID.
CalculationBase can be data which was together with the RateDetail the basis for calculating the Amount. The structure of CalculationBase can include TransportationChargesElementCalculationBaseCode, BaseQuantity, BaseQuantityRoleCode, and BaseQuantityTypeCode. TransportationChargesElementCalculationBaseCode can be a coded representation of a calculation base of a transportation charges element, and can be based on GDT: TransportationChargesElementCalculationBaseCode. BaseQuantity can be a non-monetary numerical specification of an amount in a unit of measurement. It 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, and 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, and can be based on GDT: QuantityTypeCode. TaxDetail can be tax-relevant information which can be applicable for each ChargeElement. DateTimePeriod can specify a date, time and/or period related to a ChargeElement. CostDistribution can be information on how a ChargeElement can be allocated, or distributed, from a financial accounting point of view. An AccountingCodingBlockAssignment can be an assignment of something to a coding block. Items that can be assigned to a coding block can be an amount that is known from a 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 can be assigned in Accounting. AccountCodingBlockAssignment can be based on GDT: AccountingCodingBlockAssignment.
The Item package includes information regarding products included in a shipment request and additional information on those products. It includes the Item entity. It includes the packages ItemInformation, GovernmentalRequirementInformation, PartyInformation, LocationInformation, and TransportGoodsInformation. Item can specify products included in a shipment request and additional information about those products. The structure of Item can include 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. 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. It can be based on GDT: CountryCode, Qualifier: Destination. ShippingTypeCode can be a coded representation of a shipping type. In some implementations, the 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 an inland transportation of cargo. It 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. It can be based on GDT: MeasureInterval, Qualifier: Temperature. TransportationHandlingInstructionCode can be a coded representation of a transportation handling instruction, and can be based 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, only the units of measurement Celsius and Fahrenheit are allowed.
The ItemInformation package can specify products included in a shipment request and additional information related to a transportation of these products. It includes the entities Amount, TextCollection, NatureOfCargo, Quantity, TransportationDocumentInformation, BusinessTransactionDocumentReference, DangerousGoods, TransportationStageAssignment, and TransportationUnitResourceInformationAssignment. The Amount can specify a monetary amount associated with an item, for example, a declared value or insured value. TextCollection can be a group of textual information of any type that relates to an item. TextCollection can be based on GDT: TextCollection. NatureOfCargo can indicate a nature of cargo related to an item, for example, palletized, containerized, documents. Quantity can specify a quantity related to an item. TransportationDocumentInformation can specify information on a transportation document. It includes the DateTimePeriod entity. DateTimePeriod can specify a date, time and/or Period related to Documentation. BusinessTransactionDocumentReference can specify a business document reference that is related to an item. It includes the DateTimePeriod entity. DateTimePeriod can specify a date, time and/or Period related to a BusinessTransactionDocumentReference. DangerousGoods can specify identification, description and classification of dangerous goods related to an item. It includes the entities ContactInformation, Quantity, TextCollection, and TransportationUnitResourceInformationAssignment. ContactInformation can specify information on a department or person to whom information regarding dangerous goods can be directed. Quantity can specify a quantity of the DangerousGoods. TextCollection can be a group of textual information that relates to a ItemDangerousGoods. TextCollection can be based on GDT: TextCollection. TransportationUnitResourceAssignment can specify an assignment of dangerous goods of an item to a TransportationUnitResource with corresponding quantity information. It includes the Quantity entity. ShipmentRequestResourceInformationID can be a unique identifier of a TransportationUnitResource, and can be based on GDT: ResourceInformationID. Quantity can specify a quantity related to dangerous goods assigned to a Resource. The TransportationStageAssignment can specify an assignment of an item to a transportation stage with corresponding quantity information. ShipmentRequestTransportationStageID can be a unique Identifier of a TransportationStage, and can be based on GDT: TransportationStageID. The Quantity can specify a quantity related to an item assigned to a transportation stage. TransportationUnitResourceInformationAssignment can specify an assignment of an item to a transportation unit resource information with corresponding quantity information. It includes the Quantity entity. ShipmentRequestTransportationUnitResourceID can be a unique identifier of a TransportationUnitResource, and can be based on GDT: ResourceID. Quantity can specify a quantity related to an item which is assigned to a TransportationUnitResource.
The GovernmentalRequirementInformation Package can specify governmental requirements related to an item.
The ItemPartyInformation package includes information regarding a party of an item. It includes the Party and DateTimePeriods entities. Party includes information that is exchanged, in accordance with common business understanding, in business documents about a party involved in business transactions. This information can be used to identify a party and the party's address, as well as a 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 DateTimePeriods entity. DateTimePeriods can specify a requested and an acceptable date, time and period related to the 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 ItemLocationInformation package includes information regarding a location that is related to an item. It includes the Location and LocationDateTimePeriods entities. Location can specify a physical place which is part of a shipment request item. It includes the DateTimePeriods entity. The DateTimePeriods can specify a requested and an acceptable date, time and period related to a Location. 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 TransportationGoodsInformation package can group information on goods that can be transported according to an item. It includes the ProductInformation and TransportationGoodsIdentification entities. ProductInformation includes information on a commodity that is an object of business activity of a company and serves to generate value for the company. It 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. The structure of ProductInformation can include Product and ProductDescription. Product can include information that is 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 the properties of a product, and can be based on GDT: SHORT Description, Qualifier: Product. TransportationGoodsIdentification can describe content identification related to the PackagingItem.
The message data type ShipmentRequestCancelMessage can group together business information that can be relevant for sending a business document in a message and a ShipmentRequest object in a business document. It includes the BusinessDocumentMessageHeader and ShipmentRequest packages.
A MessageHeader package can group together business information that can be relevant for sending a business document in a message. It 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, or to provide information about the recipient. The MessageHeader can be divided up into the SenderParty and RecipientParty entities. It can be of type GDT: BusinessDocumentMessageHeader. The MessageHeader can include 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.
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 can include 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. This 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. In some implementations, SenderParty can be filled by the sender, particularly if the participating parties are not transferred with the ShipmentRequest package.
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 can include 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. 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 the message and can be ignored by the receiving application. In some implementations, RecipientParty can be filled by the sender if the ShipmentRequest package cannot be used to transfer the participating parties.
The ShipmentRequest package can group together information about a ShipmentRequest. ShipmentRequest includes the ShipmentRequest entity and the BusinessTransactionDocumentReference package. ShipmentRequest 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 attributes and elements located directly at the ShipmentRequest entity can include ID. ID can be a unique identifier of a ShipmentRequest, and can be based on GDT: BusinessTransactionDocumentID.
The Request package can group the Request with its packages. It includes the Request entity and the BusinessTransactionDocumentReference package. 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.
A BusinessTransactionDocumentReference Package can group references to business documents. It includes the BusinessTransactionDocumentReference entity.
The message data type ShipmentRequestConfirmationMessage includes business information that is relevant for sending a business document in a message and the ShipmentRequest included in a business document. In some implementations, the message data type ShipmentRequestConfirmationMessage provides a structure for the message type ShipmentRequestConfirmationMessage and interfaces that are based on it.
A MessageHeader package can group together business information that is relevant for sending a business document in a message. It 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 elements. MessageHeader can be of type GDT: BusinessDocumentMessageHeader. The MessageHeader can include 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. A SenderParty can be a party responsible for sending a business document at a business application level. The SenderParty is of type GDT: BusinessDocumentMessageHeaderParty. The SenderParty can include 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. This 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. In some implementations, SenderParty can be filled by the sender, particularly if the participating parties are not transferred with the ShipmentRequest package. 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 can include 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. 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. In some implementations, RecipientParty can be filled by the sender if the ShipmentRequest package cannot be used to transfer the participating parties.
The ShipmentRequest package can group the ShipmentRequest together with its packages. It includes the ShipmentRequest entity and the Confirmation package. ShipmentRequest 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 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, which includes the 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 structure of Confirmation includes DeliveryTerms and AcceptanceStatusCode. DeliveryTerms can be a collection of conditions and agreements that apply when delivering ordered goods and providing necessary services and activities. DeliveryTerms can be based on GDT: DeliveryTerms. 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: AcceptanceStatusCode.
The message data type ShipmentRequestReceiptNotificationMessage includes business information that is relevant for sending a business document in a message and a ShipmentRequest included in a business document. In some implementations, the message data type ShipmentRequestReceiptNotificationMessage provides a structure for the message type ShipmentRequestReceiptNotificationMessage and for interfaces that are based on it.
A MessageHeader package can group together business information that is relevant for sending a business document in a message. It 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 can include 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. 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 can include 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. This 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. In some implementations, SenderParty can be filled by the sender particularly if the participating parties are not transferred with the ShipmentRequest package. 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 can include the following elements: InternalID, StandardID, and ContactPerson. The RecipientParty can be filled by a sending application to name a contact person for problems that 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. In some implementations, it can be filled by the sender if the ShipmentRequest package cannot be used to transfer the participating parties.
The ShipmentRequest package can group a ShipmentRequest with its packages. It includes the ShipmentRequest entity and the Request package. ShipmentRequest 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. ID can be a unique identifier of a ShipmentRequest, and can be based on GDT: BusinessTransactionDocumentID.
The Request package can group a Request with its packages. It includes the Request entity, and the HeaderInformation and PartyInformation packages. 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 HeaderInformation package can group dates, total values, documents and references related to the shipment request. It includes the entities: DateTimePeriods, TextCollection, and BusinessTransactionDocumentReference. 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. TextCollection can be a group of textual information that relates to a ShipmentRequestConfirmation. TextCollection can be based on GDT: TextCollection. BusinessTransactionDocumentReference can specify a business document reference that is related to a whole shipment request. DateTimePeriod can specify date, time and/or period information related to a DocumentReference.
The PartyInformation package includes information regarding a party of a shipment request (i.e., Shipper, Carrier, Agent). PartyInformation includes the Party entity. Party includes information that is exchanged, in accordance with common business understanding, in business documents, about a party involved in business transactions. This information can be used to identify a 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 structure of the Party entity includes Party and RoleCode. A Party includes information that is 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, PartyRole is assigned to exactly one PartyRoleCategory and refines its semantics. RoleCode can be based on GDT: PartyRoleCode.
The message data type ShipmentRequestConfirmationReceiptNotificationMessage includes business information that can be relevant for sending a business document in a message and a ShipmentRequest included in a business document. The message data type ShipmentRequestConfirmationReceiptNotificationMessage can provide a structure for the message type ShipmentRequestConfirmationReceiptNotificationMessage and for interfaces that are based on it.
A MessageHeader package can group together business information that is relevant for sending a business document in a message. It 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 can include 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. 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 can 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. This 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. In some implementations, SenderParty is filled by the sender particularly if the participating parties are not transferred with the ShipmentRequest package. 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 can include 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. 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. In some implementations, RecipientParty can be filled by the sender if the ShipmentRequest package cannot be used to transfer the participating parties.
The ShipmentRequest package can group the ShipmentRequest with its packages. ShipmentRequest includes the ShipmentRequest entity and the Confirmation package. ShipmentRequest 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. ID can be a unique identifier of a ShipmentRequest, and can be based on GDT: BusinessTransactionDocumentID.
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. It includes the Confirmation entity and the HeaderInformation and PartyInformation packages. 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 HeaderInformation package can group dates, total values, documents and references related to the shipment request. It can include the following entities: DateTimePeriods, TextCollection, and BusinessTransactionDocumentReference. 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). TextCollection can be a group of textual information of that relates to a ShipmentRequestConfirmation. TextCollection can be based on GDT: TextCollection. BusinessTransactionDocumentReference can specify a business document reference that is related to a shipment request. DateTimePeriod can specify date, time and/or period information related to a DocumentReference. The PartyInformation package includes information regarding a party of a shipment request (i.e., Shipper, Carrier, Agent). PartyInformation includes the Party entity. Party includes information that is exchanged, in accordance with common business understanding, in business documents, about a party involved in business transactions. This information can be used to identify a 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 structure of the Party entity includes Party and RoleCode. Party includes information that is exchanged, in accordance with common business understanding, in business documents, about a party involved in business transactions. This information can be used to identify a 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 exactly one PartyRoleCategory and refines its semantics. RoleCode can be based on GDT: PartyRoleCode.
The Supplier Freight Invoice Request interfaces are part of the Shipper and Transportation Service Provision scenarios. They can trigger supplier invoice processing with calculated transportation charges and transportation data. A confirmation can be sent from supplier invoice processing with data of a created invoice document. A SupplierFreightInvoiceRequestRequest is a request for freight invoicing from supplier freight invoice request processing to supplier invoice processing. The structure of the SupplierFreightInvoiceRequestRequest can be specified by the message data type SupplierFreightInvoiceRequestRequestMessage. A SupplierFreightInvoiceRequestCancelRequest is a cancellation of a request for freight invoicing from supplier freight invoice request processing to supplier invoice processing. The structure of the SupplierFreightInvoiceRequestCancelRequest can be specified by the message data type SupplierFreightInvoiceRequestCancelRequestMessage.
A SupplierFreightInvoiceRequestConfirmation is a confirmation of a request for freight invoicing from supplier invoice processing to supplier freight invoice request processing. The structure of the SupplierFreightRequestConfirmation can be specified by the message data type SupplierFreightInvoiceRequestConfirmationMessage. The supplier freight invoice request messages can be implemented by six message interfaces (for example, three on the supplier freight invoice request processing side and three on the supplier invoice processing side). The supplier freight invoice request processing side can include SupplierFreightInvoiceRequestRequest_Out, SupplierFreightInvoiceRequestCancelRequest_Out and SupplierFreightInvoiceRequestConfirmation_In. The supplier invoice processing side can include SupplierFreightInvoiceRequestRequest_In, SupplierFreightInvoiceRequestCancelRequest_In, and SupplierFreightInvoiceRequestConfirmation_Out.
The message choreography of
Additionally,
Additionally,
The message data type SupplierFreightInvoiceRequestRequestMessage includes business information that is relevant for sending a business document in a message and the SupplierFreightInvoiceRequest included in the business document. It includes the packages MessageHeader and SupplierFreightInvoiceRequest. The message data type SupplierFreightInvoiceRequestRequestMessage provides a structure for the message type SupplierFreightInvoiceRequestRequestMessage and for interfaces that are based on it.
A MessageHeader package groups together business information that is relevant for sending a business document in a message. It includes the entity MessageHeader. A MessageHeader groups together business information from the perspective of a sending application, for example, to identify a business document in a message, to provide information about the sender, and/or to provide information about the recipient. The MessageHeader is divided up into the entities SenderParty and RecipientParty. MessageHeader is of type GDT: BusinessDocumentMessageHeader. The MessageHeader can include the elements ID, ReferenceID, and CreationDateTime. In some implementations, the MessageID is set by the sending application. With the ReferencedMessageID, reference can be made in the current BusinessDocument to a previous BusinessDocument.
A SenderParty is a party responsible for sending a business document at a business application level. The SenderParty is of type GDT: BusinessDocumentMessageHeaderParty. The SenderParty can include the elements InternalID, StandardID, and ContactPerson. The SenderParty can be filled by the sending application to name a contact person for problems with the message. This can be particularly useful if an additional infrastructure, for example 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. It can be filled by the sender, for example, if the participating parties are not transferred with the SupplierFreightInvoiceRequest package.
A RecipientParty is a party responsible for receiving a business document at a business application level. The RecipientParty is of type GDT: BusinessDocumentMessageHeaderParty. The RecipientParty can include the 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. 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 in some implementations can be ignored by the receiving application. RecipientParty can be filled by the sender, for example, if the SupplierFreightInvoiceRequest package cannot be used to transfer the participating parties.
The SupplierFreightInvoiceRequest package groups the SupplierFreightInvoiceRequest with its packages. It includes the entity SupplierFreightInvoiceRequest and the package Request. A SupplierFreightInvoiceRequest is a request sent to invoice verification advising that a freight invoice for specified quantities and prices, for example, is expected and/or is to be created through evaluation settlement. The attributes and elements located directly at the SupplierFreightInvoiceRequest entity can include @actioncode and ID. @actioncode is a coded representation of an instruction to a message recipient describing how to process a transmitted element, and is of type GDT: ActionCode. ID is a unique identifier of a SupplierFreightInvoiceRequest and is of type GDT: BusinessTransactionDocumentID. In some implementations, the attribute actioncode can include the two values “01—Create” and “02—Change”. In some implementations, the ID is not changed once a SupplierFreightInvoiceRequest has been created.
A Request package groups the Request with its packages. It includes the entity Request and the packages HeaderInformation, PartyInformation, LocationInformation, TransportationChargesInformation, and ItemInformation. Request is a request sent to invoice verification advising that a freight invoice for specified quantities and prices, in some implementations is expected, and/or is to be created through evaluation settlement. The elements located at the Request entity can include TypeCode and DeliveryTerms. The BusinessTransactionDocumentTypeCode is a coded representation of a document type that occurs in business transactions. The document type describes the (business) nature of similar documents and defines the basic features of this type of documents. It is of type GDT: BusinessTransactionDocumentTypeCode. In some implementations, invoice-related document types are allowed, such as 128 Supplier Invoice Request. DeliveryTerms is a collection of conditions and agreements that apply when delivering ordered goods and providing necessary services and activities. DeliveryTerms is of type GDT: DeliveryTerms, and in some implementations is optional.
HeaderInformation groups dates, total values, documents and references related to a supplier freight invoice request. HeaderInformation includes the entities PurchaseBusinessArea, DateTimePeriod, TotalQuantity, TotalAmount, TextCollection, and BusinessTransactionDocumentReference. A PurchaseBusinessArea is a purchase specific area within an enterprise, for example, a purchasing organisation, and/or a purchasing group. A PurchasingOrganisationID is an identifier for a purchasing organisation, and is of type GDT: OrganisationalCentreID. A PurchasingGroupID is an identifier for a purchasing group and is of type GDT: OrganisationalCentreID, and in some implementations is optional. A DateTimePeriod specifies a date, time and/or period related to a SupplierFreightInvoiceRequest.
A PartyInformation package includes information regarding a party of a supplier freight invoice request, for example an invoicing party. It includes the entity Party. Party includes the entity BusinessTransactionDocumentReference. The LocationInformation package includes information regarding a location relevant for a supplier freight invoice request, for example a Ship-from location. LocationInformation includes the entity Location. The TransportationChargesInformation package includes information regarding a transportation charge calculation specific to components related to the SupplierFreightInvoiceRequest. It includes the entity TransportationChargesInformation.
The TransportationChargesInformation entity defines a relationship between transportation charges and an origin of those charges. It includes the entity TransportationCharges. A TransportationChargesUsageCode is a coded representation of the usage of the TransportationCharges. The usage points out if subsequent information represents a revenue- or cost-view on transportation charges. TransportationChargesUsageCode is of type GDT: TransportationChargesUsageCode. A SupplierFreightInvoiceRequestItemID is a unique identifier of an Item in a SupplierFreightInvoiceRequest. SupplierFreightInvoiceRequestItemID is of type GDT: BusinessTransactionDocumentItemID and in some implementations is optional. A TransportationDocumentInformationID is a unique identifier of a Transportation Document Information. TransportationDocumentInformationID is of type GDT: TransportationDocumentInformationID and in some implementations is optional.
A TransportationDocumentInformationTransportationUnitResourceID is a unique identification of a TransportationUnitResource in assigned transportation document information. It is of type GDT: ResourceInformationID and in some implementations is optional. A TransportationDocumentInformationPackagingID is a unique identification of a Packaging in assigned transportation document information. TransportationDocumentInformationPackagingID is of type GDT: PackageInformationID and is optional. A TransportationDocumentInformationTransportationStageID is a unique identification of a TransportationStage in assigned transportation document information. TransportationDocumentInformationTransportationStageID is of type GDT: TransportationStageID and in some implementations is optional. In case none of the IDs is maintained, the transportation charges can be related to an entire supplier freight invoice request.
The Item package includes information regarding items of a supplier freight invoice request and it includes the Transportation Document Information package with additional information of assigned transportation documents. It includes the entity Item, and the package TransportationDocumentInformation. The SupplierFreightInvoiceRequest item specifies cost components for a supplier freight invoicing and information that the cost components are based on. This includes information regarding assigned transportation documents. An ID is a unique identifier of an item in a SupplierFreightInvoiceRequest and is of type GDT: BusinessTransactionDocumentItemID. A TypeCode, namely, the BusinessTransactionDocumentItemTypeCode, is a coded representation of an item type in a document that occurs in business transactions. It is of type GDT: BusinessTransactionDocumentItemTypeCode.
A Transportation Document Information package includes information of assigned transportation documents that form a basis of a supplier freight invoice. It includes the entity TransportationDocumentInformation and the packages HeaderInformation, PartyInformation, LocationInformation, TransportationStageInformation, TransportationUnitResourceInformation, PackageInformation and TransportationDocumentItemInformation. A TransportationDocumentInformation includes information of an assigned transportation document that forms a basis of a supplier freight invoice. ID is a unique identifier of a TransportationDocumentInformation and is of type GDT: TransportationDocumentInformationID. BusinessTransactionDocumentID is a unique identifier of a Transportation Document, for example a Shipment Order and Freight Order. It is of type GDT: BusinessTransactionDocumentID and in some implementations is optional. A BusinessTransactionDocumentTypeCode is a coded representation of a document type that occurs in business transactions. The document type describes the (business) nature of similar documents and defines the basic features of this type of document. It is of type GDT: BusinessTransactionDocumentTypeCode and in some implementations is optional. DeliveryTerms is a collection of conditions and agreements that can apply when delivering ordered goods and providing necessary services and activities. It is of type GDT: DeliveryTerms and in some implementations is optional.
A HeaderInformation groups dates, total values, documents and references related to assigned transportation document information. It includes the entities DateTimePeriods, TotalQuantity, TotalAmount, TextCollection, TransportationServiceRequirement, BusinessTransactionDocumentReference, and NatureOfCargo. The PartyInformation package includes information regarding a party of assigned transportation document information, for example a customer, and/or supplier. It includes the entity Party. Party includes the entity BusinessTransactionDocumentReference. The LocationInformation package includes information regarding a location relevant to assigned transportation document information, for example a Ship-from location. It includes the entity Location.
A TransportationStageInformation package includes information regarding a stage of assigned transportation document information. A stage represents a section of a transport. It includes the entity TransportationStage. TransportationStage specifies details related to a stage of a transport which are part of assigned transportation document information. TransportationStage includes the entities Location, BusinessTransactionDocumentReference, and TransportationServiceRequirement.
The TransportationUnitResourceInformation package includes information regarding a transportation unit resource that is relevant for assigned transportation document information, for example a container. It includes the entity TransportationUnitResourceInformation. TransportationUnitResourceInformation includes information on one or more transportation unit resources, such as resource type and related properties (e.g., related measures or handling instructions). A Transportation Unit Resource is a unit into which goods are loaded and/or from which goods are unloaded. This unit can provide transportation capacity for goods, but in some implementations may not move by itself The unit includes the entities TransportationDocumentInformationTransportationStageAssignment, AttachedEquipment, Quantity, Seal, BusinessTransactionDocumentReference and DangerousGoods.
A TransportationDocumentInformationTransportationStageAssignment specifies an assignment of a transportation stage to a transportation unit resource information. TransportationDocumentInformationTransportationStageID is a unique identifier of a TransportationStage of assigned transportation document information. It is of type GDT: TransportationStageID. AttachedEquipment specifies an equipment that is attached to a TransportationUnitResource. The structure can include TransportationDocumentInformationResourceInformationID, a unique identifier of a resource in assigned transportation document information. It is of type GDT: ResourceInformationID.
The PackageInformation package includes information regarding the packages of the goods that are to be transported in the assigned transportation document information. It includes the entity PackageInformation. PackageInformation describes package information related to an assigned transportation document information. It includes the entities TransportationDocumentInformationItemAssignment, TransportationDocumentInformationTransportationUnitResourceInformationAssignment, and Quantity.
TransportationDocumentInformationItemAssignment specifies an assignment of a packaging to an item of an assigned transportation document information with corresponding information on quantities. TransportationDocumentInformationItemAssignment includes the entity Quantity. The structure can include TransportationDocumentInformationItemID, a unique identifier of an item of assigned transportation document information. TransportationDocumentInformationItemID is of type GDT: TransportationDocumentInformationItemID. TransportationDocumentInformationTransportationUnitResourceInformationAssignment specifies an assignment of a packaging to a TransportationUnitResourceInformation of an assigned transportation document information with corresponding quantity information. TransportationDocumentInformationResourceInformationID is a unique identifier of a TransportationUnitResource and is of type GDT: ResourceInformationID.
The TransportationDocumentInformationItem package includes information regarding products included in assigned transportation document information and additional information on these products. It includes the entity TransportationDocumentInformationItem and the packages ItemInformation, LocationInformation, and TransportGoodsInformation. TransportationDocumentInformationItem specifies products included in an assigned transportation document information and additional information about these products. The structure can include ID, BusinessTransactionDocumentItemID, OriginCountryCode, DestinationCountryCode, ShippingTypeCode, HaulageArrangerCode, TemperatureMeasureInterval, TransportationHandlingInstructionCode, and TransportationHandlingInstructionNote. ID is a unique identifier of an Item in assigned transportation document information and is of type GDT: TransportationDocumentInformationItemID. BusinessTransactionDocumentItemID is a unique identifier of a Transportation Document Item, for example a Shipment Order Item. BusinessTransactionDocumentItemID is of type GDT: BusinessTransactionDocumentItemID and in some implementations is optional. OriginCountryCode is the country of origin of goods that are considered in a shipment request. OriginCountryCode is of type GDT: CountryCode with a Qualifier: Origin, and in some implementations is optional.
DestinationCountryCode is the ultimate country of destination of goods that are considered in a shipment request. DestinationCountryCode is of type GDT: CountryCode and has a Qualifier: Destination, and in some implementations is optional. ShippingTypeCode is a coded representation of a shipping type. A shipping type specifies how planning and execution of a transportation can be performed, whereas transportation terms can include detailed specifications on agreed means of transportation, for example, shipping/transport type and means of transport to be used. ShippingTypeCode is of type GDT: ShippingTypeCode and in some implementations is optional. HaulageArrangerCode is a coded representation of an arranger of a haulage. Haulage is an inland transportation of cargo. Haulage is of type GDT: HaulageArrangerCode and in some implementations, is optional. TemperatureMeasureInterval is an interval of temperature measures defined by a lower and an upper boundary and a measure type code. TemperatureMeasureInterval is of type GDT: MeasureInterval and has a Qualifier: Temperature, and in some implementations is optional. TransportationHandlingInstructionCode is a coded representation of a transportation handling instruction. TransportationHandlingInstructionCode is of type GDT: TransportationHandlingInstructionCode, and in some implementations is optional. TransportationHandlingInstructionNote is a note regarding a transportation handling instruction. It is of type GDT: TransportationHandlingInstructionNote, and in some implementations is optional. A constraint can, in some implementations, exist that for a measure related to temperature, the units of measurement Celsius and Fahrenheit are allowed.
The TransportationDocumentItemInformation package specifies products included in an assigned transportation document information and additional information related to transportation of these products. TransportationDocumentItemInformation includes the entities Amount, TextCollection, NatureOfCargo, Quantity, BusinessTransactionDocumentReference, DangerousGoods, TransportationDocumentInformationTransportationStageAssignment, TransportationDocumentInformationTransportationUnitResourceInformationAssignment, Location, and ProductInformation.
DangerousGoods specifies the identification, description and classification of dangerous goods related to an item of an assigned transportation document information. It includes the entities Quantity, TextCollection, and TransportationDocumentInformationTransportationUnitResourceInformationAssignment. TransportationDocumentInformationTransportationUnitResourceInformationAssignment specifies an assignment of dangerous goods of an assigned transportation document information item to a TransportationUnitResource with corresponding quantity information. TransportationDocumentInformationTransportationUnitResourceInformationAssignment includes the entity Quantity. The structure can include TransportationDocumentInformationResourceInformationID, a unique identifier of a TransportationUnitResource, which is of type GDT: ResourceInformationID.
The TransportationDocumentInformationStageAssignment specifies an assignment of assigned transportation document information item to a transportation stage with corresponding quantity information. The structure can include TransportationDocumentInformationTransportationStageID, a unique identifier of a TransportationStage. TransportationDocumentInformationTransportationStageID is of type GDT: TransportationStageID. A TransportationDocumentInformationTransportationUnitResourceInformationAssignment specifies an assignment of assigned transportation document information item to a transportation unit resource information with corresponding quantity information. It includes the entity Quantity. The structure can include TransportationDocumentInformationResourceInformationID, a unique identifier of a TransportationUnitResource information, which is of type GDT: ResourceInformationID.
The LocationInformation package includes information regarding a location that is related to an item of an assigned transportation document information. The LocationInformation package includes the entity Location. A TransportationGoodsInformation package groups information on goods that are to be transported according to a transportation document information item. The TransportationGoodsInformation package includes the entity ProductInformation. 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.
The message data type SupplierFreightInvoiceRequestCancelRequestMessage groups together business information that is relevant for sending a business document in a message, and a SupplierFreightInvoiceRequest object in a business document. SupplierFreightInvoiceRequestCancelRequestMessage includes the packages BusinessDocumentMessageHeader and SupplierFreightInvoiceRequest. A MessageHeader package groups together business information that is relevant for sending a business document in a message. The MessageHeader package includes the entity MessageHeader.
A MessageHeader groups together business information from the 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 is divided up into the following entities: SenderParty and RecipientParty. MessageHeader is of type GDT: BusinessDocumentMessageHeader. The MessageHeader can include the following elements: ID, ReferenceID, and CreationDateTime. The MessageID can be set by the sending application.
With the ReferencedMessageID, reference is made in the current BusinessDocument to a previous BusinessDocument. A SenderParty is a party responsible for sending a business document at a business application level. The SenderParty is of type GDT: BusinessDocumentMessageHeaderParty. The SenderParty can include 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. This is particularly useful if an additional infrastructure, for example a marketplace, is located between the sender and the recipient.
The SenderParty is used to transfer the message and can be ignored by the receiving application. It can be filled by the sender, particularly if the participating parties are not transferred with the SupplierFreightInvoiceRequest package. A RecipientParty is a party responsible for receiving a business document at a business application level. The RecipientParty is of type GDT: BusinessDocumentMessageHeaderParty. The RecipientParty can include 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. This is particularly useful if an additional infrastructure, for example a marketplace, is located between the sender and the recipient. The RecipientParty is used to transfer a message and can be ignored by the receiving application. RecipientParty can be filled by the sender if the SupplierFreightInvoiceRequest package cannot be used to transfer the participating parties.
The SupplierFreightInvoiceRequest package groups together information about the SupplierFreightInvoiceRequest. SupplierFreightInvoiceRequest includes the entity SupplierFreightInvoiceRequest and the package BusinessTransactionDocumentReference. A SupplierFreightInvoiceRequest is a request sent to invoice verification advising that a freight invoice for specified quantities and prices is expected, and/or is to be created through evaluation settlement. The attributes and elements located directly at the SupplierFreightInvoiceRequest entity can include ID, which is a unique identifier of a SupplierFreightInvoiceRequest. ID is of type GDT: BusinessTransactionDocumentID.
The Request package groups a Request with its packages. The Request package includes the entity Request and the package BusinessTransactionDocumentReference. A Request is a request sent to invoice verification advising that a freight invoice for specified quantities and prices is expected, and/or is to be created through evaluation settlement. The structure can include RequestedCancellationDate, a requested date for a cancellation. RequestedCancellationDate is of type GDT: Date and has a Qualifier: Cancellation, and in some implementations, is optional. A BusinessTransactionDocumentReference package groups references to business documents. It includes the entities BusinessTransactionDocumentReference.
The message data type SupplierFreightInvoiceRequestConfirmationMessage includes business information that is relevant for sending a business document in a message and/or SupplierFreightInvoiceRequest included in a business document. The message data type SupplierFreightInvoiceRequestConfirmationMessage provides a structure for the message type SupplierFreightInvoiceRequestConfirmationMessage and for interfaces that are based on it.
A MessageHeader package groups together business information that is relevant for sending a business document in a message. It includes the entity MessageHeader. A MessageHeader groups together business information from the 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 is divided up into the following entities: SenderParty and RecipientParty. MessageHeader is of type GDT: BusinessDocumentMessageHeader. The MessageHeader can include the elements ID, ReferenceID, and CreationDateTime. The MessageID can be set by the sending application. With the ReferencedMessageID, reference is made in the current BusinessDocument to a previous BusinessDocument.
A SenderParty is a party responsible for sending a business document at a business application level. The SenderParty is of type GDT: BusinessDocumentMessageHeaderParty. The SenderParty can include the elements InternalID, StandardID, and ContactPerson. The SenderParty can be filled by a sending application to name a contact person for problems with a message. This is particularly useful if an additional infrastructure, for example, a marketplace, is located between the sender and the recipient.
The SenderParty is used to transfer a message and can be ignored by the receiving application. SenderParty can be filled by the sender, particularly if the participating parties are not transferred with the SupplierFreightInvoiceRequest package. A RecipientParty is a party responsible for receiving a business document at a business application level. The RecipientParty is of type GDT: BusinessDocumentMessageHeaderParty. The RecipientParty includes the elements InternalID, StandardID, and ContactPerson. The RecipientParty can be filled by a sending application to name a contact person for problems that occur with the message. This is particularly useful if an additional infrastructure, for example a marketplace, is located between the sender and the recipient. The RecipientParty is used to transfer a message and can be ignored by the receiving application. RecipientParty can be filled by the sender if the SupplierFreightInvoiceRequest package cannot be used to transfer the participating parties.
The SupplierFreightInvoiceRequest package groups a SupplierFreightInvoiceRequest together with its packages. It includes the entity SupplierFreightInvoiceRequest and the package Confirmation. A SupplierFreightInvoiceRequest is a request sent to invoice verification advising that a freight invoice for specified quantities and prices is expected and can be created through evaluation settlement. A Confirmation package is part of a SupplierFreightInvoiceRequest which confirms Supplier Freight Invoice Request. The Confirmation package includes the entity Confirmation and the package InvoiceDocumentReference. A Confirmation is part of a SupplierFreightInvoiceRequest which confirms Supplier Freight Invoice Request. The elements located directly at the Confirmation entity can include AcceptanceStatusCode. The AcceptanceStatusCode is a coded representation of a status of an acceptance by a communication partner regarding a business transaction that has been transmitted to that partner. It is of type GDT: AcceptanceStatusCode. A InvoiceDocumentReference package groups references to invoice documents.
The InvoiceDocumentReference package includes the entity InvoiceDocumentReference. InvoiceDocumentReference specifies an invoice document reference that is related to a supplier freight invoice request. InvoiceDocumentReference includes the entity DateTimePeriod. DateTimePeriod specifies date, time and/or period information related to an InvoiceDocumentReference.
The TransportationBookingRequest interfaces are part of the Shipper and Transportation Service Provision scenarios. They are used, for example, to exchange agreements and the corresponding confirmations and receipt notifications to provide transportation services from an ordering party to another party.
An ordering party can request a receipt notification from the transportation service provider to assure that the transportation service provider has received the TransportationBookingRequest and that it did not include any errors.
At a later time, the transportation service provider can send a confirmation to the ordering party to confirm the transportation booking request. The confirmation can be an acceptance of the TransportationBookingRequest with its transport and carriage conditions (if any), a rejection if the transportation service provider cannot ensure the transport service, and/or conditionally accepted in case the transportation service provider generally accepts the request, but sends more information about the way the requested transportation service is intended to be fulfilled (i.e., the transport details).
The transportation service provider can request a receipt notification from the ordering party about a TransportationBookingRequestConfirmation.
The information of the TransportationBookingRequest are on a rough level. It can be expected, that at a later time a ShipmentRequest can follow a confirmed TransportationBookingRequest with more detailed information.
A TransportationBookingRequestRequest is an ordering party's request to a transportation service provider to book a transportation service. It can also be an update to a previously received TransportationBookingRequest. The structure of the TransportationBookingRequestRequest is specified by the message data type TransportationBookingRequestRequestMessage.
A TransportationBookingRequestCancelRequest is a cancellation of an ordering party's request to a transportation service provider to cancel the booking of a transportation service. The structure of the TransportationBookingRequestCancelRequest is specified by the message data type TransportationBookingRequestCancelRequestMessage.
A TransportationBookingRequestConfirmation is the confirmation of the TransportationBookingRequest from the transportation service provider to the ordering party. Through the confirmation, a TransportationBookingRequest can be Accepted, Rejected, and/or Conditionally Accepted. The confirmation can include information on the transport and carriage conditions such as carrier, mode of transport, stages, to name a few examples. The confirmation can also be related to a part of the transportation booking request, for example, in case of a split scenario. The structure of the TransportationBookingRequestConfirmation is specified by the message data type TransportationBookingRequestConfirmationMessage.
A TransportationBookingRequestReceiptNotification is a message from a transportation service provider to an ordering party confirming the receipt of a message and reporting any administrative errors included in the previous TransportationBookingRequestRequest message. The structure of the TransportationBookingRequestReceiptNotification is specified by the message data type TransportationBookingRequestReceiptNotificationMessage.
A TransportationBookingRequestConfirmationReceiptNotification is a message from a transportation service provider to an ordering party confirming the receipt of the message and/or reporting any administrative errors included in the previous TransportationBookingRequestConfirmationMessage. The structure of the TransportationBookingRequestConfirmationReceiptNotification is specified by the message data type TransportationBookingRequestConfirmationReceiptNotificationMessage.
The transportation booking request messages can be implemented by ten message interfaces (five on the ordering party side and five on the transportation service provider side). The Ordering Party side can include TransportationBookingRequestRequest_Out, TransportationBookingRequestCancelRequest_Out, TransportationBookingRequestConfirmation_In, TransportationBookingRequestReceiptNotification_In, and/or TransportationBookingRequestConfirmationReceiptNotification_Out. The Transportation Service Provider side can include TransportationBookingRequestRequest_In, TransportationBookingRequestCancelRequest_In, TransportationBookingRequestConfirmation_Out, TransportationBookingRequestReceiptNotification_Out, and/or TransportationBookingRequestConfirmationReceiptNotification_In.
The message choreography of
An “Ordering Party” system 63000 can request a transportation booking, or update a previous request, using a TransportationBookingRequestRequest message 63004 as shown, for example in
The “Ordering Party” system 63000 can request the cancellation of a transportation booking request using a TransportationBookingRequestCancelRequest message 63006 as shown, for example, in
The “Transportation Service Provider” system 63002 can confirm the transportation booking request using a TransportationRequestConfirmation message 63010 as shown, for example, in
Additionally,
Additionally,
Additionally,
Additionally,
The message data type TransportationBookingRequestRequestMessage includes the business information that is relevant for sending a business document in a message, and/or the TransportationBookingRequest included in the business document. It includes the packages MessageHeader and TransportationBookingRequest. The message data type TransportationBookingRequestRequestMessage provides a structure for the message type TransportationBookingRequestRequestMessage and interfaces that are based on it.
A MessageHeader package can be included with this message data type. The TransportationBookingRequest package groups the TransportationBookingRequest with its packages. It includes the entity TransportationBookingRequest and the package Request.
TransportationBookingRequest is a request from an ordering party to another party to book transportation services. A corresponding confirmation to the ordering party is part of the TransportationBookingRequest. The attributes and elements located at the TransportationBookingRequest entity can include @actioncode and ID. @actioncode is a coded representation of an instruction to the message recipient telling it how to process the transmitted element. It is of type GDT: ActionCode. ID is a unique identifier of a TransportationBookingRequest, and is of type GDT: BusinessTransactionDocumentTypeCode. In some implementations, the attribute actioncode can include the two values 01—Create and 02—Change. In some implementations, the ID can not be changed once a TransportationBookingRequest has been created. In some implementations, the Complete Transmission Indicator (CTI) might not be included as it can always be set to true, such that there may be no delta transmissions, and the complete message content can be transmitted in every message. In some implementations, if an item is missing in the message, the corresponding item can be deleted.
The Request package groups the Request with its packages. It includes the entity Request and the packages HeaderInformation, TransportationChargesInformation, GovernmentalRequirementInformation, PartyInformation, LocationInformation, TransportationStageInformation, TransportationUnitResourceInformation, PackageInformation, and Item.
A message data type TransportationBookingRequestCancelMessage groups together the business information that is relevant for sending a business document in a message and the TransportationBookingRequest object in the business document. It includes the packages BusinessDocumentMessageHeader and TransportationBookingRequest.
A MessageHeader package can be included with this message data type. The TransportationBookingRequest package groups together information about the TransportationBookingRequest. It includes the entity TransportationBookingRequest. It includes the package BusinessTransactionDocumentReference.
TransportationBookingRequest is a request from an ordering party to another party to book transportation services. A corresponding confirmation to the ordering party is part of the TransportationBookingRequest. The attributes and elements located directly at the TransportationBookingRequest entity can include ID, which is a unique identifier of a TransportationBookingRequest. ID is of type GDT: BusinessTransactionDocumentID. A Request package can be included with this message data type.
The message data type TransportationBookingRequestConfirmationMessage includes business information that is relevant for sending a business document in a message and the TransportationBookingRequest included in the business document. The message data type TransportationBookingRequestConfirmationMessage provides the structure for the message type TransportationBookingRequestConfirmationMessage and the interfaces that are based on it.
A MessageHeader package can be included with this message data type. The TransportationBookingRequest package groups the TransportationBookingRequest together with its packages. It includes the entity TransportationBookingRequest and the package Confirmation.
TransportationBookingRequest is a request from an ordering party to another party to book transportation services. A corresponding confirmation to the ordering party is part of the TransportationBookingRequest. The confirmation package is a confirmation of a request from an ordering party to another party to book transportation services.
The message data type TransportationBookingRequestReceiptNotificationMessage includes the business information that is relevant for sending a business document in a message and the TransportationBookingRequest included in the business document. The message data type TransportationBookingRequestReceiptNotificationMessage provides the structure for the message type TransportationBookingRequestReceiptNotificationMessage and the interfaces that are based on it.
A MessageHeader package can be included with this message data type. The TransportationBookingRequest package groups the TransportationBookingRequest with its packages. It includes the entity TransportationBookingRequest and the package Request. TransportationBookingRequest is a request from an ordering party to another party to book transportation services. A corresponding confirmation to the ordering party is part of the TransportationBookingRequest. The structure can include ID, which is a unique identifier of a TransportationBookingRequest. ID is of type GDT: BusinessTransactionDocumentID.
Message Data type TransportationBookingRequestConfirmationReceiptNotificationMessage
The message data type TransportationBookingRequestConfirmationReceiptNotificationMessage includes the business information that is relevant for sending a business document in a message and the TransportationBookingRequest included in the business document. The message data type TransportationBookingRequestConfirmationReceiptNotificationMessage provides the structure for the message type TransportationBookingRequestConfirmationReceiptNotificationMessage and the interfaces that are based on it.
A MessageHeader package can be included with this message data type. The TransportationBookingRequest package groups the TransportationBookingRequest with its packages. It includes the entity TransportationBookingRequest, and the package Confirmation. TransportationBookingRequest is a request from an ordering party to another party to book transportation services. A corresponding confirmation to the ordering party is part of the TransportationBookingRequest. The structure can include ID, which is a unique identifier of a TransportationBookingRequest. It is of type GDT: BusinessTransactionDocumentID. The Confirmation package is a confirmation of a request from an ordering party to another party to book transportation services.
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.
