Patent Application
20090327105
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, computer readable medium includes program code for providing a message-based interface for performing a freight order service. The interface exposes at least one service as defined in a service registry. Upon execution, the program code executes in an environment of computer systems providing message-based services. The service comprises program code for receiving, from a service consumer, a first message for processing information representing an order to a transportation service provider to ship goods from shippers to consignees. Program code invokes a freight order business object. The business object is a logically centralized, semantically disjointed object for representing an order to a transportation service provider to ship goods from shippers to consignees. The business object comprises data logically organized as a freight order root node and a date time periods subordinate node. Program code initiates transmission of a message to a heterogeneous second application, executing in the environment of computer systems providing message-based services, based on the data in the freight order business object. The message comprises a freight order execution request message entity, a message header package, and a freight order execution package.
In a second aspect, computer readable medium includes program code for providing a message-based interface for performing a freight order service. The software comprises computer readable instructions embodied on tangible media. Upon execution, the software executes in a landscape of computer systems providing message-based services. The software comprises program code for initiating transmission of a message to a heterogeneous second application, executing in the environment of computer systems providing message-based services, based on data in a freight order business object invoked by the second application. The business object is a logically centralized, semantically disjointed object for representing an order to a transportation service provider to ship goods from shippers to consignees. The business object comprises data logically organized as a freight order root node and a date time periods subordinate node. The message comprises a freight order execution request message entity, a message header package, and a freight order execution package. The software comprises program code for receiving a second message from the second application. The second message is associated with the invoked freight order business object and in response to the first message.
In a third aspect, a distributed system operates in a landscape of computer systems providing message-based services. The system processes business objects involving a freight order. The system comprises memory and a graphical user interface remote from the memory. The memory stores a business object repository storing a plurality of business objects. Each business object is a logically centralized, semantically disjointed object. At least one of the business objects is for representing an order to a transportation service provider to ship goods from shippers to consignees. The business object comprises data logically organized as a freight order root node and a date time periods subordinate node. The graphical user interface presents data associated with an invoked instance of the freight order business object. The interface comprises computer readable instructions embodied on tangible media.
In a fourth aspect, a computer readable medium includes program code for providing a message-based interface for performing a maintenance plan service. The interface exposes at least one service as defined in a service registry. Upon execution, the program code executes in an environment of computer systems providing message-based services. The service comprises program code for receiving, from a service consumer, a first message for processing maintenance plans. Program code invokes a maintenance plan business object. The business object is a logically centralized, semantically disjointed object for representing information used to manage maintenance plans. The service comprises data logically organized as a maintenance plan root node, a scheduling terms subordinate node, a cycles subordinate node, and a maintenance plan item subordinate node. The maintenance plan item node contains an object reference subordinate node, an accounting coding block subordinate node, and an item cycle group assignment subordinate node. Program code initiates transmission of a message to a heterogeneous second application, executing in the environment of computer systems providing message-based services, based on the data in the maintenance plan business object. The message comprises a maintenance plan create confirmation message entity, a message header package, a maintenance plan package, and a log package.
In a fifth aspect, a computer readable medium includes program code for providing a message-based interface for performing a maintenance plan service. The software comprises computer readable instructions embodied on tangible media. Upon execution, the software executes in a landscape of computer systems providing message-based services. The service comprises program code for initiating transmission of a message to a heterogeneous second application, executing in the environment of computer systems providing message-based services, based on data in a maintenance plan business object invoked by the second application. The business object is a logically centralized, semantically disjointed object for representing information used to manage maintenance plans. The business object comprises data logically organized as a maintenance plan root node, a scheduling terms subordinate node, a cycles subordinate node, and a maintenance plan item subordinate node. The maintenance plan item node contains an object reference subordinate node, an accounting coding block subordinate node, and an item cycle group assignment subordinate node. The message comprises a maintenance plan create confirmation message entity, a message header package, a maintenance plan package, and a log package. Program code receives a second message from the second application, the second message associated with the invoked maintenance plan business object and in response to the first message.
In a sixth aspect, a distributed system operates in a landscape of computer systems providing message-based services. The system processes business objects involving a maintenance plan service. The service comprises memory and a graphical user interface remote from the memory. Memory stores a business object repository storing a plurality of business objects. Each business object is a logically centralized, semantically disjointed object and at least one of the business objects is for representing information used to manage maintenance plans. The business object comprises data logically organized as a maintenance plan root node, a scheduling terms subordinate node, a cycles subordinate node, and a maintenance plan item subordinate node. The maintenance plan item node contains an object reference subordinate node, an accounting coding block subordinate node, and an item cycle group assignment subordinate node. The graphical user interface presents data associated with an invoked instance of the maintenance plan business object, the interface comprising computer readable instructions embodied on tangible media.
In a seventh aspect, a computer readable medium includes program code for providing a message-based interface for performing a maintenance task list service. The interface exposes at least one service as defined in a service registry. Upon execution, the program code executes in an environment of computer systems providing message-based services. The service comprises program code for receiving, from a service consumer, a first message for processing maintenance task lists. Program code invokes a maintenance task list business object. The business object is a logically centralized, semantically disjointed object for representing information used to manage maintenance task lists. The business object comprises data logically organized as a maintenance task list root node, an operation subordinate node, a relationship subordinate node, and a material input subordinate node. Program code initiates transmission of a message to a heterogeneous second application, executing in the environment of computer systems providing message-based services, based on the data in the maintenance task list business object. The message comprises a maintenance task list simple by elements response message entity, a maintenance task list package, a processing conditions package, and a log package.
In an eighth aspect, a computer readable medium includes program code for providing a message-based interface for performing a maintenance task list service. The software comprises computer readable instructions embodied on tangible media. Upon execution the software executes in a landscape of computer systems providing message-based services. The service comprises program code for initiating transmission of a message to a heterogeneous second application, executing in the environment of computer systems providing message-based services, based on data in a maintenance task list business object invoked by the second application. The business object is a logically centralized, semantically disjointed object for representing information used to manage maintenance task lists. The business object comprises data logically organized as a maintenance task list root node, an operation subordinate node, a relationship subordinate node, and a material input subordinate node. The message comprises a maintenance task list simple by elements response message entity, a maintenance task list package, a processing conditions package, and a log package. Program code receives a second message from the second application, the second message associated with the invoked maintenance task list business object and in response to the first message.
In a ninth aspect, a distributed system operates in a landscape of computer systems providing message-based services. The system processes business objects involving a maintenance task list service. The service comprises memory and a graphical user interface remote from the memory. Memory stores a business object repository storing a plurality of business objects. Each business object is a logically centralized, semantically disjointed object and at least one of the business objects is for representing information used to manage maintenance task lists. The business object comprises data logically organized as a maintenance task list root node, an operation subordinate node, a relationship subordinate node, and a material input subordinate node. The graphical user interface presents data associated with an invoked instance of the maintenance task list business object, the interface comprising computer readable instructions embodied on tangible media.
In a tenth aspect, computer readable medium includes program code for providing a message-based interface for performing a request for supplier freight quote service. The interface exposes at least one service as defined in a service registry. Upon execution, the program code executes in an environment of computer systems providing message-based services. The service comprises program code for receiving, from a service consumer, a first message for processing information for requesting a freight quote from a supplier, including terms and conditions of a transportation service and bidding rules of the tendering process. Program code invokes a request for a supplier freight quote business object. The business object is a logically centralized, semantically disjointed object for representing information for requesting a freight quote from a supplier, including terms and conditions of a transportation service and bidding rules of the tendering process. The business object comprises data logically organized as a request for supplier freight quote root node and at least one subordinate node, including a nature of cargo subordinate node, each subordinate node having zero or more hierarchically more structured subordinate nodes. Program code initiates transmission of a message to a heterogeneous second application, executing in the environment of computer systems providing message-based services, based on the data in the request for a supplier freight quote business object. The message comprises a request for supplier freight quote request message entity, a message header package, and a request for supplier freight quote package.
In an eleventh aspect, computer readable medium includes program code for providing a message-based interface for performing a request for supplier freight quote service. The software comprises computer readable instructions embodied on tangible media. Upon execution, the software executes in a landscape of computer systems providing message-based services. The software comprises program code for initiating transmission of a message to a heterogeneous second application, executing in the environment of computer systems providing message-based services, based on data in a request for supplier freight quote business object invoked by the second application. The business object is a logically centralized, semantically disjointed object for representing information for requesting a freight quote from a supplier, including terms and conditions of a transportation service and bidding rules of the tendering process. The business object comprises data logically organized as a request for supplier freight quote root node and at least one subordinate node, including a nature of cargo subordinate node, each subordinate node having zero or more hierarchically more structured subordinate nodes. The message comprises a request for supplier freight quote request message entity, a message header package, and a request for supplier freight quote package. The software comprises program code for receiving a second message from the second application. The second message is associated with the invoked request for supplier freight quote business object and in response to the first message.
In a twelfth aspect, a distributed system operates in a landscape of computer systems providing message-based services. The system processes business objects involving a request for supplier freight quote. The system comprises memory and a graphical user interface remote from the memory. The memory stores a business object repository storing a plurality of business objects. Each business object is a logically centralized, semantically disjointed object. At least one of the business objects is for representing information for requesting a freight quote from a supplier. The business object comprises data logically organized as a request for supplier freight quote root node and at least one subordinate node, including a nature of cargo subordinate node, each subordinate node having zero or more hierarchically more structured subordinate nodes. The graphical user interface presents data associated with an invoked instance of the request for supplier freight quote business object. The interface comprises computer readable instructions embodied on tangible media.
In a thirteenth aspect, computer readable medium includes program code for providing a message-based interface for performing a supplier freight quote service. The interface exposes at least one service as defined in a service registry. Upon execution, the program code executes in an environment of computer systems providing message-based services. The service comprises program code for receiving, from a service consumer, a first message for processing information for transportation services tendered between transportation service providers, including quoted services in response to a request for a supplier freight quote. Program code invokes a supplier freight quote business object. The business object is a logically centralized, semantically disjointed object for representing information for transportation services tendered between transportation service providers, including quoted services in response to a request for a supplier freight quote. The business object comprises data logically organized as a supplier freight quote root node and at least one subordinate node, including a nature of cargo subordinate node, each subordinate node having zero or more hierarchically more structured subordinate nodes. Program code initiates transmission of a message to a heterogeneous second application, executing in the environment of computer systems providing message-based services, based on the data in the supplier freight quote business object. The message comprises a supplier freight quote request message entity, a message header package, and a supplier freight quote package.
In a fourteenth aspect, computer readable medium includes program code for providing a message-based interface for performing a supplier freight quote service. The software comprises computer readable instructions embodied on tangible media. Upon execution, the software executes in a landscape of computer systems providing message-based services. The software comprises program code for initiating transmission of a message to a heterogeneous second application, executing in the environment of computer systems providing message-based services, based on data in a supplier freight quote business object invoked by the second application. The business object is a logically centralized, semantically disjointed object for representing information for transportation services tendered between transportation service providers, including quoted services in response to a request for a supplier freight quote. The business object comprises data logically organized as a supplier freight quote root node and at least one subordinate node, including a nature of cargo subordinate node, each subordinate node having zero or more hierarchically more structured subordinate nodes. The message comprises a supplier freight quote request message entity, a message header package, and a supplier freight quote package. The software comprises program code for receiving a second message from the second application. The second message is associated with the invoked supplier freight quote business object and in response to the first message.
In a fifteenth aspect, a distributed system operates in a landscape of computer systems providing message-based services. The system processes business objects involving a supplier freight quote. The system comprises memory and a graphical user interface remote from the memory. The memory stores a business object repository storing a plurality of business objects. Each business object is a logically centralized, semantically disjointed object. At least one of the business objects is for representing information for transportation services tendered between transportation service providers, including quoted services in response to a request for a supplier freight quote. The business object comprises data logically organized as a supplier freight quote root node and at least one subordinate node, including a nature of cargo subordinate node, each subordinate node having zero or more hierarchically more structured subordinate nodes. The graphical user interface presents data associated with an invoked instance of the supplier freight quote business object. The interface comprises computer readable instructions embodied on tangible media.
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. 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)™ 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.
As depicted in
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.
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.
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.
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.
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.
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.
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.
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.
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.
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
Relationships describe the interdependencies of the entities in the business object model, and are thus an integral part of the business object model.
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
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
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
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
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.
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 freight order can be an order to a transportation service provider to ship goods from shippers to consignees. A freight order can be a combination of shipment orders, which can be assigned to stages and resources. The combination can be based on transportation planning or transportation charges calculations. The freight order execution interface can be used to delegate execution of planned transportation of goods (from shippers to consignees) to transportation execution processing of an ERP (Enterprise Resource Planning) system. The freight order invoicing preparation interface can be used for preparation of invoice verification which can be executed later on.
A FreightOrderExecutionRequest can be a request for a FreightOrderExecution from Transportation Order Processing to Transportation Execution Processing. The structure of the FreightOrderExecutionRequest can be specified by the message data type FreightOrderExecutionRequestMessage.
A FreightOrderExecutionCancelRequest can be a request to cancel a FreightOrderExecution. The structure of the FreightOrderExecutionCancelRequest can be specified by the message data type FreightOrderExecutionCancelRequestMessage.
A FreightOrderExecutionConfirmation can be a confirmation of the FreightOrderExecutionRequest from Transportation Execution Processing to Transportation Order Processing. Through the confirmation, a FreightOrderExecutionRequest can be accepted, rejected, or conditionally accepted. The confirmation can include information on transport and carriage conditions, such as carrier, mode of transport, or stages. The confirmation can be related to a part of the FreightOrderExecution, in the case of a split scenario. The structure of the FreightOrderExecutionConfirmation can be specified by the message data type FreightOrderExecutionConfirmationMessage.
A FreightOrderExecutionStatusNotification can be a message from Transportation Execution Processing to Transportation Order Processing, confirming a receipt of a FreightOrderExecutionRequest message or of a FreightOrderExecutionCancelRequest message, and reporting administrative errors included in the received message. The structure of the FreightOrderExecutionStatusNotification can be specified by the message data type FreightOrderExecutionStatusNotification Message.
A FreightOrderInvoicingPreparationRequest can be a request to prepare an invoice verification from transportation order processing to purchase order processing. The structure of the FreightOrderInvoicePreparationRequest can be specified by the message data type FreightOrderInvoicingPreparationRequestMessage.
A FreightOrderInvoicingPreparationCancelRequest can be a request to cancel a FreightOrderInvoicingPreparation from transportation order processing to purchase order processing. The structure of the FreightOrderInvoicingPreparationCancelRequest can be specified by the message data type FreightOrderInvoicingPreparationCancelRequestMessage.
A FreightOrderInvoicingPreparationConfirmation can be a confirmation of the FreightOrderInvoicingPreparation from purchase order processing to transportation order processing. The structure of the FreightOrderInvoicingPreparationConfirmation can be specified by the message data type FreightOrderInvoicingPreparationConfirmationMessage.
The FreightOrderExecution messages can be implemented by the following message interfaces that may be equally distributed on a transportation order processing side and on a transportation execution processing side. In some implementations, only the message interfaces on the Transportation Order Processing side may be implemented in transportation management. The message interfaces on the Transportation Order Processing side include the following: FreightOrderExecutionRequest_Out, FreightOrderExecutionCancelRequest_Out, FreightOrderExecutionConfirmation_In, and FreightOrderExecutionStatusNotification_In.
The FreightOrderInvoicingPreparation messages can be implemented by the following message interfaces that may be equally distributed on the transportation order processing side and on the purchase order processing side. The message interfaces on the Transportation Order Processing side can include the following: FreightOrderInvoicingPreparationRequest_Out, FreightOrderInvoicingPreparationCancelRequest_Out, and FreightOrderInvoicingPreparationConfirmation_In. The message interfaces on the Purchase Order Processing side can include the following: FreightOrderInvoicingPreparationRequest_In, FreightOrderInvoicingPreparationCancelRequest_In, and FreightOrderInvoicingPreparationConfirmation_Out.
The message choreography of
A “Transportation Ordering Processing” system 32000 can request a freight order execution, using a FreightOrderExecutionRequest message 32004 as shown, for example in
The “Transportation Order Processing” system 32000 can request the cancellation of a freight order execution using a FreightOrderExecutionCancelRequest message 32006 as shown, for example, in
The message choreography of
Additionally,
Additionally,
Additionally,
Additionally,
Additionally,
Additionally,
The message data type FreightOrderExecutionRequestMessage includes business information relevant for sending a business document in a message and the FreightOrderExecution included in a business document. The message data type FreightOrderExecutionRequestMessage includes the MessageHeader and FreightOrderExecution packages. The message data type FreightOrderExecutionRequestMessage can provide a structure for the message type FreightOrderExecutionRequest and for interfaces that are based on it.
A MessageHeader package can group together business information relevant for sending a business document in a message. The MessageHeader package includes the MessageHeader entity. A MessageHeader can group together business information from a perspective of the sending application in order to identify a business document in a message, provide information about the sender, or provide information about the recipient. The MessageHeader can be divided up into the SenderParty and RecipientParty entities. The MessageHeader can be of type GDT: BusinessDocumentMessageHeader. The MessageHeader includes the following elements: ID, ReferenceID, and CreationDateTime. The MessageID can be set by the sending application. With the ReferencedMessageID, reference can be made in the current BusinessDocument to a previous BusinessDocument.
A SenderParty can be a party responsible for sending a business document at a business application level. The SenderParty can be of type GDT: BusinessDocumentMessageHeaderParty. The SenderParty includes the following elements: InternalID, StandardID, and ContactPerson. The SenderParty can be filled by the sending application to name a contact person for problems with the message. A contact person can be useful if an additional infrastructure, such as a marketplace, is located between the sender and the recipient. The SenderParty can be used to transfer the message and can be ignored by the receiving application. SenderParty can be filled by the sender if the participating parties are not transferred with the FreightOrderExecution Package.
A RecipientParty can be a party responsible for receiving a business document at a business application level. The RecipientParty can be of type GDT: BusinessDocumentMessageHeaderParty. The RecipientParty includes the following elements: InternalID, StandardID, and ContactPerson. The RecipientParty can be filled by the sending application to name a contact person for problems that occur with the message. A contact person can be useful if an additional infrastructure, such as a marketplace, is located between the sender and the recipient. The RecipientParty can be used to transfer a message and can be ignored by the receiving application. In some implementations, RecipientParty may be filled by the sender if the FreightOrderExecution Package cannot be used to transfer the participating parties.
The FreightOrderExecution package can group the FreightOrderExecution with its packages. The FreightOrderExecution package includes the FreightOrderExecution entity and the Request package. The FreightOrderExecution interface can be used to delegate execution of planned transportation of goods, from shippers to consignees, to transportation execution processing of an ERP system. The attributes and elements located directly at the FreightOrder entity can include @actioncode and ID. The @actioncode attribute can be a coded representation of an instruction to a message recipient describing how to process a transmitted element. The @actioncode attribute can be based on GDT: ActionCode. ID can be a unique identifier of a FreightOrder. ID can be based on GDT: BusinessTransactionDocumentID. In some implementations, the attribute @actioncode may include the two values “01—Create” and “02—Change”. In some implementations, the ID might not be changed once a FreightOrder has been created. In some implementations, the Complete Transmission Indicator may be set to true (i.e., the complete message content may be transmitted in every message). As a consequence, previously transferred data that is not sent with the change message may be deleted.
The Request package can group a Request with its packages. The Request package includes the Request entity. The Request package includes the following packages: HeaderInformation, GovernmentalRequirementInformation, PartyInformation, TransportationStageInformation, TransportationUnitResourceInformation, TransportationChargesInformation, and ShipmentOrder. Request can be an agreement between a transportation service provider and an ordering party on transportation of goods from a single ship-from party to a single ship-to party in accordance with agreed terms and conditions.
The HeaderInformation package can group dates, total values, document and references related to a freight order. The HeaderInformation package includes the following entities: DateTimePeriods, NatureOfCargo, TotalQuantity, TotalAmount, TextCollection, and BusinessTransactionDocumentReference.
DateTimePeriods can specify a requested and an acceptable date, time and period applying to a shipment request (e.g. date and time of document issue). A requested period can be a period in which an event is requested to take place. An acceptable period can be a period in which an event may take place at an earliest start date/time to a latest end date/time. The elements located directly at the DateTimePeriods entity can include the following: RequestedFulfillmentPeriod, AcceptableFulfillmentPeriod, and PeriodRoleCode. RequestedFulfillmentPeriod can be a period which is requested depending on semantics of the PeriodRoleCode. RequestedFulfillmentPeriod can be based on GDT: DATETIMEPERIOD, Qualifier: RequestedFulfillment. AcceptableFulfillmentPeriod can be a period which is acceptable depending on semantics of the PeriodRoleCode. AcceptableFulfillmentPeriod can be based on GDT: DATETIMEPERIOD, Qualifier: AcceptableFulfillment. PeriodRoleCode can be a coded representation of business semantics of two periods defined by the entities RequestedFulfillmentPeriod and AcceptableFulfillmentPeriod. PeriodRoleCode can be based on GDT: PeriodRoleCode. In some implementations, RequestedFulfillmentPeriod and AcceptableFulfillmentPeriod are optional, but in every instance one of them can be filled.
NatureOfCargo can indicate a nature of cargo related to a shipment request (e.g., palletized, containerized, documents). The structure of NatureOfCargo includes the ClassificationCode element. ClassificationCode can be a coded representation of a classification of a nature of cargo. ClassificationCode can be based on GDT: NatureOfCargoClassificationCode.
TotalQuantity can specify a total quantity which is related to a whole shipment request (e.g., total number of equipment, total number of items). The structure of TotalQuantity includes the following elements: Quantity, RoleCode, and TypeCode. Quantity can be a non-monetary numerical specification of an amount in a unit of measurement. Quantity can be based on GDT: Quantity. RoleCode can be a coded representation of a role of a quantity. RoleCode can be based on GDT: QuantityRoleCode. TypeCode can be a coded representation of a type of quantity that is based on a measurable characteristic of an object or physical phenomenon. TypeCode can be based on GDT: QuantityTypeCode. In some implementations, QuantityRoleCode and QuantityTypeCode are optional, but in every instance one of them can be filled.
TotalAmount can specify a cumulated monetary amount related to a shipment request (e.g., duty amount, insurance amount, or total value). The structure of TotalAmount includes the Amount and RoleCode elements. Amount can be an amount with a corresponding currency unit. Amount can be based on CDT: Amount. RoleCode can be a coded representation of a role of an amount. RoleCode can be based on GDT: AmountRoleCode. TextCollection can be a group of textual information that relates to a shipment request. The structure of TextCollection includes the TextCollection element. TextCollection can be based on GDT: TextCollection.
BusinessTransactionDocumentReference can specify a business document reference that is related to a whole shipment request. BusinessTransactionDocumentReference includes the DateTimePeriod entity. The structure of BusinessTransactionDocumentReference includes the following elements: BusinessTransactionDocumentReference, BusinessTransactionDocumentRelationshipRoleCode, BusinessTransactionDocumentRelationshipTypeCode, TransportationDocumentTypeCode, TransportationDocumentNote, and TransportationDocumentID. BusinessTransactionDocumentReference can be a unique reference to other business documents or business document items that are of significance within each respective business process.
BusinessTransactionDocumentReference can be based on GDT: BusinessTransactionDocumentReference. BusinessTransactionDocumentRelationshipRoleCode can be a coded representation of a role that a business document or a business document item can have when set against another business document or business document item with a relationship. BusinessTransactionDocumentRelationshipRoleCode can be based on GDT: BusinessTransactionDocumentRelationshipRoleCode. BusinessTransactionDocumentRelationshipTypeCode can be a coded representation of a relationship between two business documents or business document items. BusinessTransactionDocumentRelationshipTypeCode can be based on GDT: BusinessTransactionDocumentRelationshipTypeCode. TransportationDocumentTypeCode can be a coded representation of a documentation type. TransportationDocumentTypeCode can be based on GDT: TransportationDocumentTypeCode. TransportationDocumentNote can be a short Note regarding documentation. TransportationDocumentNote can be based on GDT: SHORT_Note. TransportationDocumentID can be a unique identifier for a transportation document. TransportationDocumentID can be based on GDT: TransportationDocumentID. RelationshipTypeCode and RelationshipRoleCode are both optional. In some implementations, if used, both may be filled. Either the combination BusinessTransactionDocumentReference, BusinessTransactionDocumentRelationshipRoleCode, BusinessTransactionDocumentRelationshipTypeCode, or TransportationDocumentTypeCode, TransportationDocumentNote, TransportationDocumentID can be filled.
DateTimePeriod can specify a date, time and/or period related to a DocumentReference. The structure of the DateTimePeriod entity includes the elements DateTimePeriod and PeriodRoleCode. DateTimePeriod can be a period that is defined by two points in time. DateTimePeriod can be based on GDT: DateTimePeriod. PeriodRoleCode can be a coded representation of business semantics of a period. PeriodRoleCode can be based on GDT: PeriodRoleCode.
GovernmentalProcedureInformation can specify applicable governmental procedures related to import, export and transport of goods of a shipment request. GovernmentalProcedureInformation includes the GovernmentalProcedure entity. GovernmentalProcedure can specify applicable governmental procedures related to import, export and transport of goods of a shipment request. GovernmentalProcedure includes the following entities: Location, DateTimePeriod, Seal, TextCollection, and TransportationDocumentInformation. The structure of GovernmentalProcedure includes the elements TransportationGovernmentAgencyTypeCode, TransportationMovementTypeCode, TransportationGovernmentAgencyInvolvementStatusCode, TransportationGovernmentAgencyActionCode, and TransportationGovernmentAgencyProcedureStatusCode.
TransportationGovernmentAgencyTypeCode can be a coded representation of a type of a government agency. TransportationGovernmentAgencyTypeCode can be based on GDT: TransportationGovernmentAgencyTypeCode. TransportationMovementTypeCode can be a coded representation of a type of a transport movement. Examples can include Import, Export, Transit, and Transshipment. TransportationMovementTypeCode can be based on GDT: TransportationMovementTypeCode. TransportationGovernmentAgencyInvolvementStatusCode can be a coded representation for an involvement status of a transportation related government agency. TransportationGovernmentAgencyInvolvementStatusCode can be based on GDT: TransportationGovernmentAgencyInvolvementStatusCode. TransportationGovernmentAgencyActionCode can be a coded representation of an action of a transportation related government agency. TransportationGovernmentAgencyActionCode can be based on GDT: TransportationGovernmentAgencyActionCode. TransportationGovernmentAgencyProcedureStatusCode can be a coded representation of a status of a procedure related to a transportation government agency. TransportationGovernmentAgencyProcedureStatusCode can be based on GDT: TransportationGovernmentAgencyProcedureStatusCode.
The PartyInformation package includes information regarding a party of a freight order (i.e., Shipper, Carrier, Agent). The PartyInformation package includes the Party entity. Party includes information exchanged, in accordance with common business understanding, in business documents about a party involved in business transactions. This information can be used to identify the party and the party's address, as well as the party's contact person and the contact person's address. This identification can take place using an internal ID, a standardized ID, or IDs assigned by the parties involved.
The Party entity includes the following entities: Amount, DateTimePeriods, TransportationDocumentInformation, and BusinessTransactionDocumentReference. The structure of Party includes the Party, RoleCode and FormattedName elements. A Party includes information exchanged, in accordance with common business understanding, in business documents, about a party involved in business transactions. This information can be used to identify the party and the party's address, as well as the party's contact person and the contact person's address. This identification can take place using an internal ID, a standardized ID, or IDs assigned by the parties involved. Party can be based on GDT: BusinessTransactionDocumentParty. RoleCode can be a coded representation of a PartyRoleCode which specifies which rights and obligations a party has regarding a business object and corresponding processes. In some implementations, PartyRole is assigned to a PartyRoleCategory and refines its semantics. RoleCode can be based on GDT: PartyRoleCode. FormattedName can be a formatted name of a party. FormattedName can be based on GDT: LONG Name, Qualifier: PartyFormatted.
BusinessTransactionDocumentReference can specify a business document reference that is related to a whole shipment request. BusinessTransactionDocumentReference includes the DateTimePeriod entity. The structure of BusinessTransactionDocumentReference includes the following elements: BusinessTransactionDocumentReference, BusinessTransactionDocumentRelationshipRoleCode, BusinessTransactionDocumentRelationshipTypeCode, TransportationDocumentTypeCode, TransportationDocumentNote, and TransportationDocumentID. BusinessTransactionDocumentReference can be a unique reference to other business documents or business document items that are of significance within each respective business process.
BusinessTransactionDocumentReference can be based on GDT: BusinessTransactionDocumentReference. BusinessTransactionDocumentRelationshipRoleCode can be a coded representation of a role that a business document or a business document item has when set against another business document or business document item with a relationship. BusinessTransactionDocumentRelationshipRoleCode can be based on GDT: BusinessTransactionDocumentRelationshipRoleCode. BusinessTransactionDocumentRelationshipTypeCode can be a coded representation of a relationship between two business documents or business document items. BusinessTransactionDocumentRelationshipTypeCode can be based on GDT: BusinessTransactionDocumentRelationshipTypeCode.
TransportationDocumentTypeCode can be a coded representation of documentation type. TransportationDocumentTypeCode can be based on GDT: TransportationDocumentTypeCode. TransportationDocumentNote can be a short Note regarding documentation. TransportationDocumentNote can be based on GDT: SHORT_Note. TransportationDocumentID can be a unique identifier for a transportation document. TransportationDocumentID can be based on GDT: TransportationDocumentID. RelationshipTypeCode and RelationshipRoleCode are both optional. In some implementations, if used, both may be filled. Either the combination BusinessTransactionDocumentReference, BusinessTransactionDocumentRelationshipRoleCode, BusinessTransactionDocumentRelationshipTypeCode, or TransportationDocumentTypeCode, TransportationDocumentNote, TransportationDocumentID can be filled. DateTimePeriod can specify a date, time and/or period related to the DocumentReference.
The TransportationStageInformation package includes information regarding a stage of a freight order. A stage can represent a section of a transport. The TransportationStageInformation package includes the TransportationStage entity. TransportationStage can specify details related to a stage of a transport which is part of a freight order. TransportationStage includes the following entities: ContactInformation, Quantity, Party, Location, Seal, TextCollection, BusinessTransactionDocumentReference, and TransportationServiceRequirement. The structure of TransportationStage includes the following elements: ID, OrdinalNumberValue, TypeCode, JourneyID, TransportModeCode, TransportMeansDescriptionCode, TransportMeansDescription, TransportMeansID, TransportMeansHomeCountryCode, TransportMeansOwnershipTypeCode, CarrierStandardID, CarrierFormattedName, TransportationTransitDirectionCode, CalculatedDistanceMeasure, and GivenDistanceMeasure.
ID can be a unique identifier of a stage in a shipment request. ID can be based on GDT: TransportationStageID. OrdinalNumberValue can be an ordinal number to indicate a position of a transportation stage in a set of transportation stages. OrdinalNumberValue can be based on GDT: OrdinalNumberValue, Qualifier: TransportationStage. TypeCode can be a coded representation of a type of a TransportationStage. TypeCode can be based on GDT: TransportationStageTypeCode. JourneyID can be an identifier of a Journey. JourneyID can be based on GDT: JourneyID. TransportModeCode can be a coded representation of a mode of transportation used for delivery. TransportModeCode can be based on GDT: TransportModeCode. TransportMeansDescriptionCode can be a coded representation of a transport means type with which goods or persons are to be transported.
TransportMeansDescriptionCode can be based on GDT: TransportMeansDescriptionCode. TransportMeansDescription can be a description of a means of transport. TransportMeansDescription can be based on GDT: SHORT_Description, Qualifier: TransportMeans. TransportMeansID can be a unique identifier of a means of transport. TransportMeansID can be based on GDT: TransportMeansID. TransportMeansHomeCountryCode can be a coded representation of the home country of a transport means. TransportMeansHomeCountryCode can be based on GDT: CountryCode, Qualifier: TransportMeansHome. TransportMeansOwnershipTypeCode can be a coded representation of a type of ownership for a means of transport.
TransportMeansOwnershipTypeCode can be based on GDT: TransportMeansOwnershipTypeCode. CarrierStandardID can be a standard identifier of a carrier. CarrierStandardID can be based on GDT: PartyStandardID. CarrierFormattedName can be a name of a carrier. CarrierFormattedName can be based on GDT: LONG_Name, Qualifier: PartyFormatted. TransportationTransitDirectionCode can be a coded representation for a transportation transit direction. TransportationTransitDirectionCode can be based on GDT: TransportationTransitDirectionCode. CalculatedDistanceMeasure can be a calculated distance measure. CalculatedDistanceMeasure can be based on GDT: Measure, Qualifier: CalculatedDistance. GivenDistanceMeasure can be a given distance measure. GivenDistanceMeasure can be based on GDT: Measure, Qualifier: GivenDistance.
ContactInformation can specify information on a department or person to whom information regarding a Stage can be directed. The structure of ContactInformation includes the ContactPersonFunctionTypeCode and Address elements. ContactPersonFunctionTypeCode can be a coded representation of a type of function that a contact person has. ContactPersonFunctionTypeCode can be based on GDT: ContactPersonFunctionTypeCode. Address can be an address related to contact information defined by a corresponding FunctionTypeCode. Address can be based on GDT: Address.
Quantity can specify a quantity related to a Stage. The structure of Quantity includes the elements Quantity, RoleCode, and TypeCode. Quantity can be a non-monetary numerical specification of an amount in a unit of measurement. Quantity can be based on GDT: Quantity. RoleCode can be a coded representation of a role of a quantity. RoleCode can be based on GDT: QuantityRoleCode. TypeCode can be a coded representation of a type of quantity that is based on a measurable characteristic of an object or physical phenomenon. TypeCode can be based on GDT: QuantityTypeCode. In some implementations, QuantityRoleCode and QuantityTypeCode are optional, but in every instance one of may be filled.
Party includes information exchanged, in accordance with common business understanding, in business documents, about a party involved in a current stage. This information can be used to identify the party and the party's address. Party includes the TransportationDocumentInformation and BusinessTransactionDocumentReference entities. The structure of Party includes the following elements: Party, RoleCode, and FormattedName.
A Party includes information exchanged, in accordance with common business understanding, in business documents, about a party involved in business transactions. This information can be used to identify the party and the party's address, as well as the party's contact person and the contact person's address. This identification can take place using an internal ID, a standardized ID, or IDs assigned by the parties involved. Party can be based on GDT: BusinessTransactionDocumentParty. RoleCode can be a coded representation of a PartyRoleCode which specifies which rights and obligations the party has regarding a business object and corresponding processes. In some implementations, a PartyRole is assigned to a PartyRoleCategory and refines its semantics. RoleCode can be based on GDT: PartyRoleCode. FormattedName can be a formatted name of a party. FormattedName can be based on GDT: LONG_Name, Qualifier: PartyFormatted.
TransportationDocumentInformation can specify information on a transportation document related to a shipment request. TransportationDocumentInformation includes the DateTimePeriod entity. The structure of TransportationDocumentInformation includes the following elements: TransportationDocumentTypeCode, TransportationDocumentNote, TransportationDocumentID, TransportationDocumentStatusCode, LanguageCode, CommunicationMediumTypeCode, RequiredIndicator, OutputCopyNumberValue, and OutputOriginalNumberValue.
TransportationDocumentTypeCode can be a coded representation of a documentation type. TransportationDocumentTypeCode can be based on GDT: TransportationDocumentTypeCode. TransportationDocumentNote can be a short Note on documentation. TransportationDocumentNote can be based on GDT: SHORT_Note. TransportationDocumentID can be a unique identifier for a transportation document. TransportationDocumentID can be based on GDT: TransportationDocumentID. TransportationDocumentStatusCode can be a coded representation of a status of a transportation document (e.g., to be printed, document complete). TransportationDocumentStatusCode can be based on GDT: TransportationDocumentStatusCode. LanguageCode can be a coded representation of the language of a documentation. LanguageCode can be based on GDT: LanguageCode. CommunicationMediumTypeCode can be a coded representation of a type of a medium used for communication of documentation (e.g., fax, mail, EDI (Electronic Data Interchange), or letter). CommunicationMediumTypeCode can be based on GDT : CommunicationMediumTypeCode.
RequiredIndicator can indicate whether a documentation is required or not. RequiredIndicator can be based on GDT: Indicator Qualifier: Required. OutputCopyNumberValue can be a number specifying the number of copies of a document that should be issued. OutputCopyNumberValue can be based on GDT: NumberValue, Qualifier : OutputCopy. OutputOriginalNumberValue can be a number specifying the number of originals of a document that should be issued. OutputOriginalNumberValue can be based on GDT: NumberValue, Qualifier : OutputOriginal. In some implementations, TypeCode and TypeDescription are both optional, but at least one of them may be used. In some implementations, if the RequiredIndicator is set to true, at least one of the NumberValues OutputCopyNumberValue or OutputOriginalNumberValue may be filled.
BusinessTransactionDocumentReference can specify a business document reference that is related to a whole shipment request. BusinessTransactionDocumentReference includes the DateTimePeriod entity. The structure of BusinessTransactionDocumentReference includes the following elements: BusinessTransactionDocumentReference, BusinessTransactionDocumentRelationshipRoleCode, BusinessTransactionDocumentRelationshipTypeCode, TransportationDocumentTypeCode, TransportationDocumentNote, and TransportationDocumentID. BusinessTransactionDocumentReference can be a unique reference to other business documents or business document items that are of significance within each respective business process.
BusinessTransactionDocumentReference can be based on GDT: BusinessTransactionDocumentReference. BusinessTransactionDocumentRelationshipRoleCode can be a coded representation of a role that a business document or a business document item has when set against another business document or business document item with a relationship. BusinessTransactionDocumentRelationshipRoleCode can be based on GDT: BusinessTransactionDocumentRelationshipRoleCode. BusinessTransactionDocumentRelationshipTypeCode can be a coded representation of a relationship between two business documents or business document items. BusinessTransactionDocumentRelationshipTypeCode can be based on GDT: BusinessTransactionDocumentRelationshipTypeCode.
TransportationDocumentTypeCode can be a coded representation of a documentation type. TransportationDocumentTypeCode can be based on GDT: TransportationDocumentTypeCode. TransportationDocumentNote can be a short Note on documentation. TransportationDocumentNote can be based on GDT: SHORT_Note. TransportationDocumentID can be a unique identifier for a transportation document. TransportationDocumentID can be based on GDT: TransportationDocumentID. RelationshipTypeCode and RelationshipRoleCode are both optional. In some implementations, if used, both can be filled. Either the combination BusinessTransactionDocumentReference, BusinessTransactionDocumentRelationshipRoleCode, BusinessTransactionDocumentRelationshipTypeCode, or TransportationDocumentTypeCode, TransportationDocumentNote, TransportationDocumentID can be filled. DateTimePeriod can specify a date, time and/or period related to a DocumentReference.
The Location can specify a physical place to which the TransportationCharges and an associated calculation can refer. Location includes the DateTimePeriod entity. The structure of Location includes the following elements: Location, RoleCode, TypeCode, and Name. Location includes information exchanged in business documents about a location relevant for business transactions. Location can be based on GDT: BusinessTransactionDocumentLocation. RoleCode can be a coded representation of a LocationRole. RoleCode can be based on GDT: LocationRoleCode. TypeCode can be a coded representation of a type of a physical location. TypeCode can be based on GDT: LocationTypeCode. Name can be a name of a location. Name can be based on GDT: MEDIUM_Name, Qualifier:Location.
Seal can specify seal information related to a Stage. The structure of Seal includes the following elements: ID, PartyRoleCode, PartyFormattedName, and StatusCode. ID can be a unique identifier of a seal. ID can be based on GDT: SealID. PartyRoleCode can be a coded representation of a party role. PartyRoleCode can be based on GDT: PartyRoleCode. PartyFormattedName can be a complete, formatted name of a party (e.g., the name of a SealingParty). PartyFormattedName can be based on GDT: LONG_Name, Qualifier: PartyFormatted. StatusCode can be a coded representation of a status of a seal. StatusCode can be based on GDT: SealStatusCode.
TextCollection can be a group of textual information that relates to a Stage. The structure of TextCollection includes the element TextCollection. TextCollection can be based on GDT: TextCollection.
BusinessTransactionDocumentReference can specify a business document reference that is related to a whole shipment request. BusinessTransactionDocumentReference includes the DateTimePeriod entity. The structure of BusinessTransactionDocumentReference includes the following elements: BusinessTransactionDocumentReference, BusinessTransactionDocumentRelationshipRoleCode, BusinessTransactionDocumentRelationshipTypeCode, TransportationDocumentTypeCode, TransportationDocumentNote, and TransportationDocumentID. BusinessTransactionDocumentReference can be a unique reference to other business documents or business document items that are of significance within each respective business process. BusinessTransactionDocumentReference can be based on GDT: BusinessTransactionDocumentReference.
BusinessTransactionDocumentRelationshipRoleCode can be a coded representation of a role that a business document or a business document item has when set against another business document or business document item with a relationship. BusinessTransactionDocumentRelationshipRoleCode can be based on GDT: BusinessTransactionDocumentRelationshipRoleCode. BusinessTransactionDocumentRelationshipTypeCode can be a coded representation of a relationship between two business documents or business document items. BusinessTransactionDocumentRelationshipRoleCode can be based on GDT: BusinessTransactionDocumentRelationshipTypeCode. TransportationDocumentTypeCode can be a coded representation of a documentation type. TransportationDocumentTypeCode can be based on GDT: TransportationDocumentTypeCode.
TransportationDocumentNote can be a short Note on documentation. TransportationDocumentNote can be based on GDT: SHORT_Note. TransportationDocumentID can be a unique identifier for a transportation document. TransportationDocumentID can be based on GDT: TransportationDocumentID. RelationshipTypeCode and RelationshipRoleCode are both optional. In some implementations, if used, both may be filled. Either the combination BusinessTransactionDocumentReference, BusinessTransactionDocumentRelationshipRoleCode, BusinessTransactionDocumentRelationshipTypeCode or TransportationDocumentTypeCode, TransportationDocumentNote, TransportationDocumentID can be filled.
TransportationServiceRequirement can specify a contract and carriage condition and service and priority requirements for transport which apply to a whole shipment request. The structure of TransportationServiceRequirement includes the following elements: TransportationServiceRequirementCode, AdditionalTransportationServiceRequirementCode, TransportationContractConditionCode, TransportServiceLevelCode, and NatureOfCargoClassificationCode. TransportationServiceRequirementCode can be a coded representation of a requirement related to a transportation service. TransportationServiceRequirementCode can be based on GDT : TransportationServiceRequirementCode.
AdditionalTransportationServiceRequirementCode can be a coded representation of an additional requirement related to a transportation service. AdditionalTransportationServiceRequirementCode can be based on GDT : TransportationServiceRequirementCode, Qualifier: Additional. TransportationContractConditionCode can be a coded representation of a contract and carriage condition. TransportationContractConditionCode can be based on GDT: TransportationContractConditionCode. TransportServiceLevelCode can be a coded representation of agreed or defined services in terms of the delivery of goods with respect to the speed of the delivery. TransportServiceLevelCode can be based on GDT : TransportServiceLevelCode. NatureOfCargoClassificationCode can be a coded representation of a classification of a nature of cargo. NatureOfCargoClassificationCode can be based on GDT : NatureOfCargoClassificationCode.
The TransportationUnitResourceInformation package includes information regarding a transportation unit resource that is relevant for the freight order (e.g., a container). The TransportationUnitResourceInformation package includes the TransportationUnitResourceInformation entity. TransportationUnitResourceInformation includes information on one or more transportation unit resources, such as a resource type and related properties, and related measures or handling instructions. A TransportationUnitResource can be a unit into which goods are loaded and/or from which goods are unloaded. In some implementations, this unit can provide transportation capacity for goods but cannot move by itself. TransportationUnitResource includes the following entities: TransportationStageAssignment, AttachedEquipment, Quantity, Seal, BusinessTransactionDocumentReference, TextCollection, Party, Location, and DangerousGoods.
The structure of TransportationUnitResourceInformation includes the following elements: ID, ResourceNumberValue, ResourceID, ResourceHomeCountryCode, TransportationUnitResourceCategoryCode, TransportationUnitResourceTypeCode, FillLevelCode, ShippingTypeCode, HaulageArrangerCode, TransportationHandlingInstructionCode, and TransportationHandlingInstructionNote. ID can be a unique identifier for a resource information. ID can be based on GDT ResourceInformationID. ResourceNumberValue can be a count of resources. ResourceNumberValue can be based on GDT: NumberValue, Qualifier: Resource. ResourceID can be a unique identifier for a resource. ResourceID can be based on GDT: ResourceID. ResourceHomeCountryCode can be a coded representation of the home country of a resource. ResourceHomeCountryCode can be based on GDT: CountryCode, Qualifier: ResourceHome.
TransportationUnitResourceCategoryCode can be a coded representation of a category of transportation unit resources. TransportationUnitResourceCategoryCode can be based on GDT: TransportationUnitResourceCategoryCode. TransportationUnitResourceTypeCode can be a coded representation of a type of a transportation unit resource. TransportationUnitResourceTypeCode can be based on GDT: TransportationUnitResourceTypeCode. FillLevelCode can be a coded representation of a fill level of a resource. FillLevelCode can be based on GDT: FillLevelCode. ShippingTypeCode can be a coded representation of a shipping type. A shipping type can specify how planning and execution of a transportation can be performed.
Transportation terms include detailed specifications on agreed means of transportation, such as shipping and transport type and means of transport to be used. ShippingTypeCode can be based on GDT: ShippingTypeCode. HaulageArrangerCode can be a coded representation of an arranger of a haulage. Haulage can be inland transport of cargo. HaulageArrangerCode can be based on GDT: HaulageArrangerCode. TransportationHandlingInstructionCode can be a coded representation of the type of a transportation handling instruction. TransportationHandlingInstructionCode can be based on GDT: TransportationHandlingInstructionCode. TransportationHandlingInstructionNote can be a note regarding a transportation handling instruction. TransportationHandlingInstructionNote can be based on GDT: LONG_Note, Qualifier: TransportationHandlingInstruction.
TransportationStageAssignment can specify an assignment of a resource to a stage. The structure of TransportationStageAssignment includes the element FreightOrderTransportationStageID. FreightOrderTransportationStageID can be a unique identifier of a TransportationStage in a freight order. FreightOrderTransportationStageID can be based on GDT: TransportationStageID.
AttachedEquipment can specify equipment attached to a TransportationUnitResource. The structure of AttachedEquipment includes the ShipmentRequestResourceInformationID element. ShipmentRequestResourceInformationID can be a unique identifier of a resource information in a ShipmentRequest. ShipmentRequestResourceInformationID can be based on GDT: ResourceInformationID.
Quantity can specify a quantity related to TransportationUnitResourceInformation. The structure of Quantity includes the following elements: Quantity, RoleCode, and TypeCode. Quantity can be a non-monetary numerical specification of an amount in a unit of measurement. Quantity can be based on GDT: Quantity. RoleCode can be a coded representation of a role of a quantity. RoleCode can be based on GDT: QuantityRoleCode. TypeCode can be a coded representation of a type of quantity that is based on a measurable characteristic of an object or physical phenomenon. TypeCode can be based on GDT: QuantityTypeCode. In some implementations, QuantityRoleCode and QuantityTypeCode are optional, but in every instance one of them may be filled.
Seal can specify a seal related to a TransportationUnitResource. The structure of Seal includes the following elements: ID, PartyRoleCode, PartyFormattedName, and StatusCode. ID can be a unique identifier of a seal. ID can be based on GDT: SealID. PartyRoleCode can be a coded representation of a party role. PartyRoleCode can be based on GDT: PartyRoleCode. PartyFormattedName can be a complete, formatted name of a party, or the name of the SealingParty. PartyFormattedName can be based on GDT: LONG_Name, Qualifier: PartyFormatted. StatusCode can be a coded representation of a status of a seal. StatusCode can be based on GDT: SealStatusCode.
TextCollection can be a group of textual information that relates to a GovernmentalProcedure. The structure of the TextCollection entity includes the TextCollection element. TextCollection can be based on GDT: TextCollection.
BusinessTransactionDocumentReference can specify a business document reference that is related to a whole shipment request. BusinessTransactionDocumentReference includes the DateTimePeriod entity. The structure of BusinessTransactionDocumentReference includes the following elements: BusinessTransactionDocumentReference, BusinessTransactionDocumentRelationshipRoleCode, BusinessTransactionDocumentRelationshipTypeCode, TransportationDocumentTypeCode, TransportationDocumentNote, and TransportationDocumentID. BusinessTransactionDocumentReference can be a unique reference to other business documents or business document items that are of significance within each respective business process. BusinessTransactionDocumentReference can be based on GDT: BusinessTransactionDocumentReference.
BusinessTransactionDocumentRelationshipRoleCode can be a coded representation of a role that a business document or a business document item has when set against another business document or business document item with a relationship. BusinessTransactionDocumentRelationshipRoleCode can be based on GDT: BusinessTransactionDocumentRelationshipRoleCode. BusinessTransactionDocumentRelationshipTypeCode can be a coded representation of a relationship between two business documents or business document items. BusinessTransactionDocumentRelationshipRoleCode can be based on GDT: BusinessTransactionDocumentRelationshipTypeCode. TransportationDocumentTypeCode can be a coded representation of a documentation type.
TransportationDocumentTypeCode can be based on GDT: TransportationDocumentTypeCode. TransportationDocumentNote can be a short Note on documentation. TransportationDocumentNote can be based on GDT: SHORT_Note. TransportationDocumentID can be a unique identifier for a transportation document. TransportationDocumentID can be based on GDT: TransportationDocumentID. RelationshipTypeCode and RelationshipRoleCode are both optional. In some implementations, if used, both may be filled. Either the combination BusinessTransactionDocumentReference, BusinessTransactionDocumentRelationshipRoleCode, BusinessTransactionDocumentRelationshipTypeCode or TransportationDocumentTypeCode, TransportationDocumentNote, TransportationDocumentID can be filled.
TextCollection can be a group of textual information that relates to a TransportationUnitResource. The structure of TextCollection includes the element TextCollection. TextCollection can be based on GDT: TextCollection.
Party includes information exchanged, in accordance with common business understanding, in business documents, about a party involved in the current TransportationUnitResource. This information can be used to identify the party and the party's address. The structure of Party includes the following elements: Party, RoleCode, and FormattedName. A Party includes information exchanged, in accordance with common business understanding, in business documents, about a party involved in business transactions. This information can be used to identify the party and the party's address, as well as the party's contact person and the contact person's address. This identification can take place using an internal ID, a standardized ID, or IDs assigned by the parties involved. Party can be based on GDT: BusinessTransactionDocumentParty. RoleCode can be a coded representation of a PartyRoleCode which specifies which rights and obligations the party has regarding a business object and corresponding processes. In some implementations, a PartyRole is assigned to one PartyRoleCategory and refines its semantics. PartyRole can be based on GDT: PartyRoleCode. FormattedName can be a complete, formatted name of a party. FormattedName can be based on GDT: LONG_Name, Qualifier: PartyFormatted.
Location can specify a physical place related to a TransportationUnitResource. The structure of Location includes the following elements: Location, RoleCode, TypeCode, and Name. Location includes information exchanged in business documents about a location relevant for business transactions. Location can be based on GDT: BusinessTransactionDocumentLocation. RoleCode can be a coded representation of a LocationRole. RoleCode can be based on GDT: LocationRoleCode. TypeCode can be a coded representation of a type of a physical location. TypeCode can be based on GDT: LocationTypeCode. Name can be a name of a location. Name can be based on GDT: MEDIUM_Name, Qualifier:Location.
DangerousGoods can specify dangerous goods included in a resource. DangerousGoods includes the ContactInformation and TextCollection entities. The structure of DangerousGoods includes the following elements: ID, RegulationsCode, HazardCode, FlashpointMeasureInterval, PackagingGroupCode, EmergencySchedule, TransportEmergencyCardCode, DangerousGoodsLabelCode, DangerousGoodsLabelCode2, DangerousGoodsLabelCode3, PackagingInstructionTypeCode, TransportMeansDescriptionCode, and TransportAuthorisationCode. ID can be a unique identifier for a dangerous good, using the United Nations Dangerous Goods Number. ID can be based on GDT: DangerousGoodsID.
RegulationsCode can be a coded representation of national or international dangerous goods rules or regulations. RegulationsCode can be based on GDT: DangerousGoodsRegulationsCode. HazardCode can be a coded representation of a hazard that is imminent in a dangerous good. HazardCode can be based on GDT: DangerousGoodsHazardCode. FlashpointMeasureInterval can be an interval of measures defined by a lower and an upper boundary indicating a flashpoint of a dangerous good. FlashpointMeasureInterval can be based on GDT: MeasureInterval, Qualifier: Flashpoint. PackagingGroupCode can be a coded representation of the effectiveness of a packaging to transport dangerous goods depending on the degree of danger of the goods. PackagingGroupCode can be based on GDT: DangerousGoodsPackagingGroupCode.
EmergencySchedule can be a coded representation of an emergency schedule for dangerous goods. EmergencySchedule can identify an emergency schedule. The DangerousGoodsEmergencySchedule can be used for transports of dangerous goods by sea similar to a Transport Emergency Card which is used for transports of dangerous goods by road. EmergencySchedule can be based on GDT: DangerousGoodsEmergencySchedule. TransportEmergencyCardCode can be a coded representation of a transport emergency card which specifies how to react in case of an accident. TransportEmergencyCardCode can be based on GDT: TransportEmergencyCardCode. DangerousGoodsLabelCode can be a coded representation of a label for a dangerous good.
In some implementations, DangerousGoodsLabelCode's values are dependant on the DangerousGoodsRegulationsCode. DangerousGoodsLabelCode can be based on GDT: DangerousGoodsLabelCode. DangerousGoodsLabelCode2 can be a coded representation of a label for a dangerous good. In some implementations, DangerousGoodsLabelCode's values are dependant on the DangerousGoodsRegulationsCode. DangerousGoodsLabelCode2 can be based on GDT: DangerousGoodsLabelCode. DangerousGoodsLabelCode3 can be a coded representation of a label for a dangerous good. In some implementations, DangerousGoodsLabelCode's values are dependant on the DangerousGoodsRegulationsCode. DangerousGoodsLabelCode3 can be based on GDT: DangerousGoodsLabelCode.
PackagingInstructionTypeCode can be a coded representation of a packaging instruction. A packaging instruction can be an instruction defining which packagings can be used to pack a dangerous good. PackagingInstructionTypeCode can be based on GDT: PackagingInstructionTypeCode. TransportMeansDescriptionCode can be a coded representation of a transport means type with which goods or persons are to be transported. TransportMeansDescriptionCode can be based on GDT: TransportMeansDescriptionCode. TransportAuthorisationCode can be a coded representation of an authorisation for a transportation of dangerous goods. This code can specify an authorisation for a transportation of a particular dangerous good. TransportAuthorisationCode can be based on GDT: DangerousGoodsTransportAuthorisationCode.
The TransportationChargesInformation package includes information regarding a transportation charge calculation specific to components related to a FreightOrder. The TransportationChargesInformation package includes the TransportationChargesInformation entity. The entity TransportationChargesInformation can define a relationship between transportation charges and the origin of these charges. TransportationChargesInformation includes the TransportationCharges entity. The structure of TransportationChargesInformation includes the following elements: TransportationChargesUsageCode, FreightOrderPartyStandardID, FreightOrderTransportationUnitResourceID, and FreightOrderTransportationStageID. TransportationChargesUsageCode can be a coded representation of the usage of TransportationCharges. The usage points out if subsequent information represents a revenue view or cost view on transportation charges.
TransportationChargesUsageCode can be based on GDT: TransportationChargesUsageCode. FreightOrderPartyStandardID can be a unique identifier of a Party in a FreightOrder. FreightOrderPartyStandardID can be based on GDT: PartyStandardID. FreightOrderTransportationUnitResourceID can be a unique identification of a TransportationUnitResource in a FreightOrder. FreightOrderTransportationUnitResourceID can be based on GDT: ResourceID. FreightOrderTransportationStageID can be a unique identification of a TransportationStage in a FreightOrder. FreightOrderTransportationStageID can be based on GDT: TransportationStageID. If none of the IDs is maintained, the transportation charges are related to the entire freight order.
TransportationCharges can be a summary of determined transportation charge specific components for a transportation business case. TransportationCharges includes the following entities: Location, TextCollection, Currency, ExchangeRate, PercentElement, DateTimePeriod, BusinessTransactionDocumentReference, TaxDetail, PaymentInstruction, CashDiscountTerms, and Element. The structure of TransportationCharges includes the following elements: ID, FreightAgreementID, CalculationOriginCode, TariffID, and CalculationSheetID. ID can be a unique identifier of TransportationCharges in a ShipmentRequest. ID can be based on GDT: TransportationChargesID. FreightAgreementID can be an identification of a Freight Agreement which includes and points to a configuration for the Transportation Charges Calculation.
FreightAgreementID can be based on GDT: FreightAgreementID. CalculationOriginCode can be a coded representation of the origin of a transportation charges calculation. The calculation can be done automatically based on a system configuration. Data for the calculation, including the results, can be manually entered or received from another business system via a message. In some implementations, it may be necessary to have a clear distinction of the origin of TransportationChargesCalculation details, such as the TransportationChargesCalculationSheet and its TransportationChargeElements. The distinction can give information whether the calculation was done completely automatically, or if the results were manually adopted. CalculationOriginCode can be based on GDT: TransportationChargesOriginCode.
TariffID can be an identifier for a transportation charges tariff. A transportation charges tariff can be a specific combination of a transportation charges calculation sheet and terms and conditions. The terms and conditions can define if a certain transportation charges calculation sheet and its related rates are applicable for a transportation business case. TariffID can be based on GDT: TransportationChargesTariffID. CalculationSheetID can be a unique Identifier for a transportation charges calculation sheet. A TransportationChargesCalculationSheet can represent a configuration describing how to calculate necessary transportation charges for a transportation business case. TransportationChargesCalculationSheet includes instructions, indications of which charges are applicable, indications of which data from the transportation business case can be considered for the calculation, information describing how the underlying transportation charge rates determined, and information describing which special calculation methods can be considered. CalculationSheetID can be based on GDT: TransportationChargesCalculationSheetID.
A ShipmentOrder package can specify or group together data related to a shipment request which is assigned to a freight order. The ShipmentOrder package includes the ShipmentOrder entity and the Request package. ShippingOrder can be an agreement between an ordering party and a transportation service provider on the shipment of goods from a single shipper to a single consignee in accordance with agreed terms and conditions. ShippingOrder includes the TransportationStageAssignment and TransportationUnitResourceInformationAssignment entities. The structure of ShipmentOrder includes the ID element. ID can be a unique identifier of a ShipmentOrder. ID can be based on GDT: BusinessTransactionDocumentID.
TransportationStageAssignment can specify an assignment of a shipment order to a transportation stage of a freight order. The structure of TransportationStageAssignment includes the element FreightOrderTransportationStageID. FreightOrderTransportationStageID can be a unique identifier of a TransportationStage in a freight order. FreightOrderTransportationStageID can be based on GDT: TransportationStageID.
TransportationUnitResourceInformationAssignment can specify an assignment of a shipment order to a TransportationUnitResourceInformation of a freight order. The structure of TransportationUnitResourceInformationAssignment includes the FreightOrderTransportationUnitResourceID element. FreightOrderTransportationUnitResourceID can be a unique identifier of a TransportationUnitResource in a freight order. FreightOrderTransportationUnitResourceID can be based on GDT: ResourceID.
The Request package can group a Request with its packages. The Request package includes the Request entity and the packages HeaderInformation, TransportationChargesInformation, GovernmentalRequirementInformation, PartyInformation, LocationInformation, TransportationStageInformation, TransportationUnitResourceInformation, PackagingInformation, and Item. In some implementations, the Request Package is filled either for none or for all of the shipment requests which are assigned to a freight order. In a first case (short form message), ShipmentRequest and its subentities identify the ShipmentRequest requests that have already been sent before. In a second case (extended form message) the Request Package includes ShipmentRequest request data, and in a standard process the subentities of entity ShipmentRequest may or may not be filled.
The message data type FreightOrderExecutionCancelRequestMessage can group together business information relevant for sending a business document in a message and the FreightOrderExecution object in a business document. The message data type FreightOrderExecutionCancelRequestMessage includes the MessageHeader and FreightOrderExecution packages. The message data type FreightOrderExecutionCancelRequestMessage can provide a structure for the message type FreightOrderExecutionCancelRequest and the interfaces that are based on it.
A MessageHeader package can group together business information relevant for sending a business document in a message. The MessageHeader package includes the MessageHeader entity. A MessageHeader can group together business information from the perspective of a sending application to identify a business document in a message, to provide information about the sender, or to provide information about the recipient. The MessageHeader can be divided up into the SenderParty and RecipientParty entities. MessageHeader can be of type GDT: BusinessDocumentMessageHeader. The MessageHeader includes the following elements: ID, ReferenceID, and CreationDateTime. The MessageID can be set by the sending application. With the ReferencedMessageID, reference can be made in the current BusinessDocument to a previous BusinessDocument.
A SenderParty can be a party responsible for sending a business document at a business application level. The SenderParty can be of type GDT: BusinessDocumentMessageHeaderParty. The SenderParty includes the following elements: InternalID, StandardID, and ContactPerson. The SenderParty can be filled by the sending application to name a contact person for problems with the message. A contact person can be useful if an additional infrastructure, such as a marketplace, is located between the sender and the recipient. The SenderParty can be used to transfer a message and can be ignored by the receiving application. SenderParty can be filled by the sender if the participating parties are not transferred with the FreightOrderExecution Package.
A RecipientParty can be a party responsible for receiving a business document at a business application level. The RecipientParty can be of type GDT: BusinessDocumentMessageHeaderParty. The RecipientParty includes the following elements: InternalID, StandardID, and ContactPerson. The RecipientParty can be filled by the sending application to name a contact person for problems that may occur with the message. A contact person can be useful if an additional infrastructure, such as a marketplace, is located between the sender and the recipient. The RecipientParty can be used to transfer a message and can be ignored by the receiving application. RecipientParty can be filled by the sender if the FreightOrderExecution Package cannot be used to transfer the participating parties.
The FreightOrderExecution package can group together information about the FreightOrderExecution. The FreightOrderExecution package includes the FreightOrderExecution entity and the BusinessTransactionDocumentReference package. The FreightOrderExecution interface can be used to delegate the execution of planned transportation of goods, from shippers to consignees, to the transportation execution processing of an ERP system. The attributes and elements located directly at the FreightOrder entity include ID. ID can be a unique identifier of a FreightOrder. ID can be based on GDT: BusinessTransactionDocumentID.
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. A BusinessTransactionDocumentReference package includes the BusinessTransactionDocumentReference entity. The structure of BusinessTransactionDocumentReference includes the following elements: BusinessTransactionDocumentReference, BusinessTransactionDocumentRelationshipRoleCode, BusinessTransactionDocumentRelationshipTypeCode, TransportationDocumentTypeCode, TransportationDocumentNote, and TransportationDocumentID. BusinessTransactionDocumentReference can be a unique reference to other business documents or business document items that are of significance within each respective business process. BusinessTransactionDocumentReference can be based on GDT: BusinessTransactionDocumentReference.
BusinessTransactionDocumentRelationshipRoleCode can be a coded representation of a role that a business document or a business document item has when set against another business document or business document item with a relationship. BusinessTransactionDocumentRelationshipRoleCode can be based on GDT: BusinessTransactionDocumentRelationshipRoleCode. BusinessTransactionDocumentRelationshipTypeCode can be a coded representation of a relationship between two business documents or business document items. BusinessTransactionDocumentRelationshipTypeCode can be based on GDT: BusinessTransactionDocumentRelationshipTypeCode. TransportationDocumentTypeCode can be a coded representation of a documentation type. TransportationDocumentTypeCode can be based on GDT: TransportationDocumentTypeCode.
TransportationDocumentNote can be a short Note on documentation. TransportationDocumentNote can be based on GDT: SHORT_Note. TransportationDocumentID can be a unique identifier for a transportation document. TransportationDocumentID can be based on GDT: TransportationDocumentID. RelationshipTypeCode and RelationshipRoleCode are both optional. In some implementations, if used, both may be filled. Either the combination BusinessTransactionDocumentReference, BusinessTransactionDocumentRelationshipRoleCode, BusinessTransactionDocumentRelationshipTypeCode or TransportationDocumentTypeCode, TransportationDocumentNote, TransportationDocumentID may be filled.
The message data type FreightOrderExecutionConfirmationMessage includes business information relevant for sending a business document in a message, and the FreightOrderExecution included in a business document. The message data type FreightOrderExecutionConfirmationMessage includes the MessageHeader and FreightOrderExecution packages. The message data type FreightOrderExecutionConfirmationMessage can provide a structure for the message type FreightOrderExecutionConfirmation and the interfaces that are based on it.
A MessageHeader package can group together business information relevant for sending a business document in a message. The MessageHeader package includes the MessageHeader entity. A MessageHeader can group together business information from a perspective of a sending application to identify a business document in a message, to provide information about the sender, and to provide information about the recipient. The MessageHeader can be divided up into the SenderParty and RecipientParty entities. MessageHeader can be of type GDT: BusinessDocumentMessageHeader. The MessageHeader includes the following elements: ID, ReferenceID, and CreationDateTime. The MessageID can be set by the sending application. With the ReferencedMessageID, reference can be made in the current BusinessDocument to a previous BusinessDocument.
A SenderParty can be a party responsible for sending a business document at a business application level. The SenderParty can be of type GDT: BusinessDocumentMessageHeaderParty. The SenderParty includes the following elements: InternalID, StandardID, and ContactPerson. The SenderParty can be filled by the sending application to name a contact person for problems with the message. A contact person can be useful if an additional infrastructure, such as a marketplace, is located between the sender and the recipient. The SenderParty can be used to transfer the message and can be ignored by the receiving application. SenderParty can be filled by the sender if the participating parties are not transferred with the FreightOrderExecution Package.
A RecipientParty can be a party responsible for receiving a business document at a business application level. The RecipientParty can be of type GDT: BusinessDocumentMessageHeaderParty. The RecipientParty includes the following elements: InternalID, StandardID, and ContactPerson. The RecipientParty can be filled by the sending application to name a contact person for problems that may occur with the message. A contact person can be useful if an additional infrastructure, such as a marketplace, is located between the sender and the recipient. The RecipientParty can be used to transfer the message and can be ignored by the receiving application. RecipientParty can be filled by the sender if the FreightOrderExecution Package cannot be used to transfer the participating parties.
The FreightOrderExecution package can group the FreightOrderExecution together with its packages. The FreightOrderExecution package includes the FreightOrderExecution entity and the Confirmation package. The freight order execution interface can be used to delegate the execution of planned transportation of goods, from shippers to consignees, to the transportation execution processing of an ERP system. The attributes and elements located directly at the FreightOrder entity include @actioncode and ID. @actioncode can be a coded representation of an instruction to a message recipient describing how to process a transmitted element. @actioncode can be based on GDT: ActionCode. ID can be a unique identifier of a FreightOrder. ID can be based on GDT: BusinessTransactionDocumentID. In some implementations, the attribute @actioncode may only include the two values “01—Create” and “02—Change”. In some implementations, the ID is not changed once a FreightOrder has been created. In some implementations, the Complete Transmission Indicator is set to true (i.e., the complete message content is transmitted in every message). As a consequence, previously transferred data that is not sent with the change message may be deleted.
The Confirmation package can be a confirmation of an agreement between a transportation service provider and an ordering party on the transportation of goods from a single ship-from party to a single ship-to party in accordance with agreed terms and conditions. The Confirmation package includes the Confirmation entity. The Confirmation package includes the following packages: HeaderInformation, TransportationChargesInformation, GovernmentalRequirementInformation, PartyInformation, LocationInformation, TransportationStageInformation, TransportationUnitResourceInformation, PackagingInformation, and Item. Confirmation can be a confirmation of an agreement between a transportation service provider and an ordering party on the transportation of goods from a single ship-from party to a single ship-to party in accordance with agreed terms and conditions. The confirmation entity includes the AcceptanceStatusCode element. AcceptanceStatusCode can be a coded representation of a status of an acceptance by a communication partner regarding a business transaction that has been transmitted to that partner. AcceptanceStatusCode can be based on GDT: AcceptanceStatusCode.
The HeaderInformation package can group dates, total values, document and references related to a freight order. The HeaderInformation package includes the following entities: DateTimePeriods, NatureOfCargo, TotalQuantity, TotalAmount, TextCollection, and BusinessTransactionDocumentReference.
The GovernmentalProcedureInformation package can specify applicable governmental procedures related to import, export and transport of goods of a shipment request. The GovernmentalProcedureInformation package includes the GovernmentalProcedure entity. GovernmentalProcedure can specify applicable governmental procedures related to import, export and transport of goods of a shipment request. GovernmentalProcedure includes the following entities: Location, DateTimePeriod, Seal, TextCollection, and TransportationDocumentInformation. The structure of GovernmentalProcedure includes the following elements: TransportationGovernmentAgencyTypeCode, TransportationMovementTypeCode, TransportationGovernmentAgencyInvolvementStatusCode, TransportationGovernmentAgencyActionCode, and TransportationGovernmentAgencyProcedureStatusCode.
TransportationGovernmentAgencyTypeCode can be a coded representation of a type of a government agency. TransportationGovernmentAgencyTypeCode can be based on GDT: TransportationGovernmentAgencyTypeCode. TransportationMovementTypeCode can be a coded representation of a type of a transport movement. Examples include Import, Export, Transit, and Transshipment. TransportationMovementTypeCode can be based on GDT: TransportationMovementTypeCode. TransportationGovernmentAgencyInvolvementStatusCode can be a coded representation for an involvement status of a transportation related government agency. TransportationGovernmentAgencyInvolvementStatusCode can be based on GDT: TransportationGovernmentAgencyInvolvementStatusCode. TransportationGovernmentAgencyActionCode can be a coded representation of an action of a transportation related government agency.
TransportationGovernmentAgencyActionCode can be based on GDT: TransportationGovernmentAgencyActionCode. TransportationGovernmentAgencyProcedureStatusCode can be a coded representation of a status of a procedure related to a transportation government agency. TransportationGovernmentAgencyProcedureStatusCode can be based on GDT: TransportationGovernmentAgencyProcedureStatusCode.
The PartyInformation package includes information regarding a party of a freight order (e.g., Shipper, Carrier, Agent). PartyInformation includes the Party entity. The LocationInformation package includes information regarding a location of a shipment order (e.g., Ship-from location). The LocationInformation package includes the Location entity.
The TransportationStageInformation package includes information regarding a stage of a freight order. A stage can represent a section of a transport. The TransportationStageInformation package includes the TransportationStage entity. TransportationStage can specify details related to a stage of a transport which is part of a freight order. TransportationStage includes the following entities: ContactInformation, Quantity, Party, Location, Seal, TextCollection, BusinessTransactionDocumentReference, and TransportationServiceRequirement. The structure of TransportationStage includes the following elements: ID, OrdinalNumberValue, TypeCode, JourneyID, TransportModeCode, TransportMeansDescriptionCode, TransportMeansDescription, TransportMeansID, TransportMeansHomeCountryCode, TransportMeansOwnershipTypeCode, CarrierStandardID, CarrierFormattedName, TransportationTransitDirectionCode, CalculatedDistanceMeasure, and GivenDistanceMeasure.
ID can be a unique identifier of a stage in a shipment request. ID can be based on GDT: TransportationStageID. OrdinalNumberValue can be an ordinal number to indicate a position of a transportation stage in a set of transportation stages. OrdinalNumberValue can be based on GDT: OrdinalNumberValue, Qualifier: TransportationStage. TypeCode can be a coded representation of a type of a TransportationStage. TypeCode can be based on GDT: TransportationStageTypeCode. JourneyID can be an identifier of a Journey. JourneyID can be based on GDT: JourneyID. TransportModeCode can be a coded representation of a mode of transportation used for delivery. TransportModeCode can be based on GDT: TransportModeCode.
TransportMeansDescriptionCode can be a coded representation of a transport means type with which goods or persons are to be transported. TransportMeansDescriptionCode can be based on GDT: TransportMeansDescriptionCode. TransportMeansDescription can be a description of a means of transport. TransportMeansDescription can be based on GDT: SHORT_Description, Qualifier: TransportMeans. TransportMeansID can be a unique identifier of a means of transport. TransportMeansID can be based on GDT: TransportMeansID. TransportMeansHomeCountryCode can be a coded representation of the home country of a transport means. TransportMeansHomeCountryCode can be based on GDT: CountryCode, Qualifier: TransportMeansHome. TransportMeansOwnershipTypeCode can be a coded representation of a type of ownership for a means of transport.
TransportMeansOwnershipTypeCode can be based on GDT: TransportMeansOwnershipTypeCode. CarrierStandardID can be a standard identifier of a carrier. CarrierStandardID can be based on GDT: PartyStandardID. CarrierFormattedName can be a name of a carrier. CarrierFormattedName can be based on GDT: LONG_Name, Qualifier: PartyFormatted. TransportationTransitDirectionCode can be a coded representation for a transportation transit direction. TransportationTransitDirectionCode can be based on GDT: TransportationTransitDirectionCode. CalculatedDistanceMeasure can be a calculated distance measure. CalculatedDistanceMeasure can be based on GDT: Measure, Qualifier: CalculatedDistance. GivenDistanceMeasure can be a given distance measure. GivenDistanceMeasure can be based on GDT: Measure, Qualifier: GivenDistance.
The TransportationUnitResourceInformation package includes information regarding a transportation unit resource that is relevant for a freight order, (e.g., a container). The TransportationUnitResourceInformation package includes the TransportationUnitResourceInformation entity. TransportationUnitResourceInformation includes information on one or more transportation unit resources, such as a resource type and related properties, related measures or handling instructions. A Transportation Unit Resource can be a unit into which goods are loaded and/or from which goods are unloaded. In some implementations, this unit can provide transportation capacity for goods but may or may not move by itself.
TransportationUnitResourceInformation includes the following entities: TransportationStageAssignment, AttachedEquipment, Quantity, Seal, BusinessTransactionDocumentReference, TextCollection, Party, Location, and DangerousGoods. The structure of TransportationUnitResourceInformation includes the following elements: ID, ResourceNumberValue, ResourceID, ResourceHomeCountryCode, TransportationUnitResourceCategoryCode, TransportationUnitResourceTypeCode, FillLevelCode, ShippingTypeCode, HaulageArrangerCode, TransportationHandlingInstructionCode, and TransportationHandlingInstructionNote. ID can be a unique identifier for a resource information, and can be based on GDT ResourceInformationID. ResourceNumberValue can be a number of resources, and can be based on GDT: NumberValue, Qualifier: Resource.
ResourceID can be a unique identifier for a resource, and can be based on GDT: ResourceID. ResourceHomeCountryCode can be a coded representation of the home country of a resource. ResourceHomeCountryCode can be based on GDT: CountryCode, Qualifier: ResourceHome. TransportationUnitResourceCategoryCode can be a coded representation of a category of transportation unit resources. TransportationUnitResourceCategoryCode can be based on GDT: TransportationUnitResourceCategoryCode. TransportationUnitResourceTypeCode can be a coded representation of a type of a transportation unit resource. TransportationUnitResourceTypeCode can be based on GDT: TransportationUnitResourceTypeCode. FillLevelCode can be a coded representation of a fill level of a resource. FillLevelCode can be based on GDT: FillLevelCode. ShippingTypeCode can be a coded representation of a shipping type.
A shipping type can specify how planning and execution of a transportation may be performed. Transportation terms include detailed specifications on agreed means of transportation, such as shipping or transport type and means of transport to be used. The ShippingTypeCode can be based on GDT: ShippingTypeCode. HaulageArrangerCode can be a coded representation of an arranger of a haulage. Haulage can be inland transport of cargo. HaulageArrangerCode can be based on GDT: HaulageArrangerCode. TransportationHandlingInstructionCode can be a coded representation of the type of a transportation handling instruction. TransportationHandlingInstructionCode can be based on GDT: TransportationHandlingInstructionCode. TransportationHandlingInstructionNote can be a note regarding a transportation handling instruction. TransportationHandlingInstructionNote can be based on GDT: LONG_Note, Qualifier: TransportationHandlingInstruction.
A PackageInformation package can describe package information related to a whole shipment order. A PackageInformation package includes the following entities: ItemAssignment, TransportationUnitResourceInformationAssignment, and Quantity. The structure of PackageInformation includes ID, PackageID, PackageOrdinalNumberValue, PackageNumberValue, PackageTypeCode, PackagingLevelCode, PackageMarkingInstructionCode, and PredecessorPackageID. ID can be a unique identifier for a package information, and can be based on GDT: PackageInformationID. PackageID can be a unique identifier of a package used in a packaging, and can be based on GDT: PackageID. PackageOrdinalNumberValue can be an ordinal number to indicate a position of a package in a set of packages. In a transportation document, a position of a package can be a position that has been specified at shipping time.
PackageOrdinalNumberValue can be based on GDT:OrdinalNumberValue, Qualifier: Package. PackageNumberValue can be the number of packages used in a packaging. PackageNumberValue can be based on GDT: NumberValue, Qualifier: Package. PackageTypeCode can be a coded representation of a type of a package, and can be based on GDT: PackageTypeCode. PackagingLevelCode can be a coded representation of a packaging level. A packaging level can specify a rank of a packaging in a packaging hierarchy. PackagingLevelCode can be based on GDT: PackagingLevelCode. PackageMarkingInstructionCode can be a coded representation of a marking instruction of a package, and can be based on GDT: PackageMarkingInstructionCode. PredecessorPackageID can be a unique identification of a related package, and can be based on GDT: PackageID. In some implementations, PredecessorPackageID may be filled in case a PackageID is available.
The TransportationChargesInformation package includes information regarding transportation charge calculation specific components related to a FreightOrder. The TransportationChargesInformation package includes the TransportationChargesInformation entity. The entity TransportationChargesInformation can define a relationship between transportation charges and an origin of these charges. TransportationChargesInformation includes the TransportationCharges entity. The structure of TransportationChargesInformation includes the following elements: TransportationChargesUsageCode, FreightOrderPartyStandardID, FreightOrderTransportationUnitResourceID, and FreightOrderTransportationStageID. TransportationChargesUsageCode can be a coded representation of usage of the TransportationCharges.
The usage points out if subsequent information represents a revenue view or cost view on transportation charges. TransportationChargesUsageCode can be based on GDT: TransportationChargesUsageCode. FreightOrderPartyStandardID can be a unique identifier of a Party in a FreightOrder. FreightOrderPartyStandardID can be based on GDT: PartyStandardID. FreightOrderTransportationUnitResourceID can be a unique identification of a TransportationUnitResource in a FreightOrder. FreightOrderTransportationUnitResourceID can be based on GDT: ResourceID. FreightOrderTransportationStageID can be a unique identification of a TransportationStage in a FreightOrder, and can be based on GDT: TransportationStageID. In some implementations, if none of the IDs is maintained, the transportation charges are related to an entire freight order.
An Item package includes information regarding products included in a shipment order and additional information on these products. The Item package includes the Item entity and the following packages: ItemInformation, LocationInformation, and TransportGoodsInformation. The structure of Item includes the following elements: ID, OriginCountryCode, DestinationCountryCode, ShippingTypeCode, HaulageArrangerCode, TemperatureMeasureInterval, and TransportationHandlingInstructionCode. ID can be a unique identifier of an Item in a shipment request, and can be based on GDT: BusinessTransactionDocumentItemID. OriginCountryCode can be a country of origin of goods that are considered in a shipment request.
OriginCountryCode can be based on GDT: CountryCode, Qualifier: Origin. DestinationCountryCode can be the ultimate country of destination of goods that are considered in a shipment request. DestinationCountryCode can be based on GDT: CountryCode, Qualifier: Destination. ShippingTypeCode can be a coded representation of a shipping type. A shipping type can specify how planning and execution of a transportation may be performed. Transportation terms include detailed specifications on agreed means of transportation, such as shipping or transport type and means of transport to be used. ShippingTypeCode can be based on GDT: ShippingTypeCode. HaulageArrangerCode can be a coded representation of an arranger of a haulage. Haulage can be inland transportation of cargo.
HaulageArrangerCode can be based on GDT: HaulageArrangerCode. TemperatureMeasureInterval can be an interval of temperature measures defined by a lower and an upper boundary and a measure type code. TemperatureMeasureInterval can be based on GDT: MeasureInterval, Qualifier: Temperature. TransportationHandlingInstructionCode can be a coded representation of a transportation handling instruction. TransportationHandlingInstructionCode can be based on GDT: TransportationHandlingInstructionNote. In some implementations, for a measure related to a temperature, the units of measurement Celsius and Fahrenheit are allowed.
The message data type FreightOrderExecutionStatusNotificationMessage includes business information relevant for sending a business document in a message, and the FreightOrderExecution included in a business document. The message data type FreightOrderExecutionStatusNotificationMessage includes the MessageHeader and FreightOrderExecution packages. The message data type FreightOrderExecutionStatusNotificationMessage can provide a structure for the message type FreightOrderExecutionStatusNotification and for interfaces that are based on it.
A MessageHeader package can group together business information relevant for sending a business document in a message. The MessageHeader package includes the MessageHeader entity. A MessageHeader can group together business information from the perspective of the sending application to identify a business document in a message, to provide information about the sender, and to provide information about the recipient. The MessageHeader can be divided up into the SenderParty and RecipientParty entities. MessageHeader can be of type GDT: BusinessDocumentMessageHeader. The MessageHeader includes the following elements: ID, ReferenceID, and CreationDateTime. The MessageID can be set by the sending application. With the ReferencedMessageID, reference can be made in the current BusinessDocument to a previous BusinessDocument.
A SenderParty can be a party responsible for sending a business document at a business application level. The SenderParty can be of type GDT: BusinessDocumentMessageHeaderParty. The SenderParty includes the following elements: InternalID, StandardID, and ContactPerson. The SenderParty can be filled by the sending application to name a contact person for problems with a message. A contact person can be useful if an additional infrastructure, such as a marketplace, is located between the sender and the recipient. The SenderParty can be used to transfer a message and can be ignored by the receiving application. SenderParty can be filled by the sender if the participating parties are not transferred with the FreightOrderExecution Package.
A RecipientParty can be a party responsible for receiving a business document at a business application level. The RecipientParty can be of type GDT: BusinessDocumentMessageHeaderParty. The RecipientParty includes the following elements: InternalID, StandardID, and ContactPerson. The RecipientParty can be filled by the sending application to name a contact person for problems that may occur with a message. This can be useful if an additional infrastructure, such as a marketplace, is located between the sender and the recipient. The RecipientParty can be used to transfer a message and can be ignored by the receiving application. RecipientParty can be filled by the sender if the FreightOrderExecution Package cannot be used to transfer the participating parties.
The FreightOrderExecution package can group the FreightOrderExecution together with its packages. The FreightOrderExecution package includes the FreightOrderExecution entity and the Confirmation package. The FreightOrderExecution interface can be used to delegate execution of planned transportation of goods, from shippers to consignees, to transportation execution processing of an ERP system. The attributes and elements located directly at the FreightOrder entity include @actioncode and ID. @actioncode can be a coded representation of an instruction to a message recipient describing how to process a transmitted element. @actioncode can be based on GDT: ActionCode. ID can be a unique identifier of a FreightOrder. ID can be based on GDT: BusinessTransactionDocumentID. In some implementations, the attribute @actioncode may only contain the two values “01—Create” and “02—Change”.
In some implementations, the ID is not changed once a FreightOrder has been created. In some implementations, the Complete Transmission Indicator is set to true, (i.e., the complete message content may be transmitted in every message). As a consequence, previously transferred data that is not sent with the change message may be deleted.
The Confirmation package can group the Confirmation with its packages. The Confirmation package includes the Confirmation entity and the HeaderInformation package. Confirmation can be a confirmation of an agreement between a transportation service provider and an ordering party on transportation of goods from a single ship-from party to a single ship-to party in accordance with agreed terms and conditions.
The HeaderInformation package can group dates, total values, document and references related to a freight order. The HeaderInformation package includes the following entities: DateTimePeriods, NatureOfCargo, TotalQuantity, TotalAmount, TextCollection, and BusinessTransactionDocumentReference.
The message data type FreightOrderInvoicingPreparationRequestMessage includes business information relevant for sending a business document in a message, and the FreightOrderInvoicingPreparation included in a business document. The message data type FreightOrderInvoicingPreparationRequestMessage includes the MessageHeader and FreightOrderInvoicingPreparation packages. The message data type FreightOrderInvoicingPreparationRequestMessage can provide a structure for the message type FreightOrderInvoicingPreparationRequest and for interfaces that are based on it.
A MessageHeader package can group together business information relevant for sending a business document in a message. The MessageHeader package includes the MessageHeader entity. A MessageHeader can group together business information from the perspective of the sending application in order to identify a business document in a message, provide information about the sender, and provide information about the recipient. The MessageHeader can be divided up into the SenderParty and RecipientParty entities. The MessageHeader can be of type GDT: BusinessDocumentMessageHeader. The MessageHeader includes the following elements: ID, ReferenceID, and CreationDateTime. The MessageID can be set by the sending application. With the ReferencedMessageID, reference can be made in the current BusinessDocument to a previous BusinessDocument.
A SenderParty can be a party responsible for sending a business document at a business application level. The SenderParty can be of type GDT: BusinessDocumentMessageHeaderParty. The SenderParty includes the following elements: InternalID, StandardID, and ContactPerson. The SenderParty can be filled by the sending application to name a contact person for problems with a message. A contact person can be useful if an additional infrastructure, such as a marketplace, is located between the sender and the recipient. The SenderParty can be used to transfer a message and can be ignored by the receiving application. SenderParty can be filled by the sender if the participating parties are not transferred with the FreightOrderInvoicingPreparation Package.
A RecipientParty can be a party responsible for receiving a business document at a business application level. The RecipientParty can be of type GDT: BusinessDocumentMessageHeaderParty. The RecipientParty includes the following elements: InternalID, StandardID, and ContactPerson. The RecipientParty can be filled by the sending application to name a contact person for problems that may occur with a message. A contact person can be useful if an additional infrastructure, such as a marketplace, is located between the sender and the recipient. The RecipientParty can be used to transfer a message and can be ignored by the receiving application. RecipientParty can be filled by the sender if the FreightOrderInvoicingPreparation Package cannot be used to transfer the participating parties.
The FreightOrderInvoicingPreparation package can group the FreightOrderInvoicingPreparation with its packages. The FreightOrderInvoicingPreparation package includes the FreightOrderInvoicingPreparation entity and the Request package. A FreightOrderInvoicingPreparation can be used in purchase order processing for the preparation of supplier invoicing. The attributes and elements located directly at the FreightOrderInvoicingPreparation entity include @actioncode and ID. @actioncode can be a coded representation of an instruction to a message recipient describing how to process a transmitted element. @actioncode can be based on GDT: ActionCode. ID can be a unique identifier of a FreightOrder. ID can be based on GDT: BusinessTransactionDocumentID. In some implementations, the attribute @actioncode may include the two values “01—Create” and “02—Change”.
The Request package can group a Request with its packages. The Request package includes the Request entity and the following packages: HeaderInformation, PartyInformation, TransportationChargesInformation, and ShipmentOrder.
The HeaderInformation package can group dates, total values, document and references related to freight order invoicing preparation. The HeaderInformation package includes the following entities: PurchaseBusinessArea, DateTimePeriods, NatureOfCargo, TotalQuantity, TotalAmount, TextCollection, and BusinessTransactionDocumentReference.
The PurchaseBusinessArea can be a purchase specific area within an enterprise. For example, a PurchaseBusinessArea can be a purchasing organization or purchasing group. The structure of PurchaseBusinessArea includes the PurchasingOrganisationID and PurchasingGroupID elements. PurchasingOrganisationID can be an identifier for a purchasing organisation, and can be based on GDT: OrganisationalCentreID. PurchasingGroupID can be an identifier for a purchasing group, and can be based on GDT: OrganisationalCentreID.
DateTimePeriods can specify a requested and an acceptable date, time and period applying to a shipment request (e.g. date and time of document issue). A requested period can be a period in which an event is requested to take place. An acceptable period can be a period in which an event may take place at an earliest start date/time to a latest end date/time. The elements located directly at the DateTimePeriods entity include RequestedFulfillmentPeriod, AcceptableFulfillmentPeriod, and PeriodRoleCode. RequestedFulfillmentPeriod can be a period which is requested depending on the semantics of the PeriodRoleCode. RequestedFulfillmentPeriod can be based on GDT: DATETIMEPERIOD, Qualifier: RequestedFulfillment. AcceptableFulfillmentPeriod can be a period which is acceptable depending on the semantics of the PeriodRoleCode. AcceptableFulfillmentPeriod can be based on GDT: DATETIMEPERIOD, Qualifier: AcceptableFulfillment. PeriodRoleCode can be a coded representation of business semantics of the two periods defined by the entities RequestedFulfillmentPeriod and AcceptableFulfillmentPeriod. PeriodRoleCode can be based on GDT: PeriodRoleCode. In some implementations, RequestedFulfillmentPeriod and AcceptableFulfillmentPeriod are optional, but in every instance one of them may be filled.
NatureOfCargo can indicate a nature of cargo related to a shipment request (e.g., palletized, containerized, documents). The structure of NatureOfCargo includes the ClassificationCode element. ClassificationCode can be a coded representation of a classification of a nature of cargo. ClassificationCode can be based on GDT: NatureOfCargoClassificationCode.
TotalQuantity can specify a total quantity which is related to a whole shipment request (e.g., total number of equipment, total number of items). The structure of TotalQuantity includes the elements Quantity, RoleCode, and TypeCode. Quantity can be a non-monetary numerical specification of an amount in a unit of measurement. Quantity can be based on GDT: Quantity. RoleCode can be a coded representation of a role of a quantity, and can be based on GDT: QuantityRoleCode. TypeCode can be a coded representation of a type of quantity that is based on a measurable characteristic of an object or physical phenomenon. TypeCode can be based on GDT: QuantityTypeCode. In some implementations, QuantityRoleCode and QuantityTypeCode are optional, but in every instance one of them can be filled.
TotalAmount can specify a cumulated monetary amount related to a shipment request (e.g., duty amount, insurance amount, total value). The structure of TotalAmount includes the Amount and RoleCode elements. Amount can be an amount with a corresponding currency unit, and can be based on CDT: Amount. RoleCode can be a coded representation of a role of an amount, and can be based on GDT: AmountRoleCode.
TextCollection can be a group of textual information that relates to a shipment request. The structure of TextCollection includes the TextCollection element. TextCollection can be based on GDT: TextCollection.
BusinessTransactionDocumentReference can specify a business document reference that is related to a whole shipment request. BusinessTransactionDocumentReference includes the DateTimePeriod entity. The structure of BusinessTransactionDocumentReference includes the following elements: BusinessTransactionDocumentReference, BusinessTransactionDocumentRelationshipRoleCode, BusinessTransactionDocumentRelationshipTypeCode, TransportationDocumentTypeCode, TransportationDocumentNote, and TransportationDocumentID. BusinessTransactionDocumentReference can be a unique reference to other business documents or business document items that are of significance within each respective business process. BusinessTransactionDocumentReference can be based on GDT: BusinessTransactionDocumentReference.
BusinessTransactionDocumentRelationshipRoleCode can be a coded representation of a role that a business document or a business document item has when set against another business document or business document item with a relationship. BusinessTransactionDocumentRelationshipRoleCode can be based on GDT: BusinessTransactionDocumentRelationshipRoleCode. BusinessTransactionDocumentRelationshipTypeCode can be a coded representation of a relationship between two business documents or business document items. BusinessTransactionDocumentRelationshipTypeCode can be based on GDT: BusinessTransactionDocumentRelationshipTypeCode.
TransportationDocumentTypeCode can be a coded representation of a documentation type. TransportationDocumentTypeCode can be based on GDT: TransportationDocumentTypeCode. TransportationDocumentNote can be a short Note on documentation, and can be based on GDT: SHORT_Note. TransportationDocumentID can be a unique identifier for a transportation document, and can be based on GDT: TransportationDocumentID. RelationshipTypeCode and RelationshipRoleCode are both optional. In some implementations, if used, both may be filled. Either the combination BusinessTransactionDocumentReference, BusinessTransactionDocumentRelationshipRoleCode, BusinessTransactionDocumentRelationshipTypeCode or TransportationDocumentTypeCode, TransportationDocumentNote, TransportationDocumentID may be filled.
The PartyInformation package includes information regarding a party of freight order invoicing preparation (e.g., Shipper, Carrier, Agent). The PartyInformation package includes the Party entity. Party includes information exchanged, in accordance with common business understanding, in business documents, about a party involved in business transactions. This information can be used to identify the party and the party's address, as well as the party's contact person and the contact person's address. This identification can take place using an internal ID, a standardized ID, or IDs assigned by the parties involved. The Party entity includes the following entities: Amount, DateTimePeriods, TransportationDocumentInformation, and BusinessTransactionDocumentReference.
The structure of Party includes the elements Party, RoleCode, and FormattedName. A Party includes information exchanged, in accordance with common business understanding, in business documents, about a party involved in business transactions. This information can be used to identify the party and the party's address, as well as the party's contact person and the contact person's address. This identification can take place using an internal ID, a standardized ID, or IDs assigned by the parties involved. Party can be based on GDT: BusinessTransactionDocumentParty. RoleCode can be a coded representation of a PartyRoleCode which specifies which rights and obligations the party has regarding a business object and corresponding processes. In some implementations, a PartyRole is assigned to exactly one PartyRoleCategory and refines its semantics. RoleCode can be based on GDT: PartyRoleCode. FormattedName can be a complete, formatted name of a party, and can be based on GDT: LONG_Name, Qualifier: PartyFormatted.
BusinessTransactionDocumentReference can specify a business document reference that is related to a party. BusinessTransactionDocumentReference includes the DateTimePeriod entity. The structure of BusinessTransactionDocumentReference includes the following elements: BusinessTransactionDocumentReference, BusinessTransactionDocumentRelationshipRoleCode, BusinessTransactionDocumentRelationshipTypeCode, TransportationDocumentTypeCode, TransportationDocumentNote, and TransportationDocumentID. BusinessTransactionDocumentReference can be a unique reference to other business documents or business document items that are of significance within each respective business process. BusinessTransactionDocumentReference can be based on GDT: BusinessTransactionDocumentReference.
BusinessTransactionDocumentRelationshipRoleCode can be a coded representation of a role that a business document or a business document item can have when set against another business document or business document item with a relationship. BusinessTransactionDocumentRelationshipRoleCode can be based on GDT: BusinessTransactionDocumentRelationshipRoleCode. BusinessTransactionDocumentRelationshipTypeCode can be a coded representation of a relationship between two business documents or business document items. BusinessTransactionDocumentRelationshipTypeCode can be based on GDT: BusinessTransactionDocumentRelationshipTypeCode. TransportationDocumentTypeCode can be a coded representation of a documentation type. TransportationDocumentTypeCode can be based on GDT: TransportationDocumentTypeCode.
TransportationDocumentNote can be a short Note on documentation, and can be based on GDT: SHORT_Note. TransportationDocumentID can be a unique identifier for a transportation document, and can be based on GDT: TransportationDocumentID. RelationshipTypeCode and RelationshipRoleCode are both optional. In some implementations, if used, both may be filled. Either the combination BusinessTransactionDocumentReference, BusinessTransactionDocumentRelationshipRoleCode, BusinessTransactionDocumentRelationshipTypeCode or TransportationDocumentTypeCode, TransportationDocumentNote, TransportationDocumentID may be filled.
The TransportationChargesInformation package includes information regarding transportation charge calculation specific components related to a FreightOrderInvoicingPreparation. The TransportationChargesInformation package includes the TransportationChargesInformation entity. The entity TransportationChargesInformation can define a relationship between transportation charges and an origin of these charges. The TransportationChargesInformation entity includes the TransportationCharges entity. The structure of TransportationChargesInformation includes the TransportationChargesUsageCode element. TransportationChargesUsageCode can be a coded representation of usage of the TransportationCharges. The usage can point out if subsequent information represents a revenue view or cost view on transportation charges. TransportationChargesUsageCode can be based on GDT: TransportationChargesUsageCode.
TransportationCharges can be a summary of determined transportation charge specific components for a transportation business case. TransportationCharges includes the following entities: Location, TextCollection, Currency, ExchangeRate, PercentElement, DateTimePeriod, BusinessTransactionDocumentReference, TaxDetail, PaymentInstruction, CashDiscountTerms, and Element. The structure of TransportationCharges includes the following elements: ID, FreightAgreementID, CalculationOriginCode, TariffID, and CalculationSheetID. ID can be a unique identifier of TransportationCharges in a ShipmentRequest, and can be based on GDT: TransportationChargesID. FreightAgreementID can be an identification of a Freight Agreement which includes and points to a configuration for a Transportation Charges Calculation.
FreightAgreementID can be based on GDT: FreightAgreementID. CalculationOriginCode can be a coded representation of an origin of a transportation charges calculation. The calculation can be done automatically based on system configuration. Data for a calculation, including results, can be manually entered or received from another business system via a message. In some implementations, there can be a clear distinction of the origin of TransportationChargesCalculation details such as the TransportationChargesCalculationSheet and its TransportationChargeElements. A distinction can give information whether the calculation was done completely automatically, or if results were manually adopted. CalculationOriginCode can be based on GDT: TransportationChargesOriginCode.
TariffID can be an identifier for a transportation charges tariff. A transportation charges tariff can be a specific combination of transportation charges calculation sheet and terms and conditions. Terms and conditions can define if a certain transportation charges calculation sheet and its related rates are applicable for a transportation business case. TariffID can be based on GDT: TransportationChargesTariffID. CalculationSheetID can be a unique identifier for a transportation charges calculation sheet. A TransportationChargesCalculationSheet can represent a configuration for how to calculate transportation charges for a transportation business case. A TransportationChargesCalculationSheet includes instructions describing which charges are applicable, which data from the transportation business case can be considered for a calculation, how the underlying transportation charge rates are determined, and which special calculation methods may be considered. CalculationSheetID can be based on GDT: TransportationChargesCalculationSheetID.
A ShipmentOrder package can specify or group together the data related to a Shipment Order which is assigned to a freight order invoicing preparation. A ShipmentOrder package includes the ShipmentOrder entity and the Request package. ShipmentOrder can be an agreement between an ordering party and a transportation service provider on the shipment of goods from a single shipper to a single consignee in accordance with agreed terms and conditions. The structure of ShipmentOrder includes the ID element. ID can be a unique identifier of a ShipmentOrder, and can be based on GDT: BusinessTransactionDocumentID.
The Request package can group a Request with its packages. The Request package includes the Request entity and the following packages: HeaderInformation, PartyInformation, LocationInformation, TransportationStageInformation, TransportationUnitResourceInformation, PackageInformation, TransportationChargesInformation, and Item. In some implementations, the Request package is filled for all of the shipment orders which are assigned to a freight order invoicing preparation. Request can be an agreement between a transportation service provider and an ordering party on the transportation of goods from a single ship-from party to a single ship-to party in accordance with agreed terms and conditions. The elements located directly at the Request entity include DeliveryTerms. DeliveryTerms can be a collection of conditions and agreements that apply when delivering ordered goods and providing services and activities. DeliveryTerms can be based on GDT: DeliveryTerms.
The HeaderInformation package can group dates, total values, document and references related to a shipment order. The HeaderInformation package includes the following entities: DateTimePeriods, NatureOfCargo, TotalQuantity, TotalAmount, TextCollection, TransportationServiceRequirement, and BusinessTransactionDocumentReference.
DateTimePeriods can specify a requested and an acceptable date, time and period applying to a shipment request (e.g. date and time of document issue). A requested period can be a period in which an event is requested to take place. An acceptable period can be a period in which an event may take place at an earliest start date/time to a latest end date/time. The elements located directly at the DateTimePeriods entity include RequestedFulfillmentPeriod, AcceptableFulfillmentPeriod, and PeriodRoleCode. RequestedFulfillmentPeriod can be a period which is requested depending on semantics of the PeriodRoleCode. RequestedFulfillmentPeriod can be based on GDT: DATETIMEPERIOD, Qualifier: RequestedFulfillment. AcceptableFulfillmentPeriod can be a period which is acceptable depending on semantics of the PeriodRoleCode. AcceptableFulfillmentPeriod can be based on GDT: DATETIMEPERIOD, Qualifier: AcceptableFulfillment. PeriodRoleCode can be a coded representation of business semantics of the two periods defined by the entities RequestedFulfillmentPeriod and AcceptableFulfillmentPeriod. PeriodRoleCode can be based on GDT: PeriodRoleCode. In some implementations, RequestedFulfillmentPeriod and AcceptableFulfillmentPeriod are optional, but in every instance one of them may be filled.
NatureOfCargo can indicate a nature of cargo related to a shipment request (e.g., palletized, containerized, documents). The structure of NatureOfCargo includes the element ClassificationCode. ClassificationCode can be a coded representation of a classification of a nature of cargo. ClassificationCode can be based on GDT: NatureOfCargoClassificationCode.
TotalQuantity can specify a total quantity which is related to a whole shipment request (e.g., total number of equipment, total number of items). The structure of TotalQuantity includes the following elements: Quantity, RoleCode, and TypeCode. Quantity can be a non-monetary numerical specification of an amount in a unit of measurement. Quantity can be based on GDT: Quantity. RoleCode can be a coded representation of a role of a quantity, and can be based on GDT: QuantityRoleCode. TypeCode can be a coded representation of a type of quantity that is based on a measurable characteristic of an object or physical phenomenon. TypeCode can be based on GDT: QuantityTypeCode. In some implementations, QuantityRoleCode and QuantityTypeCode are optional, but in every instance one of them may be filled.
TotalAmount can specify a cumulated monetary amount related to a shipment request (e.g., duty amount, insurance amount, total value). The structure of TotalAmount includes the elements Amount and RoleCode. Amount can be an amount with a corresponding currency unit, and can be based on CDT: Amount. RoleCode can be a coded representation of a role of an amount, and can be based on GDT: AmountRoleCode.
TextCollection can be a group of textual information that relates to a shipment request. TextCollection includes the element TextCollection. TextCollection can be based on GDT: TextCollection.
TransportationServiceRequirement can specify a contract and carriage condition and service and priority requirements for a transport which apply to a whole shipment request. The structure of TransportationServiceRequirement includes the following elements: TransportationServiceRequirementCode, AdditionalTransportationServiceRequirementCode, TransportationContractConditionCode, TransportServiceLevelCode, and NatureOfCargoClassificationCode. TransportationServiceRequirementCode can be a coded representation of a requirement related to a transportation service, and can be based on GDT: TransportationServiceRequirementCode. AdditionalTransportationServiceRequirementCode can be a coded representation of an additional requirement related to a transportation service, and can be based on GDT : TransportationServiceRequirementCode, Qualifier: Additional. TransportationContractConditionCode can be a coded representation of a contract and carriage condition, and can be based on GDT: TransportationContractConditionCode.
TransportServiceLevelCode can be a coded representation of agreed or defined services in terms of the delivery of goods with respect to the speed of the delivery. TransportServiceLevelCode can be based on GDT : TransportServiceLevelCode. NatureOfCargoClassificationCode can be a coded representation of a classification of a nature of cargo. NatureOfCargoClassificationCode can be based on GDT : NatureOfCargoClassificationCode.
BusinessTransactionDocumentReference can specify a business document reference that is related to a whole shipment request. BusinessTransactionDocumentReference includes the DateTimePeriod entity. The structure of BusinessTransactionDocumentReference includes the following elements: BusinessTransactionDocumentReference, BusinessTransactionDocumentRelationshipRoleCode, BusinessTransactionDocumentRelationshipTypeCode, TransportationDocumentTypeCode, TransportationDocumentNote, and TransportationDocumentID. BusinessTransactionDocumentReference can be a unique reference to other business documents or business document items that are of significance within each respective business process. BusinessTransactionDocumentReference can be based on GDT: BusinessTransactionDocumentReference.
BusinessTransactionDocumentRelationshipRoleCode can be a coded representation of a role that a business document or a business document item can have when set against another business document or business document item with a relationship. BusinessTransactionDocumentRelationshipRoleCode can be based on GDT: BusinessTransactionDocumentRelationshipRoleCode. BusinessTransactionDocumentRelationshipTypeCode can be a coded representation of a relationship between two business documents or business document items. BusinessTransactionDocumentRelationshipTypeCode can be based on GDT: BusinessTransactionDocumentRelationshipTypeCode.
TransportationDocumentTypeCode can be a coded representation of a type of a documentation. TransportationDocumentTypeCode can be based on GDT: TransportationDocumentTypeCode. TransportationDocumentNote can be a short Note on documentation, and can be based on GDT: SHORT_Note. TransportationDocumentID can be a unique identifier for a transportation document, and can be based on GDT: TransportationDocumentID. RelationshipTypeCode and RelationshipRoleCode are both optional. In some implementations, if used, both may be filled. Either the combination BusinessTransactionDocumentReference, BusinessTransactionDocumentRelationshipRoleCode, BusinessTransactionDocumentRelationshipTypeCode or TransportationDocumentTypeCode, TransportationDocumentNote, TransportationDocumentID may be filled.
The PartyInformation package includes information regarding a party of a shipment request (e.g., Shipper, Carrier, Agent). The PartyInformation package includes the Party entity. Party includes information exchanged, in accordance with common business understanding, in business documents, about a party involved in business transactions. This information can be used to identify the party and the party's address, as well as the party's contact person and the contact person's address. This identification can take place using an internal ID, a standardized ID, or IDs assigned by the parties involved. The Party entity includes the following entities: Amount, DateTimePeriods, TransportationDocumentInformation, and BusinessTransactionDocumentReference.
The structure of the Party entity includes the Party, RoleCode, and FormattedName elements. A Party includes information exchanged, in accordance with common business understanding, in business documents, about a party involved in business transactions. This information can be used to identify the party and the party's address, as well as the party's contact person and the contact person's address. This identification can take place using an internal ID, a standardized ID, or IDs assigned by the parties involved. Party can be based on GDT: BusinessTransactionDocumentParty. RoleCode can be a coded representation of a PartyRoleCode which specifies which rights and obligations the party has regarding a business object and corresponding processes. In some implementations, a PartyRole is assigned to exactly one PartyRoleCategory and refines its semantics. RoleCode can be based on GDT: PartyRoleCode. FormattedName can be a complete, formatted name of a party, and can be based on GDT: LONG_Name, Qualifier: PartyFormatted.
BusinessTransactionDocumentReference can specify a business document reference that is related to a whole shipment request. BusinessTransactionDocumentReference includes the DateTimePeriod entity. The structure of BusinessTransactionDocumentReference includes the following elements: BusinessTransactionDocumentReference, BusinessTransactionDocumentRelationshipRoleCode, BusinessTransactionDocumentRelationshipTypeCode, TransportationDocumentTypeCode, TransportationDocumentNote, and TransportationDocumentID. BusinessTransactionDocumentReference can be a unique reference to other business documents or business document items that are of significance within each respective business process. BusinessTransactionDocumentReference can be based on GDT: BusinessTransactionDocumentReference.
BusinessTransactionDocumentRelationshipRoleCode can be a coded representation of a role that a business document or a business document item can have when set against another business document or business document item with a relationship. BusinessTransactionDocumentRelationshipRoleCode can be based on GDT: BusinessTransactionDocumentRelationshipRoleCode. BusinessTransactionDocumentRelationshipTypeCode can be a coded representation of a relationship between two business documents or business document items. BusinessTransactionDocumentRelationshipTypeCode can be based on GDT: BusinessTransactionDocumentRelationshipTypeCode. TransportationDocumentTypeCode can be a coded representation of a documentation type.
TransportationDocumentTypeCode can be based on GDT: TransportationDocumentTypeCode. TransportationDocumentNote can be a short Note on documentation, and can be based on GDT: SHORT_Note. TransportationDocumentID can be a unique identifier for a transportation document, and can be based on GDT: TransportationDocumentID. RelationshipTypeCode and RelationshipRoleCode are both optional. In some implementations, if used, both maybe filled. Either the combination BusinessTransactionDocumentReference, BusinessTransactionDocumentRelationshipRoleCode, BusinessTransactionDocumentRelationshipTypeCode or TransportationDocumentTypeCode, TransportationDocumentNote, TransportationDocumentID may be filled.
The LocationInformation package includes information regarding a location of the shipment order (e.g., Ship-from location). The LocationInformation package includes the Location entity. Location can specify a physical place that a shipment request refers as relevant for the processing of the shipment request. The LocationInformation package includes the DateTimePeriods entity. The structure of Location includes the elements Location, RoleCode, TypeCode, and Name. Location includes information exchanged in business documents about a location relevant for business transactions. Location can be based on GDT: BusinessTransactionDocumentLocation. RoleCode can be a coded representation of a LocationRole, and can be based on GDT: LocationRoleCode. TypeCode can be a coded representation of a type of a physical location. TypeCode can be based on GDT: LocationTypeCode. Name can be a name of a location, and can be based on GDT: MEDIUM_Name, Qualifier:Location.
The TransportationStageInformation package includes information regarding a transportation stage of a shipment order. A transportation stage can represent a section of a transport. The TransportationStageInformation package includes the TransportationStage entity. TransportationStage can specify details related to a stage of a transport which is part of a shipment order. TransportationStage includes the following entities: Location, BusinessTransactionDocumentReference, and TransportationServiceRequirement. The structure of TransportationStage includes the following elements: ID, OrdinalNumberValue, TypeCode, JourneyID, TransportModeCode, TransportMeansDescriptionCode, TransportMeansDescription, TransportMeansID, TransportMeansHomeCountryCode, 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. 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. TransportMeansHomeCountryCode can be based on GDT: CountryCode, Qualifier: TransportMeansHome. TransportMeansOwnershipTypeCode can be a coded representation of the type of ownership for a means of transport, and can be based on GDT: TransportMeansOwnershipTypeCode. CarrierStandardID can be a standard identifier of a carrier, and can be based on GDT: PartyStandardID. CarrierFormattedName can be a name of a carrier, and can be based on GDT: LONG_Name, Qualifier: PartyFormatted. TransportationTransitDirectionCode can be a coded representation for a transportation transit direction. TransportationTransitDirectionCode can be based on GDT: TransportationTransitDirectionCode. CalculatedDistanceMeasure can be a calculated distance measure, and can be based on GDT: Measure, Qualifier: CalculatedDistance. GivenDistanceMeasure can be a given distance measure, and can be based on GDT: Measure, Qualifier: GivenDistance.
StageLocation can specify a physical place related to a stage. StageLocation includes the DateTimePeriods entity. The structure of StageLocation includes the elements Location, RoleCode, TypeCode, and Name. Location includes information exchanged in business documents about a location relevant for business transactions. Location can be based on GDT: BusinessTransactionDocumentLocation. RoleCode can be a coded representation of a LocationRole, and can be based on GDT: LocationRoleCode. TypeCode can be a coded representation of a type of a physical location, and can be based on GDT: LocationTypeCode. Name can be a name of a location, and can be based on GDT: MEDIUM_Name, Qualifier:Location.
BusinessTransactionDocumentReference can specify a business document reference that is related to a Stage. BusinessTransactionDocumentReference includes the DateTimePeriod entity. The structure of BusinessTransactionDocumentReference includes the following elements: BusinessTransactionDocumentReference, BusinessTransactionDocumentRelationshipRoleCode, BusinessTransactionDocumentRelationshipTypeCode, TransportationDocumentTypeCode, TransportationDocumentNote, and TransportationDocumentID. BusinessTransactionDocumentReference can be a unique reference to other business documents or business document items that are of significance within each respective business process. BusinessTransactionDocumentReference can be based on GDT: BusinessTransactionDocumentReference.
BusinessTransactionDocumentRelationshipRoleCode can be a coded representation of a role that a business document or a business document item can have when set against another business document or business document item with a relationship. BusinessTransactionDocumentRelationshipRoleCode can be based on GDT: BusinessTransactionDocumentRelationshipRoleCode. BusinessTransactionDocumentRelationshipTypeCode can be a coded representation of a relationship between two business documents or business document items. BusinessTransactionDocumentRelationshipTypeCode can be based on GDT: BusinessTransactionDocumentRelationshipTypeCode. TransportationDocumentTypeCode can be a coded representation of a documentation type.
TransportationDocumentTypeCode can be based on GDT: TransportationDocumentTypeCode. TransportationDocumentNote can be a short Note on documentation, and can be based on GDT: SHORT_Note. TransportationDocumentID can be a unique identifier for a transportation document, and can be based on GDT: TransportationDocumentID. RelationshipTypeCode and RelationshipRoleCode are both optional. In some implementations, if used, both may be filled. Either the combination BusinessTransactionDocumentReference, BusinessTransactionDocumentRelationshipRoleCode, BusinessTransactionDocumentRelationshipTypeCode or TransportationDocumentTypeCode, TransportationDocumentNote, TransportationDocumentID may be filled.
TransportationServiceRequirement can specify a contract and carriage condition and service and priority requirements related to a stage. The structure of TransportationServiceRequirement includes the following elements: TransportationServiceRequirementCode, AdditionalTransportationServiceRequirementCode, TransportationContractConditionCode, TransportServiceLevelCode, and NatureOfCargoClassificationCode. TransportationServiceRequirementCode can be a coded representation of a requirement related to a transportation service, and can be based on GDT: TransportationServiceRequirementCode.
AdditionalTransportationServiceRequirementCode can be a coded representation of an additional requirement related to a transportation service, and can be based on GDT: TransportationServiceRequirementCode, Qualifier: Additional. TransportationContractConditionCode can be a coded representation of a contract and carriage condition, and can be based on GDT: TransportationContractConditionCode. TransportServiceLevelCode can be a coded representation of agreed or defined services in terms of the delivery of goods with respect to the speed of the delivery. TransportServiceLevelCode can be based on GDT : TransportServiceLevelCode. NatureOfCargoClassificationCode can be a coded representation of a classification of a nature of cargo, and can be based on GDT : NatureOfCargoClassificationCode.
The TransportationUnitResourceInformation package includes information regarding a transportation unit resource that is relevant for a shipment order (e.g., a container). The TransportationUnitResourceInformation package includes the TransportationUnitResourceInformation entity. TransportationUnitResourceInformation can include information on one or more transportation unit resources, such as a resource type and related properties, or related measures, or handling instructions. A Transportation Unit Resource can be a unit into which goods are loaded and/or from which goods are unloaded. In some implementations, this unit can provide transportation capacity for goods but may or ay not move by itself. TransportationUnitResourceInformation includes the following entities: TransportationStageAssignment, AttachedEquipment, Quantity, Seal, BusinessTransactionDocumentReference, Location, and DangerousGoods.
The structure of TransportationUnitResourceInformation includes the following elements: ID, ResourceNumberValue, ResourceID, ResourceHomeCountryCode, TransportationUnitResourceCategoryCode, TransportationUnitResourceTypeCode, FillLevelCode, ShippingTypeCode, HaulageArrangerCode, TransportationHandlingInstructionCode, and TransportationHandlingInstructionNote. ID can be a unique identifier for a resource information, and can be based on GDT ResourceInformationID. ResourceNumberValue can be a 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. A shipping type can specify how planning and execution of a transportation can be performed.
Transportation terms include detailed specifications on agreed means of transportation, such as shipping or transport type and means of transport to be used. ShippingTypeCode can be based on GDT: ShippingTypeCode. HaulageArrangerCode can be a coded representation of an arranger of a haulage. Haulage can be 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 transportation stage to a transportation unit resource information. The structure of the TransportationStageAssignment includes the ShipmentOrderTransportationStageID element. ShipmentOrderTransportationStageID can be a unique identifier of a TransportationStage in a shipment request, and can be based on GDT: TransportationStageID.
AttachedEquipment can specify equipment attached to a TransportationUnitResource. The structure of AttachedEquipment includes the element ShipmentOrderResourceInformationID. ShipmentOrderResourceInformationID can be a unique identifier of a resource information in a Shipment Order, and can be based on GDT: ResourceInformationID.
Quantity can specify a quantity related to TransportationUnitResourceInformation. The structure of the Quantity entity includes the Quantity, RoleCode and TypeCode elements. Quantity can be a non-monetary numerical specification of an amount in a unit of measurement, and can be based on GDT: Quantity. RoleCode can be a coded representation of a role of a quantity, and can be based on GDT: QuantityRoleCode. TypeCode can be a coded representation of a type of quantity that is based on a measurable characteristic of an object or physical phenomenon, and can be based on GDT: QuantityTypeCode. In some implementations, QuantityRoleCode and QuantityTypeCode are optional, but in every instance one of them may be filled.
Seal can specify a seal related to a TransportationUnitResource. The structure of Seal includes the following elements: ID, PartyRoleCode, PartyFormattedName, and StatusCode. ID can be a unique identifier of a seal, and can be based on GDT: SealID. PartyRoleCode can be a coded representation of a party role, and can be based on GDT: PartyRoleCode. PartyFormattedName can be a complete, formatted name of a party, or the name of a SealingParty. PartyFormattedName can be based on GDT: LONG_Name, Qualifier: PartyFormatted. StatusCode can be a coded representation of a status of a seal, and can be based on GDT: SealStatusCode.
BusinessTransactionDocumentReference can specify a business document reference that is related to a Stage. BusinessTransactionDocumentReference includes the DateTimePeriod entity. The structure of BusinessTransactionDocumentReference includes the following elements: BusinessTransactionDocumentReference, BusinessTransactionDocumentRelationshipRoleCode, BusinessTransactionDocumentRelationshipTypeCode, TransportationDocumentTypeCode, TransportationDocumentNote, and TransportationDocumentID. BusinessTransactionDocumentReference can be a unique reference to other business documents or business document items that are of significance within each respective business process. BusinessTransactionDocumentReference can be based on GDT: BusinessTransactionDocumentReference.
BusinessTransactionDocumentRelationshipRoleCode can be a coded representation of a role that a business document or a business document item can have when set against another business document or business document item with a relationship. BusinessTransactionDocumentRelationshipRoleCode can be based on GDT: BusinessTransactionDocumentRelationshipRoleCode. BusinessTransactionDocumentRelationshipTypeCode can be a coded representation of a relationship between two business documents or business document items. BusinessTransactionDocumentRelationshipTypeCode can be based on GDT: BusinessTransactionDocumentRelationshipTypeCode. TransportationDocumentTypeCode can be a coded representation of a documentation type.
TransportationDocumentTypeCode can be based on GDT: TransportationDocumentTypeCode. TransportationDocumentNote can be a short Note on documentation, and can be based on GDT: SHORT_Note. TransportationDocumentID can be a unique identifier for a transportation document, and can be based on GDT: TransportationDocumentID. RelationshipTypeCode and RelationshipRoleCode are both optional. In some implementations, if used, both may be filled. Either the combination BusinessTransactionDocumentReference, BusinessTransactionDocumentRelationshipRoleCode, BusinessTransactionDocumentRelationshipTypeCode or TransportationDocumentTypeCode, TransportationDocumentNote, TransportationDocumentID may be filled.
Location can specify a physical place related to the TransportationUnitResource. The structure of Location includes the following elements: Location, RoleCode, TypeCode, and Name. Location includes information exchanged in business documents about a location relevant for business transactions. Location can be based on GDT: BusinessTransactionDocumentLocation. RoleCode can be a coded representation of a LocationRole, and can be based on GDT: LocationRoleCode. TypeCode can be a coded representation of a type of a physical location. TypeCode can be based on GDT: LocationTypeCode. Name can be a name of a location, and can be based on GDT: MEDIUM_Name, Qualifier:Location.
DangerousGoods can specify dangerous goods included in a resource. DangerousGoods includes the ContactInformation and TextCollection entities. The structure of DangerousGoods includes the following elements: ID, RegulationsCode, HazardCode, FlashpointMeasureInterval, PackagingGroupCode, EmergencySchedule, TransportEmergencyCardCode, DangerousGoodsLabelCode, DangerousGoodsLabelCode2, DangerousGoodsLabelCode3, PackagingInstructionTypeCode, TransportMeansDescriptionCode, and TransportAuthorisationCode. ID can be a unique identifier for a dangerous good, using the United Nations Dangerous Goods Number. ID can be based on GDT: DangerousGoodsID. RegulationsCode can be a coded representation of national or international dangerous goods rules or regulations, and can be based on GDT: DangerousGoodsRegulationsCode.
HazardCode can be a coded representation of a hazard that is imminent in a dangerous good, and can be based on GDT: DangerousGoodsHazardCode. FlashpointMeasureInterval can be an interval of measures defined by a lower and an upper boundary indicating a flashpoint of a dangerous good, and can be based on GDT: MeasureInterval, Qualifier: Flashpoint. PackagingGroupCode can be a coded representation of the effectiveness of a packaging to transport dangerous goods depending on a degree of danger of the goods. PackagingGroupCode can be based on GDT: DangerousGoodsPackagingGroupCode. EmergencySchedule can be a coded representation of an emergency schedule for dangerous goods. EmergencySchedule identifies an emergency schedule. The DangerousGoodsEmergencySchedule can be used for transports of dangerous goods by sea similar to the Transport Emergency Card which is used for transports of dangerous goods by road.
EmergencySchedule can be based on GDT: DangerousGoodsEmergencySchedule. TransportEmergencyCardCode can be a coded representation of a transport emergency card which specifies how to react in case of an accident, and can be based on GDT: TransportEmergencyCardCode. DangerousGoodsLabelCode can be a coded representation of a label for a dangerous good. In some implementations, DangerousGoodsLabelCode's values are dependant on the DangerousGoodsRegulationsCode. DangerousGoodsLabelCode can be based on GDT: DangerousGoodsLabelCode. DangerousGoodsLabelCode2 can be a coded representation of a label for a dangerous good. In some implementations, DangerousGoodsLabelCode's values are dependant on the DangerousGoodsRegulationsCode. DangerousGoodsLabelCode2 can be based on GDT: DangerousGoodsLabelCode.
DangerousGoodsLabelCode3 can be a coded representation of a label for a dangerous good. In some implementations, DangerousGoodsLabelCode's values are dependant on the DangerousGoodsRegulationsCode. DangerousGoodsLabelCode3 can be based on GDT: DangerousGoodsLabelCode. PackagingInstructionTypeCode can be a coded representation of a packaging instruction. In some implementations, a packaging instruction is an instruction defining which packagings may be used to pack a dangerous good. PackagingInstructionTypeCode can be based on GDT: PackagingInstructionTypeCode. TransportMeansDescriptionCode can be a coded representation of a transport means type with which goods or persons are to be transported, and can be based on GDT: TransportMeansDescriptionCode. TransportAuthorisationCode can be a coded representation of an authorisation for a transportation of dangerous goods. This code can specify an authorisation for the transportation of a particular dangerous good. TransportAuthorisationCode can be based on GDT: DangerousGoodsTransportAuthorisationCode.
The PackageInformation package can describe package information related to a whole shipment order. The PackageInformation package includes the ItemAssignment, TransportationUnitResourceInformationAssignment, and Quantity entities.
The structure of PackageInformation includes the following elements: ID, PackageID, PackageOrdinalNumberValue, PackageNumberValue, PackageTypeCode, PackagingLevelCode, PackageMarkingInstructionCode, and PredecessorPackageID. ID can be a unique identifier for a package information, and can be based on GDT: PackageInformationID. PackageID can be a unique identifier of a package used in this packaging, and can be based on GDT: PackageID. PackageOrdinalNumberValue can be an ordinal number indicating a position of a package in a set of packages. In a transportation document, the position of a package is one that has been specified at shipping time. PackageOrdinalNumberValue can be based on GDT:OrdinalNumberValue, Qualifier: Package.
PackageNumberValue can be a count of the number of packages used in a packaging, and can be based on GDT: NumberValue, Qualifier: Package. PackageTypeCode can be a coded representation of a type of a package, and can be based on GDT: PackageTypeCode. PackagingLevelCode can be a coded representation of a packaging level. A packaging level can specify a rank of packaging in a packaging hierarchy. PackagingLevelCode can be based on GDT: PackagingLevelCode. PackageMarkingInstructionCode can be a coded representation of a marking instruction of a package, and can be based on GDT: PackageMarkingInstructionCode. PredecessorPackageID can be a unique identification of a related package, and can be based on GDT: PackageID. In some implementations, PredecessorPackageID may be filled in case a PackageID is available.
ItemAssignment can specify an assignment of a packaging to an item with corresponding information on quantities. ItemAssignment includes the Quantity entity. The structure of ItemAssignment includes the element ShipmentOrderItemID. ShipmentOrderItemID can be a unique identifier of an item of a ShipmentOrder, and can be based on GDT: BusinessTransactionDocumentItemID.
Quantity can specify a quantity related to an assignment of a packaging to an item. The structure of the Quantity entity includes the following elements: Quantity, RoleCode, and TypeCode. Quantity can be a non-monetary numerical specification of an amount in a unit of measurement. Quantity can be based on GDT: Quantity. RoleCode can be a coded representation of a role of a quantity, and can be based on GDT: QuantityRoleCode. TypeCode can be a coded representation of a type of quantity that is based on a measurable characteristic of an object or physical phenomenon. TypeCode can be based on GDT: QuantityTypeCode. In some implementations, QuantityRoleCode and QuantityTypeCode are optional, but in every instance one of them may be filled.
TransportationUnitResourceInformationAssignment can specify an assignment of a packaging to a TransportationUnitResourceInformation with corresponding quantity information. The structure of TransportationUnitResourceInformationAssignment includes the element ShipmentOrderResourceInformationID. ShipmentOrderResourceInformationID can be a unique identifier of a TransportationUnitResourceInformation in a shipment order. ShipmentOrderResourceInformationID can be based on GDT: ResourceInformationID.
Quantity can specify a quantity related to a TransportationUnitResourceAssignment. The structure of the Quantity entity includes the Quantity, RoleCode, and TypeCode elements. Quantity can be a non-monetary numerical specification of an amount in a unit of measurement. Quantity can be based on GDT: Quantity. RoleCode can be a coded representation of a role of a quantity, and can be based on GDT: QuantityRoleCode. TypeCode can be a coded representation of a type of quantity that is based on a measurable characteristic of an object or physical phenomenon. TypeCode can be based on GDT: QuantityTypeCode. In some implementations, QuantityRoleCode and QuantityTypeCode are optional, but in every instance one of them can be filled.
The TransportationChargesInformation package includes information regarding transportation charge calculation specific components related to a ShipmentOrder. The TransportationChargesInformation package includes the TransportationChargesInformation entity. The TransportationChargesInformation entity can define a relationship between transportation charges and an origin of these charges. The TransportationChargesInformation entity includes the TransportationCharges entity. The structure of TransportationChargesInformation includes the following elements: TransportationChargesUsageCode, ShipmentOrderItemID, ShipmentOrderResourceInformationID, ShipmentOrderPackageInformationID, and ShipmentOrderTransportationStageID. TransportationChargesUsageCode can be a coded representation of a usage of TransportationCharges.
A usage can point out if subsequent information represents a revenue- or cost-view on transportation charges. TransportationChargesUsageCode can be based on GDT: TransportationChargesUsageCode. ShipmentOrderItemID can be a unique identifier of an Item in a ShipmentOrder, and can be based on GDT: BusinessTransactionDocumentItemID. ShipmentOrderResourceInformationID can be a unique identification of a TransportationUnitResource in a ShipmentOrder, and can be based on GDT: ResourceInformationID. ShipmentOrderPackageInformationID can be a unique identification of a PackageInformation in a ShipmentOrder, and can be based on GDT: PackageInformationID. ShipmentOrderTransportationStageID can be a unique identification of a TransportationStage in a ShipmentOrder, and can be based on GDT: TransportationStageID. In some implementations, if none of the identifiers is maintained, transportation charges are related to a whole shipment order.
TransportationCharges can be a summary of determined transportation charge specific components for a transportation business case. TransportationCharges includes the following entities: Location, TextCollection, Currency, ExchangeRate, PercentElement, DateTimePeriod, BusinessTransactionDocumentReference, TaxDetail, PaymentInstruction, CashDiscountTerms, and Element. The structure of TransportationCharges includes the following elements: ID, FreightAgreementID, CalculationOriginCode, TariffID, and CalculationSheetID. ID can be a unique identifier of TransportationCharges in a ShipmentRequest, and can be based on GDT: TransportationChargesID. FreightAgreementID can be an identification of a Freight Agreement which includes and points to a configuration for a Transportation Charges Calculation.
FreightAgreementID can be based on GDT: FreightAgreementID. CalculationOriginCode can be a coded representation of an origin of a transportation charges calculation. A calculation can be done automatically based on a system configuration. All necessary data for a calculation, including results, can be manually entered or received from another business system via a message. In some implementations, there may be a clear distinction of an origin of TransportationChargesCalculation details like a TransportationChargesCalculationSheet and its TransportationChargeElements. A distinction can give information whether a calculation was done completely automatically, or if results were manually adopted. CalculationOriginCode can be based on GDT: TransportationChargesOriginCode. TariffID can be an identifier for a transportation charges tariff.
A transportation charges tariff can be a specific combination of transportation charges calculation sheet and terms and conditions. Terms and conditions can define if a certain transportation charges calculation sheet and its related rates are applicable for a transportation business case. TariffID can be based on GDT: TransportationChargesTariffID. CalculationSheetID can be a unique Identifier for a transportation charges calculation sheet. A TransportationChargesCalculationSheet can represent a configuration to calculate transportation charges for a transportation business case. A TransportationChargesCalculationSheet includes instructions describing which charges are applicable, which data from a transportation business case may be considered for a calculation, how the underlying transportation charge rates are determined, and which special calculation methods may be considered. CalculationSheetID can be based on GDT: TransportationChargesCalculationSheetID.
The Item package includes information regarding products included in a shipment order and additional information on these products. The Item package includes the Item entity and the following packages: ItemInformation, LocationInformation, and TransportGoodsInformation. Item can specify products included in a shipment request and additional information about these products. The structure of Item includes the following elements: ID, OriginCountryCode, DestinationCountryCode, ShippingTypeCode, HaulageArrangerCode, TemperatureMeasureInterval, TransportationHandlingInstructionCode, and TransportationHandlingInstructionNote. ID can be a unique identifier of an Item in a shipment request, and can be based on GDT: BusinessTransactionDocumentItemID. OriginCountryCode can be a country of origin of goods that are considered in a shipment request.
OriginCountryCode can be based on GDT: CountryCode, Qualifier: Origin. DestinationCountryCode can be the ultimate country of destination of goods that are considered in a shipment request. DestinationCountryCode can be based on GDT: CountryCode, Qualifier: Destination. ShippingTypeCode can be a coded representation of a shipping type. A shipping type can specify how planning and execution of a transportation can be performed. Transportation terms include detailed specifications on agreed means of transportation, such as shipping or transport type and means of transport to be used. ShippingTypeCode can be based on GDT: ShippingTypeCode. HaulageArrangerCode can be a coded representation of an arranger of a haulage. Haulage can be inland transportation of cargo.
HaulageArrangerCode can be based on GDT: HaulageArrangerCode. TemperatureMeasureInterval can be an interval of temperature measures defined by a lower and an upper boundary and a measure type code. TemperatureMeasureInterval can be based on GDT: MeasureInterval, Qualifier: Temperature. TransportationHandlingInstructionCode can be a coded representation of a transportation handling instruction. TransportationHandlingInstructionCode can be based on GDT: TransportationHandlingInstructionCode. TransportationHandlingInstructionNote can be a note regarding a transportation handling instruction, and can be based on GDT: TransportationHandlingInstructionNote. In some implementations, for a measure related to a temperature, the units of measurement Celsius and Fahrenheit are allowed.
The ItemInformation package can specify products included in a shipment order and additional information related to the transportation of these products. The ItemInformation package includes the following entities: Amount, TextCollection, NatureOfCargo, Quantity, BusinessTransactionDocumentReference, DangerousGoods, TransportationStageAssignment, and TransportationUnitResourceInformationAssignment.
An Amount can specify a monetary amount associated with an item, such as a declared value, or insured value. The structure of the Amount entity includes the Amount and RoleCode elements. Amount can be an amount with a corresponding currency unit, and can be based on CDT: Amount. RoleCode can be a coded representation of a role of an amount, and can be based on GDT: AmountRoleCode.
TextCollection can be a group of textual information that relates to an item. The structure of the TextCollection entity includes the element TextCollection. TextCollection can be based on GDT: TextCollection. NatureOfCargo can indicate a nature of cargo related to an item (e.g., palletized, containerized, documents). The structure of NatureOfCargo includes the element ClassificationCode. ClassificationCode can be a coded representation of a classification of a nature of cargo. ClassificationCode can be based on GDT: NatureOfCargoClassificationCode.
Quantity can specify a quantity related to an item. The structure of the Quantity entity includes the elements Quantity, RoleCode, and TypeCode. Quantity can be a non-monetary numerical specification of an amount in a unit of measurement. Quantity can be based on GDT: Quantity. RoleCode can be a coded representation of a role of a quantity, and can be based on GDT: QuantityRoleCode. TypeCode can be a coded representation of a type of quantity that is based on a measurable characteristic of an object or physical phenomenon. TypeCode can be based on GDT: QuantityTypeCode.
In some implementations, QuantityRoleCode and QuantityTypeCode are optional, but in every instance one of them may be filled. BusinessTransactionDocumentReference can specify a business document reference that is related to an item. BusinessTransactionDocumentReference includes the DateTimePeriod entity. The structure of BusinessTransactionDocumentReference includes the following elements: BusinessTransactionDocumentReference, BusinessTransactionDocumentRelationshipRoleCode, BusinessTransactionDocumentRelationshipTypeCode, TransportationDocumentTypeCode, TransportationDocumentNote, and TransportationDocumentID. BusinessTransactionDocumentReference can be a unique reference to other business documents or business document items that are of significance within each respective business process. BusinessTransactionDocumentReference can be based on GDT: BusinessTransactionDocumentReference.
BusinessTransactionDocumentRelationshipRoleCode can be a coded representation of a role that a business document or a business document item can have when set against another business document or business document item with a relationship. BusinessTransactionDocumentRelationshipRoleCode can be based on GDT: BusinessTransactionDocumentRelationshipRoleCode. BusinessTransactionDocumentRelationshipTypeCode can be a coded representation of a relationship between two business documents or business document items. BusinessTransactionDocumentRelationshipTypeCode can be based on GDT: BusinessTransactionDocumentRelationshipTypeCode.
TransportationDocumentTypeCode can be a coded representation of the type of a documentation. TransportationDocumentTypeCode can be based on GDT: TransportationDocumentTypeCode. TransportationDocumentNote can be a short Note on documentation, and can be based on GDT: SHORT_Note. TransportationDocumentID can be a unique identifier for a transportation document, and can be based on GDT: TransportationDocumentID. RelationshipTypeCode and RelationshipRoleCode are both optional. In some implementations, if used, both can be filled. Either the combination BusinessTransactionDocumentReference, BusinessTransactionDocumentRelationshipRoleCode, BusinessTransactionDocumentRelationshipTypeCode or TransportationDocumentTypeCode, TransportationDocumentNote, TransportationDocumentID may be filled.
DangerousGoods can specify the identification, description and classification of dangerous goods related to an item. DangerousGoods includes the following entities: Quantity, TextCollection, and TransportationUnitResourceInformationAssignment.
Quantity can specify a quantity of DangerousGoods. The structure of Quantity includes the following elements: Quantity, RoleCode, and TypeCode. Quantity can be a non-monetary numerical specification of an amount in a unit of measurement. Quantity can be based on GDT: Quantity. RoleCode can be a coded representation of a role of a quantity, and can be based on GDT: QuantityRoleCode. TypeCode can be a coded representation of a type of quantity that is based on a measurable characteristic of an object or physical phenomenon. TypeCode can be based on GDT: QuantityTypeCode. In some implementations, QuantityRoleCode and QuantityTypeCode are optional, but in every instance one of them can be filled.
TextCollection can be a group of textual information that relates to ItemDangerousGoods. The structure of the TextCollection entity includes the TextCollection element. TextCollection can be based on GDT: TextCollection.
TransportationUnitResourceAssignment can specify an assignment of dangerous goods of an item to a TransportationUnitResource with corresponding quantity information. TransportationUnitResourceAssignment includes the Quantity entity. The structure of TransportationUnitResourceInformationAssignment includes the ShipmentOrderResourceInformationID element. ShipmentOrderResourceInformationID can be a unique identifier of a TransportationUnitResource. ShipmentOrderResourceInformationID can be based on GDT: ResourceInformationID.
Quantity can specify a quantity related to dangerous goods assigned to a Resource. The structure of the Quantity entity includes the Quantity, RoleCode, and TypeCode elements. Quantity can be a non-monetary numerical specification of an amount in a unit of measurement. Quantity can be based on GDT: Quantity. RoleCode can be a coded representation of a role of a quantity, and can be based on GDT: QuantityRoleCode. TypeCode can be a coded representation of a type of quantity that is based on a measurable characteristic of an object or physical phenomenon. TypeCode can be based on GDT: QuantityTypeCode. In some implementations, QuantityRoleCode and QuantityTypeCode are optional, but in every instance one of them has to be filled.
The TransportationStageAssignment can specify the assignment of an item to a transportation stage with corresponding quantity information. The structure of TransportationStageAssignment includes the element ShipmentOrderTransportationStageID. ShipmentOrderTransportationStageID can be a unique identifier of a TransportationStage. ShipmentOrderTransportationStageID can be based on GDT: TransportationStageID.
The Quantity can specify a quantity related to an item assigned to a transportation stage. The structure of the Quantity entity includes the Quantity, RoleCode and TypeCode elements. Quantity can be a non-monetary numerical specification of an amount in a unit of measurement. Quantity can be based on GDT: Quantity. RoleCode can be a coded representation of a role of a quantity, and can be based on GDT: QuantityRoleCode. TypeCode can be a coded representation of a type of quantity that is based on a measurable characteristic of an object or physical phenomenon. TypeCode can be based on GDT: QuantityTypeCode. In some implementations, QuantityRoleCode and QuantityTypeCode are optional, but in every instance one of them can be filled.
TransportationUnitResourceInformationAssignment can specify an assignment of an item to a transportation unit resource information with corresponding quantity information. TransportationUnitResourceInformationAssignment includes the Quantity entity. The structure of TransportationUnitResourceInformationAssignment includes the ShipmentOrderTransportationUnitResourceID element. ShipmentOrderTransportationUnitResourceID can be a unique identifier of a TransportationUnitResource, and can be based on GDT: ResourceID.
Quantity can specify a quantity related to an item which is assigned to a TransportationUnitResource. The structure of the Quantity entity includes the Quantity, RoleCode and TypeCode elements. Quantity can be a non-monetary numerical specification of an amount in a unit of measurement. Quantity can be based on GDT: Quantity. RoleCode can be a coded representation of a role of a quantity, and can be based on GDT: QuantityRoleCode. TypeCode can be a coded representation of a type of quantity that is based on a measurable characteristic of an object or physical phenomenon. TypeCode can be based on GDT: QuantityTypeCode. In some implementations, QuantityRoleCode and QuantityTypeCode are optional, but in every instance one of them can be filled.
The ItemLocationInformation package includes information regarding a location that is related to an item. ItemLocationInformation includes the Location entity. Location can specify a physical place which is part of a shipment request item. Location includes the DateTimePeriods entity. The structure of the Location entity includes the following elements: Location, RoleCode, TypeCode, and Name. Location includes information exchanged in business documents about a location relevant for business transactions. Location can be based on GDT: BusinessTransactionDocumentLocation. RoleCode can be a coded representation of a LocationRole, and can be based on GDT: LocationRoleCode. TypeCode can be a coded representation of a type of a physical location. TypeCode can be based on GDT: LocationTypeCode. Name can be a name of a location, and can be based on GDT: MEDIUM_Name, Qualifier:Location.
The TransportationGoodsInformation package can group information on goods that are to be transported according to an item. The TransportationGoodsInformation package includes the ProductInformation and TransportationGoodsIdentification entities. ProductInformation includes information on a commodity that is the object of a business activity of a company and serves to generate value for the company. ProductInformation can be tangible or intangible. A product can have relationships to other products or objects. For example, there can be a service for a specially manufactured product.
The structure of ProductInformation includes the Product and ProductDescription elements. Product includes information exchanged, in accordance with common business understanding, in business documents, about a product. Product can be based on GDT: BusinessTransactionDocumentProduct. ProductDescription can be a natural-language representation of properties of a product. ProductDescription can be based on GDT: SHORT_Description, Qualifier: Product. TransportationGoodsIdentification can describe content identification related to a PackagingItem. The structure of TransportationGoodsIdentification includes the elements: TransportationGoodsIdentifierTypeCode, LowerBoundaryTransportationGoodsID, and UpperBoundaryTransportationGoodsID. TransportationGoodsIdentifierTypeCode can be a coded representation of a type of identifier for transportation goods. Goods can be movable property, merchandise or wares, to name a few examples.
Transportation Goods can be goods that are to be transported. TransportationGoodsIdentifierTypeCode can be based on GDT: TransportationGoodsIdentifierTypeCode. LowerBoundaryTransportationGoodsID can be a lower boundary of a TransportationGoodsID interval. In some implementations, LowerBoundaryTransportationGoodsID may also be used for intervals that contain a single value. LowerBoundaryTransportationGoodsID can be based on GDT: TransportationGoodsID, Qualifier: LowerBoundary. UpperBoundaryTransportationGoodsID can be an upper boundary of a TransportationGoodsID interval. UpperBoundaryTransportationGoodsID can be based on GDT: TransportationGoodsID, Qualifier: UpperBoundary.
Message Data Type FreightOrderInvoicingPreparationCancelRequestMessage The message data type FreightOrderInvoicingPreparationCancelRequestMessage can group together business information relevant for sending a business document in a message, and the FreightOrderInvoicingPreparation object in a business document. The message data type FreightOrderInvoicingPreparationCancelRequestMessage includes the MessageHeader and FreightOrderInvoicingPreparation packages. The message data type FreightOrderInvoicingPreparationCancelRequestMessage can provide a structure for the message type FreightOrderInvoicingPreparationCancelRequest and the interfaces that are based on it.
A MessageHeader package can group together business information relevant for sending a business document in a message. The MessageHeader package includes the MessageHeader entity. A MessageHeader can group together business information from the perspective of the sending application to identify a business document in a message, to provide information about the sender, or to provide information about the recipient. The MessageHeader can be divided up into the SenderParty and RecipientParty entities. MessageHeader can be of type GDT: BusinessDocumentMessageHeader. The MessageHeader includes the following elements: ID, ReferenceID, and CreationDateTime. The MessageID can be set by the sending application. With the ReferencedMessageID, reference can be made in the current BusinessDocument to a previous BusinessDocument.
A SenderParty can be a party responsible for sending a business document at a business application level. The SenderParty can be of type GDT: BusinessDocumentMessageHeaderParty. The SenderParty includes the following elements: InternalID, StandardID, and ContactPerson. The SenderParty can be filled by the sending application to name a contact person for problems with the message. A contact person can be useful if an additional infrastructure, such as a marketplace, is located between the sender and the recipient. The SenderParty can be used to transfer a message and can be ignored by the receiving application. SenderParty can be filled by the sender if the participating parties are not transferred with the FreightOrderInvoicingPreparation Package.
A RecipientParty can be a party responsible for receiving a business document at a business application level. The RecipientParty can be of type GDT: BusinessDocumentMessageHeaderParty. The RecipientParty includes the following elements: InternalID, StandardID, and ContactPerson. The RecipientParty can be filled by the sending application to name a contact person for problems that may occur with the message. A contact person can be useful if an additional infrastructure, such as a marketplace, is located between the sender and the recipient. The RecipientParty can be used to transfer a message and can be ignored by the receiving application. RecipientParty can be filled by the sender if the FreightOrderInvoicingPreparation Package cannot be used to transfer the participating parties.
The FreightOrderInvoicingPreparation package can group together information about the FreightOrderInvoicingPreparation. The FreightOrderInvoicingPreparation package includes the FreightOrderInvoicingPreparation entity and the BusinessTransactionDocumentReference package.
A freight order invoicing preparation can be used in purchase order processing for preparation of supplier invoicing. The attributes and elements located directly at the FreightOrderInvoicingPreparation entity include ID. ID can be a unique identifier of a FreightOrder, and can be based on GDT: BusinessTransactionDocumentID.
The Request package can group a Request with its packages. The Request package includes the Request entity and the BusinessTransactionDocumentReference package. The structure of Request includes the element RequestedCancellationDate. RequestedCancellationDate can be a requested date for a cancellation, and can be based on GDT: Date, Qualifier: Cancellation.
A BusinessTransactionDocumentReference package can group references to business documents. A BusinessTransactionDocumentReference package includes the BusinessTransactionDocumentReference entity. The structure of BusinessTransactionDocumentReference includes the following elements: BusinessTransactionDocumentReference, BusinessTransactionDocumentRelationshipRoleCode, BusinessTransactionDocumentRelationshipTypeCode, TransportationDocumentTypeCode, TransportationDocumentNote, and TransportationDocumentID. BusinessTransactionDocumentReference can be a unique reference to other business documents or business document items that are of significance within each respective business process. BusinessTransactionDocumentReference can be based on GDT: BusinessTransactionDocumentReference.
BusinessTransactionDocumentRelationshipRoleCode can be a coded representation of a role that a business document or a business document item can have when set against another business document or business document item with a relationship. BusinessTransactionDocumentRelationshipRoleCode can be based on GDT: BusinessTransactionDocumentRelationshipRoleCode. BusinessTransactionDocumentRelationshipTypeCode can be a coded representation of a relationship between two business documents or business document items. BusinessTransactionDocumentRelationshipTypeCode can be based on GDT: BusinessTransactionDocumentRelationshipTypeCode. TransportationDocumentTypeCode can be a coded representation of a documentation type, and can be based on GDT: TransportationDocumentTypeCode. TransportationDocumentNote can be a short Note on documentation, and can be based on GDT: SHORT_Note.
TransportationDocumentID can be a unique identifier for a transportation document, and can be based on GDT: TransportationDocumentID. RelationshipTypeCode and RelationshipRoleCode are both optional. In some implementations, if used, both may be filled. Either the combination BusinessTransactionDocumentReference, BusinessTransactionDocumentRelationshipRoleCode, BusinessTransactionDocumentRelationshipTypeCode, or TransportationDocumentTypeCode, TransportationDocumentNote, TransportationDocumentID may be filled.
The message data type FreightOrderInvoicingPreparationConfirmationMessage includes business information relevant for sending a business document in a message and FreightOrderInvoicingPreparation included in a business document. The message data type FreightOrderInvoicingPreparationConfirmationMessage can provide a structure for the message type FreightOrderInvoicingPreparationConfirmationMessage and for interfaces that are based on it.
A MessageHeader package can group together business information relevant for sending a business document in a message. The MessageHeader package includes the MessageHeader entity. A MessageHeader can group together business information from the perspective of the sending application to identify a business document in a message, to provide information about the sender, or to provide information about the recipient. The MessageHeader can be divided up into the SenderParty and RecipientParty entities. MessageHeader can be of type GDT: BusinessDocumentMessageHeader. The MessageHeader includes the following elements: ID, ReferenceID, and CreationDateTime. The MessageID can be set by the sending application. With the ReferencedMessageID, reference can be made in the current BusinessDocument to a previous BusinessDocument.
A SenderParty can be a party responsible for sending a business document at a business application level. The SenderParty can be of type GDT: BusinessDocumentMessageHeaderParty. The SenderParty includes the following elements: InternalID, StandardID, and ContactPerson. The SenderParty can be filled by the sending application to name a contact person for problems with the message. A contact person can be useful if an additional infrastructure, such as a marketplace, is located between the sender and the recipient. The SenderParty can be used to transfer a message and can be ignored by the receiving application. SenderParty can be filled by the sender if the participating parties are not transferred with the FreightOrderInvoicingPreparation package.
A RecipientParty can be a party responsible for receiving a business document at a business application level. The RecipientParty can be of type GDT: BusinessDocumentMessageHeaderParty. The RecipientParty includes the following elements: InternalID, StandardID, and ContactPerson. The RecipientParty can be filled by the sending application to name a contact person for problems that may occur with a message. A contact person can be useful if an additional infrastructure, such as a marketplace, is located between the sender and the recipient. The RecipientParty can be used to transfer a message and can be ignored by the receiving application. RecipientParty can be filled by the sender if the FreightOrderInvoicingPreparation package cannot be used to transfer the participating parties. The FreightOrderInvoicingPreparation package can group the FreightOrderInvoicingPreparation together with its packages.
The FreightOrderInvoicingPreparation package includes the FreightOrderInvoicingPreparation entity and the Confirmation package. A FreightOrderInvoicingPreparation can be used in purchase order processing for preparation of supplier invoicing.
The Confirmation package can be part of a FreightOrderInvoicingPreparation which confirms FreightOrderInvoicingPreparation. The Confirmation package includes the Confirmation entity and the BusinessTransactionDocumentReference package. A Confirmation can be part of a FreightOrderInvoicingPreparation which confirms FreightOrderInvoicingPreparation. The element located directly at the Confirmation entity include AcceptanceStatusCode. The AcceptanceStatusCode can be a coded representation of the status of an acceptance by a communication partner regarding a business transaction that has been transmitted to that partner. AcceptanceStatusCode can be based on GDT: AcceptanceStatusCode.
A BusinessTransactionDocumentReference package can group references to a business transaction documents. A BusinessTransactionDocumentReference package includes the BusinessTransactionDocumentReference entity. BusinessTransactionDocumentReference specifies a business document reference that is related to a whole shipment request. BusinessTransactionDocumentReference includes the DateTimePeriod entity. The structure of BusinessTransactionDocumentReference includes the following elements: BusinessTransactionDocumentReference, BusinessTransactionDocumentRelationshipRoleCode, BusinessTransactionDocumentRelationshipTypeCode, TransportationDocumentTypeCode, TransportationDocumentNote, and TransportationDocumentID. BusinessTransactionDocumentReference can be a unique reference to other business documents or business document items that are of significance within each respective business process. BusinessTransactionDocumentReference can be based on GDT: BusinessTransactionDocumentReference.
BusinessTransactionDocumentRelationshipRoleCode can be a coded representation of a role that a business document or a business document item can have when set against another business document or business document item with a relationship. BusinessTransactionDocumentRelationshipRoleCode can be based on GDT: BusinessTransactionDocumentRelationshipRoleCode. BusinessTransactionDocumentRelationshipTypeCode can be a coded representation of a relationship between two business documents or business document items. BusinessTransactionDocumentRelationshipTypeCode can be based on GDT: BusinessTransactionDocumentRelationshipTypeCode.
TransportationDocumentTypeCode can be a coded representation of a documentation type, and can be based on GDT: TransportationDocumentTypeCode. TransportationDocumentNote can be a short Note on documentation, and can be based on GDT: SHORT_Note. TransportationDocumentID can be a unique identifier for a transportation document, and can be based on GDT: TransportationDocumentID. RelationshipTypeCode and RelationshipRoleCode are both optional. In some implementations, if used, both can be filled. Either the combination BusinessTransactionDocumentReference, BusinessTransactionDocumentRelationshipRoleCode, BusinessTransactionDocumentRelationshipTypeCode, or TransportationDocumentTypeCode, TransportationDocumentNote, TransportationDocumentID may be filled.
In order to keep a company up and running from usually occurring down times or break downs, it can be useful to take preventive measures by performing regular checks and maintenance. In order to schedule maintenance and checks at regular intervals, Maintenance Plans are created for technical objects in the company, thereby ensuring that technical objects function optimally.
The Maintenance Plan interface can perform various operations, namely a MaintenancePlanERPCreateRequestConfirmation_In, a MaintenancePlanERPUpdateRequestConfirmation_In, a MaintenancePlanERPCreateCheckQueryResponse_In, a MaintenancePlanERPUpdateCheckQueryResponse_In, a MaintenancePlanERPByIDQueryResponse_In, a MaintenancePlanERPSimpleByElementsQueryResponse_In, a MaintenancePlanERPItemByElementsQueryResponse_In, a MaintenancePlanERPScheduleLineByIDQueryResponse_In, a MaintenancePlanERPActivateRequestConfirmation_In, a MaintenancePlanERPDeactivateRequestConfirmation_In, a MaintenancePlanERPSetDeleteIndicatorRequestConfirmation_In, and a MaintenancePlanERPResetDeleteIndicatorRequestConfirmation_In.
The MaintenancePlanERPCreateRequestConfirmation_In operation can handle a request to Maintenance Planning to create a MaintenancePlan and get a confirmation of the same. A Maintenance Planner can use a ‘Create Maintenance Plan’ inbound operation to create a MaintenancePlan. The MaintenancePlanERPCreateRequestConfirmation_In operation includes various message types, namely a MaintenancePlanERPCreateRequest_sync and a MaintenancePlanERPCreateConfirmation_sync. The structure of the MaintenancePlanERPCreateRequest_sync message type can be specified by a MaintPlnERPCrteReqMsg_s message data type. The structure of the MaintenancePlanERPCreateConfirmation_sync message type can be specified by a MaintPlnERPCrteConfMsg_s message data type.
The MaintenancePlanERPUpdateRequestConfirmation_In operation can handle a request to Maintenance Planning to update a MaintenancePlan and get a confirmation of the same. A Maintenance Planner can use an ‘Update MaintenancePlan’ inbound operation to update a MaintenancePlan. The MaintenancePlanERPUpdateRequestConfirmation_In operation includes various message types, namely a MaintenancePlanERPUpdateRequest_sync and a MaintenancePlanERPUpdateConfirmation_sync. The structure of the MaintenancePlanERPUpdateRequest_sync message type can be specified by a MaintPlnERPUpdtReqMsg_s message data type. The structure of the MaintenancePlanERPUpdateConfirmation_sync message type can be specified by a MaintPlnERPUpdtConfMsg_s message data type.
The MaintenancePlanERPCreateCheckQueryResponse_In operation can handle an inquiry to Maintenance Planning to check the consistency of the creation of a MaintenancePlan. A Maintenance Planner can use a ‘Create Check Maintenance Plan’ inbound operation to check the consistency of the creation of a maintenance plan. The MaintenancePlanERPCreateCheckQueryResponse_In operation includes various message types, namely a MaintenancePlanERPCreateCheckQuery_sync and a MaintenancePlanERPCreateCheckResponse_sync. The structure of the MaintenancePlanERPCreateCheckQuery_sync message type can be specified by a MaintPlnERPCrteCkQryMsg_s message data type. The structure of the MaintenancePlanERPCreateCheckResponse_sync message type can be specified by a MaintPlnERPCrteCkRspMsg_s message data type.
The MaintenancePlanERPUpdateCheckQueryResponse_In operation can handle an inquiry to Maintenance Planning to check the consistency of the update of a MaintenancePlan. A Maintenance Planner can use an ‘Update Check Maintenance Plan’ inbound operation to check the consistency of the update of a MaintenancePlan. The MaintenancePlanERPUpdateCheckQueryResponse_In operation includes various message types, namely a MaintenancePlanERPUpdateCheckQuery_sync and a MaintenancePlanERPUpdateCheckResponse_sync. The structure of the MaintenancePlanERPUpdateCheckQuery_sync message type can be specified by a MaintPlnERPUpdtCkQryMsg_s message data type. The structure of the MaintenancePlanERPUpdateCheckResponse_sync message type can be specified by a MaintPlnERPUpdtCkRspMsg_s message data type.
The MaintenancePlanERPByIDQueryResponse_In operation can handle an inquiry to Maintenance Planning to read a MaintenancePlan. A Maintenance Planner can use a ‘Read Maintenance Plan’ inbound operation to read a MaintenancePlan by using an ID (identifier). The MaintenancePlanERPByIDQueryResponse_In operation includes various message types, namely a MaintenancePlanERPByIDQuery_sync and a MaintenancePlanERPByIDResponse_sync. The structure of the MaintenancePlanERPByIDQuery_sync message type can be specified by a MaintPlnERPByIDQryMsg_s message data type. The structure of the MaintenancePlanERPByIDResponse_sync message type can be specified by a MaintPlnERPByIDRspMsg_s message data type.
The MaintenancePlanERPSimpleByElementsQueryResponse_In operation can handle an inquiry to Maintenance Planning to get a list of MaintenancePlans based on the selection criteria. A Maintenance Planner can use a ‘Find Maintenance Plan By Elements’ inbound operation to get a list of MaintenancePlans based on a selection criteria. The MaintenancePlanERPSimpleByElementsQueryResponse_In operation includes various message types, namely a MaintenancePlanERPSimpleByElementsQuery_sync and a MaintenancePlanERPSimpleByElementsResponse_sync. The structure of the MaintenancePlanERPSimpleByElementsQuery_sync message type can be specified by a MaintPlnERPSimplElmntsQryMsg_s message data type. The structure of the MaintenancePlanERPSimpleByElementsResponse_sync message type can be specified by a MaintPlnERPSimplElmntsRspMsg_s message data type.
The MaintenancePlanERPItemByElementsQueryResponse_In operation can be an inquiry to Maintenance Planning to get a list of MaintenancePlanItems based on selection criteria. A Maintenance planner can use a ‘Find Maintenance Plan Item By Elements’ inbound operation to get a list of Maintenance plan items based on selection criteria. The MaintenancePlanERPItemByElementsQueryResponse_In operation includes various message types, namely a MaintenancePlanERPItemByElementsQuery_sync and a MaintenancePlanERPItemByElementsResponse_sync. The structure of the MaintenancePlanERPItemByElementsQuery_sync message type can be specified by a MaintPlnERPItmElmntsQryMsg_s message data type. The structure of the MaintenancePlanERPItemByElementsResponse_sync message type can be specified by a MaintPlnERPItmElmntsRspMsg_s message data type.
The MaintenancePlanERPScheduleLineByIDQueryResponse_In operation can handle an inquiry to Maintenance Planning to read a MaintenancePlanSchedule. A Maintenance Planner can use a ‘Read Maintenance Plan Schedule’ inbound operation to read a MaintenancePlanSchedule by ID. The MaintenancePlanERPScheduleLineByIDQueryResponse_In operation includes various message types, namely a MaintenancePlanERPScheduleLineByIDQuery_sync and a MaintenancePlanERPScheduleLineByIDResponse_sync. The structure of the MaintenancePlanERPScheduleLineByIDQuery_sync message type can be specified by a MaintPlnERPSchedLineByIDQryMsg_s message data type. The structure of the MaintenancePlanERPScheduleLineByIDResponse_sync message type can be specified by a MaintPlnERPSchedLineByIDRspMsg_s message data type.
The MaintenancePlanERPActivateRequestConfirmation_In operation can be a request to Maintenance Planning to activate a MaintenancePlan and get a confirmation of the same. A Maintenance Planner can use the ‘Activate MaintenancePlan’ inbound operation to activate a MaintenancePlan. The MaintenancePlanERPActivateRequestConfirmation_In operation includes various message types, namely a MaintenancePlanERPActivateRequest_sync and a MaintenancePlanERPActivateConfirmation_sync. The structure of the MaintenancePlanERPActivateRequest_sync message type can be specified by a MaintPlnERPActvteReqMsg_s message data type. The structure of the MaintenancePlanERPActivateConfirmation_sync message type can be specified by a MaintPlnERPActvteConfMsg_s message data type.
The MaintenancePlanERPDeactivateRequestConfirmation_In operation can handle a request to Maintenance Planning to deactivate a MaintenancePlan and get a confirmation of the same. A Maintenance Planner can use a ‘Deactivate MaintenancePlan’ inbound operation to deactivate a MaintenancePlan. The MaintenancePlanERPDeactivateRequestConfirmation_In operation includes various message types, namely a MaintenancePlanERPDeactivateRequest_sync and a MaintenancePlanERPDeactivateConfirmation_sync. The structure of the MaintenancePlanERPDeactivateRequest_sync message type can be specified by a MaintPlnERPDactvteReqMsg_s message data type. The structure of the MaintenancePlanERPDeactivateConfirmation_sync message type can be specified by a MaintPlnERPDactvteConfMsg_s message data type.
The MaintenancePlanERPSetDeleteIndicatorRequestConfirmation_In operation can handle a request to Maintenance Planning to set a deletion flag for a MaintenancePlan and get a confirmation of the same. A Maintenance Planner can use a ‘Set Delete Indicator MaintenancePlan’ inbound operation to set a deletion flag for a MaintenancePlan. The MaintenancePlanERPSetDeleteIndicatorRequestConfirmation_In operation includes various message types, namely a MaintenancePlanERPSetDeleteIndicatorRequest_sync and a MaintenancePlanERPSetDeleteIndicatorConfirmation_sync. The structure of the MaintenancePlanERPSetDeleteIndicatorRequest_sync message type can be specified by a MaintPlnERPSetDelIndReqMsg_s message data type. The structure of the MaintenancePlanERPSetDeleteIndicatorConfirmation_sync message type can be specified by a MaintPlnERPSetDelIndConfMsg_s message data type.
The MaintenancePlanERPResetDeleteIndicatorRequestConfirmation_In operation can handle a request to Maintenance Planning to reset a deletion flag for a MaintenancePlan and get the confirmation of the same. A Maintenance Planner can use a ‘Reset Delete Indicator MaintenancePlan’ inbound operation to reset a deletion flag for a MaintenancePlan. The MaintenancePlanERPResetDeleteIndicatorRequestConfirmation_In operation includes various message types, namely a MaintenancePlanERPResetDeleteIndicatorRequest_sync and a MaintenancePlanERPResetDeleteIndicatorConfirmation_sync. The structure of the MaintenancePlanERPResetDeleteIndicatorRequest_sync message type can be specified by a MaintPlnERPRstDelIndReqMsg_s message data type. The structure of the MaintenancePlanERPResetDeleteIndicatorConfirmation_sync message type can be specified by an MaintPlnERPRstDelIndConfMsg_s message data type.
The message choreography of
A “Maintenance Planner” system 48000 can request the creation of a maintenance plan, using a MaintenancePlanERPCreateRequest_sync message 48004 as shown, for example in
The “Maintenance Planner” system 48000 can request an update of a maintenance plan using a MaintenancePlanERPUpdateRequest message 48008 as shown, for example, in
The “Maintenance Planner” system 48000 can request the creation of a maintenance plan item using a MaintenancePlanItemERPCreateRequest message 48010 as shown, for example, in
The “Maintenance Planner” system 48000 can request an update of a maintenance plan item using a MaintenancePlanItemERPUpdateRequest message 48012 as shown, for example, in
The “Maintenance Planner” system 48000 can query the “Maintenance Planning” system 48002 to check the consistency of the creation of a maintenance plan, using a MaintenancePlanERPCreateCheckQuery_sync message 48014 as shown, for example in
The “Maintenance Planner” system 48000 can query the “Maintenance Planning” system 48002 to check the consistency of the update of a maintenance plan, using a MaintenancePlanERPUpdateCheckQuery_sync message 48016 as shown, for example in
The “Maintenance Planner” system 48000 can query the “Maintenance Planning” system 48002 to check the consistency of the creation of a maintenance plan item using a MaintenancePlanItemERPCreateCheckQuery message 48018 as shown, for example, in
The “Maintenance Planner” system 48000 can query the “Maintenance Planning” system 48002 to check the consistency of the update of a maintenance plan item, using a MaintenancePlanItemERPUpdateCheckQuery_sync message 48020 as shown, for example in
The “Maintenance Planner” system 48000 can query the “Maintenance Planning” system 48002 to read a maintenance plan, using a MaintenancePlanERPReadQuery_sync message 48022 as shown, for example in
The “Maintenance Planner” system 48000 can query the “Maintenance Planning” system 48002 to get a list of maintenance plans based on selection criteria, using a MaintenancePlanERPSimpleByElementsQuery_sync message 48024 as shown, for example in
The “Maintenance Planner” system 48000 can query the “Maintenance Planning” system 48002 to read a maintenance plan item, using a MaintenancePlanItemERPReadQuery_sync message 48026 as shown, for example in
The “Maintenance Planner” system 48000 can query the “Maintenance Planning” system 48002 to get a list of maintenance plan items based on selection criteria, using a MaintenancePlanItemERPSimpleByElementsQuery_sync message 48028 as shown, for example in
The “Maintenance Planner” system 48000 can query the “Maintenance Planning” system 48002 to read a maintenance plan schedule, using a MaintenancePlanScheduleERPReadQuery_sync message 48030 as shown, for example in
The “Maintenance Planner” system 48000 can request the activation of a maintenance plan, using a MaintenancePlanERPActivateRequest_sync message 48032 as shown, for example in
The “Maintenance Planner” system 48000 can request the deactivation of a maintenance plan, using a MaintenancePlanERPDeactivateRequest_sync message 48034 as shown, for example in
The “Maintenance Planner” system 48000 can request the “Maintenance Planning” system 48002 to set a deletion flag for a maintenance plan, using a MaintenancePlanERPSetDeletionIndicatorRequest_sync message 48036 as shown, for example in
The “Maintenance Planner” system 48000 can request the “Maintenance Planning” system 48002 to reset a deletion flag for a maintenance plan, using a MaintenancePlanERPResetDeletionIndicatorRequest_sync message 48038 as shown, for example in
Additionally,
Additionally,
Additionally,
Additionally,
Additionally,
Additionally,
Additionally,
Additionally,
Additionally,
Additionally,
Additionally,
Additionally,
Additionally,
Additionally,
Additionally,
Additionally,
Additionally,
Additionally,
Additionally,
Additionally,
Additionally,
Additionally,
Additionally,
The MessageHeader 73004 package can be a BasicBusinessDocumentMessageHeader 73008 data type. The MessageHeader 73004 package includes a MessageHeader 73006 entity. A BasicBusinessDocumentMessageHeader can be a collection of identification data of an instance of a business document message, or reference data to another instance of a business document message, or both. The subject of the identification data can be a message instance that conveys them, whereas the reference data can be related to a different message instance previously exchanged between the same interaction parties.
The MaintenancePlan 73010 package includes a MaintenancePlan 73012 entity. The MaintenancePlan 73012 entity includes various attributes, namely an ID 73014, a CategoryCode 73020, a TypeCode 73026, a StatusObject 73032, a StartDateTime 73038, a MeasuringDeviceStartMeasurementReadingMeasure 73042, a Description 73048 and a TextCollection 73054. The MaintenancePlan 73012 entity includes various subordinate entities, namely a SchedulingTerms 73060, a Cycle 73148, an Item 73194 and a CycleGroup 73402.
The ID 73014 attribute can be a MaintenancePlanID 73018 data type. The ID 73014 attribute has a cardinality of 1 73016 meaning that for each instance of the MaintenancePlan 73012 entity there is one ID 73014 attribute. A MaintenancePlanID can be a unique identifier for a maintenance plan. The CategoryCode 73020 attribute can be a MaintenancePlanCategoryCode 73024 data type. The CategoryCode 73020 attribute has a cardinality of 1 73022 meaning that for each instance of the MaintenancePlan 73012 entity there is one CategoryCode 73020 attribute. A MaintenancePlanCategoryCode can be a coded representation of a maintenance plan category, and can determine which maintenance call object the system generates for a maintenance plan.
The TypeCode 73026 attribute can be a MaintenancePlanTypeCode 73030 data type. The TypeCode 73026 attribute has a cardinality of 1 73028 meaning that for each instance of the MaintenancePlan 73012 entity there is one TypeCode 73026 attribute. The StatusObject 73032 attribute can be a StatusObject 73036 data type. The StatusObject 73032 attribute has a cardinality of 0 . . . 1 73034 meaning that for each instance of the MaintenancePlan 73012 entity there may be one StatusObject 73032 attribute. A StatusObject can describe the processing status of a maintenance plan in a structured form. The StartDateTime 73038 attribute has a cardinality of 0 . . . 1 73040 meaning that for each instance of the MaintenancePlan 73012 entity there may be one StartDateTime 73038 attribute.
A CycleStartDateTime can be a date on which the system starts a maintenance plan. The MeasuringDeviceStartMeasurementReadingMeasure 73042 attribute can be a Measure 73046 data type. The MeasuringDeviceStartMeasurementReadingMeasure 73042 attribute has a cardinality of 0 . . . 1 73044 meaning that for each instance of the MaintenancePlan 73012 entity there may be one MeasuringDeviceStartMeasurementReadingMeasure 73042 attribute. A MeasuringDeviceStartMeasurementReadingMeasure can be a measure from where the system starts a maintenance plan. The Description 73048 attribute can be a SHORT_Description 73052 data type.
The Description 73048 attribute has a cardinality of 1 73050 meaning that for each instance of the MaintenancePlan 73012 entity there is one Description 73048 attribute. A Description can be a representation of the properties of a maintenance plan in natural language. The TextCollection 73054 attribute can be a TextCollection 73058 data type. The TextCollection 73054 attribute has a cardinality of 0 . . . 1 73056 meaning that for each instance of the MaintenancePlan 73012 entity there may be one TextCollection 73054 attribute. A TextCollection can be a collection of text descriptions of a business object or a part of a business object.
The SchedulingTerms 73060 entity has a cardinality of 0 . . . 1 73062 meaning that for each instance of the MaintenancePlan 73012 entity there may be one SchedulingTerms 73060 entity. The SchedulingTerms 73060 entity includes various attributes, namely a StartDateTime 73064, a MeasuringDeviceStartMeasurementReadingMeasure 73070, a LateCompletionShiftPercent 73076, an EarlyCompletionShiftPercent 73082, a LateCompletionTolerencePercent 73088, an EarlyCompletionTolerencePercent 73094, a WorkingDayCalendarCode 73100, a MaintenancePlanCycleQuantityModificationFactorValue 73106, a BufferStartDaysNumberValue 73112, a CallHorizonPercent 73118, a PredecessorCompletionRequiredIndicator 73124, a SchedulingDuration 73130, a SchedulingCategoryCode 73136 and a CycleDependencyIndicator 73142.
The StartDateTime 73064 attribute is a TIMEZONEINDEPENDENT_DateTime 73068 data type. The StartDateTime 73064 attribute has a cardinality of 0 . . . 1 73066 meaning that for each instance of the SchedulingTerms 73060 entity there may be one StartDateTime 73064 attribute. A StartDateTime can be a date on which the system starts a maintenance plan. The MeasuringDeviceStartMeasurementReadingMeasure 73070 attribute can be a Measure 73074 data type. The MeasuringDeviceStartMeasurementReadingMeasure 73070 attribute has a cardinality of 0 . . . 1 73072 meaning that for each instance of the SchedulingTerms 73060 entity there may be one MeasuringDeviceStartMeasurementReadingMeasure 73070 attribute.
A MeasuringDeviceStartMeasurementReadingMeasure can be a measure from where the system starts a maintenance plan. The LateCompletionShiftPercent 73076 attribute can be a Percent 73080 data type. The LateCompletionShiftPercent 73076 attribute has a cardinality of 0 . . . 1 73078 meaning that for each instance of the SchedulingTerms 73060 entity there may be one LateCompletionShiftPercent 73076 attribute. A LateCompletionShiftPercent can be a percentage of a shift to be applied to a calculation of a next date in an event of late completion. The EarlyCompletionShiftPercent 73082 attribute can be a Percent 73086 data type.
The EarlyCompletionShiftPercent 73082 attribute has a cardinality of 0 . . . 1 73084 meaning that for each instance of the SchedulingTerms 73060 entity there may be one EarlyCompletionShiftPercent 73082 attribute. An EarlyCompletionShiftPercent can be a percentage of a shift to be applied to a calculation of a next date in an event of early completion. The LateCompletionTolerencePercent 73088 attribute can be a Percent 73092 data type. The LateCompletionTolerencePercent 73088 attribute has a cardinality of 0 . . . 1 73090 meaning that for each instance of the SchedulingTerms 73060 entity there may be one LateCompletionTolerencePercent 73088 attribute. A LateCompletionTolerencePercent can be a percentage rate of the smallest interval between maintenance cycles which determines a time span in which positive variances between actual and planned dates do not influence subsequent scheduling. The EarlyCompletionTolerencePercent 73094 attribute can be a Percent 73098 data type.
The EarlyCompletionTolerencePercent 73094 attribute has a cardinality of 0 . . . 1 73096 meaning that for each instance of the SchedulingTerms 73060 entity there may be one EarlyCompletionTolerencePercent 73094 attribute. A LateCompletionTolerencePercent can be a percentage rate of the smallest interval between maintenance cycles which determines a time span in which negative variances between actual and planned dates do not influence subsequent planning. The WorkingDayCalendarCode 73100 attribute can be a WorkingDayCalendarCode 73104 data type. The WorkingDayCalendarCode 73100 attribute has a cardinality of 0 . . . 1 73102 meaning that for each instance of the SchedulingTerms 73060 entity there may be one WorkingDayCalendarCode 73100 attribute. A WorkingDayCalendarCode can be a coded representation of a working day calendar.
The MaintenancePlanCycleQuantityModificationFactorValue 73106 attribute can be a MaintenancePlanCycleQuantityModificationFactorValue 73110 data type. The MaintenancePlanCycleQuantityModificationFactorValue 73106 attribute has a cardinality of 0 . . . 1 73108 meaning that for each instance of the SchedulingTerms 73060 entity there may be one MaintenancePlanCycleQuantityModificationFactorValue 73106 attribute. A MaintenancePlanCycleModificationValue can be a multiplication factor number that changes the cycle times of maintenance plan. The BufferStartDaysNumberValue 73112 attribute can be a NumberValue 73116 data type. The BufferStartDaysNumberValue 73112 attribute has a cardinality of 0 . . . 1 73114 meaning that for each instance of the SchedulingTerms 73060 entity there may be one BufferStartDaysNumberValue 73112 attribute.
A BufferStartDaysNumberValue can be the number of days specified as a preliminary buffer for a maintenance call object start date. The CallHorizonPercent 73118 attribute can be a Percent 73122 data type. The CallHorizonPercent 73118 attribute has a cardinality of 0 . . . 1 73120 meaning that for each instance of the SchedulingTerms 73060 entity there may be one CallHorizonPercent 73118 attribute. A CallHorizonPercent can be a percentage value which determines when a maintenance call object may be generated for a maintenance plan. The PredecessorCompletionRequiredIndicator 73124 attribute can be an Indicator 73128 data type. The PredecessorCompletionRequiredIndicator 73124 attribute has a cardinality of 0 . . . 1 73126 meaning that for each instance of the SchedulingTerms 73060 entity there may be one PredecessorCompletionRequiredIndicator 73124 attribute.
A PredecessorCompletionRequiredIndicator can be an indicator to generate the next maintenance call object after the completion of a predecessor. The SchedulingDuration 73130 attribute can be a Duration 73134 data type. The SchedulingDuration 73130 attribute has a cardinality of 0 . . . 1 73132 meaning that for each instance of the SchedulingTerms 73060 entity there may be one SchedulingDuration 73130 attribute. SchedulingDuration can be a length of time for which the system creates maintenance calls during maintenance plan scheduling. The SchedulingCategoryCode 73136 attribute can be a MaintenancePlanSchedulingTypeCode 73140 data type.
The SchedulingCategoryCode 73136 attribute has a cardinality of 0 . . . 1 73138 meaning that for each instance of the SchedulingTerms 73060 entity there may be one SchedulingCategoryCode 73136 attribute. A SchedulingCategoryCode can be an indicator for identification of specific time-based or counter-based maintenance. The CycleDependencyIndicator 73142 attribute can be an Indicator 73146 data type. The CycleDependencyIndicator 73142 attribute has a cardinality of 0 . . . 1 73144 meaning that for each instance of the SchedulingTerms 73060 entity there may be one CycleDependencyIndicator 73142 attribute. An CycleDependencyIndicator can be an indicator for defining a relationship between maintenance cycles.
The Cycle 73148 entity has a cardinality of 0 . . . N 73150 meaning that for each instance of the MaintenancePlan 73012 entity there may be one or more Cycle 73148 entities. The Cycle 73148 entity includes various attributes, namely a CounterValue 73152, a GroupSequenceNumberValue 73158, a GroupSequenceRepetitionNumberValue 73164, a Quantity 73170, a StartOffsetQuantity 73176, a MeasuringDeviceID 73182 and a Description 73188. The CounterValue 73152 attribute can be a CounterValue 73156 data type.
The CounterValue 73152 attribute has a cardinality of 1 73154 meaning that for each instance of the Cycle 73148 entity there is one CounterValue 73152 attribute. A MaintenancePlanCycleID can be a unique identifier for a maintenance plan cycle. The GroupSequenceNumberValue 73158 attribute can be a NumberValue 73162 data type. The GroupSequenceNumberValue 73158 attribute has a cardinality of 1 73160 meaning that for each instance of the Cycle 73148 entity there is one GroupSequenceNumberValue 73158 attribute. A MaintenancePlanCycleGroupSequenceNumberValue can be a value to determine a maintenance cycle group.
The GroupSequenceRepetitionNumberValue 73164 attribute can be a NumberValue 73168 data type. The GroupSequenceRepetitionNumberValue 73164 attribute has a cardinality of 0 . . . N 73166 meaning that for each instance of the Cycle 73148 entity there may be one or more GroupSequenceRepetitionNumberValue 73164 attributes. A GroupSequenceRepetitionNumberValue can be a value to determine how often in a sequence a cycle set is used to calculate a date, before the system changes to the next cycle set.
The Quantity 73170 attribute can be a Quantity 73174 data type. The Quantity 73170 attribute has a cardinality of 1 73172 meaning that for each instance of the Cycle 73148 entity there is one Quantity 73170 attribute. A maintenance plan cycle quantity can be a quantity after which a maintenance task is due to be performed. The StartOffsetQuantity 73176 attribute can be a Quantity 73180 data type. The StartOffsetQuantity 73176 attribute has a cardinality of 0 . . . 1 73178 meaning that for each instance of the Cycle 73148 entity there may be one StartOffsetQuantity 73176 attribute. A StartOffsetQuantity can be a quantity using which the first due task is determined. The MeasuringDeviceID 73182 attribute can be a MeasuringDeviceID 73186 data type.
The MeasuringDeviceID 73182 attribute has a cardinality of 0 . . . N 73184 meaning that for each instance of the Cycle 73148 entity there may be one or more MeasuringDeviceID 73182 attributes. A MeasuringDeviceID can be a unique identifier for a measuring device. The Description 73188 attribute can be a SHORT_Description 73192 data type. The Description 73188 attribute has a cardinality of 0 . . . 1 73190 meaning that for each instance of the Cycle 73148 entity there may be one Description 73188 attribute. A Description can be a representation of properties of a maintenance plan cycle in natural language.
The Item 73194 entity has a cardinality of 0 . . . N 73196 meaning that for each instance of the MaintenancePlan 73012 entity there may be one or more Item 73194 entities. The Item 73194 entity includes various attributes, namely an ID 73198, a CategoryCode 73204, a CycleGroupSequenceNumberValue 73210, a Description 73216, a BusinessTransactionDocumentProcessingTypeCode 73222, a MaintenancePlannerGroupCode 73228, an ImportanceCode 73234, a MaintenanceTaskListID 73240, a MaintenanceTaskListGroupID 73246, a MaintenanceTaskListTypeCode 73252, a BusinessTransactionDocumentID 73258, a WorkCentreDescription 73264, a StatusObject 73270, a MaintenancePlanningPlantID 73276, a WorkCentreID 73282, a WorkCentrePlantID 73288, a MaintenancePlantDescription 73294, a MaintenanceWorkCenterDescription 73300 and a TextCollection 73306.
The Item 73194 entity includes various subordinate entities, namely an ObjectReference 73312 and a ScheduleLine 73376. The ID 73198 attribute can be a MaintenancePlanItemID 73202 data type. The ID 73198 attribute has a cardinality of 1 73200 meaning that for each instance of the Item 73194 entity there is one ID 73198 attribute. A MaintenancePlanItemID can be a unique identifier for a maintenance plan item. The CategoryCode 73204 attribute can be a MaintenancePlanCategoryCode 73208 data type. The CategoryCode 73204 attribute has a cardinality of 1 73206 meaning that for each instance of the Item 73194 entity there is one CategoryCode 73204 attribute. A MaintenancePlanCategoryCode can be a coded representation of a maintenance plan category that determines which maintenance call object the system generates for a maintenance plan. The CycleGroupSequenceNumberValue 73210 attribute can be a NumberValue 73214 data type.
The CycleGroupSequenceNumberValue 73210 attribute has a cardinality of 1 73212 meaning that for each instance of the Item 73194 entity there is one CycleGroupSequenceNumberValue 73210 attribute. A MaintenancePlanCycleGroupSequenceNumberValue can be a value to determine a maintenance cycle group. The Description 73216 attribute can be a SHORT_Description 73220 data type. The Description 73216 attribute has a cardinality of 0 . . . 1 73218 meaning that for each instance of the Item 73194 entity there may be one Description 73216 attribute. A Description can be a representation of properties of a maintenance plan item in natural language.
The BusinessTransactionDocumentProcessingTypeCode 73222 attribute can be a BusinessTransactionDocumentProcessingTypeCode 73226 data type. The BusinessTransactionDocumentProcessingTypeCode 73222 attribute has a cardinality of 1 73224 meaning that for each instance of the Item 73194 entity there is one BusinessTransactionDocumentProcessingTypeCode 73222 attribute. A BusinessTransactionDocumentProcessingTypeCode can be a coded representation of a type of a MaintenanceOrder. The MaintenancePlannerGroupCode 73228 attribute can be a MaintenancePlannerGroupCode 73232 data type. The MaintenancePlannerGroupCode 73228 attribute has a cardinality of 0 . . . 1 73230 meaning that for each instance of the Item 73194 entity there may be one MaintenancePlannerGroupCode 73228 attribute.
A PlannerGroupCode can be a coded representation of a PlannerGroup. The ImportanceCode 73234 attribute can be an ImportanceCode 73238 data type. The ImportanceCode 73234 attribute has a cardinality of 0 . . . 1 73236 meaning that for each instance of the Item 73194 entity there may be one ImportanceCode 73234 attribute. An ImportanceCode can be a coded representation of the importance of a maintenance plan. The MaintenanceTaskListID 73240 attribute can be a MaintenanceTaskListID 73244 data type. The MaintenanceTaskListID 73240 attribute has a cardinality of 0 . . . 1 73242 meaning that for each instance of the Item 73194 entity there may be one MaintenanceTaskListID 73240 attribute. A MaintenanceTaskListID can be an identifier for a maintenance task list in a MaintenanceTaskList Group.
The MaintenanceTaskListGroupID 73246 attribute can be a BusinessTransactionDocumentGroupID 73250 data type. The MaintenanceTaskListGroupID 73246 attribute has a cardinality of 0 . . . 1 73248 meaning that for each instance of the Item 73194 entity there may be one MaintenanceTaskListGroupID 73246 attribute. A MaintenanceTaskListGroupID can be an identifier for a TaskListGroup. The MaintenanceTaskListTypeCode 73252 attribute can be a BusinessObjectTypeCode 73256 data type. The MaintenanceTaskListTypeCode 73252 attribute has a cardinality of 0 . . . 1 73254 meaning that for each instance of the Item 73194 entity there may be one MaintenanceTaskListTypeCode 73252 attribute.
A MaintenanceTaskListTypeCode can be a coded representation of the type of a maintenance task list. The BusinessTransactionDocumentID 73258 attribute can be a BusinessTransactionDocumentReference 73262 data type. The BusinessTransactionDocumentID 73258 attribute has a cardinality of 0 . . . 1 73260 meaning that for each instance of the Item 73194 entity there may be one BusinessTransactionDocumentID 73258 attribute. A BusinessTransactionDocumentID can be a unique identifier for a business transaction document.
The WorkCentreDescription 73264 attribute can be a SHORT_Description 73268 data type. The WorkCentreDescription 73264 attribute has a cardinality of 0 . . . 1 73266 meaning that for each instance of the Item 73194 entity there may be one WorkCentreDescription 73264 attribute. A WorkCentreDescription can be a representation of the properties of a maintenance work centre in natural language.
The StatusObject 73270 attribute can be a StatusObject 73274 data type. The StatusObject 73270 attribute has a cardinality of 0 . . . 1 73272 meaning that for each instance of the Item 73194 entity there may be one StatusObject 73270 attribute. A StatusObject can describe the processing status of a maintenance plan item in structured form. The MaintenancePlanningPlantID 73276 attribute can be a PlantID 73280 data type. The MaintenancePlanningPlantID 73276 attribute has a cardinality of 0 . . . 1 73278 meaning that for each instance of the Item 73194 entity there may be one MaintenancePlanningPlantID 73276 attribute.
A MaintenancePlanningPlantID can be an identifier of a plant in which planning and supervision of the execution of maintenance work is done. The WorkCentreID 73282 attribute can be a WorkCentreID 73286 data type. The WorkCentreID 73282 attribute has a cardinality of 0 . . . 1 73284 meaning that for each instance of the Item 73194 entity there may be one WorkCentreID 73282 attribute. A WorkCentreID can be an identifier of a work centre where the execution of maintenance work is done. The WorkCentrePlantID 73288 attribute can be a PlantID 73292 data type. The WorkCentrePlantID 73288 attribute has a cardinality of 0 . . . 1 73290 meaning that for each instance of the Item 73194 entity there may be one WorkCentrePlantID 73288 attribute. A WorkCentrePlantID can be an identifier of a plant where a work centre which is responsible for the execution of maintenance work is present. The MaintenancePlantDescription 73294 attribute can be a SHORT_Description 73298 data type.
The MaintenancePlantDescription 73294 attribute has a cardinality of 0 . . . 1 73296 meaning that for each instance of the Item 73194 entity there may be one MaintenancePlantDescription 73294 attribute. A MaintenancePlantDescription can be a representation of properties of a Maintenance Plant in natural language. The MaintenanceWorkCenterDescription 73300 attribute can be a SHORT_Description 73304 data type. The MaintenanceWorkCenterDescription 73300 attribute has a cardinality of 0 . . . 1 73302 meaning that for each instance of the Item 73194 entity there may be one MaintenanceWorkCenterDescription 73300 attribute. A WorkCenterDescription can be a representation of properties of a Maintenance Work Center in natural language. The TextCollection 73306 attribute can be a TextCollection 73310 data type. The TextCollection 73306 attribute has a cardinality of 0 . . . 1 73308 meaning that for each instance of the Item 73194 entity there may be one TextCollection 73306 attribute. A TextCollection can be a collection of text descriptions of a business object or a part of a business object.
The ObjectReference 73312 entity has a cardinality of 0 . . . N 73314 meaning that for each instance of the Item 73194 entity there may be one or more ObjectReference 73312 entities. The ObjectReference 73312 entity includes various attributes, namely an OrdinalNumberValue 73316, a SerialID 73322, a MaterialInternalID 73328, an IndividualMaterialID 73334, a MainIndicator 73340, an InstallationPointID 73346, a MaterialDescription 73352, an IndividualMaterialDescription 73358, an InstallationPointDescription 73364 and a @actionCode 73370. The OrdinalNumberValue 73316 attribute can be an OrdinalNumberValue 73320 data type. The OrdinalNumberValue 73316 attribute has a cardinality of 0 . . . 1 73318 meaning that for each instance of the ObjectReference 73312 entity there may be one OrdinalNumberValue 73316 attribute.
An OrdinalNumberValue can be a number that indicates a position of a maintenance plan item object reference in a linearly ordered set that is ordered according to particular factors. The SerialID 73322 attribute can be a SerialID 73326 data type. The SerialID 73322 attribute has a cardinality of 0 . . . 1 73324 meaning that for each instance of the ObjectReference 73312 entity there may be one SerialID 73322 attribute. A SerialID (serial number) can be a unique identifier for an individual material that is assigned in a maintenance request. The MaterialInternalID 73328 attribute can be a ProductInternalID 73332 data type. The MaterialInternalID 73328 attribute has a cardinality of 0 . . . 1 73330 meaning that for each instance of the ObjectReference 73312 entity there may be one MaterialInternalID 73328 attribute. A MaterialInternalID can be a proprietary identifier for a material.
The IndividualMaterialID 73334 attribute can be a ProductInternalID 73338 data type. The IndividualMaterialID 73334 attribute has a cardinality of 0 . . . 1 73336 meaning that for each instance of the ObjectReference 73312 entity there may be one IndividualMaterialID 73334 attribute. An IndividualMaterialID can be a proprietary identifier for an individual material. The MainIndicator 73340 attribute can be an Indicator 73344 data type. The MainIndicator 73340 attribute has a cardinality of 1 73342 meaning that for each instance of the ObjectReference 73312 entity there is one MainIndicator 73340 attribute. A MainIndicator can be an indicator which describes a focused object reference. The InstallationPointID 73346 attribute can be an InstallationPointID 73350 data type. The InstallationPointID 73346 attribute has a cardinality of 0 . . . 1 73348 meaning that for each instance of the ObjectReference 73312 entity there may be one InstallationPointID 73346 attribute.
An InstallationPointID can be a unique identifier for an installation point. The MaterialDescription 73352 attribute can be a SHORT_Description 73356 data type. The MaterialDescription 73352 attribute has a cardinality of 0 . . . 1 73354 meaning that for each instance of the ObjectReference 73312 entity there may be one MaterialDescription 73352 attribute. A MaterialInternalDescription can be a representation of properties of a material in natural language. The IndividualMaterialDescription 73358 attribute can be a SHORT_Description 73362 data type. The IndividualMaterialDescription 73358 attribute has a cardinality of 0 . . . 1 73360 meaning that for each instance of the ObjectReference 73312 entity there may be one IndividualMaterialDescription 73358 attribute. An IndividualMaterialDescription can be a representation of properties of an individual material in natural language.
The InstallationPointDescription 73364 attribute can be a SHORT_Description 73368 data type. The InstallationPointDescription 73364 attribute has a cardinality of 0 . . . 1 73366 meaning that for each instance of the ObjectReference 73312 entity there may be one InstallationPointDescription 73364 attribute. An InstallationPointDescription can be a representation of properties of an installation point in natural language. The @actionCode 73370 attribute can be an ActionCode 73374 data type. The @actionCode 73370 attribute has a cardinality of 1 73372 meaning that for each instance of the ObjectReference 73312 entity there is one @actionCode 73370 attribute. An ActionCode can be a coded representation of an instruction to a recipient of a message telling the recipient how to process a transmitted element. ActionCode can determine if the Service Execution Order Operation may be created (Code 01), changed (Code 02), or deleted (Code 03). In some implementations, other codes are not allowed.
The ScheduleLine 73376 entity has a cardinality of 0 . . . N 73378 meaning that for each instance of the Item 73194 entity there may be one or more ScheduleLine 73376 entities. The ScheduleLine 73376 entity includes various attributes, namely an OrdinalNumberValue 73380, a PlannedDateTime 73384, an InitiatedDateTime 73390 and a CompletionDateTime 73396. The OrdinalNumberValue 73380 attribute can be an OrdinalNumberValue 73382 data type. An OrdinalNumberValue can be a number that indicates a position of an element in a linearly ordered set that is ordered according to particular factors.
The PlannedDateTime 73384 attribute can be a TIMEZONEINDEPENDENT_DateTime 73388 data type. The PlannedDateTime 73384 attribute has a cardinality of 0 . . . 1 73386 meaning that for each instance of the ScheduleLine 73376 entity there may be one PlannedDateTime 73384 attribute. A PlannedDateTime can be a date on which a maintenace call object can be executed. The InitiatedDateTime 73390 attribute can be a TIMEZONEINDEPENDENT_DateTime 73394 data type. The InitiatedDateTime 73390 attribute has a cardinality of 0 . . . 1 73392 meaning that for each instance of the ScheduleLine 73376 entity there may be one InitiatedDateTime 73390 attribute. A CallDateTime can be a date on which the system creates a maintenance call object. The CompletionDateTime 73396 attribute can be a TIMEZONEINDEPENDENT_DateTime 73400 data type. The CompletionDateTime 73396 attribute has a cardinality of 0 . . . 1 73398 meaning that for each instance of the ScheduleLine 73376 entity there may be one CompletionDateTime 73396 attribute. A CompletionDateTime can be a date on which a maintenance task was completed.
The CycleGroup 73402 entity has a cardinality of 0 . . . N 73404 meaning that for each instance of the MaintenancePlan 73012 entity there may be one or more CycleGroup 73402 entities. The CycleGroup 73402 entity includes various attributes, namely a SequenceNumberValue 73406, an ItemMaintenancePlanID 73412 and a MaintenancePlanCycleSetNumberValue 73418. The SequenceNumberValue 73406 attribute can be a NumberValue 73410 data type. The SequenceNumberValue 73406 attribute has a cardinality of 1 73408 meaning that for each instance of the CycleGroup 73402 entity there is one SequenceNumberValue 73406 attribute. A GroupSequenceNumberValue can be a value to determine a maintenance cycle group. The ItemMaintenancePlanID 73412 attribute can be a MaintenancePlanID 73416 data type.
The ItemMaintenancePlanID 73412 attribute has a cardinality of 0 . . . 1 73414 meaning that for each instance of the CycleGroup 73402 entity there may be one ItemMaintenancePlanID 73412 attribute. A MaintenancePlanID can be a unique identifier for a maintenance plan. The MaintenancePlanCycleSetNumberValue 73418 attribute can be a NumberValue 73422 data type. The MaintenancePlanCycleSetNumberValue 73418 attribute has a cardinality of 0 . . . N 73420 meaning that for each instance of the CycleGroup 73402 entity there may be one or more MaintenancePlanCycleSetNumberValue 73418 attributes. A MaintenancePlanCycleSetNumberValue can be a value to determine a maintenance cycles group.
The ProcessingConditions 73424 package includes a ProcessingConditions 73426 entity. The ProcessingConditions 73426 entity has a cardinality of 0 . . . 1 73428 meaning that for each instance of the ProcessingConditions 73424 package there may be one ProcessingConditions 73426 entity. The ProcessingConditions 73426 entity includes various attributes, namely a QueryHitsMaximumNumberValue 73430, an UnlimitedQueryHitsIndicator 73436, a ReturnedQueryHitsNumberValue 73442, a MoreElementsAvailableIndicator 73448 and a LastProvidedMaintenanceRequestID 73454. The QueryHitsMaximumNumberValue 73430 attribute can be a NumberValue 73434 data type.
The QueryHitsMaximumNumberValue 73430 attribute has a cardinality of 0 . . . 1 73432 meaning that for each instance of the ProcessingConditions 73426 entity there may be one QueryHitsMaximumNumberValue 73430 attribute. A NumberValue can be a number. In some implementations, NumberValue is used for cardinal numbers. The UnlimitedQueryHitsIndicator 73436 attribute can be an Indicator 73440 data type. The UnlimitedQueryHitsIndicator 73436 attribute has a cardinality of 0 . . . 1 73438 meaning that for each instance of the ProcessingConditions 73426 entity there may be one UnlimitedQueryHitsIndicator 73436 attribute. An Indicator can be a representation of a situation that has exactly two mutually exclusive Boolean values. The ReturnedQueryHitsNumberValue 73442 attribute can be a NumberValue 73446 data type. The ReturnedQueryHitsNumberValue 73442 attribute has a cardinality of 0 . . . 1 73444 meaning that for each instance of the ProcessingConditions 73426 entity there may be one ReturnedQueryHitsNumberValue 73442 attribute. A NumberValue can be a number. In some implementations, NumberValue is used for cardinal numbers.
The MoreElementsAvailableIndicator 73448 attribute can be a MoreElementsAvailableIndicator 73452 data type. The MoreElementsAvailableIndicator 73448 attribute has a cardinality of 0 . . . 1 73450 meaning that for each instance of the ProcessingConditions 73426 entity there may be one MoreElementsAvailableIndicator 73448 attribute. An Indicator can be a representation of a situation that has exactly two mutually exclusive Boolean values. The LastProvidedMaintenanceRequestID 73454 attribute can be a MaintenanceRequestID 73458 data type. The LastProvidedMaintenanceRequestID 73454 attribute has a cardinality of 0 . . . 1 73456 meaning that for each instance of the ProcessingConditions 73426 entity there may be one LastProvidedMaintenanceRequestID 73454 attribute. A MaintenanceRequestID can be a unique identifier for a MaintenanceRequest
The Log 73460 package can be a Log 73466 data type. The Log 73460 package includes a Log 73462 entity. The Log 73462 entity has a cardinality of 1 73464 meaning that for each instance of the Log 73460 package there is one Log 73462 entity.
The MessageHeader 74004 package includes a MessageHeader 74006 entity. The MessageHeader 74006 entity has a cardinality of 0 . . . 1 74008 meaning that for each instance of the MessageHeader 74004 package there may be one MessageHeader 74006 entity. The MaintenancePlan 74010 package includes a MaintenancePlan 74012 entity.
The MaintenancePlan 74012 entity has a cardinality of 1 74014 meaning that for each instance of the MaintenancePlan 74010 package there is one MaintenancePlan 74012 entity. The MaintenancePlan 74012 entity includes various attributes, namely a CategoryCode 74016, a Description 74020 and a TextCollection 74024. The MaintenancePlan 74012 entity includes various subordinate entities, namely a SchedulingTerms 74028, a Cycle 74088 and an Item 74120. The CategoryCode 74016 attribute has a cardinality of 1 74018 meaning that for each instance of the MaintenancePlan 74012 entity there is one CategoryCode 74016 attribute. The Description 74020 attribute has a cardinality of 1 74022 meaning that for each instance of the MaintenancePlan 74012 entity there is one Description 74020 attribute. The TextCollection 74024 attribute has a cardinality of 0 . . . 1 74026 meaning that for each instance of the MaintenancePlan 74012 entity there may be one TextCollection 74024 attribute.
The SchedulingTerms 74028 entity has a cardinality of 0 . . . 1 74030 meaning that for each instance of the MaintenancePlan 74012 entity there may be one SchedulingTerms 74028 entity. The SchedulingTerms 74028 entity includes various attributes, namely a StartDateTime 74032, a MeasuringDeviceStartMeasurementReadingMeasure 74036, a LateCompletionShiftPercent 74040, an EarlyCompletionShiftPercent 74044, a LateCompletionTolerencePercent 74048, an EarlyCompletionTolerencePercent 74052, a WorkingDayCalendarCode 74056, a MaintenancePlanCycleQuantityModificationFactorValue 74060, a BufferStartDaysNumberValue 74064, a CallHorizonPercent 74068, a PredecessorCompletionRequiredIndicator 74072, a SchedulingDuration 74076, a SchedulingCategoryCode 74080 and a CycleDependencyIndicator 74084. The StartDateTime 74032 attribute has a cardinality of 0 . . . 1 74034 meaning that for each instance of the SchedulingTerms 74028 entity there may be one StartDateTime 74032 attribute.
The MeasuringDeviceStartMeasurementReadingMeasure 74036 attribute has a cardinality of 0 . . . 1 74038 meaning that for each instance of the SchedulingTerms 74028 entity there may be one MeasuringDeviceStartMeasurementReadingMeasure 74036 attribute. The LateCompletionShiftPercent 74040 attribute has a cardinality of 0 . . . 1 74042 meaning that for each instance of the SchedulingTerms 74028 entity there may be one LateCompletionShiftPercent 74040 attribute. The EarlyCompletionShiftPercent 74044 attribute has a cardinality of 0 . . . 1 74046 meaning that for each instance of the SchedulingTerms 74028 entity there may be one EarlyCompletionShiftPercent 74044 attribute. The LateCompletionTolerencePercent 74048 attribute has a cardinality of 0 . . . 1 74050 meaning that for each instance of the SchedulingTerms 74028 entity there may be one LateCompletionTolerencePercent 74048 attribute.
The EarlyCompletionTolerencePercent 74052 attribute has a cardinality of 0 . . . 1 74054 meaning that for each instance of the SchedulingTerms 74028 entity there may be one EarlyCompletionTolerencePercent 74052 attribute. The WorkingDayCalendarCode 74056 attribute has a cardinality of 0 . . . 1 74058 meaning that for each instance of the SchedulingTerms 74028 entity there may be one WorkingDayCalendarCode 74056 attribute. The MaintenancePlanCycleQuantityModificationFactorValue 74060 attribute has a cardinality of 0 . . . 1 74062 meaning that for each instance of the SchedulingTerms 74028 entity there may be one MaintenancePlanCycleQuantityModificationFactorValue 74060 attribute. The BufferStartDaysNumberValue 74064 attribute has a cardinality of 0 . . . 1 74066 meaning that for each instance of the SchedulingTerms 74028 entity there may be one BufferStartDaysNumberValue 74064 attribute.
The CallHorizonPercent 74068 attribute has a cardinality of 0 . . . 1 74070 meaning that for each instance of the SchedulingTerms 74028 entity there may be one CallHorizonPercent 74068 attribute. The PredecessorCompletionRequiredIndicator 74072 attribute has a cardinality of 0 . . . 1 74074 meaning that for each instance of the SchedulingTerms 74028 entity there may be one PredecessorCompletionRequiredIndicator 74072 attribute. The SchedulingDuration 74076 attribute has a cardinality of 0 . . . 1 74078 meaning that for each instance of the SchedulingTerms 74028 entity there may be one SchedulingDuration 74076 attribute. The SchedulingCategoryCode 74080 attribute has a cardinality of 0 . . . 1 74082 meaning that for each instance of the SchedulingTerms 74028 entity there may be one SchedulingCategoryCode 74080 attribute. The CycleDependencyIndicator 74084 attribute has a cardinality of 0 . . . 1 74086 meaning that for each instance of the SchedulingTerms 74028 entity there may be one CycleDependencyIndicator 74084 attribute.
The Cycle 74088 entity has a cardinality of 0 . . . n 74090 meaning that for each instance of the MaintenancePlan 74012 entity there may be one or more Cycle 74088 entities. The Cycle 74088 entity includes various attributes, namely a CounterValue 74092, a GroupSequenceNumberValue 74096, a GroupSequenceRepetitionNumberValue 74100, a Quantity 74104, a StartOffsetQuantity 74108, a MeasuringDeviceID 74112 and a Description 74116. The CounterValue 74092 attribute has a cardinality of 1 74094 meaning that for each instance of the Cycle 74088 entity there is one CounterValue 74092 attribute. The GroupSequenceNumberValue 74096 attribute has a cardinality of 0 . . . 1 74098 meaning that for each instance of the Cycle 74088 entity there may be one GroupSequenceNumberValue 74096 attribute.
The GroupSequenceRepetitionNumberValue 74100 attribute has a cardinality of 0 . . . 1 74102 meaning that for each instance of the Cycle 74088 entity there may be one GroupSequenceRepetitionNumberValue 74100 attribute. The Quantity 74104 attribute has a cardinality of 1 74106 meaning that for each instance of the Cycle 74088 entity there is one Quantity 74104 attribute. The StartOffsetQuantity 74108 attribute has a cardinality of 0 . . . 1 74110 meaning that for each instance of the Cycle 74088 entity there may be one StartOffsetQuantity 74108 attribute. The MeasuringDeviceID 74112 attribute has a cardinality of 0 . . . 1 74114 meaning that for each instance of the Cycle 74088 entity there may be one MeasuringDeviceID 74112 attribute. The Description 74116 attribute has a cardinality of 0 . . . 1 74118 meaning that for each instance of the Cycle 74088 entity there may be one Description 74116 attribute.
The Item 74120 entity has a cardinality of 1 . . . n 74122 meaning that for each instance of the MaintenancePlan 74012 entity there are one or more Item 74120 entities. The Item 74120 entity includes various attributes, namely an OrdinalNumberValue 74124, a CycleGroupSequenceNumberValue 74128, a BusinessTransactionDocumentProcessingTypeCode 74132, a WorkCentreID 74136, a MaintenancePlanningPlantID 74140, a WorkCenterPlantID 74144, a MaintenancePlannerGroupCode 74148, an ImportanceCode 74152, a MaintenanceTaskListID 74156, a BusinessTransactionDocumentGroupID 74160, a BusinessObjectTypeCode 74164, a BusinessTransactionDocumentReference 74168, a Description 74172 and a TextCollection 74176. The Item 74120 entity includes an ObjectReference 74180 subordinate entity.
The OrdinalNumberValue 74124 attribute has a cardinality of 1 74126 meaning that for each instance of the Item 74120 entity there is one OrdinalNumberValue 74124 attribute. The CycleGroupSequenceNumberValue 74128 attribute has a cardinality of 0 . . . 1 74130 meaning that for each instance of the Item 74120 entity there may be one CycleGroupSequenceNumberValue 74128 attribute. The BusinessTransactionDocumentProcessingTypeCode 74132 attribute has a cardinality of 1 74134 meaning that for each instance of the Item 74120 entity there is one BusinessTransactionDocumentProcessingTypeCode 74132 attribute. The WorkCentreID 74136 attribute has a cardinality of 1 74138 meaning that for each instance of the Item 74120 entity there is one WorkCentreID 74136 attribute. The MaintenancePlanningPlantID 74140 attribute has a cardinality of 1 74142 meaning that for each instance of the Item 74120 entity there is one MaintenancePlanningPlantID 74140 attribute. The WorkCenterPlantID 74144 attribute has a cardinality of 0 . . . 1 74146 meaning that for each instance of the Item 74120 entity there may be one WorkCenterPlantID 74144 attribute. The MaintenancePlannerGroupCode 74148 attribute has a cardinality of 0 . . . 1 74150 meaning that for each instance of the Item 74120 entity there may be one MaintenancePlannerGroupCode 74148 attribute. The ImportanceCode 74152 attribute has a cardinality of 0 . . . 1 74154 meaning that for each instance of the Item 74120 entity there may be one ImportanceCode 74152 attribute.
The MaintenanceTaskListID 74156 attribute has a cardinality of 0 . . . 1 74158 meaning that for each instance of the Item 74120 entity there may be one MaintenanceTaskListID 74156 attribute. The BusinessTransactionDocumentGroupID 74160 attribute has a cardinality of 0 . . . 1 74162 meaning that for each instance of the Item 74120 entity there may be one BusinessTransactionDocumentGroupID 74160 attribute. The BusinessObjectTypeCode 74164 attribute has a cardinality of 0 . . . 1 74166 meaning that for each instance of the Item 74120 entity there may be one BusinessObjectTypeCode 74164 attribute. The BusinessTransactionDocumentReference 74168 attribute has a cardinality of 0 . . . 1 74170 meaning that for each instance of the Item 74120 entity there may be one BusinessTransactionDocumentReference 74168 attribute. The Description 74172 attribute has a cardinality of 0 . . . 1 74174 meaning that for each instance of the Item 74120 entity there may be one Description 74172 attribute. The TextCollection 74176 attribute has a cardinality of 0 . . . 1 74178 meaning that for each instance of the Item 74120 entity there may be one TextCollection 74176 attribute.
The ObjectReference 74180 entity has a cardinality of 1 . . . n 74182 meaning that for each instance of the Item 74120 entity there are one or more ObjectReference 74180 entities. The ObjectReference 74180 entity includes various attributes, namely an OrdinalNumberValue 74184, a MainIndicator 74188, a SerialID 74192, a MaterialInternalID 74196, an IndividualMaterialID 74200 and an InstallationPointID 74204. The OrdinalNumberValue 74184 attribute has a cardinality of 1 74186 meaning that for each instance of the ObjectReference 74180 entity there is one OrdinalNumberValue 74184 attribute. The MainIndicator 74188 attribute has a cardinality of 1 74190 meaning that for each instance of the ObjectReference 74180 entity there is one MainIndicator 74188 attribute.
The SerialID 74192 attribute has a cardinality of 0 . . . 1 74194 meaning that for each instance of the ObjectReference 74180 entity there may be one SerialID 74192 attribute. The MaterialInternalID 74196 attribute has a cardinality of 0 . . . 1 74198 meaning that for each instance of the ObjectReference 74180 entity there may be one MaterialInternalID 74196 attribute. The IndividualMaterialID 74200 attribute has a cardinality of 0 . . . 1 74202 meaning that for each instance of the ObjectReference 74180 entity there may be one IndividualMaterialID 74200 attribute. The InstallationPointID 74204 attribute has a cardinality of 0 . . . 1 74206 meaning that for each instance of the ObjectReference 74180 entity there may be one InstallationPointID 74204 attribute. The data types of the various packages, entities, and attributes are described with respect to
The MessageHeader 75004 package includes a MessageHeader 75006 entity. The MessageHeader 75006 entity has a cardinality of 0 . . . 1 75008 meaning that for each instance of the MessageHeader 75004 package there may be one MessageHeader 75006 entity. The MaintenancePlan 75010 package includes a MaintenancePlan 75012 entity.
The MaintenancePlan 75012 entity has a cardinality of 0 . . . 1 75014 meaning that for each instance of the MaintenancePlan 75010 package there may be one MaintenancePlan 75012 entity. The MaintenancePlan 75012 entity includes an ID 75016 attribute. The ID 75016 attribute has a cardinality of 1 75018 meaning that for each instance of the MaintenancePlan 75012 entity there is one ID 75016 attribute.
The Log 75020 package includes a Log 75022 entity. The Log 75022 entity has a cardinality of 1 75024 meaning that for each instance of the Log 75020 package there is one Log 75022 entity. The data types of the various packages, entities, and attributes are described with respect to
The MessageHeader 76004 package includes a MessageHeader 76006 entity. The MessageHeader 76006 entity has a cardinality of 0 . . . 1 76008 meaning that for each instance of the MessageHeader 76004 package there may be one MessageHeader 76006 entity. The MaintenancePlan 76010 package includes a MaintenancePlan 76012 entity.
The MaintenancePlan 76012 entity has a cardinality of 1 76014 meaning that for each instance of the MaintenancePlan 76010 package there is one MaintenancePlan 76012 entity. The MaintenancePlan 76012 entity includes an ID 76016 attribute. The ID 76016 attribute has a cardinality of 1 76018 meaning that for each instance of the MaintenancePlan 76012 entity there is one ID 76016 attribute. The data types of the various packages, entities, and attributes are described with respect to
The MessageHeader 77004 package includes a MessageHeader 77006 entity. The MessageHeader 77006 entity has a cardinality of 0 . . . 1 77008 meaning that for each instance of the MessageHeader 77004 package there may be one MessageHeader 77006 entity. The Log 77010 package includes a Log 77012 entity. The Log 77012 entity has a cardinality of 1 77014 meaning that for each instance of the Log 77010 package there is one Log 77012 entity. The data types of the various packages, entities, and attributes are described with respect to
The MessageHeader 78004 package includes a MessageHeader 78006 entity. The MessageHeader 78006 entity has a cardinality of 0 . . . 1 78008 meaning that for each instance of the MessageHeader 78004 package there may be one MessageHeader 78006 entity. The MaintenancePlan 78010 package includes a MaintenancePlan 78012 entity. The MaintenancePlan 78012 entity has a cardinality of 1 78014 meaning that for each instance of the MaintenancePlan 78010 package there is one MaintenancePlan 78012 entity. The MaintenancePlan 78012 entity includes an ID 78016 attribute. The ID 78016 attribute has a cardinality of 1 78018 meaning that for each instance of the MaintenancePlan 78012 entity there is one ID 78016 attribute. The data types of the various packages, entities, and attributes are described with respect to
The MessageHeader 79004 package includes a MessageHeader 79006 entity. The MessageHeader 79006 entity has a cardinality of 0 . . . 1 79008 meaning that for each instance of the MessageHeader 79004 package there may be one MessageHeader 79006 entity. The Log 79010 package includes a Log 79012 entity. The Log 79012 entity has a cardinality of 1 79014 meaning that for each instance of the Log 79010 package there is one Log 79012 entity. The data types of the various packages, entities, and attributes are described with respect to
The MessageHeader 80004 package includes a MessageHeader 80006 entity. The MessageHeader 80006 entity has a cardinality of 0 . . . 1 80008 meaning that for each instance of the MessageHeader 80004 package there may be one MessageHeader 80006 entity. The MaintenancePlan 80010 package includes a MaintenancePlan 80012 entity. The MaintenancePlan 80012 entity has a cardinality of 1 80014 meaning that for each instance of the MaintenancePlan 80010 package there is one MaintenancePlan 80012 entity. The MaintenancePlan 80012 entity includes an ID 80016 attribute. The ID 80016 attribute has a cardinality of 1 80018 meaning that for each instance of the MaintenancePlan 80012 entity there is one ID 80016 attribute. The data types of the various packages, entities, and attributes are described with respect to
The MessageHeader 81004 package includes a MessageHeader 81006 entity. The MessageHeader 81006 entity has a cardinality of 0 . . . 1 81008 meaning that for each instance of the MessageHeader 81004 package there may be one MessageHeader 81006 entity. The Log 81010 package includes a Log 81012 entity. The Log 81012 entity has a cardinality of 1 81014 meaning that for each instance of the Log 81010 package there is one Log 81012 entity. The data types of the various packages, entities, and attributes are described with respect to
The MessageHeader 82004 package includes a MessageHeader 82006 entity. The MessageHeader 82006 entity has a cardinality of 0 . . . 1 82008 meaning that for each instance of the MessageHeader 82004 package there may be one MessageHeader 82006 entity. The MaintenancePlan 82010 package includes a MaintenancePlan 82012 entity. The MaintenancePlan 82012 entity has a cardinality of 1 82014 meaning that for each instance of the MaintenancePlan 82010 package there is one MaintenancePlan 82012 entity. The MaintenancePlan 82012 entity includes an ID 82016 attribute. The ID 82016 attribute has a cardinality of 1 82018 meaning that for each instance of the MaintenancePlan 82012 entity there is one ID 82016 attribute. The data types of the various packages, entities, and attributes are described with respect to
The MessageHeader 83004 package includes a MessageHeader 83006 entity. The MessageHeader 83006 entity has a cardinality of 0 . . . 1 83008 meaning that for each instance of the MessageHeader 83004 package there may be one MessageHeader 83006 entity. The Log 83010 package includes a Log 83012 entity. The Log 83012 entity has a cardinality of 1 83014 meaning that for each instance of the Log 83010 package there is one Log 83012 entity. The data types of the various packages, entities, and attributes are described with respect to
The Selection 84004 package includes a MaintenancePlanSimpleSelectionByElements 84006 entity. The MaintenancePlanSimpleSelectionByElements 84006 entity has a cardinality of 1 84008 meaning that for each instance of the Selection 84004 package there is one MaintenancePlanSimpleSelectionByElements 84006 entity. The MaintenancePlanSimpleSelectionByElements 84006 entity includes a MaintenancePlanCategoryCode 84010 attribute. The MaintenancePlanSimpleSelectionByElements 84006 entity includes a SelectionByMaintenancePlanID 84014 subordinate entity. The MaintenancePlanCategoryCode 84010 attribute has a cardinality of 0 . . . 1 84012 meaning that for each instance of the MaintenancePlanSimpleSelectionByElements 84006 entity there may be one MaintenancePlanCategoryCode 84010 attribute.
The SelectionByMaintenancePlanID 84014 entity has a cardinality of 0 . . . 1 84016 meaning that for each instance of the MaintenancePlanSimpleSelectionByElements 84006 entity there may be one SelectionByMaintenancePlanID 84014 entity. The SelectionByMaintenancePlanID 84014 entity includes various attributes, namely an InclusionExclusionCode 84018, an IntervalBoundaryTypeCode 84022, a LowerBoundaryMaintenancePlanID 84026 and an UpperBoundaryMaintenancePlanID 84030. The InclusionExclusionCode 84018 attribute has a cardinality of 0 . . . 1 84020 meaning that for each instance of the SelectionByMaintenancePlanID 84014 entity there may be one InclusionExclusionCode 84018 attribute.
The IntervalBoundaryTypeCode 84022 attribute has a cardinality of 0 . . . 1 84024 meaning that for each instance of the SelectionByMaintenancePlanID 84014 entity there may be one IntervalBoundaryTypeCode 84022 attribute. The LowerBoundaryMaintenancePlanID 84026 attribute has a cardinality of 0 . . . 1 84028 meaning that for each instance of the SelectionByMaintenancePlanID 84014 entity there may be one LowerBoundaryMaintenancePlanID 84026 attribute. The UpperBoundaryMaintenancePlanID 84030 attribute has a cardinality of 0 . . . 1 84032 meaning that for each instance of the SelectionByMaintenancePlanID 84014 entity there may be one UpperBoundaryMaintenancePlanID 84030 attribute.
The ProcessingConditions 84034 package includes a ProcessingConditions 84036 entity. The ProcessingConditions 84036 entity has a cardinality of 0 . . . 1 84038 meaning that for each instance of the ProcessingConditions 84034 package there may be one ProcessingConditions 84036 entity. The ProcessingConditions 84036 entity includes various attributes, namely a QueryHitsMaximumNumberValue 84040, an UnlimitedQueryHitsIndicator 84044, a ReturnedQueryHitsNumberValue 84048, a MoreElementsAvailableIndicator 84052 and a LastProvidedMaintenancePlanID 84056. The QueryHitsMaximumNumberValue 84040 attribute has a cardinality of 0 . . . 1 84042 meaning that for each instance of the ProcessingConditions 84036 entity there may be one QueryHitsMaximumNumberValue 84040 attribute.
The UnlimitedQueryHitsIndicator 84044 attribute has a cardinality of 0 . . . 1 84046 meaning that for each instance of the ProcessingConditions 84036 entity there may be one UnlimitedQueryHitsIndicator 84044 attribute. The ReturnedQueryHitsNumberValue 84048 attribute has a cardinality of 0 . . . 1 84050 meaning that for each instance of the ProcessingConditions 84036 entity there may be one ReturnedQueryHitsNumberValue 84048 attribute. The MoreElementsAvailableIndicator 84052 attribute has a cardinality of 0 . . . 1 84054 meaning that for each instance of the ProcessingConditions 84036 entity there may be one MoreElementsAvailableIndicator 84052 attribute. The LastProvidedMaintenancePlanID 84056 attribute has a cardinality of 0 . . . 1 84058 meaning that for each instance of the ProcessingConditions 84036 entity there may be one LastProvidedMaintenancePlanID 84056 attribute. The data types of the various packages, entities, and attributes are described with respect to
The MaintenancePlan 85004 package includes a MaintenancePlan 85006 entity. The MaintenancePlan 85006 entity has a cardinality of 0 . . . n 85008 meaning that for each instance of the MaintenancePlan 85004 package there may be one or more MaintenancePlan 85006 entities. The MaintenancePlan 85006 entity includes various attributes, namely an ID 85010 and a Description 85014. The ID 85010 attribute has a cardinality of 1 85012 meaning that for each instance of the MaintenancePlan 85006 entity there is one ID 85010 attribute. The Description 85014 attribute has a cardinality of 0 . . . 1 85016 meaning that for each instance of the MaintenancePlan 85006 entity there may be one Description 85014 attribute.
The ProcessingConditions 85018 package includes a ProcessingConditions 85020 entity. The ProcessingConditions 85020 entity has a cardinality of 1 85022 meaning that for each instance of the ProcessingConditions 85018 package there is one ProcessingConditions 85020 entity. The ProcessingConditions 85020 entity includes various attributes, namely a QueryHitsMaximumNumberValue 85024, an UnlimitedQueryHitsIndicator 85028, a ReturnedQueryHitsNumberValue 85032, a MoreElementsAvailableIndicator 85036 and a LastProvidedMaintenancePlanID 85040. The QueryHitsMaximumNumberValue 85024 attribute has a cardinality of 0 . . . 1 85026 meaning that for each instance of the ProcessingConditions 85020 entity there may be one QueryHitsMaximumNumberValue 85024 attribute.
The UnlimitedQueryHitsIndicator 85028 attribute has a cardinality of 0 . . . 1 85030 meaning that for each instance of the ProcessingConditions 85020 entity there may be one UnlimitedQueryHitsIndicator 85028 attribute. The ReturnedQueryHitsNumberValue 85032 attribute has a cardinality of 0 . . . 1 85034 meaning that for each instance of the ProcessingConditions 85020 entity there may be one ReturnedQueryHitsNumberValue 85032 attribute. The MoreElementsAvailableIndicator 85036 attribute has a cardinality of 0 . . . 1 85038 meaning that for each instance of the ProcessingConditions 85020 entity there may be one MoreElementsAvailableIndicator 85036 attribute. The LastProvidedMaintenancePlanID 85040 attribute has a cardinality of 0 . . . 1 85042 meaning that for each instance of the ProcessingConditions 85020 entity there may be one LastProvidedMaintenancePlanID 85040 attribute.
The Log 85044 package includes a Log 85046 entity. The Log 85046 entity has a cardinality of 1 85048 meaning that for each instance of the Log 85044 package there is one Log 85046 entity. The data types of the various packages, entities, and attributes are described with respect to
The MessageHeader 86004 package includes a MessageHeader 86006 entity. The MessageHeader 86006 entity has a cardinality of 0 . . . 1 86008 meaning that for each instance of the MessageHeader 86004 package there may be one MessageHeader 86006 entity.
The MaintenancePlan 86010 package includes a MaintenancePlan 86012 entity. The MaintenancePlan 86012 entity has a cardinality of 1 86014 meaning that for each instance of the MaintenancePlan 86010 package there is one MaintenancePlan 86012 entity. The MaintenancePlan 86012 entity includes various attributes, namely an ID 86016, a ChangeStateID 86020, a Description 86024 and a TextCollection 86028. The MaintenancePlan 86012 entity includes various subordinate entities, namely a SchedulingTerms 86032, a Cycle 86092 and an Item 86128. The ID 86016 attribute has a cardinality of 1 86018 meaning that for each instance of the MaintenancePlan 86012 entity there is one ID 86016 attribute.
The ChangeStateID 86020 attribute has a cardinality of 1 86022 meaning that for each instance of the MaintenancePlan 86012 entity there is one ChangeStateID 86020 attribute. The Description 86024 attribute has a cardinality of 0 . . . 1 86026 meaning that for each instance of the MaintenancePlan 86012 entity there may be one Description 86024 attribute. The TextCollection 86028 attribute has a cardinality of 0 . . . 1 86030 meaning that for each instance of the MaintenancePlan 86012 entity there may be one TextCollection 86028 attribute.
The SchedulingTerms 86032 entity has a cardinality of 0 . . . 1 86034 meaning that for each instance of the MaintenancePlan 86012 entity there may be one SchedulingTerms 86032 entity. The SchedulingTerms 86032 entity includes various attributes, namely a StartDateTime 86036, a MeasuringDeviceStartMeasurementReadingMeasure 86040, a LateCompletionShiftPercent 86044, an EarlyCompletionShiftPercent 86048, a LateCompletionTolerencePercent 86052, an EarlyCompletionTolerencePercent 86056, a WorkingDayCalendarCode 86060, a MaintenancePlanCycleQuantityModificationFactorValue 86064, a BufferStartDaysNumberValue 86068, a CallHorizonPercent 86072, a PredecessorCompletionRequiredIndicator 86076, a SchedulingDuration 86080, a SchedulingCategoryCode 86084 and a CycleDependencyIndicator 86088. The StartDateTime 86036 attribute has a cardinality of 0 . . . 1 86038 meaning that for each instance of the SchedulingTerms 86032 entity there may be one StartDateTime 86036 attribute.
The MeasuringDeviceStartMeasurementReadingMeasure 86040 attribute has a cardinality of 0 . . . 1 86042 meaning that for each instance of the SchedulingTerms 86032 entity there may be one MeasuringDeviceStartMeasurementReadingMeasure 86040 attribute. The LateCompletionShiftPercent 86044 attribute has a cardinality of 0 . . . 1 86046 meaning that for each instance of the SchedulingTerms 86032 entity there may be one LateCompletionShiftPercent 86044 attribute. The EarlyCompletionShiftPercent 86048 attribute has a cardinality of 0 . . . 1 86050 meaning that for each instance of the SchedulingTerms 86032 entity there may be one EarlyCompletionShiftPercent 86048 attribute.
The LateCompletionTolerencePercent 86052 attribute has a cardinality of 0 . . . 1 86054 meaning that for each instance of the SchedulingTerms 86032 entity there may be one LateCompletionTolerencePercent 86052 attribute. The EarlyCompletionTolerencePercent 86056 attribute has a cardinality of 0 . . . 1 86058 meaning that for each instance of the SchedulingTerms 86032 entity there may be one EarlyCompletionTolerencePercent 86056 attribute. The WorkingDayCalendarCode 86060 attribute has a cardinality of 0 . . . 1 86062 meaning that for each instance of the SchedulingTerms 86032 entity there may be one WorkingDayCalendarCode 86060 attribute. The MaintenancePlanCycleQuantityModificationFactorValue 86064 attribute has a cardinality of 0 . . . 1 86066 meaning that for each instance of the SchedulingTerms 86032 entity there may be one MaintenancePlanCycleQuantityModificationFactorValue 86064 attribute. The BufferStartDaysNumberValue 86068 attribute has a cardinality of 0 . . . 1 86070 meaning that for each instance of the SchedulingTerms 86032 entity there may be one BufferStartDaysNumberValue 86068 attribute.
The CallHorizonPercent 86072 attribute has a cardinality of 0 . . . 1 86074 meaning that for each instance of the SchedulingTerms 86032 entity there may be one CallHorizonPercent 86072 attribute. The PredecessorCompletionRequiredIndicator 86076 attribute has a cardinality of 0 . . . 1 86078 meaning that for each instance of the SchedulingTerms 86032 entity there may be one PredecessorCompletionRequiredIndicator 86076 attribute. The SchedulingDuration 86080 attribute has a cardinality of 0 . . . 1 86082 meaning that for each instance of the SchedulingTerms 86032 entity there may be one SchedulingDuration 86080 attribute. The SchedulingCategoryCode 86084 attribute has a cardinality of 0 . . . 1 86086 meaning that for each instance of the SchedulingTerms 86032 entity there may be one SchedulingCategoryCode 86084 attribute. The CycleDependencyIndicator 86088 attribute has a cardinality of 0 . . . 1 86090 meaning that for each instance of the SchedulingTerms 86032 entity there may be one CycleDependencyIndicator 86088 attribute.
The Cycle 86092 entity has a cardinality of 0 . . . n 86094 meaning that for each instance of the MaintenancePlan 86012 entity there may be one or more Cycle 86092 entities. The Cycle 86092 entity includes various attributes, namely a @actionCode 86096, a CounterValue 86100, a GroupSequenceNumberValue 86104, a GroupSequenceRepetitionNumberValue 86108, a Quantity 86112, a StartOffsetQuantity 86116, a MeasuringDeviceID 86120 and a Description 86124. The @actionCode 86096 attribute has a cardinality of 1 86098 meaning that for each instance of the Cycle 86092 entity there is one @actionCode 86096 attribute. The CounterValue 86100 attribute has a cardinality of 1 86102 meaning that for each instance of the Cycle 86092 entity there is one CounterValue 86100 attribute. The GroupSequenceNumberValue 86104 attribute has a cardinality of 0 . . . 1 86106 meaning that for each instance of the Cycle 86092 entity there may be one GroupSequenceNumberValue 86104 attribute.
The GroupSequenceRepetitionNumberValue 86108 attribute has a cardinality of 0 . . . 1 86110 meaning that for each instance of the Cycle 86092 entity there may be one GroupSequenceRepetitionNumberValue 86108 attribute. The Quantity 86112 attribute has a cardinality of 0 . . . 1 86114 meaning that for each instance of the Cycle 86092 entity there may be one Quantity 86112 attribute. The StartOffsetQuantity 86116 attribute has a cardinality of 0 . . . 1 86118 meaning that for each instance of the Cycle 86092 entity there may be one StartOffsetQuantity 86116 attribute. The MeasuringDeviceID 86120 attribute has a cardinality of 0 . . . 1 86122 meaning that for each instance of the Cycle 86092 entity there may be one MeasuringDeviceID 86120 attribute. The Description 86124 attribute has a cardinality of 0 . . . 1 86126 meaning that for each instance of the Cycle 86092 entity there may be one Description 86124 attribute.
The Item 86128 entity has a cardinality of 0 . . . n 86130 meaning that for each instance of the MaintenancePlan 86012 entity there may be one or more Item 86128 entities. The Item 86128 entity includes various attributes, namely a @actionCode 86132, an ID 86136, a CycleGroupSequenceNumberValue 86140, a BusinessTransactionDocumentProcessingTypeCode 86144, a BusinessTransactionDocumentReference 86148, a WorkCentreID 86152, a MaintenancePlanningPlantID 86156, a MaintenancePlannerGroupCode 86160, an ImportanceCode 86164, a MaintenanceTaskListID 86168, a BusinessTransactionDocumentGroupID 86172, a BusinessObjectTypeCode 86176, a WorkCentrePlantID 86180, a Description 86184 and a TextCollection 86188. The Item 86128 entity includes an ObjectReference 86192 subordinate entity. The @actionCode 86132 attribute has a cardinality of 1 86134 meaning that for each instance of the Item 86128 entity there is one @actionCode 86132 attribute. The ID 86136 attribute has a cardinality of 0 . . . 1 86138 meaning that for each instance of the Item 86128 entity there may be one ID 86136 attribute. The CycleGroupSequenceNumberValue 86140 attribute has a cardinality of 0 . . . 1 86142 meaning that for each instance of the Item 86128 entity there may be one CycleGroupSequenceNumberValue 86140 attribute.
The BusinessTransactionDocumentProcessingTypeCode 86144 attribute has a cardinality of 0 . . . 1 86146 meaning that for each instance of the Item 86128 entity there may be one BusinessTransactionDocumentProcessingTypeCode 86144 attribute. The BusinessTransactionDocumentReference 86148 attribute has a cardinality of 0 . . . 1 86150 meaning that for each instance of the Item 86128 entity there may be one BusinessTransactionDocumentReference 86148 attribute. The WorkCentreID 86152 attribute has a cardinality of 0 . . . 1 86154 meaning that for each instance of the Item 86128 entity there may be one WorkCentreID 86152 attribute. The MaintenancePlanningPlantID 86156 attribute has a cardinality of 0 . . . 1 86158 meaning that for each instance of the Item 86128 entity there may be one MaintenancePlanningPlantID 86156 attribute. The MaintenancePlannerGroupCode 86160 attribute has a cardinality of 0 . . . 1 86162 meaning that for each instance of the Item 86128 entity there may be one MaintenancePlannerGroupCode 86160 attribute.
The ImportanceCode 86164 attribute has a cardinality of 0 . . . 1 86166 meaning that for each instance of the Item 86128 entity there may be one ImportanceCode 86164 attribute. The MaintenanceTaskListID 86168 attribute has a cardinality of 0 . . . 1 86170 meaning that for each instance of the Item 86128 entity there may be one MaintenanceTaskListID 86168 attribute. The BusinessTransactionDocumentGroupID 86172 attribute has a cardinality of 0 . . . 1 86174 meaning that for each instance of the Item 86128 entity there may be one BusinessTransactionDocumentGroupID 86172 attribute. The BusinessObjectTypeCode 86176 attribute has a cardinality of 0 . . . 1 86178 meaning that for each instance of the Item 86128 entity there may be one BusinessObjectTypeCode 86176 attribute. The WorkCentrePlantID 86180 attribute has a cardinality of 0 . . . 1 86182 meaning that for each instance of the Item 86128 entity there may be one WorkCentrePlantID 86180 attribute. The Description 86184 attribute has a cardinality of 0 . . . 1 86186 meaning that for each instance of the Item 86128 entity there may be one Description 86184 attribute. The TextCollection 86188 attribute has a cardinality of 0 . . . 1 86190 meaning that for each instance of the Item 86128 entity there may be one TextCollection 86188 attribute.
The ObjectReference 86192 entity has a cardinality of 0 . . . n 86194 meaning that for each instance of the Item 86128 entity there may be one or more ObjectReference 86192 entities. The ObjectReference 86192 entity includes various attributes, namely a @actionCode 86196, an OrdinalNumberValue 86200, a MainIndicator 86204, a SerialID 86208, a MaterialInternalID 86212, an IndividualMaterialID 86216 and an InstallationPointID 86220. The @actionCode 86196 attribute has a cardinality of 1 86198 meaning that for each instance of the ObjectReference 86192 entity there is one @actionCode 86196 attribute. The OrdinalNumberValue 86200 attribute has a cardinality of 0 . . . 1 86202 meaning that for each instance of the ObjectReference 86192 entity there may be one OrdinalNumberValue 86200 attribute.
The MainIndicator 86204 attribute has a cardinality of 1 86206 meaning that for each instance of the ObjectReference 86192 entity there is one MainIndicator 86204 attribute. The SerialID 86208 attribute has a cardinality of 0 . . . 1 86210 meaning that for each instance of the ObjectReference 86192 entity there may be one SerialID 86208 attribute. The MaterialInternalID 86212 attribute has a cardinality of 0 . . . 1 86214 meaning that for each instance of the ObjectReference 86192 entity there may be one MaterialInternalID 86212 attribute. The IndividualMaterialID 86216 attribute has a cardinality of 0 . . . 1 86218 meaning that for each instance of the ObjectReference 86192 entity there may be one IndividualMaterialID 86216 attribute. The InstallationPointID 86220 attribute has a cardinality of 0 . . . 1 86222 meaning that for each instance of the ObjectReference 86192 entity there may be one InstallationPointID 86220 attribute. The data types of the various packages, entities, and attributes are described with respect to
The MessageHeader 87004 package includes a MessageHeader 87006 entity. The MessageHeader 87006 entity has a cardinality of 0 . . . 1 87008 meaning that for each instance of the MessageHeader 87004 package there may be one MessageHeader 87006 entity.
The MaintenancePlan 87010 package includes a MaintenancePlan 87012 entity. The MaintenancePlan 87012 entity has a cardinality of 0 . . . 1 87014 meaning that for each instance of the MaintenancePlan 87010 package there may be one MaintenancePlan 87012 entity. The MaintenancePlan 87012 entity includes an ID 87016 attribute. The ID 87016 attribute has a cardinality of 1 87018 meaning that for each instance of the MaintenancePlan 87012 entity there is one ID 87016 attribute.
The Log 87020 package includes a Log 87022 entity. The Log 87022 entity has a cardinality of 1 87024 meaning that for each instance of the Log 87020 package there is one Log 87022 entity. The data types of the various packages, entities, and attributes are described with respect to
The MaintenancePlan 88004 package includes a MaintenancePlan 88006 entity. The MaintenancePlan 88006 entity has a cardinality of 1 88008 meaning that for each instance of the MaintenancePlan 88004 package there is one MaintenancePlan 88006 entity. The MaintenancePlan 88006 entity includes various attributes, namely a CategoryCode 88010, a Description 88014 and a TextCollection 88018. The MaintenancePlan 88006 entity includes various subordinate entities, namely a SchedulingTerms 88022, a Cycle 88082 and an Item 88114. The CategoryCode 88010 attribute has a cardinality of 1 88012 meaning that for each instance of the MaintenancePlan 88006 entity there is one CategoryCode 88010 attribute. The Description 88014 attribute has a cardinality of 1 88016 meaning that for each instance of the MaintenancePlan 88006 entity there is one Description 88014 attribute. The TextCollection 88018 attribute has a cardinality of 0 . . . 1 88020 meaning that for each instance of the MaintenancePlan 88006 entity there may be one TextCollection 88018 attribute.
The SchedulingTerms 88022 entity has a cardinality of 0 . . . 1 88024 meaning that for each instance of the MaintenancePlan 88006 entity there may be one SchedulingTerms 88022 entity. The SchedulingTerms 88022 entity includes various attributes, namely a StartDateTime 88026, a MeasuringDeviceStartMeasurementReadingMeasure 88030, a LateCompletionShiftPercent 88034, an EarlyCompletionShiftPercent 88038, a LateCompletionTolerencePercent 88042, a WorkingDayCalendarCode 88046, an EarlyCompletionTolerencePercent 88050, a MaintenancePlanCycleQuantityModificationFactorValue 88054, a BufferStartDaysNumberValue 88058, a CallHorizonPercent 88062, a PredecessorCompletionRequiredIndicator 88066, a SchedulingDuration 88070, a SchedulingCategoryCode 88074 and a CycleDependencyIndicator 88078. The StartDateTime 88026 attribute has a cardinality of 0 . . . 1 88028 meaning that for each instance of the SchedulingTerms 88022 entity there may be one StartDateTime 88026 attribute.
The MeasuringDeviceStartMeasurementReadingMeasure 88030 attribute has a cardinality of 0 . . . 1 88032 meaning that for each instance of the SchedulingTerms 88022 entity there may be one MeasuringDeviceStartMeasurementReadingMeasure 88030 attribute. The LateCompletionShiftPercent 88034 attribute has a cardinality of 0 . . . 1 88036 meaning that for each instance of the SchedulingTerms 88022 entity there may be one LateCompletionShiftPercent 88034 attribute. The EarlyCompletionShiftPercent 88038 attribute has a cardinality of 0 . . . 1 88040 meaning that for each instance of the SchedulingTerms 88022 entity there may be one EarlyCompletionShiftPercent 88038 attribute.
The LateCompletionTolerencePercent 88042 attribute has a cardinality of 0 . . . 1 88044 meaning that for each instance of the SchedulingTerms 88022 entity there may be one LateCompletionTolerencePercent 88042 attribute. The WorkingDayCalendarCode 88046 attribute has a cardinality of 0 . . . 1 88048 meaning that for each instance of the SchedulingTerms 88022 entity there may be one WorkingDayCalendarCode 88046 attribute. The EarlyCompletionTolerencePercent 88050 attribute has a cardinality of 0 . . . 1 88052 meaning that for each instance of the SchedulingTerms 88022 entity there may be one EarlyCompletionTolerencePercent 88050 attribute. The MaintenancePlanCycleQuantityModificationFactorValue 88054 attribute has a cardinality of 0 . . . 1 88056 meaning that for each instance of the SchedulingTerms 88022 entity there may be one MaintenancePlanCycleQuantityModificationFactorValue 88054 attribute.
The BufferStartDaysNumberValue 88058 attribute has a cardinality of 0 . . . 1 88060 meaning that for each instance of the SchedulingTerms 88022 entity there may be one BufferStartDaysNumberValue 88058 attribute. The CallHorizonPercent 88062 attribute has a cardinality of 0 . . . 1 88064 meaning that for each instance of the SchedulingTerms 88022 entity there may be one CallHorizonPercent 88062 attribute. The PredecessorCompletionRequiredIndicator 88066 attribute has a cardinality of 0 . . . 1 88068 meaning that for each instance of the SchedulingTerms 88022 entity there may be one PredecessorCompletionRequiredIndicator 88066 attribute.
The SchedulingDuration 88070 attribute has a cardinality of 0 . . . 1 88072 meaning that for each instance of the SchedulingTerms 88022 entity there may be one SchedulingDuration 88070 attribute. The SchedulingCategoryCode 88074 attribute has a cardinality of 0 . . . 1 88076 meaning that for each instance of the SchedulingTerms 88022 entity there may be one SchedulingCategoryCode 88074 attribute. The CycleDependencyIndicator 88078 attribute has a cardinality of 0 . . . 1 88080 meaning that for each instance of the SchedulingTerms 88022 entity there may be one CycleDependencyIndicator 88078 attribute.
The Cycle 88082 entity has a cardinality of 0 . . . n 88084 meaning that for each instance of the MaintenancePlan 88006 entity there may be one or more Cycle 88082 entities. The Cycle 88082 entity includes various attributes, namely a CounterValue 88086, a GroupSequenceNumberValue 88090, a GroupSequenceRepetitionNumberValue 88094, a Quantity 88098, a StartOffsetQuantity 88102, a MeasuringDeviceID 88106 and a Description 88110. The CounterValue 88086 attribute has a cardinality of 1 88088 meaning that for each instance of the Cycle 88082 entity there is one CounterValue 88086 attribute. The GroupSequenceNumberValue 88090 attribute has a cardinality of 0 . . . 1 88092 meaning that for each instance of the Cycle 88082 entity there may be one GroupSequenceNumberValue 88090 attribute.
The GroupSequenceRepetitionNumberValue 88094 attribute has a cardinality of 0 . . . 1 88096 meaning that for each instance of the Cycle 88082 entity there may be one GroupSequenceRepetitionNumberValue 88094 attribute. The Quantity 88098 attribute has a cardinality of 1 88100 meaning that for each instance of the Cycle 88082 entity there is one Quantity 88098 attribute. The StartOffsetQuantity 88102 attribute has a cardinality of 0 . . . 1 88104 meaning that for each instance of the Cycle 88082 entity there may be one StartOffsetQuantity 88102 attribute. The MeasuringDeviceID 88106 attribute has a cardinality of 1 88108 meaning that for each instance of the Cycle 88082 entity there is one MeasuringDeviceID 88106 attribute. The Description 88110 attribute has a cardinality of 0 . . . 1 88112 meaning that for each instance of the Cycle 88082 entity there may be one Description 88110 attribute.
The Item 88114 entity has a cardinality of 1 . . . N 88116 meaning that for each instance of the MaintenancePlan 88006 entity there are one or more Item 88114 entities. The Item 88114 entity includes various attributes, namely an OrdinalNumberValue 88118, a CycleGroupSequenceNumberValue 88122, a BusinessTransactionDocumentProcessingTypeCode 88126, a WorkCentreID 88130, a WorkCentrePlantID 88134, a MaintenancePlanningPlantID 88138, a MaintenancePlannerGroupCode 88142, an ImportanceCode 88146, a MaintenanceTaskListID 88150, a BusinessTransactionDocumentGroupID 88154, a BusinessObjectTypeCode 88158, a BusinessTransactionDocumentReference 88162, a Description 88166 and a TextCollection 88170. The Item 88114 entity includes an ObjectReference 88174 subordinate entity. The OrdinalNumberValue 88118 attribute has a cardinality of 1 88120 meaning that for each instance of the Item 88114 entity there is one OrdinalNumberValue 88118 attribute.
The CycleGroupSequenceNumberValue 88122 attribute has a cardinality of 0 . . . 1 88124 meaning that for each instance of the Item 88114 entity there may be one CycleGroupSequenceNumberValue 88122 attribute. The BusinessTransactionDocumentProcessingTypeCode 88126 attribute has a cardinality of 1 88128 meaning that for each instance of the Item 88114 entity there is one BusinessTransactionDocumentProcessingTypeCode 88126 attribute. The WorkCentreID 88130 attribute has a cardinality of 1 88132 meaning that for each instance of the Item 88114 entity there is one WorkCentreID 88130 attribute. The WorkCentrePlantID 88134 attribute has a cardinality of 1 88136 meaning that for each instance of the Item 88114 entity there is one WorkCentrePlantID 88134 attribute. The MaintenancePlanningPlantID 88138 attribute has a cardinality of 1 88140 meaning that for each instance of the Item 88114 entity there is one MaintenancePlanningPlantID 88138 attribute.
The MaintenancePlannerGroupCode 88142 attribute has a cardinality of 0 . . . 1 88144 meaning that for each instance of the Item 88114 entity there may be one MaintenancePlannerGroupCode 88142 attribute. The ImportanceCode 88146 attribute has a cardinality of 0 . . . 1 88148 meaning that for each instance of the Item 88114 entity there may be one ImportanceCode 88146 attribute. The MaintenanceTaskListID 88150 attribute has a cardinality of 0 . . . 1 88152 meaning that for each instance of the Item 88114 entity there may be one MaintenanceTaskListID 88150 attribute. The BusinessTransactionDocumentGroupID 88154 attribute has a cardinality of 0 . . . 1 88156 meaning that for each instance of the Item 88114 entity there may be one BusinessTransactionDocumentGroupID 88154 attribute.
The BusinessObjectTypeCode 88158 attribute has a cardinality of 0 . . . 1 88160 meaning that for each instance of the Item 88114 entity there may be one BusinessObjectTypeCode 88158 attribute. The BusinessTransactionDocumentReference 88162 attribute has a cardinality of 0 . . . 1 88164 meaning that for each instance of the Item 88114 entity there may be one BusinessTransactionDocumentReference 88162 attribute. The Description 88166 attribute has a cardinality of 0 . . . 1 88168 meaning that for each instance of the Item 88114 entity there may be one Description 88166 attribute. The TextCollection 88170 attribute has a cardinality of 0 . . . 1 88172 meaning that for each instance of the Item 88114 entity there may be one TextCollection 88170 attribute.
The ObjectReference 88174 entity has a cardinality of 1 . . . n 88176 meaning that for each instance of the Item 88114 entity there are one or more ObjectReference 88174 entities. The ObjectReference 88174 entity includes various attributes, namely an OrdinalNumberValue 88178, a MainIndicator 88182, a SerialID 88186, a MaterialInternalID 88190, an IndividualMaterialID 88194 and an InstallationPointID 88198. The OrdinalNumberValue 88178 attribute has a cardinality of 1 88180 meaning that for each instance of the ObjectReference 88174 entity there is one OrdinalNumberValue 88178 attribute. The MainIndicator 88182 attribute has a cardinality of 1 88184 meaning that for each instance of the ObjectReference 88174 entity there is one MainIndicator 88182 attribute.
The SerialID 88186 attribute has a cardinality of 0 . . . 1 88188 meaning that for each instance of the ObjectReference 88174 entity there may be one SerialID 88186 attribute. The MaterialInternalID 88190 attribute has a cardinality of 0 . . . 1 88192 meaning that for each instance of the ObjectReference 88174 entity there may be one MaterialInternalID 88190 attribute. The IndividualMaterialID 88194 attribute has a cardinality of 0 . . . 1 88196 meaning that for each instance of the ObjectReference 88174 entity there may be one IndividualMaterialID 88194 attribute. The InstallationPointID 88198 attribute has a cardinality of 0 . . . 1 88200 meaning that for each instance of the ObjectReference 88174 entity there may be one InstallationPointID 88198 attribute. The data types of the various packages, entities, and attributes are described with respect to
The Log 89004 package includes a Log 89006 entity. The Log 89006 entity has a cardinality of 1 89008 meaning that for each instance of the Log 89004 package there is one Log 89006 entity. The data types of the various packages, entities, and attributes are described with respect to
The Selection 90004 package includes a MaintenancePlanItemSelectionByElements 90006 entity. The MaintenancePlanItemSelectionByElements 90006 entity has a cardinality of 1 90008 meaning that for each instance of the Selection 90004 package there is one MaintenancePlanItemSelectionByElements 90006 entity. The MaintenancePlanItemSelectionByElements 90006 entity includes various attributes, namely a CategoryCode 90010, a MaintenancePlannerGroupCode 90014, a MaintenancePlanID 90018, a MaterialInternalID 90022, an IndividualMaterialID 90026 and an InstallationPointID 90030. The CategoryCode 90010 attribute has a cardinality of 0 . . . 1 90012 meaning that for each instance of the MaintenancePlanItemSelectionByElements 90006 entity there may be one CategoryCode 90010 attribute.
The MaintenancePlannerGroupCode 90014 attribute has a cardinality of 0 . . . 1 90016 meaning that for each instance of the MaintenancePlanItemSelectionByElements 90006 entity there may be one MaintenancePlannerGroupCode 90014 attribute. The MaintenancePlanID 90018 attribute has a cardinality of 0 . . . 1 90020 meaning that for each instance of the MaintenancePlanItemSelectionByElements 90006 entity there may be one MaintenancePlanID 90018 attribute. The MaterialInternalID 90022 attribute has a cardinality of 0 . . . 1 90024 meaning that for each instance of the MaintenancePlanItemSelectionByElements 90006 entity there may be one MaterialInternalID 90022 attribute. The IndividualMaterialID 90026 attribute has a cardinality of 0 . . . 1 90028 meaning that for each instance of the MaintenancePlanItemSelectionByElements 90006 entity there may be one IndividualMaterialID 90026 attribute. The InstallationPointID 90030 attribute has a cardinality of 0 . . . 1 90032 meaning that for each instance of the MaintenancePlanItemSelectionByElements 90006 entity there may be one InstallationPointID 90030 attribute.
The ProcessingConditions 90034 package includes a ProcessingConditions 90036 entity. The ProcessingConditions 90036 entity has a cardinality of 0 . . . 1 90038 meaning that for each instance of the ProcessingConditions 90034 package there may be one ProcessingConditions 90036 entity. The ProcessingConditions 90036 entity includes various attributes, namely a QueryHitsMaximumNumberValue 90040, an UnlimitedQueryHitsIndicator 90044, a ReturnedQueryHitsNumberValue 90048, a MoreElementsAvailableIndicator 90052 and a LastProvidedItemID 90056. The QueryHitsMaximumNumberValue 90040 attribute has a cardinality of 0 . . . 1 90042 meaning that for each instance of the ProcessingConditions 90036 entity there may be one QueryHitsMaximumNumberValue 90040 attribute.
The UnlimitedQueryHitsIndicator 90044 attribute has a cardinality of 0 . . . 1 90046 meaning that for each instance of the ProcessingConditions 90036 entity there may be one UnlimitedQueryHitsIndicator 90044 attribute. The ReturnedQueryHitsNumberValue 90048 attribute has a cardinality of 0 . . . 1 90050 meaning that for each instance of the ProcessingConditions 90036 entity there may be one ReturnedQueryHitsNumberValue 90048 attribute. The MoreElementsAvailableIndicator 90052 attribute has a cardinality of 0 . . . 1 90054 meaning that for each instance of the ProcessingConditions 90036 entity there may be one MoreElementsAvailableIndicator 90052 attribute. The LastProvidedItemID 90056 attribute has a cardinality of 0 . . . 1 90058 meaning that for each instance of the ProcessingConditions 90036 entity there may be one LastProvidedItemID 90056 attribute. The data types of the various packages, entities, and attributes are described with respect to
The MaintenancePlanItem 91004 package includes various entities, namely a MaintenancePlan 91006 and a ProcessingConditions 91030. The MaintenancePlan 91006 entity has a cardinality of 0 . . . n 91008 meaning that for each instance of the MaintenancePlanItem 91004 package there may be one or more MaintenancePlan 91006 entities. The MaintenancePlan 91006 entity includes various attributes, namely an ID 91010 and a Description 91014. The MaintenancePlan 91006 entity includes an Item 91018 subordinate entity. The ID 91010 attribute has a cardinality of 1 91012 meaning that for each instance of the MaintenancePlan 91006 entity there is one ID 91010 attribute.
The Description 91014 attribute has a cardinality of 0 . . . 1 91016 meaning that for each instance of the MaintenancePlan 91006 entity there may be one Description 91014 attribute. The Item 91018 entity has a cardinality of 1 91020 meaning that for each instance of the MaintenancePlan 91006 entity there is one Item 91018 entity. The Item 91018 entity includes various attributes, namely an ID 91022 and a Description 91026. The ID 91022 attribute has a cardinality of 1 91024 meaning that for each instance of the Item 91018 entity there is one ID 91022 attribute. The Description 91026 attribute has a cardinality of 0 . . . 1 91028 meaning that for each instance of the Item 91018 entity there may be one Description 91026 attribute.
The ProcessingConditions 91030 entity has a cardinality of 0 . . . 1 91032 meaning that for each instance of the MaintenancePlanItem 91004 package there may be one ProcessingConditions 91030 entity. The ProcessingConditions 91030 entity includes various attributes, namely a QueryHitsMaximumNumberValue 91034, an UnlimitedQueryHitsIndicator 91038, a ReturnedQueryHitsNumberValue 91042, a MoreElementsAvailableIndicator 91046 and a LastProvidedItemID 91050. The QueryHitsMaximumNumberValue 91034 attribute has a cardinality of 0 . . . 1 91036 meaning that for each instance of the ProcessingConditions 91030 entity there may be one QueryHitsMaximumNumberValue 91034 attribute.
The UnlimitedQueryHitsIndicator 91038 attribute has a cardinality of 0 . . . 1 91040 meaning that for each instance of the ProcessingConditions 91030 entity there may be one UnlimitedQueryHitsIndicator 91038 attribute. The ReturnedQueryHitsNumberValue 91042 attribute has a cardinality of 0 . . . 1 91044 meaning that for each instance of the ProcessingConditions 91030 entity there may be one ReturnedQueryHitsNumberValue 91042 attribute. The MoreElementsAvailableIndicator 91046 attribute has a cardinality of 0 . . . 1 91048 meaning that for each instance of the ProcessingConditions 91030 entity there may be one MoreElementsAvailableIndicator 91046 attribute. The LastProvidedItemID 91050 attribute has a cardinality of 0 . . . 1 91052 meaning that for each instance of the ProcessingConditions 91030 entity there may be one LastProvidedItemID 91050 attribute.
The Log 91054 package includes a Log 91056 entity. The Log 91056 entity has a cardinality of 1 91058 meaning that for each instance of the Log 91054 package there is one Log 91056 entity. The data types of the various packages, entities, and attributes are described with respect to
The MaintenancePlan 92004 package includes a MaintenancePlan 92006 entity. The MaintenancePlan 92006 entity has a cardinality of 1 92008 meaning that for each instance of the MaintenancePlan 92004 package there is one MaintenancePlan 92006 entity. The MaintenancePlan 92006 entity includes various attributes, namely an ID 92010, a ChangeStateID 92014, a Description 92018 and a TextCollection 92022. The MaintenancePlan 92006 entity includes various subordinate entities, namely a SchedulingTerms 92026, a Cycle 92086 and an Item 92122. The ID 92010 attribute has a cardinality of 1 92012 meaning that for each instance of the MaintenancePlan 92006 entity there is one ID 92010 attribute.
The ChangeStateID 92014 attribute has a cardinality of 1 92016 meaning that for each instance of the MaintenancePlan 92006 entity there is one ChangeStateID 92014 attribute. The Description 92018 attribute has a cardinality of 0 . . . 1 92020 meaning that for each instance of the MaintenancePlan 92006 entity there may be one Description 92018 attribute. The TextCollection 92022 attribute has a cardinality of 0 . . . 1 92024 meaning that for each instance of the MaintenancePlan 92006 entity there may be one TextCollection 92022 attribute.
The SchedulingTerms 92026 entity has a cardinality of 0 . . . 1 92028 meaning that for each instance of the MaintenancePlan 92006 entity there may be one SchedulingTerms 92026 entity. The SchedulingTerms 92026 entity includes various attributes, namely a StartDateTime 92030, a MeasuringDeviceStartMeasurementReadingMeasure 92034, a LateCompletionShiftPercent 92038, an EarlyCompletionShiftPercent 92042, a LateCompletionTolerencePercent 92046, a WorkingDayCalendarCode 92050, an EarlyCompletionTolerencePercent 92054, a MaintenancePlanCycleQuantityModificationFactorValue 92058, a BufferStartDaysNumberValue 92062, a CallHorizonPercent 92066, a PredecessorCompletionRequiredIndicator 92070, a SchedulingDuration 92074, a SchedulingCategoryCode 92078 and a CycleDependencyIndicator 92082. The StartDateTime 92030 attribute has a cardinality of 0 . . . 1 92032 meaning that for each instance of the SchedulingTerms 92026 entity there may be one StartDateTime 92030 attribute.
The MeasuringDeviceStartMeasurementReadingMeasure 92034 attribute has a cardinality of 0 . . . 1 92036 meaning that for each instance of the SchedulingTerms 92026 entity there may be one MeasuringDeviceStartMeasurementReadingMeasure 92034 attribute. The LateCompletionShiftPercent 92038 attribute has a cardinality of 0 . . . 1 92040 meaning that for each instance of the SchedulingTerms 92026 entity there may be one LateCompletionShiftPercent 92038 attribute. The EarlyCompletionShiftPercent 92042 attribute has a cardinality of 0 . . . 1 92044 meaning that for each instance of the SchedulingTerms 92026 entity there may be one EarlyCompletionShiftPercent 92042 attribute. The LateCompletionTolerencePercent 92046 attribute has a cardinality of 0 . . . 1 92048 meaning that for each instance of the SchedulingTerms 92026 entity there may be one LateCompletionTolerencePercent 92046 attribute.
The WorkingDayCalendarCode 92050 attribute has a cardinality of 0 . . . 1 92052 meaning that for each instance of the SchedulingTerms 92026 entity there may be one WorkingDayCalendarCode 92050 attribute. The EarlyCompletionTolerencePercent 92054 attribute has a cardinality of 0 . . . 1 92056 meaning that for each instance of the SchedulingTerms 92026 entity there may be one EarlyCompletionTolerencePercent 92054 attribute. The MaintenancePlanCycleQuantityModificationFactorValue 92058 attribute has a cardinality of 0 . . . 1 92060 meaning that for each instance of the SchedulingTerms 92026 entity there may be one MaintenancePlanCycleQuantityModificationFactorValue 92058 attribute. The BufferStartDaysNumberValue 92062 attribute has a cardinality of 0 . . . 1 92064 meaning that for each instance of the SchedulingTerms 92026 entity there may be one BufferStartDaysNumberValue 92062 attribute. The CallHorizonPercent 92066 attribute has a cardinality of 0 . . . 1 92068 meaning that for each instance of the SchedulingTerms 92026 entity there may be one CallHorizonPercent 92066 attribute.
The PredecessorCompletionRequiredIndicator 92070 attribute has a cardinality of 0 . . . 1 92072 meaning that for each instance of the SchedulingTerms 92026 entity there may be one PredecessorCompletionRequiredIndicator 92070 attribute. The SchedulingDuration 92074 attribute has a cardinality of 0 . . . 1 92076 meaning that for each instance of the SchedulingTerms 92026 entity there may be one SchedulingDuration 92074 attribute. The SchedulingCategoryCode 92078 attribute has a cardinality of 0 . . . 1 92080 meaning that for each instance of the SchedulingTerms 92026 entity there may be one SchedulingCategoryCode 92078 attribute. The CycleDependencyIndicator 92082 attribute has a cardinality of 0 . . . 1 92084 meaning that for each instance of the SchedulingTerms 92026 entity there may be one CycleDependencyIndicator 92082 attribute.
The Cycle 92086 entity has a cardinality of 0 . . . n 92088 meaning that for each instance of the MaintenancePlan 92006 entity there may be one or more Cycle 92086 entities. The Cycle 92086 entity includes various attributes, namely a @actionCode 92090, a CounterValue 92094, a GroupSequenceNumberValue 92098, a GroupSequenceRepetitionNumberValue 92102, a Quantity 92106, a StartOffsetQuantity 92110, a MeasuringDeviceID 92114 and a Description 92118. The @actionCode 92090 attribute has a cardinality of 1 92092 meaning that for each instance of the Cycle 92086 entity there is one @actionCode 92090 attribute. The CounterValue 92094 attribute has a cardinality of 1 92096 meaning that for each instance of the Cycle 92086 entity there is one CounterValue 92094 attribute. The GroupSequenceNumberValue 92098 attribute has a cardinality of 0 . . . 1 92100 meaning that for each instance of the Cycle 92086 entity there may be one GroupSequenceNumberValue 92098 attribute.
The GroupSequenceRepetitionNumberValue 92102 attribute has a cardinality of 0 . . . 1 92104 meaning that for each instance of the Cycle 92086 entity there may be one GroupSequenceRepetitionNumberValue 92102 attribute. The Quantity 92106 attribute has a cardinality of 0 . . . 1 92108 meaning that for each instance of the Cycle 92086 entity there may be one Quantity 92106 attribute. The StartOffsetQuantity 92110 attribute has a cardinality of 0 . . . 1 92112 meaning that for each instance of the Cycle 92086 entity there may be one StartOffsetQuantity 92110 attribute. The MeasuringDeviceID 92114 attribute has a cardinality of 0 . . . 1 92116 meaning that for each instance of the Cycle 92086 entity there may be one MeasuringDeviceID 92114 attribute. The Description 92118 attribute has a cardinality of 0 . . . 1 92120 meaning that for each instance of the Cycle 92086 entity there may be one Description 92118 attribute.
The Item 92122 entity has a cardinality of 0 . . . n 92124 meaning that for each instance of the MaintenancePlan 92006 entity there may be one or more Item 92122 entities. The Item 92122 entity includes various attributes, namely a @actionCode 92126, an ID 92130, a CycleGroupSequenceNumberValue 92134, a BusinessTransactionDocumentProcessingTypeCode 92138, a BusinessTransactionDocumentReference 92142, a WorkCentreID 92146, a WorkCentrePlantID 92150, a MaintenancePlanningPlantID 92154, a MaintenancePlannerGroupCode 92158, an ImportanceCode 92162, a MaintenanceTaskListID 92166, a BusinessTransactionDocumentGroupID 92170, a BusinessObjectTypeCode 92174, a Description 92178 and a TextCollection 92182. The Item 92122 entity includes an ObjectReference 92186 subordinate entity.
The @actionCode 92126 attribute has a cardinality of 1 92128 meaning that for each instance of the Item 92122 entity there is one @actionCode 92126 attribute. The ID 92130 attribute has a cardinality of 0 . . . 1 92132 meaning that for each instance of the Item 92122 entity there may be one ID 92130 attribute. The CycleGroupSequenceNumberValue 92134 attribute has a cardinality of 0 . . . 1 92136 meaning that for each instance of the Item 92122 entity there may be one CycleGroupSequenceNumberValue 92134 attribute. The BusinessTransactionDocumentProcessingTypeCode 92138 attribute has a cardinality of 0 . . . 1 92140 meaning that for each instance of the Item 92122 entity there may be one BusinessTransactionDocumentProcessingTypeCode 92138 attribute. The BusinessTransactionDocumentReference 92142 attribute has a cardinality of 0 . . . 1 92144 meaning that for each instance of the Item 92122 entity there may be one BusinessTransactionDocumentReference 92142 attribute.
The WorkCentreID 92146 attribute has a cardinality of 0 . . . 1 92148 meaning that for each instance of the Item 92122 entity there may be one WorkCentreID 92146 attribute. The WorkCentrePlantID 92150 attribute has a cardinality of 0 . . . 1 92152 meaning that for each instance of the Item 92122 entity there may be one WorkCentrePlantID 92150 attribute. The MaintenancePlanningPlantID 92154 attribute has a cardinality of 0 . . . 1 92156 meaning that for each instance of the Item 92122 entity there may be one MaintenancePlanningPlantID 92154 attribute. The MaintenancePlannerGroupCode 92158 attribute has a cardinality of 0 . . . 1 92160 meaning that for each instance of the Item 92122 entity there may be one MaintenancePlannerGroupCode 92158 attribute. The ImportanceCode 92162 attribute has a cardinality of 0 . . . 1 92164 meaning that for each instance of the Item 92122 entity there may be one ImportanceCode 92162 attribute.
The MaintenanceTaskListID 92166 attribute has a cardinality of 0 . . . 1 92168 meaning that for each instance of the Item 92122 entity there may be one MaintenanceTaskListID 92166 attribute. The BusinessTransactionDocumentGroupID 92170 attribute has a cardinality of 0 . . . 1 92172 meaning that for each instance of the Item 92122 entity there may be one BusinessTransactionDocumentGroupID 92170 attribute. The BusinessObjectTypeCode 92174 attribute has a cardinality of 0 . . . 1 92176 meaning that for each instance of the Item 92122 entity there may be one BusinessObjectTypeCode 92174 attribute. The Description 92178 attribute has a cardinality of 0 . . . 1 92180 meaning that for each instance of the Item 92122 entity there may be one Description 92178 attribute. The TextCollection 92182 attribute has a cardinality of 0 . . . 1 92184 meaning that for each instance of the Item 92122 entity there may be one TextCollection 92182 attribute.
The ObjectReference 92186 entity has a cardinality of 0 . . . n 92188 meaning that for each instance of the Item 92122 entity there may be one or more ObjectReference 92186 entities. The ObjectReference 92186 entity includes various attributes, namely a @actionCode 92190, an OrdinalNumberValue 92194, a MainIndicator 92198, a SerialID 92202, a MaterialInternalID 92206, an IndividualMaterialID 92210 and an InstallationPointID 92214. The @actionCode 92190 attribute has a cardinality of 1 92192 meaning that for each instance of the ObjectReference 92186 entity there is one @actionCode 92190 attribute. The OrdinalNumberValue 92194 attribute has a cardinality of 0 . . . 1 92196 meaning that for each instance of the ObjectReference 92186 entity there may be one OrdinalNumberValue 92194 attribute. The MainIndicator 92198 attribute has a cardinality of 1 92200 meaning that for each instance of the ObjectReference 92186 entity there is one MainIndicator 92198 attribute. The SerialID 92202 attribute has a cardinality of 0 . . . 1 92204 meaning that for each instance of the ObjectReference 92186 entity there may be one SerialID 92202 attribute. The MaterialInternalID 92206 attribute has a cardinality of 0 . . . 1 92208 meaning that for each instance of the ObjectReference 92186 entity there may be one MaterialInternalID 92206 attribute. The IndividualMaterialID 92210 attribute has a cardinality of 0 . . . 1 92212 meaning that for each instance of the ObjectReference 92186 entity there may be one IndividualMaterialID 92210 attribute. The InstallationPointID 92214 attribute has a cardinality 0 . . . 1 92216 meaning that for each instance of the ObjectReference 92186 entity there may be one InstallationPointID 92214 attribute. The data types of the various packages, entities, and attributes are described with respect to
The Log 93004 package includes a Log 93006 entity. The Log 93006 entity has a cardinality of 1 93008 meaning that for each instance of the Log 93004 package there is one Log 93006 entity. The data types of the various packages, entities, and attributes are described with respect to
The Selection 94004 package includes a MaintenancePlanSelectionByID 94006 entity. The MaintenancePlanSelectionByID 94006 entity has a cardinality of 1 94008 meaning that for each instance of the Selection 94004 package there is one MaintenancePlanSelectionByID 94006 entity. The MaintenancePlanSelectionByID 94006 entity includes a MaintenancePlanID 94010 attribute. The MaintenancePlanID 94010 attribute has a cardinality of 1 94012 meaning that for each instance of the MaintenancePlanSelectionByID 94006 entity there is one MaintenancePlanID 94010 attribute. The data types of the various packages, entities, and attributes are described with respect to
The MaintenancePlan 95004 package includes a MaintenancePlan 95006 entity. The MaintenancePlan 95006 entity has a cardinality of 0 . . . 1 95008 meaning that for each instance of the MaintenancePlan 95004 package there may be one MaintenancePlan 95006 entity. The MaintenancePlan 95006 entity includes various attributes, namely an ID 95010, a ChangeStateID 95014, a CategoryCode 95018, a StatusObject 95022, a Description 95026 and a TextCollection 95030. The MaintenancePlan 95006 entity includes various subordinate entities, namely a SchedulingTerms 95034, a Cycle 95094 and an Item 95126. The ID 95010 attribute has a cardinality of 1 95012 meaning that for each instance of the MaintenancePlan 95006 entity there is one ID 95010 attribute.
The ChangeStateID 95014 attribute has a cardinality of 1 95016 meaning that for each instance of the MaintenancePlan 95006 entity there is one ChangeStateID 95014 attribute. The CategoryCode 95018 attribute has a cardinality of 1 95020 meaning that for each instance of the MaintenancePlan 95006 entity there is one CategoryCode 95018 attribute. The StatusObject 95022 attribute has a cardinality of 0 . . . 1 95024 meaning that for each instance of the MaintenancePlan 95006 entity there may be one StatusObject 95022 attribute. The Description 95026 attribute has a cardinality of 0 . . . 1 95028 meaning that for each instance of the MaintenancePlan 95006 entity there may be one Description 95026 attribute. The TextCollection 95030 attribute has a cardinality of 0 . . . 1 95032 meaning that for each instance of the MaintenancePlan 95006 entity there may be one TextCollection 95030 attribute.
The SchedulingTerms 95034 entity has a cardinality of 0 . . . 1 95036 meaning that for each instance of the MaintenancePlan 95006 entity there may be one SchedulingTerms 95034 entity. The SchedulingTerms 95034 entity includes various attributes, namely a StartDateTime 95038, a MeasuringDeviceStartMeasurementReadingMeasure 95042, a LateCompletionShiftPercent 95046, an EarlyCompletionShiftPercent 95050, a LateCompletionTolerencePercent 95054, a WorkingDayCalendarCode 95058, an EarlyCompletionTolerencePercent 95062, a MaintenancePlanCycleQuantityModificationFactorValue 95066, a BufferStartDaysNumberValue 95070, a CallHorizonPercent 95074, a PredecessorCompletionRequiredIndicator 95078, a SchedulingDuration 95082, a SchedulingCategoryCode 95086 and a CycleDependencyIndicator 95090. The StartDateTime 95038 attribute has a cardinality of 0 . . . 1 95040 meaning that for each instance of the SchedulingTerms 95034 entity there may be one StartDateTime 95038 attribute.
The MeasuringDeviceStartMeasurementReadingMeasure 95042 attribute has a cardinality of 0 . . . 1 95044 meaning that for each instance of the SchedulingTerms 95034 entity there may be one MeasuringDeviceStartMeasurementReadingMeasure 95042 attribute. The LateCompletionShiftPercent 95046 attribute has a cardinality of 0 . . . 1 95048 meaning that for each instance of the SchedulingTerms 95034 entity there may be one LateCompletionShiftPercent 95046 attribute. The EarlyCompletionShiftPercent 95050 attribute has a cardinality of 0 . . . 1 95052 meaning that for each instance of the SchedulingTerms 95034 entity there may be one EarlyCompletionShiftPercent 95050 attribute. The LateCompletionTolerencePercent 95054 attribute has a cardinality of 0 . . . 1 95056 meaning that for each instance of the SchedulingTerms 95034 entity there may be one LateCompletionTolerencePercent 95054 attribute.
The WorkingDayCalendarCode 95058 attribute has a cardinality of 0 . . . 1 95060 meaning that for each instance of the SchedulingTerms 95034 entity there may be one WorkingDayCalendarCode 95058 attribute. The EarlyCompletionTolerencePercent 95062 attribute has a cardinality of 0 . . . 1 95064 meaning that for each instance of the SchedulingTerms 95034 entity there may be one EarlyCompletionTolerencePercent 95062 attribute. The MaintenancePlanCycleQuantityModificationFactorValue 95066 attribute has a cardinality of 0 . . . 1 95068 meaning that for each instance of the SchedulingTerms 95034 entity there may be one MaintenancePlanCycleQuantityModificationFactorValue 95066 attribute. The BufferStartDaysNumberValue 95070 attribute has a cardinality of 0 . . . 1 95072 meaning that for each instance of the SchedulingTerms 95034 entity there may be one BufferStartDaysNumberValue 95070 attribute.
The CallHorizonPercent 95074 attribute has a cardinality of 0 . . . 1 95076 meaning that for each instance of the SchedulingTerms 95034 entity there may be one CallHorizonPercent 95074 attribute. The PredecessorCompletionRequiredIndicator 95078 attribute has a cardinality of 0 . . . 1 95080 meaning that for each instance of the SchedulingTerms 95034 entity there may be one PredecessorCompletionRequiredIndicator 95078 attribute. The SchedulingDuration 95082 attribute has a cardinality of 0 . . . 1 95084 meaning that for each instance of the SchedulingTerms 95034 entity there may be one SchedulingDuration 95082 attribute. The SchedulingCategoryCode 95086 attribute has a cardinality of 0 . . . 1 95088 meaning that for each instance of the SchedulingTerms 95034 entity there may be one SchedulingCategoryCode 95086 attribute. The CycleDependencyIndicator 95090 attribute has a cardinality of 0 . . . 1 95092 meaning that for each instance of the SchedulingTerms 95034 entity there may be one CycleDependencyIndicator 95090 attribute.
The Cycle 95094 entity includes various attributes, namely a CounterValue 95098, a GroupSequenceNumberValue 95102, a GroupSequenceRepetitionNumberValue 95106, a Quantity 95110, a StartOffsetQuantity 95114, a MeasuringDeviceID 95118 and a Description 95122. The CounterValue 95098 attribute has a cardinality of 1 95100 meaning that for each instance of the Cycle 95094 entity there is one CounterValue 95098 attribute. The GroupSequenceNumberValue 95102 attribute has a cardinality of 0 . . . 1 95104 meaning that for each instance of the Cycle 95094 entity there may be one GroupSequenceNumberValue 95102 attribute.
The GroupSequenceRepetitionNumberValue 95106 attribute has a cardinality of 0 . . . 1 95108 meaning that for each instance of the Cycle 95094 entity there may be one GroupSequenceRepetitionNumberValue 95106 attribute. The Quantity 95110 attribute has a cardinality of 1 95112 meaning that for each instance of the Cycle 95094 entity there is one Quantity 95110 attribute. The StartOffsetQuantity 95114 attribute has a cardinality of 0 . . . 1 95116 meaning that for each instance of the Cycle 95094 entity there may be one StartOffsetQuantity 95114 attribute. The MeasuringDeviceID 95118 attribute has a cardinality of 0 . . . 1 95120 meaning that for each instance of the Cycle 95094 entity there may be one MeasuringDeviceID 95118 attribute. The Description 95122 attribute has a cardinality of 0 . . . 1 95124 meaning that for each instance of the Cycle 95094 entity there may be one Description 95122 attribute.
The Item 95126 entity has a cardinality of 1 . . . n 95128 meaning that for each instance of the MaintenancePlan 95006 entity there are one or more Item 95126 entities. The Item 95126 entity includes various attributes, namely an OrdinalNumberValue 95130, an ID 95134, a CycleGroupSequenceNumberValue 95138, a BusinessTransactionDocumentProcessingTypeCode 95142, a BusinessTransactionDocumentReference 95146, a WorkCentreID 95150, a WorkCentrePlantID 95154, a MaintenancePlanningPlantID 95158, a MaintenancePlannerGroupCode 95162, an ImportanceCode 95166, a MaintenanceTaskListID 95170, a BusinessTransactionDocumentGroupID 95174, a BusinessObjectTypeCode 95178, a WorkCentreDescription 95182, a MaintenancePlantDescription 95186, a StatusObject 95190, a Description 95194 and a TextCollection 95198. The Item 95126 entity includes various subordinate entities, namely an ObjectReference 95202 and a ScheduleLine 95242.
The OrdinalNumberValue 95130 attribute has a cardinality of 1 95132 meaning that for each instance of the Item 95126 entity there is one OrdinalNumberValue 95130 attribute. The ID 95134 attribute has a cardinality of 1 95136 meaning that for each instance of the Item 95126 entity there is one ID 95134 attribute. The CycleGroupSequenceNumberValue 95138 attribute has a cardinality of 0 . . . 1 95140 meaning that for each instance of the Item 95126 entity there may be one CycleGroupSequenceNumberValue 95138 attribute. The BusinessTransactionDocumentProcessingTypeCode 95142 attribute has a cardinality of 1 95144 meaning that for each instance of the Item 95126 entity there is one BusinessTransactionDocumentProcessingTypeCode 95142 attribute.
The BusinessTransactionDocumentReference 95146 attribute has a cardinality of 0 . . . 1 95148 meaning that for each instance of the Item 95126 entity there may be one BusinessTransactionDocumentReference 95146 attribute. The WorkCentreID 95150 attribute has a cardinality of 1 95152 meaning that for each instance of the Item 95126 entity there is one WorkCentreID 95150 attribute. The WorkCentrePlantID 95154 attribute has a cardinality of 0 . . . 1 95156 meaning that for each instance of the Item 95126 entity there may be one WorkCentrePlantID 95154 attribute. The MaintenancePlanningPlantID 95158 attribute has a cardinality of 1 95160 meaning that for each instance of the Item 95126 entity there is one MaintenancePlanningPlantID 95158 attribute. The MaintenancePlannerGroupCode 95162 attribute has a cardinality of 0 . . . 1 95164 meaning that for each instance of the Item 95126 entity there may be one MaintenancePlannerGroupCode 95162 attribute. The ImportanceCode 95166 attribute has a cardinality of 0 . . . 1 95168 meaning that for each instance of the Item 95126 entity there may be one ImportanceCode 95166 attribute.
The MaintenanceTaskListID 95170 attribute has a cardinality of 0 . . . 1 95172 meaning that for each instance of the Item 95126 entity there may be one MaintenanceTaskListID 95170 attribute. The BusinessTransactionDocumentGroupID 95174 attribute has a cardinality of 0 . . . 1 95176 meaning that for each instance of the Item 95126 entity there may be one BusinessTransactionDocumentGroupID 95174 attribute. The BusinessObjectTypeCode 95178 attribute has a cardinality of 0 . . . 1 95180 meaning that for each instance of the Item 95126 entity there may be one BusinessObjectTypeCode 95178 attribute. The WorkCentreDescription 95182 attribute has a cardinality of 0 . . . 1 95184 meaning that for each instance of the Item 95126 entity there may be one WorkCentreDescription 95182 attribute.
The MaintenancePlantDescription 95186 attribute has a cardinality of 0 . . . 1 95188 meaning that for each instance of the Item 95126 entity there may be one MaintenancePlantDescription 95186 attribute. The StatusObject 95190 attribute has a cardinality of 0 . . . 1 95192 meaning that for each instance of the Item 95126 entity there may be one StatusObject 95190 attribute. The Description 95194 attribute has a cardinality of 0 . . . 1 95196 meaning that for each instance of the Item 95126 entity there may be one Description 95194 attribute. The TextCollection 95198 attribute has a cardinality of 0 . . . 1 95200 meaning that for each instance of the Item 95126 entity there may be one TextCollection 95198 attribute.
The ObjectReference 95202 entity has a cardinality of 1 . . . n 95204 meaning that for each instance of the Item 95126 entity there are one or more ObjectReference 95202 entities. The ObjectReference 95202 entity includes various attributes, namely an OrdinalNumberValue 95206, a MainIndicator 95210, a SerialID 95214, a MaterialInternalID 95218, an IndividualMaterialID 95222, an InstallationPointID 95226, a MaterialDescription 95230, an IndividualMaterialDescription 95234 and an InstallationPointDescription 95238. The OrdinalNumberValue 95206 attribute has a cardinality of 1 95208 meaning that for each instance of the ObjectReference 95202 entity there is one OrdinalNumberValue 95206 attribute. The MainIndicator 95210 attribute has a cardinality of 1 95212 meaning that for each instance of the ObjectReference 95202 entity there is one MainIndicator 95210 attribute. The SerialID 95214 attribute has a cardinality of 0 . . . 1 95216 meaning that for each instance of the ObjectReference 95202 entity there may be one SerialID 95214 attribute.
The MaterialInternalID 95218 attribute has a cardinality of 0 . . . 1 95220 meaning that for each instance of the ObjectReference 95202 entity there may be one MaterialInternalID 95218 attribute. The IndividualMaterialID 95222 attribute has a cardinality of 0 . . . 1 95224 meaning that for each instance of the ObjectReference 95202 entity there may be one IndividualMaterialID 95222 attribute. The InstallationPointID 95226 attribute has a cardinality of 0 . . . 1 95228 meaning that for each instance of the ObjectReference 95202 entity there may be one InstallationPointID 95226 attribute. The MaterialDescription 95230 attribute has a cardinality of 0 . . . 1 95232 meaning that for each instance of the ObjectReference 95202 entity there may be one MaterialDescription 95230 attribute. The IndividualMaterialDescription 95234 attribute has a cardinality of 0 . . . 1 95236 meaning that for each instance of the ObjectReference 95202 entity there may be one IndividualMaterialDescription 95234 attribute. The InstallationPointDescription 95238 attribute has a cardinality of 0 . . . 1 95240 meaning that for each instance of the ObjectReference 95202 entity there may be one InstallationPointDescription 95238 attribute.
The ScheduleLine 95242 entity has a cardinality of 0 . . . n 95244 meaning that for each instance of the Item 95126 entity there may be one or more ScheduleLine 95242 entities. The ScheduleLine 95242 entity includes various attributes, namely an OrdinalNumberValue 95246, a PlannedDateTime 95250, an InitiatedDateTime 95254 and a CompletionDateTime 95258. The OrdinalNumberValue 95246 attribute has a cardinality of 1 95248 meaning that for each instance of the ScheduleLine 95242 entity there is one OrdinalNumberValue 95246 attribute. The PlannedDateTime 95250 attribute has a cardinality of 1 95252 meaning that for each instance of the ScheduleLine 95242 entity there is one PlannedDateTime 95250 attribute. The InitiatedDateTime 95254 attribute has a cardinality of 0 . . . 1 95256 meaning that for each instance of the ScheduleLine 95242 entity there may be one InitiatedDateTime 95254 attribute. The CompletionDateTime 95258 attribute has a cardinality of 0 . . . 1 95260 meaning that for each instance of the ScheduleLine 95242 entity there may be one CompletionDateTime 95258 attribute.
The Log 95262 package includes a Log 95264 entity. The Log 95264 entity has a cardinality of 1 95266 meaning that for each instance of the Log 95262 package there is one Log 95264 entity. The data types of the various packages, entities, and attributes are described with respect to
The Selection 96004 package includes a MaintenancePlanScheduleLineSelectionByID 96006 entity. The MaintenancePlanScheduleLineSelectionByID 96006 entity has a cardinality of 1 96008 meaning that for each instance of the Selection 96004 package there is one MaintenancePlanScheduleLineSelectionByID 96006 entity. The MaintenancePlanScheduleLineSelectionByID 96006 entity includes a MaintenancePlanID 96010 attribute. The MaintenancePlanID 96010 attribute has a cardinality of 1 96012 meaning that for each instance of the MaintenancePlanScheduleLineSelectionByID 96006 entity there is one MaintenancePlanID 96010 attribute. The data types of the various packages, entities, and attributes are described with respect to
The MessageHeader 97004 package includes a MessageHeader 97006 entity. The MessageHeader 97006 entity has a cardinality of 0 . . . 1 97008 meaning that for each instance of the MessageHeader 97004 package there may be one MessageHeader 97006 entity.
The MaintenancePlan 97010 package includes a MaintenancePlan 97012 entity. The MaintenancePlan 97012 entity has a cardinality of 0 . . . 1 97014 meaning that for each instance of the MaintenancePlan 97010 package there may be one MaintenancePlan 97012 entity. The MaintenancePlan 97012 entity includes an ID 97016 attribute. The MaintenancePlan 97012 entity includes an Item 97020 subordinate entity. The ID 97016 attribute has a cardinality of 1 97018 meaning that for each instance of the MaintenancePlan 97012 entity there is one ID 97016 attribute.
The Item 97020 entity has a cardinality of 0 . . . n 97022 meaning that for each instance of the MaintenancePlan 97012 entity there may be one or more Item 97020 entities. The Item 97020 entity includes an ID 97024 attribute. The Item 97020 entity includes a ScheduleLine 97028 subordinate entity. The ID 97024 attribute has a cardinality of 1 97026 meaning that for each instance of the Item 97020 entity there is one ID 97024 attribute.
The ScheduleLine 97028 entity has a cardinality of 0 . . . n 97030 meaning that for each instance of the Item 97020 entity there may be one or more ScheduleLine 97028 entities. The ScheduleLine 97028 entity includes various attributes, namely an OrdinalNumberValue 97032, a PlannedDateTime 97036, an InitiatedDateTime 97040 and a CompletionDateTime 97044. The OrdinalNumberValue 97032 attribute has a cardinality of 0 . . . 1 97034 meaning that for each instance of the ScheduleLine 97028 entity there may be one OrdinalNumberValue 97032 attribute. The PlannedDateTime 97036 attribute has a cardinality of 0 . . . 1 97038 meaning that for each instance of the ScheduleLine 97028 entity there may be one PlannedDateTime 97036 attribute. The InitiatedDateTime 97040 attribute has a cardinality of 0 . . . 1 97042 meaning that for each instance of the ScheduleLine 97028 entity there may be one InitiatedDateTime 97040 attribute. The CompletionDateTime 97044 attribute has a cardinality of 0 . . . 1 97046 meaning that for each instance of the ScheduleLine 97028 entity there may be one CompletionDateTime 97044 attribute.
The Log 97048 package includes a Log 97050 entity. The Log 97050 entity has a cardinality of 1 97052 meaning that for each instance of the Log 97048 package there is one Log 97050 entity. The data types of the various packages, entities, and attributes are described with respect to
Maintenance Task List can be a list of maintenance tasks which may be performed repeatedly for maintaining a product. Task lists can be used to standardize recurring work sequences and to plan them more effectively. Many manufacturers can deliver task lists along with their products for the maintenance of those products.
The MaintenanceTaskList interface can perform various operations, namely a MaintenanceTaskListERPSimpleByElementsQueryResponse_In, a ParentMaintenanceTaskListERPSimpleByMaintenanceTaskListQueryResponse_In, a SubordinateMaintenanceTaskListERPSimpleByMaintenanceTaskListQueryResponse_In, a TopLevelMaintenanceTaskListERPSimpleByMaintenanceTaskListQueryResponse_In, a MaintenanceTaskListERPByIDAndGroupIDAndTypeCodeQueryResponse_In, and a MaintenanceTaskListERPSimulateMaintenanceOrderCalculationRequestConfirmation_In. The MaintenanceTaskListERPSimpleByElementsQueryResponse_In operation can handle an inquiry to and response from Maintenance Planning to list Maintenance Task Lists according to a given selection criteria.
Maintenance Planner can use a ‘Find Maintenance Task List By Elements’ inbound operation to get a list of Maintenance Task Lists based on a given selection criteria. The MaintenanceTaskListERPSimpleByElementsQueryResponse_In operation includes various message types, namely a MaintenanceTaskListERPSimpleByElementsQuery_sync and a MaintenanceTaskListERPSimpleByElementsResponse_sync. The structure of the MaintenanceTaskListERPSimpleByElementsQuery_sync message type can be specified by a MaintTskListERPSimplElmntsQryMsg_s message data type. The structure of the MaintenanceTaskListERPSimpleByElementsResponse_sync message type can be specified by a MaintTskListERPSimplElmntsRspMsg_s message data type.
The ParentMaintenanceTaskListERPSimpleByMaintenanceTaskListQueryResponse_In operation can handle an inquiry to and response from Maintenance Planning to list Parent Maintenance Task Lists for a given Maintenance Task List and level. Maintenance Planner can use a ‘Find Parent Maintenance Task List By Maintenance Task List’ inbound operation to find Parent Maintenance Task Lists for a given Maintenance Task List and a given level. The upper hierarchy can be returned until a specified level is reached. The ParentMaintenanceTaskListERPSimpleByMaintenanceTaskListQueryResponse_In operation includes various message types, namely a ParentMaintenanceTaskListERPSimpleByMaintenanceTaskListQuery_sync and a ParentMaintenanceTaskListERPSimpleByMaintenanceTaskListResponse_sync. The structure of the ParentMaintenanceTaskListERPSimpleByMaintenanceTaskListQuery_sync message type can be specified by a ParMaintTskListERPSimplMaintTskListRspMsg_s message data type. The structure of the ParentMaintenanceTaskListERPSimpleByMaintenanceTaskListResponse_sync message type can be specified by a ParMaintTskListERPSimplMaintTskListRspMsg_s message data type.
The SubordinateMaintenanceTaskListERPSimpleByMaintenanceTaskListQueryResponse_In operation can handle an inquiry to and response from Maintenance Planning to list Subordinate Maintenance Task Lists according to a specified Maintenance Task List. Maintenance Planner can use a ‘Find Subordinate Maintenance Task List By Maintenance Task List’ inbound operation to find Subordinate Maintenance Task Lists for a given Maintenance Task List and a given level. A lower hierarchy can be returned until a specified level is reached. The SubordinateMaintenanceTaskListERPSimpleByMaintenanceTaskListQueryResponse_In operation includes various message types, namely a SubordinateMaintenanceTaskListERPSimpleByMaintenanceTaskListQuery_sync and a SubordinateMaintenanceTaskListERPSimpleByMaintenanceTaskListResponse_sync. The structure of the SubordinateMaintenanceTaskListERPSimpleByMaintenanceTaskListQuery_sync message type can be specified by a SubordMaintTskListERPSimplMaintTskListQryMsg_s message data type. The structure of the SubordinateMaintenanceTaskListERPSimpleByMaintenanceTaskListResponse_sync message type can be specified by a SubordMaintTskListERPSimplMaintTskListRspMsg_s message data type.
The TopLevelMaintenanceTaskListERPSimpleByMaintenanceTaskListQueryResponse_In operation can handle an inquiry to and response from Maintenance Planning to find the Top Level Maintenance Task List in the given Maintenance Task List hierarchy. Maintenance Planner can use a ‘Find Top Level Maintenance Task List By Maintenance Task List’ inbound operation to find a Top Level Maintenance Task List in a given Maintenance Task List hierarchy. The TopLevelMaintenanceTaskListERPSimpleByMaintenanceTaskListQueryResponse_In operation includes various message types, namely a TopLevelMaintenanceTaskListERPSimpleByMaintenanceTaskListQuery_sync and a TopLevelMaintenanceTaskListERPSimpleByMaintenanceTaskListResponse_sync. The structure of the TopLevelMaintenanceTaskListERPSimpleByMaintenanceTaskListQuery_sync message type can be specified by a TopLvlMaintTskListERPSimplMaintTskListQryMsg_s message data type. The structure of the TopLevelMaintenanceTaskListERPSimpleByMaintenanceTaskListResponse_sync message type can be specified by a TopLvlMaintTskListERPSimplMaintTskListRspMsg_s message data type.
The MaintenanceTaskListERPByIDAndGroupIDAndTypeCodeQueryResponse_In operation can handle an inquiry to and response from Maintenance Planning to read a Maintenance Task List. Maintenance Planner can use a ‘Read Maintenance Task List’ inbound operation to read a Maintenance Task List. The MaintenanceTaskListERPByIDAndGroupIDAndTypeCodeQueryResponse_In operation includes various message types, namely a MaintenanceTaskListERPByIDAndGroupIDAndTypeCodeQuery_sync and a MaintenanceTaskListERPByIDAndGroupIDAndTypeCodeResponse_sync. The structure of the MaintenanceTaskListERPByIDAndGroupIDAndTypeCodeQuery_sync message type can be specified by a MaintTskListERPByIDAndGrpIDAndTypeCodeQryMsg_s message data type. The structure of the MaintenanceTaskListERPByIDAndGroupIDAndTypeCodeResponse_sync message type can be specified by a MaintTskListERPByIDAndGrpIDAndTypeCodeRspMsg_s message data type.
The MaintenanceTaskListERPSimulateMaintenanceOrderCalculationRequestConfirmation_In operation can request to and confirm from Maintenance Planning to simulate Maintenance Order calculation. The Maintenance Planner can use a ‘Simulate Task List Maintenance Order Calculation’ inbound operation to simulate a Maintenance Order calculation. The MaintenanceTaskListERPSimulateMaintenanceOrderCalculationRequestConfirmation_In operation includes various message types, namely a MaintenanceTaskListERPSimulateMaintenanceOrderCalculationRequest_sync and a MaintenanceTaskListERPSimulateMaintenanceOrderCalculationConfirmation_sync. The structure of the MaintenanceTaskListERPSimulateMaintenanceOrderCalculationRequest_sync message type can be specified by a MaintenanceTaskListERPSimulateMaintenanceOrderCalculationRequestMessage_sync message data type. The structure of the MaintenanceTaskListERPSimulateMaintenanceOrderCalculationConfirmation_sync message type can be specified by a MaintenanceTaskListERPSimulateMaintenanceOrderCalculationConfirmationMessage_sync message data type.
The message choreography of
The “Maintenance Planner” system 98000 can query the “Maintenance Planning” system 98002 to list parent maintenance task lists for a given maintenance task list and level, using a ParentMaintenanceTaskListERPSimpleByMaintenanceTaskListQuery_sync message 98008 as shown, for example in
The “Maintenance Planner” system 98000 can query the “Maintenance Planning” system 98002 to list subordinate maintenance task lists for a given maintenance task list, using a SubordinateMaintenanceTaskListERPSimpleByMaintenanceTaskListQuery_sync message 98012 as shown, for example in
The “Maintenance Planner” system 98000 can query the “Maintenance Planning” system 98002 to find the top level maintenance task list for a given maintenance task list hierarchy, using a TopLevelMaintenanceTaskListERPSimpleByMaintenanceTaskListQuery_sync message 98016 as shown, for example in
The “Maintenance Planner” system 98000 can query the “Maintenance Planning” system 98002 to read a maintenance task list, using a MaintenanceTaskListERPByIDQuery_sync message 98020 as shown, for example in
Additionally,
Additionally,
Additionally,
Additionally,
Additionally,
Additionally,
Additionally,
Additionally,
Additionally,
The MessageHeader 109006 package can be a BasicBusinessDocumentMessageHeader 109010 data type. The MessageHeader 109006 package includes a MessageHeader 109008 entity. The MaintenanceTaskList 109012 package includes a MaintenanceTaskList 109014 entity. The MaintenanceTaskList 109012 package includes various packages, namely an Operation 109076 and a ProcessingConditions 109156. The MaintenanceTaskList 109014 entity includes various attributes, namely an ID 109016, a GroupID 109020, a MaintenancePlanningPlantID 109024, a MaintenanceWorkCentreID 109028, a MaintenanceWorkCentrePlantID 109032, a MaterialInternalID 109036, an InstallationPointID 109040, an IndividualMaterialID 109044, a TypeCode 109048, a MaintenancePlannerGroupCode 109052, a ProcessingStatusCode 109056, an InstallationPointDescription 109060, an IndividualMaterialDescription 109064, a MaterialDescription 109068 and a Description 109072.
The ID 109016 attribute can be a MaintenanceTaskListID 109018 data type. The MaintenanceTaskListID can be an identifier for a maintenance task list in a MaintenanceTaskList Group. The GroupID 109020 attribute can be a BusinessTransactionDocumentGroupID 109022 data type. The BusinessTransactionDocumentGroupID can be an identifier for a TaskListGroup. The MaintenancePlanningPlantID 109024 attribute can be a PlantID 109026 data type. The MaintenancePlanningPlantID can be an identifier of a plant in which planning and supervision of the execution of maintenance work is done. The MaintenanceWorkCentreID 109028 attribute can be a WorkCentreID 109030 data type.
The MaintenanceWorkCentreID can be an identifier of a work centre where the execution of maintenance work is done. The MaintenanceWorkCentrePlantID 109032 attribute can be a PlantID 109034 data type. The MaintenanceWorkCentrePlantID can be an identifier of a plant where a work centre which is responsible for the execution of maintenance work is present. The MaterialInternalID 109036 attribute can be a ProductInternalID 109038 data type. The MaterialInternalID can be a proprietary identifier for a material. The InstallationPointID 109040 attribute can be an InstallationPointID 109042 data type. The InstallationPointID can be a unique identifier for an installation point. The IndividualMaterialID 109044 attribute can be a ProductInternaID 109046 data type. The IndividualMaterialID can be a proprietary identifier for an individual material. The TypeCode 109048 attribute can be a BusinessObjectTypeCode 109050 data type. The BusinessObjectTypeCode can be a coded representation of the type of a maintenance task list. The MaintenancePlannerGroupCode 109052 attribute can be a MaintenancePlannerGroupCode 109054 data type.
The MaintenancePlannerGroupCode can be a coded representation of a MaintenancePlannerGroup. The ProcessingStatusCode 109056 attribute can be a MaintenanceTaskListLifeCycleStatusCode 109058 data type. The MaintenanceTaskListLifeCycleStatusCode can be used to indicate the processing status of a task list. The InstallationPointDescription 109060 attribute can be a SHORT_Description 109062 data type. The InstallationPointDescription can be a representation of properties of an InstallationPoint in natural language. The IndividualMaterialDescription 109064 attribute can be a SHORT_Description 109066 data type. The IndividualMaterialDescription can be a representation of properties of a IndividualMaterial in natural language. The MaterialDescription 109068 attribute can be a SHORT_Description 109070 data type. The MaterialDescription can be a representation of properties of a material in natural language. The Description 109072 attribute can be a SHORT_Description 109074 data type. The Description can be a representation of properties of a maintenance task list in natural language.
The Operation 109076 package includes an Operation 109078 entity. The Operation 109076 package includes various packages, namely an OperationRelationship 109112 and a MaterialInput 109140. The Operation 109078 entity includes various attributes, namely an ID 109080, an ActivityID 109084, a MaintenanceWorkCentreID 109088, a MaintenanceWorkCentrePlantID 109092, a ControlProfileCode 109096, a PlannedDurationQuantity 109100, a PlannedWorkQuantity 109104 and a Description 109108. The ID 109080 attribute can be an OperationID 109082 data type. The OperationID can be a unique identifier of an operation within a MaintenanceTaskList. The ActivityID 109084 attribute can be an OperationActivityID 109086 data type. The ActivityID can be a unique identifier of an activity in an operation. The MaintenanceWorkCentreID 109088 attribute can be a WorkCentreID 109090 data type. The MaintenanceWorkCentreID can be an identifier of a work centre where the execution of maintenance work is done.
The MaintenanceWorkCentrePlantID 109092 attribute can be a PlantID 109094 data type. The MaintenanceWorkCentrePlantID can be an identifier of a plant where a work centre which is responsible for the execution of maintenance work is present. The ControlProfileCode 109096 attribute can be an OperationControlProfileCode 109098 data type. The OperationControlProfileCode can be a coded representation of a ControlProfile of an operation, which can combine controlling elements of business transactions in an operation. The PlannedDurationQuantity 109100 attribute can be a Quantity 109102 data type. The PlannedDurationQuantity can be a non-monetary numerical specification of an amount in a unit of measurement. The PlannedWorkQuantity 109104 attribute can be a Quantity 109106 data type. The PlannedWorkQuantity can be a non-monetary numerical specification of an amount in a unit of measurement. The Description 109108 attribute can be a SHORT_Description 109110 data type. The Description can be a representation of properties of a maintenance task list in natural language.
The OperationRelationship 109112 package includes a Relationship 109114 entity. The Relationship 109114 entity includes various attributes, namely an OperationID 109116, a MaintenanceWorkCentreID 109120, a MaintenanceWorkCentrePlantID 109124, a NetworkPlanElementSuccessionTypeCode 109128, a LagDuration 109132 and a @actionCode 109136. The OperationID 109116 attribute can be an OperationID 109118 data type. The OperationID can be a unique identifier of an operation. The MaintenanceWorkCentreID 109120 attribute can be a WorkCentreID 109122 data type. The MaintenanceWorkCentreID can be an identifier of a work centre where the execution of maintenance work is done. The MaintenanceWorkCentrePlantID 109124 attribute can be a PlantID 109126 data type.
The MaintenanceWorkCentrePlantID can be an identifier of a plant where a work centre which is responsible for the execution of maintenance work is present. The NetworkPlanElementSuccessionTypeCode 109128 attribute can be a NetworkPlanElementSuccessionTypeCode 109130 data type. The MaintenanceTaskListOperationSuccessionTypeCode can be a coded representation of the type of a directed relationship between two successive operations in a maintenance task list. The LagDuration 109132 attribute can be a LagDuration 109134 data type. LagDuration can be a time span between a preceding and succeeding operation, which are linked by a relationship. The @actionCode 109136 attribute can be an ActionCode 109138 data type. The ActionCode can be a coded representation of an instruction to the recipient of a message describing how to process a transmitted element.
The MaterialInput 109140 package includes a MaterialInput 109142 entity. The MaterialInput 109142 entity includes various attributes, namely a MaterialInternalID 109144, a RequiredQuantity 109148 and a Description 109152. The MaterialInternalID 109144 attribute can be a ProductInternalID 109146 data type. The MaterialInternalID can be a proprietary identifier for a material. The RequiredQuantity 109148 attribute can be a Quantity 109150 data type. The Quantity can be a non-monetary numerical specification of an amount in a unit of measurement. The Description 109152 attribute can be a SHORT_Description 109154 data type. The Description can be a representation of properties of a maintenance task list in natural language.
The ProcessingConditions 109156 package includes a ProcessingConditions 109158 entity. The ProcessingConditions 109158 entity includes various attributes, namely a QueryHitsMaximumNumberValue 109160, an UnlimitedQueryHitsIndicator 109164, a ReturnedQueryHitsNumberValue 109168, a MoreElementsAvailableIndicator 109172 and a LastProvidedMaintenanceTaskListID 109176. The QueryHitsMaximumNumberValue 109160 attribute can be a NumberValue 109162 data type. The NumberValue can be a number used for cardinal numbers. The UnlimitedQueryHitsIndicator 109164 attribute can be an Indicator 109166 data type. The Indicator can be a representation of a situation that has exactly two mutually exclusive Boolean values.
The ReturnedQueryHitsNumberValue 109168 attribute can be a NumberValue 109170 data type. The NumberValue can be a number used for cardinal numbers. The MoreElementsAvailableIndicator 109172 attribute can be a MoreElementsAvailableIndicator 109174 data type. An Indicator can be a representation of a situation that has exactly two mutually exclusive Boolean values. The LastProvidedMaintenanceTaskListID 109176 attribute can be a MaintenanceTaskListID 109178 data type. The MaintenanceTaskListID can be an identifier for a maintenance task list in a MaintenanceTaskList Group.
The Log 109180 package can be a Log 109184 data type. The Log 109180 package includes a Log 109182 entity. The Log can be a sequence of messages that result when an application executes a task.
The Selection 110004 package includes a MaintenanceTaskListSimpleSelectionByElements 110006 entity. The MaintenanceTaskListSimpleSelectionByElements 110006 entity has a cardinality of 1 110008 meaning that for each instance of the Selection 110004 package there is one MaintenanceTaskListSimpleSelectionByElements 110006 entity. The MaintenanceTaskListSimpleSelectionByElements 110006 entity includes various attributes, namely a ProcessingStatusCode 110010, a MaintenanceTaskListID 110014, an InstallationPointID 110018, an IndividualMaterialID 110022, a MaintenanceTaskListGroupID 110026 and a MaintenanceTaskListTypeCode 110030.
The ProcessingStatusCode 110010 attribute has a cardinality of 0 . . . 1 110012 meaning that for each instance of the MaintenanceTaskListSimpleSelectionByElements 110006 entity there may be one ProcessingStatusCode 110010 attribute. The MaintenanceTaskListID 110014 attribute has a cardinality of 0 . . . 1 110016 meaning that for each instance of the MaintenanceTaskListSimpleSelectionByElements 110006 entity there may be one MaintenanceTaskListID 110014 attribute. The InstallationPointID 110018 attribute has a cardinality of 0 . . . 1 110020 meaning that for each instance of the MaintenanceTaskListSimpleSelectionByElements 110006 entity there may be one InstallationPointID 110018 attribute. The IndividualMaterialID 110022 attribute has a cardinality of 0 . . . 1 110024 meaning that for each instance of the MaintenanceTaskListSimpleSelectionByElements 110006 entity there may be one IndividualMaterialID 110022 attribute.
The MaintenanceTaskListGroupID 110026 attribute has a cardinality of 0 . . . 1 110028 meaning that for each instance of the MaintenanceTaskListSimpleSelectionByElements 110006 entity there may be one MaintenanceTaskListGroupID 110026 attribute. The MaintenanceTaskListTypeCode 110030 attribute has a cardinality of 0 . . . 1 110032 meaning that for each instance of the MaintenanceTaskListSimpleSelectionByElements 110006 entity there may be one MaintenanceTaskListTypeCode 110030 attribute.
The ProcessingConditions 110034 package includes a ProcessingConditions 110036 entity. The ProcessingConditions 110036 entity has a cardinality of 0 . . . 1 110038 meaning that for each instance of the ProcessingConditions 110034 package there may be one ProcessingConditions 110036 entity. The ProcessingConditions 110036 entity includes various attributes, namely a QueryHitsMaximumNumberValue 110040, an UnlimitedQueryHitsIndicator 110044 and a LastProvidedMaintenanceTaskListID 110048.
The QueryHitsMaximumNumberValue 110040 attribute has a cardinality of 0 . . . 1 110042 meaning that for each instance of the ProcessingConditions 110036 entity there may be one QueryHitsMaximumNumberValue 110040 attribute. The UnlimitedQueryHitsIndicator 110044 attribute has a cardinality of 0 . . . 1 110046 meaning that for each instance of the ProcessingConditions 110036 entity there may be one UnlimitedQueryHitsIndicator 110044 attribute. The LastProvidedMaintenanceTaskListID 110048 attribute has a cardinality of 0 . . . 1 110050 meaning that for each instance of the ProcessingConditions 110036 entity there may be one LastProvidedMaintenanceTaskListID 110048 attribute. The data types of the various packages, entities, and attributes are described with respect to
The MaintenanceTaskList 111004 package includes a MaintenanceTaskList 111006 entity. The MaintenanceTaskList 111006 entity has a cardinality of 0 . . . n 111008 meaning that for each instance of the MaintenanceTaskList 111004 package there may be one or more MaintenanceTaskList 111006 entities. The MaintenanceTaskList 111006 entity includes various attributes, namely an ID 111010, a GroupID 111014, a TypeCode 111018 and a Description 111022. The ID 111010 attribute has a cardinality of 1 11012 meaning that for each instance of the MaintenanceTaskList 111006 entity there is one ID 111010 attribute. The GroupID 111014 attribute has a cardinality of 1 11016 meaning that for each instance of the MaintenanceTaskList 111006 entity there is one GroupID 111014 attribute. The TypeCode 111018 attribute has a cardinality of 1 11020 meaning that for each instance of the MaintenanceTaskList 111006 entity there is one TypeCode 111018 attribute. The Description 111022 attribute has a cardinality of 0 . . . 1 111024 meaning that for each instance of the MaintenanceTaskList 111006 entity there may be one Description 111022 attribute.
The ProcessingConditions 111026 package includes a ProcessingConditions 111028 entity. The ProcessingConditions 111028 entity has a cardinality of 1 11030 meaning that for each instance of the ProcessingConditions 111026 package there is one ProcessingConditions 111028 entity. The ProcessingConditions 111028 entity includes various attributes, namely a ReturnedQueryHitsNumberValue 111032, a MoreElementsAvailableIndicator 111036 and a LastProvidedMaintenanceTaskListID 111040. The ReturnedQueryHitsNumberValue 111032 attribute has a cardinality of 1 111034 meaning that for each instance of the ProcessingConditions 111028 entity there is one ReturnedQueryHitsNumberValue 111032 attribute. The MoreElementsAvailableIndicator 111036 attribute has a cardinality of 1 11038 meaning that for each instance of the ProcessingConditions 111028 entity there is one MoreElementsAvailableIndicator 111036 attribute. The LastProvidedMaintenanceTaskListID 111040 attribute has a cardinality of 0 . . . 1 111042 meaning that for each instance of the ProcessingConditions 111028 entity there may be one LastProvidedMaintenanceTaskListID 111040 attribute.
The Log 111044 package includes a Log 111046 entity. The Log 111046 entity has a cardinality of 1 11048 meaning that for each instance of the Log 111044 package there is one Log 111046 entity. The data types of the various packages, entities, and attributes are described with respect to
The Selection 112004 package includes a ParMaintenanceTaskListSimpleSelectionByMaintenanceTaskList 112006 entity. The ParMaintenanceTaskListSimpleSelectionByMaintenanceTaskList 112006 entity has a cardinality of 1 12008 meaning that for each instance of the Selection 112004 package there is one ParMaintenanceTaskListSimpleSelectionByMaintenanceTaskList 112006 entity. The ParMaintenanceTaskListSimpleSelectionByMaintenanceTaskList 112006 entity includes various attributes, namely a MaintenanceTaskListID 112010, a MaintenanceTaskListGroupID 112014, a MaintenanceTaskListTypeCode 112018 and a LevelNumberValue 112022. The MaintenanceTaskListID 112010 attribute has a cardinality of 1112012 meaning that for each instance of the ParMaintenanceTaskListSimpleSelectionByMaintenanceTaskList 112006 entity there is one MaintenanceTaskListID 112010 attribute.
The MaintenanceTaskListGroupID 112014 attribute has a cardinality of 1 12016 meaning that for each instance of the ParMaintenanceTaskListSimpleSelectionByMaintenanceTaskList 112006 entity there is one MaintenanceTaskListGroupID 112014 attribute. The MaintenanceTaskListTypeCode 112018 attribute has a cardinality of 1 12020 meaning that for each instance of the ParMaintenanceTaskListSimpleSelectionByMaintenanceTaskList 112006 entity there is one MaintenanceTaskListTypeCode 112018 attribute. The LevelNumberValue 112022 attribute has a cardinality of 1 12024 meaning that for each instance of the ParMaintenanceTaskListSimpleSelectionByMaintenanceTaskList 112006 entity there is one LevelNumberValue 112022 attribute. The data types of the various packages, entities, and attributes are described with respect to
The MaintenanceTaskList 113004 package includes a MaintenanceTaskList 113006 entity. The MaintenanceTaskList 113006 entity has a cardinality of 0 . . . n 113008 meaning that for each instance of the MaintenanceTaskList 113004 package there may be one or more MaintenanceTaskList 113006 entities. The MaintenanceTaskList 113006 entity includes various attributes, namely an ID 113010, a GroupID 113014, a TypeCode 113018, a LevelNumberValue 113022 and a Description 113026. The ID 113010 attribute has a cardinality of 1 13012 meaning that for each instance of the MaintenanceTaskList 113006 entity there is one ID 113010 attribute.
The GroupID 113014 attribute has a cardinality of 1 13016 meaning that for each instance of the MaintenanceTaskList 113006 entity there is one GroupID 113014 attribute. The TypeCode 113018 attribute has a cardinality of 1 13020 meaning that for each instance of the MaintenanceTaskList 113006 entity there is one TypeCode 113018 attribute. The LevelNumberValue 113022 attribute has a cardinality of 1 13024 meaning that for each instance of the MaintenanceTaskList 113006 entity there is one LevelNumberValue 113022 attribute. The Description 113026 attribute has a cardinality of 0 . . . 1 113028 meaning that for each instance of the MaintenanceTaskList 113006 entity there may be one Description 113026 attribute.
The Log 113030 package includes a Log 113032 entity. The Log 113032 entity has a cardinality of 1 13034 meaning that for each instance of the Log 113030 package there is one Log 113032 entity. The data types of the various packages, entities, and attributes are described with respect to
The Selection 114004 package includes a SubordinateMaintenanceTaskListSimpleSelectionByMaintenanceTaskList 114006 entity. The SubordinateMaintenanceTaskListSimpleSelectionByMaintenanceTaskList 114006 entity has a cardinality of 1 14008 meaning that for each instance of the Selection 114004 package there is one SubordinateMaintenanceTaskListSimpleSelectionByMaintenanceTaskList 114006 entity. The SubordinateMaintenanceTaskListSimpleSelectionByMaintenanceTaskList 114006 entity includes various attributes, namely a MaintenanceTaskListID 114010, a MaintenanceTaskListGroupID 114014, a MaintenanceTaskListTypeCode 114018 and a LevelNumberValue 114022. The MaintenanceTaskListID 114010 attribute has a cardinality of 1114012 meaning that for each instance of the SubordinateMaintenanceTaskListSimpleSelectionByMaintenanceTaskList 114006 entity there is one MaintenanceTaskListID 114010 attribute.
The MaintenanceTaskListGroupID 114014 attribute has a cardinality of 1 14016 meaning that for each instance of the SubordinateMaintenanceTaskListSimpleSelectionByMaintenanceTaskList 114006 entity there is one MaintenanceTaskListGroupID 114014 attribute. The MaintenanceTaskListTypeCode 114018 attribute has a cardinality of 1 14020 meaning that for each instance of the SubordinateMaintenanceTaskListSimpleSelectionByMaintenanceTaskList 114006 entity there is one MaintenanceTaskListTypeCode 114018 attribute. The LevelNumberValue 114022 attribute has a cardinality of 1 14024 meaning that for each instance of the SubordinateMaintenanceTaskListSimpleSelectionByMaintenanceTaskList 114006 entity there is one LevelNumberValue 114022 attribute. The data types of the various packages, entities, and attributes are described with respect to
The MaintenanceTaskList 115004 package includes a MaintenanceTaskList 115006 entity. The MaintenanceTaskList 115006 entity has a cardinality of 0 . . . N 115008 meaning that for each instance of the MaintenanceTaskList 115004 package there may be one or more MaintenanceTaskList 115006 entities. The MaintenanceTaskList 115006 entity includes various attributes, namely an ID 115010, a GroupID 115014, a TypeCode 115018, a LevelNumberValue 115022 and a Description 115026. The ID 115010 attribute has a cardinality of 1 15012 meaning that for each instance of the MaintenanceTaskList 115006 entity there is one ID 115010 attribute.
The GroupID 115014 attribute has a cardinality of 1 15016 meaning that for each instance of the MaintenanceTaskList 115006 entity there is one GroupID 115014 attribute. The TypeCode 115018 attribute has a cardinality of 1 15020 meaning that for each instance of the MaintenanceTaskList 115006 entity there is one TypeCode 115018 attribute. The LevelNumberValue 115022 attribute has a cardinality of 1 15024 meaning that for each instance of the MaintenanceTaskList 115006 entity there is one LevelNumberValue 115022 attribute. The Description 115026 attribute has a cardinality of 0 . . . 1 115028 meaning that for each instance of the MaintenanceTaskList 115006 entity there may be one Description 115026 attribute.
The Log 115030 package includes a Log 115032 entity. The Log 115032 entity has a cardinality of 1 15034 meaning that for each instance of the Log 115030 package there is one Log 115032 entity. The data types of the various packages, entities, and attributes are described with respect to
The Selection 116004 package includes a TopLevelMaintenanceTaskListSimpleSelectionByMaintenanceTaskList 116006 entity. The TopLevelMaintenanceTaskListSimpleSelectionByMaintenanceTaskList 116006 entity has a cardinality of 1 16008 meaning that for each instance of the Selection 116004 package there is one TopLevelMaintenanceTaskListSimpleSelectionByMaintenanceTaskList 116006 entity. The TopLevelMaintenanceTaskListSimpleSelectionByMaintenanceTaskList 116006 entity includes various attributes, namely a MaintenanceTaskListID 116010, a MaintenanceTaskListGroupID 116014 and a MaintenanceTaskListTypeCode 116018. The MaintenanceTaskListID 116010 attribute has a cardinality of 1 16012 meaning that for each instance of the TopLevelMaintenanceTaskListSimpleSelectionByMaintenanceTaskList 116006 entity there is one MaintenanceTaskListID 116010 attribute.
The MaintenanceTaskListGroupID 116014 attribute has a cardinality of 1 16016 meaning that for each instance of the TopLevelMaintenanceTaskListSimpleSelectionByMaintenanceTaskList 116006 entity there is one MaintenanceTaskListGroupID 116014 attribute. The MaintenanceTaskListTypeCode 116018 attribute has a cardinality of 1 16020 meaning that for each instance of the TopLevelMaintenanceTaskListSimpleSelectionByMaintenanceTaskList 116006 entity there is one MaintenanceTaskListTypeCode 116018 attribute. The data types of the various packages, entities, and attributes are described with respect to
The MaintenanceTaskList 117004 package includes a MaintenanceTaskList 117006 entity. The MaintenanceTaskList 117006 entity has a cardinality of 0 . . . 1 1117008 meaning that for each instance of the MaintenanceTaskList 117004 package there may be one MaintenanceTaskList 117006 entity. The MaintenanceTaskList 117006 entity includes various attributes, namely an ID 117010, a GroupID 117014, a TypeCode 117018 and a Description 117022.
The ID 117010 attribute has a cardinality of 1 17012 meaning that for each instance of the MaintenanceTaskList 117006 entity there is one ID 117010 attribute. The GroupID 117014 attribute has a cardinality of 1 17016 meaning that for each instance of the MaintenanceTaskList 117006 entity there is one GroupID 117014 attribute. The TypeCode 117018 attribute has a cardinality of 1 17020 meaning that for each instance of the MaintenanceTaskList 117006 entity there is one TypeCode 117018 attribute. The Description 117022 attribute has a cardinality of 0 . . . 1 117024 meaning that for each instance of the MaintenanceTaskList 117006 entity there may be one Description 117022 attribute.
The Log 117026 package includes a Log 117028 entity. The Log 117028 entity has a cardinality of 1 17030 meaning that for each instance of the Log 117026 package there is one Log 117028 entity. The data types of the various packages, entities, and attributes are described with respect to
The Selection 118004 package includes a MaintenanceTaskListSelectionByIDAndGrpIDAndTypeCode 118006 entity. The MaintenanceTaskListSelectionByIDAndGrpIDAndTypeCode 118006 entity has a cardinality of 1118008 meaning that for each instance of the Selection 118004 package there is one MaintenanceTaskListSelectionByIDAndGrpIDAndTypeCode 118006 entity. The MaintenanceTaskListSelectionByIDAndGrpIDAndTypeCode 118006 entity includes various attributes, namely a MaintenanceTaskListID 118010, a MaintenanceTaskListGroupID 118014 and a MaintenanceTaskListTypeCode 118018.
The MaintenanceTaskListID 118010 attribute has a cardinality of 1 18012 meaning that for each instance of the MaintenanceTaskListSelectionByIDAndGrpIDAndTypeCode 118006 entity there is one MaintenanceTaskListID 118010 attribute. The MaintenanceTaskListGroupID 118014 attribute has a cardinality of 1 18016 meaning that for each instance of the MaintenanceTaskListSelectionByIDAndGrpIDAndTypeCode 118006 entity there is one MaintenanceTaskListGroupID 118014 attribute. The MaintenanceTaskListTypeCode 118018 attribute has a cardinality of 1 18020 meaning that for each instance of the MaintenanceTaskListSelectionByIDAndGrpIDAndTypeCode 118006 entity there is one MaintenanceTaskListTypeCode 118018 attribute. The data types of the various packages, entities, and attributes are described with respect to
The MaintenanceTaskList 119004 package includes a MaintenanceTaskList 119006 entity. The MaintenanceTaskList 119006 entity has a cardinality of 0 . . . 1 119008 meaning that for each instance of the MaintenanceTaskList 119004 package there may be one MaintenanceTaskList 119006 entity. The MaintenanceTaskList 119006 entity includes various attributes, namely an ID 119010, a GroupID 119014, a MaintenancePlanningPlantID 119018, a MaintenanceWorkCentreID 119022, a MaintenanceWorkCentrePlantID 119026, a MaterialInternalID 119030, an InstallationPointID 119034, an IndividualMaterialID 119038, a TypeCode 119042, a MaintenancePlannerGroupCode 119046, a ProcessingStatusCode 119050, an InstallationPointDescription 119054, an IndividualMaterialDescription 119058, a MaterialDescription 119062 and a Description 119066. The MaintenanceTaskList 119006 entity includes an Operation 119070 subordinate entity.
The ID 119010 attribute has a cardinality of 1 19012 meaning that for each instance of the MaintenanceTaskList 119006 entity there is one ID 119010 attribute. The GroupID 119014 attribute has a cardinality of 1 19016 meaning that for each instance of the MaintenanceTaskList 119006 entity there is one GroupID 119014 attribute. The MaintenancePlanningPlantID 119018 attribute has a cardinality of 1 119020 meaning that for each instance of the MaintenanceTaskList 119006 entity there is one MaintenancePlanningPlantID 119018 attribute. The MaintenanceWorkCentreID 119022 attribute has a cardinality 0 . . . 1 119024 meaning that for each instance of the MaintenanceTaskList 119006 entity there may be one MaintenanceWorkCentreID 119022 attribute. The MaintenanceWorkCentrePlantID 119026 attribute has a cardinality of 0 . . . 1 119028 meaning that for each instance of the MaintenanceTaskList 119006 entity there may be one MaintenanceWorkCentrePlantID 119026 attribute. The MaterialInternalID 119030 attribute has a cardinality of 0 . . . 1 119032 meaning that for each instance of the MaintenanceTaskList 119006 entity there may be one MaterialInternalID 119030 attribute.
The InstallationPointID 119034 attribute has a cardinality of 0 . . . 1 119036 meaning that for each instance of the MaintenanceTaskList 119006 entity there may be one InstallationPointID 119034 attribute. The IndividualMaterialID 119038 attribute has a cardinality of 0 . . . 1 119040 meaning that for each instance of the MaintenanceTaskList 119006 entity there may be one IndividualMaterialID 119038 attribute. The TypeCode 119042 attribute has a cardinality of 1 119044 meaning that for each instance of the MaintenanceTaskList 119006 entity there is one TypeCode 119042 attribute. The MaintenancePlannerGroupCode 119046 attribute has a cardinality of 0 . . . 1 119048 meaning that for each instance of the MaintenanceTaskList 119006 entity there may be one MaintenancePlannerGroupCode 119046 attribute. The ProcessingStatusCode 119050 attribute has a cardinality of 1 119052 meaning that for each instance of the MaintenanceTaskList 119006 entity there is one ProcessingStatusCode 119050 attribute. The InstallationPointDescription 119054 attribute has a cardinality of 0 . . . 1 119056 meaning that for each instance of the MaintenanceTaskList 119006 entity there may be one InstallationPointDescription 119054 attribute.
The IndividualMaterialDescription 119058 attribute has a cardinality of 0 . . . 1 119060 meaning that for each instance of the MaintenanceTaskList 119006 entity there may be one IndividualMaterialDescription 119058 attribute. The MaterialDescription 119062 attribute has a cardinality of 0 . . . 1 119064 meaning that for each instance of the MaintenanceTaskList 119006 entity there may be one MaterialDescription 119062 attribute. The Description 119066 attribute has a cardinality of 0 . . . 1 119068 meaning that for each instance of the MaintenanceTaskList 119006 entity there may be one Description 119066 attribute. The Operation 119070 entity has a cardinality of 0 . . . n 119072 meaning that for each instance of the MaintenanceTaskList 119006 entity there may be one or more Operation 119070 entities. The Operation 119070 entity includes various attributes, namely an ID 119074, an ActivityID 119078, a MaintenanceWorkCentreID 119082, a MaintenanceWorkCentrePlantID 119086, a ControlProfileCode 119090, a PlannedDurationQuantity 119094, a PlannedWorkQuantity 119098 and a Description 119102. The Operation 119070 entity includes various subordinate entities, namely a Relationship 119106 and a MaterialInput 119130.
The ID 119074 attribute has a cardinality of 1 119076 meaning that for each instance of the Operation 119070 entity there is one ID 119074 attribute. The ActivityID 119078 attribute has a cardinality of 0 . . . 1 119080 meaning that for each instance of the Operation 119070 entity there may be one ActivityID 119078 attribute. The MaintenanceWorkCentreID 119082 attribute has a cardinality of 1 119084 meaning that for each instance of the Operation 119070 entity there is one MaintenanceWorkCentreID 119082 attribute. The MaintenanceWorkCentrePlantID 119086 attribute has a cardinality of 1 119088 meaning that for each instance of the Operation 119070 entity there is one MaintenanceWorkCentrePlantID 119086 attribute. The ControlProfileCode 119090 attribute has a cardinality of 1 119092 meaning that for each instance of the Operation 119070 entity there is one ControlProfileCode 119090 attribute. The PlannedDurationQuantity 119094 attribute has a cardinality of 0 . . . 1 119096 meaning that for each instance of the Operation 119070 entity there may be one PlannedDurationQuantity 119094 attribute. The PlannedWorkQuantity 119098 attribute has a cardinality of 0 . . . 1 119100 meaning that for each instance of the Operation 119070 entity there may be one PlannedWorkQuantity 119098 attribute. The Description 119102 attribute has a cardinality of 0 . . . 1 119104 meaning that for each instance of the Operation 119070 entity there may be one Description 119102 attribute.
The Relationship 119106 entity has a cardinality of 0 . . . n 119108 meaning that for each instance of the Operation 119070 entity there may be one or more Relationship 119106 entities. The Relationship 119106 entity includes various attributes, namely an OperationID 119110, a MaintenanceWorkCentreID 119114, a MaintenanceWorkCentrePlantID 119118, a NetworkPlanElementSuccessionTypeCode 119122 and a LagDuration 119126. The OperationID 119110 attribute has a cardinality of 1 119112 meaning that for each instance of the Relationship 119106 entity there is one OperationID 119110 attribute. The MaintenanceWorkCentreID 119114 attribute has a cardinality of 0 . . . 1 119116 meaning that for each instance of the Relationship 119106 entity there may be one MaintenanceWorkCentreID 119114 attribute. The MaintenanceWorkCentrePlantID 119118 attribute has a cardinality of 0 . . . 1 119120 meaning that for each instance of the Relationship 119106 entity there may be one MaintenanceWorkCentrePlantID 119118 attribute.
The NetworkPlanElementSuccessionTypeCode 119122 attribute has a cardinality of 0 . . . 1 119124 meaning that for each instance of the Relationship 119106 entity there may be one NetworkPlanElementSuccessionTypeCode 119122 attribute. The LagDuration 119126 attribute has a cardinality of 0 . . . 1 119128 meaning that for each instance of the Relationship 119106 entity there may be one LagDuration 119126 attribute. The MaterialInput 119130 entity has a cardinality of 0 . . . n 119132 meaning that for each instance of the Operation 119070 entity there may be one or more MaterialInput 119130 entities. The MaterialInput 119130 entity includes various attributes, namely a MaterialInternalID 119134, a RequiredQuantity 119138 and a MaterialDescription 119142.
The MaterialInternalID 119134 attribute has a cardinality of 1 119136 meaning that for each instance of the MaterialInput 119130 entity there is one MaterialInternalID 119134 attribute. The RequiredQuantity 119138 attribute has a cardinality of 1 119140 meaning that for each instance of the MaterialInput 119130 entity there is one RequiredQuantity 119138 attribute. The MaterialDescription 119142 attribute has a cardinality of 0 . . . 1 119144 meaning that for each instance of the MaterialInput 119130 entity there may be one MaterialDescription 119142 attribute.
The Log 119146 package includes a Log 119148 entity. The Log 119148 entity has a cardinality of 1 119150 meaning that for each instance of the Log 119146 package there is one Log 119148 entity. The data types of the various packages, entities, and attributes are described with respect to
A RequestForSupplierFreightQuote can be part of a Transportation Management subcontracting and tendering process, where transportation services can be tendered between transportation service providers. The terms and conditions of a transportation service, as well as the bidding rules of the tendering process, can be specified in the RequestForSupplierFreightQuote. The response of a supplier of the transportation service to a customer is included in the SupplierFreightQuote. A customer, such as Transportation Supplier Quote Processing, can request a freight quote from a supplier, such as Transportation Customer Quote Processing, by using the interfaces supplied by RequestForSupplierFreightQuote.
A RequestForSupplierFreightQuoteRequest can be a request to a supplier to provide a SupplierFreightQuote. The structure of the RequestForSupplierFreightQuoteRequest can be specified by the message data type RequestForSupplierFreightQuoteRequestMessage.
A RequestForSupplierFreightQuoteCancelRequest can be a request to a supplier to cancel a RequestForSupplierFreightQuote. The structure of the RequestForSupplierFreightQuoteCancelRequest can be specified by the message data type RequestForSupplierFreightQuoteCancelRequestMessage.
The message interfaces on the customer side include RequestForSupplierFreightQuoteRequest_Out and RequestForSupplierFreightQuoteCancelRequest_Out. The message interfaces on the supplier side include RequestForSupplierFreightQuoteRequest_In and RequestForSupplierFreightQuoteCancelRequest_In.
The message choreography of
Additionally,
A MessageHeader package can group together business information relevant for sending a business document in a message. The MessageHeader package includes the MessageHeader entity. A MessageHeader can group together business information from the perspective of a sending application, to identify a business document in a message, to provide information about the sender, to provide information about the recipient. The MessageHeader can be divided up into the following entities: SenderParty and RecipientParty. MessageHeader can be of type GDT: BusinessDocumentMessageHeader. The MessageHeader includes the following elements: ID, ReferenceID, and CreationDateTime. The MessageID can be set by the sending application. With the ReferencedMessageID, reference can be made in the current BusinessDocument to a previous BusinessDocument.
A SenderParty can be a party responsible for sending a business document at a business application level. The SenderParty can be of type GDT: BusinessDocumentMessageHeaderParty. The SenderParty includes the following elements: InternalID, StandardID, and ContactPerson. The SenderParty can be filled by a sending application to name a contact person for problems with the message. A contact person can be useful if an additional infrastructure, such as a marketplace, is located between the sender and the recipient. The SenderParty can be used to transfer a message and can be ignored by the receiving application. SenderParty can be filled by the sender if the participating parties are not transferred with the ShipmentRequest package.
A RecipientParty can be a party responsible for receiving a business document at a business application level. The RecipientParty can be of type GDT: BusinessDocumentMessageHeaderParty. The RecipientParty includes the following elements: InternalID, StandardID, and ContactPerson. The RecipientParty can be filled by the sending application to name a contact person for problems that occur with the message. A contact person can be useful if an additional infrastructure, such as a marketplace, is located between the sender and the recipient. The RecipientParty can be used to transfer the message and can be ignored by the receiving application. RecipientParty can be filled by the sender if the ShipmentRequest package cannot be used to transfer the participating parties.
The RequestForSupplierFreightQuote package can group the RequestForSupplierFreightQuote together with its packages. The RequestForSupplierFreightQuote package includes the RequestForSupplierFreightQuote entity and the following packages: HeaderInformation, GovernmentalRequirementInformation, PartyInformation, TransportationStageInformation, TransportationUnitResourceInformation, TransportationChargesInformation, and RequestForSupplierShipmentQuote.
RequestForSupplierFreightQuote can be a request from an ordering party to a supplier of a transportation service to submit a quote for the transportation of goods from one or multiple ship-from parties to one or multiple ship-to parties with requested terms and conditions. The structure of RequestForSupplierFreightQuote includes the elements @actioncode and ID. The @actioncode element can be a coded representation of an instruction to a message recipient describing how to process the transmitted element. The @actioncode element can be based on GDT: ActionCode. ID can be a unique identifier for a RequestForSupplierFreightQuote. ID can be based on GDT: BusinessTransactionDocumentID. In some implementations, @actioncode “01” (Create) is supported.
The HeaderInformation package can group dates, total values, document and references related to a shipment request. The HeaderInformation package includes the following entities: DateTimePeriods, NatureOfCargo, TotalQuantity, TotalAmount, TextCollection, TransportationServiceRequirement, TransportationDocumentInformation, and BusinessTransactionDocumentReference.
DateTimePeriods can specify a requested and an acceptable date, time and period applying to a shipment request (e.g. date and time of document issue). A requested period can be a period in which an event is requested to take place. An acceptable period can be a period in which an event may take place at an earliest start date/time to a latest end date/time. The elements located directly at the DateTimePeriods entity include RequestedFulfillmentPeriod, AcceptableFulfillmentPeriod, and PeriodRoleCode. RequestedFulfillmentPeriod can be a period which is requested depending on semantics of the PeriodRoleCode. RequestedFulfillmentPeriod can be based on GDT: DATETIMEPERIOD, Qualifier: RequestedFulfillment. AcceptableFulfillmentPeriod can be a period which is acceptable depending on semantics of the PeriodRoleCode. AcceptableFulfillmentPeriod can be based on GDT: DATETIMEPERIOD, Qualifier: AcceptableFulfillment. PeriodRoleCode can be a coded representation of business semantics of the two periods defined by the entities RequestedFulfillmentPeriod and AcceptableFulfillmentPeriod. PeriodRoleCode can be based on GDT: PeriodRoleCode. In some implementations, RequestedFulfillmentPeriod and AcceptableFulfillmentPeriod are optional, but in every instance one of them can be filled.
NatureOfCargo can indicate a nature of cargo related to a shipment request (e.g., palletized, containerized, documents). The structure of NatureOfCargo includes the element ClassificationCode. ClassificationCode can be a coded representation of a classification of a nature of cargo. ClassificationCode can be based on GDT: NatureOfCargoClassificationCode.
TotalQuantity can specify a total quantity which is related to a whole shipment request (e.g., total number of equipment, total number of items). The structure of TotalQuantity includes the Quantity, RoleCode, and TypeCode elements. Quantity can be a non-monetary numerical specification of an amount in a unit of measurement. Quantity can be based on GDT: Quantity. RoleCode can be a coded representation of a role of a quantity, and can be based on GDT: QuantityRoleCode. TypeCode can be a coded representation of a type of quantity that is based on a measurable characteristic of an object or physical phenomenon. TypeCode can be based on GDT: QuantityTypeCode. In some implementations, QuantityRoleCode and QuantityTypeCode are optional, but in every instance one of them can be filled.
TotalAmount can specify a cumulated monetary amount related to a shipment request (e.g., duty amount, insurance amount, total value). The structure of TotalAmount includes the elements Amount and RoleCode. Amount can be an amount with a corresponding currency unit, and can be based on CDT: Amount. RoleCode can be a coded representation of a role of an amount, and can be based on GDT: AmountRoleCode.
TextCollection can be a group of textual information that relates to a shipment request. The structure of the TextCollection entity includes the TextCollection element. TextCollection can be based on GDT: TextCollection.
TransportationServiceRequirement can specify a contract and carriage condition and service and priority requirements for a transport which apply to a whole shipment request. The structure of TransportationServiceRequirement includes the elements TransportationServiceRequirementCode, AdditionalTransportationServiceRequirementCode, TransportationContractConditionCode, TransportServiceLevelCode, and NatureOfCargoClassificationCode. TransportationServiceRequirementCode can be a coded representation of a requirement related to a transportation service. TransportationServiceRequirementCode can be based on GDT : TransportationServiceRequirementCode.
AdditionalTransportationServiceRequirementCode can be a coded representation of an additional requirement related to a transportation service, and can be based on GDT: TransportationServiceRequirementCode, Qualifier: Additional. TransportationContractConditionCode can be a coded representation of a contract and carriage condition, and can be based on GDT: TransportationContractConditionCode. TransportServiceLevelCode can be a coded representation of agreed or defined services in terms of the delivery of goods with respect to the speed of the delivery. TransportServiceLevelCode can be based on GDT : TransportServiceLevelCode. NatureOfCargoClassificationCode can be a coded representation of a classification of a nature of cargo. NatureOfCargoClassificationCode can be based on GDT : NatureOfCargoClassificationCode.
TransportationDocumentInformation can specify information on a transportation document related to a shipment request. TransportationDocumentInformation includes the DateTimePeriod entity. The structure of TransportationDocumentInformation includes the following elements: TransportationDocumentTypeCode, TransportationDocumentNote, TransportationDocumentID, TransportationDocumentStatusCode, LanguageCode, CommunicationMediumTypeCode, RequiredIndicator, OutputCopyNumberValue, and OutputOriginalNumberValue. TransportationDocumentTypeCode can be a coded representation of a documentation type, and can be based on GDT: TransportationDocumentTypeCode.
TransportationDocumentNote can be a short note on documentation, and can be based on GDT: SHORT_Note. TransportationDocumentID can be a unique identifier for a transportation document, and can be based on GDT: TransportationDocumentID. TransportationDocumentStatusCode can be a coded representation of the status of a transportation document (e.g., to be printed, document complete). TransportationDocumentStatusCode can be based on GDT: TransportationDocumentStatusCode. LanguageCode can be a coded representation of the language of a documentation, and can be based on GDT: LanguageCode. CommunicationMediumTypeCode can be a coded representation of a type of a medium used for communication of a documentation, such as Fax, mail, EDI, or Letter. CommunicationMediumTypeCode can be based on GDT : CommunicationMediumTypeCode.
RequiredIndicator can indicate whether a documentation is required or not. RequiredIndicator can be based on GDT: Indicator Qualifier: Required. OutputCopyNumberValue can be a number specifying the number of copies of a document that may be issued. OutputCopyNumberValue can be based on GDT: NumberValue, Qualifier : OutputCopy. OutputOriginalNumberValue can be a number specifying the number of originals of a document that may be issued. OutputOriginalNumberValue can be based on GDT: NumberValue, Qualifier : OutputOriginal. In some implementations, TypeCode and TypeDescription are both optional, but at least one of them can be used. In some implementations, if the RequiredIndicator is set to true, at least one of NumberValues, OutputCopyNumberValue or OutputOriginalNumberValue may be filled.
DateTimePeriod can specify a date, time and/or period (e.g., validity date) related to business documentation. The structure of the DateTimePeriod entity includes the elements DateTimePeriod and PeriodRoleCode. DateTimePeriod can be a period that is defined by two points in time, and can be based on GDT: DateTimePeriod. PeriodRoleCode can be a coded representation of business semantics of a period, and can be based on GDT: PeriodRoleCode.
BusinessTransactionDocumentReference can specify a business document reference that is related to a whole shipment request. BusinessTransactionDocumentReference includes the DateTimePeriod entity. The structure of the BusinessTransactionDocumentReference entity includes the following elements: BusinessTransactionDocumentReference, BusinessTransactionDocumentRelationshipRoleCode, BusinessTransactionDocumentRelationshipTypeCode, TransportationDocumentTypeCode, TransportationDocumentNote, and TransportationDocumentID. BusinessTransactionDocumentReference can be a unique reference to other business documents or business document items that are of significance within each respective business process. BusinessTransactionDocumentReference can be based on GDT: BusinessTransactionDocumentReference.
BusinessTransactionDocumentRelationshipRoleCode can be a coded representation of a role that a business document or a business document item has when set against another business document or business document item with a relationship. BusinessTransactionDocumentRelationshipRoleCode can be based on GDT: BusinessTransactionDocumentRelationshipRoleCode. BusinessTransactionDocumentRelationshipTypeCode can be a coded representation of a relationship between two business documents or business document items. BusinessTransactionDocumentRelationshipTypeCode can be based on GDT: BusinessTransactionDocumentRelationshipTypeCode. TransportationDocumentTypeCode can be a coded representation of a documentation type.
TransportationDocumentTypeCode can be based on GDT: TransportationDocumentTypeCode. TransportationDocumentNote can be a short Note on documentation. TransportationDocumentNote can be based on GDT: SHORT_Note. TransportationDocumentID can be a unique identifier for a transportation document. TransportationDocumentID can be based on GDT: TransportationDocumentID. RelationshipTypeCode and RelationshipRoleCode are both optional. In some implementations, if used, both may be filled. Either the combination BusinessTransactionDocumentReference, BusinessTransactionDocumentRelationshipRoleCode, BusinessTransactionDocumentRelationshipTypeCode or TransportationDocumentTypeCode, TransportationDocumentNote, TransportationDocumentID may be filled.
DateTimePeriod can specify a date, time and/or period related to a DocumentReference. The elements located directly at the DateTimePeriods entity include RequestedFulfillmentPeriod, AcceptableFulfillmentPeriod, and PeriodRoleCode. RequestedFulfillmentPeriod can be a period which is requested depending on semantics of the PeriodRoleCode. RequestedFulfillmentPeriod can be based on GDT: DATETIMEPERIOD, Qualifier: RequestedFulfillment. AcceptableFulfillmentPeriod can be a period which is acceptable depending on semantics of the PeriodRoleCode. AcceptableFulfillmentPeriod can be based on GDT: DATETIMEPERIOD, Qualifier: AcceptableFulfillment. PeriodRoleCode can be a coded representation of business semantics of the two periods defined by the entities RequestedFulfillmentPeriod and AcceptableFulfillmentPeriod. PeriodRoleCode can be based on GDT: PeriodRoleCode. In some implementations, RequestedFulfillmentPeriod and AcceptableFulfillmentPeriod are optional, but in every instance one of them may be filled.
The GovernmentalRequirementInformation package can specify applicable governmental procedures related to import, export and transport of goods of a shipment request. The GovernmentalRequirementInformation package includes the GovernmentalProcedure entity.
GovernmentalProcedure can specify applicable governmental procedures related to import, export and transport of goods of a shipment request. GovernmentalProcedure includes the entities Location, DateTimePeriod, TextCollection, and TransportationDocumentInformation. The structure of GovernmentalProcedure includes the following elements: TransportationGovernmentAgencyTypeCode, TransportationMovementTypeCode, TransportationGovernmentAgencyInvolvementStatusCode, TransportationGovernmentAgencyActionCode, and TransportationGovernmentAgencyProcedureStatusCode. TransportationGovernmentAgencyTypeCode can be a coded representation of a government agency type, and can be based on GDT: TransportationGovernmentAgencyTypeCode.
TransportationMovementTypeCode can be a coded representation of a transport movement type. Example transport movement types include Import, Export, Transit, and Transshipment. TransportationMovementTypeCode can be based on GDT: TransportationMovementTypeCode. TransportationGovernmentAgencyInvolvementStatusCode can be a coded representation for an involvement status of a transportation related government agency. TransportationGovernmentAgencyInvolvementStatusCode can be based on GDT: TransportationGovernmentAgencyInvolvementStatusCode. TransportationGovernmentAgencyActionCode can be a coded representation of an action of a transportation related government agency.
TransportationGovernmentAgencyActionCode can be based on GDT: TransportationGovernmentAgencyActionCode. TransportationGovernmentAgencyProcedureStatusCode can be a coded representation of a status of a procedure related to a transportation government agency. TransportationGovernmentAgencyProcedureStatusCode can be based on GDT: TransportationGovernmentAgencyProcedureStatusCode.
Location can be a physical place related to a GovernmentalProcedure. The structure of the Location entity includes the following elements: Location, RoleCode, TypeCode, and Name. Location includes information exchanged in business documents about a location relevant for business transactions. Location can be based on GDT: BusinessTransactionDocumentLocation. RoleCode can be a coded representation of a LocationRole. RoleCode can be based on GDT: LocationRoleCode. TypeCode can be a coded representation of a type of a physical location. TypeCode can be based on GDT: LocationTypeCode. Name can be a name of a location. Name can be based on GDT: MEDIUM_Name, Qualifier:Location.
DateTimePeriod can specify a date, time and/or period related to a GovernmentalProcedure. The elements located directly at the DateTimePeriods entity include RequestedFulfillmentPeriod, AcceptableFulfillmentPeriod, and PeriodRoleCode. RequestedFulfillmentPeriod can be a period which is requested depending on semantics of the PeriodRoleCode. RequestedFulfillmentPeriod can be based on GDT: DATETIMEPERIOD, Qualifier: RequestedFulfillment. AcceptableFulfillmentPeriod can be a period which is acceptable depending on semantics of the PeriodRoleCode. AcceptableFulfillmentPeriod can be based on GDT: DATETIMEPERIOD, Qualifier: AcceptableFulfillment. PeriodRoleCode can be a coded representation of business semantics of the two periods defined by the entities RequestedFulfillmentPeriod and AcceptableFulfillmentPeriod. PeriodRoleCode can be based on GDT: PeriodRoleCode. In some implementations, RequestedFulfillmentPeriod and AcceptableFulfillmentPeriod are optional, but in every instance one of them may be filled.
TextCollection can be a group of textual information that relates to a GovernmentalProcedure. The structure of the TextCollection entity includes the element TextCollection. TextCollection can be based on GDT: TextCollection.
TransportationDocumentInformation can specify information on a transportation document related to the GovernmentalProcedure. It includes the DateTimePeriod entity. The structure of TransportationDocumentInformation includes the elements: TransportationDocumentTypeCode, TransportationDocumentNote, TransportationDocumentID, TransportationDocumentStatusCode, LanguageCode, CommunicationMediumTypeCode, RequiredIndicator, OutputCopyNumberValue, and OutputOriginalNumberValue. TransportationDocumentTypeCode can be a coded representation of the type of a documentation, and can be based on GDT: TransportationDocumentTypeCode. TransportationDocumentNote can be a short Note on the documentation, and can be based on GDT: SHORT_Note. TransportationDocumentID can be a unique identifier for a transportation document, and can be based on GDT: TransportationDocumentID.
TransportationDocumentStatusCode can be a coded representation of the status of a transportation document, e.g. To be printed, or Document Complete. TransportationDocumentStatusCode can be based on GDT: TransportationDocumentStatusCode. LanguageCode can be a coded representation of the language of a documentation, and can be based on GDT: LanguageCode. CommunicationMediumTypeCode can be a coded representation of the type of a medium used for communication of the documentation, such as, Fax, mail, EDI, or Letter. CommunicationMediumTypeCode can be based on GDT : CommunicationMediumTypeCode. RequiredIndicator can indicate whether a documentation is required or not. RequiredIndicator can be based on GDT: Indicator Qualifier: Required.
OutputCopyNumberValue can be a number specifying the number of copies of the document that should be issued. OutputCopyNumberValue can be based on GDT: NumberValue, Qualifier : OutputCopy. OutputOriginalNumberValue can be a number specifying the number of originals of the document that should be issued. OutputOriginalNumberValue can be based on GDT: NumberValue, Qualifier: OutputOriginal. In some implementations, TypeCode and TypeDescription are both optional, but at least one of them has to be used. In some implementations, if the RequiredIndicator is set to true, at least one of the both NumberValues OutputCopyNumberValue or OutputOriginalNumberValue has to be filled.
DateTimePeriod can specify date, time and/or period related to the Documentation. The elements located directly at the DateTimePeriods entity include: RequestedFulfillmentPeriod, AcceptableFulfillmentPeriod, and PeriodRoleCode. RequestedFulfillmentPeriod can be a period which is requested depending on the semantic of the PeriodRoleCode. RequestedFulfillmentPeriod can be based on GDT: DATETIMEPERIOD, Qualifier: RequestedFulfillment. AcceptableFulfillmentPeriod can be a period which is still acceptable depending on the semantic of the PeriodRoleCode. AcceptableFulfillmentPeriod can be based on GDT: DATETIMEPERIOD, Qualifier: AcceptableFulfillment. PeriodRoleCode can be a coded representation of the business semantic of the two periods defined by the entities RequestedFulfillmentPeriod and AcceptableFulfillmentPeriod. PeriodRoleCode can be based on GDT: PeriodRoleCode. In some implementations, RequestedFulfillmentPeriod and AcceptableFulfillmentPeriod are optional, but in every instance one of them has to be filled.
The PartyInformation package includes information regarding a party of the shipment request, i.e., Shipper, Carrier, or Agent. It includes the Party entity. Party includes information exchanged, in accordance with common business understanding, in business documents about a party involved in business transactions. This information can be used to identify the party and the party's address, as well as the party's contact person and the contact person's address. This identification can take place using an internal ID, a standardized ID, or IDs assigned by the parties involved. It includes the entities: Amount, DateTimePeriods, TransportationDocumentInformation, and BusinessTransactionDocumentReference. The structure of the Party entity includes the Party, RoleCode, and FormattedName entities.
A Party includes information exchanged, in accordance with common business understanding, in business documents about a party involved in business transactions. This information can be used to identify the party and the party's address, as well as the party's contact person and the contact person's address. This identification can take place using an internal ID, a standardized ID, or IDs assigned by the parties involved. Party can be based on GDT: BusinessTransactionDocumentParty. RoleCode can be a coded representation of a PartyRoleCode which specifies which rights and obligations the party has regarding a business object and corresponding processes. In some implementations, a PartyRole is assigned to a PartyRoleCategory and refines its semantics. RoleCode can be based on GDT: PartyRoleCode. FormattedName can be a complete, formatted name of a party, and can be based on GDT: LONG_Name, Qualifier: PartyFormatted.
Amount can specify an amount related to a party. The structure of the Amount entity includes the elements Amount and RoleCode. Amount can be an amount with a corresponding currency unit, and can be based on CDT: Amount. RoleCode can be a coded representation of a role of an amount, and can be based on GDT: AmountRoleCode.
DateTimePeriods can specify a requested and an acceptable date, time and period related to a party. A requested period can be a period in which an event is requested to take place. An acceptable period is a period in which an event may take place at an earliest start date/time to a latest end date/time. The elements located directly at the DateTimePeriods entity include RequestedFulfillmentPeriod, AcceptableFulfillmentPeriod, and PeriodRoleCode. RequestedFulfillmentPeriod can be a period which is requested depending on semantics of the PeriodRoleCode. RequestedFulfillmentPeriod can be based on GDT: DATETIMEPERIOD, Qualifier: RequestedFulfillment. AcceptableFulfillmentPeriod can be a period which is acceptable depending on semantics of the PeriodRoleCode. AcceptableFulfillmentPeriod can be based on GDT: DATETIMEPERIOD, Qualifier: AcceptableFulfillment. PeriodRoleCode can be a coded representation of business semantics of the two periods defined by the entities RequestedFulfillmentPeriod and AcceptableFulfillmentPeriod. PeriodRoleCode can be based on GDT: PeriodRoleCode. In some implementations, RequestedFulfillmentPeriod and AcceptableFulfillmentPeriod are optional, but in every instance one of them may be filled.
TransportationDocumentInformation can specify business documentation related to a party according to a documentation type. TransportationDocumentInformation includes the DateTimePeriod entity. The structure of TransportationDocumentInformation includes the following elements: TransportationDocumentTypeCode, TransportationDocumentNote, TransportationDocumentID, TransportationDocumentStatusCode, LanguageCode, CommunicationMediumTypeCode, RequiredIndicator, OutputCopyNumberValue, and OutputOriginalNumberValue. TransportationDocumentTypeCode can be a coded representation of a documentation type, and can be based on GDT: TransportationDocumentTypeCode. TransportationDocumentNote can be a short note on documentation, and can be based on GDT: SHORT_Note. TransportationDocumentID can be a unique identifier for a transportation document, and can be based on GDT: TransportationDocumentID.
TransportationDocumentStatusCode can be a coded representation of a status of a transportation document (e.g., to be printed, document complete). TransportationDocumentStatusCode can be based on GDT: TransportationDocumentStatusCode. LanguageCode can be a coded representation of the language of a documentation, and can be based on GDT: LanguageCode. CommunicationMediumTypeCode can be a coded representation of the type of a medium used for communication of a documentation, such as Fax, mail, EDI, or Letter. CommunicationMediumTypeCode can be based on GDT : CommunicationMediumTypeCode. RequiredIndicator can indicate whether a documentation is required or not. RequiredIndicator can be based on GDT: Indicator Qualifier: Required.
OutputCopyNumberValue can be a number specifying the number of copies of a document that may be issued. OutputCopyNumberValue can be based on GDT: NumberValue, Qualifier : OutputCopy. OutputOriginalNumberValue can be a number specifying the number of originals of a document that may be issued. OutputOriginalNumberValue can be based on GDT: NumberValue, Qualifier : OutputOriginal. In some implementations, TypeCode and TypeDescription are both optional, but at least one of them can be used. In some implementations, if the RequiredIndicator is set to true, at least one of NumberValues, OutputCopyNumberValue or OutputOriginalNumberValue may be filled.
DateTimePeriod can specify date, time and/or period (e.g. validity date) related to a business documentation of a party. The elements located directly at the DateTimePeriods entity include RequestedFulfillmentPeriod, AcceptableFulfillmentPeriod, and PeriodRoleCode. RequestedFulfillmentPeriod can be a period which is requested depending on semantics of the PeriodRoleCode. RequestedFulfillmentPeriod can be based on GDT: DATETIMEPERIOD, Qualifier: RequestedFulfillment. AcceptableFulfillmentPeriod can be a period which is acceptable depending on semantics of the PeriodRoleCode. AcceptableFulfillmentPeriod can be based on GDT: DATETIMEPERIOD, Qualifier: AcceptableFulfillment. PeriodRoleCode can be a coded representation of business semantics of the two periods defined by the entities RequestedFulfillmentPeriod and AcceptableFulfillmentPeriod. PeriodRoleCode can be based on GDT: PeriodRoleCode. In some implementations, RequestedFulfillmentPeriod and AcceptableFulfillmentPeriod are optional, but in every instance one of them may be filled.
BusinessTransactionDocumentReference can specify a business document reference that is related to a party. BusinessTransactionDocumentReference includes the DateTimePeriod entity. The structure of the BusinessTransactionDocumentReference entity includes the following elements: BusinessTransactionDocumentReference, BusinessTransactionDocumentRelationshipRoleCode, BusinessTransactionDocumentRelationshipTypeCode, TransportationDocumentTypeCode, TransportationDocumentNote, and TransportationDocumentID. BusinessTransactionDocumentReference can be a unique reference to other business documents or business document items that are of significance within each respective business process. BusinessTransactionDocumentReference can be based on GDT: BusinessTransactionDocumentReference.
BusinessTransactionDocumentRelationshipRoleCode can be a coded representation of a role that a business document or a business document item has when set against another business document or business document item with a relationship. BusinessTransactionDocumentRelationshipRoleCode can be based on GDT: BusinessTransactionDocumentRelationshipRoleCode. BusinessTransactionDocumentRelationshipTypeCode can be a coded representation of a relationship between two business documents or business document items. BusinessTransactionDocumentRelationshipTypeCode can be based on GDT: BusinessTransactionDocumentRelationshipTypeCode.
TransportationDocumentTypeCode can be a coded representation of a documentation type. TransportationDocumentTypeCode can be based on GDT: TransportationDocumentTypeCode. TransportationDocumentNote can be a short Note on documentation. TransportationDocumentNote can be based on GDT: SHORT_Note. TransportationDocumentID can be a unique identifier for a transportation document. TransportationDocumentID can be based on GDT: TransportationDocumentID. RelationshipTypeCode and RelationshipRoleCode are both optional. In some implementations, if used, both may be filled. Either the combination BusinessTransactionDocumentReference, BusinessTransactionDocumentRelationshipRoleCode, BusinessTransactionDocumentRelationshipTypeCode or TransportationDocumentTypeCode, TransportationDocumentNote, TransportationDocumentID may be filled.
DateTimePeriod can specify date, time and/or period related to a document referenced by a party. The elements located directly at the DateTimePeriods entity include RequestedFulfillmentPeriod, AcceptableFulfillmentPeriod, and PeriodRoleCode. RequestedFulfillmentPeriod can be a period which is requested depending on semantics of the PeriodRoleCode. RequestedFulfillmentPeriod can be based on GDT: DATETIMEPERIOD, Qualifier: RequestedFulfillment. AcceptableFulfillmentPeriod can be a period which is acceptable depending on semantics of the PeriodRoleCode. AcceptableFulfillmentPeriod can be based on GDT: DATETIMEPERIOD, Qualifier: AcceptableFulfillment. PeriodRoleCode can be a coded representation of business semantics of the two periods defined by the entities RequestedFulfillmentPeriod and AcceptableFulfillmentPeriod. PeriodRoleCode can be based on GDT: PeriodRoleCode. In some implementations, RequestedFulfillmentPeriod and AcceptableFulfillmentPeriod are optional, but in every instance one of them may be filled.
The TransportationStageInformation package includes information regarding a transportation stage of a shipment request. A transportation stage can represent a section of a transport. The TransportationStageInformation package includes the Stage entity. TransportationStage can specify the details related to a stage of a transport which is part of a shipment request. TransportationStage includes the entities Location, TransportationDocumentInformation, and TransportationServiceRequirement. The structure of TransportationStage includes the following elements: ID, OutputOriginalNumberValue, TypeCode, JourneyID, TransportModeCode, TransportMeansDescriptionCode, TransportMeansDescription, TransportMeansID, TransportMeansHomeCountryCode, TransportMeansOwnershipTypeCode, CarrierStandardID, CarrierFormattedName, TransportationTransitDirectionCode, CalculatedDistanceMeasure, and GivenDistanceMeasure. ID can be a unique identifier of a stage in a shipment request. ID can be based on GDT: TransportationStageID. OrdinalNumberValue can be an ordinal number to indicate a position of a transportation stage in a set of transportation stages.
OrdinalNumberValue can be based on GDT: OrdinalNumberValue, Qualifier: TransportationStage. TypeCode can be a coded representation of a type of a TransportationStage. TypeCode can be based on GDT: TransportationStageTypeCode. JourneyID can be an identifier of a Journey. JourneyID can be based on GDT: JourneyID. TransportModeCode can be a coded representation of a mode of transportation used for delivery. TransportModeCode can be based on GDT: TransportModeCode. TransportMeansDescriptionCode can be a coded representation of a transport means type with which goods or persons can be transported. TransportMeansDescriptionCode can be based on GDT: TransportMeansDescriptionCode. TransportMeansDescription can be a description of a means of transport, and can be based on GDT: SHORT_Description, Qualifier: TransportMeans. TransportMeansID can be a unique identifier of a means of transport, and can be based on GDT: TransportMeansID.
TransportMeansHomeCountryCode can be a coded representation of the home country of a transport means, and can be based on GDT: CountryCode, Qualifier: TransportMeansHome. TransportMeansOwnershipTypeCode can be a coded representation of a type of ownership for a means of transport, and can be based on GDT: TransportMeansOwnershipTypeCode. CarrierStandardID can be a standard identifier of a carrier, and can be based on GDT: PartyStandardID. CarrierFormattedName can be a name of a carrier, and can be based on GDT: LONG_Name, Qualifier: PartyFormatted. TransportationTransitDirectionCode can be a coded representation for a transportation transit direction. TransportationTransitDirectionCode can be based on GDT: TransportationTransitDirectionCode. CalculatedDistanceMeasure can be a calculated distance measure, and can be based on GDT: Measure, Qualifier: CalculatedDistance. GivenDistanceMeasure can be a given distance measure, and can be based on GDT: Measure, Qualifier: GivenDistance.
StageLocation can specify a physical place related to a stage. StageLocation includes the DateTimePeriods entity. The structure of the Location entity includes the following elements: Location, RoleCode, TypeCode, and Name. Location includes information exchanged in business documents about a location relevant for business transactions. Location can be based on GDT: BusinessTransactionDocumentLocation. RoleCode can be a coded representation of a LocationRole, and can be based on GDT: LocationRoleCode. TypeCode can be a coded representation of a type of a physical location. TypeCode can be based on GDT: LocationTypeCode. Name can be a name of a location, and can be based on GDT: MEDIUM_Name, Qualifier:Location.
DateTimePeriods can specify a date, time and/or period related to a Location. The elements located directly at the DateTimePeriods entity include RequestedFulfillmentPeriod, AcceptableFulfillmentPeriod, and PeriodRoleCode. RequestedFulfillmentPeriod can be a period which is requested depending on semantics of a PeriodRoleCode. RequestedFulfillmentPeriod can be based on GDT: DATETIMEPERIOD, Qualifier: RequestedFulfillment. AcceptableFulfillmentPeriod can be a period which is acceptable depending on semantics of a PeriodRoleCode. AcceptableFulfillmentPeriod can be based on GDT: DATETIMEPERIOD, Qualifier: AcceptableFulfillment. PeriodRoleCode can be a coded representation of business semantics of the two periods defined by the entities RequestedFulfillmentPeriod and AcceptableFulfillmentPeriod. PeriodRoleCode can be based on GDT: PeriodRoleCode. In some implementations, RequestedFulfillmentPeriod and AcceptableFulfillmentPeriod are optional, but in every instance one of them may be filled.
BusinessTransactionDocumentReference can specify a business document reference that is related to a Stage. BusinessTransactionDocumentReference includes the DateTimePeriod entity. The structure of the BusinessTransactionDocumentReference entity includes the elements BusinessTransactionDocumentReference, BusinessTransactionDocumentRelationshipRoleCode, BusinessTransactionDocumentRelationshipTypeCode, TransportationDocumentTypeCode, TransportationDocumentNote, and TransportationDocumentID. BusinessTransactionDocumentReference can be a unique reference to other business documents or business document items that are of significance within each respective business process. BusinessTransactionDocumentReference can be based on GDT: BusinessTransactionDocumentReference.
BusinessTransactionDocumentRelationshipRoleCode can be a coded representation of a role that a business document or a business document item has when set against another business document or business document item with a relationship. BusinessTransactionDocumentRelationshipRoleCode can be based on GDT: BusinessTransactionDocumentRelationshipRoleCode. BusinessTransactionDocumentRelationshipTypeCode can be a coded representation of a relationship between two business documents or business document items. BusinessTransactionDocumentRelationshipTypeCode can be based on GDT: BusinessTransactionDocumentRelationshipTypeCode.
TransportationDocumentTypeCode can be a coded representation of a documentation type. TransportationDocumentTypeCode can be based on GDT: TransportationDocumentTypeCode. TransportationDocumentNote can be a short Note on documentation. TransportationDocumentNote can be based on GDT: SHORT_Note. TransportationDocumentID can be a unique identifier for a transportation document. TransportationDocumentID can be based on GDT: TransportationDocumentID. RelationshipTypeCode and RelationshipRoleCode are both optional. In some implementations, if used, both may be filled. Either the combination BusinessTransactionDocumentReference, BusinessTransactionDocumentRelationshipRoleCode, BusinessTransactionDocumentRelationshipTypeCode or TransportationDocumentTypeCode, TransportationDocumentNote, TransportationDocumentID may be filled.
DateTimePeriod can specify a date, time and/or period related to a BusinessTransactionDocumentReference. The elements located directly at the DateTimePeriods entity include RequestedFulfillmentPeriod, AcceptableFulfillmentPeriod, and PeriodRoleCode. RequestedFulfillmentPeriod can be a period which is requested depending on semantics of the PeriodRoleCode. RequestedFulfillmentPeriod can be based on GDT: DATETIMEPERIOD, Qualifier: RequestedFulfillment. AcceptableFulfillmentPeriod can be a period which is acceptable depending on semantics of the PeriodRoleCode. AcceptableFulfillmentPeriod can be based on GDT: DATETIMEPERIOD, Qualifier: AcceptableFulfillment. PeriodRoleCode can be a coded representation of business semantics of the two periods defined by the entities RequestedFulfillmentPeriod and AcceptableFulfillmentPeriod. PeriodRoleCode can be based on GDT: PeriodRoleCode. In some implementations, RequestedFulfillmentPeriod and AcceptableFulfillmentPeriod are optional, but in every instance one of them may be filled.
TransportationServiceRequirement can specify a contract and carriage condition and service and priority requirements related to a stage. The structure of TransportationServiceRequirement includes the following elements: TransportationServiceRequirementCode, AdditionalTransportationServiceRequirementCode, TransportationContractConditionCode, TransportServiceLevelCode, and NatureOfCargoClassificationCode. TransportationServiceRequirementCode can be a coded representation of a requirement related to a transportation service, and can be based on GDT: TransportationServiceRequirementCode.
AdditionalTransportationServiceRequirementCode can be a coded representation of an additional requirement related to a transportation service, and can be based on GDT: TransportationServiceRequirementCode, Qualifier: Additional. TransportationContractConditionCode can be a coded representation of a contract and carriage condition, and can be based on GDT: TransportationContractConditionCode. TransportServiceLevelCode can be a coded representation of agreed or defined services in terms of the delivery of goods with respect to the speed of the delivery. TransportServicesLevelCode can be based on GDT : TransportServiceLevelCode. NatureOfCargoClassificationCode can be a coded representation of a classification of the nature of cargo. NatureOfCargoClassificationCode can be based on GDT : NatureOfCargoClassificationCode.
The TransportationUnitResourceInformation package includes information regarding a transportation unit resource that is relevant for a shipment request (e.g., a container). The TransportationUnitResourceInformation package includes the TransportationUnitResourceInformation entity. TransportationUnitResourceInformation includes information on one or more transportation unit resources, such as a resource type and related properties, related measures or handling instructions. A Transportation Unit Resource can be a unit into which goods are loaded and/or from which goods are unloaded. In some implementations, this unit can provide transportation capacity for goods but may or may not move by itself. TransportationUnitResourceInformation includes the following entities: TransportationStageAssignment, AttachedEquipment, Quantity, Seal, BusinessTransactionDocumentReference, TextCollection, Location, and DangerousGoods. The structure of TransportationUnitResourceInformation includes the following elements: ID, ResourceNumberValue, ResourceID, ResourceHomeCountryCode, TransportationUnitResourceCategoryCode, TransportationUnitResourceTypeCode, FillLevelCode, ShippingTypeCode, HaulageArrangerCode, TransportationHandlingInstructionCode, and TransportationHandlingInstructionNote.
ID can be a unique identifier for a resource information, and can be based on GDT ResourceInformationID. ResourceNumberValue can be a count of resources, and can be based on GDT: NumberValue, Qualifier: Resource. ResourceID can be a unique identifier for a resource, and can be based on GDT: ResourceID. ResourceHomeCountryCode can be a coded representation of the home country of a resource, and can be based on GDT: CountryCode, Qualifier: ResourceHome. TransportationUnitResourceCategoryCode can be a coded representation of a category of transportation unit resources, and can be based on GDT: TransportationUnitResourceCategoryCode. TransportationUnitResourceTypeCode can be a coded representation of the type of a transportation unit resource. TransportationUnitResourceTypeCode can be based on GDT: TransportationUnitResourceTypeCode.
FillLevelCode can be a coded representation of a fill level of a resource, and can be based on GDT: FillLevelCode. ShippingTypeCode can be a coded representation of a shipping type. A shipping type can specify how planning and execution of a transportation can be performed. Transportation terms include detailed specifications on agreed means of transportation, such as shipping or transport type, and means of transport to be used. ShippingTypeCode can be based on GDT: ShippingTypeCode. HaulageArrangerCode can be a coded representation of an arranger of a haulage. Haulage can be inland transport of cargo. HaulageArrangerCode can be based on GDT: HaulageArrangerCode. TransportationHandlingInstructionCode can be a coded representation of a type of a transportation handling instruction, and can be based on GDT: TransportationHandlingInstructionCode. TransportationHandlingInstructionNote can be a note regarding a transportation handling instruction, and can be based on GDT: LONG_Note, Qualifier: TransportationHandlingInstruction.
TransportationStageAssignment can specify an assignment of a transportation stage to a transportation unit resource information. The structure of TransportationStageAssignment includes the element ShipmentRequestTransportationStageID. ShipmentRequestTransportationStageID can be a unique identifier of a TransportationStage in a shipment request, and can be based on GDT: TransportationStageID.
AttachedEquipment can specify equipment attached to a TransportationUnitResource. The structure of AttachedEquipment includes the element ShipmentRequestResourceInformationID. ShipmentRequestResourceInformationID can be a unique identifier of a resource information in a ShipmentRequest, and can be based on GDT: ResourceInformationID.
Quantity can specify a quantity related to the TransportationUnitResourceInformation. The structure of the Quantity entity includes the following elements: Quantity, RoleCode, and TypeCode. Quantity can be a non-monetary numerical specification of an amount in a unit of measurement. Quantity can be based on GDT: Quantity. RoleCode can be a coded representation of the role of a quantity, and can be based on GDT: QuantityRoleCode. TypeCode can be a coded representation of a type of a quantity that is based on a measurable characteristic of an object or physical phenomenon. TypeCode can be based on GDT: QuantityTypeCode. In some implementations, QuantityRoleCode and QuantityTypeCode are optional, but in every instance one of them can be filled.
BusinessTransactionDocumentReference can specify a business document reference that is related to the TransportationUnitResource. BusinessTransactionDocumentReference includes the DateTimePeriod entity. The structure of the BusinessTransactionDocumentReference entity includes the following elements: BusinessTransactionDocumentReference, BusinessTransactionDocumentRelationshipRoleCode, BusinessTransactionDocumentRelationshipTypeCode, TransportationDocumentTypeCode, TransportationDocumentNote, and TransportationDocumentID. BusinessTransactionDocumentReference can be a unique reference to other business documents or business document items that are of significance within each respective business process. BusinessTransactionDocumentReference can be based on GDT: BusinessTransactionDocumentReference.
BusinessTransactionDocumentRelationshipRoleCode can be a coded representation of a role that a business document or a business document item has when set against another business document or business document item with a relationship. BusinessTransactionDocumentRelationshipRoleCode can be based on GDT: BusinessTransactionDocumentRelationshipRoleCode. BusinessTransactionDocumentRelationshipTypeCode can be a coded representation of a relationship between two business documents or business document items. BusinessTransactionDocumentRelationshipTypeCode can be based on GDT: BusinessTransactionDocumentRelationshipTypeCode. TransportationDocumentTypeCode can be a coded representation of a documentation type. TransportationDocumentTypeCode can be based on GDT: TransportationDocumentTypeCode.
TransportationDocumentNote can be a short Note on documentation. TransportationDocumentNote can be based on GDT: SHORT_Note. TransportationDocumentID can be a unique identifier for a transportation document. TransportationDocumentID can be based on GDT: TransportationDocumentID. RelationshipTypeCode and RelationshipRoleCode are both optional. In some implementations, if used, both may be filled. Either the combination BusinessTransactionDocumentReference, BusinessTransactionDocumentRelationshipRoleCode, BusinessTransactionDocumentRelationshipTypeCode or TransportationDocumentTypeCode, TransportationDocumentNote, TransportationDocumentID may be filled.
DateTimePeriod can specify a date, time and/or period related to a BusinessTransactionDocumentReference. The elements located directly at the DateTimePeriods entity include RequestedFulfillmentPeriod, AcceptableFulfillmentPeriod, and PeriodRoleCode. RequestedFulfillmentPeriod can be a period which is requested depending on semantics of the PeriodRoleCode. RequestedFulfillmentPeriod can be based on GDT: DATETIMEPERIOD, Qualifier: RequestedFulfillment. AcceptableFulfillmentPeriod can be a period which is acceptable depending on semantics of a PeriodRoleCode. AcceptableFulfillmentPeriod can be based on GDT: DATETIMEPERIOD, Qualifier: AcceptableFulfillment. PeriodRoleCode can be a coded representation of business semantics of the two periods defined by the entities RequestedFulfillmentPeriod and AcceptableFulfillmentPeriod. PeriodRoleCode can be based on GDT: PeriodRoleCode. In some implementations, RequestedFulfillmentPeriod and AcceptableFulfillmentPeriod are optional, but in every instance one of them may be filled.
TextCollection can be a group of textual information that relates to a TransportationUnitResource. The structure of the TextCollection entity includes the TextCollection element. TextCollection can be based on GDT: TextCollection. Location can specify a physical place related to the TransportationUnitResource. The structure of the Location entity includes the following elements: Location, RoleCode, TypeCode, and Name. Location includes information exchanged in business documents about a location relevant for business transactions. Location can be based on GDT: BusinessTransactionDocumentLocation. RoleCode can be a coded representation of a LocationRole, and can be based on GDT: LocationRoleCode. TypeCode can be a coded representation of a type of a physical location, and can be based on GDT: LocationTypeCode. Name can be a name of a location, and can be based on GDT: MEDIUM_Name, Qualifier:Location.
DateTimePeriods can specify a requested and an acceptable date, time and period related to a Location of a resource. The elements located directly at the DateTimePeriods entity include RequestedFulfillmentPeriod, AcceptableFulfillmentPeriod, and PeriodRoleCode. RequestedFulfillmentPeriod can be a period which is requested depending on semantics of a PeriodRoleCode. RequestedFulfillmentPeriod can be based on GDT: DATETIMEPERIOD, Qualifier: RequestedFulfillment. AcceptableFulfillmentPeriod can be a period which is acceptable depending on semantics of a PeriodRoleCode. AcceptableFulfillmentPeriod can be based on GDT: DATETIMEPERIOD, Qualifier: AcceptableFulfillment. PeriodRoleCode can be a coded representation of business semantics of the two periods defined by the entities RequestedFulfillmentPeriod and AcceptableFulfillmentPeriod. PeriodRoleCode can be based on GDT: PeriodRoleCode. In some implementations, RequestedFulfillmentPeriod and AcceptableFulfillmentPeriod are optional, but in every instance one of them may be filled.
DangerousGoods can specify dangerous goods included in a resource. DangerousGoods includes the ContactInformation and TextCollection entities. The structure of DangerousGoods includes the following elements: ID, RegulationsCode, HazardCode, FlashpointMeasureInterval, PackagingGroupCode, EmergencySchedule, TransportEmergencyCardCode, DangerousGoodsLabelCode, DangerousGoodsLabelCode2, DangerousGoodsLabelCode3, PackagingInstructionTypeCode, TransportMeansDescriptionCode, and TransportAuthorisationCode. ID can be a unique identifier for a dangerous good, using the United Nations Dangerous Goods Number. ID can be based on GDT: DangerousGoodsID. RegulationsCode can be a coded representation of national or international dangerous goods rules or regulations. RegulationsCode can be based on GDT: DangerousGoodsRegulationsCode. HazardCode can be a coded representation of a hazard that is imminent in a dangerous good. HazardCode can be based on GDT: DangerousGoodsHazardCode. FlashpointMeasureInterval can be an interval of measures defined by a lower and an upper boundary indicating a flashpoint of a dangerous good. FlashpointMeasureInterval can be based on GDT: MeasureInterval, Qualifier: Flashpoint. PackagingGroupCode can be a coded representation of the effectiveness of a packaging to transport dangerous goods depending on a degree of danger of the goods. PackagingGroupCode can be based on GDT: DangerousGoodsPackagingGroupCode.
EmergencySchedule can be a coded representation of an emergency schedule for dangerous goods. EmergencySchedule can identify an emergency schedule. The DangerousGoodsEmergencySchedule can be used for transports of dangerous goods by sea similar to a Transport Emergency Card which is used for transports of dangerous goods by road. EmergencySchedule can be based on GDT: DangerousGoodsEmergencySchedule. TransportEmergencyCardCode can be a coded representation of a transport emergency card which specifies how to react in case of an accident. TransportEmergencyCardCode can be based on GDT: TransportEmergencyCardCode. DangerousGoodsLabelCode can be a coded representation of a label for a dangerous good. In some implementations, DangerousGoodsLabelCode's values are dependant on the DangerousGoodsRegulationsCode. DangerousGoodsLabelCode can be based on GDT: DangerousGoodsLabelCode.
DangerousGoodsLabelCode2 can be a coded representation of a label for a dangerous good. In some implementations, DangerousGoodsLabelCode's values are dependant on the DangerousGoodsRegulationsCode. DangerousGoodsLabelCode2 can be based on GDT: DangerousGoodsLabelCode. DangerousGoodsLabelCode3 can be a coded representation of a label for a dangerous good. In some implementations, DangerousGoodsLabelCode's values are dependant on the DangerousGoodsRegulationsCode. DangerousGoodsLabelCode3 can be based on GDT: DangerousGoodsLabelCode. PackagingInstructionTypeCode can be a coded representation of a packaging instruction. In some implementations, a packaging instruction can be an instruction defining which packaging can be used to pack a dangerous good. PackagingInstructionTypeCode can be based on GDT: PackagingInstructionTypeCode. TransportMeansDescriptionCode can be a coded representation of a transport means type with which goods or persons can be transported. TransportMeansDescriptionCode can be based on GDT: TransportMeansDescriptionCode. TransportAuthorisationCode can be a coded representation of an authorisation for the transportation of dangerous goods. This code can specify an authorisation for the transportation of a particular dangerous good. TransportAuthorisationCode can be based on GDT: DangerousGoodsTransportAuthorisationCode.
ContactInformation can specify information on a department or person to whom information regarding dangerous goods can be directed. The structure of ContactInformation includes the elements ContactPersonFunctionTypeCode, and Address. ContactPersonFunctionTypeCode can be a coded representation of the type of function that a contact person has. ContactPersonFunctionTypeCode can be based on GDT: ContactPersonFunctionTypeCode. Address can be an address related to the contact information defined by a corresponding FunctionTypeCode. Address can be based on GDT: Address.
TextCollection can be a group of textual information that relates to DangerousGoods. The structure of the TextCollection entity includes the TextCollection element. TextCollection can be based on GDT: TextCollection.
The TransportationChargesInformation package includes information regarding transportation charge calculation specific components related to a FreightRequest. The TransportationChargesInformation package includes the TransportationChargesInformation entity. The entity TransportationChargesInformation can define a relationship between transportation charges and the origin of these charges. TransportationChargesInformation includes the TransportationCharges entity. The structure of TransportationChargesInformation includes the following elements: TransportationChargesUsageCode, RequestForSupplierFreightQuotePartyStandardID, RequestForSupplierFreightQuoteTransportationUnitResourceID, and RequestForSupplierFreightQuoteTransportationStageID.
TransportationChargesUsageCode can be a coded representation of the usage of TransportationCharges. The usage can point out if subsequent information represents a revenue view or cost view on transportation charges. TransportationChargesUsageCode can be based on GDT: TransportationChargesUsageCode. RequestForSupplierFreightQuotePartyStandardID can be a unique identifier of a Party in a FreightRequest, and can be based on GDT: PartyStandardID. RequestForSupplierFreightQuoteTransportationUnitResourceID can be a unique identification of a TransportationUnitResource in a FreightRequest, and can be based on GDT: ResourceID. RequestForSupplierFreightQuoteTransportationStageID can be a unique identification of a TransportationStage in a FreightRequest, and can be based on GDT: TransportationStageID. If none of the IDs is maintained, the transportation charges may be related to an entire freight request.
TransportationCharges can be a summary of determined transportation charge specific components for a transportation business case. TransportationCharges includes the following entities: Location, TextCollection, Currency, ExchangeRate, PercentElement, DateTimePeriod, BusinessTransactionDocumentReference, TaxDetail, PaymentInstruction, CashDiscountTerms, and Element. The structure of TransportationCharges includes the following elements: ID, FreightAgreementID, CalculationOriginCode, TariffID, and CalculationSheetID. ID can be a unique identifier of TransportationCharges in a ShipmentRequest, and can be based on GDT: TransportationChargesID. FreightAgreementID can be an identification of a Freight Agreement which includes and points to a configuration for the Transportation Charges Calculation.
FreightAgreementID can be based on GDT: FreightAgreementID. CalculationOriginCode can be a coded representation of an origin of a transportation charges calculation. The calculation can be done automatically based on a system configuration. Data for the calculation, including the results, can be manually entered or received from another business system via a message. In some implementations, a clear distinction of the origin of TransportationChargesCalculation details such as the TransportationChargesCalculationSheet and its TransportationChargeElements can be included. The included details can give information whether the calculation was done completely automatically, or if the results were manually adopted. CalculationOriginCode can be based on GDT: TransportationChargesOriginCode.
TariffID can be an identifier for a transportation charges tariff. A transportation charges tariff can be a specific combination of a transportation charges calculation sheet and terms and conditions. The terms and conditions can define if a certain transportation charges calculation sheet and its related rates are applicable for a transportation business case. TariffID can be based on GDT: TransportationChargesTariffID. CalculationSheetID can be a unique Identifier for a transportation charges calculation sheet. A TransportationChargesCalculationSheet can represent a configuration how to calculate transportation charges for a transportation business case. A TransportationChargesCalculationSheet includes instructions describing which charges are applicable, which data from a transportation business case may be considered for a calculation, how the underlying transportation charge rates are determined and which special calculation methods can be considered. CalculationSheetID can be based on GDT: TransportationChargesCalculationSheetID.
A Location can specify a physical place to which TransportationCharges and their calculation can refer. Location includes the DateTimePeriod entity. The structure of the Location entity includes the following elements: Location, RoleCode, TypeCode, and Name. Location includes information exchanged in business documents about a location relevant for business transactions. Location can be based on GDT: BusinessTransactionDocumentLocation. RoleCode can be a coded representation of a LocationRole, and can be based on GDT: LocationRoleCode. TypeCode can be a coded representation of a type of a physical location, and can be based on GDT: LocationTypeCode. Name can be a name of a location, and can be based on GDT: MEDIUM_Name, Qualifier:Location.
DateTimePeriods can specify a date, time and/or period related to a TransportationChargesLocation. The elements located directly at the DateTimePeriods entity include RequestedFulfillmentPeriod, AcceptableFulfillmentPeriod, and PeriodRoleCode. RequestedFulfillmentPeriod can be a period which is requested depending on semantics of a PeriodRoleCode. RequestedFulfillmentPeriod can be based on GDT: DATETIMEPERIOD, Qualifier: RequestedFulfillment. AcceptableFulfillmentPeriod can be a period which is acceptable depending on semantics of the PeriodRoleCode. AcceptableFulfillmentPeriod can be based on GDT: DATETIMEPERIOD, Qualifier: AcceptableFulfillment. PeriodRoleCode can be a coded representation of business semantics of the two periods defined by the entities RequestedFulfillmentPeriod and AcceptableFulfillmentPeriod. PeriodRoleCode can be based on GDT: PeriodRoleCode. In some implementations, RequestedFulfillmentPeriod and AcceptableFulfillmentPeriod are optional, but in every instance one of them may be filled.
TextCollection can be a group of textual information that relates to the TransportationCharges. The structure of the TextCollection entity includes the TextCollection element. TextCollection can be based on GDT: TextCollection.
Currency can be a currency which is valid for transportation charges. The structure of Currency includes the following elements: Code, RoleCode, and UsageCode. Code can be a coded representation of a currency, and can be based on GDT: CurrencyCode. RoleCode can be a coded representation of a role of a Currency, and can be based on GDT: CurrencyRoleCode. UsageCode can be a coded representation of how a currency is used, and can be based on GDT: CurrencyUsageCode. This currency can be valid for transportation charges, as long as there is no currency information on a charge element level.
ExchangeRate can be an exchange rate that has been especially negotiated for transportation charges. The structure of ExchangeRate includes the ExchangeRate and TypeCode elements. ExchangeRate can be a rate at which one unit of a currency can be changed into another currency. ExchangeRate can be based on GDT: ExchangeRate. TypeCode can be a coded representation of a type of an exchange rate. The actual exchange rate between two currencies can depend on an exchange rate type and currency conversion type. The exchange rate type can define characteristics of an exchange rate according to currencies that get converted. TypeCode can be based on GDT: ExchangeRateTypeCode.
PercentElement can be a detail about Transportation Charges, represented as a percentage. The structure of PercentElement includes the elements PercentRoleCode, Percent, TransportationChargesPercentCalculationBaseCode, and StatusCode. PercentRoleCode can be a coded representation of a role of a percent, and can be based on GDT: PercentRoleCode. Percent can be a number that relates to the comparison
DateTimePeriod can specify a date, time and/or period that is relevant for a transportation charges calculation. The elements located directly at the DateTimePeriods entity include RequestedFulfillmentPeriod, AcceptableFulfillmentPeriod, and PeriodRoleCode. RequestedFulfillmentPeriod can be a period which is requested depending on semantics of the PeriodRoleCode. RequestedFulfillmentPeriod can be based on GDT: DATETIMEPERIOD, Qualifier: RequestedFulfillment. AcceptableFulfillmentPeriod can be a period which is acceptable depending on semantics of the PeriodRoleCode. AcceptableFulfillmentPeriod can be based on GDT: DATETIMEPERIOD, Qualifier: AcceptableFulfillment. PeriodRoleCode can be a coded representation of business semantics of the two periods defined by the entities RequestedFulfillmentPeriod and AcceptableFulfillmentPeriod. PeriodRoleCode can be based on GDT: PeriodRoleCode. In some implementations, RequestedFulfillmentPeriod and AcceptableFulfillmentPeriod are optional, but in every instance one of them may be filled.
A BusinessTransactionDocumentReference can specify a business document reference that is related to a transportation charges calculation. The structure of the BusinessTransactionDocumentReference entity includes the following elements: BusinessTransactionDocumentReference, BusinessTransactionDocumentRelationshipRoleCode, BusinessTransactionDocumentRelationshipTypeCode, TransportationDocumentTypeCode, TransportationDocumentNote, and TransportationDocumentID. BusinessTransactionDocumentReference can be a unique reference to other business documents or business document items that are of significance within each respective business process. BusinessTransactionDocumentReference can be based on GDT: BusinessTransactionDocumentReference.
BusinessTransactionDocumentRelationshipRoleCode can be a coded representation of a role that a business document or a business document item has when set against another business document or business document item with a relationship. BusinessTransactionDocumentRelationshipRoleCode can be based on GDT: BusinessTransactionDocumentRelationshipRoleCode. BusinessTransactionDocumentRelationshipTypeCode can be a coded representation of a relationship between two business documents or business document items. BusinessTransactionDocumentRelationshipTypeCode can be based on GDT: BusinessTransactionDocumentRelationshipTypeCode. TransportationDocumentTypeCode can be a coded representation of a documentation type.
TransportationDocumentTypeCode can be based on GDT: TransportationDocumentTypeCode. TransportationDocumentNote can be a short Note on documentation. TransportationDocumentNote can be based on GDT: SHORT_Note. TransportationDocumentID can be a unique identifier for a transportation document. TransportationDocumentID can be based on GDT: TransportationDocumentID. RelationshipTypeCode and RelationshipRoleCode are both optional. In some implementations, if used, both may be filled. Either the combination BusinessTransactionDocumentReference, BusinessTransactionDocumentRelationshipRoleCode, BusinessTransactionDocumentRelationshipTypeCode or TransportationDocumentTypeCode, TransportationDocumentNote, TransportationDocumentID may be filled.
A TaxDetail can be tax-relevant information which is applicable for each ChargeElement. The structure of TaxDetail includes the ProductTax element. ProductTax can be a tax that is incurred for product-related business transactions, such as purchasing, sales, or consumption. The ProductTax can be used to display different tax components in calculated and invoiced amounts, and to inform about tax declarations and payments of a company to responsible tax authorities. ProductTax can be based on GDT: ProductTax. In some implementations, within TaxDetail, the BusinessTransactionDocumentItemGroupID of the GDT ProductTax is not used.
PaymentInstruction can be an instruction about how a payment can be carried out or which additional activities can be carried out within a payment. There can be a separate instance for each Charge Category Code, such as Basic Freight, Origin haulage, or charges. The structure of PaymentInstruction includes the following elements: PaymentInstruction, TransportationChargesElementCategoryCode, TransportationChargesElementSubCategoryCode, and TransportationChargesPaymentArrangementCode. PaymentInstruction can be an instruction about how a payment can be carried out or which additional activities can be carried out within a payment. PaymentInstruction can be based on GDT: PaymentInstruction. TransportationChargesElementCategoryCode can be a coded representation of a category of a TransportationChargeElement.
The TransportationChargeElementCategoryCode can be used to group TransportationChargeElements. PaymentInstructions can be different per TransportationChargeElementCategory. TransportationChargesElementCategoryCode can be based on GDT: TransportationChargesElementCategoryCode. TransportationChargesElementSubCategoryCode can be a coded representation of a subcategory of a transportation charges element. TransportationChargesElementSubCategoryCode can be based on GDT: TransportationChargesElementSubCategoryCode. TransportationChargesPaymentArrangementCode can be a coded representation of an arrangement of a payment for transportation charges. TransportationChargesPaymentArrangementCode can be based on GDT: TransportationChargesPaymentArrangementCode.
CashDiscountTerms can be an agreement on a percentage of a cash discount that is granted during a transportation transaction when a payment takes place within a certain number of days after a baseline date for payment has passed. The structure of CashDiscountTerms includes the following elements: CashDiscountTerms, TransportationChargesElementCategoryCode, and TransportationChargesElementSubCategoryCode. CashDiscountTerms can be an agreement of cash discounts for a payment, and can be based on GDT: CashDiscountTerms. TransportationChargesElementCategoryCode can be a coded representation of a category of a TransportationChargesElement.
The TransportationChargesElementCategoryCode can be used to group TransportationChargesElements. PaymentInstructions can be different per TransportationChargesElementCategory. TransportationChargesElementCategoryCode can be based on GDT: TransportationChargesElementCategoryCode. TransportationChargesElementSubCategoryCode can be a coded representation of a subcategory of a transportation charges element. TransportationChargesElementSubCategoryCode can be based on GDT: TransportationChargesElementSubCategoryCode.
Element can be, together with its sub nodes, a single building block of a transportation charge calculation. A Charge Element can result from a manually created charge, an automatically determined charge, or another Charge Element distributed from an entire document. A Charge Element includes the following entities: Location, TextCollection, Currency, RateElement, PercentElement, AmountElement, CalculationBase, TaxDetail, DateTimePeriod, and CostDistribution. The structure of Element includes the following elements: CategoryCode, SubCategoryCode, TypeCode, CalculationResolutionCode, and TransportationChargesPaymentArrangementCode. CategoryCode can be a coded representation of a category of a TransportationChargesElement.
The TransportationChargesElementCategoryCode can be used to group TransportationChargesElements. PaymentInstructions can be different per TransportationChargesElementCategory. CategoryCode can be based on GDT: TransportationChargesElementCategoryCode. SubCategoryCode can be a coded representation of a subcategory of a transportation charges element. SubCategoryCode can be based on GDT: TransportationChargesElementSubCategoryCode. TypeCode can be a coded representation of a type of a transportation charge element. TypeCode can be based on GDT: TransportationChargesElementTypeCode. CalculationResolutionCode can be a coded representation of a resolution for a transportation charges element calculation. CalculationResolutionCode can be based on GDT: TransportationChargesElementCalculationResolutionCode. TransportationChargesPaymentArrangementCode can be a coded representation of an arrangement of a payment for transportation charges. TransportationChargesPaymentArrangementCode can be based on GDT: TransportationChargesPaymentArrangementCode.
Location can specify a physical place a specific ChargeElement refers to. Location includes the DateTimePeriod entity. The structure of the Location entity includes the following elements: Location, RoleCode, TypeCode, and Name. Location includes information exchanged in business documents about a location relevant for business transactions. Location can be based on GDT: BusinessTransactionDocumentLocation. RoleCode can be a coded representation of a LocationRole, and can be based on GDT: LocationRoleCode. TypeCode can be a coded representation of a type of a physical location. TypeCode can be based on GDT: LocationTypeCode. Name can be a name of a location, and can be based on GDT: MEDIUM_Name, Qualifier:Location.
DateTimePeriods can specify a date, time and/or period related to a location. The elements located directly at the DateTimePeriods entity include RequestedFulfillmentPeriod, AcceptableFulfillmentPeriod, and PeriodRoleCode. RequestedFulfillmentPeriod can be a period which is requested depending on semantics of the PeriodRoleCode. RequestedFulfillmentPeriod can be based on GDT: DATETIMEPERIOD, Qualifier: RequestedFulfillment. AcceptableFulfillmentPeriod can be a period which is acceptable depending on semantics of the PeriodRoleCode. AcceptableFulfillmentPeriod can be based on GDT: DATETIMEPERIOD, Qualifier: AcceptableFulfillment. PeriodRoleCode can be a coded representation of business semantics of the two periods defined by the entities RequestedFulfillmentPeriod and AcceptableFulfillmentPeriod. PeriodRoleCode can be based on GDT: PeriodRoleCode. In some implementations, RequestedFulfillmentPeriod and AcceptableFulfillmentPeriod are optional, but in every instance one of them may be filled.
TextCollection can be a group of textual information that relates to a ChargeElement. The structure of the TextCollection entity includes the TextCollection element. TextCollection can be based on GDT: TextCollection.
Currency can emphasize if the ChargeElement may be considered with relation to a certain currency. The structure of Currency includes the following elements: Code, RoleCode, and UsageCode. Code can be a coded representation of a currency, and can be based on GDT: CurrencyCode. RoleCode can be a coded representation of a role of a Currency, and can be based on GDT: CurrencyRoleCode. UsageCode can be a coded representation of how a currency is used. UsageCode can be based on GDT: CurrencyUsageCode. This currency can be valid for transportation charges, as long as there is no currency information on a charge element level.
RateDetail can specify a rate with which the ChargeElement is calculated. The structure of RateElement includes the following elements: ID, Amount, BaseQuantity, TransportationChargesRateTypeCode, TransportationChargesRateRoleCode, and TransportationChargesRateElementStatusCode. ID can be a unique identifier of a rate element of a transportation charges element, and can be based on GDT: TransportationChargesElementRateElementID. Amount can be an amount with a corresponding currency unit, or a monetary amount of a rate. Amount can be based on CDT: Amount. BaseQuantity can be a non-monetary numerical specification of an amount in a unit of measurement, or a quantity to which an amount refers.
BaseQuantity can be based on CDT: Quantity, Qualifier: Base. TransportationChargesRateTypeCode can be a coded representation of a TransportationChargeRate type. Examples include gross weight rate and net weight rate. TransportationChargesRateTypeCode can be based on GDT: TransportationChargesRateTypeCode. TransportationChargesRateRoleCode can be a coded representation of a role of a TransportationChargeRate. Examples include an invoice rate and a rate for calculation purposes. TransportationChargesRateRoleCode can be based on GDT: TransportationChargesRateRoleCode. TransportationChargesRateElementStatusCode can be a coded representation of a status of a transportation charges rate element. TransportationChargesRateElementStatusCode can be based on GDT: TransportationChargesRateElementStatusCode.
PercentElement can be a detail about a transportation charges element represented as a percentage. The structure of PercentElement includes the following elements: PercentRoleCode, Percent, TransportationChargesPercentCalculationBaseCode, and StatusCode. PercentRoleCode can be a coded representation of a role of a percent, and can be based on GDT: PercentRoleCode. Percent can be a number that relates to the comparison
AmountElement can represent a monetary aspect of a Transportation Charge. AmountElement can be a result of a transportation charge calculation. There can be a separate instance for each monetary amount per AmountRoleCode. AmountElement includes the RateElementAssignment entity. The structure of AmountElement includes the following elements: Amount, AmountRoleCode, and TransportationChargesAmountElementStatusCode. Amount can be an amount with a corresponding currency unit, and can be based on CDT: Amount. AmountRoleCode can be a coded representation of a role of an amount, and can be based on GDT: AmountRoleCode. TransportationChargesAmountElementStatusCode can be a coded representation of a status of an amount element of transportation charges or its transportation charges element. TransportationChargesAmountElementStatusCode can be based on GDT: TransportationChargesAmountElementStatusCode.
RateElementAssignment can be an assignment of an amount to a RateElement. TransportationChargesElementRateElementID can be a unique Identifier of a rate element of a transportation charges element. TransportationChargesElementRateElementID can be based on GDT: TransportationChargesElementRateElementID.
CalculationBase can be data which can be included with the RateDetail as a basis for calculating an Amount. The structure of CalculationBase includes the following elements: TransportationChargesElementCalculationBaseCode, BaseQuantity, BaseQuantityRoleCode, and BaseQuantityTypeCode. TransportationChargesElementCalculationBaseCode can be a coded representation of a calculation base of a transportation charges element. TransportationChargesElementCalculationBaseCode can be based on GDT: TransportationChargesElementCalculationBaseCode. BaseQuantity can be a non-monetary numerical specification of an amount in a unit of measurement. BaseQuantity can be the value of a calculation base as a quantity. BaseQuantity can be based on GDT: Quantity, Qualifier: Base. BaseQuantityRoleCode can be a coded representation of a role of a quantity. BaseQuantityRoleCode can be based on GDT: QuantityRoleCode. BaseQuantityTypeCode can be a coded representation of a type of quantity that is based on a measurable characteristic of an object or physical phenomenon. BaseQuantityTypeCode can be based on GDT: QuantityTypeCode.
TaxDetail can be tax-relevant information which is applicable for each ChargeElement. The structure of TaxDetail includes the ProductTax element. ProductTax can be a tax that is incurred for product-related business transactions, such as purchasing, sales, or consumption. The ProductTax can be used to display different tax components in calculated and invoiced amounts, and to inform about tax declarations and payments of a company to responsible tax authorities. ProductTax can be based on GDT: ProductTax. In some implementations, within TaxDetail, the BusinessTransactionDocumentItemGroupID of the GDT ProductTax is not used.
DateTimePeriod can specify a date, time and/or period related to a ChargeElement. The elements located directly at the DateTimePeriods entity include RequestedFulfillmentPeriod, AcceptableFulfillmentPeriod, and PeriodRoleCode. RequestedFulfillmentPeriod can be a period which is requested depending on semantics of the PeriodRoleCode. RequestedFulfillmentPeriod can be based on GDT: DATETIMEPERIOD, Qualifier: RequestedFulfillment. AcceptableFulfillmentPeriod can be a period which is acceptable depending on semantics of the PeriodRoleCode. AcceptableFulfillmentPeriod can be based on GDT: DATETIMEPERIOD, Qualifier: AcceptableFulfillment. PeriodRoleCode can be a coded representation of business semantics of the two periods defined by the entities RequestedFulfillmentPeriod and AcceptableFulfillmentPeriod. PeriodRoleCode can be based on GDT: PeriodRoleCode. In some implementations, RequestedFulfillmentPeriod and AcceptableFulfillmentPeriod are optional, but in every instance one of them may be filled.
CostDistribution can be information on how a ChargeElement can be allocated or distributed from a financial accounting point of view. The structure of CostDistribution includes the AccountingCodingBlockAssignment element. An AccountingCodingBlockAssignment can be an assignment of an item to a coding block. Items that are typically assigned to a coding block can be an amount that is known from context, a quantity, or a company resource such as office space or working time. A coding block can be a set of account assignment objects of different types. An account assignment object can be a business object to which value changes from business transactions are assigned in Accounting. AccountingCodingBlockAssignment can be based on GDT: AccountingCodingBlockAssignment.
In some implementations, the RequestForSupplierShipmentQuote package includes a SupplierFreightQuoteAssignmentInformation package which can include information for supplier freight quote assignments. The RequestForSupplierFreightQuoteAssignmentInformation package includes the TransportationStageAssignment and TransportationUnitResourceInformationAssignment entities.
TransportationStageAssignment can specify an assignment of the RequestForSupplierShipmentQuote to a stage of the RequestForSupplierFreightQuote. The structure of RequestForSupplierFreightQuoteAssignmentInformation includes the element RequestForSupplierFreightQuoteTransportationStageID. RequestForSupplierFreightQuoteTransportationStageID can be a unique identifier of a TransportationStage in a RequestForSupplierFreightQuote, and can be based on GDT: TransportationStageID. TransportationUnitResourceInformationAssignment can specify an assignment of a RequestForSupplierShipmentQuote to a TransportationUnitResourceInformation of a RequestForSupplierFreightQuote. The structure of TransportationUnitResourceInformationAssignment includes the element RequestForSupplierFreightQuoteTransportationUnitResourceInformationID. RequestForSupplierFreightQuoteTransportationUnitResourceInformationID can be a unique identifier of a TransportationUnitResourceInformation in a RequestForSupplierFreightQuote. RequestForSupplierFreightQuoteTransportationUnitResourceInformationID can be based on GDT: TransportationUnitResourceID.
The TransportationUnitResourceInformation package includes information regarding a transportation unit resource relevant for a shipment request (e.g., a container). The TransportationUnitResourceInformation package includes the TransportationUnitResourceInformation entity. TransportationUnitResourceInformation includes information on one or more transportation unit resources, such as a resource type and related properties, related measures or handling instructions. A Transportation Unit Resource can be a unit into which goods are loaded and/or from which goods are unloaded. In some implementations, this unit can provide transportation capacity for goods but might not move by itself. TransportationUnitResourceInformation includes the following entities: TransportationStageAssignment, AttachedEquipment, Quantity, Seal, BusinessTransactionDocumentReference, TextCollection, Location, and DangerousGoods. The structure of TransportationUnitResourceInformation includes the following elements: ID, ResourceNumberValue, ResourceID, ResourceHomeCountryCode, TransportationUnitResourceCategoryCode, TransportationUnitResourceTypeCode, FillLevelCode, ShippingTypeCode, HaulageArrangerCode, TransportationHandlingInstructionCode, and TransportationHandlingInstructionNote. ID can be a unique identifier for a resource information, and can be based on GDT ResourceInformationID. ResourceNumberValue can be a number of resources, and can be based on GDT: NumberValue, Qualifier: Resource. ResourceID can be a unique identifier for a resource, and can be based on GDT: ResourceID. ResourceHomeCountryCode can be a coded representation of the home country of a resource, and can be based on GDT: CountryCode, Qualifier: ResourceHome. TransportationUnitResourceCategoryCode can be a coded representation of a category of transportation unit resources, and can be based on GDT: TransportationUnitResourceCategoryCode. TransportationUnitResourceTypeCode can be a coded representation of a transportation unit resource type.
TransportationUnitResourceTypeCode can be based on GDT: TransportationUnitResourceTypeCode. FillLevelCode can be a coded representation of a fill level of a resource, and can be based on GDT: FillLevelCode. ShippingTypeCode can be a coded representation of a shipping type. A shipping type can specify how planning and execution of a transportation can be performed. Transportation terms include detailed specifications on agreed means of transportation, such as shipping or transport type and means of transport to be used. ShippingTypeCode can be based on GDT: ShippingTypeCode. HaulageArrangerCode can be a coded representation of an arranger of a haulage. Haulage can be inland transport of cargo. HaulageArrangerCode can be based on GDT: HaulageArrangerCode. TransportationHandlingInstructionCode can be a coded representation of a type of a transportation handling instruction, and can be based on GDT: TransportationHandlingInstructionCode. TransportationHandlingInstructionNote can be a note regarding a transportation handling instruction, and can be based on GDT: LONG_Note, Qualifier: TransportationHandlingInstruction.
TransportationStageAssignment can specify an assignment of a transportation stage to a transportation unit resource information. The structure of TransportationStageAssignment includes the ShipmentRequestTransportationStageID element. ShipmentRequestTransportationStageID can be a unique identifier of a TransportationStage in a shipment request, and can be based on GDT: TransportationStageID.
AttachedEquipment can specify equipment attached to a TransportationUnitResource. The structure of AttachedEquipment includes the element ShipmentRequestResourceInformationID. ShipmentRequestResourceInformationID can be a unique identifier of a resource information in a ShipmentRequest, and can be based on GDT: ResourceInformationID.
Quantity can specify a quantity related to TransportationUnitResourceInformation. The structure of the Quantity entity includes the following elements: Quantity, RoleCode, and TypeCode. Quantity can be a non-monetary numerical specification of an amount in a unit of measurement. Quantity can be based on GDT: Quantity. RoleCode can be a coded representation of a role of a quantity, and can be based on GDT: QuantityRoleCode. TypeCode can be a coded representation of a type of quantity that is based on a measurable characteristic of an object or physical phenomenon. TypeCode can be based on GDT: QuantityTypeCode. In some implementations, QuantityRoleCode and QuantityTypeCode are optional, but in every instance one of them may be filled.
Seal can specify a seal related to a TransportationUnitResource. The structure of Seal includes the following elements: ID, PartyRoleCode, PartyFormattedName, and StatusCode. ID can be a unique identifier of a seal, and can be based on GDT: SealID. PartyRoleCode can be a coded representation of a party role, and can be based on GDT: PartyRoleCode. PartyFormattedName can be a complete, formatted name of a party, or the name of a SealingParty. PartyFormattedName can be based on GDT: LONG_Name, Qualifier: PartyFormatted. StatusCode can be a coded representation of a status of a seal, and can be based on GDT: SealStatusCode.
BusinessTransactionDocumentReference can specify a business document reference that is related to a TransportationUnitResource. BusinessTransactionDocumentReference includes the DateTimePeriod entity. The structure of the BusinessTransactionDocumentReference entity includes the following elements: BusinessTransactionDocumentReference, BusinessTransactionDocumentRelationshipRoleCode, BusinessTransactionDocumentRelationshipTypeCode, TransportationDocumentTypeCode, TransportationDocumentNote, and TransportationDocumentID. BusinessTransactionDocumentReference can be a unique reference to other business documents or business document items that are of significance within each respective business process. BusinessTransactionDocumentReference can be based on GDT: BusinessTransactionDocumentReference. BusinessTransactionDocumentRelationshipRoleCode can be a coded representation of a role that a business document or a business document item has when set against another business document or business document item with a relationship. BusinessTransactionDocumentRelationshipRoleCode can be based on GDT: BusinessTransactionDocumentRelationshipRoleCode. BusinessTransactionDocumentRelationshipTypeCode can be a coded representation of a relationship between two business documents or business document items. BusinessTransactionDocumentRelationshipTypeCode can be based on GDT: BusinessTransactionDocumentRelationshipTypeCode.
TransportationDocumentTypeCode can be a coded representation of a documentation type. TransportationDocumentTypeCode can be based on GDT: TransportationDocumentTypeCode. TransportationDocumentNote can be a short Note on documentation. TransportationDocumentNote can be based on GDT: SHORT_Note. TransportationDocumentID can be a unique identifier for a transportation document. TransportationDocumentID can be based on GDT: TransportationDocumentID. RelationshipTypeCode and RelationshipRoleCode are both optional. In some implementations, if used, both may be filled. Either the combination BusinessTransactionDocumentReference, BusinessTransactionDocumentRelationshipRoleCode, BusinessTransactionDocumentRelationshipTypeCode or TransportationDocumentTypeCode, TransportationDocumentNote, TransportationDocumentID may be filled.
DateTimePeriod can specify a date, time and/or period related to a BusinessTransactionDocumentReference. The elements located directly at the DateTimePeriods entity include RequestedFulfillmentPeriod, AcceptableFulfillmentPeriod, and PeriodRoleCode. RequestedFulfillmentPeriod can be a period which is requested depending on semantics of the PeriodRoleCode. RequestedFulfillmentPeriod can be based on GDT: DATETIMEPERIOD, Qualifier: RequestedFulfillment. AcceptableFulfillmentPeriod can be a period which is acceptable depending on semantics of a PeriodRoleCode. AcceptableFulfillmentPeriod can be based on GDT: DATETIMEPERIOD, Qualifier: AcceptableFulfillment. PeriodRoleCode can be a coded representation of business semantics of the two periods defined by the entities RequestedFulfillmentPeriod and AcceptableFulfillmentPeriod. PeriodRoleCode can be based on GDT: PeriodRoleCode. In some implementations, RequestedFulfillmentPeriod and AcceptableFulfillmentPeriod are optional, but in every instance one of them may be filled.
TextCollection can be a group of textual information that relates to a TransportationUnitResource. The structure of the TextCollection entity includes the TextCollection element. TextCollection can be based on GDT: TextCollection.
Location can specify a physical place related to the TransportationUnitResource. The structure of Location includes the following elements: Location, RoleCode, TypeCode, and Name. Location includes information exchanged in business documents about a location relevant for business transactions. Location can be based on GDT: BusinessTransactionDocumentLocation. RoleCode can be a coded representation of a LocationRole, and can be based on GDT: LocationRoleCode. TypeCode can be a coded representation of a type of a physical location. TypeCode can be based on GDT: LocationTypeCode. Name can be a name of a location, and can be based on GDT: MEDIUM_Name, Qualifier:Location.
DateTimePeriods can specify a requested and an acceptable date, time and period related to a Location of a resource. The elements located directly at the DateTimePeriods entity include RequestedFulfillmentPeriod, AcceptableFulfillmentPeriod, and PeriodRoleCode. RequestedFulfillmentPeriod can be a period which is requested depending on semantics of the PeriodRoleCode. RequestedFulfillmentPeriod can be based on GDT: DATETIMEPERIOD, Qualifier: RequestedFulfillment. AcceptableFulfillmentPeriod can be a period which is acceptable depending on semantic of the PeriodRoleCode. AcceptableFulfillmentPeriod can be based on GDT: DATETIMEPERIOD, Qualifier: AcceptableFulfillment. PeriodRoleCode can be a coded representation of business semantics of the two periods defined by the entities RequestedFulfillmentPeriod and AcceptableFulfillmentPeriod. PeriodRoleCode can be based on GDT: PeriodRoleCode. In some implementations, RequestedFulfillmentPeriod and AcceptableFulfillmentPeriod are optional, but in every instance one of them may be filled.
DangerousGoods can specify dangerous goods included in a resource. DangerousGoods includes the ContactInformation and TextCollection entities. The structure of DangerousGoods includes the following elements: ID, RegulationsCode, HazardCode, FlashpointMeasureInterval, PackagingGroupCode, EmergencySchedule, TransportEmergencyCardCode, DangerousGoodsLabelCode, DangerousGoodsLabelCode2, DangerousGoodsLabelCode3, PackagingInstructionTypeCode, TransportMeansDescriptionCode, and TransportAuthorisationCode. ID can be a unique identifier for a dangerous good, using the United Nations Dangerous Goods Number. ID can be based GDT: DangerousGoodsID. RegulationsCode can be a coded representation of national or international dangerous goods rules or regulations, and can be based on GDT: DangerousGoodsRegulationsCode. HazardCode can be a coded representation of a hazard that is imminent in a dangerous good. HazardCode can be based on GDT: DangerousGoodsHazardCode. FlashpointMeasureInterval can be an interval of measures defined by a lower and an upper boundary indicating a flashpoint of a dangerous good.
FlashpointMeasureInterval can be based on GDT: MeasureInterval, Qualifier: Flashpoint. PackagingGroupCode can be a coded representation of the effectiveness of a packaging to transport dangerous goods depending on the degree of danger of the goods. PackagingGroupCode can be based on GDT: DangerousGoodsPackagingGroupCode. EmergencySchedule can be a coded representation of an emergency schedule for dangerous goods. EmergencySchedule can identify an emergency schedule. The DangerousGoodsEmergencySchedule can be used for transports of dangerous goods by sea similar to a Transport Emergency Card which is used for transports of dangerous goods by road. EmergencySchedule can be based on GDT: DangerousGoodsEmergencySchedule. TransportEmergencyCardCode can be a coded representation of a transport emergency card which specifies how to react in case of an accident. TransportEmergencyCardCode can be based on GDT: TransportEmergencyCardCode.
DangerousGoodsLabelCode can be a coded representation of a label for a dangerous good. In some implementations, DangerousGoodsLabelCode's values are dependant on the DangerousGoodsRegulationsCode. DangerousGoodsLabelCode can be based on GDT: DangerousGoodsLabelCode. DangerousGoodsLabelCode2 can be a coded representation of a label for a dangerous good. In some implementations, DangerousGoodsLabelCode's values are dependant on the DangerousGoodsRegulationsCode. DangerousGoodsLabelCode2 can be based on GDT: DangerousGoodsLabelCode. DangerousGoodsLabelCode3 can be a coded representation of a label for a dangerous good. In some implementations, DangerousGoodsLabelCode's values are dependant on the DangerousGoodsRegulationsCode. DangerousGoodsLabelCode3 can be based on GDT: DangerousGoodsLabelCode.
PackagingInstructionTypeCode can be a coded representation of a packaging instruction. In some implementations, a packaging instruction is an instruction defining which packagings may be used to pack a dangerous good. PackagingInstructionTypeCode can be based on GDT: PackagingInstructionTypeCode. TransportMeansDescriptionCode can be a coded representation of a transport means type with which goods or persons can be transported. TransportMeansDescriptionCode can be based on GDT: TransportMeansDescriptionCode. TransportAuthorisationCode can be a coded representation of an authorisation for the transportation of dangerous goods. This code can specify an authorisation for the transportation of a particular dangerous good. TransportAuthorisationCode can be based on GDT: DangerousGoodsTransportAuthorisationCode.
ContactInformation can specify information on a department or person to whom information regarding dangerous goods can be directed. The structure of ContactInformation includes the ContactPersonFunctionTypeCode and Address elements. ContactPersonFunctionTypeCode can be a coded representation of a type of function that a contact person has. ContactPersonFunctionTypeCode can be based on GDT: ContactPersonFunctionTypeCode. Address can be an address related to contact information defined by a corresponding FunctionTypeCode. Address can be based on GDT: Address.
TextCollection can be a group of textual information that relates to the DangerousGoods. The structure of the TextCollection entity includes the TextCollection element. TextCollection can be based on GDT: TextCollection.
The message data type RequestForSupplierFreightQuoteCancelRequestMessage can group together business information relevant for sending a business document in a message, and the RequestForSupplierFreightQuote object in a business document. The message data type RequestForSupplierFreightQuoteCancelRequestMessage includes the MessageHeader and RequestForSupplierFreightQuote packages.
A MessageHeader package can group together business information relevant for sending a business document in a message. The MessageHeader package includes the MessageHeader entity. A MessageHeader can group together business information from a perspective of the sending application, to identify a business document in a message, to provide information about the sender, and to provide information about the recipient. The MessageHeader can be divided up into the SenderParty and RecipientParty entities. MessageHeader can be of type GDT: BusinessDocumentMessageHeader. The MessageHeader includes the following elements: ID, ReferenceID, and CreationDateTime. The MessageID can be set by the sending application. With the ReferencedMessageID, reference can be made in the current BusinessDocument to a previous BusinessDocument.
A SenderParty can be a party responsible for sending a business document at a business application level. The SenderParty can be of type GDT: BusinessDocumentMessageHeaderParty. The SenderParty includes the following elements: InternalID, StandardID, and ContactPerson. The SenderParty can be filled by the sending application to name a contact person for problems with the message. A contact person can be useful if an additional infrastructure, such as a marketplace, is located between the sender and the recipient. The SenderParty can be used to transfer a message and can be ignored by the receiving application. SenderParty can be filled by the sender if the participating parties are not transferred with the ShipmentRequest package.
A RecipientParty can be a party responsible for receiving a business document at a business application level. The RecipientParty can be of type GDT: BusinessDocumentMessageHeaderParty. The RecipientParty includes the following elements: InternalID, StandardID, and ContactPerson. The RecipientParty can be filled by the sending application to name a contact person for problems that may occur with the message. A contact person can be useful if an additional infrastructure, such as a marketplace, is located between the sender and the recipient. The RecipientParty can be used to transfer a message and can be ignored by the receiving application. RecipientParty can be filled by the sender if the ShipmentRequest package cannot be used to transfer the participating parties
The RequestForSupplierFreightQuote package can group together information about the RequestForSupplierFreightQuote. The RequestForSupplierFreightQuote package includes the RequestForSupplierFreightQuote entity. RequestForSupplierFreightQuote can be a request from an ordering party to a supplier of a transportation service to submit a quote for the transportation of goods from one or more ship-from parties to one or more ship-to parties with requested terms and conditions. The structure of RequestForSupplierFreightQuote includes the ID element. ID can be a unique identifier for a RequestForSupplierFreightQuote. ID can be based on GDT: BusinessTransactionDocumentID.
A SupplierFreightQuote can be part of a Transportation Management subcontracting and tendering process, where transportation services can be tendered between transportation service providers. The terms and conditions of a transportation service, as well as the bidding rules of the tendering process, are included in the RequestForSupplierFreightQuote. The response of a supplier of a transportation service to a customer is included in the SupplierFreightQuote. A supplier, such as Transportation Customer Quote Processing, can respond to a customer, such as Transportation Supplier Quote Processing, with a freight quote by using the interfaces described below.
A SupplierFreightQuoteNotification can be a notification from a Supplier about a SupplierFreightQuote. The structure of the SupplierFreightQuoteNotification can be specified by the message data type SupplierFreightQuoteNotificationMessage. The message interface on the Supplier side includes SupplierFreightQuoteNotification_Out. The message interface on the Customer side includes SupplierFreightQuoteNotification_In.
The message choreography of
Additionally,
The message data type SupplierFreightQuoteNotificationMessage includes business information relevant for sending a business document in a message and a SupplierFreightQuote included in a business document. The message data type SupplierFreightQuoteNotificationMessage includes the MessageHeader and SupplierFreightQuote packages.
A MessageHeader package can group together business information relevant for sending a business document in a message. The MessageHeader package includes the MessageHeader entity. A MessageHeader can group together business information from a perspective of the sending application to identify a business document in a message, to provide information about the sender, and to provide information about a recipient. The MessageHeader can be divided up into the SenderParty and RecipientParty. MessageHeader can be of type GDT: BusinessDocumentMessageHeader. The MessageHeader includes the following elements: ID, ReferenceID, and CreationDateTime. The MessageID can be set by the sending application. With the ReferencedMessageID, reference can be made in the current BusinessDocument to a previous BusinessDocument.
A SenderParty can be a party responsible for sending a business document at a business application level. The SenderParty can be of type GDT: BusinessDocumentMessageHeaderParty. The SenderParty includes the following elements: InternalID, StandardID, and ContactPerson. The SenderParty can be filled by the sending application to name a contact person for problems with a message. A contact person can be useful if an additional infrastructure, such as a marketplace, is located between the sender and the recipient. The SenderParty can be used to transfer a message and can be ignored by the receiving application. SenderParty can be filled by the sender if the participating parties are not transferred with the ShipmentRequest package.
A RecipientParty can be a party responsible for receiving a business document at a business application level. The RecipientParty can be of type GDT: BusinessDocumentMessageHeaderParty. The RecipientParty includes the following elements: InternalID, StandardID, and ContactPerson. The RecipientParty can be filled by the sending application to name a contact person for problems that may occur with a message. A contact person can be useful if an additional infrastructure, such as a marketplace, is located between the sender and the recipient. The RecipientParty can be used to transfer a message and can be ignored by the receiving application. In some implementations, RecipientParty may be filled by the sender if the ShipmentRequest package cannot be used to transfer the participating parties.
The SupplierFreightQuote package can group the SupplierFreightQuote together with its packages. The SupplierFreightQuote package includes the SupplierFreightQuote entity and the following packages: HeaderInformation, GovernmentalRequirementInformation, PartyInformation, TransportationStageInformation, TransportationUnitResourceInformation, TransportationChargesInformation, and SupplierShipmentQuote.
SupplierFreightQuote can be a quote from a supplier to an ordering party of a transportation service for the transportation of goods from one or more ship-from parties to one or more ship-to parties with requested terms and conditions. The structure of SupplierFreightQuote includes the ID element. ID can be a unique identifier for a SupplierFreightQuote. ID can be based on GDT: BusinessTransactionDocumentID.
The HeaderInformation package can group dates, total values, documents and references related to a shipment request. The HeaderInformation package includes the following entities: DateTimePeriods, NatureOfCargo, TotalQuantity, TotalAmount, TextCollection, TransportationServiceRequirement, TransportationDocumentInformation, and BusinessTransactionDocumentReference.
DateTimePeriods can specify a requested and an acceptable date, time and period applying to a shipment request (e.g. date and time of document issue). A requested period can be a period in which an event is requested to take place. An acceptable period can be a period in which an event may take place at an earliest start date/time to a latest end date/time. The elements located directly at the DateTimePeriods entity include RequestedFulfillmentPeriod, AcceptableFulfillmentPeriod, and PeriodRoleCode. RequestedFulfillmentPeriod can be a period which is requested depending on semantics of the PeriodRoleCode. RequestedFulfillmentPeriod can be based on GDT: DATETIMEPERIOD, Qualifier: RequestedFulfillment. AcceptableFulfillmentPeriod can be a period which is acceptable depending on semantics of the PeriodRoleCode. AcceptableFulfillmentPeriod can be based on GDT: DATETIMEPERIOD, Qualifier: AcceptableFulfillment. PeriodRoleCode can be a coded representation of business semantics of the two periods defined by the entities RequestedFulfillmentPeriod and AcceptableFulfillmentPeriod. PeriodRoleCode can be based on GDT: PeriodRoleCode. In some implementations, RequestedFulfillmentPeriod and AcceptableFulfillmentPeriod are optional, but in every instance one of them may be filled.
NatureOfCargo can indicate a nature of cargo related to a shipment request (e.g., palletized, containerized, documents). The structure of NatureOfCargo includes the ClassificationCode element. ClassificationCode can be a coded representation of a classification of a nature of cargo. ClassificationCode can be based on GDT: NatureOfCargoClassificationCode.
TotalQuantity can specify a total quantity which is related to a whole shipment request (e.g., total number of equipment, total number of items). The structure of TotalQuantity includes the following elements: Quantity, RoleCode, and TypeCode. Quantity can be a non-monetary numerical specification of an amount in a unit of measurement. Quantity can be based on GDT: Quantity. RoleCode can be a coded representation of a role of a quantity. RoleCode can be based on GDT: QuantityRoleCode. TypeCode can be a coded representation of a type of quantity that is based on a measurable characteristic of an object or physical phenomenon. TypeCode can be based on GDT: QuantityTypeCode. In some implementations, QuantityRoleCode and QuantityTypeCode are optional, but in every instance one of them may be filled.
TotalAmount can specify a cumulated monetary amount related to a shipment request (e.g., duty amount, insurance amount, total value). The structure of TotalAmount includes the Amount and RoleCode elements. Amount can be an amount with a corresponding currency unit. Amount can be based on CDT: Amount. RoleCode can be a coded representation of a role of an amount. RoleCode can be based on GDT: AmountRoleCode.
TextCollection can be a group of textual information that relates to a shipment request. The structure of the TextCollection entity includes the TextCollection element. TextCollection can be based on GDT: TextCollection.
TransportationServiceRequirement can specify a contract and carriage condition and service and priority requirements for a transport which apply to a whole shipment request. The structure of TransportationServiceRequirement includes the following elements: TransportationServiceRequirementCode, AdditionalTransportationServiceRequirementCode, TransportationContractConditionCode, TransportServiceLevelCode, and NatureOfCargoClassificationCode. TransportationServiceRequirementCode can be a coded representation of a requirement related to a transportation service. TransportationServiceRequirementCode can be based on GDT : TransportationServiceRequirementCode.
AdditionalTransportationServiceRequirementCode can be a coded representation of an additional requirement related to a transportation service. AdditionalTransportationServiceRequirementCode can be based on GDT : TransportationServiceRequirementCode, Qualifier: Additional. TransportationContractConditionCode can be a coded representation of a contract and carriage condition. TransportationContractConditionCode can be based on GDT: TransportationContractConditionCode. TransportServiceLevelCode can be a coded representation of agreed or defined services in terms of the delivery of goods with respect to the speed of the delivery. TransportServiceLevelCode can be based on GDT: TransportServiceLevelCode. NatureOfCargoClassificationCode can be a coded representation of the classification of a nature of cargo. NatureOfCargoClassificationCode can be based on GDT : NatureOfCargoClassificationCode.
TransportationDocumentInformation can specify information on a transportation document related to a shipment request. TransportationDocumentInformation includes the DateTimePeriod entity. TransportationDocumentTypeCode can be a coded representation of a documentation type. TransportationDocumentTypeCode can be based on GDT: TransportationDocumentTypeCode. TransportationDocumentNote can be a short note on documentation. TransportationDocumentNote can be based on GDT: SHORT_Note. TransportationDocumentID can be a unique identifier for a transportation document. TransportationDocumentID can be based on GDT: TransportationDocumentID. TransportationDocumentStatusCode can be a coded representation of a status of a transportation document (e.g., to be printed, document complete).
TransportationDocumentStatusCode can be based on GDT: TransportationDocumentStatusCode. LanguageCode can be a coded representation of the language of a documentation. LanguageCode can be based on GDT: LanguageCode. CommunicationMediumTypeCode can be a coded representation of the type of a medium used for communication of documentation, such as Fax, mail, EDI, or Letter. CommunicationMediumTypeCode can be based on GDT : CommunicationMediumTypeCode. RequiredIndicator can indicate whether a documentation is required or not. RequiredIndicator can be based on GDT: Indicator Qualifier: Required.
OutputCopyNumberValue can be a number specifying the number of copies of a document that may be issued. OutputCopyNumberValue can be based on GDT: NumberValue, Qualifier : OutputCopy. OutputOriginalNumberValue can be a number specifying the number of originals of a document that may be issued. OutputOriginalNumberValue can be based on GDT: NumberValue, Qualifier: OutputOriginal. In some implementations, TypeCode and TypeDescription are both optional, but at least one of them may be used. In some implementations, if the RequiredIndicator is set to true, at least one of the NumberValues OutputCopyNumberValue or OutputOriginalNumberValue may be filled.
DateTimePeriod can specify a date, time and/or period (e.g., validity date) related to required business documentation. The structure of the DateTimePeriod entity includes the DateTimePeriod and PeriodRoleCode elements. DateTimePeriod can be a period that is defined by two points in time. DateTimePeriod can be based on GDT: DateTimePeriod. PeriodRoleCode can be a coded representation of business semantics of a period. PeriodRoleCode can be based on GDT: PeriodRoleCode.
BusinessTransactionDocumentReference can specify a business document reference related to a whole shipment request. BusinessTransactionDocumentReference includes the DateTimePeriod entity. The structure of the BusinessTransactionDocumentReference entity includes the following elements: BusinessTransactionDocumentReference, BusinessTransactionDocumentRelationshipRoleCode, BusinessTransactionDocumentRelationshipTypeCode, TransportationDocumentTypeCode, TransportationDocumentNote, and TransportationDocumentID. BusinessTransactionDocumentReference can be a unique reference to other business documents or business document items that are of significance within each respective business process. BusinessTransactionDocumentReference can be based on GDT: BusinessTransactionDocumentReference.
BusinessTransactionDocumentRelationshipRoleCode can be a coded representation of a role that a business document or a business document item has when set against another business document or business document item with a relationship. BusinessTransactionDocumentRelationshipRoleCode can be based on GDT: BusinessTransactionDocumentRelationshipRoleCode. BusinessTransactionDocumentRelationshipTypeCode can be a coded representation of a relationship between two business documents or business document items. BusinessTransactionDocumentRelationshipTypeCode can be based on GDT: BusinessTransactionDocumentRelationshipTypeCode. TransportationDocumentTypeCode can be a coded representation of a documentation type.
TransportationDocumentTypeCode can be based on GDT: TransportationDocumentTypeCode. TransportationDocumentNote can be a short note on documentation. TransportationDocumentNote can be based on GDT: SHORT_Note. TransportationDocumentID can be a unique identifier for a transportation document. TransportationDocumentID can be based on GDT: TransportationDocumentID. In some implementations, RelationshipTypeCode and RelationshipRoleCode are both optional. If used, both may be filled. Either the combination BusinessTransactionDocumentReference, BusinessTransactionDocumentRelationshipRoleCode, BusinessTransactionDocumentRelationshipTypeCode, or TransportationDocumentTypeCode, TransportationDocumentNote, TransportationDocumentID may be filled.
DateTimePeriod can specify a date, time and/or period related to a DocumentReference. The structure of the DateTimePeriod entity includes the DateTimePeriod and PeriodRoleCode elements. DateTimePeriod can be a period that is defined by two points in time. DateTimePeriod can be based on GDT: DateTimePeriod. PeriodRoleCode can be a coded representation of business semantics of a period. PeriodRoleCode can be based on GDT: PeriodRoleCode. PeriodRoleCode includes the modified entity BusinessTransactionDocumentReference.
BusinessTransactionDocumentReference can specify a business document reference related to a whole shipment request. BusinessTransactionDocumentReference includes the DateTimePeriod entity. The structure of the BusinessTransactionDocumentReference entity includes the following elements: BusinessTransactionDocumentReference, BusinessTransactionDocumentRelationshipRoleCode, BusinessTransactionDocumentRelationshipTypeCode, TransportationDocumentTypeCode, TransportationDocumentNote, and TransportationDocumentID. BusinessTransactionDocumentReference can be a unique reference to other business documents or business document items that are of significance within each respective business process. BusinessTransactionDocumentReference can be based on GDT: BusinessTransactionDocumentReference.
BusinessTransactionDocumentRelationshipRoleCode can be a coded representation of a role that a business document or a business document item has when set against another business document or business document item with a relationship. BusinessTransactionDocumentRelationshipRoleCode can be based on GDT: BusinessTransactionDocumentRelationshipRoleCode. BusinessTransactionDocumentRelationshipTypeCode can be a coded representation of a relationship between two business documents or business document items. BusinessTransactionDocumentRelationshipTypeCode can be based on GDT: BusinessTransactionDocumentRelationshipTypeCode. TransportationDocumentTypeCode can be a coded representation of a documentation type.
TransportationDocumentTypeCode can be based on GDT: TransportationDocumentTypeCode. TransportationDocumentNote can be a short note on documentation. TransportationDocumentNote can be based on GDT: SHORT_Note. TransportationDocumentID can be a unique identifier for a transportation document. TransportationDocumentID can be based on GDT: TransportationDocumentID. In some implementations, RelationshipTypeCode and RelationshipRoleCode are both optional. If used, both may be filled. Either the combination BusinessTransactionDocumentReference, BusinessTransactionDocumentRelationshipRoleCode, BusinessTransactionDocumentRelationshipTypeCode, or TransportationDocumentTypeCode, TransportationDocumentNote, TransportationDocumentID, may be filled. The additional entity RequestForSupplierFreightQuoteAcceptanceStatus may be included.
RequestForSupplierFreightQuoteAcceptanceStatus can specify an acceptance status of a referenced request for a supplier freight quote. The structure of RequestForSupplierFreightQuoteAcceptanceStatus includes the AcceptanceStatusCode and RequestForQuoteRejectionReasonCode elements. The AcceptanceStatusCode can be a coded representation of a status of an acceptance by a communication partner regarding a business transaction that has been transmitted to that partner. AcceptanceStatusCode can be based on GDT: AcceptanceStatusCode. The RequestForQuoteRejectionReasonCode can be a coded representation of a reason for rejection of a request for a supplier freight quote. RequestForQuoteRejectionReasonCode can be based on GDT: RequestForQuoteRejectionReasonCode. In some implementations, the AcceptanceStatusCode values ‘AP’ (accepted) and ‘RE’ (rejected) are supported.
GovernmentalProcedureInformation can specify applicable governmental procedures related to import, export and transport of the goods of a shipment request. GovernmentalProcedureInformation includes the GovernmentalProcedure entity. GovernmentalProcedure can specify applicable governmental procedures related to import, export and transport of the goods of a shipment request. GovernmentalProcedure includes the following entities: Location, DateTimePeriod, Seal, TextCollection, and TransportationDocumentInformation. The structure of GovernmentalProcedure includes the following elements: TransportationGovernmentAgencyTypeCode, TransportationMovementTypeCode, TransportationGovernmentAgencyInvolvementStatusCode, TransportationGovernmentAgencyActionCode, and TransportationGovernmentAgencyProcedureStatusCode.
TransportationGovernmentAgencyTypeCode can be a coded representation of the type of a government agency, and can be based on GDT: TransportationGovernmentAgencyTypeCode. TransportationMovementTypeCode can be a coded representation of the type of a transport movement (e.g., Import, Export, Transit, Transshipment). TransportationMovementTypeCode can be based on GDT: TransportationMovementTypeCode. TransportationGovernmentAgencyInvolvementStatusCode can be a coded representation for an involvement status of a transportation related government agency. TransportationGovernmentAgencyInvolvementStatusCode can be based on GDT: TransportationGovernmentAgencyInvolvementStatusCode.
TransportationGovernmentAgencyActionCode can be a coded representation of an action of a transportation related government agency. TransportationGovernmentAgencyActionCode can be based on GDT: TransportationGovernmentAgencyActionCode. TransportationGovemmentAgencyProcedureStatusCode can be a coded representation of a status of a procedure related to a transportation government agency. TransportationGovernmentAgencyProcedureStatusCode can be based on GDT: TransportationGovernmentAgencyProcedureStatusCode.
Location can be a physical place related to a GovernmentalProcedure. The structure of the Location entity includes the following elements: Location, RoleCode, TypeCode, and Name. Location includes information exchanged in business documents about a location relevant for business transactions. Location can be based on GDT: BusinessTransactionDocumentLocation. RoleCode can be a coded representation of a LocationRole. RoleCode can be based on GDT: LocationRoleCode. TypeCode can be a coded representation of a type of a physical location. TypeCode can be based on GDT: LocationTypeCode. Name can be a name of a location. Name can be based on GDT: MEDIUM_Name, Qualifier:Location.
DateTimePeriod specifies a date, time and/or period related to a GovernmentalProcedure. The structure of DateTimePeriod includes the DateTimePeriod and PeriodRoleCode elements. DateTimePeriod can be a period that is defined by two points in time. DateTimePeriod can be based on GDT: DateTimePeriod. PeriodRoleCode can be a coded representation of business semantics of a period. PeriodRoleCode can be based on GDT: PeriodRoleCode.
TextCollection can be a group of textual information that relates to a GovernmentalProcedure. The structure of the TextCollection entity includes the TextCollection element. TextCollection can be based on GDT: TextCollection.
TransportationDocumentInformation can specify information on a transportation document related to the GovernmentalProcedure. TransportationDocumentInformation includes the DateTimePeriod entity. The structure of the TransportationDocumentInformation entity includes the following elements: TransportationDocumentTypeCode, TransportationDocumentNote, TransportationDocumentID, TransportationDocumentStatusCode, LanguageCode, CommunicationMediumTypeCode, RequiredIndicator, OutputCopyNumberValue, and OutputOriginalNumberValue. TransportationDocumentTypeCode can be a coded representation of a documentation type. TransportationDocumentTypeCode can be based on GDT: TransportationDocumentTypeCode.
TransportationDocumentNote can be a short note on documentation. TransportationDocumentNote can be based on GDT: SHORT_Note. TransportationDocumentID can be a unique identifier for a transportation document. TransportationDocumentID can be based on GDT: TransportationDocumentID. TransportationDocumentStatusCode can be a coded representation of a status of a transportation document (e.g., to be printed, document complete). TransportationDocumentStatusCode can be based on GDT: TransportationDocumentStatusCode. LanguageCode can be a coded representation of the language of a documentation. LanguageCode can be based on GDT: LanguageCode. CommunicationMediumTypeCode can be a coded representation of the type of a medium used for communication of the documentation, such as Fax, mail, EDI, or Letter. CommunicationMediumTypeCode can be based on GDT: CommunicationMediumTypeCode.
RequiredIndicator can indicate whether a documentation is required or not. RequiredIndicator can be based on GDT: Indicator Qualifier: Required. OutputCopyNumberValue can be a number specifying the number of copies of a document that may be issued. OutputCopyNumberValue can be based on GDT: NumberValue, Qualifier : OutputCopy. OutputOriginalNumberValue can be a number specifying the number of originals of a document that may be issued. OutputOriginalNumberValue can be based on GDT: NumberValue, Qualifier : OutputOriginal. In some implementations, TypeCode and TypeDescription are both optional, but at least one of them may be used. In some implementations, if the RequiredIndicator is set to true, at least one of the NumberValues OutputCopyNumberValue or OutputOriginalNumberValue may be filled.
DateTimePeriod can specify a date, time and/or period related to documentation. The structure of the DateTimePeriod entity includes the DateTimePeriod and PeriodRoleCode elements. DateTimePeriod can be a period that is defined by two points in time. DateTimePeriod can be based on GDT: DateTimePeriod. PeriodRoleCode can be a coded representation of business semantics of a period. PeriodRoleCode can be based on GDT: PeriodRoleCode.
The PartyInformation package includes information regarding a party of a shipment request (e.g., Shipper, Carrier, Agent). PartyInformation includes the Party entity. Party includes information exchanged, in accordance with common business understanding, in business documents, about a party involved in business transactions. This information can be used to identify the party and the party's address, as well as the party's contact person and the contact person's address. This identification can take place using an internal ID, a standardized ID, or IDs assigned by the parties involved. The Party entity includes the following entities: Amount, DateTimePeriods, TransportationDocumentInformation, and BusinessTransactionDocumentReference. The structure of the Party entity includes the following elements: Party, RoleCode, and FormattedName.
A Party includes information exchanged, in accordance with common business understanding, in business documents, about a party involved in business transactions. This information can be used to identify the party and the party's address, as well as the party's contact person and the contact person's address. This identification can take place using an internal ID, a standardized ID, or IDs assigned by the parties involved. Party can be based on GDT: BusinessTransactionDocumentParty. RoleCode can be a coded representation of a PartyRoleCode which specifies which rights and obligations the party has regarding a business object and corresponding processes. In some implementations, a PartyRole is assigned to exactly one PartyRoleCategory and refines its semantics. RoleCode can be based on GDT: PartyRoleCode. FormattedName can be a complete, formatted name of a party. FormattedName can be based on GDT: LONG_Name, Qualifier: PartyFormatted.
Amount can specify an amount related to a party. Amount can be an amount with a corresponding currency unit, and can be based on CDT: Amount. RoleCode can be a coded representation of a role of an amount, and can be based on GDT: AmountRoleCode.
DateTimePeriods can specify a requested and an acceptable date, time and period related to a party. A requested period can be a period in which an event is requested to take place. An acceptable period can be a period in which an event may take place at an earliest start date/time to a latest end date/time. The elements located directly at the DateTimePeriods entity include RequestedFulfillmentPeriod, AcceptableFullfilmentPeriod, and PeriodRoleCode. RequestedFulfillmentPeriod can be a period which is requested depending on semantics of the PeriodRoleCode. RequestedFulfillmentPeriod can be based on GDT: DATETIMEPERIOD, Qualifier: RequestedFulfillment.
AcceptableFulfillmentPeriod can be a period which is acceptable depending on semantics of the PeriodRoleCode. AcceptableFulfillmentPeriod can be based on GDT: DATETIMEPERIOD, Qualifier: AcceptableFulfillment. PeriodRoleCode can be a coded representation of business semantics of the two periods defined by the entities RequestedFulfillmentPeriod and AcceptableFulfillmentPeriod. PeriodRoleCode can be based on GDT: PeriodRoleCode. In some implementations, RequestedFulfillmentPeriod and AcceptableFulfillmentPeriod are optional, but in every instance one of them may be filled.
TransportationDocumentInformation can specify business documentation related to a party according to a documentation type. TransportationDocumentInformation includes the DateTimePeriod entity. The structure of TransportationDocumentInformation includes the following elements: TransportationDocumentTypeCode, TransportationDocumentNote, TransportationDocumentID, TransportationDocumentStatusCode, LanguageCode, CommunicationMediumTypeCode, RequiredIndicator, OutputCopyNumberValue, and OutputOriginalNumberValue. TransportationDocumentTypeCode can be a coded representation of a documentation type. TransportationDocumentTypeCode can be based on GDT: TransportationDocumentTypeCode. TransportationDocumentNote can be a short note on documentation. TransportationDocumentNote can be based on GDT: SHORT_Note. TransportationDocumentID can be a unique identifier for a transportation document. TransportationDocumentID can be based on GDT: TransportationDocumentID. TransportationDocumentStatusCode can be a coded representation of a status of a transportation document (e.g., to be printed, document complete).
TransportationDocumentStatusCode can be based on GDT: TransportationDocumentStatusCode. LanguageCode can be a coded representation of the language of a documentation. LanguageCode can be based on GDT: LanguageCode. CommunicationMediumTypeCode can be a coded representation of the type of a medium used for communication of documentation, such as Fax, mail, EDI, or Letter. CommunicationMediumTypeCode can be based on GDT : CommunicationMediumTypeCode. RequiredIndicator can indicate whether a documentation is required or not. RequiredIndicator can be based on GDT: Indicator Qualifier: Required. OutputCopyNumberValue can be a number specifying the number of copies of a document that may be issued.
OutputCopyNumberValue can be based on GDT: NumberValue, Qualifier : OutputCopy. OutputOriginalNumberValue can be a number specifying the number of originals of a document that may be issued. OutputOriginalNumberValue can be based on GDT: NumberValue, Qualifier : OutputOriginal. In some implementations, TypeCode and TypeDescription are both optional, but at least one of them may be used. In some implementations, if the RequiredIndicator is set to true, at least one of the NumberValues OutputCopyNumberValue or OutputOriginalNumberValue may be filled.
DateTimePeriod can specify a date, time and/or period (e.g., validity date) related to business documentation of a party. DateTimePeriod can be a period that is defined by two points in time. DateTimePeriod can be based on GDT: DateTimePeriod. PeriodRoleCode can be a coded representation of the business semantic of a period. PeriodRoleCode can be based on GDT: PeriodRoleCode.
BusinessTransactionDocumentReference can specify a business document reference related to a party. BusinessTransactionDocumentReference includes the DateTimePeriod entity. The structure of the BusinessTransactionDocumentReference entity includes the following elements: BusinessTransactionDocumentReference, BusinessTransactionDocumentRelationshipRoleCode, BusinessTransactionDocumentRelationshipTypeCode, TransportationDocumentTypeCode, TransportationDocumentNote, and TransportationDocumentID. BusinessTransactionDocumentReference can be a unique reference to other business documents or business document items that are of significance within each respective business process. BusinessTransactionDocumentReference can be based on GDT: BusinessTransactionDocumentReference.
BusinessTransactionDocumentRelationshipRoleCode can be a coded representation of a role that a business document or a business document item has when set against another business document or business document item with a relationship. BusinessTransactionDocumentRelationshipRoleCode can be based on GDT: BusinessTransactionDocumentRelationshipRoleCode. BusinessTransactionDocumentRelationshipTypeCode can be a coded representation of a relationship between two business documents or business document items. BusinessTransactionDocumentRelationshipTypeCode can be based on GDT: BusinessTransactionDocumentRelationshipTypeCode. TransportationDocumentTypeCode can be a coded representation of a documentation type.
TransportationDocumentTypeCode can be based on GDT: TransportationDocumentTypeCode. TransportationDocumentNote can be a short note on documentation. TransportationDocumentNote can be based on GDT: SHORT_Note. TransportationDocumentID can be a unique identifier for a transportation document. TransportationDocumentID can be based on GDT: TransportationDocumentID. In some implementations, RelationshipTypeCode and RelationshipRoleCode are both optional. If used, both may be filled. Either the combination BusinessTransactionDocumentReference, BusinessTransactionDocumentRelationshipRoleCode, BusinessTransactionDocumentRelationshipTypeCode, or TransportationDocumentTypeCode, TransportationDocumentNote, TransportationDocumentID may be filled.
DateTimePeriod can specify a date, time and/or period related to a document referenced by a party. DateTimePeriod can be a period that is defined by two points in time. DateTimePeriod can be based on GDT: DateTimePeriod. PeriodRoleCode can be a coded representation of business semantics of a period. PeriodRoleCode can be based on GDT: PeriodRoleCode.
The TransportationStageInformation package includes information regarding a transportation stage of a shipment request. A transportation stage represents a section of a transport. The TransportationStageInformation package includes the Stage entity. TransportationStage can specify details related to a stage of a transport which is part of a shipment request. TransportationStage includes the following entities: Location, TransportationDocumentInformation, and TransportationServiceRequirement. The structure of TransportationStage includes the following elements: ID, OrdinalNumberValue, TypeCode, JourneyID, TransportModeCode, TransportMeansDescriptionCode, TransportMeansDescription, TransportMeansID, TransportMeansHomeCountryCode, TransportMeansOwnershipTypeCode, CarrierStandardID, CarrierFormattedName, TransportationTransitDirectionCode, CalculatedDistanceMeasure, and GivenDistanceMeasure.
ID can be a unique identifier of a stage in a shipment request. ID can be based on GDT: TransportationStageID. OrdinalNumberValue can be an ordinal number to indicate a position of a transportation stage in a set of transportation stages. OrdinalNumberValue can be based on GDT: OrdinalNumberValue, Qualifier: TransportationStage. TypeCode can be a coded representation of the type of a TransportationStage. TypeCode can be based on GDT: TransportationStageTypeCode. JourneyID can be an identifier of a journey. JourneyID can be based on GDT: JourneyID. TransportModeCode can be a coded representation of a mode of transportation used for delivery. TransportModeCode can be based on GDT: TransportModeCode. TransportMeansDescriptionCode can be a coded representation of a transport means type with which goods or persons can be transported. TransportMeansDescriptionCode can be based on GDT: TransportMeansDescriptionCode.
TransportMeansDescription can be a description of a means of transport. TransportMeansDescription can be based on GDT: SHORT_Description, Qualifier: TransportMeans. TransportMeansID can be a unique identifier of a means of transport. TransportMeansID can be based on GDT: TransportMeansID. TransportMeansHomeCountryCode can be a coded representation of the home country of a transport means. TransportMeansHomeCountryCode can be based on GDT: CountryCode, Qualifier: TransportMeansHome. TransportMeansOwnershipTypeCode can be a coded representation of the type of ownership for a means of transport. TransportMeansOwnershipTypeCode can be based on GDT: TransportMeansOwnershipTypeCode.
CarrierStandardID can be a standard identifier of a carrier. CarrierStandardID can be based on GDT: PartyStandardID. CarrierFormattedName can be a name of a carrier. CarrierFormattedName can be based on GDT: LONG_Name, Qualifier: PartyFormatted. TransportationTransitDirectionCode can be a coded representation for a transportation transit direction. TransportationTransitDirectionCode can be based on GDT: TransportationTransitDirectionCode. CalculatedDistanceMeasure can be a calculated distance measure. CalculatedDistanceMeasure can be based on GDT: Measure, Qualifier: CalculatedDistance. GivenDistanceMeasure can be a given distance measure. GivenDistanceMeasure can be based on GDT: Measure, Qualifier: GivenDistance.
StageLocation can specify a physical place related to a stage. StageLocation includes the DateTimePeriods entity. The structure of the Location entity includes the following elements: Location, RoleCode, TypeCode, and Name. Location includes information exchanged in business documents about a location relevant for business transactions. Location can be based on GDT: BusinessTransactionDocumentLocation. RoleCode can be a coded representation of a LocationRole. RoleCode can be based on GDT: LocationRoleCode. TypeCode can be a coded representation of a type of a physical location. TypeCode can be based on GDT: LocationTypeCode. Name can be a name of a location. Name can be based on GDT: MEDIUM_Name, Qualifier:Location.
DateTimePeriods can specify a date, time and/or period related to a Location. The elements located directly at the DateTimePeriods entity include RequestedFulfillmentPeriod, AcceptableFullfilmentPeriod, and PeriodRoleCode. RequestedFulfillmentPeriod can be a period which is requested depending on semantics of the PeriodRoleCode. RequestedFulfillmentPeriod can be based on GDT: DATETIMEPERIOD, Qualifier: RequestedFulfillment. AcceptableFulfillmentPeriod can be a period which is acceptable depending on semantics of the PeriodRoleCode. AcceptableFulfillmentPeriod can be based on GDT: DATETIMEPERIOD, Qualifier: AcceptableFulfillment. PeriodRoleCode can be a coded representation of business semantics of the two periods defined by the entities RequestedFulfillmentPeriod and AcceptableFulfillmentPeriod. PeriodRoleCode can be based on GDT: PeriodRoleCode. In some implementations, RequestedFulfillmentPeriod and AcceptableFulfillmentPeriod are optional, but in every instance one of them may be filled.
BusinessTransactionDocumentReference can specify a business document reference related to a Stage. BusinessTransactionDocumentReference includes the DateTimePeriod entity. The structure of the BusinessTransactionDocumentReference entity includes the following elements: BusinessTransactionDocumentReference, BusinessTransactionDocumentRelationshipRoleCode, BusinessTransactionDocumentRelationshipTypeCode, TransportationDocumentTypeCode, TransportationDocumentNote, and TransportationDocumentID. BusinessTransactionDocumentReference can be a unique reference to other business documents or business document items that are of significance within each respective business process. BusinessTransactionDocumentReference can be based on GDT: BusinessTransactionDocumentReference.
BusinessTransactionDocumentRelationshipRoleCode can be a coded representation of a role that a business document or a business document item has when set against another business document or business document item with a relationship. BusinessTransactionDocumentRelationshipRoleCode can be based on GDT: BusinessTransactionDocumentRelationshipRoleCode. BusinessTransactionDocumentRelationshipTypeCode can be a coded representation of a relationship between two business documents or business document items. BusinessTransactionDocumentRelationshipTypeCode can be based on GDT: BusinessTransactionDocumentRelationshipTypeCode.
TransportationDocumentTypeCode can be a coded representation of a documentation type. TransportationDocumentTypeCode can be based on GDT: TransportationDocumentTypeCode. TransportationDocumentNote can be a short note on documentation. TransportationDocumentNote can be based on GDT: SHORT_Note. TransportationDocumentID can be a unique identifier for a transportation document. TransportationDocumentID can be based on GDT: TransportationDocumentID. In some implementations, RelationshipTypeCode and RelationshipRoleCode are both optional. If used, both may be filled. Either the combination BusinessTransactionDocumentReference, BusinessTransactionDocumentRelationshipRoleCode, BusinessTransactionDocumentRelationshipTypeCode, or TransportationDocumentTypeCode, TransportationDocumentNote, TransportationDocumentID may be filled.
DateTimePeriod specifies a date, time and/or period related to a BusinessTransactionDocumentReference. The structure of the DateTimePeriod entity includes the elements DateTimePeriod and PeriodRoleCode. DateTimePeriod can be a period that is defined by two points in time. DateTimePeriod can be based on GDT: DateTimePeriod. PeriodRoleCode can be a coded representation of business semantics of a period. PeriodRoleCode can be based on GDT: PeriodRoleCode.
TransportationServiceRequirement specifies a contract and carriage condition and service and priority requirements related to a stage. The structure of TransportationServiceRequirement includes the following elements: TransportationServiceRequirementCode, AdditionalTransportationServiceRequirementCode, TransportationContractConditionCode, TransportServiceLevelCode, and NatureOfCargoClassificationCode. TransportationServiceRequirementCode can be a coded representation of a requirement related to a transportation service. TransportationServiceRequirementCode can be based on GDT : TransportationServiceRequirementCode.
AdditionalTransportationServiceRequirementCode can be a coded representation of an additional requirement related to a transportation service. AdditionalTransportationServiceRequirementCode can be based on GDT : TransportationServiceRequirementCode, Qualifier: Additional. TransportationContractConditionCode can be a coded representation of a contract and carriage condition. TransportationContractConditionCode can be based on GDT: TransportationContractConditionCode. TransportServiceLevelCode can be a coded representation of agreed or defined services in terms of the delivery of goods with respect to the speed of the delivery. TransportServiceLevelCode can be based on GDT: TransportServiceLevelCode. NatureOfCargoClassificationCode can be a coded representation of a classification of the nature of cargo. NatureOfCargoClassificationCode can be based on GDT : NatureOfCargoClassificationCode.
The TransportationUnitResourceInformation package includes information regarding a transportation unit resource that is relevant for a shipment request (e.g., a container). The TransportationUnitResourceInformation package includes the TransportationUnitResourceInformation entity. TransportationUnitResourceInformation includes information on one or more transportation unit resources, such as a resource type and related properties, or related measures or handling instructions. A Transportation Unit Resource can be a unit into which goods are loaded and/or from which goods are unloaded. In some implementations, this unit can provide transportation capacity for goods but might move by itself. TransportationUnitResourceInformation includes the following entities: TransportationStageAssignment, AttachedEquipment, Quantity, BusinessTransactionDocumentReference, TextCollection, Location, and DangerousGoods. The structure of TransportationUnitResourceInformation includes the following elements: ID, ResourceNumberValue, ResourceID, ResourceHomeCountryCode, TransportationUnitResourceCategoryCode, TransportationUnitResourceTypeCode, FillLevelCode, ShippingTypeCode, HaulageArrangerCode, TransportationHandlingInstructionCode, and TransportationHandlingInstructionNote.
ID can be a unique identifier for a resource information. ID can be based on GDT ResourceInformationID. ResourceNumberValue can be a count of resources. ResourceNumberValue can be based on GDT: NumberValue, Qualifier: Resource. ResourceID can be a unique identifier for a resource. ResourceID can be based on GDT: ResourceID. ResourceHomeCountryCode can be a coded representation of the home country of a resource. ResourceHomeCountryCode can be based on GDT: CountryCode, Qualifier: ResourceHome. TransportationUnitResourceCategoryCode can be a coded representation of a category of transportation unit resources. TransportationUnitResourceCategoryCode can be based on GDT: TransportationUnitResourceCategoryCode. TransportationUnitResourceTypeCode can be a coded representation of the type of a transportation unit resource.
TransportationUnitResourceTypeCode can be based on GDT: TransportationUnitResourceTypeCode. FillLevelCode can be a coded representation of a fill level of a resource. FillLevelCode can be based on GDT: FillLevelCode. ShippingTypeCode can be a coded representation of a shipping type. A shipping type can specify how the planning and execution of a transportation can be performed. Transportation terms include detailed specifications on agreed means of transportation, such as shipping or transport type and means of transport to be used. ShippingTypeCode can be based on GDT: ShippingTypeCode. HaulageArrangerCode can be a coded representation of an arranger of a haulage. Haulage can be inland transport of cargo. HaulageArrangerCode can be based on GDT: HaulageArrangerCode. TransportationHandlingInstructionCode can be a coded representation of a type of a transportation handling instruction. TransportationHandlingInstructionCode can be based on GDT: TransportationHandlingInstructionCode. TransportationHandlingInstructionNote can be a note regarding a transportation handling instruction. TransportationHandlingInstructionNote can be based on GDT: LONG_Note, Qualifier: TransportationHandlingInstruction.
TransportationStageAssignment can specify an assignment of a transportation stage to a transportation unit resource information. The structure of TransportationStageAssignment includes the element ShipmentRequestTransportationStageID. ShipmentRequestTransportationStageID can be a unique identifier of a TransportationStage in a shipment request. ShipmentRequestTransportationStageID can be based on GDT: TransportationStageID.
AttachedEquipment can specify equipment attached to a TransportationUnitResource. The structure of AttachedEquipment includes the ShipmentRequestResourceInformationID. ShipmentRequestResourceInformationID can be a unique identifier of a resource information in a ShipmentRequest. ShipmentRequestResourceInformationID can be based on GDT: ResourceInformationID.
Quantity can specify a quantity related to TransportationUnitResourceInformation. The structure of the Quantity entity includes the Quantity, RoleCode, and TypeCode elements. Quantity can be a non-monetary numerical specification of an amount in a unit of measurement. Quantity can be based on GDT: Quantity. RoleCode can be a coded representation of a role of a quantity. RoleCode can be based on GDT: QuantityRoleCode. TypeCode can be a coded representation of a type of quantity that is based on a measurable characteristic of an object or physical phenomenon. TypeCode can be based on GDT: QuantityTypeCode. In some implementations, QuantityRoleCode and QuantityTypeCode are optional, but in every instance one of them may be filled.
BusinessTransactionDocumentReference can specify a business document reference related to a TransportationUnitResource. BusinessTransactionDocumentReference includes the DateTimePeriod entity. The structure of the BusinessTransactionDocumentReference entity includes the following elements: BusinessTransactionDocumentReference, BusinessTransactionDocumentRelationshipRoleCode, BusinessTransactionDocumentRelationshipTypeCode, TransportationDocumentTypeCode, TransportationDocumentNote, and TransportationDocumentID. BusinessTransactionDocumentReference can be a unique reference to other business documents or business document items that are of significance within each respective business process. BusinessTransactionDocumentReference can be based on GDT: BusinessTransactionDocumentReference.
BusinessTransactionDocumentRelationshipRoleCode can be a coded representation of a role that a business document or a business document item has when set against another business document or business document item with a relationship. BusinessTransactionDocumentRelationshipRoleCode can be based on GDT: BusinessTransactionDocumentRelationshipRoleCode. BusinessTransactionDocumentRelationshipTypeCode can be a coded representation of a relationship between two business documents or business document items. BusinessTransactionDocumentRelationshipTypeCode can be based on GDT: BusinessTransactionDocumentRelationshipTypeCode. TransportationDocumentTypeCode can be a coded representation of a documentation type.
TransportationDocumentTypeCode can be based on GDT: TransportationDocumentTypeCode. TransportationDocumentNote can be a short note on documentation. TransportationDocumentNote can be based on GDT: SHORT_Note. TransportationDocumentID can be a unique identifier for a transportation document. TransportationDocumentID can be based on GDT: TransportationDocumentID. In some implementations, RelationshipTypeCode and RelationshipRoleCode are both optional. If used, both may be filled. Either the combination BusinessTransactionDocumentReference, BusinessTransactionDocumentRelationshipRoleCode, BusinessTransactionDocumentRelationshipTypeCode, or TransportationDocumentTypeCode, TransportationDocumentNote, TransportationDocumentID may be filled.
DateTimePeriod can specify a date, time and/or period related to a BusinessTransactionDocumentReference. The structure of the DateTimePeriod entity includes the DateTimePeriod and PeriodRoleCode. DateTimePeriod can be a period that is defined by two points in time. DateTimePeriod can be based on GDT: DateTimePeriod. PeriodRoleCode can be a coded representation of business semantics of a period. PeriodRoleCode can be based on GDT: PeriodRoleCode.
TextCollection can be a group of textual information that relates to a TransportationUnitResource. The structure of the TextCollection entity includes the TextCollection element. TextCollection can be based on GDT: TextCollection.
Location can specify a physical place related to a TransportationUnitResource. The structure of the Location entity includes the following elements: Location, RoleCode, TypeCode, and Name. Location includes information exchanged in business documents about a location relevant for business transactions. Location can be based on GDT: BusinessTransactionDocumentLocation. RoleCode can be a coded representation of a LocationRole. RoleCode can be based on GDT: LocationRoleCode. TypeCode can be a coded representation of a type of a physical location. TypeCode can be based on GDT: LocationTypeCode. Name can be a name of a location. Name can be based on GDT: MEDIUM_Name, Qualifier:Location.
DateTimePeriods can specify a requested and an acceptable date, time and period related to a Location of a resource. The elements located directly at the DateTimePeriods entity include RequestedFulfillmentPeriod, AcceptableFullfilmentPeriod, and PeriodRoleCode. RequestedFulfillmentPeriod can be a period which is requested depending on semantics of the PeriodRoleCode. RequestedFulfillmentPeriod can be based on GDT: DATETIMEPERIOD, Qualifier: RequestedFulfillment. AcceptableFulfillmentPeriod can be a period which is acceptable depending on semantics of the PeriodRoleCode. AcceptableFulfillmentPeriod can be based on GDT: DATETIMEPERIOD, Qualifier: AcceptableFulfillment. PeriodRoleCode can be a coded representation of business semantics of the two periods defined by the entities RequestedFulfillmentPeriod and AcceptableFulfillmentPeriod. PeriodRoleCode can be based on GDT: PeriodRoleCode. In some implementations, RequestedFulfillmentPeriod and AcceptableFulfillmentPeriod are optional, but in every instance one of them may be filled.
DangerousGoods can specify dangerous goods included in a resource. DangerousGoods includes the ContactInformation and TextCollection entities. The structure of DangerousGoods includes the following elements: ID, RegulationsCode, HazardCode, FlashpointMeasureInterval, PackagingGroupCode, EmergencySchedule, TransportEmergencyCardCode, DangerousGoodsLabelCode, DangerousGoodsLabelCode2, DangerousGoodsLabelCode3, PackagingInstructionTypeCode, TransportMeansDescriptionCode, and TransportAuthorisationCode. ID can be a unique identifier for a dangerous good, using the United Nations Dangerous Goods Number. ID can be based on GDT: DangerousGoodsID. RegulationsCode can be a coded representation of national or international dangerous goods rules or regulations. RegulationsCode can be based on GDT: DangerousGoodsRegulationsCode.
HazardCode can be a coded representation of a hazard that is imminent in a dangerous good. HazardCode can be based on GDT: DangerousGoodsHazardCode. FlashpointMeasureInterval can be an interval of measures defined by a lower and an upper boundary indicating a flashpoint of a dangerous good. FlashpointMeasureInterval can be based on GDT: MeasureInterval, Qualifier: Flashpoint. PackagingGroupCode can be a coded representation of the effectiveness of a packaging to transport dangerous goods depending on the degree of danger of the goods. PackagingGroupCode can be based on GDT: DangerousGoodsPackagingGroupCode. EmergencySchedule can be a coded representation of an emergency schedule for dangerous goods. EmergencySchedule can identify an emergency schedule. The DangerousGoodsEmergencySchedule can be used for transports of dangerous goods by sea similar to a Transport Emergency Card which is used for transports of dangerous goods by road. EmergencySchedule can be based on GDT: DangerousGoodsEmergencySchedule. TransportEmergencyCardCode can be a coded representation of a transport emergency card which specifies how to react in case of an accident.
TransportEmergencyCardCode can be based on GDT: TransportEmergencyCardCode. DangerousGoodsLabelCode can be a coded representation of a label for a dangerous good. In some implementations, DangerousGoodsLabelCode's values are dependant on the DangerousGoodsRegulationsCode. DangerousGoodsLabelCode can be based on GDT: DangerousGoodsLabelCode. DangerousGoodsLabelCode2 can be a coded representation of a label for a dangerous good. In some implementations, DangerousGoodsLabelCode's values are dependant on the DangerousGoodsRegulationsCode. DangerousGoodsLabelCode2 can be based on GDT: DangerousGoodsLabelCode. DangerousGoodsLabelCode3 can be a coded representation of a label for a dangerous good. In some implementations, DangerousGoodsLabelCode's values are dependant on the DangerousGoodsRegulationsCode. DangerousGoodsLabelCode3 can be based on GDT: DangerousGoodsLabelCode.
PackagingInstructionTypeCode can be a coded representation of a packaging instruction. In some implementations, a packaging instruction can be an instruction defining which packaging may be used to pack a dangerous good. PackagingInstructionTypeCode can be based on GDT: PackagingInstructionTypeCode. TransportMeansDescriptionCode can be a coded representation of a transport means type with which goods or persons can be transported. TransportMeansDescriptionCode can be based on GDT: TransportMeansDescriptionCode. TransportAuthorisationCode can be a coded representation of an authorisation for the transportation of dangerous goods. This code can specify an authorisation for the transportation of a particular dangerous good. TransportAuthorisationCode can be based on GDT: DangerousGoodsTransportAuthorisationCode.
ContactInformation can specify information on a department or person to whom information regarding the dangerous goods can be directed. The structure of ContactInformation includes the ContactPersonFunctionTypeCode and Address elements. ContactPersonFunctionTypeCode can be a coded representation of a type of function that a contact person has. ContactPersonFunctionTypeCode can be based on GDT: ContactPersonFunctionTypeCode. Address can be an address related to the contact information defined by a corresponding FunctionTypeCode. Address can be based on GDT: Address.
TextCollection can be a group of textual information that relates to DangerousGoods. The structure of the TextCollection entity includes the TextCollection element. TextCollection can be based on GDT: TextCollection.
The TransportationChargesInformation package includes information regarding transportation charge calculation specific components related to a ShipmentRequest. The TransportationChargesInformation package includes the TransportationChargesInformation entity. The TransportationChargesInformation entity can define a relationship between the transportation charges and the origin of these charges. The TransportationChargesInformation entity includes the TransportationCharges entity. The structure of TransportationChargesInformation includes the following elements: TransportationChargesUsageCode, ShipmentRequestItemID, ShipmentRequestPartyStandardID, ShipmentRequestPartyInternalID, ShipmentRequestResourceInformationID, ShipmentRequestPackageInformationID, and ShipmentRequestTransportationStageID. TransportationChargesUsageCode can be a coded representation of the usage of TransportationCharges.
The usage can point out if the subsequent information represents a revenue- or cost-view on transportation charges. TransportationChargesUsageCode can be based on GDT: TransportationChargesUsageCode. ShipmentRequestItemID can be a unique identifier of an Item in a ShipmentRequest. ShipmentRequestItemID can be based on GDT: BusinessTransactionDocumentItemID. ShipmentRequestPartyStandardID can be a unique identifier of a Party in a ShipmentRequest. ShipmentRequestPartyStandardID can be based on GDT: PartyStandardID. ShipmentRequestPartyInternalID can be based on GDT: PartyInternalID. ShipmentRequestResourceInformationID can be a unique identification of a TransportationUnitResource in a ShipmentRequest. ShipmentRequestResourceInformationID can be based on GDT: ResourceInformationID. ShipmentRequestPackageInformationID can be a unique identification of a PackageInformation in a ShipmentRequest. ShipmentRequestPackageInformationID can be based on GDT: PackageInformationID. ShipmentRequestTransportationStageID can be a unique identification of a TransportationStage in a ShipmentRequest. ShipmentRequestTransportationStageID can be based on GDT: TransportationStageID. In some implementations, if none of the IDs is maintained, the transportation charges are related to the whole shipment request.
TransportationCharges can be a summary of determined transportation charge specific components for a transportation business case. TransportationCharges includes the following entities: Location, TextCollection, Currency, ExchangeRate, PercentElement, DateTimePeriod, BusinessTransactionDocumentReference, TaxDetail, PaymentInstruction, CashDiscountTerms, and Element. The structure of TransportationCharges includes the following elements: ID, FreightAgreementID, CalculationOriginCode, TariffID, and CalculationSheetID. ID can be a unique identifier of TransportationCharges in a ShipmentRequest. ID can be based on GDT: TransportationChargesID. FreightAgreementID can be an identification of a Freight Agreement which includes and points to a configuration for the Transportation Charges Calculation. FreightAgreementID can be based on GDT: FreightAgreementID.
CalculationOriginCode can be a coded representation of an origin of a transportation charges calculation. The calculation can be done automatically based on the system configuration. Data for the calculation, including the results, can be manually entered or received from another business system via a message. In some implementations, a clear distinction of the origin of TransportationChargesCalculation details like the TransportationChargesCalculationSheet and its TransportationChargeElements may be included. CalculationOriginCode can give information whether the calculation was done completely automatically, or if the results were manually adopted. CalculationOriginCode can be based on GDT: TransportationChargesOriginCode.
TariffID can be an identifier for a transportation charges tariff. A transportation charges tariff can be a specific combination of a transportation charges calculation sheet and terms and conditions. The terms and conditions can define if a certain transportation charges calculation sheet and its related rates are applicable for a transportation business case. TariffID can be based on GDT: TransportationChargesTariffID. CalculationSheetID can be a unique identifier for a transportation charges calculation sheet. A TransportationChargesCalculationSheet can represent a configuration describing how to calculate transportation charges for a transportation business case. TransportationChargesCalculationSheet includes instructions describing which charges are applicable, which data from a transportation business case may be considered for a calculation, how underlying transportation charge rates are determined, and which special calculation methods may be considered. CalculationSheetID can be based on GDT: TransportationChargesCalculationSheetID.
A Location can specify a physical place to which TransportationCharges and their calculation can refer. Location includes the DateTimePeriod entity. The structure of the Location entity includes the following elements: Location, RoleCode, TypeCode, and Name. Location includes information exchanged in business documents about a location relevant for business transactions. Location can be based on GDT: BusinessTransactionDocumentLocation. RoleCode can be a coded representation of a LocationRole. RoleCode can be based on GDT: LocationRoleCode. TypeCode can be a coded representation of a type of a physical location. TypeCode can be based on GDT: LocationTypeCode. Name can be a name of a location. Name can be based on GDT: MEDIUM_Name, Qualifier:Location.
DateTimePeriods can specify a date, time and/or period related to a TransportationChargesLocation. The elements located directly at the DateTimePeriods entity include RequestedFulfillmentPeriod, AcceptableFullfilmentPeriod, and PeriodRoleCode. RequestedFulfillmentPeriod can be a period which is requested depending on semantics of the PeriodRoleCode. RequestedFulfillmentPeriod can be based on GDT: DATETIMEPERIOD, Qualifier: RequestedFulfillment. AcceptableFulfillmentPeriod can be a period which is acceptable depending on semantics of the PeriodRoleCode. AcceptableFulfillmentPeriod can be based on GDT: DATETIMEPERIOD, Qualifier: AcceptableFulfillment. PeriodRoleCode can be a coded representation of business semantics of the two periods defined by the entities RequestedFulfillmentPeriod and AcceptableFulfillmentPeriod. PeriodRoleCode can be based on GDT: PeriodRoleCode. In some implementations, RequestedFulfillmentPeriod and AcceptableFulfillmentPeriod are optional, but in every instance one of them may be filled.
TextCollection can be a group of textual information that relates to TransportationCharges. The structure of the TextCollection entity includes the TextCollection element. TextCollection can be based on GDT: TextCollection.
Currency can be a currency which is valid for transportation charges. The structure of Currency includes the following elements: Code, RoleCode, and UsageCode. Code can be a coded representation of a currency. Code can be based on GDT: CurrencyCode. RoleCode can be a coded representation of a role of a Currency. RoleCode can be based on GDT: CurrencyRoleCode. UsageCode can be a coded representation of how a currency is used. UsageCode can be based on GDT: CurrencyUsageCode. In some implementations, a currency can be valid for transportation charges, as long as there is no currency information on a charge element level.
ExchangeRate can be an exchange rate that has been especially negotiated for transportation charges. The structure of the ExchangeRate entity includes the ExchangeRate and TypeCode elements. ExchangeRate can be a rate at which one unit of a currency can be changed into another currency. ExchangeRate can be based on GDT: ExchangeRate. TypeCode can be a coded representation of a type of an exchange rate. The actual exchange rate between two currencies can depend on an exchange rate type and currency conversion type. The exchange rate type can define characteristics of an exchange rate according to the currencies that get converted. TypeCode can be based on GDT: ExchangeRateTypeCode.
PercentElement is a detail about Transportation Charges represented as a percentage. The structure of PercentElement includes the following elements: PercentRoleCode, Percent, TransportationChargesPercentCalculationBaseCode, and Status. PercentRoleCode can be a coded representation of a role of a percent. PercentRoleCode can be based on GDT: PercentRoleCode. Percent can be a number that relates to the comparison
DateTimePeriod can specify a date, time and/or period that is relevant for a transportation charges calculation. The structure of the DateTimePeriod entity includes the DateTimePeriod and PeriodRoleCode. DateTimePeriod can be a period that is defined by two points in time. DateTimePeriod can be based on GDT: DateTimePeriod. PeriodRoleCode can be a coded representation of business semantics of a period. PeriodRoleCode can be based on GDT: PeriodRoleCode.
A BusinessTransactionDocumentReference can specify a business document reference related to a transportation charges calculation. The structure of the BusinessTransactionDocumentReference entity includes the following elements: BusinessTransactionDocumentReference, BusinessTransactionDocumentRelationshipRoleCode, BusinessTransactionDocumentRelationshipTypeCode, TransportationDocumentTypeCode, TransportationDocumentNote, and TransportationDocumentID. BusinessTransactionDocumentReference can be a unique reference to other business documents or business document items that are of significance within each respective business process. BusinessTransactionDocumentReference can be based on GDT: BusinessTransactionDocumentReference.
BusinessTransactionDocumentRelationshipRoleCode can be a coded representation of aa role that a business document or a business document item has when set against another business document or business document item with a relationship. BusinessTransactionDocumentRelationshipRoleCode can be based on GDT: BusinessTransactionDocumentRelationshipRoleCode. BusinessTransactionDocumentRelationshipTypeCode can be a coded representation of a relationship between two business documents or business document items. BusinessTransactionDocumentRelationshipTypeCode can be based on GDT: BusinessTransactionDocumentRelationshipTypeCode. TransportationDocumentTypeCode can be a coded representation of a documentation type. TransportationDocumentTypeCode can be based on GDT: TransportationDocumentTypeCode. TransportationDocumentNote can be a short note on documentation. TransportationDocumentNote can be based on GDT: SHORT_Note. TransportationDocumentID can be a unique identifier for a transportation document. TransportationDocumentID can be based on GDT: TransportationDocumentID. In some implementations, RelationshipTypeCode and RelationshipRoleCode are both optional. If used, both may be filled. Either the combination BusinessTransactionDocumentReference, BusinessTransactionDocumentRelationshipRoleCode, BusinessTransactionDocumentRelationshipTypeCode, or TransportationDocumentTypeCode, TransportationDocumentNote, TransportationDocumentID may be filled.
A TaxDetail can be a tax-relevant information which is applicable for each ChargeElement. The structure of TaxDetail includes the ProductTax element. ProductTax can be a tax incurred for product-related business transactions, such as purchasing, sales, or consumption. ProductTax can be used to display different tax components in calculated and invoiced amounts, and to inform about tax declarations and payments of a company to responsible tax authorities. ProductTax can be based on GDT: ProductTax. In some implementations, within TaxDetail, the BusinessTransactionDocumentItemGroupID of the GDT ProductTax is not used.
PaymentInstruction can be an instruction about how a payment may be carried out or which additional activities may be carried out within a payment. In some implementations, there is a separate instance for each Charge Category Code, such as Basic Freight, or Origin haulage charges. The structure of the PaymentInstruction entity includes the following elements: PaymentInstruction, TransportationChargesElementCategoryCode, TransportationChargesElementSubCategoryCode, and TransportationChargesPaymentArrangementCode.
PaymentInstruction can be an instruction about how a payment may be carried out, or which additional activities may be carried out within a payment. PaymentInstruction can be based on GDT: PaymentInstruction. TransportationChargesElementCategoryCode can be a coded representation of a category of a TransportationChargeElement. The TransportationChargeElementCategoryCode can be used to group TransportationChargeElements. PaymentInstructions can be different per TransportationChargeElementCategory. TransportationChargesElementCategoryCode can be based on GDT: TransportationChargesElementCategoryCode. TransportationChargesElementSubCategoryCode can be a coded representation of a subcategory of a transportation charges element. TransportationChargesElementSubCategoryCode can be based on GDT: TransportationChargesElementSubCategoryCode. TransportationChargesPaymentArrangementCode can be a coded representation of an arrangement of a payment for transportation charges. TransportationChargesPaymentArrangementCode can be based on GDT: TransportationChargesPaymentArrangementCode.
CashDiscountTerms can be an agreement on a percentage of cash discount that is granted during a transportation transaction when payment takes place within a certain number of days after a baseline date for payment has passed. The structure of the CashDiscountTerms entity includes the following elements: CashDiscountTerms, TransportationChargesElementCategoryCode, and TransportationChargesElementSubCategoryCode. CashDiscountTerms can be an agreement of cash discounts for a payment. CashDiscountTerms can be based on GDT: CashDiscountTerms. TransportationChargesElementCategoryCode can be a coded representation of a category of a TransportationChargesElement. The TransportationChargesElementCategoryCode can be used to group TransportationChargesElements. PaymentInstructions can be different per TransportationChargesElementCategory. TransportationChargesElementCategoryCode can be based on GDT: TransportationChargesElementCategoryCode. TransportationChargesElementSubCategoryCode can be a coded representation of a subcategory of a transportation charges element. TransportationChargesElementSubCategoryCode can be based on GDT: TransportationChargesElementSubCategoryCode.
Element can be, together with its sub nodes, a single building block of a transportation charge calculation. A Charge Element can result from a manually created charge, an automatically determined charge, or another Charge Element distributed from an entire document. Charge Element includes the following entities: Location, TextCollection, Currency, RateElement, PercentElement, AmountElement, CalculationBase, TaxDetail, DateTimePeriod, and CostDistribution. The structure of Element includes CategoryCode, SubCategoryCode, TypeCode, CalculationResolutionCode, and TransportationChargesPaymentArrangementCode. CategoryCode can be a coded representation of a category of a TransportationChargesElement. The TransportationChargesElementCategoryCode can be used to group TransportationChargesElements.
PaymentInstructions can be different per TransportationChargesElementCategory. CategoryCode can be based on GDT: TransportationChargesElementCategoryCode. SubCategoryCode can be a coded representation of a subcategory of a transportation charges element. SubCategoryCode can be based on GDT: TransportationChargesElementSubCategoryCode. TypeCode can be a coded representation of a type of a transportation charge element. TypeCode can be based on GDT: TransportationChargesElementTypeCode. CalculationResolutionCode can be a coded representation of a resolution for a transportation charges element calculation. CalculationResolutionCode can be based on GDT: TransportationChargesElementCalculationResolutionCode. TransportationChargesPaymentArrangementCode can be a coded representation of an arrangement of payment for transportation charges. TransportationChargesPaymentArrangementCode can be based on GDT: TransportationChargesPaymentArrangementCode.
Location can specify a physical place a specific ChargeElement refers to. Location includes the DateTimePeriod entity. The structure of the Location entity includes the following elements: Location, RoleCode, TypeCode, and Name. Location includes information exchanged in business documents about a location relevant for business transactions. Location can be based on GDT: BusinessTransactionDocumentLocation. RoleCode can be a coded representation of a LocationRole. RoleCode can be based on GDT: LocationRoleCode. TypeCode can be a coded representation of a type of a physical location. TypeCode can be based on GDT: LocationTypeCode. Name can be a name of a location. Name can be based on GDT: MEDIUM_Name, Qualifier:Location. DateTimePeriods can specify a date, time and/or period related to a location.
The elements located directly at the DateTimePeriods entity include RequestedFulfillmentPeriod, AcceptableFullfilmentPeriod, and PeriodRoleCode. RequestedFulfillmentPeriod can be a period which is requested depending on semantics of the PeriodRoleCode. RequestedFulfillmentPeriod can be based on GDT: DATETIMEPERIOD, Qualifier: RequestedFulfillment. AcceptableFulfillmentPeriod can be a period which is acceptable depending on semantics of the PeriodRoleCode. AcceptableFulfillmentPeriod can be based on GDT: DATETIMEPERIOD, Qualifier: AcceptableFulfillment. PeriodRoleCode can be a coded representation of business semantics of the two periods defined by the entities RequestedFulfillmentPeriod and AcceptableFulfillmentPeriod. PeriodRoleCode can be based on GDT: PeriodRoleCode. In some implementations, RequestedFulfillmentPeriod and AcceptableFulfillmentPeriod are optional, but in every instance one of them may be filled.
TextCollection can be a group of textual information that relates to a ChargeElement. The structure of the TextCollection entity includes the TextCollection element. TextCollection can be based on GDT: TextCollection.
Currency can emphasize if a ChargeElement may be considered with relation to a certain currency. The structure of Currency includes the following elements: Code, RoleCode, and UsageCode. Code can be a coded representation of a currency. Code can be based on GDT: CurrencyCode. RoleCode can be a coded representation of a role of a Currency. RoleCode can be based on GDT: CurrencyRoleCode. UsageCode can be a coded representation of how a currency is used. UsageCode can be based on GDT: CurrencyUsageCode. In some implementations, this currency can be valid for transportation charges, as long as there is no currency information on a charge element level.
RateDetail can specify a rate with which a ChargeElement is calculated. The structure of RateDetail includes the following elements: ID, Amount, BaseQuantity, TransportationChargesRateTypeCode, TransportationChargesRateRoleCode, and TransportationChargesRateElementStatusCode. ID can be a unique identifier of a rate element of a transportation charges element. ID can be based on GDT: TransportationChargesElementRateElementID. Amount can be an amount with a corresponding currency unit, or a monetary amount of a rate. Amount can be based on CDT: Amount. BaseQuantity can be a non-monetary numerical specification of an amount in a unit of measurement. BaseQuantity can be a quantity to which an amount refers. BaseQuantity can be based on CDT: Quantity, Qualifier: Base.
TransportationChargesRateTypeCode can be a coded representation of a TransportationChargeRate type. Examples include gross weight rate and net weight rate. TransportationChargesRateTypeCode can be based on GDT: TransportationChargesRateTypeCode. TransportationChargesRateRoleCode can be a coded representation of the role of a TransportationChargeRate. Examples include an invoice rate or a rate for calculation purposes. TransportationChargesRateRoleCode can be based on GDT: TransportationChargesRateRoleCode. TransportationChargesRateElementStatusCode can be a coded representation of a status of a transportation charges rate element. TransportationChargesRateElementStatusCode can be based on GDT: TransportationChargesRateElementStatusCode.
PercentElement can be a detail about a transportation charges element represented as a percentage. The structure of PercentElement includes the following elements: PercentRoleCode, Percent, TransportationChargesPercentCalculationBaseCode, and Status. PercentRoleCode can be a coded representation of a role of a percent. PercentRoleCode can be based on GDT: PercentRoleCode. Percent can be a number that relates to the comparison
AmountElement can represent a monetary aspect of a Transportation Charge. AmountElement can be a result of a transportation charge calculation. There can be a separate AmountElement instance for each monetary amount per AmountRoleCode. AmountElement includes the RateElementAssignment entity. The structure of AmountElement includes the following elements: Amount, AmountRoleCode, and TransportationChargesAmountElementStatusCode. Amount can be an amount with a corresponding currency unit. Amount can be based on CDT: Amount. AmountRoleCode can be a coded representation of a role of an amount. AmountRoleCode can be based on GDT: AmountRoleCode. TransportationChargesAmountElementStatusCode can be a coded representation of a status of an amount element of transportation charges or its transportation charges element. TransportationChargesAmountElementStatusCode can be based on GDT: TransportationChargesAmountElementStatusCode.
RateElementAssignment can be an assignment of an amount to a RateElement. The structure of RateElementAssignment includes the element TransportationChargesElementRateElementID. TransportationChargesElementRateElementID can be a unique identifier of a rate element of a transportation charges element. TransportationChargesElementRateElementID can be based on GDT: TransportationChargesElementRateElementID.
CalculationBase can be data which, included with RateDetail, is a basis for calculating an Amount. The structure of CalculationBase includes the following elements: TransportationChargesElementCalculationBaseCode, BaseQuantity, BaseQuantityRoleCode, and BaseQuantityTypeCode. TransportationChargesElementCalculationBaseCode can be a coded representation of a calculation base of a transportation charges element. TransportationChargesElementCalculationBaseCode can be based on GDT: TransportationChargesElementCalculationBaseCode. BaseQuantity can be a non-monetary numerical specification of an amount in a unit of measurement. BaseQuantity can be a value of a calculation base as a quantity. BaseQuantity can be based on GDT: Quantity, Qualifier: Base. BaseQuantityRoleCode can be a coded representation of a role of a quantity. BaseQuantityRoleCode can be based on GDT: QuantityRoleCode. BaseQuantityTypeCode can be a coded representation of a type of quantity that is based on a measurable characteristic of an object or physical phenomenon. BaseQuantityTypeCode can be based on GDT: QuantityTypeCode.
TaxDetail can be tax-relevant information which is applicable for each ChargeElement. The structure of TaxDetail includes the ProductTax element. ProductTax can be a tax incurred for product-related business transactions, such as purchasing, sales, or consumption. The ProductTax can be used to display different tax components in calculated and invoiced amounts, and to inform about tax declarations and payments of a company to responsible tax authorities. ProductTax can be based on GDT: ProductTax. In some implementations, within TaxDetail, the BusinessTransactionDocumentItemGroupID of the GDT ProductTax is not used.
DateTimePeriod can specify a date, time and/or period related to a ChargeElement. The structure of the DateTimePeriod entity includes DateTimePeriod and PeriodRoleCode. DateTimePeriod can be a period that is defined by two points in time. DateTimePeriod can be based on GDT: DateTimePeriod. PeriodRoleCode can be a coded representation of business semantics of a period. PeriodRoleCode can be based on GDT: PeriodRoleCode.
CostDistribution can be information describing how a ChargeElement can be allocated or distributed from a financial accounting point of view. The structure of CostDistribution includes the AccountingCodingBlockAssignment element.
An AccountingCodingBlockAssignment can be an assignment of an item to a coding block. Items typically assigned to a coding block can be an amount that is known from context, a quantity, or a company resource such as office space or working time. A coding block can be a set of account assignment objects of different types. An account assignment object can be a business object to which value changes from business transactions are assigned in accounting. AccountingCodingBlockAssignment can be based on GDT: AccountingCodingBlockAssignment.
In some implementations, the SupplierShipmentQuote package includes a SupplierFreightQuoteAssignmentInformation package which can include information for supplier freight quote assignments. The SupplierFreightQuoteAssignmentInformation package includes the TransportationStageAssignment and TransportationUnitResourceInformationAssignment entities. TransportationStageAssignment can specify an assignment of the SupplierShipmentQuote to a stage of the SupplierFreightQuote. The structure of TransportationStageAssignment includes the element SupplierFreightQuoteTransportationStageID. SupplierFreightQuoteTransportationStageID can be a unique identifier of a TransportationStage in a SupplierFreightQuote, and can be based on GDT: TransportationStageID. TransportationUnitResourceInformationAssignment can specify an assignment of the SupplierShipmentQuote to a TransportationUnitResourceInformation of the SupplierFreightQuote. The structure of TransportationUnitResourceInformationAssignment includes the SupplierFreightQuoteTransportationUnitResourceInformationID element. SupplierFreightQuoteTransportationUnitResourceInformationID can be a unique identifier of a TransportationUnitResourceInformation in a SupplierFreightQuote, and can be based on GDT: TransportationUnitResourceID.
The TransportationUnitResourceInformation package includes information regarding a transportation unit resource relevant for a shipment request (e.g., a container. The TransportationUnitResourceInformation package includes the TransportationUnitResourceInformation entity. TransportationUnitResourceInformation includes information on one or more transportation unit resources, such as a resource type and related properties (e.g., related measures or handling instructions). A Transportation Unit Resource can be a unit into which goods are loaded and/or from which goods are unloaded. In some implementations, this unit can provide transportation capacity for goods but might not move by itself. TransportationUnitResourceInformation includes the following entities: TransportationStageAssignment, AttachedEquipment, Quantity, BusinessTransactionDocumentReference, TextCollection, Location, and DangerousGoods. The structure of TransportationUnitResourceInformation includes the following elements: ID, ResourceNumberValue, ResourceID, ResourceHomeCountryCode, TransportationUnitResourceCategoryCode, TransportationUnitResourceTypeCode, FillLevelCode, ShippingTypeCode, HaulageArrangerCode, TransportationHandlingInstructionCode, and TransportationHandlingInstructionNote.
ID can be a unique identifier for a resource information. ID can be based on GDT ResourceInformationID. ResourceNumberValue can be a count of resources. ResourceNumberValue can be based on GDT: NumberValue, Qualifier: Resource. ResourceID can be a unique identifier for a resource. ResourceID can be based on GDT: ResourceID. ResourceHomeCountryCode can be a coded representation of the home country of a resource. ResourceHomeCountryCode can be based on GDT: CountryCode, Qualifier: ResourceHome. TransportationUnitResourceCategoryCode can be a coded representation of a category of transportation unit resources. TransportationUnitResourceCategoryCode can be based on GDT: TransportationUnitResourceCategoryCode. TransportationUnitResourceTypeCode can be a coded representation of the type of a transportation unit resource. TransportationUnitResourceTypeCode can be based on GDT: TransportationUnitResourceTypeCode.
FillLevelCode can be a coded representation of a fill level of a resource. FillLevelCode can be based on GDT: FillLevelCode. ShippingTypeCode can be a coded representation of a shipping type. A shipping type can specify how planning and execution of a transportation may be performed. Transportation terms include detailed specifications on agreed means of transportation, such as shipping/transport type and means of transport to be used. ShippingTypeCode can be based on GDT: ShippingTypeCode. HaulageArrangerCode can be a coded representation of an arranger of a haulage. Haulage can be inland transport of cargo. HaulageArrangerCode can be based on GDT: HaulageArrangerCode. TransportationHandlingInstructionCode can be a coded representation of a type of transportation handling instruction. TransportationHandlingInstructionCode can be based on GDT: TransportationHandlingInstructionCode. TransportationHandlingInstructionNote can be a note regarding a transportation handling instruction. TransportationHandlingInstructionNote can be based on GDT: LONG_Note, Qualifier: TransportationHandlingInstruction.
TransportationStageAssignment can specify an assignment of a transportation stage to a transportation unit resource information. The structure of TransportationStageAssignment includes the ShipmentRequestTransportationStageID element. ShipmentRequestTransportationStageID can be a unique identifier of a TransportationStage in a shipment request. ShipmentRequestTransportationStageID can be based on GDT: TransportationStageID.
AttachedEquipment can specify equipment attached to a TransportationUnitResource. The structure of AttachedEquipment includes the element ShipmentRequestResourceInformationID. ShipmentRequestResourceInformationID can be a unique identifier of a resource information in a ShipmentRequest. ShipmentRequestResourceInformationID can be based on GDT: ResourceInformationID.
Quantity can specify a quantity related to a TransportationUnitResourceInformation. The structure of the Quantity entity includes the Quantity, RoleCode, and TypeCode elements. Quantity can be a non-monetary numerical specification of an amount in a unit of measurement. Quantity can be based on GDT: Quantity. RoleCode can be a coded representation of a role of a quantity. RoleCode can be based on GDT: QuantityRoleCode. TypeCode can be a coded representation of a type of quantity that is based on a measurable characteristic of an object or physical phenomenon. TypeCode can be based on GDT: QuantityTypeCode. In some implementations, QuantityRoleCode and QuantityTypeCode are optional, but in every instance one of them may be filled.
BusinessTransactionDocumentReference can specify a business document reference related to a TransportationUnitResource. BusinessTransactionDocumentReference includes the DateTimePeriod entity. The structure of the BusinessTransactionDocumentReference entity includes the following elements: BusinessTransactionDocumentReference, BusinessTransactionDocumentRelationshipRoleCode, BusinessTransactionDocumentRelationshipTypeCode, TransportationDocumentTypeCode, TransportationDocumentNote, and TransportationDocumentID. BusinessTransactionDocumentReference can be a unique reference to other business documents or business document items that are of significance within each respective business process. BusinessTransactionDocumentReference can be based on GDT: BusinessTransactionDocumentReference.
BusinessTransactionDocumentRelationshipRoleCode can be a coded representation of a role that a business document or a business document item has when set against another business document or business document item with a relationship. BusinessTransactionDocumentRelationshipRoleCode can be based on GDT: BusinessTransactionDocumentRelationshipRoleCode. BusinessTransactionDocumentRelationshipTypeCode can be a coded representation of a relationship between two business documents or business document items. BusinessTransactionDocumentRelationshipTypeCode can be based on GDT: BusinessTransactionDocumentRelationshipTypeCode. TransportationDocumentTypeCode can be a coded representation of a documentation type. TransportationDocumentTypeCode can be based on GDT: TransportationDocumentTypeCode.
TransportationDocumentNote can be a short note on documentation. TransportationDocumentNote can be based on GDT: SHORT_Note. TransportationDocumentID can be a unique identifier for a transportation document. TransportationDocumentID can be based on GDT: TransportationDocumentID. In some implementations, RelationshipTypeCode and RelationshipRoleCode are both optional. If used, both may be filled. Either the combination BusinessTransactionDocumentReference, BusinessTransactionDocumentRelationshipRoleCode, BusinessTransactionDocumentRelationshipTypeCode, or TransportationDocumentTypeCode, TransportationDocumentNote, TransportationDocumentID may be filled.
DateTimePeriod can specify a date, time and/or period related to a BusinessTransactionDocumentReference. The structure of the DateTimePeriod entity includes the DateTimePeriod and PeriodRoleCode. DateTimePeriod can be a period that is defined by two points in time. DateTimePeriod can be based on GDT: DateTimePeriod. PeriodRoleCode can be a coded representation of business semantics of a period. PeriodRoleCode can be based on GDT: PeriodRoleCode.
TextCollection can be a group of textual information that relates to a TransportationUnitResource. The structure of the TextCollection entity includes the TextCollection element. TextCollection can be based on GDT: TextCollection.
Location can specify a physical place related to a TransportationUnitResource. The structure of the Location entity includes the following elements: Location, RoleCode, TypeCode, and Name. Location includes information exchanged in business documents about a location relevant for business transactions. Location can be based on GDT: BusinessTransactionDocumentLocation. RoleCode can be a coded representation of a LocationRole. RoleCode can be based on GDT: LocationRoleCode. TypeCode can be a coded representation of a type of a physical location. TypeCode can be based on GDT: LocationTypeCode. Name can be a name of a location. Name can be based on GDT: MEDIUM_Name, Qualifier:Location.
DateTimePeriods can specify a requested and an acceptable date, time and period related to a Location of a resource. The elements located directly at the DateTimePeriods entity include RequestedFulfillmentPeriod, AcceptableFullfilmentPeriod, and PeriodRoleCode. RequestedFulfillmentPeriod can be a period which is requested depending on semantics of the PeriodRoleCode. RequestedFulfillmentPeriod can be based on GDT: DATETIMEPERIOD, Qualifier: RequestedFulfillment. AcceptableFulfillmentPeriod can be a period which is acceptable depending on semantics of the PeriodRoleCode. AcceptableFulfillmentPeriod can be based on GDT: DATETIMEPERIOD, Qualifier: AcceptableFulfillment. PeriodRoleCode can be a coded representation of business semantics of the two periods defined by the entities RequestedFulfillmentPeriod and AcceptableFulfillmentPeriod. PeriodRoleCode can be based on GDT: PeriodRoleCode. In some implementations, RequestedFulfillmentPeriod and AcceptableFulfillmentPeriod are optional, but in every instance one of them may be filled.
DangerousGoods can specify dangerous goods included in a resource. DangerousGoods includes the ContactInformation and TextCollection entities. The structure of DangerousGoods includes the following elements: ID, RegulationsCode, HazardCode, FlashpointMeasureInterval, PackagingGroupCode, EmergencySchedule, TransportEmergencyCardCode, DangerousGoodsLabelCode, DangerousGoodsLabelCode2, DangerousGoodsLabelCode3, PackagingInstructionTypeCode, TransportMeansDescriptionCode, and TransportAuthorisationCode. ID can be a unique identifier for a dangerous good, using the United Nations Dangerous Goods Number. ID can be based on GDT: DangerousGoodsID. RegulationsCode can be a coded representation of national or international dangerous goods rules or regulations. RegulationsCode can be based on GDT: DangerousGoodsRegulationsCode.
HazardCode can be a coded representation of a hazard that is imminent in a dangerous good. HazardCode can be based on GDT: DangerousGoodsHazardCode. FlashpointMeasureInterval can be an interval of measures defined by a lower and an upper boundary indicating a flashpoint of a dangerous good. FlashpointMeasureInterval can be based on GDT: MeasureInterval, Qualifier: Flashpoint. PackagingGroupCode can be a coded representation of the effectiveness of a packaging to transport dangerous goods depending on the degree of danger of the goods. PackagingGroupCode can be based on GDT: DangerousGoodsPackagingGroupCode. EmergencySchedule can be a coded representation of an emergency schedule for dangerous goods. EmergencySchedule can identify an emergency schedule. The DangerousGoodsEmergencySchedule can be used for transports of dangerous goods by sea similar to a Transport Emergency Card which is used for transports of dangerous goods by road. EmergencySchedule can be based on GDT: DangerousGoodsEmergencySchedule. TransportEmergencyCardCode can be a coded representation of a transport emergency card which specifies how to react in case of an accident.
TransportEmergencyCardCode can be based on GDT: TransportEmergencyCardCode. DangerousGoodsLabelCode can be a coded representation of a label for a dangerous good. In some implementations, DangerousGoodsLabelCode's values are dependant on the DangerousGoodsRegulationsCode. DangerousGoodsLabelCode can be based on GDT: DangerousGoodsLabelCode. DangerousGoodsLabelCode2 can be a coded representation of a label for a dangerous good. In some implementations, DangerousGoodsLabelCode's values are dependant on the DangerousGoodsRegulationsCode. DangerousGoodsLabelCode2 can be based on GDT: DangerousGoodsLabelCode. DangerousGoodsLabelCode3 can be a coded representation of a label for a dangerous good. In some implementations, DangerousGoodsLabelCode's values are dependant on the DangerousGoodsRegulationsCode. DangerousGoodsLabelCode3 can be based on GDT: DangerousGoodsLabelCode. PackagingInstructionTypeCode can be a coded representation of a packaging instruction.
In some implementations, a packaging instruction is an instruction defining which packagings may be used to pack a dangerous good. PackagingInstructionTypeCode can be based on GDT: PackagingInstructionTypeCode. TransportMeansDescriptionCode can be a coded representation of a transport means type with which goods or persons are to be transported. TransportMeansDescriptionCode can be based on GDT: TransportMeansDescriptionCode. TransportAuthorisationCode can be a coded representation of an authorisation for the transportation of dangerous goods. This code can specify an authorisation for the transportation of a particular dangerous good. TransportAuthorisationCode can be based on GDT: DangerousGoodsTransportAuthorisationCode.
ContactInformation can specify information on a department or person to whom information regarding dangerous goods can be directed. The structure of ContactInformation includes the ContactPersonFunctionTypeCode and Address elements. ContactPersonFunctionTypeCode can be a coded representation of the type of function that a contact person has. ContactPersonFunctionTypeCode can be based on GDT: ContactPersonFunctionTypeCode. Address can be an address related to contact information defined by the corresponding FunctionTypeCode. Address can be based on GDT: Address.
TextCollection can be a group of textual information that relates to DangerousGoods. The structure of the TextCollection entity includes the TextCollection element. TextCollection can be based on GDT: TextCollection.
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.
