# Patent

## Title
Managing consistent interfaces for export declaration and export declaration request business objects across heterogeneous systems

## Abstract

A business object model, which reflects data that is used during a given business transaction, is utilized to generate interfaces. This business object model facilitates commercial transactions by providing consistent interfaces that are suitable for use across industries, across businesses, and across different departments within a business during a business transaction. In some operations, software creates, updates, or otherwise processes information related to an export declaration and/or an export declaration request business object.

## Background
TECHNICAL FIELD
The subject matter described herein relates generally to the generation and use of consistent interfaces (or services) derived from a business object model. More particularly, the present disclosure relates to the generation and use of consistent interfaces or services that are suitable for use across industries, across businesses, and across different departments within a business.
BACKGROUND
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.
SUMMARY
In a first aspect, a tangible computer readable medium includes program code for providing a message-based interface for exchanging information regarding a declaration to a customs authority for exporting goods according to legal requirements. The medium comprises program code for receiving via a message-based interface derived from a common business object model, where the common business object model includes business objects having relationships that enable derivation of message-based interfaces and message packages, the message-based interface exposing at least one service as defined in a service registry and from a heterogeneous application executing in an environment of computer systems providing message-based services, a first message for a request for processing an export declaration that includes a first message package derived from the common business object model and hierarchically organized in memory as an export declaration processing request message header entity and an export declaration package comprising an export declaration entity.
The medium further comprises program code for processing the first message according to the hierarchical organization of the first message package, where processing the first message includes unpacking the first message package based on the common business object model.
The medium further comprises program code for sending a second message to the heterogeneous application responsive to the first message, where the second message includes a second message package derived from the common business object model to provide consistent semantics with the first message package.
Implementations can include the following. The export declaration package further comprises at least one of the following: a customs authorization package, a time point package, a basic text package, a location package, a customs office package, a party package, a transport route country package, and an item package. The export declaration entity comprises at least one of the following: an export message sub type code, an export message identifier (ID), an export message reference ID, a customs authority country code, a major version customs authority ID, a minor version customs authority ID, a main test case ID, a sub test case ID, a customs message exchange server file ID, a customs process ID, a customs process party ID, a customs process customs authority ID, an export declaration type code, an export type code, an export exporting country code, an export destination country code, an export special circumstances code, an export transport cost payment form code, a container used indicator, an export party representation code, an item total number value, a total gross weight quantity, a total gross weight quantity type code, a consignment export ID, an inland export transport mode code, a cross border export transport mode code, a cross border export transport means type code, a cross border transport means ID, an export cross border transport means nationality code, an export business transaction type code, an invoice total net amount, an export incoterms classification code, an export incoterms classification description, an export incoterms transfer location name, and a customs authentication ID.
In another aspect, a distributed system operates in a landscape of computer systems providing message-based services defined in a service registry. The system comprises a graphical user interface comprising computer readable instructions, embedded on tangible media, for a request for processing an export declaration using a request.
The system further comprises a first memory storing a user interface controller for processing the request and involving a message including a message package derived from a common business object model, where the common business object model includes business objects having relationships that enable derivation of message-based service interfaces and message packages, the message package hierarchically organized as an export declaration processing request message header entity and an export declaration package comprising an export declaration entity.
The system further comprises a second memory, remote from the graphical user interface, storing a plurality of message-based service interfaces derived from the common business object model to provide consistent semantics with messages derived from the common business object model, where one of the message-based service interfaces processes the message according to the hierarchical organization of the message package, where processing the message includes unpacking the first message package based on the common business object model.
Implementations can include the following. The first memory is remote from the graphical user interface. The first memory is remote from the second memory.
In another aspect, a tangible computer readable medium includes program code for providing a message-based interface for exchanging information for a request to create or update an export declaration using customs-relevant business transactions. The medium comprises program code for receiving via a message-based interface derived from a common business object model, where the common business object model includes business objects having relationships that enable derivation of message-based interfaces and message packages, the message-based interface exposing at least one service as defined in a service registry and from a heterogeneous application executing in an environment of computer systems providing message-based services, a first message for a request for an export declaration request that includes a first message package derived from the common business object model and hierarchically organized in memory as an export declaration request request message entity and an export declaration request package comprising an export declaration request entity, where the export declaration request entity includes a reconciliation period counter value, an item list complete transmission indicator, a base business transaction document type code, an export declaration block indicator, and an export declaration cancel indicator.
The medium further comprises program code for processing the first message according to the hierarchical organization of the first message package, where processing the first message includes unpacking the first message package based on the common business object model.
The medium further comprises program code for sending a second message to the heterogeneous application responsive to the first message, where the second message includes a second message package derived from the common business object model to provide consistent semantics with the first message package.
Implementations can include the following. The export declaration request package further comprises at least one of the following: a party package, a location package, a business transaction document reference package, a package package, and an item package. The export declaration request entity comprises at least one of the following: an incoterms, a transport mode code, a transport means, a total net weight quantity, a total net weight quantity type code, a total gross weight quantity, and a total gross weight quantity type code.
In another aspect, a distributed system operates in a landscape of computer systems providing message-based services defined in a service registry. The system comprises a graphical user interface comprising computer readable instructions, embedded on tangible media, for a request for an export declaration request using a request.
The system further comprises a first memory storing a user interface controller for processing the request and involving a message including a message package derived from a common business object model, where the common business object model includes business objects having relationships that enable derivation of message-based service interfaces and message packages, the message package hierarchically organized as an export declaration request request message entity and an export declaration request package comprising an export declaration request entity, where the export declaration request entity includes a reconciliation period counter value, an item list complete transmission indicator, a base business transaction document type code, an export declaration block indicator, and an export declaration cancel indicator.
The system further comprises a second memory, remote from the graphical user interface, storing a plurality of message-based service interfaces derived from the common business object model to provide consistent semantics with messages derived from the common business object model, where one of the message-based service interfaces processes the message according to the hierarchical organization of the message package, where processing the message includes unpacking the first message package based on the common business object model.
Implementations can include the following. The first memory is remote from the graphical user interface. The first memory is remote from the second memory.



BRIEF DESCRIPTION OF THE DRAWINGS
FIG. 1 depicts a flow diagram of the overall steps performed by methods and systems consistent with the subject matter described herein.
FIG. 2 depicts a business document flow for an invoice request in accordance with methods and systems consistent with the subject matter described herein.
FIGS. 3A-B illustrate example environments implementing the transmission, receipt, and processing of data between heterogeneous applications in accordance with certain embodiments included in the present disclosure.
FIG. 4 illustrates an example application implementing certain techniques and components in accordance with one embodiment of the system of FIG. 1.
FIG. 5A depicts an example development environment in accordance with one embodiment of FIG. 1.
FIG. 5B depicts a simplified process for mapping a model representation to a runtime representation using the example development environment of FIG. 5A or some other development environment.
FIG. 6 depicts message categories in accordance with methods and systems consistent with the subject matter described herein.
FIG. 7 depicts an example of a package in accordance with methods and systems consistent with the subject matter described herein.
FIG. 8 depicts another example of a package in accordance with methods and systems consistent with the subject matter described herein.
FIG. 9 depicts a third example of a package in accordance with methods and systems consistent with the subject matter described herein.
FIG. 10 depicts a fourth example of a package in accordance with methods and systems consistent with the subject matter described herein.
FIG. 11 depicts the representation of a package in the XML schema in accordance with methods and systems consistent with the subject matter described herein.
FIG. 12 depicts a graphical representation of cardinalities between two entities in accordance with methods and systems consistent with the subject matter described herein.
FIG. 13 depicts an example of a composition in accordance with methods and systems consistent with the subject matter described herein.
FIG. 14 depicts an example of a hierarchical relationship in accordance with methods and systems consistent with the subject matter described herein.
FIG. 15 depicts an example of an aggregating relationship in accordance with methods and systems consistent with the subject matter described herein.
FIG. 16 depicts an example of an association in accordance with methods and systems consistent with the subject matter described herein.
FIG. 17 depicts an example of a specialization in accordance with methods and systems consistent with the subject matter described herein.
FIG. 18 depicts the categories of specializations in accordance with methods and systems consistent with the subject matter described herein.
FIG. 19 depicts an example of a hierarchy in accordance with methods and systems consistent with the subject matter described herein.
FIG. 20 depicts a graphical representation of a hierarchy in accordance with methods and systems consistent with the subject matter described herein.
FIGS. 21A-B depict a flow diagram of the steps performed to create a business object model in accordance with methods and systems consistent with the subject matter described herein.
FIGS. 22A-F depict a flow diagram of the steps performed to generate an interface from the business object model in accordance with methods and systems consistent with the subject matter described herein.
FIG. 23 depicts an example illustrating the transmittal of a business document in accordance with methods and systems consistent with the subject matter described herein.
FIG. 24 depicts an interface proxy in accordance with methods and systems consistent with the subject matter described herein.
FIG. 25 depicts an example illustrating the transmittal of a message using proxies in accordance with methods and systems consistent with the subject matter described herein.
FIG. 26A depicts components of a message in accordance with methods and systems consistent with the subject matter described herein.
FIG. 26B depicts IDs used in a message in accordance with methods and systems consistent with the subject matter described herein.
FIGS. 27A-E depict a hierarchization process in accordance with methods and systems consistent with the subject matter described herein.
FIG. 28 illustrates an example method for service enabling in accordance with one embodiment of the present disclosure.
FIG. 29 is a graphical illustration of an example business object and associated components as may be used in the enterprise service infrastructure system of the present disclosure.
FIG. 30 illustrates an example method for managing a process agent framework in accordance with one embodiment of the present disclosure.
FIG. 31 illustrates an example method for status and action management in accordance with one embodiment of the present disclosure.
FIGS. 32-1 through 32-6 depict an example object model for a business object Export Declaration.
FIG. 33 depicts an example Export Declaration Processing Cancellation Request Message Data Type.
FIGS. 34-1 through 34-2 depict an example Export Declaration Processing Confirmation Message Data Type.
FIGS. 35-1 through 35-2 depict an example Export Declaration Processing Request Message Data Type.
FIG. 36 depicts an example Export Message Exchange Notification Message Data Type.
FIG. 37 depicts an example Export Message Semantic Error Notification Message Data Type.
FIG. 38 depicts an example Export Message Syntax Error Notification Message Data Type.
FIG. 39 depicts an example Export Processing Information Confirmation Message Data Type.
FIG. 40 depicts an example Export Processing Information Request Message Data Type.
FIGS. 41-1 through 41-2 depict an example Export Processing Notification Message Data Type.
FIGS. 42-1 through 42-4 depict an example Form Export Declaration Processing in Fallback Procedure Request Message Data Type.
FIGS. 43-1 through 43-42 show an example configuration of an Element Structure that includes an ExportDeclarationProcessingCancellationRequest package.
FIGS. 44-1 through 44-158 show an example configuration of an Element Structure that includes an ExportDeclarationProcessingConfirmation package.
FIGS. 45-1 through 45-143 show an example configuration of an Element Structure that includes an ExportDeclarationProcessingRequest package.
FIGS. 46-1 through 46-6 show an example configuration of an Element Structure that includes an ExportMessageExchangeNotification package.
FIGS. 47-1 through 47-7 show an example configuration of an Element Structure that includes an ExportMessageSemanticErrorNotification package.
FIGS. 48-1 through 48-7 show an example configuration of an Element Structure that includes an ExportMessageSyntaxErrorNotification package.
FIGS. 49-1 through 49-40 show an example configuration of an Element Structure that includes an ExportProcessingInformationConfirmation package.
FIGS. 50-1 through 50-41 show an example configuration of an Element Structure that includes an ExportProcessingInformationRequest package.
FIGS. 51-1 through 51-102 show an example configuration of an Element Structure that includes an ExportProcessingNotification package.
FIGS. 52-1 through 52-22 show an example configuration of an Element Structure that includes a FormExportDeclarationProcessinglnFallbackProcedureRequest package.
FIGS. 53-1 through 53-6 depict an example object model for a business object Export Declaration Request.
FIGS. 54-1 through 54-2 depict an example Export Declaration Request Request Message Data Type.
FIGS. 55-1 through 55-167 show an example configuration of an Element Structure that includes an ExportDeclarationRequestRequest package.



DETAILED DESCRIPTION
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.
FIG. 1 depicts a flow diagram 100 showing an example technique, perhaps implemented by systems similar to those disclosed herein. Initially, to generate the business object model, design engineers study the details of a business process, and model the business process using a “business scenario” (step 102). The business scenario identifies the steps performed by the different business entities during a business process. Thus, the business scenario is a complete representation of a clearly defined business process.
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.
FIG. 2 depicts an example business document flow 200 for the process of purchasing a product or service. The business entities involved with the illustrative purchase process include Accounting 202, Payment 204, Invoicing 206, Supply Chain Execution (“SCE”) 208, Supply Chain Planning (“SCP”) 210, Fulfillment Coordination (“FC”) 212, Supply Relationship Management (“SRM”) 214, Supplier 216, and Bank 218. The business document flow 200 is divided into four different transactions: Preparation of Ordering (“Contract”) 220, Ordering 222, Goods Receiving (“Delivery”) 224, and Billing/Payment 226. In the business document flow, arrows 228 represent the transmittal of documents. Each document reflects a message transmitted between entities. One of ordinary skill in the art will appreciate that the messages transferred may be considered to be a communications protocol. The process flow follows the focus of control, which is depicted as a solid vertical line (e.g., 229) when the step is required, and a dotted vertical line (e.g., 230) when the step is optional.
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 FIG. 2, Purchase Requirement Requests 234, 236 and Purchase Requirement Confirmations 238, 240 have the same structures. Thus, each of these business documents is marked with an “O6.” Similarly, Purchase Order Request 242 and Purchase Order Confirmation 248 have the same structures. Thus, both documents are marked with an “O1.” Each business document or message is based on a message type.
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 FIG. 1 were described as being performed manually, one skilled in the art will appreciate that such steps could be computer-assisted or performed entirely by a computer, including being performed by either hardware, software, or any other combination thereof.
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 FIG. 3A, environment 300 includes or is communicably coupled (such as via a one-, bi- or multi-directional link or network) with server 302, one or more clients 304, one or more or vendors 306, one or more customers 308, at least some of which communicate across network 312. But, of course, this illustration is for example purposes only, and any distributed system or environment implementing one or more of the techniques described herein may be within the scope of this disclosure. Server 302 comprises an electronic computing device operable to receive, transmit, process and store data associated with environment 300. Generally, FIG. 3A provides merely one example of computers that may be used with the disclosure. Each computer is generally intended to encompass any suitable processing device. For example, although FIG. 3A illustrates one server 302 that may be used with the disclosure, environment 300 can be implemented using computers other than servers, as well as a server pool. Indeed, server 302 may be any computer or processing device such as, for example, a blade server, general-purpose personal computer (PC), Macintosh, workstation, Unix-based computer, or any other suitable device. In other words, the present disclosure contemplates computers other than general purpose computers as well as computers without conventional operating systems. Server 302 may be adapted to execute any operating system including Linux, UNIX, Windows Server, or any other suitable operating system. According to one embodiment, server 302 may also include or be communicably coupled with a web server and/or a mail server.
As illustrated (but not required), the server 302 is communicably coupled with a relatively remote repository 335 over a portion of the network 312. The repository 335 is any electronic storage facility, data processing center, or archive that may supplement or replace local memory (such as 327). The repository 335 may be a central database communicably coupled with the one or more servers 302 and the clients 304 via a virtual private network (VPN), SSH (Secure Shell) tunnel, or other secure network connection. The repository 335 may be physically or logically located at any appropriate location including in one of the example enterprises or off-shore, so long as it remains operable to store information associated with the environment 300 and communicate such data to the server 302 or at least a subset of plurality of the clients 304.
Illustrated server 302 includes local memory 327. Memory 327 may include any memory or database module and may take the form of volatile or non-volatile memory including, without limitation, magnetic media, optical media, random access memory (RAM), read-only memory (ROM), removable media, or any other suitable local or remote memory component. Illustrated memory 327 includes an exchange infrastructure (“XI”) 314, which is an infrastructure that supports the technical interaction of business processes across heterogeneous system environments. XI 314 centralizes the communication between components within a business entity and between different business entities. When appropriate, XI 314 carries out the mapping between the messages. XI 314 integrates different versions of systems implemented on different platforms (e.g., Java and ABAP). XI 314 is based on an open architecture, and makes use of open standards, such as eXtensible Markup Language (XML)TM and Java environments. XI 314 offers services that are useful in a heterogeneous and complex system landscape. In particular, XI 314 offers a runtime infrastructure for message exchange, configuration options for managing business processes and message flow, and options for transforming message contents between sender and receiver systems.
XI 314 stores data types 316, a business object model 318, and interfaces 320. The details regarding the business object model are described below. Data types 316 are the building blocks for the business object model 318. The business object model 318 is used to derive consistent interfaces 320. XI 314 allows for the exchange of information from a first company having one computer system to a second company having a second computer system over network 312 by using the standardized interfaces 320.
While not illustrated, memory 327 may also include business objects and any other appropriate data such as services, interfaces, VPN applications or services, firewall policies, a security or access log, print or other reporting files, HTML files or templates, data classes or object interfaces, child software applications or sub-systems, and others. This stored data may be stored in one or more logical or physical repositories. In some embodiments, the stored data (or pointers thereto) may be stored in one or more tables in a relational database described in terms of SQL statements or scripts. In the same or other embodiments, the stored data may also be formatted, stored, or defined as various data structures in text files, XML documents, Virtual Storage Access Method (VSAM) files, flat files, Btrieve files, comma-separated-value (CSV) files, internal variables, or one or more libraries. For example, a particular data service record may merely be a pointer to a particular piece of third party software stored remotely. In another example, a particular data service may be an internally stored software object usable by authenticated customers or internal development. In short, the stored data may comprise one table or file or a plurality of tables or files stored on one computer or across a plurality of computers in any appropriate format. Indeed, some or all of the stored data may be local or remote without departing from the scope of this disclosure and store any type of appropriate data.
Server 302 also includes processor 325. Processor 325 executes instructions and manipulates data to perform the operations of server 302 such as, for example, a central processing unit (CPU), a blade, an application specific integrated circuit (ASIC), or a field-programmable gate array (FPGA). Although FIG. 3A illustrates a single processor 325 in server 302, multiple processors 325 may be used according to particular needs and reference to processor 325 is meant to include multiple processors 325 where applicable. In the illustrated embodiment, processor 325 executes at least business application 330.
At a high level, business application 330 is any application, program, module, process, or other software that utilizes or facilitates the exchange of information via messages (or services) or the use of business objects. For example, application 330 may implement, utilize or otherwise leverage an enterprise service-oriented architecture (enterprise SOA), which may be considered a blueprint for an adaptable, flexible, and open IT architecture for developing services-based, enterprise-scale business solutions. This example enterprise service may be a series of web services combined with business logic that can be accessed and used repeatedly to support a particular business process. Aggregating web services into business-level enterprise services helps provide a more meaningful foundation for the task of automating enterprise-scale business scenarios Put simply, enterprise services help provide a holistic combination of actions that are semantically linked to complete the specific task, no matter how many cross-applications are involved. In certain cases, environment 300 may implement a composite application 330, as described below in FIG. 4. Regardless of the particular implementation, “software” may include software, firmware, wired or programmed hardware, or any combination thereof as appropriate. Indeed, application 330 may be written or described in any appropriate computer language including C, C++, Java, Visual Basic, assembler, Perl, any suitable version of 4GL, as well as others. For example, returning to the above mentioned composite application, the composite application portions may be implemented as Enterprise Java Beans (EJBs) or the design-time components may have the ability to generate run-time implementations into different platforms, such as J2EE (Java 2 Platform, Enterprise Edition), ABAP (Advanced Business Application Programming) objects, or Microsoft's .NET. It will be understood that while application 330 is illustrated in FIG. 4 as including various sub-modules, application 330 may include numerous other sub-modules or may instead be a single multi-tasked module that implements the various features and functionality through various objects, methods, or other processes. Further, while illustrated as internal to server 302, one or more processes associated with application 330 may be stored, referenced, or executed remotely. For example, a portion of application 330 may be a web service that is remotely called, while another portion of application 330 may be an interface object bundled for processing at remote client 304. Moreover, application 330 may be a child or sub-module of another software module or enterprise application (not illustrated) without departing from the scope of this disclosure. Indeed, application 330 may be a hosted solution that allows multiple related or third parties in different portions of the process to perform the respective processing.
More specifically, as illustrated in FIG. 4, application 330 may be a composite application, or an application built on other applications, that includes an object access layer (OAL) and a service layer. In this example, application 330 may execute or provide a number of application services, such as customer relationship management (CRM) systems, human resources management (HRM) systems, financial management (FM) systems, project management (PM) systems, knowledge management (KM) systems, and electronic file and mail systems. Such an object access layer is operable to exchange data with a plurality of enterprise base systems and to present the data to a composite application through a uniform interface. The example service layer is operable to provide services to the composite application. These layers may help the composite application to orchestrate a business process in synchronization with other existing processes (e.g., native processes of enterprise base systems) and leverage existing investments in the IT platform. Further, composite application 330 may run on a heterogeneous IT platform. In doing so, composite application may be cross-functional in that it may drive business processes across different applications, technologies, and organizations. Accordingly, composite application 330 may drive end-to-end business processes across heterogeneous systems or sub-systems. Application 330 may also include or be coupled with a persistence layer and one or more application system connectors. Such application system connectors enable data exchange and integration with enterprise sub-systems and may include an Enterprise Connector (EC) interface, an Internet Communication Manager/Internet Communication Framework (ICM/ICF) interface, an Encapsulated PostScript (EPS) interface, and/or other interfaces that provide Remote Function Call (RFC) capability. It will be understood that while this example describes a composite application 330, it may instead be a standalone or (relatively) simple software program. Regardless, application 330 may also perform processing automatically, which may indicate that the appropriate processing is substantially performed by at least one component of environment 300. It should be understood that automatically further contemplates any suitable administrator or other user interaction with application 330 or other components of environment 300 without departing from the scope of this disclosure.
Returning to FIG. 3A, illustrated server 302 may also include interface 317 for communicating with other computer systems, such as clients 304, over network 312 in a client-server or other distributed environment. In certain embodiments, server 302 receives data from internal or external senders through interface 317 for storage in memory 327, for storage in DB 335, and/or processing by processor 325. Generally, interface 317 comprises logic encoded in software and/or hardware in a suitable combination and operable to communicate with network 312. More specifically, interface 317 may comprise software supporting one or more communications protocols associated with communications network 312 or hardware operable to communicate physical signals.
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 FIG. 3B, a Foundation Layer 375 can be deployed on multiple separate and distinct hardware platforms, e.g., System A 350 and System B 360, to support application software deployed as two or more deployment units distributed on the platforms, including deployment unit 352 deployed on System A and deployment unit 362 deployed on System B. In this example, the foundation layer can be used to support application software deployed in an application layer. In particular, the foundation layer can be used in connection with application software implemented in accordance with a software architecture that provides a suite of enterprise service operations having various application functionality. In some implementations, the application software is implemented to be deployed on an application platform that includes a foundation layer that contains all fundamental entities that can used from multiple deployment units. These entities can be process components, business objects, and reuse service components. A reuse service component is a piece of software that is reused in different transactions. A reuse service component is used by its defined interfaces, which can be, e.g., local APIs or service interfaces. As explained above, process components in separate deployment units interact through service operations, as illustrated by messages passing between service operations 356 and 366, which are implemented in process components 354 and 364, respectively, which are included in deployment units 352 and 362, respectively. As also explained above, some form of direct communication is generally the form of interaction used between a business object, e.g., business object 358 and 368, of an application deployment unit and a business object, such as master data object 370, of the Foundation Layer 375.
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.
FIG. 5A depicts an example modeling environment 516, namely a modeling environment, in accordance with one embodiment of the present disclosure. Thus, as illustrated in FIG. 5A, such a modeling environment 516 may implement techniques for decoupling models created during design-time from the runtime environment. In other words, model representations for GUIs created in a design time environment are decoupled from the runtime environment in which the GUIs are executed. Often in these environments, a declarative and executable representation for GUIs for applications is provided that is independent of any particular runtime platform, GUI framework, device, or programming language.
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 FIG. 5A, modeling tool 340 may be used by a GUI designer or business analyst during the application design phase to create a model representation 502 for a GUI application. It will be understood that modeling environment 516 may include or be compatible with various different modeling tools 340 used to generate model representation 502. This model representation 502 may be a machine-readable representation of an application or a domain specific model. Model representation 502 generally encapsulates various design parameters related to the GUI such as GUI components, dependencies between the GUI components, inputs and outputs, and the like. Put another way, model representation 502 provides a form in which the one or more models can be persisted and transported, and possibly handled by various tools such as code generators, runtime interpreters, analysis and validation tools, merge tools, and the like. In one embodiment, model representation 502 maybe a collection of XML documents with a well-formed syntax.
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 FIG. 5A, an XGL-to-Java compiler 508A may take abstract representation 506 as input and generate Java code 510 for execution by a target device comprising a Java runtime 512. Java runtime 512 may execute Java code 510 to generate or display a GUI 514 on a Java-platform target device. As another example, an XGL-to-Flash compiler 508B may take abstract representation 506 as input and generate Flash code 526 for execution by a target device comprising a Flash runtime 518. Flash runtime 518 may execute Flash code 516 to generate or display a GUI 520 on a target device comprising a Flash platform. As another example, an XGL-to-DHTML (dynamic HTML) interpreter 508C may take abstract representation 506 as input and generate DHTML statements (instructions) on the fly which are then interpreted by a DHTML runtime 522 to generate or display a GUI 524 on a target device comprising a DHTML platform.
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.
FIG. 5B depicts an example process for mapping a model representation 502 to a runtime representation using the example modeling environment 516 of FIG. 5A or some other modeling environment. Model representation 502 may comprise one or more model components and associated properties that describe a data object, such as hosted business objects and interfaces. As described above, at least one of these model components is based on or otherwise associated with these hosted business objects and interfaces. The abstract representation 506 is generated based upon model representation 502. Abstract representation 506 may be generated by the abstract representation generator 504. Abstract representation 506 comprises one or more abstract GUI components and properties associated with the abstract GUI components. As part of generation of abstract representation 506, the model GUI components and their associated properties from the model representation are mapped to abstract GUI components and properties associated with the abstract GUI components. Various mapping rules may be provided to facilitate the mapping. The abstract representation encapsulates both appearance and behavior of a GUI. Therefore, by mapping model components to abstract components, the abstract representation not only specifies the visual appearance of the GUI but also the behavior of the GUI, such as in response to events whether clicking/dragging or scrolling, interactions between GUI components and such.
One or more runtime representations 550a, including GUIs for specific runtime environment platforms, may be generated from abstract representation 506. A device-dependent runtime representation may be generated for a particular type of target device platform to be used for executing and displaying the GUI encapsulated by the abstract representation. The GUIs generated from abstract representation 506 may comprise various types of GUI elements such as buttons, windows, scrollbars, input boxes, etc. Rules may be provided for mapping an abstract representation to a particular runtime representation. Various mapping rules may be provided for different runtime environment platforms.
Methods and systems consistent with the subject matter described herein provide and use interfaces 320 derived from the business object model 318 suitable for use with more than one business area, for example different departments within a company such as finance, or marketing. Also, they are suitable across industries and across businesses. Interfaces 320 are used during an end-to-end business transaction to transfer business process information in an application-independent manner. For example the interfaces can be used for fulfilling a sales order.
1. Message Overview
To perform an end-to-end business transaction, consistent interfaces are used to create business documents that are sent within messages between heterogeneous programs or modules.
a) Message Categories
As depicted in FIG. 6, the communication between a sender 602 and a recipient 604 can be broken down into basic categories that describe the type of the information exchanged and simultaneously suggest the anticipated reaction of the recipient 604. A message category is a general business classification for the messages. Communication is sender-driven. In other words, the meaning of the message categories is established or formulated from the perspective of the sender 602. The message categories include information 606, notification 608, query 610, response 612, request 614, and confirmation 616.
(1) Information
Information 606 is a message sent from a sender 602 to a recipient 604 concerning a condition or a statement of affairs. No reply to information is expected. Information 606 is sent to make business partners or business applications aware of a situation. Information 606 is not compiled to be application-specific. Examples of “information” are an announcement, advertising, a report, planning information, and a message to the business warehouse.
(2) Notification
A notification 608 is a notice or message that is geared to a service. A sender 602 sends the notification 608 to a recipient 604. No reply is expected for a notification. For example, a billing notification relates to the preparation of an invoice while a dispatched delivery notification relates to preparation for receipt of goods.
(3) Query
A query 610 is a question from a sender 602 to a recipient 604 to which a response 612 is expected. A query 610 implies no assurance or obligation on the part of the sender 602. Examples of a query 610 are whether space is available on a specific flight or whether a specific product is available. These queries do not express the desire for reserving the flight or purchasing the product.
(4) Response
A response 612 is a reply to a query 610. The recipient 604 sends the response 612 to the sender 602. A response 612 generally implies no assurance or obligation on the part of the recipient 604. The sender 602 is not expected to reply. Instead, the process is concluded with the response 612. Depending on the business scenario, a response 612 also may include a commitment, i.e., an assurance or obligation on the part of the recipient 604. Examples of responses 612 are a response stating that space is available on a specific flight or that a specific product is available. With these responses, no reservation was made.
(5) Request
A request 614 is a binding requisition or requirement from a sender 602 to a recipient 604. Depending on the business scenario, the recipient 604 can respond to a request 614 with a confirmation 616. The request 614 is binding on the sender 602. In making the request 614, the sender 602 assumes, for example, an obligation to accept the services rendered in the request 614 under the reported conditions. Examples of a request 614 are a parking ticket, a purchase order, an order for delivery and a job application.
(6) Confirmation
A confirmation 616 is a binding reply that is generally made to a request 614. The recipient 604 sends the confirmation 616 to the sender 602. The information indicated in a confirmation 616, such as deadlines, products, quantities and prices, can deviate from the information of the preceding request 614. A request 614 and confirmation 616 may be used in negotiating processes. A negotiating process can consist of a series of several request 614 and confirmation 616 messages. The confirmation 616 is binding on the recipient 604. For example, 100 units of X may be ordered in a purchase order request; however, only the delivery of 80 units is confirmed in the associated purchase order confirmation.
b) Message Choreography
A message choreography is a template that specifies the sequence of messages between business entities during a given transaction. The sequence with the messages contained in it describes in general the message “lifecycle” as it proceeds between the business entities. If messages from a choreography are used in a business transaction, they appear in the transaction in the sequence determined by the choreography. This illustrates the template character of a choreography, i.e., during an actual transaction, it is not necessary for all messages of the choreography to appear. Those messages that are contained in the transaction, however, follow the sequence within the choreography. A business transaction is thus a derivation of a message choreography. The choreography makes it possible to determine the structure of the individual message types more precisely and distinguish them from one another.
2. Components of the Business Object Model
The overall structure of the business object model ensures the consistency of the interfaces that are derived from the business object model. The derivation ensures that the same business-related subject matter or concept is represented and structured in the same way in all interfaces.
The business object model defines the business-related concepts at a central location for a number of business transactions. In other words, it reflects the decisions made about modeling the business entities of the real world acting in business transactions across industries and business areas. The business object model is defined by the business objects and their relationship to each other (the overall net structure).
Each business object is generally a capsule with an internal hierarchical structure, behavior offered by its operations, and integrity constraints. Business objects are semantically disjoint, i.e., the same business information is represented once. In the business object model, the business objects are arranged in an ordering framework. From left to right, they are arranged according to their existence dependency to each other. For example, the customizing elements may be arranged on the left side of the business object model, the strategic elements may be arranged in the center of the business object model, and the operative elements may be arranged on the right side of the business object model. Similarly, the business objects are arranged from the top to the bottom based on defined order of the business areas, e.g., finance could be arranged at the top of the business object model with CRM below finance and SRM below CRM.
To ensure the consistency of interfaces, the business object model may be built using standardized data types as well as packages to group related elements together, and package templates and entity templates to specify the arrangement of packages and entities within the structure.
a) Data Types
Data types are used to type object entities and interfaces with a structure. This typing can include business semantic. Such data types may include those generally described at pages 96 through 1642 (which are incorporated by reference herein) of U.S. patent application Ser. No. 11/803,178, filed on May 11, 2007 and entitled “Consistent Set Of Interfaces Derived From A Business Object Model”. For example, the data type BusinessTransactionDocumentID is a unique identifier for a document in a business transaction. Also, as an example, Data type BusinessTransactionDocumentParty contains the information that is exchanged in business documents about a party involved in a business transaction, and includes the party's identity, the party's address, the party's contact person and the contact person's address. BusinessTransactionDocumentParty also includes the role of the party, e.g., a buyer, seller, product recipient, or vendor.
The data types are based on Core Component Types (“CCTs”), which themselves are based on the World Wide Web Consortium (“W3C”) data types. “Global” data types represent a business situation that is described by a fixed structure. Global data types include both context-neutral generic data types (“GDTs”) and context-based context data types (“CDTs”). GDTs contain business semantics, but are application-neutral, i.e., without context. CDTs, on the other hand, are based on GDTs and form either a use-specific view of the GDTs, or a context-specific assembly of GDTs or CDTs. A message is typically constructed with reference to a use and is thus a use-specific assembly of GDTs and CDTs. The data types can be aggregated to complex data types.
To achieve a harmonization across business objects and interfaces, the same subject matter is typed with the same data type. For example, the data type “GeoCoordinates” is built using the data type “Measure” so that the measures in a GeoCoordinate (i.e., the latitude measure and the longitude measure) are represented the same as other “Measures” that appear in the business object model.
b) Entities
Entities are discrete business elements that are used during a business transaction. Entities are not to be confused with business entities or the components that interact to perform a transaction. Rather, “entities” are one of the layers of the business object model and the interfaces. For example, a Catalogue entity is used in a Catalogue Publication Request and a Purchase Order is used in a Purchase Order Request. These entities are created using the data types defined above to ensure the consistent representation of data throughout the entities.
c) Packages
Packages group the entities in the business object model and the resulting interfaces into groups of semantically associated information. Packages also may include “sub”-packages, i.e., the packages may be nested.
Packages may group elements together based on different factors, such as elements that occur together as a rule with regard to a business-related aspect. For example, as depicted in FIG. 7, in a Purchase Order, different information regarding the purchase order, such as the type of payment 702, and payment card 704, are grouped together via the PaymentInformation package 700.
Packages also may combine different components that result in a new object. For example, as depicted in FIG. 8, the components wheels 804, motor 806, and doors 808 are combined to form a composition “Car” 802. The “Car” package 800 includes the wheels, motor and doors as well as the composition “Car.”
Another grouping within a package may be subtypes within a type. In these packages, the components are specialized forms of a generic package. For example, as depicted in FIG. 9, the components Car 904, Boat 906, and Truck 908 can be generalized by the generic term Vehicle 902 in Vehicle package 900. Vehicle in this case is the generic package 910, while Car 912, Boat 914, and Truck 916 are the specializations 918 of the generalized vehicle 910.
Packages also may be used to represent hierarchy levels. For example, as depicted in FIG. 10, the Item Package 1000 includes Item 1002 with subitem xxx 1004, subitem yyy 1006, and subitem zzz 1008.
Packages can be represented in the XML schema as a comment. One advantage of this grouping is that the document structure is easier to read and is more understandable. The names of these packages are assigned by including the object name in brackets with the suffix “Package.” For example, as depicted in FIG. 11, Party package 1100 is enclosed by <PartyPackage> 1102 and </PartyPackage> 1104. Party package 1100 illustratively includes a Buyer Party 1106, identified by <BuyerParty> 1108 and </BuyerParty> 1110, and a Seller Party 1112, identified by <SellerParty> 1114 and </SellerParty>, etc.
d) Relationships
Relationships describe the interdependencies of the entities in the business object model, and are thus an integral part of the business object model.
(1) Cardinality of Relationships
FIG. 12 depicts a graphical representation of the cardinalities between two entities. The cardinality between a first entity and a second entity identifies the number of second entities that could possibly exist for each first entity. Thus, a 1:c cardinality 1200 between entities A 1202 and X 1204 indicates that for each entity A 1202, there is either one or zero 1206 entity X 1204. A 1:1 cardinality 1208 between entities A 1210 and X 1212 indicates that for each entity A 1210, there is exactly one 1214 entity X 1212. A 1:n cardinality 1216 between entities A 1218 and X 1220 indicates that for each entity A 1218, there are one or more 1222 entity Xs 1220. A 1:cn cardinality 1224 between entities A 1226 and X 1228 indicates that for each entity A 1226, there are any number 1230 of entity Xs 1228 (i.e., 0 through n Xs for each A).
(2) Types of Relationships
(a) Composition
A composition or hierarchical relationship type is a strong whole-part relationship which is used to describe the structure within an object. The parts, or dependent entities, represent a semantic refinement or partition of the whole, or less dependent entity. For example, as depicted in FIG. 13, the components 1302, wheels 1304, and doors 1306 may be combined to form the composite 1300 “Car” 1308 using the composition 1310. FIG. 14 depicts a graphical representation of the composition 1410 between composite Car 1408 and components wheel 1404 and door 1406.
(b) Aggregation
An aggregation or an aggregating relationship type is a weak whole-part relationship between two objects. The dependent object is created by the combination of one or several less dependent objects. For example, as depicted in FIG. 15, the properties of a competitor product 1500 are determined by a product 1502 and a competitor 1504. A hierarchical relationship 1506 exists between the product 1502 and the competitor product 1500 because the competitor product 1500 is a component of the product 1502. Therefore, the values of the attributes of the competitor product 1500 are determined by the product 1502. An aggregating relationship 1508 exists between the competitor 1504 and the competitor product 1500 because the competitor product 1500 is differentiated by the competitor 1504. Therefore the values of the attributes of the competitor product 1500 are determined by the competitor 1504.
(c) Association
An association or a referential relationship type describes a relationship between two objects in which the dependent object refers to the less dependent object. For example, as depicted in FIG. 16, a person 1600 has a nationality, and thus, has a reference to its country 1602 of origin. There is an association 1604 between the country 1602 and the person 1600. The values of the attributes of the person 1600 are not determined by the country 1602.
(3) Specialization
Entity types may be divided into subtypes based on characteristics of the entity types. For example, FIG. 17 depicts an entity type “vehicle” 1700 specialized 1702 into subtypes “truck” 1704, “car” 1706, and “ship” 1708. These subtypes represent different aspects or the diversity of the entity type.
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 FIG. 18, specializations may further be characterized as complete specializations 1800 or incomplete specializations 1802. There is a complete specialization 1800 where each entity of the generalized type belongs to at least one subtype. With an incomplete specialization 1802, there is at least one entity that does not belong to a subtype. Specializations also may be disjoint 1804 or nondisjoint 1806. In a disjoint specialization 1804, each entity of the generalized type belongs to a maximum of one subtype. With a nondisjoint specialization 1806, one entity may belong to more than one subtype. As depicted in FIG. 18, four specialization categories result from the combination of the specialization characteristics.
e) Structural Patterns
(1) Item
An item is an entity type which groups together features of another entity type. Thus, the features for the entity type chart of accounts are grouped together to form the entity type chart of accounts item. For example, a chart of accounts item is a category of values or value flows that can be recorded or represented in amounts of money in accounting, while a chart of accounts is a superordinate list of categories of values or value flows that is defined in accounting.
The cardinality between an entity type and its item is often either 1:n or 1:cn. For example, in the case of the entity type chart of accounts, there is a hierarchical relationship of the cardinality 1:n with the entity type chart of accounts item since a chart of accounts has at least one item in all cases.
(2) Hierarchy
A hierarchy describes the assignment of subordinate entities to superordinate entities and vice versa, where several entities of the same type are subordinate entities that have, at most, one directly superordinate entity. For example, in the hierarchy depicted in FIG. 19, entity B 1902 is subordinate to entity A 1900, resulting in the relationship (A,B) 1912. Similarly, entity C 1904 is subordinate to entity A 1900, resulting in the relationship (A,C) 1914. Entity D 1906 and entity E 1908 are subordinate to entity B 1902, resulting in the relationships (B,D) 1916 and (B,E) 1918, respectively. Entity F 1910 is subordinate to entity C 1904, resulting in the relationship (C,F) 1920.
Because each entity has at most one superordinate entity, the cardinality between a subordinate entity and its superordinate entity is 1:c. Similarly, each entity may have 0, 1 or many subordinate entities. Thus, the cardinality between a superordinate entity and its subordinate entity is 1:cn. FIG. 20 depicts a graphical representation of a Closing Report Structure Item hierarchy 2000 for a Closing Report Structure Item 2002. The hierarchy illustrates the 1:c cardinality 2004 between a subordinate entity and its superordinate entity, and the 1:cn cardinality 2006 between a superordinate entity and its subordinate entity.
3. Creation of the Business Object Model
FIGS. 21A-B depict the steps performed using methods and systems consistent with the subject matter described herein to create a business object model. Although some steps are described as being performed by a computer, these steps may alternatively be performed manually, or computer-assisted, or any combination thereof. Likewise, although some steps are described as being performed by a computer, these steps may also be computer-assisted, or performed manually, or any combination thereof.
As discussed above, the designers create message choreographies that specify the sequence of messages between business entities during a transaction. After identifying the messages, the developers identify the fields contained in one of the messages (step 2100, FIG. 21A). The designers then determine whether each field relates to administrative data or is part of the object (step 2102). Thus, the first eleven fields identified below in the left column are related to administrative data, while the remaining fields are part of the object.
















MessageID
Admin



ReferenceID



CreationDate



SenderID



AdditionalSenderID



ContactPersonID



SenderAddress



RecipientID



AdditionalRecipientID



ContactPersonID



RecipientAddress



ID
Main Object



AdditionalID



PostingDate



LastChangeDate



AcceptanceStatus



Note



CompleteTransmission Indicator



Buyer



BuyerOrganisationName



Person Name



FunctionalTitle



DepartmentName



CountryCode



StreetPostalCode



POBox Postal Code



Company Postal Code



City Name



DistrictName



PO Box ID



PO Box Indicator



PO Box Country Code



PO Box Region Code



PO Box City Name



Street Name



House ID



Building ID



Floor ID



Room ID



Care Of Name



AddressDescription



Telefonnumber



MobileNumber



Facsimile



Email



Seller



SellerAddress



Location



LocationType



DeliveryItemGroupID



DeliveryPriority



DeliveryCondition



TransferLocation



NumberofPartialDelivery



QuantityTolerance



MaximumLeadTime



TransportServiceLevel



TranportCondition



TransportDescription



CashDiscountTerms



PaymentForm



PaymentCardID



PaymentCardReferenceID



SequenceID



Holder



ExpirationDate



AttachmentID



AttachmentFilename



DescriptionofMessage



ConfirmationDescriptionof Message



FollowUpActivity



ItemID



ParentItemID



HierarchyType



ProductID



ProductType



ProductNote



ProductCategoryID



Amount



BaseQuantity



ConfirmedAmount



ConfirmedBaseQuantity



ItemBuyer



ItemBuyerOrganisationName



Person Name



FunctionalTitle



DepartmentName



CountryCode



StreetPostalCode



POBox Postal Code



Company Postal Code



City Name



DistrictName



PO Box ID



PO Box Indicator



PO Box Country Code



PO Box Region Code



PO Box City Name



Street Name



House ID



Building ID



Floor ID



Room ID



Care Of Name



AddressDescription



Telefonnumber



MobilNumber



Facsimile



Email



ItemSeller



ItemSellerAddress



ItemLocation



ItemLocationType



ItemDeliveryItemGroupID



ItemDeliveryPriority



ItemDeliveryCondition



ItemTransferLocation



ItemNumberofPartialDelivery



ItemQuantityTolerance



ItemMaximumLeadTime



ItemTransportServiceLevel



ItemTranportCondition



ItemTransportDescription



ContractReference



QuoteReference



CatalogueReference



ItemAttachmentID



ItemAttachmentFilename



ItemDescription



ScheduleLineID



DeliveryPeriod



Quantity



ConfirmedScheduleLineID



ConfirmedDeliveryPeriod



ConfirmedQuantity










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.















ID
Pur-




AdditionalID
chase


PostingDate
Order


LastChangeDate


AcceptanceStatus


Note


CompleteTransmission


Indicator


Buyer

Buyer


BuyerOrganisationName


Person Name


FunctionalTitle


DepartmentName


CountryCode


StreetPostalCode


POBox Postal Code


Company Postal Code


City Name


DistrictName


PO Box ID


PO Box Indicator


PO Box Country Code


PO Box Region Code


PO Box City Name


Street Name


House ID


Building ID


Floor ID


Room ID


Care Of Name


AddressDescription


Telefonnumber


MobileNumber


Facsimile


Email


Seller

Seller


SellerAddress


Location

Location


LocationType


DeliveryItemGroupID

DeliveryTerms


DeliveryPriority


DeliveryCondition


TransferLocation


NumberofPartialDelivery


QuantityTolerance


MaximumLeadTime


TransportServiceLevel


TranportCondition


TransportDescription


CashDiscountTerms


PaymentForm

Payment


PaymentCardID


PaymentCardReferenceID


SequenceID


Holder


ExpirationDate


AttachmentID


AttachmentFilename


DescriptionofMessage


ConfirmationDescriptionof


Message


FollowUpActivity


ItemID

Purchase Order


ParentItemID

Item


HierarchyType


ProductID


Product


ProductType


ProductNote


ProductCategoryID


ProductCategory


Amount


BaseQuantity


ConfirmedAmount


ConfirmedBaseQuantity


ItemBuyer


Buyer


ItemBuyerOrganisation


Name


Person Name


FunctionalTitle


DepartmentName


CountryCode


StreetPostalCode


POBox Postal Code


Company Postal Code


City Name


DistrictName


PO Box ID


PO Box Indicator


PO Box Country Code


PO Box Region Code


PO Box City Name


Street Name


House ID


Building ID


Floor ID


Room ID


Care Of Name


AddressDescription


Telefonnumber


MobilNumber


Facsimile


Email


ItemSeller


Seller


ItemSellerAddress


ItemLocation


Location


ItemLocationType


ItemDeliveryItemGroupID


ItemDeliveryPriority


ItemDeliveryCondition


ItemTransferLocation


ItemNumberofPartial


Delivery


ItemQuantityTolerance


ItemMaximumLeadTime


ItemTransportServiceLevel


ItemTranportCondition


ItemTransportDescription


ContractReference


Contract


QuoteReference


Quote


CatalogueReference


Catalogue


ItemAttachmentID


ItemAttachmentFilename


ItemDescription


ScheduleLineID


DeliveryPeriod


Quantity


ConfirmedScheduleLineID


ConfirmedDeliveryPeriod


ConfirmedQuantity









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.
















PurchaseOrder



1



Buyer


0 . . . 1




Address

0 . . . 1




ContactPerson

0 . . . 1





Address
0 . . . 1



Seller


0 . . . 1



Location


0 . . . 1




Address

0 . . . 1



DeliveryTerms


0 . . . 1




Incoterms

0 . . . 1




PartialDelivery

0 . . . 1




QuantityTolerance

0 . . . 1




Transport

0 . . . 1



CashDiscount


0 . . . 1



Terms




MaximumCashDiscount

0 . . . 1




NormalCashDiscount

0 . . . 1



PaymentForm


0 . . . 1




PaymentCard

0 . . . 1



Attachment


0 . . . n



Description


0 . . . 1



Confirmation


0 . . . 1



Description



Item


0 . . . n




HierarchyRelationship

0 . . . 1




Product

0 . . . 1




ProductCategory

0 . . . 1




Price

0 . . . 1





NetunitPrice
0 . . . 1




ConfirmedPrice

0 . . . 1





NetunitPrice
0 . . . 1




Buyer

0 . . . 1




Seller

0 . . . 1




Location

0 . . . 1




DeliveryTerms

0 . . . 1




Attachment

0 . . . n




Description

0 . . . 1




ConfirmationDescription

0 . . . 1




ScheduleLine

0 . . . n





DeliveryPeriod
1




ConfirmedScheduleLine

0 . . . n









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.

















Purchase




1


Order



PurchaseOrder



Update




PurchaseOrder Request




PurchaseOrder Change




PurchaseOrder




Confirmation



PurchaseOrder



Cancellation



PurchaseOrder



Information



Party




BuyerParty


0 . . . 1





Address

0 . . . 1





ContactPerson

0 . . . 1






Address
0 . . . 1




SellerParty


0 . . . 1



Location




ShipToLocation


0 . . . 1





Address

0 . . . 1




ShipFromLocation


0 . . . 1





Address

0 . . . 1



DeliveryTerms



0 . . . 1




Incoterms


0 . . . 1




PartialDelivery


0 . . . 1




QuantityTolerance


0 . . . 1




Transport


0 . . . 1



CashDiscount



0 . . . 1



Terms




MaximumCash Discount


0 . . . 1




NormalCashDiscount


0 . . . 1



PaymentForm



0 . . . 1




PaymentCard


0 . . . 1



Attachment



0 . . . n



Description



0 . . . 1



Confirmation



0 . . . 1



Description



Item



0 . . . n




HierarchyRelationship


0 . . . 1




Product


0 . . . 1




ProductCategory


0 . . . 1




Price


0 . . . 1





NetunitPrice

0 . . . 1




ConfirmedPrice


0 . . . 1





NetunitPrice

0 . . . 1




Party





BuyerParty

0 . . . 1





SellerParty

0 . . . 1




Location





ShipTo

0 . . . 1





Location





ShipFrom

0 . . . 1





Location




DeliveryTerms


0 . . . 1




Attachment


0 . . . n




Description


0 . . . 1




Confirmation Description


0 . . . 1




ScheduleLine


0 . . . n





Delivery

1





Period




ConfirmedScheduleLine


0 . . . n









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.


















Purchase





1


Order



ID




1



SellerID




0 . . . 1



BuyerPosting




0 . . . 1



DateTime



BuyerLast




0 . . . 1



ChangeDate



Time



SellerPosting




0 . . . 1



DateTime



SellerLast




0 . . . 1



ChangeDate



Time



Acceptance




0 . . . 1



StatusCode



Note




0 . . . 1



ItemList




0 . . . 1



Complete



Transmission



Indicator



BuyerParty




0 . . . 1




StandardID



0 . . . n




BuyerID



0 . . . 1




SellerID



0 . . . 1




Address



0 . . . 1




ContactPerson



0 . . . 1





BuyerID


0 . . . 1





SellerID


0 . . . 1





Address


0 . . . 1



SellerParty




0 . . . 1



Product




0 . . . 1



RecipientParty



VendorParty




0 . . . 1



Manufacturer




0 . . . 1



Party



BillToParty




0 . . . 1



PayerParty




0 . . . 1



CarrierParty




0 . . . 1



ShipTo




0 . . . 1



Location




StandardID



0 . . . n




BuyerID



0 . . . 1




SellerID



0 . . . 1




Address



0 . . . 1



ShipFrom




0 . . . 1



Location









The system then determines whether the component is one of the object nodes in the business object model (step 2116, FIG. 21B). If the system determines that the component is one of the object nodes in the business object model, the system integrates a reference to the corresponding object node from the business object model into the object (step 2118). In the above example, the system integrates the reference to the Buyer party represented by an ID and the reference to the ShipToLocation represented by an into the object, as shown below. The attributes that were formerly located in the PurchaseOrder object are now assigned to the new found object party. Thus, the attributes are removed from the PurchaseOrder object.

















PurchaseOrder
ID





SellerID




BuyerPostingDateTime




BuyerLastChangeDateTime




SellerPostingDateTime




SellerLastChangeDateTime




AcceptanceStatusCode




Note




ItemListComplete




TransmissionIndicator




BuyerParty





ID




SellerParty




ProductRecipientParty




VendorParty




ManufacturerParty




BillToParty




PayerParty




CarrierParty




ShipToLocation





ID




ShipFromLocation










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 FIG. 27A, communication between components takes place via messages that contain business documents (e.g., business document 27002). The business document 27002 ensures a holistic business-related understanding for the recipient of the message. The business documents are created and accepted or consumed by interfaces, specifically by inbound and outbound interfaces. The interface structure and, hence, the structure of the business document are derived by a mapping rule. This mapping rule is known as “hierarchization.” An interface structure thus has a hierarchical structure created based on the leading business object 27000. The interface represents a usage-specific, hierarchical view of the underlying usage-neutral object model.
As illustrated in FIG. 27B, several business document objects 27006, 27008, and 27010 as overlapping views may be derived for a given leading object 27004. Each business document object results from the object model by hierarchization.
To illustrate the hierarchization process, FIG. 27C depicts an example of an object model 27012 (i.e., a portion of the business object model) that is used to derive a service operation signature (business document object structure). As depicted, leading object X 27014 in the object model 27012 is integrated in a net of object A 27016, object B 27018, and object C 27020. Initially, the parts of the leading object 27014 that are required for the business object document are adopted. In one variation, all parts required for a business document object are adopted from leading object 27014 (making such an operation a maximal service operation). Based on these parts, the relationships to the superordinate objects (i.e., objects A, B, and C from which object X depends) are inverted. In other words, these objects are adopted as dependent or subordinate objects in the new business document object.
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, FIG. 27D). The cardinality to these referenced objects is adopted as 1:1 or 1:C, respectively. By this, the direction of the dependency changes. The required parts of this referenced object are adopted identically, both in their cardinality and in their dependency arrangement.
The newly created business document object contains all required information, including the incorporated master data information of the referenced objects. As depicted in FIG. 27D, components Xi in leading object X 27022 are adopted directly. The relationship of object X 27022 to object A 27024, object B 27028, and object C 27026 are inverted, and the parts required by these objects are added as objects that depend from object X 27022. As depicted, all of object A 27024 is adopted. B3 and B4 are adopted from object B 27028, but B1 is not adopted. From object C 27026, C2 and C1 are adopted, but C3 is not adopted.
FIG. 27E depicts the business document object X 27030 created by this hierarchization process. As shown, the arrangement of the elements corresponds to their dependency levels, which directly leads to a corresponding representation as an XML structure 27032.
The following provides certain rules that can be adopted singly or in combination with regard to the hierarchization process. A business document object always refers to a leading business document object and is derived from this object. The name of the root entity in the business document entity is the name of the business object or the name of a specialization of the business object or the name of a service specific view onto the business object. The nodes and elements of the business object that are relevant (according to the semantics of the associated message type) are contained as entities and elements in the business document object.
The name of a business document entity is predefined by the name of the corresponding business object node. The name of the superordinate entity is not repeated in the name of the business document entity. The “full” semantic name results from the concatenation of the entity names along the hierarchical structure of the business document object.
The structure of the business document object is, except for deviations due to hierarchization, the same as the structure of the business object. The cardinalities of the business document object nodes and elements are adopted identically or more restrictively to the business document object. An object from which the leading business object is dependent can be adopted to the business document object. For this arrangement, the relationship is inverted, and the object (or its parts, respectively) are hierarchically subordinated in the business document object.
Nodes in the business object representing generalized business information can be adopted as explicit entities to the business document object (generally speaking, multiply TypeCodes out). When this adoption occurs, the entities are named according to their more specific semantic (name of TypeCode becomes prefix). Party nodes of the business object are modeled as explicit entities for each party role in the business document object. These nodes are given the name <Prefix><Party Role>Party, for example, BuyerParty, ItemBuyerParty. BTDReference nodes are modeled as separate entities for each reference type in the business document object. These nodes are given the name <Qualifier><BO><Node>Reference, for example SalesOrderReference, OriginSalesOrderReference, SalesOrderItemReference. A product node in the business object comprises all of the information on the Product, ProductCategory, and Batch. This information is modeled in the business document object as explicit entities for Product, ProductCategory, and Batch.
Entities which are connected by a 1:1 relationship as a result of hierarchization can be combined to a single entity, if they are semantically equivalent. Such a combination can often occurs if a node in the business document object that results from an assignment node is removed because it does not have any elements.
The message type structure is typed with data types. Elements are typed by GDTs according to their business objects. Aggregated levels are typed with message type specific data types (Intermediate Data Types), with their names being built according to the corresponding paths in the message type structure. The whole message type structured is typed by a message data type with its name being built according to the root entity with the suffix “Message”. For the message type, the message category (e.g., information, notification, query, response, request, confirmation, etc.) is specified according to the suited transaction communication pattern.
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.
FIGS. 22A-F depict a flow diagram of the steps performed by methods and systems consistent with the subject matter described herein to generate an interface from the business object model. Although described as being performed by a computer, these steps may alternatively be performed manually, or using any combination thereof. The process begins when the system receives an indication of a package template from the designer, i.e., the designer provides a package template to the system (step 2200).
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, FIG. 22B). The system determines whether there is a specialization in the entity template (step 2214). If the system determines that there is a specialization in the entity template, the system selects a subtype for the specialization (step 2216). The system may either select the subtype for the specialization based on the message type, or it may receive this information from the designer. The system then determines whether there are any other specializations in the entity template (step 2214). When the system determines that there are no specializations in the entity template, the system continues this analysis for the remaining packages within the package template (step 2210, FIG. 22A).
At step 2210, after the system completes its analysis for the packages within the package template, the system selects one of the packages remaining in the package template (step 2218, FIG. 22C), and selects an entity from the package (step 2220). The system receives an indication from the designer whether the entity is required for the interface (step 2222). If the entity is not required for the interface, the system removes the entity from the package template (step 2224). The system then continues this analysis for the remaining entities within the package (step 2226), and for the remaining packages within the package template (step 2228).
If, at step 2222, the entity is required for the interface, the system retrieves the cardinality between a superordinate entity and the entity from the business object model (step 2230, FIG. 22D). The system also receives an indication of the cardinality between the superordinate entity and the entity from the designer (step 2232). The system then determines whether the received cardinality is a subset of the business object model cardinality (step 2234). If the received cardinality is not a subset of the business object model cardinality, the system sends an error message to the designer (step 2236). If the received cardinality is a subset of the business object model cardinality, the system assigns the received cardinality as the cardinality between the superordinate entity and the entity (step 2238). The system then continues this analysis for the remaining entities within the package (step 2226, FIG. 22C), and for the remaining packages within the package template (step 2228).
The system then selects a leading object from the package template (step 2240, FIG. 22E). The system determines whether there is an entity superordinate to the leading object (step 2242). If the system determines that there is an entity superordinate to the leading object, the system reverses the direction of the dependency (step 2244) and adjusts the cardinality between the leading object and the entity (step 2246). The system performs this analysis for entities that are superordinate to the leading object (step 2242). If the system determines that there are no entities superordinate to the leading object, the system identifies the leading object as analyzed (step 2248).
The system then selects an entity that is subordinate to the leading object (step 2250, FIG. 22F). The system determines whether any non-analyzed entities are superordinate to the selected entity (step 2252). If a non-analyzed entity is superordinate to the selected entity, the system reverses the direction of the dependency (step 2254) and adjusts the cardinality between the selected entity and the non-analyzed entity (step 2256). The system performs this analysis for non-analyzed entities that are superordinate to the selected entity (step 2252). If the system determines that there are no non-analyzed entities superordinate to the selected entity, the system identifies the selected entity as analyzed (step 2258), and continues this analysis for entities that are subordinate to the leading object (step 2260). After the packages have been analyzed, the system substitutes the BusinessTransactionDocument (“BTD”) in the package template with the name of the interface (step 2262). This includes the “BTD” in the BTDItem package and the “BTD” in the BTDItemScheduleLine package.
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 FIG. 23, the Buyer 2300 uses an application 2306 in its system to instantiate an interface 2308 and create an interface object or business document object 2310. The Buyer's application 2306 uses data that is in the sender's component-specific structure and fills the business document object 2310 with the data. The Buyer's application 2306 then adds message identification 2312 to the business document and places the business document into a message 2302. The Buyer's application 2306 sends the message 2302 to the Vendor 2304. The Vendor 2304 uses an application 2314 in its system to receive the message 2302 and store the business document into its own memory. The Vendor's application 2314 unpacks the message 2302 using the corresponding interface 2316 stored in its XI to obtain the relevant data from the interface object or business document object 2318.
From the component's perspective, the interface is represented by an interface proxy 2400, as depicted in FIG. 24. The proxies 2400 shield the components 2402 of the sender and recipient from the technical details of sending messages 2404 via XI. In particular, as depicted in FIG. 25, at the sending end, the Buyer 2500 uses an application 2510 in its system to call an implemented method 2512, which generates the outbound proxy 2506. The outbound proxy 2506 parses the internal data structure of the components and converts them to the XML structure in accordance with the business document object. The outbound proxy 2506 packs the document into a message 2502. Transport, routing and mapping the XML message to the recipient 28304 is done by the routing system (XI, modeling environment 516, etc.).
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 FIG. 26A, a message 2600 includes a message header 2602 and a business document 2604. The message 2600 also may include an attachment 2606. For example, the sender may attach technical drawings, detailed specifications or pictures of a product to a purchase order for the product. The business document 2604 includes a business document message header 2608 and the business document object 2610. The business document message header 2608 includes administrative data, such as the message ID and a message description. As discussed above, the structure 2612 of the business document object 2610 is derived from the business object model 2614. Thus, there is a strong correlation between the structure of the business document object and the structure of the business object model. The business document object 2610 forms the core of the message 2600.
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 FIG. 26B, the message header 2618 in message 2616 includes a technical ID (“ID4”) 2622 that identifies the address for a computer to route the message. The sender's system manages the technical ID 2622.
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, FIG. 28 illustrates an example method 2800 for service enabling. In this example, the enterprise services infrastructure may offer one common and standard-based service infrastructure. Further, one central enterprise services repository may support uniform service definition, implementation and usage of services for user interface, and cross-application communication. In step 2801, a business object is defined via a process component model in a process modeling phase. Next, in step 2802, the business object is designed within an enterprise services repository. For example, FIG. 29 provides a graphical representation of one of the business objects 2900. As shown, an innermost layer or kernel 2901 of the business object may represent the business object's inherent data. Inherent data may include, for example, an employee's name, age, status, position, address, etc. A second layer 2902 may be considered the business object's logic. Thus, the layer 2902 includes the rules for consistently embedding the business object in a system environment as well as constraints defining values and domains applicable to the business object. For example, one such constraint may limit sale of an item only to a customer with whom a company has a business relationship. A third layer 2903 includes validation options for accessing the business object. For example, the third layer 2903 defines the business object's interface that may be interfaced by other business objects or applications. A fourth layer 2904 is the access layer that defines technologies that may externally access the business object.
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.
FIG. 30 illustrates an example method 3000 for a process agent framework. For example, the process agent framework may be the basic infrastructure to integrate business processes located in different deployment units. It may support a loose coupling of these processes by message based integration. A process agent may encapsulate the process integration logic and separate it from business logic of business objects. As shown in FIG. 30, an integration scenario and a process component interaction model are defined during a process modeling phase in step 3001. In step 3002, required interface operations and process agents are identified during the process modeling phase also. Next, in step 3003, a service interface, service interface operations, and the related process agent are created within an enterprise services repository as defined in the process modeling phase. In step 3004, a proxy class for the service interface is generated. Next, in step 3005, a process agent class is created and the process agent is registered. In step 3006, the agent class is implemented within a development environment.
FIG. 31 illustrates an example method 3100 for status and action management (S&AM). For example, status and action management may describe the life cycle of a business object (node) by defining actions and statuses (as their result) of the business object (node), as well as, the constraints that the statuses put on the actions. In step 3101, the status and action management schemas are modeled per a relevant business object node within an enterprise services repository. In step 3102, existing statuses and actions from the business object model are used or new statuses and actions are created. Next, in step 3103, the schemas are simulated to verify correctness and completeness. In step 3104, missing actions, statuses, and derivations are created in the business object model with the enterprise services repository. Continuing with method 3100, the statuses are related to corresponding elements in the node in step 3105. In step 3106, status code GDT's are generated, including constants and code list providers. Next, in step 3107, a proxy class for a business object service provider is generated and the proxy class S&AM schemas are imported. In step 3108, the service provider is implemented and the status and action management runtime interface is called from the actions.
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.
FIGS. 32-1 through 32-6 depict an example object model for a business object Export Declaration 32000. The business object 32000 has relationships with other objects 32002-32028, as shown with lines and arrows. The business object 32000 hierarchically comprises elements 32030-32082. The other objects 32002-32028 include respective elements 32084-32126 as shown.
The business object Export Declaration is a declaration to a customs authority for exporting goods according to legal requirements. The business object Export Declaration belongs to the process component Customs Processing. An export declaration can be a text file including customs-relevant data in EDIFACT (Electronic Data Interchange For Administration, Commerce and Transport) format, which may be sent to a customs authority using a communication method (e.g. x.400). An export declaration includes business transaction databout goods that are transported out of a customs territory, for example, quantities, values, and other customs-relevant information. The business object Export Declaration is involved in the following Process Component Interaction Models: Customs Message Exchange Server at Communication Partner_Customs Processing, Customs Processing at Customs Authority_Customs Processing_EP Notification, Customs Processing at Customs Authority_Customs Processing_EPI Requesting, Customs Processing at Customs Authority_Customs Processing_Error Notification, Customs Processing_Customs Processing at Customs Authority_ED Processing, and Customs Processing_Customs Processing at Customs Authority_Form ED Fallback Proc.
The business object Export Declaration can include a root node Export Declaration, which may be time dependent on Time Point. Goods to be exported are described by items. The root node gives information about an export procedure. The elements located directly at the node Export Declaration are defined by the data type ExportDeclarationElements. These elements include: UUID, ID, CustomsAuthorityCountryCode, TypeCode, ExportTypeCode, CustomsProcessID, CustomsProcessPartyID, ExportDestinationCountryCode, ExportSpecialCircumstancesCode, ExportTransportCostPaymentFormCode, ExportPartyRepresentationCode, ItemTotalNumberValue, InconsistentItemsTotalNumberValue, TotalpackageNumberValue, TotalGrossWeightQuantity, TotalGrossWeightQuantityTypeCode, ShortfallIndicator, ExportExitConfirmationMethodCode, ConsignmentExportID, InlandExportTransportModeCode, CrossBorderExportTransportModeCode, CrossBorderExportTransportMeansTypeCode, CrossBorderTransportMeansID, ExportCrossBorderTransportMeansNationalityCode, ExportBusinessTransactionTypeCode, InvoiceTotalNetAmount, ExportIncotermsClassificationCode, ExportIncotermsClassificationDescription, IncotermsTransferLocationName, Status, CustomsProcessingStatusCode, CustomsExportSoftwareVersionCode, SystemAdministrativeData, ApplicationLogID, ApplicationLogUUID, CustomsFallbackProcedureIncidentID, MainTestCaseID, and SubTestCaseID. UUID may be an alternative key, is an internally assigned globally unique identifier of an ExportDeclaration, and may be based on datatype GDT: UUID. ID may be an alternative key, is an internally assigned identifier for an ExportDeclaration, may be unique in a context of a deployment unit, and may be based on datatype GDT: BusinessTransactionDocumentID. CustomsAuthorityCountryCode is a country to whose customs authority an export declaration was or will be submitted, and may be based on datatype GDT: CountryCode, with a qualifier of CustomsAuthority. TypeCode is a type of an export declaration, and may be based on datatype GDT: ExportDeclarationTypeCode. Examples for an export declaration type are complete export declaration, incomplete export declaration, and supplementary export declaration. ExportTypeCode is a type of an export, and may be based on datatype GDT: ExportTypeCode. CustomsProcessID is an identifier for an export, may be assigned internally, and may be based on datatype GDT: CustomsProcessID. CustomsProcessPartyID is an identifier for an export, may be assigned by an external party, and may be based on datatype GDT: CustomsProcessID, with a qualifier of Party. CustomsProcessCustomsAuthorityID is an identifier for an export, may be assigned by a customs authority, and may be based on datatype GDT: CustomsProcessID, with a qualifier of Customs Authority. ExportExportingCountryCode is a country from which goods are exported, and may be based on datatype GDT: ExportExportingCountryCode. The ExportExportingCountryCode can differ from the CustomsAuthorityCountryCode, such as for cases (e.g., in the European Union) in which an export is declared in one country but the goods ship from another country. ExportDestinationCountryCode is a destination country of an export, and may be based on datatype GDT: ExportDestinationCountryCode. ExportSpecialCircumstancesCode documents circumstances that accompany an export, and may be based on datatype GDT: ExportSpecialCircumstancesCode. Special circumstances are a collection of highly diverse concepts that can have great impact on an export approval process, for example “exporting” operating equipment for an aircraft to international airspace, or an involvement of a highly privileged Authorised Economic Operator (AEO). ExportTransportCostPaymentFormCode is a payment form of a transport cost for an export, and may be based on datatype GDT: ExportTransportCostPaymentFormCode. Examples for a payment form are cash or cheque. ExportPartyRepresentationCode is a representation situation of parties, and may be based on datatype GDT: ExportPartyRepresentationCode. ExportPartyRepresentationCode specifies if parties are represented by other parties, and if so, which party is represented by whom. ItemTotalNumberValue is a total number of items in an export declaration, and may be based on datatype GDT: NumberValue, with a qualifier of Total. InconsistentItemsTotalNumberValue is a total number of inconsistent items in an export declaration, and may be based on datatype GDT: NumberValue, with a qualifier of Total. TotalpackageNumberValue is a total number of packages in an export declaration, and may be based on datatype GDT: NumberValue, with a qualifier of package. TotalGrossWeightQuantity is a total gross weight of export goods, and may be based on datatype GDT: Quantity, with a qualifier of Weight. Gross weight includes a weight of all items and packages. TotalGrossWeightQuantityTypeCode is a type of TotalGrossWeightQuantity, and may be based on datatype GDT: QuantityTypeCode, with a qualifier of Weight. ShortfallIndicator indicates whether there is a quantity shortfall, and may be based on datatype GDT: Indicator, with a qualifier of Shortfall. Quantity shortfall in this context means that a quantity of goods that left a customs territory is smaller than the quantity announced earlier in an export declaration. A shortfall may be reported by a customs office that monitors an exit of goods at a border. ExportExitConfirmationMethodCode is a method used to give an exit confirmation, and may be based on datatype GDT: ExportExitConfirmationMethodCode. An exit confirmation can, for example, be received electronically or in paper. ConsignmentExportID is a unique identifier of a consignment, may be used to reference an export to external parties, and may be based on datatype GDT: ConsignmentExportID. Examples for a consignment identifier are a shipment document identifier and the Unique Consignment Reference (UCR). InlandExportTransportModeCode is a transport mode used for transporting export goods inland, to a location where the goods are presented to a customs authority, and may be based on datatype GDT: ExportTransportModeCode, with a qualifier of Inland. CrossBorderExportTransportModeCode is a transport mode used for transporting export goods across a border, and may be based on datatype GDT: ExportTransportModeCode, with a qualifier of CrossBorder. CrossBorderExportTransportMeansTypeCode is a transport means used to transport export goods across a border, and may be based on datatype GDT: ExportTransportMeansTypeCode, with a qualifier of CrossBorder. CrossBorderTransportMeansID is an identifier of a transport vehicle used to transport export goods across a border, and may be based on datatype GDT: TransportMeansID_V1, with a qualifier of CrossBorder. ExportCrossBorderTransportMeansNationalityCode is a nationality of a transport means used to transport export goods across a border, and may be based on datatype GDT: ExportCrossBorderTransportMeansNationalityCode. ExportBusinessTransactionTypeCode is a type of business transaction that underlies an export, and may be based on datatype GDT: ExportBusinessTransactionTypeCode. Examples for a type of business transaction are sale and return of goods. InvoiceTotalNetAmount is a total net amount invoiced for an export, and may be based on datatype GDT: Amount, with a qualifier of Net. ExportIncotermsClassificationCode is delivery terms of an export, and may be based on datatype GDT: ExportIncotermsClassificationCode. Examples for delivery terms are factory, duty paid, and duty unpaid. ExportIncotermsClassificationDescription is a description of delivery terms, and may be based on datatype GDT: LANGUAGEINDEPENDENT_MEDIUM_Description, with a qualifier of ExportIncotermsClassification. ExportIncotermsClassificationDescription may be a representation of information given by an ExportIncotermsClassificationCode, in natural language. IncotermsTransferLocationName is a location to which delivery terms apply, and may be based on datatype GDT: MEDIUM_Name. Status is a status of an export declaration, and may be based on datatype BOIDT: ExportDeclarationStatus. CustomsProcessingStatusCode is a processing status of an export declaration at a customs authority, may be based on datatype GDT: ExportDeclarationCustomsProcessingStatusCode, and may be reported by a customs authority. CustomsExportSoftwareVersionCode is a version of export software of a customs authority that was active for an ExportDeclaration during a last action on a business object, and may be based on datatype GDT: CustomsExportSoftwareVersionCode. The version may be determined from an associated CustomsArrangement. SystemAdministrativeData is a Administrative data on a business object node, and may be based on datatype GDT: SystemAdministrativeData. ApplicationLogID is an identifier for an application log associated with an export declaration, and may be based on datatype GDT: ApplicationLogID. ApplicationLogUUID is a universally unique identifier for an application log associated with an export declaration, and may be based on datatype GDT: UUID. CustomsFallbackProcedureIncidentID is an identifier for an incident for which a fallback procedure for communication with a customs authority is used, and may be based on datatype GDT: CustomsFallbackProcedureIncidentID. MainTestCaseID is an identifier for a main test case an ExportDeclaration is used for, and may be based on datatype GDT: TestCaseID. SubTestCaseID is an identifier for a sub test case an ExportDeclaration is used for, and may be based on datatype GDT: TestCaseID.
The following composition relationships to subordinate nodes may exist: Item with a cardinality of 1:N, Time Point with a cardinality of 1:CN, Customs Authorisation with a cardinality of 1:C, Location with a cardinality of 1:CN, Customs Office with a cardinality of 1:CN, Party with a cardinality of 1:CN, Package with a cardinality of 1:CN, Container with a cardinality of 1:CN, Message with a cardinality of 1:CN, Transport Route Country with a cardinality of 1:CN, Business Transaction Document Reference with a cardinality of 1:CN, Text Collection with a cardinality of 1:C, Information Request with a cardinality of 1:CN, Attachment Folder with a cardinality of 1:C, and Controlled Output Request with a cardinality of 1:C. A Creation Identity inbound association relationship may exist from the business object Identity/node Identity, with a cardinality of 1:CN, which represents an identity that created an export declaration. A Last Changed Identity inbound association relationship may exist from the business object Identity/node Identity, with a cardinality of 1:CN, which represents an identity that last changed an export declaration. A OutboundDeliveryReference specialization association for navigation may exist to node BusinessTransactionDocumentReference, with a target cardinality of C. The following association may exist to node Party: ExporterParty, with a target cardinality of; DeclarantParty, with a target cardinality of 1, ProductRecipientParty, with a target cardinality of 1; RepresentativeDeclarantParty, with a target cardinality of C; SubContractingParty, with a target cardinality of C; and MessageExchangeServiceProviderParty, with a target cardinality of C. The following associations may exist to the node CustomsOffice: ExportCustomsOffice, with a target cardinality of C; SupplementaryExportCustomsOffice, with a target cardinality of C; PlannedExitCustomsOffice, with a target cardinality of C; and ExitCustomsOffice, with a target cardinality of C. A PresentationLocation association may exist to node Location, with a target cardinality of C. The following associations may exist to node TimePoint: PresentationToCustomsStartTimePoint, with a target cardinality of C; PresentationToCustomsEndTimePoint, with a target cardinality of C; and IssueTimePoint, with a cardinality of C. An ExportCustomsAuthorisation association may exist to node CustomsAuthorisation, with a target cardinality of C. In some implementations, a representation situation specified by ExportPartyRepresentationCode may be consistent with the parties in an export declaration. In some implementations, each location role appears only once per export declaration.
The following enterprise service infrastructure actions may be associated with Export Declaration: SwitchToFallbackProcedure, SwitchToStandardProcedure, Block, Unblock, RequestIssue, NotifyOfIssue, RequestAcceptance NotifyOfAcceptanceRejection, NotifyOfAcceptance, NotifyOfPartlyApproval, NotifyOfApproval, NotifyOfApprovalRejection, NotifyOfFallbackApprovalRejection, NotifyOfRelease, NotifyOfReleaseRejection, NotifyOfFallbackReleaseRejection, NotifyOfExitConfirmation, NotifyOfFallbackExitConfirmation, Cancel, RevokeCancellation, RequestCancellation, NotifyOfCancellationDiscard, and NotifyOfCancellationCompletion. The SwitchToFallbackProcedure action may be used to designate a fallback procedure as a current customs procedure. The SwitchToFallbackProcedure may have a precondition that a Customs Procedure is in a status of “Standard”. In response to the SwitchToFallbackProcedure action, a status variable Customs Procedure may be set to “Fallback.”
The SwitchToStandardProcedure action may be used to designate a standard procedure as a current customs procedure. The SwitchToStandardProcedure action may have a precondition that a Customs Procedure is in status “Fallback”. In response to the SwitchToStandardProcedure action, a Customs Procedure may be set to “Standard”. The Block action prohibits the issuing of an Export Declaration. The Block action may have preconditions that Issue Blocking is in status “Not Blocked” and Export Declaration Issuing is in status “Not Issued”. In response to the Block action, Issue Blocking may be set to “Blocked”. The Unblock action allows the issuing of an Export Declaration. The Unblock action may have a precondition that Issue Blocking is in status “Blocked”. In response to the Unblock action, Issue Blocking may be set to “Not Blocked”. The RequestIssue action requests that an Export Declaration be issued. The Request action may have preconditions that Issue Blocking is in status “Not Blocked”, that Consistency is in status “Consistent”, and that Export Declaration Issuing is in status “Not Issued” or “Issued” while Customs Procedure is in status “Fallback”. In response to the Request action, Export Declaration Issuing may be set to “Issue Requested”. The NotifyOfIssue action states that an Export Declaration was successfully issued. The NotifyOfIssue action is an agent action, and may have a precondition that Export Declaration Issuing is in status “Issue Requested”. In response to the NotifyOfissue action, Export Declaration Issuing may be set to “Issued”. The RequestAcceptance action requests acceptance of an Export Declaration from a customs authority. The RequestAcceptance action may have preconditions that Export Declaration Acceptance is in status “Not Requested” or “Rejected”, that Customs Procedure is in status “Standard”, and that Export Declaration Issuing is in status “Issued”. In response to the RequestAcceptance action, Export Declaration Acceptance may be set to “Acceptance Requested”. The NotifyOfAcceptanceRejection action states that a customs authority rejected acceptance of an Export Declaration. The NotifyOfAcceptanceRejection may have preconditions that Export Declaration Acceptance is in status “Acceptance Requested”, that Customs Procedure is in status “Standard”, and that Export Declaration Issuing is in status “Issued”. In response to the NotifyOfAcceptanceRejection action, Export Declaration Acceptance may be set to “Rejected”. The NotifyOfAcceptance action states that an issue of an export declaration was accepted by a customs authority. The NotifyOfAcceptance action may have preconditions that Export Declaration Acceptance is in status “Acceptance Requested”, that Customs Procedure is in status “Standard”, and that Export Declaration Issuing is in status “Issued”. In response to the NotifyOfAcceptance action, Export Declaration Acceptance may be set to “Accepted”. The NotifyOfPartlyApproval action states that a customs authority generally but partly approved an export. The NotifyOfPartlyApproval action may have preconditions that Export Approval is in status “Not Approved”, and that Export Declaration Acceptance is in status “Accepted”. In response to the NotifyOfPartlyApproval action, Export Approval may be set to “Partly Approved”. The NotifyOfApproval action states that a customs authority approved an export. The NotifyOfApproval action may have preconditions that Export Approval is in status “Not Approved” and that Export Declaration Acceptance is in status “Accepted”. In response to the NotifyOfApproval action, Export Approval may be set to “Approved”. The NotifyOfApprovalRejection action states that a customs authority rejected an export using a standard procedure. The NotifyOfApprovalRejection may have preconditions that Export Approval is in status “Not Approved” and that Export Declaration Acceptance is in status “Accepted”. In response to the NotifyOfApprovalRejection action, Export Approval may be set to “Rejected”. The NotifyOfFallbackApprovalRejection action states that a customs authority rejected an export in a fallback procedure. The NotifyOfFallbackApprovalRejection action may have preconditions that Export Approval is in status “Not Approved”, that Export Declaration Issuing is in status “Issued”, and that Customs Procedure is in status “Fallback”. In response to the NotifyOfFallbackApprovalRejection action, Export Approval may be set to “Rejected”. The NotifyOfRelease action states that a customs authority released an export completely. The NotifyOfRelease action may have preconditions that Export Release is in status “Not Released”, and that Export Declaration Acceptance is in status “Accepted”. In response to the NotifyOfRelease action, Export Release may be set to “Released”. The NotifyOfReleaseRejection action states that a customs authority rejected a release of an export in a standard procedure. The NotifyOfReleaseRejection may have preconditions that Export Release is in status “Not Released” and that Export Declaration Acceptance is in status “Accepted”. In response to the NotifyOfReleaseRejection action, Export Release may be set to “Rejected”. The NotifyOfFallbackReleaseRejection action states that a customs authority rejected the release of an export in fallback procedure. The NotifyOfFallbackReleaseRejection may have preconditions that Export Release is in status “Not Released”, that Export Declaration Issuing is in status “Issued”, and that Customs Procedure is in status “Fallback”. In response to the NotifyOfFallbackReleaseRejection action, Export Release may be set to “Rejected”. The NotifyOfExitConfirmation action states that a customs authority confirmed in standard procedure that export goods have left a customs territory. The NotifyOfFallbackReleaseRejection action may have preconditions that Export Exit Confirmation is in status “Not Confirmed” and that Export Declaration Acceptance is in status “Accepted”. In response to the NotifyOfFallbackReleaseRejection action, Export Exit Confirmation may be set to “Confirmed”. The NotifyOfFallbackExitConfirmation action states that a customs authority confirmed in fallback procedure that export goods have left a customs territory. The NotifyOfFallbackExitConfirmation may have preconditions that Export Exit Confirmation is in status “Not Confirmed”, that Export Declaration Issuing is in status “Issued”, and that Customs Procedure is in status “Fallback”. In response to the NotifyOfFallbackExitConfirmation action, Export Exit Confirmation may be set to “Confirmed”. The Cancel action cancels an Export Declaration. The Cancel action may have preconditions that Cancellation is in status “Not Canceled”, and that if Customs Procedure is in status “Standard”, then Export Declaration Issuing is in status “Not Issued”. In response to the Cancel action, Cancellation may be set to “Canceled”. The RevokeCancellation action reverts the cancellation of an Export Declaration. The RevokeCancellation action may have a precondition that Cancellation is in status “Canceled”. In response to the RevokeCancellation action, Cancellation may be set to “Not Canceled”. The RequestCancellation action sends a cancellation request to a customs authority. The RequestCancellation action may have preconditions that Customs Authority Cancellation is in status “Not Canceled”, that Export Declaration Acceptance is in status “Accepted”, and that Customs Procedure is in status “Standard”. In response to the RequestCancellation action, Customs Authority Cancellation may be set to “Cancellation Requested”. The NotifyOfCancellationDiscard action states that a customs authority rejected a cancellation request. The NotifyOfCancellationDiscard action may have a precondition that Customs Authority Cancellation is in status “Cancellation Requested”. In response to the NotifyOfCancellationDiscard action, Customs Authority Cancellation may be set to “Cancellation Discarded”. The NotifyOfCancellationCompletion action states that a customs authority approved a cancellation request. The NotifyOfCancellationCompletion action may have a precondition that Customs Authority Cancellation is in status “Not Canceled” or “Cancellation Requested”. In response to the NotifyOfCancellationCompletion action, Customs Authority Cancellation may be set to “Canceled.”
A Select All query provides the NodeIDs of all instances of a node and may be used to enable an initial load of data for a Fast Search Infrastructure. A Query By Elements query provides a list of all Export Declarations found based upon given parameters. The query elements are defined by the data type ExportDeclarationElementsQueryElements. These elements include: UUID, ID, CustomsProcessID, CustomsProcessCustomsAuthorityID, SystemAdministrativeData, CreationDateTime, CreationIdentityUUID, CreationIdentityID, CreationIdentityBusinessPartnerInternalID, CreationIdentityBusinessPartnerPersonFamilyName, CreationIdentityBusinessPartnerPersonGivenName, CreationIdentityEmployeeID, LastChangeDateTime, LastChangeIdentityUUID, LastChangeIdentityID, LastChangeIdentityBusinessPartnerInternalID, LastChangeIdentityBusinessPartnerPersonFamilyName, LastChangeIdentityBusinessPartnerPersonGivenName, LastChangeIdentityEmployeeID, CustomsAuthorityCountryCode, CustomsExportSoftwareVersionCode, TypeCode, ExportTypeCode, ExportExportingCountryCode, ExportDestinationCountryCode, PartyKey, PartyTypeCode, PartyID, PartyRoleCategoryCode, CustomsAuthorisationInternalID, BusinessTransactionDocumentReference, LifecycleStatusCode, ConsistencyStatusCode, InformationRequestStatusCode, CustomsProcedureStatusCode, and CustomsAuthorityCancellationStatusCode.
UUID may be optional, may be an alternative key, is an internally assigned globally unique identifier of an ExportDeclaration, and may be based on datatype GDT: UUID. ID may be optional, may be an alternative key, is an internally assigned identifier for an ExportDeclaration, unique in a context of this deployment unit, and may be based on datatype GDT: BusinessTransactionDocumentID. CustomsProcessID is an identifier of an export, may be assigned internally, and may be based on datatype GDT: CustomsProcessID. CustomsProcessCustomsAuthorityID is an identifier of an export, may be assigned by a customs authority, and may be based on datatype GDT: CustomsProcessID. SystemAdministrativeData is Administrative data on a business object node, and may be based on datatype QueryIDT: QueryElementSystemAdministrativeData. CreationDateTime is a point in time date and time stamp of a creation, and may be based on datatype GDT: GLOBAL_DateTime. CreationIdentityUUID is a globally unique identifier for an identity who performed a creation, and may be based on datatype GDT: UUID. CreationIdentityID is an identifier for an identity who performed a creation, and may be based on datatype GDT: IdentityID. CreationIdentityBusinessPartnerinternalID is a proprietary identifier for a business partner that is attributed to a creation identity and that can be reached following the relationships of a creation identity, and may be based on datatype GDT: BusinessPartnerinternalID. CreationIdentityBusinessPartnerPersonFamilyName is a family name of a business partner of a category person that is attributed to the creation identity and that can be reached following the relationships of a creation identity, and may be based on datatype GDT: LANGUAGEINDEPENDENT_MEDIUM_Name. CreationIdentityBusinessPartnerPersonGivenName is a given name of a business partner of a category person that is attributed to a creation identity and that can be reached following the relationships of the creation identity, and may be based on datatype GDT: LANGUAGEINDEPENDENT_MEDIUM_Name. CreationIdentityEmployeeID is an identifier for an employee that is attributed to a creation identity and that can be reached following the relationships of the creation identity, and may be based on datatype GDT: EmployeeID. LastChangeDateTime is a point in time date and time stamp of a last change, and may be based on datatype GDT: GLOBAL_DateTime. LastChangeIdentityUUID is a globally unique identifier for an identity who made last changes, and may be based on datatype GDT: UUID. LastChangeIdentityID is an identifier for an identity who made last changes, and may be based on datatype GDT: IdentityID. LastChangeIdentityBusinessPartnerinternalID is a proprietary identifier for a business partner that is attributed to a last change identity and that can be reached following the relationships of the last change identity, and may be based on datatype GDT: BusinessPartnerInternalID. LastChangeIdentityBusinessPartnerPersonFamilyName is a family name of a business partner of a category person that is attributed to a last change identity and that can be reached following the relationships of the last change identity, and may be based on datatype GDT: LANGUAGEINDEPENDENT_MEDIUM_Name. LastChangeIdentityBusinessPartnerPersonGivenName is a given name of a business partner of a category person that is attributed to a last change identity and that can be reached following the relationships of the last change identity, and may be based on datatype GDT: LANGUAGEINDEPENDENT_MEDIUM_Name. LastChangeIdentityEmployeeID is an identifier for an employee that is attributed to a last change identity and that can be reached following the relationships of the last change identity, and may be based on datatype GDT: EmployeeID. CustomsAuthorityCountryCode is a country to whose customs authority an export declaration was or will be submitted, and may be based on datatype GDT: CountryCode, with a qualifier of CustomsAuthority. CustomsExportSoftwareVersionCode is a version of an export software of a customs authority that was active for an ExportDeclaration during a last action on a business object, and may be based on datatype GDT: CustomsExportSoftwareVersionCode. The version may be determined from an associated CustomsArrangement. TypeCode is a type of an export declaration, and may be based on datatype GDT: ExportDeclarationTypeCode. Examples for an export declaration type are complete export declaration, incomplete export declaration, and supplementary export declaration. ExportTypeCode is a type of an export, and may be based on datatype GDT: ExportTypeCode. ExportExportingCountryCode is a country from which goods are exported, and may be based on datatype GDT: ExportExportingCountryCode. The ExportExportingCountryCode can differ from the CustomsAuthorityCountryCode, such as in cases (e.g., in the European Union) in which an export is declared in one country but goods ship from another country. ExportDestinationCountryCode is a destination country of an export, and may be based on datatype GDT: ExportDestinationCountryCode. PartyKey is an identifying key of a party, and may be based on datatype KDT: PartyKey. PartyTypeCode is a coded representation of a type of party, and may be based on datatype GDT: BusinessObjectTypeCode. PartyID is an identifier for a party, and may be based on datatype GDT: PartyID. PartyRoleCategoryCode is a party role category of a party, and may be based on datatype GDT: PartyRoleCategoryCode. CustomsAuthorisationInternalID is an internal identifier of a customs authorisation, and may be based on datatype GDT: CustomsAuthorisationInternalID. BusinessTransactionDocumentReference may be based on datatype GDT: BusinessTransactionDocumentReference. LifecycleStatusCode is a lifecycle status of an export declaration, and may be based on datatype GDT: ExportDeclarationLifeCycleStatusCode. ConsistencyStatusCode may be based on datatype GDT: ConsistencyStatusCode. InformationRequestStatusCode may be based on datatype GDT: ExportDeclarationInformationRequestStatusCode. CustomsProcedureStatusCode may be based on datatype GDT: CustomsProcedureStatusCode. CustomsAuthorityCancellationStatusCode may be based on datatype GDT: CancellationStatusCode.
Item is a quantity of a product in an export declaration with additional information on amounts, quantities and packaging data. An item includes information on a corresponding product, including customs commodity, dangerous goods classification, and a region of origin. Item also includes information on goods weight, an associated consignment, an export procedure to apply, and value and weight information for foreign trade statistics. Furthermore, item includes information on the packaging of declared goods in packages and containers, and specifies supporting documents and previous documents needed for approval of an item by a customs authority. The elements located directly at the node Item are defined by the data type ExportDeclarationItemElements. These elements include: UUID, ID, Description, CustomsAuthorityID, CustomsCommodityClassificationCode, DangerousGoodsID, OriginExportRegionCode, Quantity, QuantityTypeCode, LegalComplianceQuantity, LegalComplianceQuantityTypeCode, NetWeightQuantity, NetWeightQuantityTypeCode, GrossWeightQuantity, GrossWeightQuantityTypeCode, GrossWeightQuantity, ConsignmentExportID, ExportTransportCostPaymentFormCode, ExportProcedureTypeCode, ExportPreviousProcedureTypeCode, ExportAdditionalProcedureTypeCode, LegalComplianceAmount, and SystemAdministrativeData.
UUID may be an alternative key, is a globally unique identifier for a node, and may be based on datatype GDT: UUID. ID is an identifier for an export declaration item, and may be based on datatype GDT: BusinessTransactionDocumentItemID. Description is a description of an export declaration item, and may be based on datatype GDT: LANGUAGEINDEPENDENT_LONG_Description. CustomsAuthorityID is an identifier for an export declaration item, may be assigned according to legal requirements of a customs authority, and may be based on datatype GDT: CustomsDeclarationItemCustomsAuthorityID. CustomsCommodityClassificationCode is a classification of an export declaration item according to a customs commodity classification catalog, may be issued by a customs authority, and may be based on datatype GDT: CustomsCommodityClassificationCode. DangerousGoodsID is an identifier for a kind of danger presented by an export declaration item, and may be based on datatype GDT: DangerousGoodsID. Classification may be subject to a United Nations Dangerous Goods number (UNDG) classification. OriginExportRegionCode is a region of origin of goods within an export declaration item, and may be based on datatype GDT: ExportRegionCode, with a qualifier of Origin. Quantity is a quantity of a product within an export declaration item, and may be based on datatype GDT: Quantity. QuantityTypeCode is a type of a quantity of an export declaration item, and may be based on datatype GDT: QuantityTypeCode. LegalComplianceQuantity is a quantity of an export declaration item, in a format and measure required by a customs authority, and may be based on datatype GDT: Quantity, with a qualifier of LegalCompliance. LegalComplianceQuantity may be used for foreign trade statistics. LegalComplianceQuantityTypeCode is a type of a quantity of an export declaration item, may be required by a customs authority, and may be based on datatype GDT: QuantityTypeCode, with a qualifier of LegalCompliance. LegalComplianceQuantityTypeCode may be used for foreign trade statistics. NetWeightQuantity is a net weight of an export declaration item, and may be based on datatype GDT: Quantity, with a qualifier of Weight. NetWeightQuantityTypeCode is a type of a NetWeightQuantity of an export declaration item, and may be based on datatype GDT: QuantityTypeCode, with a qualifier of Weight. GrossWeightQuantity is a gross weight of an export declaration item, and may be based on datatype GDT: Quantity, with a qualifier of Weight. Gross weight includes the packages of an item, excluding a weight of containers. GrossWeightQuantityTypeCode is a type of the GrossWeightQuantity of an export declaration item, and may be based on datatype GDT: QuantityTypeCode, with a qualifier of Weight. ConsignmentExportID is an identifier of a consignment an export declaration is part of, may be used to reference an export to external parties, and may be based on datatype GDT: ConsignmentExportID. ConsignmentExportID may be a shipment document identifier or a Unique Consignment Reference (UCR). ExportTransportCostPaymentFormCode is a payment form used to pay a transport cost for a single export declaration item, and may be based on datatype GDT: ExportTransportCostPaymentFormCode.
Examples of payment forms include cash and cheque. ExportProcedureTypeCode is a type of export procedure to apply to an export declaration item, and may be based on datatype GDT: ExportProcedureTypeCode. ExportPreviousProcedureTypeCode is a type of export procedure that was applied to an export declaration item in a preceding customs transaction, and may be based on datatype GDT: ExportPreviousProcedureTypeCode. ExportPreviousProcedureTypeCode may be used only in certain countries. ExportAdditionalProcedureTypeCode is a type of additional export procedure to apply to an export declaration item, may be based on datatype GDT: ExportAdditionalProcedureTypeCode, and may be used only in certain countries. LegalComplianceAmount is an amount of an export declaration item, may be in a format and currency required by a customs authority, may be based on datatype GDT: Amount, with a qualifier of LegalCompliance, and may be used for foreign trade statistics. SystemAdministrativeData is a System administrative data related to an export declaration item, and may be based on datatype GDT: SystemAdministrativeData.
The following composition relationships to subordinate nodes may exist: Item package Assignment with a cardinality of 1:CN, Item Product with a cardinality of 1:C, Item Supporting Document with a cardinality of 1:CN, Item Previous Document with a cardinality of 1:CN, Item Business Transaction Document Reference with a cardinality of 1:CN, Item Text Collection with a cardinality of 1:C, and Item Attachment Folder with a cardinality of 1:C. A Last Changed Identity inbound association relationship may exist from the business object Identity/node Identity, with a cardinality of 1:CN, which represents an identity that last changed an export declaration item. A Creation Identity inbound association relationship may exist from the business object Identity/node Identity, with a cardinality of 1:CN, which represents an identity that created an export declaration item. The following specialization associations for navigation may exist to node ItemBusinessTransactionDocumentReference: SalesOrderItemReference, with a target cardinality of C; OutboundDeliveryItemReference, with a target cardinality of C; CustomerInvoiceItemReference, with a target cardinality CN, IntraCompanyStockTransferRequirementItemReference, with a target cardinality C; PurchaseOrderItemReference, with a target cardinality of C; and ServiceOrderItemReference, with a target cardinality of C. A CommodityCatalogueItem association to business object ForeignTradeCommodityCatalogue/Node Item may exist with a target cardinality of C. In some implementations, if a quantity or a measure is set, a corresponding quantity or measure type may also be filled. In some implementations, provided elements on an item level override identical elements on a root level.
Item Package Assignment is an assignment to a package an export declaration item is packed in. The elements located directly at the node Item package Assignment are defined by the data type ExportDeclarationItempackageAssignmentElements. These elements include: PackageUUID, PackageKey, ExportDeclarationUUID, and ExportDeclarationPackageID. PackageUUID is a globally unique identifier of a package an export declaration item is packed in, and may be based on datatype GDT: UUID. PackageKey is a key of a package an export declaration item is packed in, and may be based on datatype KDT: ExportDeclarationPackageKey. ExportDeclarationUUID is an internally unique identifier of an export declaration, and may be based on datatype GDT: UUID. ExportDeclarationPackageID is an internal identifier of a package item, and may be based on datatype GDT: ExportDeclarationPackageID. A Package inbound association relationship may exist from the business object Export Declaration/node package, with a cardinality of package 1:CN, which represents a package an export declaration item is packed in.
Item Product is a product associated with an export declaration item. The elements located directly at the node Item Product are defined by the data type ExportDeclarationItemProductElements. These elements include: ProductUUID, ProductKey, ProductTypeCode, ProductIdentifierTypeCode, and ProductID. ProductUUID is a globally unique identifier for a product, and may be based on datatype GDT: UUID. ProductKey is a proprietary identifier for a product, and may be based on datatype KDT: ProductKey. ProductTypeCode is a coded representation of a product type, such as a material or service, and may be based on datatype GDT: ProductTypeCode. ProductIdentifierTypeCode is a coded representation of a product identifier type, and may be based on datatype GDT: ProductIdentifierTypeCode. ProductID is an identifier for a product, and may be based on datatype GDT: ProductID. An Individual Material inbound aggregation relationship may exist from the business object Individual Material/node Individual Material, with a cardinality of C:CN, which is an individual material of an export declaration item. A Material inbound aggregation relationship may exist from the business object Material/node Material, with a cardinality of C:CN, which is a material of an export declaration item.
Item Supporting Document is a document that verifies the correctness of certain data of an export declaration item. Item Supporting Document may be required by a customs authority to approve an export. An example of an Item Supporting Document is a certificate of origin. The elements located directly at the node Item Supporting Document are defined by the data type ExportDeclarationItemSupportingDocumentElements. These elements include ExportSupportingDocumentTypeCode, ExportSupportingDocumentID, ExportSupportingDocumentAddendumID, ExportSupportingDocumentDetailID, IssueDate, ValidityEndDate, LicenceWriteOffAmount, LicenceWriteOffQuantity, and LicenceWriteOffQuantityTypeCode.
Item Previous Document is a document that includes details on a previous business transaction related to an export declaration item. Item Previous Document may be required by a customs authority to approve an export. An example of an Item Previous Document is an import notification that documents a previous import of an item. The elements located directly at the node Item Previous Document are defined by the data type ExportDeclarationItemPreviousDocumentElements. These elements include: ExportPreviousDocumentTypeCode, ExportPreviousDocumentID, ExportSupportingDocumentTypeCode, ExportSupportingDocumentID, ExportSupportingDocumentAddendumID, ExportSupportingDocumentDetailID, IssueDate, ValidityEndDate, LicenceWriteOffAmount, LicenceWriteOffQuantity, and LicenceWriteOffQuantityTypeCode.
ExportPreviousDocumentTypeCode is a type of a previous document, and may be based on datatype GDT: ExportPreviousDocumentTypeCode. An example of a previous document is a preceding import declaration for an item that is now exported. ExportPreviousDocumentID is an identifier of a previous document, and may be based on datatype GDT: ExportPreviousDocumentID. ExportSupportingDocumentTypeCode is a type of a supporting document, and may be based on datatype GDT: ExportSupportingDocumentTypeCode. An example of a supporting document type is a certificate of origin. In some implementations, the ExportSupportingDocumentTypeCode determines which of the elements ExportSupportingDocumentID, ExportSupportingDocumentAddendumID and ExportSupportingDocumentDetailID are provided. In some implementations, at least one of the elements ExportSupportingDocumentID, ExportSupportingDocumentAddendumID and ExportSupportingDocumentDetailID is provided. ExportSupportingDocumentID is an identifier of a supporting document, and may be based on datatype GDT: ExportSupportingDocumentID. ExportSupportingDocumentAddendumID is an identifier of an addendum of a supporting document, and may be based on datatype GDT: ExportSupportingDocumentAddendumID. ExportSupportingDocumentDetailID is an identifier of the detail of a supporting document, and may be based on datatype GDT: ExportSupportingDocumentDetailID. IssueDate is a date a supporting document was issued, and may be based on datatype GDT: Date, with a qualifier of Issue. ValidityEndDate is a date the validity of a supporting document ends, and may be based on datatype GDT: Date, with a qualifier of End. LicenceWriteOffAmount is an amount to write off of a licence for an export declaration item, and may be based on datatype GDT: Amount, with a qualifier of LicenceWriteOff. A licence is a kind of supporting document. LicenceWriteOffQuantity is a quantity to write off of a licence for an export declaration item, and may be based on datatype GDT: Quantity, with a qualifier of LicenceWriteOff. LicenceWriteOffQuantityTypeCode is a type of the LicenceWriteOffQuantity, and may be based on datatype GDT: QuantityTypeCode, with a qualifier of LicenceWriteOff.
Item Previous Document is a document that includes details on a previous business transaction related to an export declaration item. In some implementations, Item Previous Document may be required by a customs authority to approve an export. An example of an Item Previous Document is an import notification that documents a previous import of an item. The elements located directly at the node Item Previous Document are defined by the data type ExportDeclarationItemPreviousDocumentElements. These elements include: ExportPreviousDocumentTypeCode and ExportPreviousDocumentID. ExportPreviousDocumentTypeCode is a type of a previous document, and may be based on datatype GDT: ExportPreviousDocumentTypeCode. An example of a previous document is a preceding import declaration for an item that is now exported. ExportPreviousDocumentID is an identifier of a previous document, and may be based on datatype GDT: ExportPreviousDocumentID.
Item Business Transaction Document Reference is a reference to a business transaction document from which an export declaration item was created. The elements located directly at the node Item Business Transaction Document Reference are defined by the data type ExportDeclarationItemBusinessTransactionDocumentReferenceElements. These elements include: BusinessTransactionDocumentReference and BusinessTransactionDocumentRelationshipRoleCode. BusinessTransactionDocumentReference is a unique identification of a business transaction document related to an export declaration item, and may be based on datatype GDT: BusinessTransactionDocumentReference. BusinessTransactionDocumentRelationshipRoleCode is a role of a referenced business transaction document in an export declaration item, and may be based on datatype GDT: BusinessTransactionDocumentRelationshipRoleCode.
A Customer Invoice Item inbound aggregation relationship may exist from the business object Customer Invoice/node Item Cross DU, with a cardinality of 1:CN, which represents a customer invoice item from which an export declaration item was created. A CustomerRequirementExternalRequestItem inbound aggregation relationship may exist from the business object Customer Requirement/node External Request Item Cross DU, with a cardinality of C:CN, which represents an item of a customer requirement from which an item of an export declaration request was created. An Outbound Delivery Item inbound aggregation relationship may exist from the business object Outbound Delivery/node Item Cross DU, with a cardinality of C:CN, which represents an outbound delivery item from which an export declaration item was created. A PurchaseOrderItem inbound aggregation relationship may exist from the business object Purchase Order/node Item Cross DU, with a cardinality of C:CN, which represents an item in a purchase order. A Sales Order Item inbound aggregation relationship may exist from the business object Sales Order/node Item Cross DU, with a cardinality of C:CN, which represents a sales order item from which an export declaration item was created. A Service Order Item inbound aggregation relationship may exist from the business object Service Order/node Item Cross DU, with a cardinality of C:CN, which represents an item of a service order.
Item Text Collection is a dependent object inclusion node. Item Text Collection includes natural language texts that describe an export declaration item or that specify export goods. Some of the texts are reported to and others are reported by a customs authority. Item Attachment Folder is a dependent object inclusion node which includes a collection of documents that are assigned to an export declaration item. Time Point is a time point at which some processing of an export declaration took place, takes place, or will take place. The elements located directly at the node Time Point are defined by the data type ExportDeclarationTimePointElements. These elements include TimePointRoleCode, Date, and DateTime. TimePointRoleCode is a role of a time point in an export declaration, and may be based on datatype GDT: TimePointRoleCode. Examples of time points are PlannedExportExitTimePoint, PresentationToCustomsStartTimePoint, and PresentationToCustomsEndTimePoint. Date is a date of a time point, and may be based on datatype GDT: Date. DateTime is a date and time of a time point, and may be based on datatype GDT: GLOBAL_DateTime. In some implementations, only one of either Date or DateTime is filled. In some implementations, Date is used if no time is available or required.
Customs Authorisation is a document that authorizes an exporter to use simplifications in exports. For example, an authorization may entitle an exporter to use simplified customs procedures. The elements located directly at the node Customs Authorisation are defined by the data type ExportDeclarationCustomsAuthorisationElements. These elements include InternalID. InternalID is an internal identifier of a customs authorisation in a customs arrangement, and may be based on datatype GDT: CustomsAuthorisationInternalID. A Customs Arrangement Customs Authorisation inbound association relationship may exist from the business object Customs Arrangement/node Customs Authorisation, with a cardinality of 1:CN, which represents a customs authorisation to use for an export declaration.
Location is a location related to the processing of an export declaration. For example, Location may refer to a location where export goods can be inspected by customs officers. The elements located directly at the node Location are defined by the data type ExportDeclarationLocationElements. These elements include: LocationID, LocationUUID, RoleCategoryCode, and RoleCode. LocationID is an identifier for a location, and may be based on datatype GDT: LocationID. LocationUUID is a globally unique identifier for a location, and may be based on datatype GDT: UUID. RoleCategoryCode is a location's role category in an export declaration, and may be based on datatype GDT: LocationRoleCategoryCode. RoleCode is a location's role in an export declaration, and may be based on datatype GDT: LocationRoleCode. A Location inbound aggregation relationship may exist from the business object Location/node Location, with a cardinality of 1:CN, which represents a location involved in an export.
Customs Office is a customs office involved in an export. For example, Customs Office may refer to a customs office of export, a customs office of export for a supplementary export declaration, a customs office of exit, or a planned customs office of exit. The elements located directly at the node Customs Office are defined by the data type ExportDeclarationCustomsOfficeElements. These elements include: CustomsOfficeUUID, CustomsOfficeInternalID, RoleCategoryCode, and RoleCode. CustomsOfficeUUID is a globally unique identifier of a customs office party, and may be based on datatype GDT: UUID. CustomsOfficeInternalID is an internal identifier of a customs office business partner, and may be based on datatype GDT: BusinessPartnerinternalID. RoleCategoryCode is a role category of a customs office category in an export, and may be based on datatype GDT: PartyRoleCategoryCode. Examples for role category codes are ExportCustomsOfficeParty and ExitCustomsOfficeParty. RoleCode is a role of a customs office role in an export, and may be based on datatype GDT: PartyRoleCode. A CustomsOffice inbound aggregation relationship may exist from the business object Business Partner/node Business Partner, with a cardinality of C:CN, which represents a customs office involved in an export. In some implementations, customs offices listed at ExportDeclarationInformationRequestResponse may not necessarily appear at the Customs Office node.
Party is a natural or legal person involved in an export as exporter or product recipient or on behalf of any of these parties. Examples of parties include exporter, declarant, representative of a declarant, sub-contractor and message exchange service provider. The elements located directly at the node Party are defined by the data type ExportDeclarationPartyElements. These elements include: PartyUUID, PartyKey, PartyTypeCode, PartyID, RoleCategoryCode, RoleCode, and AddressReference. PartyUUID is a globally unique identifier of a party, and may be based on datatype GDT: UUID. PartyKey is a key of a party, and may be based on datatype KDT: PartyKey. PartyTypeCode is a coded representation of a type of party, and may be based on datatype GDT: BusinessObjectTypeCode. PartyID is an identifier for a party, and may be based on datatype GDT: PartyID. RoleCategoryCode is a role category of a party in an export declaration, and may be based on datatype GDT: PartyRoleCategoryCode. Examples for role categories include ExporterParty and DeclarantParty. RoleCode is a role of a party in an export declaration, and may be based on datatype GDT: PartyRoleCode. AddressReference is a reference to a party's address, and may be based on datatype GDT: PartyAddressReference. The following composition relationships to subordinate nodes may exist: Party Address with a cardinality of 1:C, and Party Contact Party with a cardinality of 1:C. A Party inbound aggregation relationship may exist from the business object Party/node Party, with a cardinality of C:CN, which represents a party involved in an export. Party Address is a dependent object inclusion node which represents an address of a party that is specific to an export declaration.
Party Contact Party is a natural person or organizational unit that can be contacted for a party. The contact can be a contact person or, as another example, a secretary's office. The PartyContactParty is used to communicate communication data to a customs authority. The elements located directly at the node Party Contact Party are defined by the data type ExportDeclarationPartyContactPartyElements. These elements include: PartyUUID, PartyKey, PartyTypeCode, PartyID, and AddressReference. PartyUUID is a globally unique identifier of a party's contact, and may be based on datatype GDT: UUID. PartyKey is a key of a party contact, and may be based on datatype KDT: PartyKey. PartyTypeCode is a coded representation of a type of party, and may be based on datatype GDT: BusinessObjectTypeCode. PartyID is an identifier for a party, and may be based on datatype GDT: PartyID. AddressReference is a reference to a party contact's address, and may be based on datatype GDT: PartyAddressReference. A Party Contact Party inbound aggregation relationship may exist from the business object Party/node Party, with a cardinality of C:CN, which represents a contact party of a party.
Package is a logical group of one or more package elements. A package element is a physical object in which physical export goods are packed. The elements located directly at the node package are defined by the data type ExportDeclarationpackageElements. These elements include: UUID, Key, ExportDeclarationUUID, ExportDeclarationpackageID, ID, ElementNumberValue, ExportpackageTypeCode, packageExportID, ContainerUUID, ContainerKey, ExportDeclarationUUID, ExportDeclarationContainerID. UUID is an alternative key, is a globally unique identifier of a node, and may be based on datatype GDT: UUID. Key may be an alternative key, is a key of a package in an export declaration, and may be based on datatype KDT: ExportDeclarationpackageKey. ExportDeclarationUUID is an internally unique identifier of an export declaration, and may be based on datatype GDT: UUID. ExportDeclarationpackageID is an internal identifier of a package item, and may be based on datatype GDT: ExportDeclarationpackageID. ID is an internal identifier of a package, and may be based on datatype GDT: ExportDeclarationpackageID. ElementNumberValue is a number of package elements in a package, and may be based on datatype GDT: NumberValue, with a qualifier of Elements. ExportpackageTypeCode is a type of package elements in a package, and may be based on datatype GDT: ExportpackageTypeCode. In some implementations, all package elements of a package are of a same type. PackageExportID is an identifier of a package for reporting to a customs authority, and may be based on datatype GDT: packageExportID. In some implementations, if the number of package elements in a package is greater than one, this element may include the identifiers of several package elements, for example as an enumeration (e.g., “4711, 4712” or as a value range (e.g., “4711-4718”). ContainerUUID is a globally unique identifier of a container that includes all of the package elements in a package, and may be based on datatype GDT: UUID. ContainerKey is a key of a physical container that includes all of the package elements in a package, and may be based on datatype KDT: ExportDeclarationContainerKey. ExportDeclarationUUID is an internally unique identifier of an export declaration, and may be based on datatype GDT: UUID. ExportDeclarationContainerID is an internal identifier of a container, and may be based on datatype GDT: ExportDeclarationContainerID. A Container inbound association relationship may exist from the business object Export Declaration/node Container, with a cardinality of C:CN, which represents a container in which a package is included.
Container is a physical container that includes a portion of or all of the export goods in an export. The elements located directly at the node Container are defined by the data type ExportDeclarationContainerElements. These elements include: UUID, ID, ContainerExportID, Key, ExportDeclarationUUID, and ExportDeclarationContainerID. UUID is an alternative key, is a globally unique identifier of a node, and may be based on datatype GDT: UUID. ID is an internal identifier of a container, and may be based on datatype GDT: ExportDeclarationContainerID. ContainerExportID is an identifier of a container for reporting to a customs authority, and may be based on datatype GDT: ContainerExportID. Key may be an alternative key, is a key of a container, and may be based on datatype KDT: ExportDeclarationContainerKey. ExportDeclarationUUID is an internally unique identifier of an export declaration, and may be based on datatype GDT: UUID. ExportDeclarationContainerID is an internal identifier of a container, and may be based on datatype GDT: ExportDeclarationContainerID.
Message is a message that is exchanged with a customs authority. Exact reproduction of a message flow may be a legal requirement. The elements located directly at the node Message are defined by the data type ExportDeclarationMessageElements. These elements include: UUID, ExportMessageID, CustomsMessageExchangeServerFileID, OrdinalNumberValue, DirectionCode, ExportMessageSubTypeCode, MajorVersionCustomsAuthorityID, MinorVersionCustomsAuthorityID, CustomsExportSoftwareVersionCode, CreationIdentityUUID, ApplicationLogID, ApplicationLogUUID, DateTime, Status, and ExportMessageCommunicationStatusCode. UUID may be an alternative key, is a globally unique identifier of a message, and may be based on datatype GDT: UUID. ExportMessageID is an identifier of a message, may be based on datatype GDT: CustomsProcessMessageID, may be assigned internally if for an outbound message, may be assigned by a customs authority for an inbound message, and may be defined by a customs authority. CustomsMessageExchangeServerFileID is an identifier for a file in which a message was handled on a message exchange server for communication with a customs authority, and may be based on datatype GDT: CustomsMessageExchangeServerFileID. OrdinalNumberValue is an ordinal number used to represent an order in which the messages were sent or received, and may be based on datatype GDT: OrdinalNumberValue. DirectionCode is a direction of a message (e.g., inbound, outbound) from a declarant's point of view, and may be based on datatype GDT: BusinessDocumentMessageDirectionCode. ExportMessageSubTypeCode is an internal type of a message, and may be based on datatype GDT: ExportMessageSubTypeCode. MajorVersionCustomsAuthorityID is a major version of a message as defined by a customs authority, and may be based on datatype GDT: VersionPartyID, with a qualifier of Major. MinorVersionCustomsAuthorityID is a minor version of a message as defined by a customs authority, and may be based on datatype GDT: VersionPartyID, with a qualifier of Minor. CustomsExportSoftwareVersionCode is a version of export software of a customs authority that was active for an ExportDeclaration while a message was created or received, and may be based on datatype GDT: CustomsExportSoftwareVersionCode. The version may be determined from a CustomsArrangement while an outbound message is created or while an inbound message is received. CreationIdentityUUID is a reference to an identity that created a message, and may be based on datatype GDT: UUID. CreationIdentityUUID may only provide for outbound messages. ApplicationLogID is an identification of an ApplicationLog for an export declaration message, and may be based on datatype GDT: ApplicationLogID. ApplicationLogUUID is a globally unique identifier of an ApplicationLog root node for referencing an ApplicationLog that corresponds to an export declaration message, and may be based on datatype GDT: UUID. DateTime is a date and time a message was processed, and may be based on datatype GDT: GLOBAL_DateTime. In some implementations, for outbound messages, DateTime is a date and time of a message transmittsion to a customs authority. For inbound messages, DateTime may be a date and time of message arrival from a customs authority. Status is a status of a message and may be based on datatype BOIDT: ExportDeclarationMessageStatus. ExportMessageCommunicationStatusCode is a communication status of a message, and may be based on datatype GDT: ExportMessageCommunicationStatusCode. ExportMessageCommunicationStatusCode may indicate whether a message was successfully transmitted to a customs authority. In contrast to “message exchange”, “message communication” here means a mere technical transmission. A composition relationship to subordinate node Message Attachment Folder may exist, with a cardinality of 1:CN. A CreationIdentity inbound association relationship may exist from the business object Identity/node Identity, with a cardinality of 1:CN, which represents an identity that created a message. A specialization association for navigation may exist to business object ApplicationLog/node Root Application Log, which represents an Application Log for an export declaration message.
A QueryByElements query may provide a list of all messages found based upon given parameters. The query elements are defined by the data type ExportDeclarationMessageElementsQueryElements. These elements include: DateTime, CreationIdentityUUID, ExportDeclarationID, CustomsProcessID, CustomsProcessCustomsAuthorityID, MajorVersionCustomsAuthorityID, ExportMessageID, ExportMessageCommunicationStatusCode, DirectionCode, and CustomsMessageExchangeServerFileID. DateTime is a date and time a message was sent or received, and may be based on datatype GDT: GLOBAL_DateTime. CreationIdentityUUID is an identity of a user that created a message, and may be based on datatype GDT: UUID. ExportDeclarationID is an identifier of an export declaration a message is associated with, and may be based on datatype GDT: BusinessTransactionDocumentID. CustomsProcessID is an identifier of a customs process a message is associated with, and may be based on datatype GDT: CustomsProcessID. CustomsProcessCustomsAuthorityID is an identifier assigned by a customs authority to a customs process a message is associated with, and may be based on datatype GDT: CustomsProcessID. MajorVersionCustomsAuthorityID is a major version of a message as specified by a customs authority, and may be based on datatype GDT: VersionPartyID. ExportMessageID is an identifier of a message, and may be based on datatype GDT: CustomsProcessMessageID. ExportMessageCommunicationStatusCode is a communication status of a message, and may be based on datatype GDT: ExportMessageCommunicationStatusCode. DirectionCode is a direction of a message, and may be based on datatype GDT: BusinessDocumentMessageDirectionCode. CustomsMessageExchangeServerFileID is an identifier of a file on an exchange server in which a customs message is transported, and may be based on datatype GDT: CustomsMessageExchangeServerFileID.
Message Attachment Folder is a dependent object inclusion node. MessageAttachmentFolder includes original messages sent to or received from a customs authority. Transport Route Country is a country an export starts in, passes through, or ends in. The sequence of all TransportRouteCountries in an ExportDeclaration represents a transport route. An OrdinalNumberValue is used to order the TransportRouteCountries in sequence. The same country can appear more than once in an ordered list of countries. The elements located directly at a node Transport Route Country are defined by the data type ExportDeclarationTransportRouteCountryElements. These elements include: ExportTransportRouteCountryCode and OrdinalNumberValue. ExportTransportRouteCountryCode is a country an export starts in, ends in, or one of the countries it passes through. ExportTransportRouteCountryCode may be based on datatype GDT: ExportTransportRouteCountryCode. OrdinalNumberValue is an ordinal number used to order countries in an order an export contacts them, and may be based on datatype GDT: OrdinalNumberValue.
Business Transaction Document Reference is a reference to a business transaction document related to an export. In some implementations, an export declaration can include at most one reference, namely to the OutboundDelivery it was created from. The elements located directly at the node Business Transaction Document Reference are defined by the data type ExportDeclarationBusinessTransactionDocumentReferenceElements. These elements include: BusinessTransactionDocumentReference and BusinessTransactionDocumentRelationshipRoleCode. BusinessTransactionDocumentReference is a unique identification of a business transaction document related to an export declaration, and may be based on datatype GDT: BusinessTransactionDocumentReference. BusinessTransactionDocumentRelationshipRoleCode is a role of a referenced business transaction document in an export declaration, and may be based on datatype GDT: BusinessTransactionDocumentRelationshipRoleCode. An Outbound Delivery inbound aggregation relationship may exist from the business object Outbound Delivery/node Outbound Delivery Cross DU, with a cardinality of C:CN.
Text Collection is a dependent object inclusion node which is a collection of natural language texts that describe an export declaration or that specify an export. Some of these natural language texts are reported to, and others are reported by, a customs authority.
Information Request is a request sent by a customs authority to inquire about a status of an export. The elements located directly at the node Information Request are defined by the data type ExportDeclarationInformationRequestElements. These elements include: UUID, Date, and ResponseDeadlineDate. UUID may be an alternative key, is a globally unique identifier for an information request, and may be based on datatype GDT: UUID. Date is a date information was requested by a customs authority, and may be based on datatype GDT: Date. ResponseDeadlineDate is a deadline until which a customs authority expects a response to its information request, and may be based on datatype GDT: Date, with a qualifier of ResponseDeadline. A composition relationship to subordinate nodes Information Request Response may exist, with a cardinality of 1:C. Information Request may be associated with the following enterprise service infrastructure actions: Respond and NotifyOfResponse. The Respond action sends a response on an information request to a customs authority. The Respond action may have a precondition that Information Request is in status “Requested” or “Response Rejected”. In response to the Respond action, Information Request may be set to “Responded”. The NotifyOfResponseRejection action states that a customs authority rejected a response to the information request. The NotifyOfResponseRejection action may have a precondition that Information Request is in status “Responded.” In response to the NotifyOfResponseRejection action, Information Request may be set to “Response Rejected.”
Information Request Response is a response sent to a customs authority upon an information request. The elements located directly at the node Information Request Response are defined by the data type ExportDeclarationInformationRequestResponseElements. These elements include: UUID, ExportExitDate, PlannedExportExitDate, ExitCustomsOfficeUUID, ExitCustomsOfficeInternalID, Status, and ExportExitStatusCode. UUID may be an alternative key, is a globally unique identifier for an information request response, and may be based on datatype GDT: UUID. ExportExitDate is a date an export left a customs territory (e.g., crossed a border), and may be based on datatype GDT: Date, with a qualifier of ExportExit. PlannedExportExitDate is a date an export is planned to exit a customs territory, and may be based on datatype GDT: Date, with a qualifier of PlannedExportExit. ExitCustomsOfficeUUID is a globally unique identifier of a customs office of exit that managed an export, and may be based on datatype GDT: UUID. ExitCustomsOfficeInternalID is an internal identifier for a customs office of exit that managed an export, and may be based on datatype GDT: BusinessPartnerinternalID. Status is a status of an information request response, and may be based on datatype BOIDT: ExportDeclarationInformationRequestResponseStatus. ExportExitStatusCode is an exit status of an export, and may be based on datatype GDT: ExportExitStatusCode. A composition relationship to subordinate node Information Request Response Text Collection may exist, with a cardinality of 1:C. A Exit Customs Office inbound association relationship may exist from the business object Business Partner/node Business Partner Cross DU, with a cardinality of C:CN, which represents an Exit Customs Office for exporting goods. In some implementations, depending on an exit status of an export, two cases can be reported. In some implementations, in case an export has already left a customs territory, the ExportExitDate and ExitCustomsOfficeUUID and/or ExitCustomsOfficeInternalID are provided. In some implementations, the provided customs office is not mirrored at node ExportDeclarationCustomsOffice. In some implementations, in the case an export has not yet left a customs territory, the PlannedExportExitDate is provided. Information Request Response Text Collection is a dependent object inclusion node which is a collection of natural language texts reported to a customs authority in an information request response. Attachment Folder is a dependent object inclusion node which is a collection of documents that are assigned to an Export Declaration. Controlled Output Request is a dependent object inclusion node which includes information for printing.
FIG. 33 depicts an example Export Declaration Processing Cancellation Request Message Data Type 33000, which comprises elements 33002-33020, hierarchically related as shown. For example, the Export Declaration Processing Cancellation Request 33002 includes a Message Header 33004.
The message type Export Declaration Processing Cancellation Request is derived from the business object Export Declaration as a leading object together with its operation signature. The message type Export Declaration Processing Cancellation Request is a request to cancel the processing of an export declaration. The structure of the message type Export Declaration Processing Cancellation Request is determined by the message data type ExportDeclarationProcessingCancellationRequestMessage. The message data type ExportDeclarationProcessingCancellationRequestMessage includes an object ExportDeclaration which is included in a business document, business information that is relevant for sending a business document in a message, the MessageHeader package, and an ExportDeclaration package. The message data type ExportDeclarationProcessingCancellationRequestMessage provides a structure for the Export Declaration Processing Cancellation Request message type and for associated operations.
The MessageHeader package is a grouping of business information that is relevant for sending a business document in a message. The MessageHeader package includes the MessageHeader node. The MessageHeader node is a grouping of business information from the perspective of a sending application, such as information to identify the business document in a message, information about the sender, and may be optionally information about the recipient. The MessageHeader includes SenderParty and RecipientParty. MessageHeader may be based on the datatype and may be based on datatype GDT:BusinessDocumentMessageHeader and the following elements of the GDT are used: RecipientParty, BusinessScope, SenderParty, SenderBusinessSystemID, TestDataIndicator, RecipientBusinessSystemID, ReferenceID, ReferenceUUID, ReconciliationIndicator, ID, UUID, and CreationDateTime. SenderParty is the partner responsible for sending a business document at a business application level. The SenderParty is of the type and may be based on datatype GDT:BusinessDocumentMessageHeaderParty. RecipientParty is of the type and may be based on datatype GDT:BusinessDocumentMessageHeaderParty. RecipientParty is the partner responsible for receiving a business document at a business application level.
The ExportDeclaration package is a grouping of ExportDeclaration with its TimePoint, BasicText, CustomsOffice, and Party packages and with an ExportDeclaration entity. ExportDeclaration is a business transaction document including data for a declaration to a customs authority for exporting goods according to legal requirements. ExportDeclaration includes the following non-node elements: ExportMessageSubTypeCode, ExportMessageID, ExportMessageReferenceID, CustomsAuthorityCountryCode, MajorVersionCustomsAuthorityID, MinorVersionCustomsAuthorityID, MainTestCaseID, SubTestCaseID, CustomsMessageExchangeServerFileID, CustomsProcessCustomsAuthorityID, ExportDeclarationCancellationTypeCode, and CustomsAuthenticationID.
ExportMessageSubTypeCode may be optional, is an internal type of a message, and may be based on datatype GDT:ExportMessageSubTypeCode. ExportMessageID may be optional, is an identifier of a message, and may be based on datatype GDT:CustomsProcessMessageID. ExportMessageReferenceID includes one or more identifiers of messages referenced by a message, and may be based on datatype GDT:CustomsProcessMessageID. CustomsAuthorityCountryCode may be optional, is a country in which a customs authority to which this processing request is sent is situated, and may be based on datatype GDT:CountryCode. MajorVersionCustomsAuthorityID may be optional, is a major version of a message, may be issued by a customs authority, and may be based on datatype GDT:VersionPartyID. MinorVersionCustomsAuthorityID may be optional, is a minor version of a message, may be issued by a customs authority, and may be based on datatype GDT:VersionPartyID. MainTestCaseID may be optional and is an identifier for a main test case. If a message is sent as part of a test case, MainTestCaseID provides an identifier of a superordinate test case. Test cases and their identifiers may be issued by a customs authority. MainTestCaseID may be based on datatype GDT:TestCaseID. SubTestCaseID may be optional and is an identifier for a sub test case. If a message is sent as part of a test case, SubTestCaseID provides an identifier of a subordinate test case. Test cases and their identifiers may be issued by a customs authority. SubTestCaseID may be based on datatype GDT:TestCaseID. CustomsMessageExchangeServerFileID may be optional, is an identifier for a file a message is stored in on a message exchange server that communicates with a customs authority, and may be based on datatype GDT:CustomsMessageExchangeServerFileID. CustomsProcessCustomsAuthorityID may be optional, is an identifier for an export, may be assigned by a customs authority, and may be based on datatype GDT:CustomsProcessID. ExportDeclarationCancellationTypeCode may be optional, is a type of cancellation, and may be based on datatype GDT:ExportDeclarationCancellationTypeCode. CustomsAuthenticationID may be optional, is an authentication identifier for communicating with a customs authority, and may be based on datatype GDT:CustomsAuthenticationID.
ExportDeclaration may include the node element TimePoint with a cardinality of 1:CN, the node element BasicText with a cardinality of 1:CN, the node element CustomsOffice with a cardinality of 1:CN, and the node element Party with a cardinality of 1:CN.
The ExportDeclarationTimePoint package includes the TimePoint entity. TimePoint is a time point at which processing of an export declaration took place, takes place, or may take place. TimePoint includes the following non-node elements: TimePointRoleCode, DateTime, and Date. TimePointRoleCode may be optional, is a role a time point plays in processing of an export declaration, and may be based on datatype GDT:TimePointRoleCode. DateTime may be optional, is a date and time of a time point, and may be based on datatype CDT:LOCAL_DateTime. Date may be optional, is a date of a time point, and may be based on datatype CDT:Date.
The ExportDeclarationBasicText package includes the BasicText entity. BasicText includes natural language text that describes an export declaration or specifies an export. BasicText is typed by datatype TextCollectionBasicText.
The ExportDeclarationCustomsOffice package includes the CustomsOffice entity. CustomsOffice is a customs office involved in an export. CustomsOffice includes the RoleCategoryCode non-node element, which may be optional, is a role a customs office plays in processing of an export declaration, and may be based on datatype GDT:PartyRoleCategoryCode. The ExportCustomsOffice package may include the node element Identification in a 1:CN cardinality relationship. The ExportCustomsOfficeIdentification package includes the Identification entity. Identification is an identifier of a customs office. Identification includes the following non-node elements: PartyIdentifierTypeCode and PartyID. PartyIdentifierTypeCode may be optional, is a type code of an identifier for a customs office, and may be based on datatype GDT:PartyIdentifierTypeCode. PartyID may be optional, is an identifier for a customs office, and may be based on datatype GDT:NOALPHANUMERICCONVERSION_PartyID.
The ExportParty package includes the Party entity. Party is a natural or legal person involved in an export as exporter or product recipient or acting on behalf of an exporter or product recipient. Party includes the following non-node elements: RoleCategoryCode, PostalRegulationsCompliantStreetDescription, and Address. RoleCategoryCode may be optional, is role a party plays in processing of an export declaration, and may be based on datatype GDT:PartyRoleCategoryCode. Address may be optional, is an address of a party, and may be based on datatype GDT:Address. PostalRegulationsCompliantStreetDescription may be optional, is a street and house identifier, may be formatted to comply with postal regulations in a country a party is situated in, and may be based on datatype GDT:LANGUAGEINDEPENDENT_MEDIUM_Description. The ExportParty package may include the Identification node element in a 1:CN cardinality relationship and the ContactParty node element in a 1:C cardinality relationship.
The ExportPartyPartyIdentification package includes the Identification entity. Identification is an identifier for a party. Identification includes the following non-node elements: PartyIdentifierTypeCode and PartyID. PartyIdentifierTypeCode may be optional, is a type of an identifier of a party, and may be based on datatype GDT:PartyIdentifierTypeCode. PartyID may be optional, is an identifier for a party, and may be based on datatype GDT:NOALPHANUMERICCONVERSION_PartyID.
The ExportPartyPartyContactParty package includes the ContactParty entity. The ContactParty entity is a contact for a party. ContactParty includes the following non-node elements: Address, BusinessPartnerFormattedName, FormattedConventionalPhoneNumberDescription, and FormattedFacsimileNumberDescription. Address may be optional, is an address of a contact party, and may be based on datatype GDT:Address. BusinessPartnerFormattedName may be optional, is a formatted name of a contact party, and may be based on datatype CDT:LANGUAGEINDEPENDENT_EXTENDED_Name. FormattedConventionalPhoneNumberDescription may be optional, is a formatted conventional phone number of a contact party, and may be based on datatype GDT:LANGUAGEINDEPENDENT_SHORT_Description. FormattedFacsimileNumberDescription may be optional, is a formatted facsimile number of a contact party, and may be based on datatype GDT:LANGUAGEINDEPENDENT_SHORT_Description.
FIGS. 34-1 through 34-2 depict an example Export Declaration Processing Confirmation Message Data Type 34000, which comprises elements 34002-34046, hierarchically related as shown. For example, the Export Declaration Processing Confirmation 34002 includes a Message Header 34004.
The message type Export Declaration Processing Confirmation is derived from a business object Export Declaration as a leading object together with its operation signature. The message type Export Declaration Processing Confirmation is a confirmation to confirm processing of an export declaration. The structure of the message type Export Declaration Processing Confirmation is determined by a messagedata type ExportDeclarationProcessingConfirmationMessage. The messagedata type ExportDeclarationProcessingConfirmationMessage includes an object ExportDeclaration which is included in a business document, business information that is relevant for sending a business document in a message, the MessageHeader package, and the ExportDeclaration package. The message data type ExportDeclarationProcessingConfirmationMessage provides a structure for the Export Declaration Processing Confirmation message type and for associated operations.
The MessageHeader package is a grouping of business information that is relevant for sending a business document in a message. The MessageHeader package includes the MessageHeader node. The MessageHeader node is a grouping of business information from the perspective of a sending application, such as information to identify the business document in a message, information about the sender, and optionally information about the recipient. The MessageHeader includes SenderParty and RecipientParty. MessageHeader may be based on the datatype GDT:BusinessDocumentMessageHeader and the following elements of the GDT are used: RecipientParty, BusinessScope, SenderParty, SenderBusinessSystemID, TestDataIndicator, RecipientBusinessSystemID, ReferenceID, ReferenceUUID, ReconciliationIndicator, ID, UUID, and CreationDateTime. SenderParty is the partner responsible for sending a business document at a business application level. The SenderParty is of the type GDT:BusinessDocumentMessageHeaderParty. RecipientParty is of the type GDT:BusinessDocumentMessageHeaderParty. RecipientParty is the partner responsible for receiving a business document at a business application level.
The ExportDeclaration package is a grouping of ExportDeclaration with its CustomsAuthorisation, TimePoint, BasicText, Location, CustomsOffice, Party, TransportRouteCountry, Item, Document, and LogItem packages and with the ExportDeclaration entity. ExportDeclaration is a business transaction document including data for a declaration to a customs authority for exporting goods according to legal requirements. ExportDeclaration includes the following non-node elements: ExportMessageSubTypeCode, ExportMessageID, ExportMessageReferenceID, MajorVersionCustomsAuthorityID, MinorVersionCustomsAuthorityID, MainTestCaseID, SubTestCaseID, CustomsProcessID, CustomsProcessPartyID, CustomsProcessCustomsAuthorityID, ExportDeclarationTypeCode, ExportTypeCode, ExportExportingCountryCode, ExportDestinationCountryCode, ExportSpecialCircumstancesCode, ExportTransportCostPaymentFormCode, ContainerUsedIndicator, ExportPartyRepresentationCode, ItemTotalNumberValue, TotalGrossWeightQuantity, TotalGrossWeightQuantityTypeCode, ConsignmentExportID, InlandExportTransportModeCode, CrossBorderExportTransportModeCode, CrossBorderExportTransportMeansTypeCode, CrossBorderTransportMeansID, ExportCrossBorderTransportMeansNationalityCode, ExportBusinessTransactionTypeCode, InvoiceTotalNetAmount, ExportIncotermsClassificationCode, ExportIncotermsClassificationDescription, IncotermsTransferLocationName, PackageTotalNumberValue, and CommunicationDateTime.
ExportMessageSubTypeCode may be optional, is an internal type of a message, and may be based on datatype GDT:ExportMessageSubTypeCode. ExportMessageID may be optional, is an identifier for a message, and may be based on datatype GDT:CustomsProcessMessageID. ExportMessageReferenceID includes one or more identifiers of messages referenced by a message, and may be based on datatype GDT:CustomsProcessMessageID. MajorVersionCustomsAuthorityID may be optional, is a major version of a message, may be issued by a customs authority, and may be based on datatype GDT:VersionPartyID. MinorVersionCustomsAuthorityID may be optional, is a minor version of a message, may be issued by a customs authority, and may be based on datatype GDT:VersionPartyID. MainTestCaseID may be optional and is an identifier for a main test case. If a message is sent as part of a test case, MainTestCaseID provides an identifier of a superordinate test case. Test cases and their identifiers may be issued by a customs authority. MainTestCaseID may be based on datatype GDT:TestCaseID. SubTestCaseID may be optional, is an identifier for a sub test case. If a message is sent as part of a test case, SubTestCaseID provides an identifier of a subordinate test case. Test cases and their identifiers may be issued by a customs authority. SubTestCaseID may be based on datatype GDT:TestCaseID. CustomsProcessID may be optional, is an identifier for an export, may be assigned internally, and may be based on datatype GDT:CustomsProcessID. CustomsProcessPartyID may be optional, is an identifier for an export, may be assigned by a third party, and may be based on datatype GDT:CustomsProcessID. CustomsProcessCustomsAuthorityID may be optional, is an identifier for an export, may be assigned by a customs authority, and may be based on datatype GDT:CustomsProcessID. ExportDeclarationTypeCode may be optional, is a type of an export declaration, and may be based on datatype GDT:ExportDeclarationTypeCode. ExportTypeCode may be optional, is a type of an export, and may be based on datatype GDT:ExportTypeCode. ExportExportingCountryCode may be optional, is a country from which goods are exported, and may be based on datatype GDT:ExportExportingCountryCode. ExportDestinationCountryCode may be optional, is a country to which goods are exported, and may be based on datatype GDT:ExportDestinationCountryCode. ExportSpecialCircumstancesCode may be optional, documents special circumstances accompanying an export, and may be based on datatype GDT:ExportSpecialCircumstancesCode. ExportTransportCostPaymentFormCode may be optional, is a payment form for a transport cost of an export, and may be based on datatype GDT:ExportTransportCostPaymentFormCode. ContainerUsedIndicator may be optional, indicates whether export goods are shipped in containers, and may be based on datatype CDT:Indicator. ExportPartyRepresentationCode may be optional, is a representation situation of parties involved in an export, and may be based on datatype GDT:ExportPartyRepresentationCode. ItemTotalNumberValue may be optional, is a total number of items in an export declaration, and may be based on datatype GDT:NumberValue. TotalGrossWeightQuantity may be optional, is a total gross weight of export declaration items, and may be based on datatype CDT:Quantity. TotalGrossWeightQuantityTypeCode may be optional, is a type of a total gross weight of export declaration items, and may be based on datatype GDT:QuantityTypeCode. ConsignmentExportID may be optional, is an identifier for a consignment underlying an export, and may be based on datatype GDT:ConsignmentExportID. InlandExportTransportModeCode may be optional, is a transport mode used to move an export goods in inland, and may be based on datatype GDT:ExportTransportModeCode. CrossBorderExportTransportModeCode may be optional, is a transport mode used to move export goods across a border, and may be based on datatype GDT:ExportTransportModeCode. CrossBorderExportTransportMeansTypeCode may be optional, is a transport means used to move export goods across a border, and may be based on datatype GDT:ExportTransportMeansTypeCode. CrossBorderTransportMeansID may be optional, is an identifier for a transport means used to move export goods across a border, and may be based on datatype GDT:TransportMeansID_V1. ExportCrossBorderTransportMeansNationalityCode may be optional, is a nationality of a transport means used to move export goods across a border, and may be based on datatype GDT:ExportCrossBorderTransportMeansNationalityCode. ExportBusinessTransactionTypeCode may be optional, is a type of a business transaction underlying an export, and may be based on datatype GDT:ExportBusinessTransactionTypeCode. InvoiceTotalNetAmount may be optional, is a total net amount of an invoice underlying an export, and may be based on datatype CDT:Amount. ExportIncotermsClassificationCode may be optional, is a classification of incoterms underlying an export, and may be based on datatype GDT:ExportIncotermsClassificationCode. ExportIncotermsClassificationDescription may be optional, is a description of incoterms underlying an export, and may be based on datatype GDT:LANGUAGEINDEPENDENT_MEDIUM_Description. IncotermsTransferLocationName may be optional, is a name of a transfer location of incoterms underlying an export, and may be based on datatype CDT:MEDIUM_Name. PackageTotalNumberValue may be optional, is a total number of packages in an export, and may be based on datatype GDT:NumberValue. CommunicationDateTime may be optional, is a date and time a message was communicated by a customs authority, and may be based on datatype GDT:GLOBAL_DateTime.
ExportDeclaration may include the node element CustomsAuthorisation in a 1:C cardinality relationship, the node element TimePoint in a 1:CN cardinality relationship, the node element BasicText in a 1:CN cardinality relationship, the node element Location in a 1:CN cardinality relationship, the node element CustomsOffice in a 1:CN cardinality relationship, the node element Party in a 1:CN cardinality relationship, the node element TransportRouteCountry in a 1:CN cardinality relationship, the node element Item in a 1:CN cardinality relationship, the node element Document in a 1:CN cardinality relationship, and the node element LogItem in a 1:CN cardinality relationship.
The ExportDeclarationCustomsAuthorisation package includes the CustomsAuthorisation entity. CustomsAuthorisation is a document that authorizes an exporter to use simplifications in exports. CustomsAuthorisation includes the following non-node elements: CustomsAuthorisationTypeCode and CustomsAuthorisationID. CustomsAuthorisationTypeCode may be optional, is a type of a customs authorization, and may be based on datatype GDT:CustomsAuthorisationTypeCode. CustomsAuthorisationID may be optional, is an identifier for a customs authorization, may be issued by a customs authority, and may be based on datatype GDT: CustomsAuthorisationID.
The ExportDeclarationTimePoint package includes the TimePoint entity. TimePoint is a time point at which some processing of an export declaration took place, takes place or will take place. TimePoint includes the following non-node elements: TimePointRoleCode, DateTime, and Date. TimePointRoleCode may be optional, is a role a time point plays in processing of an export declaration, and may be based on datatype GDT:TimePointRoleCode. DateTime may be optional, is a date and time of a time point, and may be based on datatype CDT:LOCAL_DateTime. Date may be optional, is a date of a time point, and may be based on datatype CDT:Date.
The ExportDeclarationBasicText package includes the BasicText entity. BasicText includes natural language text that describes an export declaration or specifies an export. BasicText is typed by datatype TextCollectionBasicText. The ExportDeclarationLocation package includes the Location entity. Location is a location related to processing of an export declaration. Location includes the following non-node elements: LocationRoleCategoryCode, CustomsAuthorityID, Address, and PostalRegulationsCompliantStreetDescription. LocationRoleCategoryCode may be optional, is a role a location plays in the processing of an export declaration, and may be based on datatype GDT:LocationRoleCategoryCode. CustomsAuthorityID may be optional, is an identifier for a location, may be issued by a customs authority, and may be based on datatype GDT:LocationPartyID. Address may be optional, is an address of a location, and may be based on datatype GDT:Address. PostalRegulationsCompliantStreetDescription may be optional, includes a street and house identifier of a location, may be formatted to comply with postal regulations of a country in which a location is situated, and may be based on datatype GDT:LANGUAGEINDEPENDENT_MEDIUM_Description.
The ExportDeclarationCustomsOffice package includes a CustomsOffice entity. CustomsOffice is a customs office involved in an export. CustomsOffice includes the RoleCategoryCode non-node element, which may be optional, is a role a customs office plays in processing of an export declaration, and may be based on datatype GDT:PartyRoleCategoryCode. The ExportCustomsOffice package may include the node element Identification in a 1:C cardinality relationship. The ExportCustomsOfficeIdentification package includes the Identification entity. Identification is an identifier of a customs office. Identification includes the following non-node elements: PartyIdentifierTypeCode and PartyID. PartyIdentifierTypeCode may be optional, is a type code of an identifier for a customs office, and may be based on datatype GDT:PartyIdentifierTypeCode. PartyID may be optional, is an identifier for a customs office, and may be based on datatype GDT:NOALPHANUMERICCONVERSION_PartyID.
The ExportDeclarationParty package includes the Party entity. Party is a natural or legal person involved in an export as exporter or product recipient or acting on behalf of an exporter or product recipient. Party includes the following non-node elements: RoleCategoryCode, PostalRegulationsCompliantStreetDescription, and Address. RoleCategoryCode may be optional, is role a party plays in processing of an export declaration, and may be based on datatype GDT:PartyRoleCategoryCode. Address may be optional, is an address of a party, and may be based on datatype GDT:Address. PostalRegulationsCompliantStreetDescription may be optional, is a street and house identifier, may be formatted to comply with postal regulations in a country a party is situated in, and may be based on datatype GDT:LANGUAGEINDEPENDENT_MEDIUM_Description. The ExportParty package may include the Identification node element in a 1:CN cardinality relationship and the ContactParty node element in a 1:C cardinality relationship.
The ExportDeclarationPartyPartyIdentification package includes the Identification entity. Identification is an identifier for a party. Identification includes the following non-node elements: PartyIdentifierTypeCode and PartyID. PartyIdentifierTypeCode may be optional, is a type of an identifier of a party, and may be based on datatype GDT:PartyIdentifierTypeCode. PartyID may be optional, is an identifier for a party, and may be based on datatype GDT:NOALPHANUMERICCONVERSION_PartyID.
The ExportDeclarationPartyPartyContactParty package includes the ContactParty entity. The ContactParty entity is a contact for a party. ContactParty includes the following non-node elements: Address, BusinessPartnerFormattedName, FormattedConventionalPhoneNumberDescription, and FormattedFacsimileNumberDescription. Address may be optional, is an address of a contact party, and may be based on datatype GDT:Address. BusinessPartnerFormattedName may be optional, is a formatted name of a contact party, and may be based on datatype CDT:LANGUAGEINDEPENDENT_EXTENDED_Name. FormattedConventionalPhoneNumberDescription may be optional, is a formatted conventional phone number of a contact party, and may be based on datatype GDT:LANGUAGEINDEPENDENT_SHORT_Description. FormattedFacsimileNumberDescription may be optional, is a formatted facsimile number of a contact party, and may be based on datatype GDT:LANGUAGEINDEPENDENT_SHORT_Description.
The ExportDeclarationTransportRouteCountry package includes the TransportRouteCountry entity. TransportRouteCountry is a country an export starts in, passes through, or ends in. TransportRouteCountry includes the following non-node elements: OrdinalNumberValue and ExportTransportRouteCountryCode. OrdinalNumberValue may be optional, is an ordinal number used order countries of a transport route in an order in which they are passed by an export, and may be based on datatype GDT:OrdinalNumberValue. ExportTransportRouteCountryCode may be optional, is a single country of a transport route, and may be based on datatype GDT:ExportTransportRouteCountryCode.
The ExportDeclarationItem package includes the Item entity. Item is an item in an export declaration. Item includes the following non-node elements: CustomsAuthorityID, Description, CustomsProcessPartyID, ConsignmentExportID, NetWeightQuantity, Net WeightQuantityTypeCode, Gross WeightQuantity, GrossWeightQuantityTypeCode, CustomsCommodityClassificationCode, ExportProcedureTypeCode, ExportPreviousProcedureTypeCode, ExportAdditionalProcedureTypeCode, OriginExportRegionCode, DangerousGoodsID, ExportTransportCostPaymentFormCode, LegalComplianceQuantity, LegalComplianceQuantityTypeCode, and LegalComplianceAmount.
CustomsAuthorityID may be optional, is an identifier for an export declaration item, may follow a schema specified by a customs authority, and may be based on datatype GDT: CustomsDeclarationItemCustomsAuthorityID. Description may be optional, is a description of an export declaration item in natural language, and may be based on datatype GDT:Description. CustomsProcessPartyID may be optional, is an identifier for an export, may be assigned internally, and may be based on datatype GDT:CustomsProcessID. ConsignmentExportID may be optional, is an identifier for a consignment underlying an export, and may be based on datatype GDT:ConsignmentExportID. NetWeightQuantity may be optional, is the net weight quantity of an item, and may be based on datatype CDT:Quantity. NetWeightQuantityTypeCode may be optional, is a type of net weight quantity of an item, and may be based on datatype GDT:QuantityTypeCode. GrossWeightQuantity may be optional, is the gross weight of an item, and may be based on datatype CDT:Quantity. GrossWeightQuantityTypeCode may be optional, is a type of gross weight of an item, and may be based on datatype GDT:QuantityTypeCode. CustomsCommodityClassificationCode may be optional, is a classification of an exported commodity according to specifications by a customs authority, and may be based on datatype GDT: CustomsCommodityClassificationCode. ExportProcedureTypeCode may be optional, is an export procedure to use for an item, and may be based on datatype GDT:ExportProcedureTypeCode. ExportPreviousProcedureTypeCode may be optional, is a customs procedure that was previously applied to an item, and may be based on datatype GDT:ExportPreviousProcedureTypeCode. ExportAdditionalProcedureTypeCode may be optional, is an additional export procedure to use for an item, and may be based on datatype GDT:ExportAdditionalProcedureTypeCode. OriginExportRegionCode may be optional, is a region of origin of an export item, and may be based on datatype GDT:ExportRegionCode. DangerousGoodsID may be optional, is an identifier for a risk and kind of danger posed by an item, and may be based on datatype GDT:DangerousGoodsID. ExportTransportCostPaymentFormCode may be optional, is a payment form for a transport cost of an export, and may be based on datatype GDT:ExportTransportCostPaymentFormCode. LegalComplianceQuantity may be optional, is a quantity of an item, may be formatted to comply with legal regulations, and may be based on datatype CDT:Quantity. LegalComplianceQuantityTypeCode may be optional, is a type of a quantity of an item, may be formatted to comply with legal regulations, and may be based on datatype GDT:QuantityTypeCode. LegalComplianceAmount may be optional, is an amount of an item, may be formatted to comply with legal regulations, and may be based on datatype CDT:Amount.
The ExportDeclarationDocument package includes the Document entity. Document is a document involved in an export. The ExportDeclarationLogItem package includes the LogItem entity. LogItem is an application log item based on processing of an export declaration. LogItem may be typed by datatype LogItem.
The ExportDeclarationItemParty package includes the Party entity. Party is a party involved in an export of an item. Party includes the following non-node elements: RoleCategoryCode, Address, and PostalRegulationsCompliantStreetDescription. RoleCategoryCode may be optional, is a role a party plays in an export of an item, and may be based on datatype GDT:PartyRoleCategoryCode. Address may be optional, is an address of a party, and may be based on datatype GDT:Address. PostalRegulationsCompliantStreetDescription may be optional, is a street and house identifier of a party, may be formatted to comply with local postal regulations in a country a party is situated in, and may be based on datatype GDT:LANGUAGEINDEPENDENT_MEDIUM_Description. Party may include an Identification node element in a 1:CN cardinality relationship and a ContactParty node element in a 1:C cardinality relationship.
The ExportDeclarationItemPartyIdentification package includes the Identification entity. Identification is an identifier for a party. Identification includes the following non-node elements: PartyIdentifierTypeCode and PartyID. PartyIdentifierTypeCode may be optional, is a type of a party identifier, and may be based on datatype GDT:PartyIdentifierTypeCode. PartyID may be optional, is an identifier for a party, and may be based on datatype GDT:NOALPHANUMERICCONVERSION_PartyID. The ExportDeclarationItemPartyContactParty package includes the ContactParty entity. ContactParty is a contact party for a party. ContactParty includes the following non-node elements: Address, BusinessPartnerFormattedName, FormattedConventionalPhoneNumberDescription, and FormattedFacsimileNumberDescription. Address may be optional, is an address of a contact party, and may be based on datatype GDT:Address. BusinessPartnerFormattedName may be optional, is a formatted name of a contact party, and may be based on datatype CDT:LANGUAGEINDEPENDENT_EXTENDED_Name. FormattedConventionalPhoneNumberDescription may be optional, is a formatted conventional phone number of a contact party, and may be based on datatype GDT:LANGUAGEINDEPENDENT_SHORT_Description. FormattedFacsimileNumberDescription may be optional, is a formatted facsimile number of a contact party, and may be based on datatype GDT:LANGUAGEINDEPENDENT_SHORT_Description.
The ExportDeclarationItemPackage package includes the Package entity. Package is a package an item is packed in. Package includes the following non-node elements: OrdinalNumberValue, ElementNumberValue, ExportpackageTypeCode, and PackageExportID. OrdinalNumberValue may be optional, is an ordinal number used to order packages, and may be based on datatype GDT:OrdinalNumberValue. ElementNumberValue may be optional, is the number of physical containers in a package, and may be based on datatype GDT:NumberValue. ExportPackageTypeCode may be optional, is a type of a physical container in a package, and may be based on datatype GDT:ExportPackageTypeCode. PackageExportID may be optional, is an identifier for a physical container in a package, and may be based on datatype GDT:PackageExportID.
The ExportDeclarationItemContainer package includes the Container entity. Container is a container an item is packed in. Container includes the ContainerExportID non-node element, which may be optional, is an identifier for a container, and may be based on datatype GDT: ContainerExportID. The ExportDeclarationItemSupportingDocument package includes the SupportingDocument entity. SupportingDocument is a document providing additional information used to export an item. SupportingDocument includes the following non-node elements: ExportSupportingDocumentTypeCode, ExportSupportingDocumentID, ExportSupportingDocumentAddendumID, ExportSupportingDocumentDetailID, IssueDate, ValidityEndDate, LicenceWriteOffAmount, LicenceWriteOffQuantity, and LicenceWriteOffQuantityTypeCode.
ExportSupportingDocumentTypeCode may be optional, is a type of a supporting document, and may be based on datatype GDT:ExportSupportingDocumentTypeCode. ExportSupportingDocumentID may be optional, is an identifier for a supporting document, and may be based on datatype GDT:ExportSupportingDocumentID. ExportSupportingDocumentAddendumID may be optional, is an identifier for an addendum of a supporting document, and may be based on datatype GDT:ExportSupportingDocumentAddendumID. ExportSupportingDocumentDetailID may be optional, is an identifier for a detail of a supporting document, and may be based on datatype GDT:ExportSupportingDocumentDetailID. IssueDate may be optional, is a date a supporting document was issued, and may be based on datatype CDT:Date. ValidityEndDate may be optional, is a date a validity of a supporting document ends, and may be based on datatype CDT:Date. LicenceWriteOffAmount may be optional, is an amount to write off of a license for an export declaration item, and may be based on datatype CDT:Amount. LicenceWriteOffQuantity may be optional, is a quantity to write off of a licence for an export declaration item, and may be based on datatype CDT: Quantity. LicenceWriteOffQuantityTypeCode may be optional, is a type of a LicenceWriteOffQuantity, and may be based on datatype GDT:QuantityTypeCode.
The ExportDeclarationItemPreviousDocument package includes the PreviousDocument entity. PreviousDocument is a document that proves prior export-relevant processing of an item. PreviousDocument includes the following non-node elements: ExportPreviousDocumentTypeCode, ExportPreviousDocumentID, and ExportPreviousDocumentDescription. ExportPreviousDocumentTypeCode may be optional, is a type of a previous document, and may be based on datatype GDT:ExportPreviousDocumentTypeCode. ExportPreviousDocumentID may be optional, is an identifier for a previous document, and may be based on datatype GDT:ExportPreviousDocumentID. ExportPreviousDocumentDescription may be optional, is a description of a previous document, and may be based on datatype GDT:LANGUAGEINDEPENDENT_MEDIUM_Description.
The ExportDeclarationItemCustomsWarehouseDischarge package includes the CustomsWarehouseDischarge entity. CustomsWarehouseDischarge includes references and information for discharging an item from a customs warehouse. CustomsWarehouseDischarge includes the following non-node elements: ClosingPortionTotalNumberValue and CustomsAuthorisationID. ClosingPortionTotalNumberValue may be optional, is a total number of closing portions in a customs warehouse discharge, and may be based on datatype GDT:NumberValue. CustomsAuthorisationID may be optional, is an identifier for a customs authorization of an exporter for using a customs warehouse, and may be based on datatype GDT: CustomsAuthorisationID.
The ExportDeclarationItemCustomsWarehouseDischarge package may include the node element ClosingPortion in a 1:CN cardinality relationship. ClosingPortion is a closing portion of a customs warehouse discharge. ClosingPortion includes the following non-node elements: OrdinalNumberValue, CustomsProcessCustomsAuthorityID, CustomsDeclarationItemCustomsAuthorityID, CustomsCommodityClassificationCode, UsualFormsOfHandlingAppliedIndicator, ElectronicallyReportedIndicator, Description, OriginalQuantity, OriginalQuantityTypeCode, Quantity, and QuantityTypeCode.
OrdinalNumberValue may be optional, is an ordinal number to order closing portions of a customs warehouse discharge, and may be based on datatype GDT:OrdinalNumberValue. CustomsProcessCustomsAuthorityID may be optional, is an identifier for a customs process with which goods to be discharged are stored in a customs warehouse, and may be based on datatype GDT: CustomsProcessID. CustomsDeclarationItemCustomsAuthorityID may be optional, is an identifier of an item in a previous customs declaration with which goods to be discharged are stored in a customs warehouse, and may be based on datatype GDT: CustomsDeclarationItemCustomsAuthorityID. CustomsCommodityClassificationCode may be optional, is a classification of goods to be discharged, and may be based on datatype GDT: CustomsCommodityClassificationCode. UsualFormsOfHandlingAppliedIndicator may be optional, indicates whether usual forms of handling have been applied to goods to be discharged, and may be based on datatype CDT:Indicator. ElectronicallyReportedIndicator may be optional, indicates whether a customs declaration with which goods to be discharged are stored in a customs warehouse, may be given electronically, and may be based on datatype CDT:Indicator. Description may be optional, is a natural language description of a closing portion, and may be based on datatype GDT:Description. OriginalQuantity may be optional, is an item portion to close with a closing portion, may be given with a unit of measure with which goods were originally reported, and may be based on datatype CDT:Quantity. OriginalQuantityTypeCode may be optional, is a type of an item portion to close with a closing portion, may be given with a unit of measure with which goods were originally reported, and may be based on datatype GDT:QuantityTypeCode. Quantity may be optional, is an item portion to close with a closing portion, may be given with a unit of measure with which goods are measured at a time of discharge, and may be based on datatype CDT:Quantity. QuantityTypeCode may be optional, is a type of an item portion to close with a closing portion, may be given with a unit of measure with which goods are measured at a time of discharge, and may be based on datatype GDT: QuantityTypeCode.
The ExportDeclarationItemInwardProcessingDischarge package includes the InwardProcessingDischarge entity. InwardProcessingDischarge includes references and information for discharging an item from inward processing. InwardProcessingDischarge includes the following non-node elements: ClosingPortionTotalNumberValue and CustomsAuthorisationID. ClosingPortionTotalNumberValue may be optional, is a total number of closing portions of an inward processing discharge, and may be based on datatype GDT:NumberValue. CustomsAuthorisationID may be optional, is an identifier of a customs authorisation of an exporter for inward processing, and may be based on datatype GDT: CustomsAuthorisationID.
ExportDeclarationItemInwardProcessingDischarge may include the ClosingPortion node element in a 1:CN cardinality relationship. The ExportDeclarationItemInwardProcessingDischargellemInwardProcessingClosingPortion package includes the ClosingPortion entity. ClosingPortion is a closing portion of an inward processing discharge. ClosingPortion includes the following non-node elements: OrdinalNumberValue, CustomsProcessCustomsAuthorityID, CustomsDeclarationItemCustomsAuthorityID, ElectronicallyReportedIndicator, and Description.
OrdinalNumberValue may be optional, is an ordinal number used to order closing portions, and may be based on datatype GDT: OrdinalNumberValue. CustomsProcessCustomsAuthorityID may be optional, is an identifier of a customs process that stated that goods are subject to inward processing, and may be based on datatype GDT: CustomsProcessID. CustomsDeclarationItemCustomsAuthorityID may be optional, is an identifier of an item in a customs declaration that stated that goods are subject to inward processing, and may be based on datatype GDT: CustomsDeclarationItemCustomsAuthorityID. ElectronicallyReportedIndicator may be optional, indicates whether a statement that goods are subject to inward processing was given electronically, and may be based on datatype CDT:Indicator. Description may be optional, is a description of a closing portion, and may be based on datatype GDT:Description.
FIGS. 35-1 through 35-2 depict an example Export Declaration Processing Request Message Data Type 35000, which comprises elements 35002-35052, hierarchically related as shown. For example, the Export Declaration Processing Request 35002 includes a Message Header 35004.
The message type Export Declaration Processing Request is derived from a business object Export Declaration as a leading object together with its operation signature. The message type Export Declaration Processing Request is a request for processing an export declaration. The structure of the message type Export Declaration Processing Request is determined by a message data type ExportDeclarationProcessingRequestMessage. The message data type ExportDeclarationProcessingRequestMessage includes an object ExportDeclaration which is included in a business document, business information that is relevant for sending a business document in a message, the MessageHeader package, and the ExportDeclaration package. The message data type ExportDeclarationProcessingRequestMessage provides a structure for the Export Declaration Processing Request message type and for associated operations.
The MessageHeader package is a grouping of business information that is relevant for sending a business document in a message. The MessageHeader package includes the MessageHeader node. The MessageHeader node is a grouping of business information from the perspective of a sending application, such as information to identify the business document in a message, information about the sender, and optionally information about the recipient. The MessageHeader includes SenderParty and RecipientParty. MessageHeader may be based on the datatype GDT:BusinessDocumentMessageHeader and the following elements of the GDT are used: RecipientParty, BusinessScope, SenderParty, SenderBusinessSystemID, TestDataIndicator, RecipientBusinessSystemID, ReferenceID, ReferenceUUID, ReconciliationIndicator, ID, UUID, and CreationDateTime. SenderParty is the partner responsible for sending a business document at a business application level. The SenderParty is of the type GDT:BusinessDocumentMessageHeaderParty. RecipientParty is of the type GDT:BusinessDocumentMessageHeaderParty. RecipientParty is the partner responsible for receiving a business document at a business application level.
The ExportDeclaration package is a grouping of ExportDeclaration with its CustomsAuthorisation, TimePoint, BasicText, Location, CustomsOffice, Party, TransportRouteCountry, and Item and with the ExportDeclaration entity. ExportDeclaration is a business transaction document including data for a declaration to a customs authority for exporting goods according to legal requirements. ExportDeclaration includes the following non-node elements: ExportMessageSubTypeCode, ExportMessageID, ExportMessageReferenceID, CustomsAuthorityCountryCode, MajorVersionCustomsAuthorityID, MinorVersionCustomsAuthorityID, MainTestCaseID, SubTestCaseID, CustomsMessageExchangeServerFileID, CustomsProcessID, CustomsProcessPartyID, CustomsProcessCustomsAuthorityID, ExportDeclarationTypeCode, ExportTypeCode, ExportExportingCountryCode, ExportDestinationCountryCode, ExportSpecialCircumstancesCode, ExportTransportCostPaymentFormCode, ContainerUsedIndicator, ExportPartyRepresentationCode, ItemTotalNumberValue, TotalGrossWeightQuantity, TotalGrossWeightQuantityTypeCode, ConsignmentExportID, InlandExportTransportModeCode, CrossBorderExportTransportModeCode, CrossBorderExportTransportMeansTypeCode, CrossBorderTransportMeansID, ExportCrossBorderTransportMeansNationalityCode, ExportBusinessTransactionTypeCode, InvoiceTotalNetAmount, ExportIncotermsClassificationCode, ExportIncotermsClassificationDescription, IncotermsTransferLocationName, and CustomsAuthenticationID.
ExportMessageSubTypeCode may be optional, is an internal type of a message, and may be based on datatype GDT:ExportMessageSubTypeCode. ExportMessageID may be optional, is an identifier for a message, and may be based on datatype GDT:CustomsProcessMessageID. ExportMessageReferenceID includes one or more identifiers of previous messages referenced by a message, and may be based on datatype GDT:CustomsProcessMessageID. CustomsAuthorityCountryCode may be optional, is a country in which a customs authority to which a processing request is sent is situated, and may be based on datatype GDT:CountryCode. MajorVersionCustomsAuthorityID may be optional, is a major version of a message, may be issued by a customs authority, and may be based on datatype GDT:VersionPartyID. MinorVersionCustomsAuthorityID may be optional, is a minor version of a message, may be issued by a customs authority, and may be based on datatype GDT:VersionPartyID. MainTestCaseID may be optional and is an identifier for a main test case. If a message is sent as part of a test case, MainTestCaseID provides an identifier of a superordinate test case. Test cases and their identifiers may be issued by a customs authority. MainTestCaseID may be based on datatype GDT:TestCaseID. SubTestCaseID may be optional, is an identifier for a sub test case. If a message is sent as part of a test case, SubTestCaseID provides an identifier of a subordinate test case. Test cases and their identifiers may be issued by a customs authority. SubTestCaseID may be based on datatype GDT:TestCaseID. CustomsMessageExchangeServerFileID may be optional, is an identifier for a file a message is stored in on a message exchange server that communicates with a customs authority, and may be based on datatype GDT:CustomsMessageExchangeServerFileID. CustomsProcessID may be optional, is an identifier for an export, may be assigned internally, and may be based on datatype GDT:CustomsProcessID. CustomsProcessPartyID may be optional, is an identifier for an export, may be assigned by a third party, and may be based on datatype GDT: CustomsProcessID. CustomsProcessCustomsAuthorityID may be optional, is an identifier for an export, may be assigned by a customs authority, and may be based on datatype GDT:CustomsProcessID. ExportDeclarationTypeCode may be optional, is a type of an export declaration, and may be based on datatype GDT:ExportDeclarationTypeCode. ExportTypeCode may be optional, is a type of an export, and may be based on datatype GDT:ExportTypeCode. ExportExportingCountryCode may be optional, is a country from which goods are exported, and may be based on datatype GDT:ExportExportingCountryCode. ExportDestinationCountryCode may be optional, is a country to which goods are exported, and may be based on datatype GDT:ExportDestinationCountryCode. ExportSpecialCircumstancesCode may be optional, documents special circumstances accompanying an export, and may be based on datatype GDT:ExportSpecialCircumstancesCode. ExportTransportCostPaymentFormCode may be optional, is a payment form for a transport cost of an export, and may be based on datatype GDT:ExportTransportCostPaymentFormCode. ContainerUsedIndicator may be optional, indicates whether export goods are shipped in containers, and may be based on datatype CDT:Indicator. ExportPartyRepresentationCode may be optional, is a representation situation of parties involved in an export, and may be based on datatype GDT:ExportPartyRepresentationCode. ItemTotalNumberValue may be optional, is a total number of items in an export declaration, and may be based on datatype GDT:NumberValue. TotalGrossWeightQuantity may be optional, is a total gross weight of export declaration items, and may be based on datatype CDT:Quantity. TotalGrossWeightQuantityTypeCode may be optional, is a type of a total gross weight of export declaration items, and may be based on datatype GDT:QuantityTypeCode. ConsignmentExportID may be optional, is an identifier for a consignment underlying an export, and may be based on datatype GDT:ConsignmentExportID. InlandExportTransportModeCode may be optional, is a transport mode used to move an export goods in inland, and may be based on datatype GDT:ExportTransportModeCode. CrossBorderExportTransportModeCode may be optional, is a transport mode used to move export goods across a border, and may be based on datatype GDT:ExportTransportModeCode. CrossBorderExportTransportMeansTypeCode may be optional, is a transport means used to move export goods across a border, and may be based on datatype GDT:ExportTransportMeansTypeCode. CrossBorderTransportMeansID may be optional, is an identifier for a transport means used to move export goods across a border, and may be based on datatype GDT:TransportMeansID_V1. ExportCrossBorderTransportMeansNationalityCode may be optional, is a nationality of a transport means used to move export goods across a border, and may be based on datatype GDT:ExportCrossBorderTransportMeansNationalityCode. ExportBusinessTransactionTypeCode may be optional, is a type of a business transaction underlying an export, and may be based on datatype GDT:ExportBusinessTransactionTypeCode. InvoiceTotalNetAmount may be optional, is a total net amount of an invoice underlying an export, and may be based on datatype CDT:Amount. ExportIncotermsClassificationCode may be optional, is a classification of incoterms underlying an export, and may be based on datatype GDT:ExportIncotermsClassificationCode. ExportIncotermsClassificationDescription may be optional, is a description of incoterms underlying an export, and may be based on datatype GDT:LANGUAGEINDEPENDENT_LONG_Description. IncotermsTransferLocationName may be optional, is a name of a transfer location of incoterms underlying an export, and may be based on datatype CDT:MEDIUM_Name. CustomsAuthenticationID may be optional, is an authentication identifier for communicating with a customs authority, and may be based on datatype GDT: CustomsAuthenticationID.
ExportDeclaration may include the node element CustomsAuthorisation in a 1:C cardinality relationship, the node element TimePoint in a 1:CN cardinality relationship, the node element BasicText in a 1:CN cardinality relationship, the node element Location in a 1:CN cardinality relationship, the node element CustomsOffice in a 1:CN cardinality relationship, the node element Party in a 1:CN cardinality relationship, the node element TransportRouteCountry in a 1:CN cardinality relationship, and the node element Item in a 1:CN cardinality relationship.
The ExportDeclarationCustomsAuthorisation package includes the CustomsAuthorisation entity. CustomsAuthorisation is a document that authorizes an exporter to use simplifications in exports. CustomsAuthorisation includes the following non-node elements: CustomsAuthorisationTypeCode and CustomsAuthorisationID. CustomsAuthorisationTypeCode may be optional, is a type of a customs authorization, and may be based on datatype GDT:CustomsAuthorisationTypeCode. CustomsAuthorisationID may be optional, is an identifier for a customs authorization, may be issued by a customs authority, and may be based on datatype GDT: CustomsAuthorisationID.
The ExportDeclarationTimePoint package includes the TimePoint entity. TimePoint is a time point at which some processing of an export declaration took place, takes place or will take place. TimePoint includes the following non-node elements: TimePointRoleCode, DateTime, and Date. TimePointRoleCode may be optional, is a role a time point plays in processing of an export declaration, and may be based on datatype GDT:TimePointRoleCode. DateTime may be optional, is a date and time of a time point, and may be based on datatype CDT:LOCAL_DateTime. Date may be optional, is a date of a time point, and may be based on datatype CDT:Date.
The ExportDeclarationBasicText package includes the BasicText entity. BasicText includes natural language text that describes an export declaration or specifies an export. BasicText is typed by datatype TextCollectionBasicText. The ExportDeclarationLocation package includes the Location entity. Location is a location related to processing of an export declaration. Location includes the following non-node elements: LocationRoleCategoryCode, CustomsAuthorityID, Address, and PostalRegulationsCompliantStreetDescription. LocationRoleCategoryCode may be optional, is a role a location plays in the processing of an export declaration, and may be based on datatype GDT:LocationRoleCategoryCode. CustomsAuthorityID may be optional, is an identifier for a location, may be issued by a customs authority, and may be based on datatype GDT:LocationPartyID. Address may be optional, is an address of a location, and may be based on datatype GDT:Address. PostalRegulationsCompliantStreetDescription may be optional, includes a street and house identifier of a location, may be formatted to comply with postal regulations of a country in which a location is situated, and may be based on datatype GDT:LANGUAGEINDEPENDENT_MEDIUM_Description.
The ExportDeclarationCustomsOffice package includes a CustomsOffice entity. CustomsOffice is a customs office involved in an export. CustomsOffice includes the RoleCategoryCode non-node element, which may be optional, is a role a customs office plays in processing of an export declaration, and may be based on datatype GDT:PartyRoleCategoryCode. The ExportCustomsOffice package may include the node element Identification in a 1:CN cardinality relationship. The ExportCustomsOfficeIdentification package includes the Identification entity. Identification is an identifier of a customs office. Identification includes the following non-node elements: PartyIdentifierTypeCode and PartyID. PartyIdentifierTypeCode may be optional, is a type code of an identifier for a customs office, and may be based on datatype GDT:PartyIdentifierTypeCode. PartyID may be optional, is an identifier for a customs office, and may be based on datatype GDT:NOALPHANUMERICCONVERSION_PartyID.
The ExportDeclarationParty package includes the Party entity. Party is a natural or legal person involved in an export as exporter or product recipient or acting on behalf of an exporter or product recipient. Party includes the following non-node elements: RoleCategoryCode, PostalRegulationsCompliantStreetDescription, and Address. RoleCategoryCode may be optional, is role a party plays in processing of an export declaration, and may be based on datatype GDT:PartyRoleCategoryCode. Address may be optional, is an address of a party, and may be based on datatype GDT:Address. PostalRegulationsCompliantStreetDescription may be optional, is a street and house identifier, may be formatted to comply with postal regulations in a country a party is situated in, and may be based on datatype GDT:LANGUAGEINDEPENDENT_MEDIUM_Description. The ExportParty package may include the Identification node element in a 1:CN cardinality relationship and the ContactParty node element in a 1:C cardinality relationship.
The ExportDeclarationPartyPartyIdentification package includes the Identification entity. Identification is an identifier for a party. Identification includes the following non-node elements: PartyIdentifierTypeCode and PartyID. PartyIdentifierTypeCode may be optional, is a type of an identifier of a party, and may be based on datatype GDT:PartyIdentifierTypeCode. PartyID may be optional, is an identifier for a party, and may be based on datatype GDT:NOALPHANUMERICCONVERSION_PartyID.
The ExportDeclarationPartyPartyContactParty package includes the ContactParty entity. The ContactParty entity is a contact for a party. ContactParty includes the following non-node elements: Address, BusinessPartnerFormattedName, FormattedConventionalPhoneNumberDescription, and FormattedFacsimileNumberDescription. Address may be optional, is an address of a contact party, and may be based on datatype GDT:Address. BusinessPartnerFormattedName may be optional, is a formatted name of a contact party, and may be based on datatype CDT:LANGUAGEINDEPENDENT_EXTENDED_Name. FormattedConventionalPhoneNumberDescription may be optional, is a formatted conventional phone number of a contact party, and may be based on datatype GDT:LANGUAGEINDEPENDENT_SHORT_Description. FormattedFacsimileNumberDescription may be optional, is a formatted facsimile number of a contact party, and may be based on datatype GDT:LANGUAGEINDEPENDENT_SHORT_Description.
The ExportDeclarationTransportRouteCountry package includes the TransportRouteCountry entity. TransportRouteCountry is a country an export starts in, passes through, or ends in. TransportRouteCountry includes the following non-node elements: OrdinalNumberValue and ExportTransportRouteCountryCode. OrdinalNumberValue may be optional, is an ordinal number used order countries of a transport route in an order in which they are passed by an export, and may be based on datatype GDT:OrdinalNumberValue. ExportTransportRouteCountryCode may be optional, is a single country of a transport route, and may be based on datatype GDT:ExportTransportRouteCountryCode. A sequence of all TransportRouteCountries in an ExportDeclaration represents a transport route. An OrdinalNumberValue may be used to order the TransportRouteCountries in sequence. The same country can appear more than once in a ordered list of countries.
The ExportDeclarationItem package includes the Item entity. Item is an item in an export declaration. Item includes the following non-node elements: CustomsAuthorityID, Description, CustomsProcessPartyID, ConsignmentExportID, NetWeightQuantity, Net WeightQuantityTypeCode, Gross WeightQuantity, GrossWeightQuantityTypeCode, CustomsCommodityClassificationCode, ExportProcedureTypeCode, ExportPreviousProcedureTypeCode, ExportAdditionalProcedureTypeCode, OriginExportRegionCode, DangerousGoodsID, ExportTransportCostPaymentFormCode, LegalComplianceQuantity, LegalComplianceQuantityTypeCode, and LegalComplianceAmount. CustomsAuthorityID may be optional, is an identifier for an export declaration item, may follow a schema specified by a customs authority, and may be based on datatype GDT:CustomsDeclarationItemCustomsAuthorityID. Description may be optional, is a description of an export declaration item in natural language, and may be based on datatype GDT:Description. CustomsProcessPartyID may be optional, is an identifier for an export, may be assigned internally, and may be based on datatype GDT:CustomsProcessID. ConsignmentExportID may be optional, is an identifier for a consignment underlying an export, and may be based on datatype GDT:ConsignmentExportID. NetWeightQuantity may be optional, is the net weight quantity of an item, and may be based on datatype CDT:Quantity. NetWeightQuantityTypeCode may be optional, is a type of net weight quantity of an item, and may be based on datatype GDT:QuantityTypeCode. GrossWeightQuantity may be optional, is the gross weight of an item, and may be based on datatype CDT:Quantity. GrossWeightQuantityTypeCode may be optional, is a type of gross weight of an item, and may be based on datatype GDT:QuantityTypeCode. CustomsCommodityClassificationCode may be optional, is a classification of an exported commodity according to specifications by a customs authority, and may be based on datatype GDT: CustomsCommodityClassificationCode. ExportProcedureTypeCode may be optional, is an export procedure to use for an item, and may be based on datatype GDT:ExportProcedureTypeCode. ExportPreviousProcedureTypeCode may be optional, is a customs procedure that was previously applied to an item, and may be based on datatype GDT:ExportPreviousProcedureTypeCode. ExportAdditionalProcedureTypeCode may be optional, is an additional export procedure to use for an item, and may be based on datatype GDT:ExportAdditionalProcedureTypeCode. OriginExportRegionCode may be optional, is a region of origin of an export item, and may be based on datatype GDT:ExportRegionCode.
DangerousGoodsID may be optional, is an identifier for a risk and kind of danger posed by an item, and may be based on datatype GDT:DangerousGoodsID. ExportTransportCostPaymentFormCode may be optional, is a payment form for a transport cost of an export, and may be based on datatype GDT:ExportTransportCostPaymentFormCode. LegalComplianceQuantity may be optional, is a quantity of an item, may be formatted to comply with legal regulations, and may be based on datatype CDT:Quantity. LegalComplianceQuantityTypeCode may be optional, is a type of a quantity of an item, may be formatted to comply with legal regulations, and may be based on datatype GDT:QuantityTypeCode. LegalComplianceAmount may be optional, is an amount of an item, may be formatted to comply with legal regulations, and may be based on datatype CDT:Amount.
ExportDeclarationItem may include the node element BasicText in a 1:CN cardinality relationship, the node element Party in a 1:CN cardinality relationship, the node element Package in a 1:CN cardinality relationship, the node element Container in a 1:CN cardinality relationship, the node element SupportingDocument in a 1:CN cardinality relationship, the node element PreviousDocument in a 1:CN cardinality relationship, the node element CustomsWarehouseDischarge in a 1:C cardinality relationship, and the node element InwardProcessingDischarge in a 1:C cardinality relationship.
The ExportDeclarationItemBasicText package includes the BasicText entity. BasicText includes natural language text that describes an item or provides additional information for an item. BasicText is typed by datatype TextCollectionBasicText.
The ExportDeclarationItemParty package includes the Party entity. Party is a party involved in an export of an item. Party includes the following non-node elements: RoleCategoryCode, Address, and PostalRegulationsCompliantStreetDescription. RoleCategoryCode may be optional, is a role a party plays in an export of an item, and may be based on datatype GDT:PartyRoleCategoryCode. Address may be optional, is an address of a party, and may be based on datatype GDT:Address. PostalRegulationsCompliantStreetDescription may be optional, is a street and house identifier of a party, may be formatted to comply with local postal regulations in a country a party is situated in, and may be based on datatype GDT:LANGUAGEINDEPENDENT_MEDIUM_Description. Party may include an Identification node element in a 1:CN cardinality relationship and a ContactParty node element in a 1:C cardinality relationship.
The ExportDeclarationItemPartyIdentification package includes the Identification entity. Identification is an identifier for a party. Identification includes the following non-node elements: PartyIdentifierTypeCode and PartyID. PartyIdentifierTypeCode may be optional, is a type of a party identifier, and may be based on datatype GDT:PartyIdentifierTypeCode. PartyID may be optional, is an identifier for a party, and may be based on datatype GDT:NOALPHANUMERICCONVERSION_PartyID. The ExportDeclarationItemPartyContactParty package includes the ContactParty entity. ContactParty is a contact party for a party. ContactParty includes the following non-node elements: Address, BusinessPartnerFormattedName, FormattedConventionalPhoneNumberDescription, and FormattedFacsimileNumberDescription. Address may be optional, is an address of a contact party, and may be based on datatype GDT:Address. BusinessPartnerFormattedName may be optional, is a formatted name of a contact party, and may be based on datatype CDT:LANGUAGEINDEPENDENT_EXTENDED_Name. FormattedConventionalPhoneNumberDescription may be optional, is a formatted conventional phone number of a contact party, and may be based on datatype GDT:LANGUAGEINDEPENDENT_SHORT_Description. FormattedFacsimileNumberDescription may be optional, is a formatted facsimile number of a contact party, and may be based on datatype GDT:LANGUAGEINDEPENDENT_SHORT_Description.
The ExportDeclarationItemPackage package includes the Package entity. Package is a package an item is packed in. Package includes the following non-node elements: OrdinalNumberValue, ElementNumberValue, ExportpackageTypeCode, and PackageExportID. OrdinalNumberValue may be optional, is an ordinal number used to order packages, and may be based on datatype GDT:OrdinalNumberValue. ElementNumberValue may be optional, is the number of physical containers in a package, and may be based on datatype GDT:NumberValue. ExportPackageTypeCode may be optional, is a type of a physical container in a package, and may be based on datatype GDT:ExportPackageTypeCode. PackageExportID may be optional, is an identifier for a physical container in a package, and may be based on datatype GDT:PackageExportID.
The ExportDeclarationItemContainer package includes the Container entity. Container is a container an item is packed in. Container includes the ContainerExportID non-node element, which may be optional, is an identifier for a container, and may be based on datatype GDT: ContainerExportID. The ExportDeclarationItemSupportingDocument package includes the SupportingDocument entity. SupportingDocument is a document providing additional information used to export an item. SupportingDocument includes the following non-node elements: ExportSupportingDocumentTypeCode, ExportSupportingDocumentID, ExportSupportingDocumentAddendumID, ExportSupportingDocumentDetailID, IssueDate, ValidityEndDate, LicenceWriteOffAmount, LicenceWriteOffQuantity, and LicenceWriteOffQuantityTypeCode.
ExportSupportingDocumentTypeCode may be optional, is a type of a supporting document, and may be based on datatype GDT:ExportSupportingDocumentTypeCode. ExportSupportingDocumentID may be optional, is an identifier for a supporting document, and may be based on datatype GDT:ExportSupportingDocumentID. ExportSupportingDocumentAddendumID may be optional, is an identifier for an addendum of a supporting document, and may be based on datatype GDT:ExportSupportingDocumentAddendumID. ExportSupportingDocumentDetailID may be optional, is an identifier for a detail of a supporting document, and may be based on datatype GDT:ExportSupportingDocumentDetailID. IssueDate may be optional, is a date a supporting document was issued, and may be based on datatype CDT:Date. ValidityEndDate may be optional, is a date a validity of a supporting document ends, and may be based on datatype CDT:Date. LicenceWriteOffAmount may be optional, is an amount to write off of a licence for an export declaration item, and may be based on datatype CDT:Amount. LicenceWriteOffQuantity may be optional, is a quantity to write off of a licence for an export declaration item, and may be based on datatype CDT: Quantity. LicenceWriteOffQuantityTypeCode may be optional, is a type of a LicenceWriteOffQuantity, and may be based on datatype GDT:QuantityTypeCode.
The ExportDeclarationItemPreviousDocument package includes the PreviousDocument entity. PreviousDocument is a document that proves prior export-relevant processing of an item. PreviousDocument includes the following non-node elements: ExportPreviousDocumentTypeCode, ExportPreviousDocumentID, and ExportPreviousDocumentDescription. ExportPreviousDocumentTypeCode may be optional, is a type of a previous document, and may be based on datatype GDT:ExportPreviousDocumentTypeCode. ExportPreviousDocumentID may be optional, is an identifier for a previous document, and may be based on datatype GDT:ExportPreviousDocumentID. ExportPreviousDocumentDescription may be optional, is a description of a previous document, and may be based on datatype GDT:LANGUAGEINDEPENDENT_MEDIUM_Description.
The ExportDeclarationItemCustomsWarehouseDischarge package includes the CustomsWarehouseDischarge entity. CustomsWarehouseDischarge includes references and information for discharging an item from a customs warehouse. CustomsWarehouseDischarge includes the following non-node elements: ClosingPortionTotalNumberValue and CustomsAuthorisationID. ClosingPortionTotalNumberValue may be optional, is a total number of closing portions in a customs warehouse discharge, and may be based on datatype GDT:NumberValue. CustomsAuthorisationID may be optional, is an identifier for a customs authorization of an exporter for using a customs warehouse, and may be based on datatype GDT: CustomsAuthorisationID.
The ExportDeclarationItemCustomsWarehouseDischarge package may include the node element ClosingPortion in a 1:CN cardinality relationship. ClosingPortion is a closing portion of a customs warehouse discharge. ClosingPortion includes the following non-node elements: OrdinalNumberValue, CustomsProcessCustomsAuthorityID, CustomsDeclarationItemCustomsAuthorityID, CustomsCommodityClassificationCode, UsualFormsOfHandlingAppliedIndicator, ElectronicallyReportedIndicator, Description, OriginalQuantity, OriginalQuantityTypeCode, Quantity, and QuantityTypeCode.
OrdinalNumberValue may be optional, is an ordinal number to order closing portions of a customs warehouse discharge, and may be based on datatype GDT:OrdinalNumberValue. CustomsProcessCustomsAuthorityID may be optional, is an identifier for a customs process with which goods to be discharged are stored in a customs warehouse, and may be based on datatype GDT: CustomsProcessID. CustomsDeclarationItemCustomsAuthorityID may be optional, is an identifier of an item in a previous customs declaration with which goods to be discharged are stored in a customs warehouse, and may be based on datatype GDT: CustomsDeclarationItemCustomsAuthorityID. CustomsCommodityClassificationCode may be optional, is a classification of goods to be discharged, and may be based on datatype GDT: CustomsCommodityClassificationCode. UsualFormsOfHandlingAppliedIndicator may be optional, indicates whether usual forms of handling have been applied to goods to be discharged, and may be based on datatype CDT:Indicator. ElectronicallyReportedIndicator may be optional, indicates whether a customs declaration with which goods to be discharged are stored in a customs warehouse, may be given electronically, and may be based on datatype CDT:Indicator. Description may be optional, is a natural language description of a closing portion, and may be based on datatype GDT:Description. OriginalQuantity may be optional, is an item portion to close with a closing portion, may be given with a unit of measure with which goods were originally reported, and may be based on datatype CDT:Quantity. OriginalQuantityTypeCode may be optional, is a type of an item portion to close with a closing portion, may be given with a unit of measure with which goods were originally reported, and may be based on datatype GDT:QuantityTypeCode. Quantity may be optional, is an item portion to close with a closing portion, may be given with a unit of measure with which goods are measured at a time of discharge, and may be based on datatype CDT:Quantity. QuantityTypeCode may be optional, is a type of an item portion to close with a closing portion, may be given with a unit of measure with which goods are measured at a time of discharge, and may be based on datatype GDT: QuantityTypeCode.
The ExportDeclarationItemInwardProcessingDischarge package includes the InwardProcessingDischarge entity. InwardProcessingDischarge includes references and information for discharging an item from inward processing. InwardProcessingDischarge includes the following non-node elements: ClosingPortionTotalNumberValue and CustomsAuthorisationID. ClosingPortionTotalNumberValue may be optional, is a total number of closing portions of an inward processing discharge, and may be based on datatype GDT:NumberValue. CustomsAuthorisationID may be optional, is an identifier of a customs authorisation of an exporter for inward processing, and may be based on datatype GDT: CustomsAuthorisationID.
ExportDeclarationItemInwardProcessingDischarge may include the ClosingPortion node element in a 1:CN cardinality relationship. The ExportDeclarationItemInwardProcessingDischargellemInwardProcessingClosingPortion package includes the ClosingPortion entity. ClosingPortion is a closing portion of an inward processing discharge. ClosingPortion includes the following non-node elements: OrdinalNumberValue, CustomsProcessCustomsAuthorityID, CustomsDeclarationItemCustomsAuthorityID, ElectronicallyReportedIndicator, and Description. OrdinalNumberValue may be optional, is an ordinal number used to order closing portions, and may be based on datatype GDT: OrdinalNumberValue. CustomsProcessCustomsAuthorityID may be optional, is an identifier of a customs process that stated that goods are subject to inward processing, and may be based on datatype GDT: CustomsProcessID. CustomsDeclarationItemCustomsAuthorityID may be optional, is an identifier of an item in a customs declaration that stated that goods are subject to inward processing, and may be based on datatype GDT: CustomsDeclarationItemCustomsAuthorityID. ElectronicallyReportedIndicator may be optional, indicates whether a statement that goods are subject to inward processing was given electronically, and may be based on datatype CDT:Indicator. Description may be optional, is a description of a closing portion, and may be based on datatype GDT:Description.
FIG. 36 depicts an example Export Message Exchange Notification Message Data Type 36000, which comprises elements 36002-36008, hierarchically related as shown. For example, the Export Message Exchange Notification 36002 includes a Message Header 36004.
The message type Export Message Exchange Notification is derived from a business object Export Message_Virtual Object as a leading object together with its operation signature. The message type Export Message Exchange Notification is a notification about an export message exchange. The structure of the message type Export Message Exchange Notification is determined by a message data type ExportMessageExchangeNotificationMessage. The message data type ExportMessageExchangeNotificationMessage includes an object ExportMessage which is included in a business document, business information that is relevant for sending a business document in a message, the MessageHeader package, and the ExportMessage package. The message data type ExportMessageExchangeNotificationMessage provides a structure for the Export Message Exchange Notification message type and for associated operations.
The MessageHeader package is a grouping of business information that is relevant for sending a business document in a message. The MessageHeader package includes the MessageHeader node. The MessageHeader node is a grouping of business information from the perspective of a sending application, such as information to identify the business document in a message, information about the sender, and optionally information about the recipient. The MessageHeader includes SenderParty and RecipientParty.
MessageHeader may be based on the datatype GDT:BusinessDocumentMessageHeader and the following elements of the GDT are used: RecipientParty, BusinessScope, SenderParty, SenderBusinessSystemID, TestDataIndicator, RecipientBusinessSystemID, ReferenceID, ReferenceUUID, ReconciliationIndicator, ID, UUID, and CreationDateTime. SenderParty is the partner responsible for sending a business document at a business application level. The SenderParty is of the type GDT:BusinessDocumentMessageHeaderParty. RecipientParty is of the type GDT:BusinessDocumentMessageHeaderParty. RecipientParty is the partner responsible for receiving a business document at a business application level.
The ExportMessage package is a grouping of ExportMessage with its Document package and with the ExportMessage entity. ExportMessage is a business document including information on an exchange status of an export message. ExportMessage includes the following non-node elements: CustomsMessageExchangeServerFileReferenceID, ExportMessageID, ExportMessageReferenceID, CommunicationDateTime, and ExportMessageCommunicationStatusCode.
CustomsMessageExchangeServerFileReferenceID may be optional, is an identifier of a file on a message exchange server that includes an export message whose exchange status is given in a message, and may be based on datatype GDT:CustomsMessageExchangeServerFileID. ExportMessageID may be optional, is an identifier of a message, and may be based on datatype GDT:CustomsProcessMessageID. ExportMessageReferenceID includes one or more identifiers of messages referenced by a message, and may be based on datatype GDT:CustomsProcessMessageID. CommunicationDateTime may be optional, is a date and time a message was communicated to or from a customs authority, and may be based on datatype CDT:GLOBAL_DateTime. ExportMessageCommunicationStatusCode may be optional, is an exchange status of an export message, and may be based on datatype GDT:ExportMessageCommunicationStatusCode.
The ExportMessage package includes the Document node elements in a 1:CN cardinality relationship. The ExportMessageDocument package includes the Document entity. Document is a document attached to a message. Document includes the following non-node elements: DocumentTypeCode and FileContentBinaryObject. DocumentTypeCode may be optional, is a type of a document, and may be based on datatype GDT:DocumentTypeCode. FileContentBinaryObject may be optional, includes binary content of a document, and may be based on datatype CDT:BinaryObject.
FIG. 37 depicts an example Export Message Semantic Error Notification Message Data Type 37000, which comprises elements 37002-37010, hierarchically related as shown. For example, the Export Message Semantic Error Notification 37002 includes a Message Header 37004.
The message type Export Message Semantic Error Notification is derived from a business object Export Message_Virtual Object as a leading object together with its operation signature. The message type Export Message Semantic Error Notification is a notification about a semantic error in an export message. The structure of the message type Export Message Semantic Error Notification is determined by a messagedata type ExportMessageSemanticErrorNotificationMessage. The messagedata type ExportMessageSemanticErrorNotificationMessage includes an object ExportMessage which is included in a business document, business information that is relevant for sending a business document in a message, the MessageHeader package, and the ExportMessage package. The message data type ExportMessageSemanticErrorNotificationMessage provides a structure for the Export Message Semantic Error Notification message type and for associated operations.
The MessageHeader package is a grouping of business information that is relevant for sending a business document in a message. The MessageHeader package includes the MessageHeader node. The MessageHeader node is a grouping of business information from the perspective of a sending application, such as information to identify the business document in a message, information about the sender, and optionally information about the recipient. The MessageHeader includes SenderParty and RecipientParty.
MessageHeader may be based on the datatype GDT:BusinessDocumentMessageHeader and the following elements of the GDT are used: RecipientParty, BusinessScope, SenderParty, SenderBusinessSystemID, TestDataIndicator, RecipientBusinessSystemID, ReferenceID, ReferenceUUID, ReconciliationIndicator, ID, UUID, and CreationDateTime. SenderParty is the partner responsible for sending a business document at a business application level. The SenderParty is of the type GDT:BusinessDocumentMessageHeaderParty. RecipientParty is of the type GDT:BusinessDocumentMessageHeaderParty. RecipientParty is the partner responsible for receiving a business document at a business application level.
The ExportMessage package is a grouping of ExportMessage with its Log and Document packages and with the ExportMessage entity. ExportMessage is a business document including information on processing of a message related to an export of goods or services. ExportMessage includes the following non-node elements: ExportMessageSubTypeCode, ExportMessageID, ExportMessageReferenceID MajorVersionCustomsAuthorityID, MinorVersionCustomsAuthorityID, MainTestCaseID, SubTestCaseID, CustomsProcessID, CustomsProcessPartyID, CustomsProcessCustomsAuthorityID, and CommunicationDateTime.
ExportMessageSubTypeCode may be optional, is an internal type of a message, and may be based on datatype GDT:ExportMessageSubTypeCode. ExportMessageID may be optional, is an identifier of a message, and may be based on datatype GDT:CustomsProcessMessageID. ExportMessageReferenceID includes one or more identifiers of messages referenced by a message and may be based on datatype GDT:CustomsProcessMessageID. MajorVersionCustomsAuthorityID may be optional, is a major version of a message, may be issued by a customs authority, and may be based on datatype GDT:VersionPartyID. MinorVersionCustomsAuthorityID may be optional, is a minor version of a message, may be issued by a customs authority, and may be based on datatype GDT:VersionPartyID. MainTestCaseID may be optional and may be an identifier for a main test case. If a message is sent as part of a test case, MainTestCaseID provides an identifier of a superordinate test case. Test cases and their identifiers may be issued by a customs authority. MainTestCaseID may be based on datatype GDT:TestCaseID. SubTestCaseID may be optional and is an identifier for a sub test case. If a message is sent as part of a test case, SubTestCaseID provides an identifier of a subordinate test case. Test cases and their identifiers may be issued by a customs authority. SubTestCaseID may be based on datatype GDT:TestCaseID. CustomsProcessID may be optional, is an identifier for an export, may be assigned internally, and may be based on datatype GDT:CustomsProcessID. CustomsProcessPartyID may be optional, is an identifier for an export, may be assigned by a third party, and may be based on datatype GDT:CustomsProcessID. CustomsProcessCustomsAuthorityID may be optional, is an identifier for an export, may be assigned by a customs authority, and may be based on datatype GDT:CustomsProcessID. CommunicationDateTime may be optional, is a date and time a message was communicated by a customs authority, and may be based on datatype CDT:GLOBAL_DateTime.
The ExportMessage package includes a LogItem node element in a 1:CN cardinality relationship and a Document node element in a 1:CN cardinality relationship. ExportMessageLog package includes the LogItem entity. LogItem is a log entry on an error that occurred during the processing of a message. LogItem is typed by datatype LogItem. The ExportMessageDocument package includes the Document entity. Document is a document attached to a message. Document includes the following non-node elements: DocumentTypeCode and FileContentBinaryObject. DocumentTypeCode may be optional, is a type of a document, and may be based on datatype GDT:DocumentTypeCode. FileContentBinaryObject may be optional, includes binary content of a document, and may be based on datatype CDT:BinaryObject.
FIG. 38 depicts an example Export Message Syntax Error Notification Message Data Type 38000, which comprises elements 38002-38010, hierarchically related as shown. For example, the Export Message Syntax Error Notification 38002 includes a Message Header 38004.
The message type Export Message Syntax Error Notification is derived from a business object Export Message_Virtual Object as a leading object together with its operation signature. The message type Export Message Syntax Error Notification is a notification about a syntax error in an export message. The structure of the message type Export Message Syntax Error Notification is determined by a messagedata type ExportMessageSyntaxErrorNotificationMessage. The messagedata type ExportMessageSyntaxErrorNotificationMessage includes an object ExportMessage which is included in a business document, business information that is relevant for sending a business document in a message, the MessageHeader package, and the ExportMessage package. The message data type ExportMessageSyntaxErrorNotificationMessage provides a structure for the message type Export Message Syntax Error Notification and for associated operations.
The MessageHeader package is a grouping of business information that is relevant for sending a business document in a message. The MessageHeader package includes the MessageHeader node. The MessageHeader node is a grouping of business information from the perspective of a sending application, such as information to identify the business document in a message, information about the sender, and optionally information about the recipient. The MessageHeader includes SenderParty and RecipientParty.
MessageHeader may be based on the datatype GDT:BusinessDocumentMessageHeader and the following elements of the GDT are used: RecipientParty, BusinessScope, SenderParty, SenderBusinessSystemID, TestDataIndicator, RecipientBusinessSystemID, ReferenceID, ReferenceUUID, ReconciliationIndicator, ID, UUID, and CreationDateTime. SenderParty is the partner responsible for sending a business document at a business application level. The SenderParty is of the type GDT:BusinessDocumentMessageHeaderParty. RecipientParty is of the type GDT:BusinessDocumentMessageHeaderParty. RecipientParty is the partner responsible for receiving a business document at a business application level.
The ExportMessage package is a grouping of ExportMessage with its Log and Document packages and with the ExportMessage entity. ExportMessage is a business document including information on processing of a message related to an export of goods or services. ExportMessage includes the following non-node elements: ExportMessageSubTypeCode, ExportMessageID, ExportMessageReferenceID, MajorVersionCustomsAuthorityID, MinorVersionCustomsAuthorityID, MainTestCaseID, SubTestCaseID, CommunicationDateTime, and CustomsMessageExchangeServerFileReferenceID.
ExportMessageSubTypeCode may be optional, is an internal type of a message, and may be based on datatype GDT:ExportMessageSubTypeCode. ExportMessageID may be optional, is an identifier of a message, and may be based on datatype GDT:CustomsProcessMessageID. ExportMessageReferenceID includes one or more identifiers of messages referenced by a message, and may be based on datatype GDT:CustomsProcessMessageID. MajorVersionCustomsAuthorityID may be optional, is a major version of a message, may be issued by a customs authority, and may be based on datatype GDT:VersionPartyID. MinorVersionCustomsAuthorityID may be optional, is a minor version of a message, may be issued by a customs authority, and may be based on datatype GDT:VersionPartyID. MainTestCaseID may be optional and is an identifier for a main test case. If a message is sent as part of a test case, MainTestCaseID provides an identifier of a superordinate test case. Test cases and their identifiers may be issued by a customs authority. MainTestCaseID may be based on datatype GDT:TestCaseID. SubTestCaseID may be optional and is an identifier for a sub test case. If a message is sent as part of a test case, SubTestCaseID provides an identifier of a subordinate test case. Test cases and their identifiers may be issued by a customs authority. SubTestCaseID may be based on datatype GDT:TestCaseID. CommunicationDateTime may be optional, is a date and time a message was communicated by a customs authority, and may be based on datatype CDT:GLOBAL_DateTime. CustomsMessageExchangeServerFileReferenceID may be optional, is an identifier of a file on a message exchange server in that an error occurred, and may be based on datatype GDT: CustomsMessageExchangeServerFileID.
ExportMessage may include a LogItem node element in a 1:CN cardinality relationship and a Document node element in a 1:CN cardinality relationship. The ExportMessageLog package includes the LogItem entity. LogItem is a log entry on an error that occurred during message processing. LogItem is typed by LogItem. The ExportMessageDocument package includes the Document entity. Document is a document attached to a message. Document includes the following non-node elements: DocumentTypeCode and FileContentBinaryObject. DocumentTypeCode may be optional, is a type of a document, and may be based on datatype GDT:DocumentTypeCode. FileContentBinaryObject may be optional, includes binary content of a document, and may be based on datatype CDT:BinaryObject.
FIG. 39 depicts an example Export Processing Information Confirmation Message Data Type 39000, which comprises elements 39002-39018, hierarchically related as shown. For example, the Export Processing Information Confirmation 39002 includes a Message Header 39004.
The message type Export Processing Information Confirmation is derived from a business object Export_Virtual Object as a leading object together with its operation signature. The message type Export Processing Information Confirmation is a confirmation to a request for export processing information. The structure of the message type Export Processing Information Confirmation is determined by a message data type ExportProcessingInformationConfirmationMessage. The message data type ExportProcessingInformationConfirmationMessage includes an object Export which is included in a business document, business information that is relevant for sending a business document in a message, the MessageHeader package, and the Export package. The message data type ExportProcessingInformationConfirmationMessage provides a structure for the message type Export Processing Information Confirmation and for associated operations.
The MessageHeader package is a grouping of business information that is relevant for sending a business document in a message. The MessageHeader package includes the MessageHeader node. The MessageHeader node is a grouping of business information from the perspective of a sending application, such as information to identify the business document in a message, information about the sender, and optionally information about the recipient. The MessageHeader includes SenderParty and RecipientParty. MessageHeader may be based on the datatype GDT:BusinessDocumentMessageHeader and the following elements of the GDT are used: RecipientParty, BusinessScope, SenderParty, SenderBusinessSystemID, TestDataIndicator, RecipientBusinessSystemID, ReferenceID, ReferenceUUID, ReconciliationIndicator, ID, UUID, and CreationDateTime. SenderParty is the partner responsible for sending a business document at a business application level. The SenderParty is of the type GDT:BusinessDocumentMessageHeaderParty. RecipientParty is of the type GDT:BusinessDocumentMessageHeaderParty. RecipientParty is the partner responsible for receiving a business document at a business application level.
The Export package is a grouping of Export with its BasicText, CustomsOffice, and Party packages and with the Export entity. Export is a business transaction document including data on an export. Export includes the following non-node elements: ExportMessageSubTypeCode, ExportMessageID, ExportMessageReferenceID, CustomsAuthorityCountryCode, MajorVersionCustomsAuthorityID, MinorVersionCustomsAuthorityID, MainTestCaseID, SubTestCaseID, CustomsMessageExchangeServerFileID, CustomsProcessCustomsAuthorityID, ExportExitStatusCode, and CustomsAuthenticationID.
ExportMessageSubTypeCode may be optional, is an internal type of a message, and may be based on datatype GDT:ExportMessageSubTypeCode. ExportMessageID may be optional, is an identifier of a message, and may be based on datatype GDT:CustomsProcessMessageID. ExportMessageReferenceID includes one or more identifiers of messages referenced by a message and may be based on datatype GDT:CustomsProcessMessageID. CustomsAuthorityCountryCode may be optional, is a country in which a customs authority to which a processing request is sent is situated, and may be based on datatype GDT:CountryCode. MajorVersionCustomsAuthorityID may be optional, is a major version of a message, may be issued by a customs authority, and may be based on datatype GDT:VersionPartyID. MinorVersionCustomsAuthorityID may be optional, is a minor version of a message, may be issued by a customs authority, and may be based on datatype GDT:VersionPartyID. MainTestCaseID may be optional and is an identifier for a main test case. If a message is sent as part of a test case, MainTestCaseID provides an identifier of a superordinate test case. Test cases and their identifiers may be issued by a customs authority. MainTestCaseID may be based on datatype GDT:TestCaseID. SubTestCaseID may be optional and is an identifier for a sub test case. If a message is sent as part of a test case, SubTestCaseID provides an identifier of a subordinate test case. Test cases and their identifiers may be issued by a customs authority. SubTestCaseID may be based on datatype GDT:TestCaseID. CustomsMessageExchangeServerFileID may be optional, is an identifier for a file a message is stored in on a message exchange server that communicates with a customs authority, and may be based on datatype GDT: CustomsMessageExchangeServerFileID. CustomsProcessCustomsAuthorityID may be optional, is an identifier for an export, assigned by a customs authority, and may be based on datatype GDT:CustomsProcessID. ExportExitStatusCode may be optional, is an exit status of an export, and may be based on datatype GDT:ExportExitStatusCode. CustomsAuthenticationID may be optional, is an authentication identifier for communicating with a customs authority, and may be based on datatype GDT: CustomsAuthenticationID.
Export may include a BasicText node element in a 1:CN cardinality relationship, a CustomsOffice node element in a 1:CN cardinality relationship, and a Party node element in a 1:CN cardinality relationship. The ExportBasicText package includes the BasicText entity. BasicText is natural language text that describes an export declaration or specifies an export. BasicText is typed by TextCollectionBasicText. The ExportCustomsOffice package includes the CustomsOffice entity. CustomsOffice is a customs office involved in an export. CustomsOffice includes a RoleCategoryCode node element, which may be optional, is a role a customs office plays in the processing of an export declaration, and may be based on datatype GDT:PartyRoleCategoryCode. ExportCustomsOffice may include an Identification node element in a 1:CN cardinality relationship. The ExportCustomsOfficeIdentification package includes the Identification entity. Identification is an identifier of a customs office. Identification includes the following non-node elements: PartyIdentifierTypeCode and PartyID. PartyIdentifierTypeCode may be optional, is a type code of an identifier for a customs office, and may be based on datatype GDT:PartyIdentifierTypeCode. PartyID may be optional, is an identifier for a customs office, and may be based on datatype GDT:NOALPHANUMERICCONVERSION_PartyID.
The ExportParty package includes the Party entity. Party is a natural or legal person involved in an export as exporter or product recipient or on behalf of an exporter or product recipient. Party includes the following non-node elements: RoleCategoryCode, Address, and PostalRegulationsCompliantStreetDescription. RoleCategoryCode may be optional, is a role a party plays in processing of an export declaration, and may be based on datatype GDT:PartyRoleCategoryCode. Address may be optional, is an address of a party, and may be based on datatype GDT:Address. PostalRegulationsCompliantStreetDescription may be optional, includes a street and house identifier, may be formatted to comply with postal regulations in a country a party is situated in, and may be based on datatype GDT:LANGUAGEINDEPENDENT_MEDIUM_Description. Party may include an Identification node element in a 1:CN cardinality relationship and a ContactParty node element in a 1:C cardinality relationship.
The ExportPartyPartyIdentification package includes the Identification entity. Identification is an identifier for a party. Identification includes the following non-node elements: PartyIdentifierTypeCode and PartyID. PartyIdentifierTypeCode may be optional, is a type of an identifier of a party, and may be based on datatype GDT:PartyIdentifierTypeCode. PartyID may be optional, is an identifier for a party, and may be based on datatype GDT:NOALPHANUMERICCONVERSION_PartyID. The ExportPartyPartyContactParty package includes the ContactParty entity. ContactParty is a contact for a party. ContactParty includes the following non-node elements: Address, BusinessPartnerFormattedName, FormattedConventionalPhoneNumberDescription, and FormattedFacsimileNumberDescription. Address may be optional, is an address of a contact party, and may be based on datatype GDT:Address. BusinessPartnerFormattedName may be optional, is a formatted name of a contact party, and may be based on datatype CDT:LANGUAGEINDEPENDENT_EXTENDED Name. FormattedConventionalPhoneNumberDescription may be optional, is a formatted conventional phone number of a contact party, and may be based on datatype GDT:LANGUAGEINDEPENDENT_SHORT_Description. FormattedFacsimileNumberDescription may be optional, is a formatted facsimile number of a contact party, and may be based on datatype GDT:LANGUAGEINDEPENDENT_SHORT_Description.
FIG. 40 depicts an example Export Processing Information Request Message Data Type 40000, which comprises elements 40002-40018, hierarchically related as shown. For example, the Export Processing Information Request 40002 includes a Message Header 40004.
The message type Export Processing Information Request is derived from the business object Export_Virtual Object as a leading object together with its operation signature. The message type Export Processing Information Request is a request for export processing information. The structure of the message type Export Processing Information Request is determined by the message data type ExportProcessingInformationRequestMessage. The message data type ExportProcessingInformationRequestMessage includes an object Export which is included in a business document, business information that is relevant for sending a business document in a message, the MessageHeader package, and an Export package. The ExportProcessingInformationRequestMessage message data type provides a structure for an Export Processing Information Request message type and for associated operations.
The MessageHeader package is a grouping of business information that is relevant for sending a business document in a message. The MessageHeader package includes the MessageHeader node. The MessageHeader node is a grouping of business information from the perspective of a sending application, such as information to identify the business document in a message, information about the sender, and optionally information about the recipient. The MessageHeader includes SenderParty and RecipientParty. MessageHeader may be based on the datatype GDT:BusinessDocumentMessageHeader and the following elements of the GDT are used: RecipientParty, BusinessScope, SenderParty, SenderBusinessSystemID, TestDataIndicator, RecipientBusinessSystemID, ReferenceID, ReferenceUUID, ReconciliationIndicator, ID, UUID, and CreationDateTime. SenderParty is the partner responsible for sending a business document at a business application level. The SenderParty is of the type GDT:BusinessDocumentMessageHeaderParty. RecipientParty is of the type GDT:BusinessDocumentMessageHeaderParty. RecipientParty is the partner responsible for receiving a business document at a business application level.
The Export package is a grouping of Export with its CustomsOffice, Party, and Document packages and with an Export entity. Export is a business transaction document including data on an export. Export includes the following non-node elements: ExportMessageSubTypeCode, ExporMessageID, ExportMessageReferenceID, MajorVersionCustomsAuthorityID, MinorVersionCustomsAuthorityID, MainTestCaseID, SubTestCaseID, CustomsProcessID, CustomsProcessCustomsAuthorityID, ExportPartyRepresentationCode, CommunicationDateTime, RequestDate, and ResponseDeadlineDate.
ExportMessageSubTypeCode may be optional, is an internal type of a message, and may be based on datatype GDT:ExportMessageSubTypeCode. ExporMessageiD may be optional, is an identifier of a message, and may be based on datatype GDT:CustomsProcessMessageID. ExportMessageReferenceID includes one or more identifiers of messages referenced by a message and may be based on datatype GDT:CustomsProcessMessageID. MajorVersionCustomsAuthorityID may be optional, is a major version of a message, may be issued by a customs authority, and may be based on datatype GDT:VersionPartyID. MinorVersionCustomsAuthorityID may be optional, is a minor version of a message, may be issued by a customs authority, and may be based on datatype GDT:VersionPartyID. MainTestCaseID may be optional and is an identifier for a main test case. In some implementations, if this message is sent as part of a test case, MainTestCaseID provides an identifier of a superordinate test case. Test cases and their identifiers may be issued by a customs authority. MainTestCaseID may be based on datatype GDT:TestCaseID. SubTestCaseID may be optional and is an identifier for a sub test case. In some implementations, if a message is sent as part of a test case, SubTestCaseID provides an identifier of a subordinate test case. Test cases and their identifiers may be issued by a customs authority. SubTestCaseID may be based on datatype GDT:TestCaseID. CustomsProcessID may be optional, is an identifier for an export, may be assigned internally, and may be based on datatype GDT:CustomsProcessID. CustomsProcessCustomsAuthorityID may be optional, is an identifier for an export, may be assigned by a customs authority, and may be based on datatype GDT:CustomsProcessID. ExportPartyRepresentationCode may be optional, is a representation of parties involved in an export, and may be based on datatype GDT:ExportPartyRepresentationCode. CommunicationDateTime may be optional, is a date and time at which a message was communicated from a customs authority, and may be based on datatype CDT:GLOBAL_DateTime. RequestDate may be optional, is a date information on processing of an export was requested by a customs authority, and may be based on datatype CDT:Date. ResponseDeadlineDate may be optional, is a date until which a customs authority expects an answer on its information request, and may be based on datatype CDT:Date. Export may include a CustomsOffice node element in a 1:CN cardinality relationship, a Party node element in a 1:CN cardinality relationship, and a Document node element in a 1:CN cardinality relationship.
The ExportCustomsOffice package includes the CustomsOffice entity. CustomsOffice is a customs office involved in an export. CustomsOffice includes the RoleCategoryCode non-node element, which may be optional, is a role a customs office plays in processing of an export declaration, and may be based on datatype GDT:PartyRoleCategoryCode. The ExportCustomsOffice package may include an Identification node element in a 1:CN cardinality relationship.
The ExportCustomsOfficeIdentification package includes the Identification entity. Identification is an identifier of a customs office. Identification includes the following non-node elements: PartyIdentifierTypeCode and PartyID. PartyIdentifierTypeCode may be optional, is a type code of an identifier for a customs office, and may be based on datatype GDT:PartyIdentifierTypeCode. PartyID may be optional, is an identifier for a customs office, and may be based on datatype GDT:NOALPHANUMERICCONVERSION_PartyID.
The ExportParty package includes the Party entity. Party is a natural or legal person involved in an export as exporter or product recipient or on behalf of an exporter or product recipient. Party includes the following non-node elements: RoleCategoryCode, Address, and PostalRegulationsCompliantStreetDescription. RoleCategoryCode may be optional, is a role a party plays in processing of an export declaration, and may be based on datatype GDT:PartyRoleCategoryCode. Address may be optional, is an address of a party, and may be based on datatype GDT:Address. PostalRegulationsCompliantStreetDescription may be optional, includes a street and house identifier, may be formatted to comply with postal regulations in a country a party is situated in, and may be based on datatype GDT:LANGUAGEINDEPENDENT_MEDIUM_Description. ExportPartyParty may include an Identification node element in a 1:CN cardinality relationship and a ContactParty node element in a 1:C cardinality relationship.
The ExportPartyPartyIdentification package includes the Identification entity. Identification is an identifier for a party. Identification includes the following non-node elements: PartyIdentifierTypeCode and PartyID. PartyIdentifierTypeCode may be optional, is a type of an identifier of a party, and may be based on datatype GDT:PartyIdentifierTypeCode. PartyID may be optional, is an identifier for a party, and may be based on datatype GDT:NOALPHANUMERICCONVERSION_PartyID.
The ExportPartyPartyContactParty package includes the ContactParty entity. ContactParty is a contact for a party. ContactParty includes the following non-node elements: Address, BusinessPartnerFormattedName, FormattedConventionalPhoneNumberDescription, and FormattedFacsimileNumberDescription. Address may be optional, is an address of a contact party, and may be based on datatype GDT:Address. BusinessPartnerFormattedName may be optional, is a formatted name of a contact party, and may be based on datatype CDT:LANGUAGEINDEPENDENT_EXTENDED_Name. FormattedConventionalPhoneNumberDescription may be optional, is a formatted conventional phone number of a contact party, and may be based on datatype GDT:LANGUAGEINDEPENDENT_SHORT_Description. FormattedFacsimileNumberDescription may be optional, is a formatted facsimile number of a contact party, and may be based on datatype GDT:LANGUAGEINDEPENDENT_SHORT_Description.
The ExportDocument package includes the Document entity. Document is a document that is attached to a message. Document includes the following non-node elements: DocumentTypeCode and FileContentBinaryObject. DocumentTypeCode may be optional, is a type of a document, and may be based on datatype GDT:DocumentTypeCode. FileContentBinaryObject may be optional, includes binary content of a document, and may be based on datatype CDT:BinaryObject.
FIGS. 41-1 through 41-2 depict an example Export Processing Notification Message Data Type 41000, which comprises elements 41002-41030, hierarchically related as shown. For example, the Export Processing Notification 41002 includes a Message Header 41004.
The message type Export Processing Notification is derived from the business object Export_Virtual Object as a leading object together with its operation signature. The message type Export Processing Notification is a notification about export processing. The structure of the message type Export Processing Notification is determined by a message data type ExportProcessingNotificationMessage. The messagedata type ExportProcessingNotificationMessage includes the object Export which is included in a business document, business information that is relevant for sending a business document in a message, the MessageHeader package, and the Export package. The message data type ExportProcessingNotificationMessage provides a structure for the message type Export Processing Notification and for associated operations.
The MessageHeader package is a grouping of business information that is relevant for sending a business document in a message. The MessageHeader package includes the MessageHeader node. The MessageHeader node is a grouping of business information from the perspective of a sending application, such as information to identify the business document in a message, information about the sender, and optionally information about the recipient. The MessageHeader includes SenderParty and RecipientParty. MessageHeader may be based on the datatype GDT:BusinessDocumentMessageHeader and the following elements of the GDT are used: RecipientParty, BusinessScope, SenderParty, SenderBusinessSystemID, TestDataIndicator, RecipientBusinessSystemID, ReferenceID, ReferenceUUID, ReconciliationIndicator, ID, UUID, and CreationDateTime. SenderParty is the partner responsible for sending a business document at a business application level. The SenderParty is of the type GDT:BusinessDocumentMessageHeaderParty. RecipientParty is of the type GDT:BusinessDocumentMessageHeaderParty. RecipientParty is the partner responsible for receiving a business document at a business application level.
The Export package is a grouping of Export with its TimePoint, CustomsOffice, Party, Document, and Item packages and with the Export entity. The Export entity is a business transaction document including data about an export. Export includes the following non-node elements: ExportMessageSubTypeCode, ExportMessageID, ExportMessageReferenceID, MajorVersionCustomsAuthorityID, MinorVersionCustomsAuthorityID, MainTestCaseID, SubTestCaseID, CustomsProcessID, CustomsProcessPartyID, CustomsProcessCustomsAuthorityID, ExportDeclarationTypeCode, ExportTypeCode, ExportExportingCountryCode, ExportDestinationCountryCode, ExportPartyRepresentationCode, ItemTotalNumberValue, TotalGrossWeightQuantity, TotalGrossWeightQuantityTypeCode, ConsignmentExportID, ExportBusinessTransactionTypeCode, InvoiceTotalNetAmount, ExportIncotermsClassificationCode, ExportIncotermsClassificationDescription, IncotermsTransferLocationName, CommunicationDateTime, ShortfallIndicator, and ExportExitConfirmationMethodCode.
ExportMessageSubTypeCode may be optional, is an internal type of a message, and may be based on datatype GDT:ExportMessageSubTypeCode. ExportMessageID may be optional, is an identifier of a message, and may be based on datatype GDT:CustomsProcessMessageID. ExportMessageReferenceID is one or more identifiers of messages referenced by a message and may be based on datatype GDT:CustomsProcessMessageID. MajorVersionCustomsAuthorityID may be optional, is a major version of a message, may be issued by a customs authority, and may be based on datatype GDT:VersionPartyID. MinorVersionCustomsAuthorityID may be optional, is a minor version of a message, may be issued by a customs authority, and may be based on datatype GDT:VersionPartyID. MainTestCaseID may be optional and is an identifier for a main test case. If a message is sent as part of a test case, MainTestCaseID provides an identifier of a superordinate test case. Test cases and their identifiers may be issued by a customs authority. MainTestCaseID may be based on datatype GDT:TestCaseID. SubTestCaseID may be optional and is an identifier for a sub test case. If a message is sent as part of a test case, SubTestCaseID provides an identifier of a subordinate test case. Test cases and their identifiers may be issued by a customs authority. SubTestCaseID may be based on datatype GDT:TestCaseID. CustomsProcessID may be optional, is an identifier for an export, may be assigned internally, and may be based on datatype GDT:CustomsProcessID. CustomsProcessPartyID may be optional, is an identifier for an export, may be assigned by a third party, and may be based on datatype GDT: CustomsProcessID. CustomsProcessCustomsAuthorityID may be optional, is an identifier for an export, may be assigned by a customs authority, and may be based on datatype GDT:CustomsProcessID. ExportDeclarationTypeCode may be optional, is a type of an export declaration, and may be based on datatype GDT:ExportDeclarationTypeCode. ExportTypeCode may be optional, is a type of an export, and may be based on datatype GDT:ExportTypeCode. ExportExportingCountryCode may be optional, is a country from which goods are exported, and may be based on datatype GDT:ExportExportingCountryCode. ExportDestinationCountryCode may be optional, is a country to which goods are exported, and may be based on datatype GDT:ExportDestinationCountryCode. ExportPartyRepresentationCode may be optional, is a representation of parties involved in an export, and may be based on datatype GDT:ExportPartyRepresentationCode. ItemTotalNumberValue may be optional, is a total number of items in an export declaration, and may be based on datatype GDT:NumberValue. TotalGrossWeightQuantity may be optional, is a total gross weight of export declaration items, and may be based on datatype CDT:Quantity. TotalGrossWeightQuantityTypeCode may be optional, is a type of total gross weight of export declaration items, and may be based on datatype GDT:QuantityTypeCode. ConsignmentExportID may be optional, is an identifier for a consignment underlying an export, and may be based on datatype GDT:ConsignmentExportID. PackageTotalNumberValue may be optional, is the total number of packages in an export, and may be based on datatype GDT:NumberValue. ExportBusinessTransactionTypeCode may be optional, is a type of a business transaction underlying an export, and may be based on datatype GDT:ExportBusinessTransactionTypeCode. InvoiceTotalNetAmount may be optional, is the total net amount of an invoice underlying an export, and may be based on datatype CDT:Amount. ExportIncotermsClassificationCode may be optional, is a classification of an incoterms underlying an export, and may be based on datatype GDT:ExportIncotermsClassificationCode. ExportIncotermsClassificationDescription may be optional, is a description of an incoterms underlying an export, and may be based on datatype GDT:LANGUAGEINDEPENDENT_MEDIUM_Description. IncotermsTransferLocationName may be optional, is a name of a transfer location of an incoterms underlying an export, and may be based on datatype CDT:MEDIUM_Name. CommunicationDateTime may be optional, is a date and time a message was communicated by a customs authority, and may be based on datatype CDT:GLOBAL_DateTime. ShortfallIndicator may be optional, indicates whether a total quantity of goods that left a customs territory is less than a quantity originally declared in a corresponding export declaration, and may be based on datatype CDT:Indicator. ExportExitConfirmationMethodCode may be optional, is a method with which a confirmation that an export goods have crossed a border is given, and may be based on datatype GDT:ExportExitConfirmationMethodCode.
The Export package may include the node element TimePoint in a 1:CN cardinality relationship, a node element CustomsOffice in a 1:CN cardinality relationship, a node element Party in a 1:CN cardinality relationship, a node element Item in a 1:CN cardinality relationship, and a node element Document in a 1:CN cardinality relationship.
The ExportTimePoint package includes a TimePoint entity. TimePoint is a time point at which some processing of an export declaration took place, takes place or will take place. TimePoint includes the following non-node elements: TimePointRoleCode, DateTime, and Date. TimePointRoleCode may be optional, is a role a time point plays in processing of an export declaration, and may be based on datatype GDT:TimePointRoleCode. DateTime may be optional, is a date and time of a time point, and may be based on datatype CDT:LOCAL_DateTime. Date may be optional, is a date of a time point, and may be based on datatype CDT:Date.
The ExportCustomsOffice package includes a CustomsOffice entity. CustomsOffice is a customs office involved in an export. CustomsOffice includes the RoleCategoryCode non-node element, which may be optional, is a role a customs office plays in processing of an export declaration, and may be based on datatype GDT:PartyRoleCategoryCode. The ExportCustomsOffice package may include the node element Identification in a 1:CN cardinality relationship. The ExportCustomsOfficeIdentification package includes the Identification entity. Identification is an identifier of a customs office. Identification includes the following non-node elements: PartyIdentifierTypeCode and PartyID. PartyIdentifierTypeCode may be optional, is a type code of an identifier for a customs office, and may be based on datatype GDT:PartyIdentifierTypeCode. PartyID may be optional, is an identifier for a customs office, and may be based on datatype GDT:NOALPHANUMERICCONVERSION_PartyID.
The ExportParty package includes the Party entity. Party is a natural or legal person involved in an export as exporter or product recipient or acting on behalf of an exporter or product recipient. Party includes the following non-node elements: RoleCategoryCode, PostalRegulationsCompliantStreetDescription, and Address. RoleCategoryCode may be optional, is role a party plays in processing of an export declaration, and may be based on datatype GDT:PartyRoleCategoryCode. Address may be optional, is an address of a party, and may be based on datatype GDT:Address. PostalRegulationsCompliantStreetDescription may be optional, is a street and house identifier, may be formatted to comply with postal regulations in a country a party is situated in, and may be based on datatype GDT:LANGUAGEINDEPENDENT_MEDIUM_Description. The ExportParty package may include the Identification node element in a 1:CN cardinality relationship and the ContactParty node element in a 1:C cardinality relationship.
The ExportPartyPartyIdentification package includes the Identification entity. Identification is an identifier for a party. Identification includes the following non-node elements: PartyIdentifierTypeCode and PartyID. PartyIdentifierTypeCode may be optional, is a type of an identifier of a party, and may be based on datatype GDT:PartyIdentifierTypeCode. PartyID may be optional, is an identifier for a party, and may be based on datatype GDT:NOALPHANUMERICCONVERSION_PartyID.
The ExportPartyPartyContactParty package includes the ContactParty entity. The ContactParty entity is a contact for a party. ContactParty includes the following non-node elements: Address, BusinessPartnerFormattedName, FormattedConventionalPhoneNumberDescription, and FormattedFacsimileNumberDescription. Address may be optional, is an address of a contact party, and may be based on datatype GDT:Address. BusinessPartnerFormattedName may be optional, is a formatted name of a contact party, and may be based on datatype CDT:LANGUAGEINDEPENDENT_EXTENDED_Name. FormattedConventionalPhoneNumberDescription may be optional, is a formatted conventional phone number of a contact party, and may be based on datatype GDT:LANGUAGEINDEPENDENT_SHORT_Description. FormattedFacsimileNumberDescription may be optional, is a formatted facsimile number of a contact party, and may be based on datatype GDT:LANGUAGEINDEPENDENT_SHORT_Description.
ExportDocument package includes the Document entity. Document is a document that is attached to a message. Document includes the following non-node elements: DocumentTypeCode and FileContentBinaryObject. DocumentTypeCode may be optional, is a type of a document, and may be based on datatype GDT:DocumentTypeCode. FileContentBinaryObject may be optional, is binary content of a document, and may be based on datatype CDT:BinaryObject.
ExportItem package includes the Item entity. Item is an item of an export. Item includes the following non-node elements: CustomsAuthorityID, Description, CustomsProcessPartyID, ConsignmentExportID, Net WeightQuantity, Net WeightQuantityTypeCode, GrossWeightQuantity, GrossWeightQuantityTypeCode, CustomsCommodityClassificationCode, ExportProcedureTypeCode, ExportPreviousProcedureTypeCode, and ExportAdditionalProcedureTypeCode.
CustomsAuthorityID may be optional, is an identifier for an export declaration item, may follow a schema specified by a customs authority, and may be based on datatype GDT:CustomsDeclarationItemCustomsAuthorityID. Description may be optional, is a description of an export declaration item in natural language, and may be based on datatype GDT:Description. CustomsProcessPartyID may be optional, is an identifier for an export, may be assigned internally, and may be based on datatype GDT:CustomsProcessID. ConsignmentExportID may be optional, is an identifier for a consignment underlying an export, and may be based on datatype GDT:ConsignmentExportID. NetWeightQuantity may be optional, is the net weight quantity of an item, and may be based on datatype CDT:Quantity. NetWeightQuantityTypeCode may be optional, is a type of net weight quantity of an item, and may be based on datatype GDT:QuantityTypeCode. GrossWeightQuantity may be optional, is the gross weight of an item, and may be based on datatype CDT:Quantity. GrossWeightQuantityTypeCode may be optional, is a type of gross weight of an item, and may be based on datatype GDT:QuantityTypeCode. CustomsCommodityClassificationCode may be optional, is a classification of an exported commodity according to specifications by a customs authority, and may be based on datatype GDT: CustomsCommodityClassificationCode. ExportProcedureTypeCode may be optional, is an export procedure to use for an item, and may be based on datatype GDT:ExportProcedureTypeCode. ExportPreviousProcedureTypeCode may be optional, is a customs procedure that was previously applied to an item, and may be based on datatype GDT:ExportPreviousProcedureTypeCode. ExportAdditionalProcedureTypeCode may be optional, is an additional export procedure to use for an item, and may be based on datatype GDT:ExportAdditionalProcedureTypeCode.
The ExportItem package may include a Party node element in a 1:CN cardinality relationship and a Package node element in a 1:CN cardinality relationship. The ExportItemParty package includes the Party entity. Party is a party involved in an export of an item. Party includes the following non-node elements: RoleCategoryCode, Address, and PostalRegulationsCompliantStreetDescription. RoleCategoryCode may be optional, is a role a party plays in an export of an item, and may be based on datatype GDT:PartyRoleCategoryCode. Address may be optional, is an address of a party, and may be based on datatype GDT:Address. PostalRegulationsCompliantStreetDescription may be optional, is a street and house identifier of a party, may be formatted to comply with local postal regulations in a country a party is situated in, and may be based on datatype GDT:LANGUAGEINDEPENDENT_MEDIUM_Description. Party may include an Identification node element in a 1:CN cardinality relationship and a ContactParty node element in a 1:C cardinality relationship.
The ExportItemPartyIdentification package includes the Identification entity. Identification is an identifier for a party. Identification includes the following non-node elements: PartyIdentifierTypeCode and PartyID. PartyIdentifierTypeCode may be optional, is a type of a party identifier, and may be based on datatype GDT:PartyIdentifierTypeCode. PartyID may be optional, is an identifier for a party, and may be based on datatype GDT:NOALPHANUMERICCONVERSION_PartyID. The ExportItemPartyContactParty package includes the ContactParty entity. ContactParty is a contact party for a party. ContactParty includes the following non-node elements: Address, BusinessPartnerFormattedName, FormattedConventionalPhoneNumberDescription, and FormattedFacsimileNumberDescription. Address may be optional, is an address of a contact party, and may be based on datatype GDT:Address. BusinessPartnerFormattedName may be optional, is a formatted name of a contact party, and may be based on datatype CDT:LANGUAGEINDEPENDENT_EXTENDED_Name. FormattedConventionalPhoneNumberDescription may be optional, is a formatted conventional phone number of a contact party, and may be based on datatype GDT:LANGUAGEINDEPENDENT_SHORT_Description. FormattedFacsimileNumberDescription may be optional, is a formatted facsimile number of a contact party, and may be based on datatype GDT:LANGUAGEINDEPENDENT_SHORT_Description.
The ExportItempackage package includes the Package entity. Package is a package an item is packed in. Package includes the following non-node elements: OrdinalNumberValue, ElementNumberValue, ExportpackageTypeCode, and PackageExportID. OrdinalNumberValue may be optional, is an ordinal number used to order packages, and may be based on datatype GDT:OrdinalNumberValue. ElementNumberValue may be optional, is the number of physical containers in a package, and may be based on datatype GDT:NumberValue. ExportPackageTypeCode may be optional, is a type of a physical container in a package, and may be based on datatype GDT:ExportPackageTypeCode. PackageExportID may be optional, is an identifier for a physical container in a package, and may be based on datatype GDT:PackageExportID.
FIGS. 42-1 through 42-4 depict an example Form Export Declaration Processing in Fallback Procedure Request Message Data Type 42000, which comprises elements 42002-42044, hierarchically related as shown. For example, the Form Export Declaration Processing in Fallback Procedure Request 42002 includes an Export Declaration 42004.
The message type Form Export Declaration Processing in Fallback Procedure Request is derived from the business object Export Declaration as a leading object together with its operation signature. The message type Form Export Declaration Processing in Fallback Procedure Request enables a form-based output of an export declaration to request processing of an export declaration from a customs authority in a fallback procedure. The structure of the Form Export Declaration Processing in Fallback Procedure Request message type is determined by a message data type FormExportDeclarationProcessingInFallbackProcedureRequestMessage. The message data type FormExportDeclarationProcessingInFallbackProcedureRequestMessage includes the object ExportDeclaration which is included in a business document, business information that is relevant for sending a business document in a message, the MessageHeader package, and the ExportDeclaration package. The message data type FormExportDeclarationProcessingInFallbackProcedureRequestMessage provides a structure for the Form Export Declaration Processing in Fallback Procedure Request message type and for associated operations.
The MessageHeader package is a grouping of business information that is relevant for sending a business document in a message. The MessageHeader package includes the MessageHeader node. The MessageHeader node is a grouping of business information from the perspective of a sending application, such as information to identify the business document in a message, information about the sender, and optionally information about the recipient. The MessageHeader includes SenderParty and RecipientParty. MessageHeader may be based on the datatype GDT:BusinessDocumentMessageHeader. SenderParty is the partner responsible for sending a business document at a business application level. The SenderParty is of the type GDT:BusinessDocumentMessageHeaderParty. RecipientParty is of the type GDT:BusinessDocumentMessageHeaderParty. RecipientParty is the partner responsible for receiving a business document at a business application level.
The ExportDeclaration package is a grouping of ExportDeclaration with the entity ExportDeclaration and with the following packages: CustomsAuthorisation, PresentationLocation, ExportCustomsOffice, ExitCustomsOffice, SupplementaryExportCustomsOffice, PlannedExitCustomsOffice, ExporterParty, DeclarantParty, RepresentativeDeclarantParty, SubContractingParty, ProductRecipientParty, TransportRouteCountry, and Item. The ExportDeclaration entity is a business transaction document including data for a declaration to a customs authority for exporting goods according to legal requirements.
ExportDeclaration includes the following non-node elements: CustomsAuthorityCountryCode, CustomsProcessID, ExportDeclarationTypeCode, ExportTypeCode, ExportExportingCountryCode, ExportDestinationCountryCode, ExportSpecialCircumstancesCode, ExportTransportCostPaymentFormCode, ContainerUsedIndicator, ExportPartyRepresentationCode, ItemTotalNumberValue, InlandExportTransportModeCode, CrossBorderExportTransportModeCode, CrossBorderTransportMeansID, ExportCrossBorderTransportMeansNationalityCode, ExportBusinessTransactionTypeCode, InvoiceTotalNetAmount, ExportIncotermsClassificationCode, IncotermsTransferLocationName, CustomsFallbackProcedureIncidentID, CustomsFallbackProcedureIncidentStartDateTime, and CreationDateTime.
CustomsAuthorityCountryCode may be optional, is a country in which the customs authority to which this processing request is sentis situated, and may be based on datatype GDT:CountryCode. CustomsProcessID may be optional, is an identifier for an export, may be assigned internally, and may be based on datatype GDT:CustomsProcessID. ExportDeclarationTypeCode may be optional, is a type of an export declaration, and may be based on datatype GDT:ExportDeclarationTypeCode. ExportTypeCode may be optional, is a type of an export, and may be based on datatype GDT:ExportTypeCode. ExportExportingCountryCode may be optional, is a country from which goods are exported, and may be based on datatype GDT:ExportExportingCountryCode. ExportDestinationCountryCode may be optional, is a country to which goods are exported, and may be based on datatype GDT:ExportDestinationCountryCode. ExportSpecialCircumstancesCode may be optional, is a representation of special circumstances accompanying an export, and may be based on datatype GDT:ExportSpecialCircumstancesCode. ExportTransportCostPaymentFormCode may be optional, is a payment form for a transport cost of an export, and may be based on datatype GDT:ExportTransportCostPaymentFormCode. ContainerUsedIndicator may be optional, indicates whether export goods are shipped in containers, and may be based on datatype CDT:Indicator. ExportPartyRepresentationCode may be optional, is a representation situation of parties involved in an export, and may be based on datatype GDT:ExportPartyRepresentationCode. ItemTotalNumberValue may be optional, is a total number of items in an export declaration, and may be based on datatype GDT:NumberValue. InlandExportTransportModeCode may be optional, is a transport mode used to move export goods inland, and may be based on datatype GDT:ExportTransportModeCode. CrossBorderExportTransportModeCode may be optional, is a transport mode used to move export goods across a border, and may be based on datatype GDT:ExportTransportModeCode. CrossBorderTransportMeansID may be optional, is an identifier for a transport means used to move export goods across a border, and may be based on datatype GDT:TransportMeansID_V1. ExportCrossBorderTransportMeansNationalityCode may be optional, is a nationality of a transport means used to move export goods across a border, and may be based on datatype GDT: ExportCrossBorderTransportMeansNationalityCode. ExportBusinessTransactionTypeCode may be optional, is a type of a business transaction underlying an export, and may be based on datatype GDT:ExportBusinessTransactionTypeCode. InvoiceTotalNetAmount may be optional, is a total net amount of an invoice underlying an export, and may be based on datatype CDT:Amount. ExportIncotermsClassificationCode may be optional, is a classification of incoterms underlying an export, and may be based on datatype GDT:ExportIncotermsClassificationCode. IncotermsTransferLocationName may be optional, is a name of a transfer location of incoterms underlying an export, and may be based on datatype CDT:MEDIUM_Name. CustomsFallbackProcedureIncidentID may be optional, is an incident that makes the usage of a customs fallback procedure necessary, and may be based on datatype GDT: CustomsFallbackProcedureIncidentID. CustomsFallbackProcedureIncidentStartDateTime may be optional, is a date and time at which the usage of a customs fallback procedure starts, and may be based on CDT:LOCAL_DateTime. CreationDateTime may be optional, is a date and time at which a message was created, and may be based on datatype CDT:LOCAL_DateTime.
ExportDeclaration may include CustomsAuthorisation in a 1:C cardinality relationship, PresentationLocation in a 1:C cardinality relationship, ExportCustomsOffice in a 1:C cardinality relationship, ExitCustomsOffice in a 1:C cardinality relationship, SupplementaryExportCustomsOffice in a 1:C cardinality relationship, PlannedExitCustomsOffice in a 1:C cardinality relationship, ExporterParty in a 1:C cardinality relationship, DeclarantParty in a 1:C cardinality relationship, RepresentativeDeclarantParty in a 1:C cardinality relationship, SubContractingParty in a 1:C cardinality relationship, ProductRecipientParty in a 1:C cardinality relationship, TransportRouteCountry in a 1:C cardinality relationship, and Item in a 1:CN cardinality relationship.
The ExportDeclarationCustomsAuthorisation package includes the CustomsAuthorisation entity. CustomsAuthorisation is a customs authorisation that authorizes an exporter to use simplifications and special procedures declared in a message. CustomsAuthorisation includes the following non-node elements: TypeCode, ID, ReleaseStampPrintingAllowedIndicator, and ReleaseStampPrintingCustomsAuthorisationID. TypeCode may be optional, is a type of a customs authorization, and may be based on datatype GDT:CustomsAuthorisationTypeCode. ID may be optional, is an identifier for a customs authorization, may be issued by a customs authority, and may be based on datatype GDT: CustomsAuthorisationID. ReleaseStampPrintingAllowedIndicator may be optional, indicates whether a declarant is allowed to print a release stamp on a form, and may be based on datatype CDT:Indicator. ReleaseStampPrintingCustomsAuthorisationID may be optional, is an identifier for a customs authorisation that allows a declarant to print a release stamp on a form, and may be based on datatype GDT:CustomsAuthorisationID.
The ExportDeclarationPresentationLocation package includes the PresentationLocation entity. PresentationLocation is a location at which export goods are presented to a customs authority. PresentationLocation includes the CustomsAuthorityID element, which may be optional, is an identifier for a location, may be issued by a customs authority, and may be based on datatype GDT:LocationPartyID.
The ExportDeclarationExportCustomsOffice package includes the ExportCustomsOffice entity. The ExportCustomsOffice is a customs office of export involved in an export. ExportCustomsOffice includes the following non-node elements: Address and EUCustomsOfficeNumberPartyID. Address may be optional, is an address of a customs office, and may be based on datatype GDT:FormAddress. EUCustomsOfficeNumberPartyID may be optional, is an EI (European Union) customs office number of a customs office, and may be based on datatype GDT:NOALPHANUMERICCONVERSION_PartyID.
The ExportDeclarationExitCustomsOffice package includes the ExitCustomsOffice entity. ExitCustomsOffice is a customs office of exit involved in an export. ExitCustomsOffice includes the following non-node elements: Address and EUCustomsOfficeNumberPartyID. Address may be optional, is an address of a customs office, and may be based on datatype GDT:FormAddress. EUCustomsOfficeNumberPartyID may be optional, is an EI (European Union) customs office number of a customs office, and may be based on datatype GDT:NOALPHANUMERICCONVERSION_PartyID.
The ExportDeclarationSupplementaryExportCustomsOffice package includes the SupplementaryExportCustomsOffice entity. SupplementaryExportCustomsOffice is a customs office of export that processes a supplementary declaration of an export. SupplementaryExportCustomsOffice includes the following non-node elements: Address and EUCustomsOfficeNumberPartyID. Address may be optional, is an address of a customs office, and may be based on datatype GDT:FormAddress. EUCustomsOfficeNumberPartyID may be optional, is an EI (European Union) customs office number of a customs office, and may be based on datatype GDT:NOALPHANUMERICCONVERSION_PartyID.
The ExportDeclarationPlannedExitCustomsOffice package includes the PlannedExitCustomsOffice entity. PlannedExitCustomsOffice is a customs office of exit at which goods are planned to exit a customs territory. PlannedExitCustomsOffice includes the following non-node elements: Address and EUCustomsOfficeNumberPartyID. Address may be optional, is an address of a customs office, and may be based on datatype GDT:FormAddress. EUCustomsOfficeNumberPartyID may be optional, is an EI (European Union) customs office number of a customs office, and may be based on datatype GDT:NOALPHANUMERICCONVERSION_PartyID.
The ExportDeclarationExporterParty package includes the ExporterParty entity. ExporterParty is a party that exports goods. ExporterParty includes the following non-node elements: Address and GermanCustomsNumberPartyID. Address may be optional, is an address of a party, and may be based on datatype GDT:FormAddress. GermanCustomsNumberPartyID may be optional, is a German customs number of a party, and may be based on datatype GDT:NOALPHANUMERICCONVERSION_PartyID. The ExportDeclarationExporterParty package may include a 1:C cardinality relationship with ContactParty.
The ExportDeclarationExporterPartyContactParty package includes the ContactParty entity. ContactParty is a contact party of a party. ContactParty includes Address as a non-node element. Address may be optional, is an address of a contact party, and may be based on datatype GDT:FormAddress. The ExportDeclarationDeclarantParty package includes DeclarantParty entity. DeclarantParty is a party that declares an export to a customs authority. DeclarantParty includes the following non-node elements: Address and GermanCustomsNumberPartyID. Address may be optional, is an address of a party, and may be based on datatype GDT:FormAddress. GermanCustomsNumberPartyID may be optional, is a German customs number of a party, and may be based on datatype GDT:NOALPHANUMERICCONVERSION_PartyID. The ExportDeclarationExporterPartyContactParty package may include a 1:C cardinality relationship with ContactParty.
The ExportDeclarationDeclarantPartyContactParty package includes the ContactParty entity. ContactParty is a contact party of a party. ContactParty includes Address as a non-node element. Address may be optional, is an address of a contact party, and may be based on datatype GDT:FormAddress.
The ExportDeclarationRepresentativeDeclarantParty package includes the RepresentativeDeclarantParty entity. RepresentativeDeclarantParty is a party that represents a declarant party to a customs authority. RepresentativeDeclarantParty includes the following non-node elements: Address and GermanCustomsNumberPartyID. Address may be optional, is an address of a party, and may be based on datatype GDT:FormAddress. GermanCustomsNumberPartyID may be optional, is a German customs number of a party, and may be based on datatype GDT:NOALPHANUMERICCONVERSION_PartyID. ExportDeclarationRepresentativeDeclarantParty may include the node element ContactParty in a 1:C cardinality relationship.
The ExportDeclarationRepresentativeDeclarantPartyContactParty package includes the ContactParty entity. ContactParty is a contact party of a party. ContactParty includes Address as a non-node element. Address may be optional, is an address of a contact party, and may be based on datatype GDT:FormAddress.
The ExportDeclarationSubContractingParty package includes the SubContractingParty entity. SubContractingParty is a party that sub-contracts in an export to carry goods across a border. SubContractingParty includes the following non-node elements: Address and GermanCustomsNumberPartyID. Address may be optional, is an address of a party, and may be based on datatype GDT:FormAddress. GermanCustomsNumberPartyID may be optional, is a German customs number of a party, and may be based on datatype GDT:NOALPHANUMERICCONVERSION_PartyID. ExportDeclarationSubContractingParty may include the node element ContactParty in a 1:C cardinality relationship.
The ExportDeclarationSubContractingPartyContactParty package includes the ContactParty entity. ContactParty is a contact party of a party. ContactParty includes Address as a non-node element. Address may be optional, is an address of a contact party, and may be based on datatype GDT:FormAddress.
The ExportDeclarationProductRecipientParty package includes the ProductRecipientParty. ProductRecipientParty is a party that receives export goods. ProductRecipientParty includes the following non-node elements: Address and GermanCustomsNumberPartyID. Address may be optional, is an address of a party, and may be based on datatype GDT:FormAddress. GermanCustomsNumberPartyID may be optional, is a German customs number of a party, and may be based on datatype GDT:NOALPHANUMERICCONVERSION_PartyID. ExportDeclarationProductRecipientParty may include the node element ContactParty in a 1:C cardinality relationship.
The ExportDeclarationProductRecipientPartyContactParty package includes the ContactParty entity. ContactParty is a contact party of a party. ContactParty includes Address as a non-node element. Address may be optional, is an address of a contact party, and may be based on datatype GDT:FormAddress.
The ExportDeclarationTransportRouteCountry package includes the TransportRouteCountry entity. TransportRouteCountry is a country wherein an export starts, passes through, or ends.
TransportRouteCountry includes the following non-node elements: OrdinalNumberValue and ExportTransportRouteCountryCode. OrdinalNumberValue may be optional, is an ordinal number used to order countries of the transport route in an order in which they are passed by an export, and may be based on datatype GDT:NumberValue. ExportTransportRouteCountryCode may be optional, is a single country of a transport route, and may be based on datatype GDT:ExportTransportRouteCountryCode. In some implementations, the sequence of all TransportRouteCountries in an ExportDeclaration represents a transport route. An OrdinalNumberValue may be used to put a TransportRouteCountries in sequence and the same country can appear more than once in this ordered list of countries.
The ExportDeclarationItem package includes the Item entity. Item is an item in an export declaration. Item includes the following non-node elements: CustomsAuthorityID, Description, OriginExportRegionCode, Net WeightQuantity, Net WeightQuantityTypeCode, GrossWeightQuantity, GrossWeightQuantityTypeCode, ExportTransportCostPaymentFormCode, CustomsCommodityClassificationCode, ExportProcedureTypeCode, ExportPreviousProcedureTypeCode, ExportAdditionalProcedureTypeCode, LegalComplianceQuantity, LegalComplianceQuantityTypeCode, PackageText, AdditionalInformationText, PreviousDocumentText, and LegalComplianceAmount.
CustomsAuthorityID may be optional, is an identifier for an export declaration item which may follow a schema specified by a customs authority, and may be based on datatype GDT: CustomsDeclarationItemCustomsAuthorityID. Description may be optional, is a description of an export declaration item in natural language, and may be based on datatype GDT:Description. OriginExportRegionCode may be optional, is a region of origin of an export item, and may be based on datatype GDT:ExportRegionCode. NetWeightQuantity may be optional, is a net weight quantity of an item, and may be based on datatype CDT:Quantity. NetWeightQuantityTypeCode may be optional, is a type of net weight quantity of an item, and may be based on datatype GDT:QuantityTypeCode. GrossWeightQuantity may be optional, is a gross weight of an item, and may be based on datatype CDT:Quantity. GrossWeightQuantityTypeCode may be optional, is a type of gross weight of an item, and may be based on datatype GDT:QuantityTypeCode. ExportTransportCostPaymentFormCode may be optional, is a payment form for a transport cost of an export, and may be based on datatype GDT:ExportTransportCostPaymentFormCode. CustomsCommodityClassificationCode may be optional, is a classification of an exported commodity according to specifications by a customs authority, and may be based on datatype GDT: CustomsCommodityClassificationCode. ExportProcedureTypeCode may be optional, is an export procedure to use for an item, and may be based on datatype GDT:ExportProcedureTypeCode. ExportPreviousProcedureTypeCode may be optional, is a customs procedure that was previously applied to an item, and may be based on datatype GDT:ExportPreviousProcedureTypeCode. ExportAdditionalProcedureTypeCode may be optional, is an additional export procedure to use for an item, and may be based on datatype GDT:ExportAdditionalProcedureTypeCode. LegalComplianceQuantity may be optional, is a quantity of an item formatted to comply with legal regulations, and may be based on datatype CDT:Quantity. LegalComplianceQuantityTypeCode may be optional, is a type of a quantity of an item formatted to comply with legal regulations, and may be based on datatype GDT:QuantityTypeCode. PackageText may be optional, is a textual description of packages in which an item is packed, and may be based on datatype CDT:Text. AdditionalInformationText may be optional, includes additional information about an item, and may be based on datatype CDT:Text. PreviousDocumentText may be optional, is a textual description of previous documents related to an item, and may be based on datatype CDT:Text. LegalComplianceAmount may be optional, is an amount of an item formatted to comply with legal regulations, and may be based on datatype CDT:Amount. ExportDeclarationItem may include ProductRecipientParty as a node element in a 1:C cardinality relationship.
The ExportDeclarationItemProductRecipientParty package includes the ProductRecipientParty entity. ProductRecipientParty is a party that receives export goods. ProductRecipientParty includes the following non-node elements: Address and GermanCustomsNumberPartyID. Address may be optional, is an address of a party, and may be based on datatype GDT:FormAddress. GermanCustomsNumberPartyID may be optional, is a German customs number of a party, and may be based on datatype GDT:NOALPHANUMERICCONVERSION_PartyID. ExportDeclarationItemProductRecipientParty may include ProductRecipientParty as a node element in a 1:C cardinality relationship.
The ExportDeclarationItemProductRecipientPartyContactParty package includes the ContactParty entity. ContactParty is a contact party of a party. ContactParty includes Address as a non-node element. Address may be optional, is an address of a party, and may be based on datatype GDT:FormAddress.
FIGS. 43-1 through 43-42 show an example configuration of an Element Structure that includes an ExportDeclarationProcessingCancellationRequest 430000 package. Specifically, these figures depict the arrangement and hierarchy of various components such as one or more levels of packages, entities, and datatypes, shown here as 430000 through 431248. As described above, packages may be used to represent hierarchy levels. Entities are discrete business elements that are used during a business transaction. Data types are used to type object entities and interfaces with a structure. For example, the ExportDeclarationProcessingCancellationRequest 430000 includes, among other things, an ExportDeclarationProcessingCancellationRequest 430002. Accordingly, heterogeneous applications may communicate using this consistent message configured as such.
FIGS. 44-1 through 44-158 show an example configuration of an Element Structure that includes an ExportDeclarationProcessingConfirmation 440000 package. Specifically, these figures depict the arrangement and hierarchy of various components such as one or more levels of packages, entities, and datatypes, shown here as 440000 through 443142. As described above, packages may be used to represent hierarchy levels. Entities are discrete business elements that are used during a business transaction. Data types are used to type object entities and interfaces with a structure. For example, the ExportDeclarationProcessingConfirmation 440000 includes, among other things, an ExportDeclarationProcessingConfirmation 440002. Accordingly, heterogeneous applications may communicate using this consistent message configured as such.
FIGS. 45-1 through 45-143 show an example configuration of an Element Structure that includes an ExportDeclarationProcessingRequest 450000 package. Specifically, these figures depict the arrangement and hierarchy of various components such as one or more levels of packages, entities, and datatypes, shown here as 450000 through 453162. As described above, packages may be used to represent hierarchy levels. Entities are discrete business elements that are used during a business transaction. Data types are used to type object entities and interfaces with a structure. For example, the ExportDeclarationProcessingRequest 450000 includes, among other things, an ExportDeclarationProcessingRequest 450002. Accordingly, heterogeneous applications may communicate using this consistent message configured as such.
FIGS. 46-1 through 46-6 show an example configuration of an Element Structure that includes an ExportMessageExchangeNotification 460000 package. Specifically, these figures depict the arrangement and hierarchy of various components such as one or more levels of packages, entities, and datatypes, shown here as 460000 through 460252. As described above, packages may be used to represent hierarchy levels. Entities are discrete business elements that are used during a business transaction. Data types are used to type object entities and interfaces with a structure. For example, the ExportMessageExchangeNotification 460000 includes, among other things, an ExportMessageExchangeNotification 460002. Accordingly, heterogeneous applications may communicate using this consistent message configured as such.
FIGS. 47-1 through 47-7 show an example configuration of an Element Structure that includes an ExportMessageSemanticErrorNotification 470000 package. Specifically, these figures depict the arrangement and hierarchy of various components such as one or more levels of packages, entities, and datatypes, shown here as 470000 through 470290. As described above, packages may be used to represent hierarchy levels. Entities are discrete business elements that are used during a business transaction. Data types are used to type object entities and interfaces with a structure. For example, the ExportMessageSemanticErrorNotification 470000 includes, among other things, an ExportMessageSemanticErrorNotification 470002. Accordingly, heterogeneous applications may communicate using this consistent message configured as such.
FIGS. 48-1 through 48-7 show an example configuration of an Element Structure that includes an ExportMessageSyntaxErrorNotification 480000 package. Specifically, these figures depict the arrangement and hierarchy of various components such as one or more levels of packages, entities, and datatypes, shown here as 480000 through 480278. As described above, packages may be used to represent hierarchy levels. Entities are discrete business elements that are used during a business transaction. Data types are used to type object entities and interfaces with a structure. For example, the ExportMessageSyntaxErrorNotification 480000 includes, among other things, an ExportMessageSyntaxErrorNotification 480002. Accordingly, heterogeneous applications may communicate using this consistent message configured as such.
FIGS. 49-1 through 49-40 show an example configuration of an Element Structure that includes an ExportProcessingInformationConfirmation 490000 package. Specifically, these figures depict the arrangement and hierarchy of various components such as one or more levels of packages, entities, and datatypes, shown here as 490000 through 491210. As described above, packages may be used to represent hierarchy levels. Entities are discrete business elements that are used during a business transaction. Data types are used to type object entities and interfaces with a structure. For example, the ExportProcessingInformationConfirmation 490000 includes, among other things, an ExportProcessingInformationConfirmation 490002. Accordingly, heterogeneous applications may communicate using this consistent message configured as such.
FIGS. 50-1 through 50-41 show an example configuration of an Element Structure that includes an ExportProcessingInformationRequest 500000 package. Specifically, these figures depict the arrangement and hierarchy of various components such as one or more levels of packages, entities, and datatypes, shown here as 500000 through 501216. As described above, packages may be used to represent hierarchy levels. Entities are discrete business elements that are used during a business transaction. Data types are used to type object entities and interfaces with a structure. For example, the ExportProcessingInformationRequest 500000 includes, among other things, an ExportProcessingInformationRequest 500002. Accordingly, heterogeneous applications may communicate using this consistent message configured as such.
FIGS. 51-1 through 51-102 show an example configuration of an Element Structure that includes an ExportProcessingNotification 510000 package. Specifically, these figures depict the arrangement and hierarchy of various components such as one or more levels of packages, entities, and datatypes, shown here as 510000 through 512324. As described above, packages may be used to represent hierarchy levels. Entities are discrete business elements that are used during a business transaction. Data types are used to type object entities and interfaces with a structure. For example, the ExportProcessingNotification 510000 includes, among other things, an ExportProcessingNotification 510002. Accordingly, heterogeneous applications may communicate using this consistent message configured as such.
FIGS. 52-1 through 52-22 show an example configuration of an Element Structure that includes a FormExportDeclarationProcessinglnFallbackProcedureRequest 520000 package. Specifically, these figures depict the arrangement and hierarchy of various components such as one or more levels of packages, entities, and datatypes, shown here as 520000 through 520610. As described above, packages may be used to represent hierarchy levels. Entities are discrete business elements that are used during a business transaction. Data types are used to type object entities and interfaces with a structure. For example, the FormExportDeclarationProcessinglnFallbackProcedureRequest 520000 includes, among other things, a FormExportDeclarationProcessinglnFallbackProcedureRequest 520002. Accordingly, heterogeneous applications may communicate using this consistent message configured as such.
FIGS. 53-1 through 53-6 depict an example object model for a business object Export Declaration Request 53000. The business object 53000 has relationships with other objects 53002-53022, as shown with lines and arrows. The business object 53000 hierarchically comprises elements 53024-53048. The other objects 53002-53022 include respective elements 53050-53084 as shown.
The business object Export Declaration Request is a request to create or update an export declaration using customs-relevant business transactions, such as from customer invoicing or outbound delivery. The business object Export Declaration Request belongs to the process component Customs Processing. An export declaration request includes business transaction data about goods that are transported out of a customs territory, for example, quantities, values, and other customs-relevant information. The business object Export Declaration Request is involved in the following Process Component Interaction Models: Customer Invoice Processing_Customs Processing and Outbound Delivery Processing_Customs Processing. The business object Export Declaration Request includes a root node. The elements located directly at the node Export Declaration Request are defined by the data type ExportDeclarationRequestElements. These elements include: UUID, ID, BaseBusinessTransactionDocumentTypeCode, Incoterms, TransportModeCode, TransportMeans, TotalNetWeightQuantity, TotalNetWeightQuantityTypeCode, TotalGrossWeightQuantity, TotalGrossWeightQuantityTypeCode, ExportDeclarationBlockIndicator, ExportDeclarationCancelIndicator, and SystemAdministrativeData. UUID is an alternative key, is a universally unique identifier of an export declaration request, and may be based on datatype GDT: UUID. ID is an alternative key, is an internally assigned identifier for an export declaration request, and may be based on datatype GDT: BusinessTransactionDocumentID. BaseBusinessTransactionDocumentTypeCode is a coded representation of a business document type used as base for an export declaration request, for example, a customer invoice or outbound delivery, and may be based on datatype GDT: BusinessTransactionDocumentTypeCode, with a qualifier of Base. Incoterms may be optional, are Incoterms of an export declaration request, and may be based on datatype GDT: Incoterms. TransportModeCode may be optional, is a coded representation of a transport mode of an export declaration request, and may be based on datatype GDT: TransportModeCode. TransportMeans may be optional, is a description of a means of transport of an export declaration request, and may be based on datatype GDT: TransportMeans. TotalNetWeightQuantity may be optional, is a total net weight of the goods of an export declaration request, and may be based on datatype GDT: Quantity, with a qualifier of Weight. TotalNetWeightQuantityTypeCode may be optional, is a coded representation of a type of the NetWeightQuantity of an export declaration request, and may be based on datatype GDT: QuantityTypeCode, with a qualifier of Weight. TotalGrossWeightQuantity may be optional, is a total gross weight of the goods of an export declaration request, and may be based on datatype GDT: Quantity, with a qualifier of Weight. TotalGrossWeightQuantityTypeCode may be optional, is a coded representation of a type of the GrossWeightQuantity of an export declaration request item, and may be based on datatype GDT: QuantityTypeCode, with a qualifier of Weight. ExportDeclarationBlockIndicator indicates that the processing of a requested export declaration may be blocked, and may be based on datatype GDT: Indicator, with a qualifier of Block. ExportDeclarationCancelIndicator indicates that an export declaration may be cancelled, and may be based on datatype GDT: Indicator, with a qualifier of Cancel. SystemAdministrativeData includes administrative data recorded by the system. This data includes system user and change times, and may be based on datatype GDT: SystemAdministrativeData.
The following composition relationships to subordinate nodes exist: Item, with a cardinality of 1:N; Party, with a cardinality of 1:CN; Location, with a cardinality of 1:CN; Package, with a cardinality of 1:CN; and Business Transaction Document Reference, with a cardinality of 1:CN. A Creation Identity inbound association relationship may exist from the business object Identity/node Identity, with a cardinality of 1:CN, which represents an identity of a user that created an Export Declaration Request. A Last Change Identity inbound association relationship may exist from the business object Identity/node Identity, with a cardinality of 1:CN, which represents an identity of the user that last changed an Export Declaration Request.
A Transfer Into Export Declaration enterprise service infrastructure action may be used to start a transfer of an Export Declaration Request into an Export Declaration. In some implementations, this action only influences the Data Transfer Result Status. In response to the Transfer Into Export Declaration action, the business object export declaration may be created or updated, which may mean that in the business object export declaration, one or more items can be created, changed or deleted. Also in response to the Transfer Into Export Declaration action, the Data Transfer Result Status is set to “Transferred.”
The business object Export Declaration Request may be associated with a Select All query and with a Query by Elements query. The Select All query provides the NodeIDs of all instances of a node and may be used to enable an initial load of data for a fast search infrastructure. The Query By Elements query provides a list of all Export Declaration Requests found based on given parameters. The query elements are defined by the data type ExportDeclarationRequestElementsQueryElements. These elements include: UUID, ID, SystemAdministrativeData, CreationDateTime, CreationIdentityUUID, CreationIdentityID, CreationIdentityBusinessPartnerInternalID, CreationIdentityBusinessPartnerPersonFamilyName, CreationIdentityBusinessPartnerPersonGivenName, CreationIdentityEmployeeID, LastChangeDateTime, LastChangeIdentityUUID, LastChangeIdentityID, LastChangeIdentityBusinessPartnerInternalID, LastChangeIdentityBusinessPartnerPersonFamilyName, LastChangeIdentityBusinessPartnerPersonGivenName, LastChangeIdentityEmployeeID, BaseBusinessTransactionDocumentTypeCode, and BusinessTransactionDocumentReference.
UUID may be optional, is a universally unique identifier of an export declaration request, and may be based on datatype GDT: UUID. ID: may be optional, is an ID of an export declaration request, and may be based on datatype GDT: BusinessTransactionDocumentID. SystemAdministrativeData may be optional, includes administrative data recorded by the system, such as system user and change times, and may be based on datatype QueryIDT: QueryElementSystemAdministrativeData. CreationDateTime may be optional, is a point in time date and time stamp of a creation, and may be based on datatype GDT: GLOBAL_DateTime. CreationIdentityUUID may be optional, is a globally unique identifier for an identity who performed a creation, and may be based on datatype GDT: UUID. CreationIdentityID may be optional, is an identifier for an identity who performed a creation, and may be based on datatype GDT: IdentityID. CreationIdentityBusinessPartnerInternalID may be optional, is a proprietary identifier for a business partner that is attributed to a creation identity and that can be reached following the relationships of the creation identity, and may be based on datatype GDT: BusinessPartnerInternalID. CreationIdentityBusinessPartnerPersonFamilyName may be optional, is a family name of a business partner of a category person that is attributed to a creation identity and that can be reached following the relationships of the creation identity, and may be based on datatype GDT: LANGUAGEINDEPENDENT_MEDIUM Name. CreationIdentityBusinessPartnerPersonGivenName may be optional, is a given name of a business partner of a category person that is attributed to a creation identity and that can be reached following the relationships of the creation identity, and may be based on datatype GDT: LANGUAGEINDEPENDENT_MEDIUM Name. CreationIdentityEmployeeID may be optional, is an identifier for an employee that is attributed to a creation identity and that can be reached following the relationships of the creation identity, and may be based on datatype GDT: EmployeeID. LastChangeDateTime may be optional, is a point in time date and time stamp of a last change, and may be based on datatype GDT: GLOBAL_DateTime. LastChangeIdentityUUID may be optional, is a globally unique identifier for an identity who made last changes, and may be based on datatype GDT: UUID. LastChangeIdentityID may be optional, is an identifier for an identity who made last changes, and may be based on datatype GDT: IdentityID. LastChangeIdentityBusinessPartnerInternalID may be optional, is a proprietary identifier for a business partner that is attributed to a last change identity and that can be reached following the relationships of the last change identity, and may be based on datatype GDT: BusinessPartnerinternalID. LastChangeIdentityBusinessPartnerPersonFamilyName may be optional, is a family name of a business partner of a category person that is attributed to a last change identity and that can be reached following the relationships of the last change identity, and may be based on datatype GDT: LANGUAGEINDEPENDENT_MEDIUM Name. LastChangeIdentityBusinessPartnerPersonGivenName may be optional, is a given name of a business partner of a category person that is attributed to a last change identity and that can be reached following the relationships of the last change identity, and may be based on datatype GDT: LANGUAGEINDEPENDENT_MEDIUM_Name. LastChangeIdentityEmployeeID may be optional, is an identifier for an employee that is attributed to a last change identity and that can be reached following the relationships of the last change identity, and may be based on datatype GDT: EmployeeID. BaseBusinessTransactionDocumentTypeCode may be optional, is a coded representation of a business document type used as base for an export declaration request, for example, a customer invoice or outbound delivery, and may be based on datatype GDT: BusinessTransactionDocumentTypeCode, with a qualifier of Base. BusinessTransactionDocumentReference may be optional, is a reference to a delivery, and may be based on datatype GDT: BusinessTransactionDocumentReference.
Item is a quantity of a product in an export declaration request with additional information on amounts, quantities and packaging data. The elements located directly at the node Item are defined by a data type ExportDeclarationRequestItemElements. These elements include: UUID, ID, Description, Quantity, QuantityTypeCode, NetWeightQuantity, Net WeightQuantityTypeCode, Gross WeightQuantity, Gross WeightQuantityTypeCode, InvoiceNetAmount, CustomerInvoiceRequiredIndicator, ExportDeclarationBlockIndicator, and SystemAdministrativeData. UUID may be an alternative key, is a inversely unique identifier for an export declaration request item, and may be based on datatype GDT: UUID. ID is an internally assigned identifier for an export declaration request item, and may be based on datatype GDT: BusinessTransactionDocumentItemID. Description may be optional, is a description of an item, and may be based on datatype GDT: SHORT_Description. Quantity is a quantity of exported goods, and may be based on datatype GDT: Quantity. QuantityTypeCode is a coded representation of a type of the quantity of an export declaration request item, and may be based on datatype GDT: QuantityTypeCode. NetWeightQuantity may be optional, is a net weight of an export declaration request item, and may be based on datatype GDT: Quantity, with a qualifier of Weight. NetWeightQuantityTypeCode may be optional, is a coded representation of a type of a net weight quantity of an export declaration request item, and may be based on datatype GDT: QuantityTypeCode, with a qualifier of Weight. GrossWeightQuantity may be optional, is a gross weight of an export declaration request item, and may be based on datatype GDT: Quantity, with a qualifier of Weight. GrossWeightQuantityTypeCode may be optional, is a coded representation of a type of a gross weight quantity of an export declaration request item, and may be based on datatype GDT: QuantityTypeCode, with a qualifier of Weight. InvoiceNetAmount may be optional, is a net value of an invoice item, and may be based on datatype GDT: Amount, with a qualifier of Net. CustomerInvoiceRequiredIndicator indicates that a Customer Invoice that triggers an Export Declaration Request is required to complete an Export Declaration, and may be based on datatype GDT: Indicator, with a qualifier of Required. ExportDeclarationBlockIndicator indicates that the processing of a requested export declaration may be blocked, and may be based on datatype GDT: Indicator, with a qualifier of Block. SystemAdministrativeData includes administrative data recorded by the system, such as system user and change times, and may be based on datatype GDT: SystemAdministrativeData.
The following composition relationships to subordinate nodes may exist: Item Product, with a cardinality of 1:C; Item package Assignment, with a cardinality of 1:CN; Item Party, with a cardinality of 1:CN; and ItemBusinessTransactionDocumentReference, with a cardinality of 1:CN. A Creation Identity inbound association relationship may exist from the business object Identity/node Identity, with a cardinality of 1:CN, which is an identity of a user that created an Export Declaration Request Item. A Last Change Identity inbound association relationship may exist from the business object Identity/node Identity, with a cardinality of 1:CN, which is an identity of a user that last changed an Export Declaration Request Item.
The following specialization associations for navigation may exist to node ItemBusinessTransactionDocumentReference: SalesOrderItemReference, with a cardinality of C; OutboundDeliveryItemReference, with a cardinality of C; CustomerInvoiceItemReference, with a cardinality of CN; IntraCompanyStockTransferRequirementItemReference, with a cardinality of C; PurchaseOrderItemReference, with a cardinality of C; and ServiceOrderItemReference, with a cardinality of C. In some implementations, in the case that a quantity or a measure is set, a corresponding quantity or measure type may also be filled.
Item Product is a product of an export declaration request item. The elements located directly at the node Item Product are defined by the data type ExportDeclarationRequestItemProductElements. These elements include: ProductUUID, ProductKey, ProductTypeCode, ProductIdentifierTypeCode, and ProductID. ProductUUID may be optional, is a universally unique identifier of a product, and may be based on datatype GDT: UUID. ProductKey may be optional, is a proprietary identifier of a product, and may be based on datatype KDT: ProductKey. ProductTypeCode is a coded representation of a product type, such as a material or service, and may be based on datatype GDT: ProductTypeCode. ProductIdentifierTypeCode is a coded representation of a product identifier type, and may be based on datatype GDT: ProductIdentifierTypeCode. ProductID is an identifier for a product, and may be based on datatype GDT: ProductID. A Individual Material inbound aggregation relationship may exist from the business object Individual Material/node Individual Material, with a cardinality of C:CN, which is an individual material of an export declaration request item. A Material inbound aggregation relationship may exist from the business object Material/node Material, with a cardinality of C:CN, which is a material of an export declaration request item. In some implementations, at least one of the following elements is filled: ProductUUID or ProductKey. In some implementations, at least one of the following aggregations exists: material and individual material.
Item package Assignment is an assignment to a package an export declaration request item is packed in. The elements located directly at the node Item package Assignment are defined by the data type ExportDeclarationRequestItempackageAssignmentElements. These elements include: packageUUID, packageKey, ExportDeclarationRequestUUID, ExportDeclarationRequestpackageID, ProductQuantity, and ProductQuantityTypeCode. PackageUUID is a universally unique identifier for a package, and may be based on datatype GDT: UUID. PackageKey is a key of a package in an export declaration request, and may be based on datatype KDT: ExportDeclarationRequestpackageKey. ExportDeclarationRequestUUID is a universally unique identifier of an export declaration request, and may be based on datatype GDT: UUID. ExportDeclarationRequestpackageID is an internal identifier of a package, and may be based on datatype GDT: ExportDeclarationRequestpackageID. ProductQuantity may be optional, is a quantity of product of an item assigned to a package, and may be based on datatype GDT: Quantity, with a qualifier of Product. ProductQuantityTypeCode may be optional, is a coded representation of the type of the ProductQuantity of an item assigned to a package, and may be based on datatype GDT: QuantityTypeCode, with a qualifier of Product. A Package inbound aggregation relationship may exist from the business object Export Declaration Request/node package, with a cardinality of 1:CN, which is a package in which an item product is packed.
Item Party is a natural or legal person, or a business partner that is involved in an export declaration request. A Party is a natural or legal person, organization, organizational unit or group that is involved in an export declaration request in a PartyRole. An item party can occur in the following disjoint specializations: Buyer Party, such as a party Customer that purchases a good or a service; and Seller Party, such as a party Company that sells a good or a service. The elements located directly at the node Item Party are defined by the data type ExportDeclarationRequestItemPartyElements. These elements include: PartyUUID, PartyKey, PartyTypeCode, PartyID, RoleCategoryCode, RoleCode, and AddressReference. PartyUUID may be optional, is a universally unique identifier for referencing a party, and may be based on datatype GDT: UUID. PartyKey may be optional, is a unique identifier of a Party, and may be based on datatype KDT: PartyKey. PartyTypeCode is a coded representation of a type of party, and may be based on datatype GDT: BusinessObjectTypeCode. PartyID is an identifier for a party, and may be based on datatype GDT: PartyID. RoleCategoryCode is a coded representation of a grouping of partner roles by process-controlling criteria, and may be based on datatype GDT: PartyRoleCategoryCode. RoleCode is a coded representation of a partner role, and may be based on datatype GDT: PartyRoleCode. AddressReference may be optional, is a reference to an item party's address, and may be based on datatype GDT: PartyAddressReference. A composition relationship to subordinate node Item Party Address may exist, with a cardinality of 1:C. A Party inbound aggregation relationship may exist from the business object Party/node Party, with a cardinality of C:CN, which represents either: a buyer to whom an invoice will be sent, who is requested to pay for goods and services to be exported; or a seller who was involved in a sales process on which an export declaration request item is based. A specialization association for navigation may exist to dependent business object item party address, with a target cardinality of C. In some implementations, at least one of the following elements is filled: PartyKey and PartyUUID. In some implementations, if the PartyUUID is specified, the PartyTypeCode is also present. In some implementations, if AddressHostUUID is specified, AddressHostTypeCode is also present.
Item Party Address is a dependent object inclusion node. The dependent object Address includes the data necessary to describe a postal or communication address of a party. Item Business Transaction Document Reference is a reference to a document that is part of a preceding process flow of a business transaction. The elements located directly at the node Item Business Transaction Document Reference are defined by the data type ExportDeclarationRequestItemBusinessTransactionDocumentReferenceElements. These elements include BusinessTransactionDocumentReference and BusinessTransactionDocumentRelationshipRoleCode. BusinessTransactionDocumentReference is a unique identification of a business transaction document related to an export declaration item, and may be based on datatype GDT: BusinessTransactionDocumentReference.
BusinessTransactionDocumentRelationshipRoleCode is a role of a referenced business transaction document in an export declaration item, and may be based on datatype GDT: BusinessTransactionDocumentRelationshipRoleCode. A Customer Invoice Item inbound aggregation relationship may exist from the business object Customer Invoice/node Item Cross DU, with a cardinality of C:CN, which represents an item of a customer invoice from which an item of an export declaration request was created. A CustomerRequirementExternalRequestItem inbound aggregation relationship may exist from the business object Customer Requirement/node External Request Item Cross DU, with a cardinality of C:CN, which represents an item of a customer requirement from which an item of an export declaration request was created. A Outbound Delivery Item inbound aggregation relationship may exist from the business object Outbound Delivery/node Item Cross DU, with a cardinality of C:CN, which represents an item of an outbound delivery from which an item of an export declaration request was created. A PurchaseOrderItem inbound aggregation relationship may exist from the business object Purchase Order/node Item Cross DU, with a cardinality of C:CN, which represents an item of a purchase order from which an item of an export declaration request was created. A Sales Order Item inbound aggregation relationship may exist, from the business object Sales Order/node Item Cross DU, with a cardinality of C:CN, which represents an item of a sales order from which an item of an export declaration request was created. A Service Order Item inbound aggregation relationship may exist from the business object Service Order/node Item Cross DU, with a cardinality of C:CN, which represents an item of a service order from which an item of an export declaration request was created.
Party is a natural or legal person, or a business partner that is involved in an export declaration request. A Party is a natural or legal person, organization, organizational unit or group that is involved in a export declaration request in a PartyRole. A Party can occur in the following disjoint specializations: Buyer Party, such as a party Customer that purchases a good or a service; Seller Party, such as a party Company that sells a good or a service; Product Recipient Party, such as a party Customer that receives a good or a service; and Vendor Party, such as a party Company or Supplier that delivers a good or provides a service. The elements located directly at the node Party are defined by the data type ExportDeclarationRequestPartyElements. These elements include: PartyUUID, PartyKey, PartyTypeCode, PartyID, RoleCategoryCode, RoleCode, and AddressReference. PartyUUID may be optional, is a universally unique identifier of a party, and may be based on datatype GDT: UUID. PartyKey may be optional, is a key of a party in an export declaration request, and may be based on datatype KDT: PartyKey. PartyTypeCode is a coded representation of a type of party, and may be based on datatype GDT: BusinessObjectTypeCode. PartyID is an identifier for a party, and may be based on datatype GDT: PartyID. RoleCategoryCode is a role category of a party in an export declaration request, and may be based on datatype GDT: PartyRoleCategoryCode. RoleCode is a role of a party in an export declaration request, and may be based on datatype GDT: PartyRoleCode. AddressReference may be optional, is a reference to a party's address, and may be based on datatype GDT: PartyAddressReference. A composition relationship to subordinate node Party Address may exist, with a cardinality of 1:C. A Party inbound aggregation relationship may exist from the business object Party/node Party, with a cardinality of C:CN, which may represent one of the following: a vendor that delivers goods to be exported; product recipient to whom goods will be sent; a buyer to whom an invoice will be sent, who is requested to pay for goods and services to be exported; or a seller who was involved in a sales process on which an export declaration request item is based. A specialization association for navigation may exist to dependent business object party address with a target cardinality of C. In some implementations, at least one of the following elements is filled: PartyKey and PartyUUID. In some implementations, if the PartyUUID is specified, the PartyTypeCode is also present. In some implementations, if AddressHostUUID is specified, AddressHostTypeCode is also present.
Party Address is a dependent object inclusion node. The dependent object Address includes the data necessary to describe a postal or communication address of a party. Location is a physical place which is part of an export process in a LocationRole. A location may be a reference to a business object location or a reference to an address. An example location is a location from where goods are shipped. The elements located directly at the node Location are defined by the data type ExportDeclarationRequestLocationElements. These elements include: LocationID, LocationUUID, AddressReference, AddressHostUUID, BusinessObjectTypeCode, AddressHostTypeCode, PartyKey, PartyTypeCode, PartyID, InstalledBaseID, InstallationPointID, RoleCode, and RoleCategoryCode. LocationID is an identifier for a location, and may be based on datatype GDT: LocationID. LocationUUID is a universally unique identifier for a location, and may be based on datatype GDT: UUID. AddressReference may be optional, is a reference to a location address, and may be based on datatype BOIDT: ObjectNodeLocationAddressReference. AddressHostUUID may be optional, is a universally unique identifier for an address of a business partner, an organizational unit or its specializations, the business object InstalledBase, or the business object InstallationPoint, and may be based on datatype GDT: UUID. BusinessObjectTypeCode may be optional, is a coded representation of a type of a business object in which an address referenced in the LocationAddressUUID is integrated as a dependent object, and may be based on datatype GDT: BusinessObjectTypeCode. AddressHostTypeCode may be optional, is a coded representation of an address host type of an address referenced by the AddressUUID or an address included using a Location Address composition, and may be based on datatype GDT: AddressHostTypeCode. PartyKey may be optional, is an alternative identifier of a party representing a business partner or an organizational unit that references an address using the AddressUUID, and may be based on datatype KDT: PartyKey. PartyTypeCode is a coded representation of a type of party, and may be based on datatype GDT: BusinessObjectTypeCode. PartyID is an identifier for a party, and may be based on datatype GDT: PartyID. InstalledBaseID may be optional, is an identifier for an installed base that references an address using the AddressUUID, and may be based on datatype GDT: InstalledBaseID. InstallationPointID may be optional, is an identifier for an installation point that references an address using the AddressUUID, and may be based on datatype GDT: InstallationPointID. RoleCode is a location role of a location, and may be based on datatype GDT: LocationRoleCode. RoleCategoryCode is a location role category of a location, and may be based on datatype GDT: LocationRoleCategoryCode. A composition relationship to subordinate node Location Address may exist, with a cardinality of 1:C. A Location inbound aggregation relationship may exist from the business object Location/node Location, with a cardinality of C:CN, which represents a location from which or to which exported goods will be delivered. A specialization association for navigation may exist to dependent business object party address with a target cardinality of C. In some implementations, there may only be one aggregation or one composition relationship to the dependent object Address. Location Address is a dependent object inclusion node. The dependent object Address includes the data necessary to describe a physical or logical location.
Package is a logical group of one or more package elements. A package element is a physical object in which physical export goods are packed. The elements located directly at a node package are defined by the data type ExportDeclarationRequestpackageElements. These elements include: UUID, ID, TypeCode, packageExportID, ElementNumberValue, ParentpackageUUID, NetWeightQuantity, NetWeightQuantityTypeCode, GrossWeightQuantity, and GrossWeightQuantityTypeCode. Key may be an alternative key, is a key of a package in an export declaration request, and may be based on datatype KDT: ExportDeclarationRequestpackageKey. ExportDeclarationRequestUUID is a universally unique identifier of an export declaration request, and may be based on datatype GDT: UUID. ExportDeclarationRequestpackageID is an internal identifier of a package, and may be based on datatype GDT: ExportDeclarationRequestpackageID. UUID may be an alternative key, is a globally unique identifier of a node, and may be based on datatype GDT: UUID. ID is an internal identifier of a package, and may be based on datatype GDT: ExportDeclarationRequestpackageID. TypeCode is a coded representation of the type of a packing unit as it is used in logistics for storing and shipping goods, and may be based on datatype GDT: packageTypeCode. PackageExportID may be optional, is an identifier of a package for reporting to a customs authority, and may be based on datatype GDT: packageExportID. If the number of package elements in a package is greater than one, this element can include the identifiers of several package elements, for example as an enumeration (e.g., “4711, 4712”) or as a value range (e.g., “4711-4718”). ElementNumberValue is the number of package elements in a package, and may be based on datatype GDT: NumberValue, with a qualifier of Element. ParentpackageUUID may be optional, is a universally unique identification of a parent package, and may be based on datatype GDT: UUID. NetWeightQuantity may be optional, is a net weight of packed goods, and may be based on datatype GDT: Quantity, with a qualifier of Weight. NetWeightQuantityTypeCode may be optional, is a coded representation of the type of the NetWeightQuantity of a package, and may be based on datatype GDT: QuantityTypeCode, with a qualifier of Weight. GrossWeightQuantity may be optional, is a gross weight of the packed goods, and may be based on datatype GDT: Quantity, with a qualifier of Weight. GrossWeightQuantityTypeCode may be optional, is a coded representation of a type of the GrossWeightQuantity of a package, and may be based on datatype GDT: QuantityTypeCode, with a qualifier of Weight. A Package inbound association relationship may exist from the business object Export Declaration Request/node package, with a cardinality of C:CN, which specifies the UUID of a package in which the package is included.
Business Transaction Document Reference is a reference to a business transaction document related to an export. The elements located directly at the node Business Transaction Document Reference are defined by the data type ExportDeclarationRequestBusinessTransactionDocumentReferenceElements. These elements include: BusinessTransactionDocumentReference and BusinessTransactionDocumentRelationshipRoleCode. BusinessTransactionDocumentReference is a unique identification of a business transaction document referenced to in an export declaration request, and may be based on datatype GDT: BusinessTransactionDocumentReference. BusinessTransactionDocumentRelationshipRoleCode is a role of a referenced business transaction document in an export declaration request, and may be based on datatype GDT: BusinessTransactionDocumentRelationshipRoleCode. An Outbound Delivery inbound aggregation relationship may exist from the business object Outbound Delivery/node Outbound Delivery Cross DU, with a cardinality of C:CN, which represents an outbound delivery from which an export declaration request was created.
FIGS. 54-1 through 54-2 depict an example Export Declaration Request Request Message Data Type 54000, which comprises elements 54002-54040, hierarchically related as shown. For example, the Export Declaration Request Request 54002 includes a Message Header 54004.
The message type Export Declaration Request Request is derived from a business object Export Declaration Request as a leading object together with its operation signature. The message type Export Declaration Request Request is a request for an export declaration request. The structure of the message type Export Declaration Request Request is determined by a message data type ExportDeclarationRequestMessage. The message data type ExportDeclarationRequestMessage includes an object ExportDeclarationRequest which is included in a business document, business information that is relevant for sending a business document in a message, the MessageHeader package, and the ExportDeclarationRequest package. This message data type ExportDeclarationRequestMessage provides a structure for the Export Declaration Request Request and for associated operations.
The MessageHeader package is a grouping of business information that is relevant for sending a business document in a message. The MessageHeader package includes the MessageHeader node. The MessageHeader node is a grouping of business information from the perspective of a sending application, such as information to identify the business document in a message, information about the sender, and optionally information about the recipient. The MessageHeader includes SenderParty and RecipientParty. MessageHeader may be based on the datatype GDT:BusinessDocumentMessageHeader. SenderParty is the partner responsible for sending a business document at a business application level. The SenderParty is of the type GDT:BusinessDocumentMessageHeaderParty. RecipientParty is of the type GDT:BusinessDocumentMessageHeaderParty. RecipientParty is the partner responsible for receiving a business document at a business application level.
The ExportDeclarationRequest package is a grouping of ExportDeclarationRequest with Party, Location, BusinessTransactionDocumentReference, Item, and Package packages and with the ExportDeclarationRequest entity. ExportDeclarationRequest is a business transaction document including data that is used to create an export declaration, including data on products, quantities, amounts, packaging, partners, and locations. ExportDeclarationRequest includes the following attributes: ReconciliationPeriodCounterValue and ItemListCompleteTransmissionIndicator. ReconciliationPeriodCounterValue is a counter for a reconciliation period. A reconciliation period is a time between two consecutive reconciliation messages in a same sequence context. ReconciliationPeriodCounterValue may be based on datatype GDT:CounterValue with a qualifier of ReconciliationPeriod. ItemListCompleteTransmissionIndicator specifies whether all the items in a base business document for a CustomerInvoiceRequest are to be transmitted, whether items that are not transmitted are to be implicitly classed as canceled, or whether new items or items that have been changed since a last transmission are to be transmitted. ItemListCompleteTransmissionIndicator may be based on datatype CDT:Indicator with a qualifier of CompleteTransmission.
ExportDeclarationRequest may include the non-node elements BaseBusinessTransactionDocumentTypeCode, ExportDeclarationRequestRequest, Incoterms, TransportModeCode, TransportMeans, TotalNetWeightQuantity, TotalNetWeightQuantityTypeCode, TotalGrossWeightQuantity, TotalGrossWeightQuantityTypeCode, ExportDeclarationBlockIndicator, and ExportDeclarationCancelIndicator. BaseBusinessTransactionDocumentTypeCode is a coded representation of a type of a base business document for a CustomerInvoiceRequest. The types outbound delivery and customer invoice are currently relevant for a message type ExportDeclarationRequestRequest. BaseBusinessTransactionDocumentTypeCode may be based on datatype GDT:BusinessTransactionDocumentTypeCode with a qualifier of Base. Incoterms may be optional, are typical contract formulations for delivery conditions that correspond to rules defined by the International Chamber of Commerce (ICC), and may be based on datatype GDT:Incoterms. TransportModeCode may be optional, is a coded representation of a transport mode of a delivery, and may be based on datatype GDT:TransportModeCode. TransportMeans may be optional, is a description of a means of transport and can also contain information to identify a means of transport, and may be based on datatype GDT:TransportMeans. TotalNetWeightQuantity may be optional, is a total net weight of goods of an export declaration request, and may be based on datatype CDT:Quantity with a qualifier of Weight. TotalNetWeightQuantityTypeCode may be optional, is a coded representation of a type of a NetWeightQuantity of an export declaration request, and may be based on datatype GDT:QuantityTypeCode with a qualifier of Weight. TotalGrossWeightQuantity may be optional, is a total gross weight of goods of an export declaration request, and may be based on datatype CDT:Quantity with a qualifier of Weight. TotalGrossWeightQuantityTypeCode may be optional, is a coded representation of a type of a GrossWeightQuantity of an export declaration request, and may be based on datatype GDT:QuantityTypeCode with a qualifier of Weight. ExportDeclarationBlockIndicator may be optional, indicates that processing of the requested export declaration may be blocked, and may be based on datatype CDT:Indicator with a qualifier of Block. ExportDeclarationCancelIndicator may be optional, indicates that a requested export declaration may be cancelled, and may be based on datatype CDT:Indicator with a qualifier of Cancel.
ExportDeclarationRequest may include the node element VendorParty in a 1:C cardinality relationship, the node element ProductRecipientParty in a 1:C cardinality relationship, the node element SellerParty in a 1:C cardinality relationship, the node element BuyerParty in a 1:C cardinality relationship, the node element ShipFromLocation in a 1:C cardinality relationship, the node element ShipToLocation in a 1:C cardinality relationship, the node element OutboundDeliveryReference in a 1:1 cardinality relationship, the node element Package in a 1:CN cardinality relationship, and the node element Item in a 1:N cardinality relationship.
The Party package includes the VendorParty, ProductRecipientParty, SellerParty, and BuyerParty entities. VendorParty is a company or person that delivers goods. VendorParty may be typed by BusinessTransactionDocumentParty. ProductRecipientParty is a company or person to which goods are to be delivered and may be typed by datatype BusinessTransactionDocumentParty. SellerParty is a company or person who sells goods and may be typed by datatype datatype BusinessTransactionDocumentParty. BuyerParty is a company or person who purchases goods and may be typed by datatype BusinessTransactionDocumentParty.
The Location package includes the ShipFromLocation entity. ShipToLocation is a location from which goods are shipped. ShipFromLocation may be typed by datatype BusinessTransactionDocumentLocation. ShipToLocation is a location to which goods are shipped. ShipToLocation may be typed by datatype BusinessTransactionDocumentLocation.
The BusinessTransactionDocumentReference package includes the OutboundDeliveryReference entity. OutboundDeliveryReference is a reference to a delivery. OutboundDeliveryReference may be typed by datatype BusinessTransactionDocumentReference. The Package package includes the Package entity. Package includes information about packages used in an underlying outbound delivery, including information about a type of package, weight, and hierarchy. Package includes the following non-node elements: OrdinalNumber, TypeCode, PackageExportID, ElementNumberValue, ParentPackageOrdinalNumber, NetWeightQuantity, NetWeightQuantityTypeCode, GrossWeightQuantity, and GrossWeightQuantityTypeCode. OrdinalNumber may be based on datatype GDT:OrdinalNumberValue. TypeCode may be based on datatype GDT:PackageTypeCode. PackageExportID may be optional and may be based on datatype GDT:PackageExportID. ElementNumberValue may be based on datatype GDT:NumberValue. ParentPackageOrdinalNumber may be optional and may be based on datatype GDT:OrdinalNumberValue. NetWeightQuantity may be optional, is a net weight of packed goods, and may be based on datatype CDT:Quantity with a qualifier of Weight. NetWeightQuantityTypeCode may be optional, is a coded representation of a type of a NetWeightQuantity of a package, and may be based on datatype GDT:QuantityTypeCode with a qualifier of Weight. GrossWeightQuantity may be optional, is a gross weight of packed goods, and may be based on datatype CDT:Quantity with a qualifier of Weight. GrossWeightQuantityTypeCode may be optional, is a coded representation of a type of a GrossWeightQuantity of a package, and may be based on datatype GDT:QuantityTypeCode with a qualifier of Weight.
The Item package includes the Item entity. An ExportDeclarationRequestItem summarizes information from a business document item that is to be taken into account in a future settlement. ExportDeclarationRequestItem may include information about a quantity of a product that is to be exported, such as amount, weight, and related business documents. Item includes the following non-node elements: Description, Quantity, QuantityTypeCode, NetWeightQuantity, NetWeightQuantityTypeCode, GrossWeightQuantity, GrossWeightQuantityTypeCode, InvoiceNetAmount, CustomerInvoiceRequiredIndicator, and ExportDeclarationBlockIndicator.
Description may be optional and may be based on datatype GDT:SHORT_Description. Quantity is an item's quantity and may be based on datatype CDT:Quantity. QuantityTypeCode is a coded representation of an item's quantity type and may be based on datatype GDT:QuantityTypeCode. NetWeightQuantity may be optional, is a net weight of goods of an export declaration request item, and may be based on datatype CDT:Quantity with a qualifier of Weight. NetWeightQuantityTypeCode may be optional, is a coded representation of a type of a NetWeightQuantity of an export declaration request item, and may be based on datatype GDT:QuantityTypeCode with a qualifier of Weight. GrossWeightQuantity may be optional, is a gross weight of goods of an export declaration request item, and may be based on datatype CDT:Quantity with a qualifier of Weight. GrossWeightQuantityTypeCode may be optional, is a coded representation of a type of a GrossWeightQuantity of an export declaration request item, and may be based on datatype GDT:QuantityTypeCode with a qualifier of Weight. InvoiceNetAmount may be optional, is a net value of an invoice item, and may be based on datatype CDT:Amount. CustomerInvoiceRequiredIndicator may be optional, indicates that an export declaration request based on a customer invoice is required to complete an export declaration, and may be based on datatype CDT:Indicator with a qualifier of Required. ExportDeclarationBlockIndicator may be optional, indicates that processing of a requested export declaration may be blocked, and may be based on datatype CDT:Indicator with a qualifier of Block.
Description may include the node element Product in a 1:C cardinality relationship. the node element PackageAssignment in a 1:C cardinality relationship, the node element OutboundDeliveryReference in a 1:1 cardinality relationship, the node element CustomerInvoiceReference in a 1:CN cardinality relationship, the node element SalesOrderReference in a 1:C cardinality relationship, the node element IntraCompanyStockTransferRequirementReference in a 1:C cardinality relationship, the node element ServiceOrderReference in a 1:C cardinality relationship, and the node element PurchaseOrderReference in a 1:C cardinality relationship.
The ItemProductInformation package includes the Product entity. Product identifies, describes, and classifies a product for which an export declaration is requested. Product is typed by datatype BusinessTransactionDocumentProduct. A product may be specified when a line item instance is not a grouping or unplanned delivery costs. The ItemPackage package includes the PackageAssignment entity. PackageAssignment represents packages assigned to an item. PackageAssignment includes the following non-node elements: PackageOrdinalNumber, ProductQuantity, and ProductQuantityTypeCode. PackageOrdinalNumber may be based on datatype GDT:OrdinalNumberValue. ProductQuantity may be optional, is a quantity of product of an item assigned to a package, and may be based on datatype CDT:Quantity with a qualifier of Product. ProductQuantityTypeCode may be optional, is a coded representation of a type of a ProductQuantity of an item assigned to a package, and may be based on datatype GDT: QuantityTypeCode with a qualifier of Product.
The ItemBusinessTransactionDocumentReference package includes the OutboundDeliveryReference, CustomerInvoiceReference, SalesOrderReference, IntraCompanyStockTransferRequirementReference, ServiceOrderReference, and PurchaseOrderReference entities. OutboundDeliveryReference is a reference to a delivery item and may be typed by datatype BusinessTransactionDocumentReference. CustomerInvoiceReference is a reference to a customer invoice item and may be typed by datatype BusinessTransactionDocumentReference. SalesOrderReference is a reference to a sales order item and may be typed by datatype BusinessTransactionDocumentReference. IntraCompanyStockTransferRequirementReference is a reference to a stock transfer order item and may be typed by datatype BusinessTransactionDocumentReference. ServiceOrderReference is a reference to a service order item and may be typed by datatype BusinessTransactionDocumentReference. PurchaseOrderReference is a reference to a purchase order item and may be typed by datatype BusinessTransactionDocumentReference.
FIGS. 55-1 through 55-167 show an example configuration of an Element Structure that includes an ExportDeclarationRequestRequest 550000 package. Specifically, these figures depict the arrangement and hierarchy of various components such as one or more levels of packages, entities, and datatypes, shown here as 550000 through 555520. As described above, packages may be used to represent hierarchy levels. Entities are discrete business elements that are used during a business transaction. Data types are used to type object entities and interfaces with a structure. For example, the ExportDeclarationRequestRequest 550000 includes, among other things, an ExportDeclarationRequestRequest 550002. Accordingly, heterogeneous applications may communicate using this consistent message configured as such.
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.

## Claims

1. A non-transitory computer readable medium including program code for providing a message-based interface for exchanging information regarding a declaration to a customs authority for exporting goods according to legal requirements, the medium comprising:
program code for receiving via a message-based interface derived from a common business object model, where the common business object model includes business objects having relationships that enable derivation of message-based interfaces and message packages, the message-based interface exposing at least one service as defined in a service registry and from a heterogeneous application executing in an environment of computer systems providing message-based services, a first message for a request for processing an export declaration that includes a first message package derived from the common business object model and hierarchically organized in memory as:
an export declaration processing request message entity; and
an export declaration package, where the export declaration package includes an export declaration entity, a custom authorization package, and a customs office package, where the export declaration entity includes an export message subtype code, an export message identification (ID), a customs authority country code, and a major version customs authority ID, where the custom authorization package includes at least one customs authorization entity, each customs authorization entity including a customer authorization type code and a customs authorization ID, and where the customs office package includes at least one customs office entity;

program code for processing the first message according to the hierarchical organization of the first message package, where processing the first message includes unpacking the first message package based on the common business object model; and
program code for sending a second message to the heterogeneous application responsive to the first message, where the second message includes a second message package derived from the common business object model to provide consistent semantics with the first message package.

2. The computer readable medium of claim 1, wherein the export declaration package further comprises at least one of the following: a time point package, a basic text package, a location package, a party package, a transport route country package, and an item package.

3. The computer readable medium of claim 1, wherein the export declaration entity comprises at least one of the following: an export message sub type code, an export message identifier (ID), an export message reference ID, a customs authority country code, a major version customs authority ID, a minor version customs authority ID, a main test case ID, a sub test case ID, a customs message exchange server file ID, a customs process ID, a customs process party ID, a customs process customs authority ID, an export declaration type code, an export type code, an export exporting country code, an export destination country code, an export special circumstances code, an export transport cost payment form code, a container used indicator, an export party representation code, an item total number value, a total gross weight quantity, a total gross weight quantity type code, a consignment export ID, an inland export transport mode code, a cross border export transport mode code, a cross border export transport means type code, a cross border transport means ID, an export cross border transport means nationality code, an export business transaction type code, an invoice total net amount, an export incoterms classification code, an export incoterms classification description, an export incoterms transfer location name, and a customs authentication ID.

4. A distributed system operating in a plurality of computer systems providing message-based services defined in a service registry, the system comprising:
at least one processor operable to execute computer readable instructions embodied on non-transitory media;
a graphical user interface executable by the at least one processor and comprising computer readable instructions, embedded on non-transitory media, for a request for processing an export declaration using a request;
a first memory storing a user interface controller executable by the at least one processor for processing the request and involving a message including a message package derived from a common business object model, where the common business object model includes business objects having relationships that enable derivation of message-based service interfaces and message packages, the message package hierarchically organized as:
an export declaration processing request message header entity; and
an export declaration package, where the export declaration package includes an export declaration entity, a custom authorization package, and a customs office package, where the export declaration entity includes an export message subtype code, an export message identification (ID), a customs authority country code, and a major version customs authority ID, where the custom authorization package includes at least one customs authorization entity, each customs authorization entity including a customer authorization type code and a customs authorization ID, and where the customs office package includes at least one customs office entity; and

a second memory, remote from the graphical user interface, storing a plurality of message-based service interfaces executable by the at least one processor and derived from the common business object model to provide consistent semantics with messages derived from the common business object model, where one of the message-based service interfaces processes the message according to the hierarchical organization of the message package, where processing the message includes unpacking the first message package based on the common business object model.

5. The distributed system of claim 4, wherein the first memory is remote from the graphical user interface.

6. The distributed system of claim 4, wherein the first memory is remote from the second memory.

7. A non-transitory computer readable medium including program code for providing a message-based interface for exchanging information for a request to create or update an export declaration using customs-relevant business transactions, the medium comprising:
program code for receiving via a message-based interface derived from a common business object model, where the common business object model includes business objects having relationships that enable derivation of message-based interfaces and message packages, the message-based interface exposing at least one service as defined in a service registry and from a heterogeneous application executing in an environment of computer systems providing message-based services, a first message for a request for an export declaration request that includes a first message package derived from the common business object model and hierarchically organized in memory as:
an export declaration request request message entity; and
an export declaration request package comprising an export declaration request entity, where the export declaration request entity includes a reconciliation period counter value, an item list complete transmission indicator, a base business transaction document type code, an export declaration block indicator, and an export declaration cancel indicator;

program code for processing the first message according to the hierarchical organization of the first message package, where processing the first message includes unpacking the first message package based on the common business object model; and
program code for sending a second message to the heterogeneous application responsive to the first message, where the second message includes a second message package derived from the common business object model to provide consistent semantics with the first message package.

8. The computer readable medium of claim 7, wherein the export declaration request package further comprises at least one of the following: a party package, a location package, a business transaction document reference package, a package package, and an item package.

9. The computer readable medium of claim 7, wherein the export declaration request entity comprises at least one of the following: an incoterms, a transport mode code, a transport means, a total net weight quantity, a total net weight quantity type code, a total gross weight quantity, and a total gross weight quantity type code.

10. A distributed system operating in a plurality of computer systems providing message-based services defined in a service registry, the system comprising:
at least one processor operable to execute computer readable instructions embodied on non-transitory media;
a graphical user interface executable by the at least one processor and comprising computer readable instructions, embedded on non-transitory media, for a request for an export declaration request using a request;
a first memory storing a user interface controller executable by the at least one processor and for processing the request and involving a message including a message package derived from a common business object model, where the common business object model includes business objects having relationships that enable derivation of message-based service interfaces and message packages, the message package hierarchically organized as:
an export declaration request request message entity; and
an export declaration request package comprising an export declaration request entity, where the export declaration request entity includes a reconciliation period counter value, an item list complete transmission indicator, a base business transaction document type code, an export declaration block indicator, and an export declaration cancel indicator; and

a second memory, remote from the graphical user interface, storing a plurality of message-based service interfaces executable by the at least one processor and derived from the common business object model to provide consistent semantics with messages derived from the common business object model, where one of the message-based service interfaces processes the message according to the hierarchical organization of the message package, where processing the message includes unpacking the first message package based on the common business object model.

11. The distributed system of claim 10, wherein the first memory is remote from the graphical user interface.

12. The distributed system of claim 10, wherein the first memory is remote from the second memory.