Some details of the subject matter of this specification are described in previously-filed U.S. patent application Ser. No. 11/803,178, entitled “Consistent Set of Interfaces Derived From a Business Object Model”, filed on May 11, 2007, which is hereby incorporated by reference.
A portion of the disclosure of this patent document contains material which is subject to copyright protection. The copyright owner has no objection to the facsimile reproduction by anyone of the patent document or the patent disclosure, as it appears in the Patent and Trademark Office patent file or records, but otherwise reserves all copyright rights whatsoever.
The subject matter described herein relates generally to the generation and use of consistent interfaces (or services) derived from a business object model. More particularly, the present disclosure relates to the generation and use of consistent interfaces or services that are suitable for use across industries, across businesses, and across different departments within a business.
Transactions are common among businesses and between business departments within a particular business. During any given transaction, these business entities exchange information. For example, during a sales transaction, numerous business entities may be involved, such as a sales entity that sells merchandise to a customer, a financial institution that handles the financial transaction, and a warehouse that sends the merchandise to the customer. The end-to-end business transaction may require a significant amount of information to be exchanged between the various business entities involved. For example, the customer may send a request for the merchandise as well as some form of payment authorization for the merchandise to the sales entity, and the sales entity may send the financial institution a request for a transfer of funds from the customer's account to the sales entity's account.
Exchanging information between different business entities is not a simple task. This is particularly true because the information used by different business entities is usually tightly tied to the business entity itself. Each business entity may have its own program for handling its part of the transaction. These programs differ from each other because they typically are created for different purposes and because each business entity may use semantics that differ from the other business entities. For example, one program may relate to accounting, another program may relate to manufacturing, and a third program may relate to inventory control. Similarly, one program may identify merchandise using the name of the product while another program may identify the same merchandise using its model number. Further, one business entity may use U.S. dollars to represent its currency while another business entity may use Japanese Yen. A simple difference in formatting, e.g., the use of upper-case lettering rather than lower-case or title-case, makes the exchange of information between businesses a difficult task. Unless the individual businesses agree upon particular semantics, human interaction typically is required to facilitate transactions between these businesses. Because these “heterogeneous” programs are used by different companies or by different business areas within a given company, a need exists for a consistent way to exchange information and perform a business transaction between the different business entities.
Currently, many standards exist that offer a variety of interfaces used to exchange business information. Most of these interfaces, however, apply to only one specific industry and are not consistent between the different standards. Moreover, a number of these interfaces are not consistent within an individual standard.
In a first aspect, a computer-readable medium includes program code for providing a message-based interface for exchanging information about appointment activities. The medium comprises program code for receiving, via a 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 requesting to maintain an appointment activity bundle, including information about planned and unplanned activities maintained in a calendar of an employee of a company, the information including information about external appointments and scheduled meetings with business partners. The first message includes a message package hierarchically organized as an appointment activity bundle maintain request sync message entity and an appointment activity package including at least one appointment activity entity. Each appointment activity entity includes an organizer party entity. The medium further comprises program code for sending a second message to the heterogeneous application responsive to the first message.
Implementations can include the following. Each appointment activity entity further includes at least one of the following: a location name entity, at least one attendee party entity, an employee responsible party entity, a main activity party entity, an activity unit party entity, at least one business transaction document reference entity, at least one text entity, an attachment folder entity, and at least one reference party. Each appointment activity entity further includes at least one of the following: an object node sender technical identifier (ID), a change state ID, an ID, a universally unique identifier (UUID), a migrated data adaptation type code, a name, a priority code, an initiator code, an information sensitivity code, a group code, a data origin type code, a life cycle status code, a start date time, an end date time, a full day indicator, a completion date time, an activity follow up service request blocking reason code, and a groupware item 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 requesting to maintain an appointment activity bundle, including information about planned and unplanned activities maintained in a calendar of an employee of a company, the information including information about external appointments and scheduled meetings with business partners, the instructions 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 hierarchically organized as an appointment activity bundle maintain request sync message entity and an appointment activity package including at least one appointment activity entity. Each appointment activity entity includes an organizer party entity. The system further comprises a second memory, remote from the graphical user interface, storing a plurality of service interfaces, wherein one of the service interfaces is operable to process the message via the service interface.
Implementations can include the following. The first memory is remote from the graphical user interface. The first memory is remote from the second memory.
A. Overview
Methods and systems consistent with the subject matter described herein facilitate e-commerce by providing consistent interfaces that are suitable for use across industries, across businesses, and across different departments within a business during a business transaction. To generate consistent interfaces, methods and systems consistent with the subject matter described herein utilize a business object model, which reflects the data that will be used during a given business transaction. An example of a business transaction is the exchange of purchase orders and order confirmations between a buyer and a seller. The business object model is generated in a hierarchical manner to ensure that the same type of data is represented the same way throughout the business object model. This ensures the consistency of the information in the business object model. Consistency is also reflected in the semantic meaning of the various structural elements. That is, each structural element has a consistent business meaning. For example, the location entity, regardless of in which package it is located, refers to a location.
From this business object model, various interfaces are derived to accomplish the functionality of the business transaction. Interfaces provide an entry point for components to access the functionality of an application. For example, the interface for a Purchase Order Request provides an entry point for components to access the functionality of a Purchase Order, in particular, to transmit and/or receive a Purchase Order Request. One skilled in the art will recognize that each of these interfaces may be provided, sold, distributed, utilized, or marketed as a separate product or as a major component of a separate product. Alternatively, a group of related interfaces may be provided, sold, distributed, utilized, or marketed as a product or as a major component of a separate product. Because the interfaces are generated from the business object model, the information in the interfaces is consistent, and the interfaces are consistent among the business entities. Such consistency facilitates heterogeneous business entities in cooperating to accomplish the business transaction.
Generally, the business object is a representation of a type of a uniquely identifiable business entity (an object instance) described by a structural model. In the architecture, processes may typically operate on business objects. Business objects represent a specific view on some well-defined business content. In other words, business objects represent content, which a typical business user would expect and understand with little explanation. Business objects are further categorized as business process objects and master data objects. A master data object is an object that encapsulates master data (i.e., data that is valid for a period of time). A business process object, which is the kind of business object generally found in a process component, is an object that encapsulates transactional data (i.e., data that is valid for a point in time). The term business object will be used generically to refer to a business process object and a master data object, unless the context requires otherwise. Properly implemented, business objects are implemented free of redundancies.
The architectural elements also include the process component. The process component is a software package that realizes a business process and generally exposes its functionality as services. The functionality contains business transactions. In general, the process component contains one or more semantically related business objects. Often, a particular business object belongs to no more than one process component. Interactions between process component pairs involving their respective business objects, process agents, operations, interfaces, and messages are described as process component interactions, which generally determine the interactions of a pair of process components across a deployment unit boundary. Interactions between process components within a deployment unit are typically not constrained by the architectural design and can be implemented in any convenient fashion. Process components may be modular and context-independent. In other words, process components may not be specific to any particular application and as such, may be reusable. In some implementations, the process component is the smallest (most granular) element of reuse in the architecture. An external process component is generally used to represent the external system in describing interactions with the external system; however, this should be understood to require no more of the external system than that able to produce and receive messages as required by the process component that interacts with the external system. For example, process components may include multiple operations that may provide interaction with the external system. Each operation generally belongs to one type of process component in the architecture. Operations can be synchronous or asynchronous, corresponding to synchronous or asynchronous process agents, which will be described below. The operation is often the smallest, separately-callable function, described by a set of data types used as input, output, and fault parameters serving as a signature.
The architectural elements may also include the service interface, referred to simply as the interface. The interface is a named group of operations. The interface often belongs to one process component and process component might contain multiple interfaces. In one implementation, the service interface contains only inbound or outbound operations, but not a mixture of both. One interface can contain both synchronous and asynchronous operations. Normally, operations of the same type (either inbound or outbound) which belong to the same message choreography will belong to the same interface. Thus, generally, all outbound operations to the same other process component are in one interface.
The architectural elements also include the message. Operations transmit and receive messages. Any convenient messaging infrastructure can be used. A message is information conveyed from one process component instance to another, with the expectation that activity will ensue. Operation can use multiple message types for inbound, outbound, or error messages. When two process components are in different deployment units, invocation of an operation of one process component by the other process component is accomplished by the operation on the other process component sending a message to the first process component.
The architectural elements may also include the process agent. Process agents do business processing that involves the sending or receiving of messages. Each operation normally has at least one associated process agent. Each process agent can be associated with one or more operations. Process agents can be either inbound or outbound and either synchronous or asynchronous. Asynchronous outbound process agents are called after a business object changes such as after a “create”, “update”, or “delete” of a business object instance. Synchronous outbound process agents are generally triggered directly by business object. An outbound process agent will generally perform some processing of the data of the business object instance whose change triggered the event. The outbound agent triggers subsequent business process steps by sending messages using well-defined outbound services to another process component, which generally will be in another deployment unit, or to an external system. The outbound process agent is linked to the one business object that triggers the agent, but it is sent not to another business object but rather to another process component. Thus, the outbound process agent can be implemented without knowledge of the exact business object design of the recipient process component. Alternatively, the process agent may be inbound. For example, inbound process agents may be used for the inbound part of a message-based communication. Inbound process agents are called after a message has been received. The inbound process agent starts the execution of the business process step requested in a message by creating or updating one or multiple business object instances. Inbound process agent is not generally the agent of business object but of its process component. Inbound process agent can act on multiple business objects in a process component. Regardless of whether the process agent is inbound or outbound, an agent may be synchronous if used when a process component requires a more or less immediate response from another process component, and is waiting for that response to continue its work.
The architectural elements also include the deployment unit. Each deployment unit may include one or more process components that are generally deployed together on a single computer system platform. Conversely, separate deployment units can be deployed on separate physical computing systems. The process components of one deployment unit can interact with those of another deployment unit using messages passed through one or more data communication networks or other suitable communication channels. Thus, a deployment unit deployed on a platform belonging to one business can interact with a deployment unit software entity deployed on a separate platform belonging to a different and unrelated business, allowing for business-to-business communication. More than one instance of a given deployment unit can execute at the same time, on the same computing system or on separate physical computing systems. This arrangement allows the functionality offered by the deployment unit to be scaled to meet demand by creating as many instances as needed.
Since interaction between deployment units is through process component operations, one deployment unit can be replaced by other another deployment unit as long as the new deployment unit supports the operations depended upon by other deployment units as appropriate. Thus, while deployment units can depend on the external interfaces of process components in other deployment units, deployment units are not dependent on process component interaction within other deployment units. Similarly, process components that interact with other process components or external systems only through messages, e.g., as sent and received by operations, can also be replaced as long as the replacement generally supports the operations of the original.
Services (or interfaces) may be provided in a flexible architecture to support varying criteria between services and systems. The flexible architecture may generally be provided by a service delivery business object. The system may be able to schedule a service asynchronously as necessary, or on a regular basis. Services may be planned according to a schedule manually or automatically. For example, a follow-up service may be scheduled automatically upon completing an initial service. In addition, flexible execution periods may be possible (e.g. hourly, daily, every three months, etc.). Each customer may plan the services on demand or reschedule service execution upon request.
After creating the business scenario, the developers add details to each step of the business scenario (step 104). In particular, for each step of the business scenario, the developers identify the complete process steps performed by each business entity. A discrete portion of the business scenario reflects a “business transaction,” and each business entity is referred to as a “component” of the business transaction. The developers also identify the messages that are transmitted between the components. A “process interaction model” represents the complete process steps between two components.
After creating the process interaction model, the developers create a “message choreography” (step 106), which depicts the messages transmitted between the two components in the process interaction model. The developers then represent the transmission of the messages between the components during a business process in a “business document flow” (step 108). Thus, the business document flow illustrates the flow of information between the business entities during a business process.
During the Contract transaction 220, the SRM 214 sends a Source of Supply Notification 232 to the SCP 210. This step is optional, as illustrated by the optional control line 230 coupling this step to the remainder of the business document flow 200. During the Ordering transaction 222, the SCP 210 sends a Purchase Requirement Request 234 to the FC 212, which forwards a Purchase Requirement Request 236 to the SRM 214. The SRM 214 then sends a Purchase Requirement Confirmation 238 to the FC 212, and the FC 212 sends a Purchase Requirement Confirmation 240 to the SCP 210. The SRM 214 also sends a Purchase Order Request 242 to the Supplier 216, and sends Purchase Order Information 244 to the FC 212. The FC 212 then sends a Purchase Order Planning Notification 246 to the SCP 210. The Supplier 216, after receiving the Purchase Order Request 242, sends a Purchase Order Confirmation 248 to the SRM 214, which sends a Purchase Order Information confirmation message 254 to the FC 212, which sends a message 256 confirming the Purchase Order Planning Notification to the SCP 210. The SRM 214 then sends an Invoice Due Notification 258 to Invoicing 206.
During the Delivery transaction 224, the FC 212 sends a Delivery Execution Request 260 to the SCE 208. The Supplier 216 could optionally (illustrated at control line 250) send a Dispatched Delivery Notification 252 to the SCE 208. The SCE 208 then sends a message 262 to the FC 212 notifying the FC 212 that the request for the Delivery Information was created. The FC 212 then sends a message 264 notifying the SRM 214 that the request for the Delivery Information was created. The FC 212 also sends a message 266 notifying the SCP 210 that the request for the Delivery Information was created. The SCE 208 sends a message 268 to the FC 212 when the goods have been set aside for delivery. The FC 212 sends a message 270 to the SRM 214 when the goods have been set aside for delivery. The FC 212 also sends a message 272 to the SCP 210 when the goods have been set aside for delivery.
The SCE 208 sends a message 274 to the FC 212 when the goods have been delivered. The FC 212 then sends a message 276 to the SRM 214 indicating that the goods have been delivered, and sends a message 278 to the SCP 210 indicating that the goods have been delivered. The SCE 208 then sends an Inventory Change Accounting Notification 280 to Accounting 202, and an Inventory Change Notification 282 to the SCP 210. The FC 212 sends an Invoice Due Notification 284 to Invoicing 206, and SCE 208 sends a Received Delivery Notification 286 to the Supplier 216.
During the Billing/Payment transaction 226, the Supplier 216 sends an Invoice Request 287 to Invoicing 206. Invoicing 206 then sends a Payment Due Notification 288 to Payment 204, a Tax Due Notification 289 to Payment 204, an Invoice Confirmation 290 to the Supplier 216, and an Invoice Accounting Notification 291 to Accounting 202. Payment 204 sends a Payment Request 292 to the Bank 218, and a Payment Requested Accounting Notification 293 to Accounting 202. Bank 218 sends a Bank Statement Information 296 to Payment 204. Payment 204 then sends a Payment Done Information 294 to Invoicing 206 and a Payment Done Accounting Notification 295 to Accounting 202.
Within a business document flow, business documents having the same or similar structures are marked. For example, in the business document flow 200 depicted in
From the business document flow, the developers identify the business documents having identical or similar structures, and use these business documents to create the business object model (step 110). The business object model includes the objects contained within the business documents. These objects are reflected as packages containing related information, and are arranged in a hierarchical structure within the business object model, as discussed below.
Methods and systems consistent with the subject matter described herein then generate interfaces from the business object model (step 112). The heterogeneous programs use instantiations of these interfaces (called “business document objects” below) to create messages (step 114), which are sent to complete the business transaction (step 116). Business entities use these messages to exchange information with other business entities during an end-to-end business transaction. Since the business object model is shared by heterogeneous programs, the interfaces are consistent among these programs. The heterogeneous programs use these consistent interfaces to communicate in a consistent manner, thus facilitating the business transactions.
Standardized Business-to-Business (“B2B”) messages are compliant with at least one of the e-business standards (i.e., they include the business-relevant fields of the standard). The e-business standards include, for example, RosettaNet for the high-tech industry, Chemical Industry Data Exchange (“CIDX”), Petroleum Industry Data Exchange (“PIDX”) for the oil industry, UCCnet for trade, PapiNet for the paper industry, Odette for the automotive industry, HR-XML for human resources, and XML Common Business Library (“xCBL”). Thus, B2B messages enable simple integration of components in heterogeneous system landscapes. Application-to-Application (“A2A”) messages often exceed the standards and thus may provide the benefit of the full functionality of application components. Although various steps of
B. Implementation Details
As discussed above, methods and systems consistent with the subject matter described herein create consistent interfaces by generating the interfaces from a business object model. Details regarding the creation of the business object model, the generation of an interface from the business object model, and the use of an interface generated from the business object model are provided below.
Turning to the illustrated embodiment in
As illustrated (but not required), the server 302 is communicably coupled with a relatively remote repository 335 over a portion of the network 312. The repository 335 is any electronic storage facility, data processing center, or archive that may supplement or replace local memory (such as 327). The repository 335 may be a central database communicably coupled with the one or more servers 302 and the clients 304 via a virtual private network (VPN), SSH (Secure Shell) tunnel, or other secure network connection. The repository 335 may be physically or logically located at any appropriate location including in one of the example enterprises or off-shore, so long as it remains operable to store information associated with the environment 300 and communicate such data to the server 302 or at least a subset of plurality of the clients 304.
Illustrated server 302 includes local memory 327. Memory 327 may include any memory or database module and may take the form of volatile or non-volatile memory including, without limitation, magnetic media, optical media, random access memory (RAM), read-only memory (ROM), removable media, or any other suitable local or remote memory component. Illustrated memory 327 includes an exchange infrastructure (“XI”) 314, which is an infrastructure that supports the technical interaction of business processes across heterogeneous system environments. XI 314 centralizes the communication between components within a business entity and between different business entities. When appropriate, XI 314 carries out the mapping between the messages. XI 314 integrates different versions of systems implemented on different platforms (e.g., Java and ABAP). XI 314 is based on an open architecture, and makes use of open standards, such as eXtensible Markup Language (XML)™ and Java environments. XI 314 offers services that are useful in a heterogeneous and complex system landscape. In particular, XI 314 offers a runtime infrastructure for message exchange, configuration options for managing business processes and message flow, and options for transforming message contents between sender and receiver systems.
XI 314 stores data types 316, a business object model 318, and interfaces 320. The details regarding the business object model are described below. Data types 316 are the building blocks for the business object model 318. The business object model 318 is used to derive consistent interfaces 320. XI 314 allows for the exchange of information from a first company having one computer system to a second company having a second computer system over network 312 by using the standardized interfaces 320.
While not illustrated, memory 327 may also include business objects and any other appropriate data such as services, interfaces, VPN applications or services, firewall policies, a security or access log, print or other reporting files, HTML files or templates, data classes or object interfaces, child software applications or sub-systems, and others. This stored data may be stored in one or more logical or physical repositories. In some embodiments, the stored data (or pointers thereto) may be stored in one or more tables in a relational database described in terms of SQL statements or scripts. In the same or other embodiments, the stored data may also be formatted, stored, or defined as various data structures in text files, XML documents, Virtual Storage Access Method (VSAM) files, flat files, Btrieve files, comma-separated-value (CSV) files, internal variables, or one or more libraries. For example, a particular data service record may merely be a pointer to a particular piece of third party software stored remotely. In another example, a particular data service may be an internally stored software object usable by authenticated customers or internal development. In short, the stored data may comprise one table or file or a plurality of tables or files stored on one computer or across a plurality of computers in any appropriate format. Indeed, some or all of the stored data may be local or remote without departing from the scope of this disclosure and store any type of appropriate data.
Server 302 also includes processor 325. Processor 325 executes instructions and manipulates data to perform the operations of server 302 such as, for example, a central processing unit (CPU), a blade, an application specific integrated circuit (ASIC), or a field-programmable gate array (FPGA). Although
At a high level, business application 330 is any application, program, module, process, or other software that utilizes or facilitates the exchange of information via messages (or services) or the use of business objects. For example, application 330 may implement, utilize or otherwise leverage an enterprise service-oriented architecture (enterprise SOA), which may be considered a blueprint for an adaptable, flexible, and open IT architecture for developing services-based, enterprise-scale business solutions. This example enterprise service may be a series of web services combined with business logic that can be accessed and used repeatedly to support a particular business process. Aggregating web services into business-level enterprise services helps provide a more meaningful foundation for the task of automating enterprise-scale business scenarios Put simply, enterprise services help provide a holistic combination of actions that are semantically linked to complete the specific task, no matter how many cross-applications are involved. In certain cases, environment 300 may implement a composite application 330, as described below in
More specifically, as illustrated in
Returning to
Network 312 facilitates wireless or wireline communication between computer server 302 and any other local or remote computer, such as clients 304. Network 312 may be all or a portion of an enterprise or secured network. In another example, network 312 may be a VPN merely between server 302 and client 304 across wireline or wireless link. Such an example wireless link may be via 802.11a, 802.11b, 802.11g, 802.20, WiMax, and many others. While illustrated as a single or continuous network, network 312 may be logically divided into various sub-nets or virtual networks without departing from the scope of this disclosure, so long as at least portion of network 312 may facilitate communications between server 302 and at least one client 304. For example, server 302 may be communicably coupled to one or more “local” repositories through one sub-net while communicably coupled to a particular client 304 or “remote” repositories through another. In other words, network 312 encompasses any internal or external network, networks, sub-network, or combination thereof operable to facilitate communications between various computing components in environment 300. Network 312 may communicate, for example, Internet Protocol (IP) packets, Frame Relay frames, Asynchronous Transfer Mode (ATM) cells, voice, video, data, and other suitable information between network addresses. Network 312 may include one or more local area networks (LANs), radio access networks (RANs), metropolitan area networks (MANs), wide area networks (WANs), all or a portion of the global computer network known as the Internet, and/or any other communication system or systems at one or more locations. In certain embodiments, network 312 may be a secure network associated with the enterprise and certain local or remote vendors 306 and customers 308. As used in this disclosure, customer 308 is any person, department, organization, small business, enterprise, or any other entity that may use or request others to use environment 300. As described above, vendors 306 also may be local or remote to customer 308. Indeed, a particular vendor 306 may provide some content to business application 330, while receiving or purchasing other content (at the same or different times) as customer 308. As illustrated, customer 308 and vendor 06 each typically perform some processing (such as uploading or purchasing content) using a computer, such as client 304.
Client 304 is any computing device operable to connect or communicate with server 302 or network 312 using any communication link. For example, client 304 is intended to encompass a personal computer, touch screen terminal, workstation, network computer, kiosk, wireless data port, smart phone, personal data assistant (PDA), one or more processors within these or other devices, or any other suitable processing device used by or for the benefit of business 308, vendor 306, or some other user or entity. At a high level, each client 304 includes or executes at least GUI 336 and comprises an electronic computing device operable to receive, transmit, process and store any appropriate data associated with environment 300. It will be understood that there may be any number of clients 304 communicably coupled to server 302. Further, “client 304,” “business,” “business analyst,” “end user,” and “user” may be used interchangeably as appropriate without departing from the scope of this disclosure. Moreover, for ease of illustration, each client 304 is described in terms of being used by one user. But this disclosure contemplates that many users may use one computer or that one user may use multiple computers. For example, client 304 may be a PDA operable to wirelessly connect with external or unsecured network. In another example, client 304 may comprise a laptop that includes an input device, such as a keypad, touch screen, mouse, or other device that can accept information, and an output device that conveys information associated with the operation of server 302 or clients 304, including digital data, visual information, or GUI 336. Both the input device and output device may include fixed or removable storage media such as a magnetic computer disk, CD-ROM, or other suitable media to both receive input from and provide output to users of clients 304 through the display, namely the client portion of GUI or application interface 336.
GUI 336 comprises a graphical user interface operable to allow the user of client 304 to interface with at least a portion of environment 300 for any suitable purpose, such as viewing application or other transaction data. Generally, GUI 336 provides the particular user with an efficient and user-friendly presentation of data provided by or communicated within environment 300. For example, GUI 336 may present the user with the components and information that is relevant to their task, increase reuse of such components, and facilitate a sizable developer community around those components. GUI 336 may comprise a plurality of customizable frames or views having interactive fields, pull-down lists, and buttons operated by the user. For example, GUI 336 is operable to display data involving business objects and interfaces in a user-friendly form based on the user context and the displayed data. In another example, GUI 336 is operable to display different levels and types of information involving business objects and interfaces based on the identified or supplied user role. GUI 336 may also present a plurality of portals or dashboards. For example, GUI 336 may display a portal that allows users to view, create, and manage historical and real-time reports including role-based reporting and such. Of course, such reports may be in any appropriate output format including PDF, HTML, and printable text. Real-time dashboards often provide table and graph information on the current state of the data, which may be supplemented by business objects and interfaces. It should be understood that the term graphical user interface may be used in the singular or in the plural to describe one or more graphical user interfaces and each of the displays of a particular graphical user interface. Indeed, reference to GUI 336 may indicate a reference to the front-end or a component of business application 330, as well as the particular interface accessible via client 304, as appropriate, without departing from the scope of this disclosure. Therefore, GUI 336 contemplates any graphical user interface, such as a generic web browser or touchscreen, that processes information in environment 300 and efficiently presents the results to the user. Server 302 can accept data from client 304 via the web browser (e.g., Microsoft Internet Explorer or Netscape Navigator) and return the appropriate HTML or XML responses to the browser using network 312.
More generally in environment 300 as depicted in
Various components of the present disclosure may be modeled using a model-driven environment. For example, the model-driven framework or environment may allow the developer to use simple drag-and-drop techniques to develop pattern-based or freestyle user interfaces and define the flow of data between them. The result could be an efficient, customized, visually rich online experience. In some cases, this model-driven development may accelerate the application development process and foster business-user self-service. It further enables business analysts or IT developers to compose visually rich applications that use analytic services, enterprise services, remote function calls (RFCs), APIs, and stored procedures. In addition, it may allow them to reuse existing applications and create content using a modeling process and a visual user interface instead of manual coding.
According to some embodiments, a modeler (or other analyst) may use the model-driven modeling environment 516 to create pattern-based or freestyle user interfaces using simple drag-and-drop services. Because this development may be model-driven, the modeler can typically compose an application using models of business objects without having to write much, if any, code. In some cases, this example modeling environment 516 may provide a personalized, secure interface that helps unify enterprise applications, information, and processes into a coherent, role-based portal experience. Further, the modeling environment 516 may allow the developer to access and share information and applications in a collaborative environment. In this way, virtual collaboration rooms allow developers to work together efficiently, regardless of where they are located, and may enable powerful and immediate communication that crosses organizational boundaries while enforcing security requirements. Indeed, the modeling environment 516 may provide a shared set of services for finding, organizing, and accessing unstructured content stored in third-party repositories and content management systems across various networks 312. Classification tools may automate the organization of information, while subject-matter experts and content managers can publish information to distinct user audiences. Regardless of the particular implementation or architecture, this modeling environment 516 may allow the developer to easily model hosted business objects 140 using this model-driven approach.
In certain embodiments, the modeling environment 516 may implement or utilize a generic, declarative, and executable GUI language (generally described as XGL). This example XGL is generally independent of any particular GUI framework or runtime platform. Further, XGL is normally not dependent on characteristics of a target device on which the graphic user interface is to be displayed and may also be independent of any programming language. XGL is used to generate a generic representation (occasionally referred to as the XGL representation or XGL-compliant representation) for a design-time model representation. The XGL representation is thus typically a device-independent representation of a GUI. The XGL representation is declarative in that the representation does not depend on any particular GUI framework, runtime platform, device, or programming language. The XGL representation can be executable and therefore can unambiguously encapsulate execution semantics for the GUI described by a model representation. In short, models of different types can be transformed to XGL representations.
The XGL representation may be used for generating representations of various different GUIs and supports various GUI features including full windowing and componentization support, rich data visualizations and animations, rich modes of data entry and user interactions, and flexible connectivity to any complex application data services. While a specific embodiment of XGL is discussed, various other types of XGLs may also be used in alternative embodiments. In other words, it will be understood that XGL is used for example description only and may be read to include any abstract or modeling language that can be generic, declarative, and executable.
Turning to the illustrated embodiment in
Illustrated modeling environment 516 also includes an abstract representation generator (or XGL generator) 504 operable to generate an abstract representation (for example, XGL representation or XGL-compliant representation) 506 based upon model representation 502. Abstract representation generator 504 takes model representation 502 as input and outputs abstract representation 506 for the model representation. Model representation 502 may include multiple instances of various forms or types depending on the tool/language used for the modeling. In certain cases, these various different model representations may each be mapped to one or more abstract representations 506. Different types of model representations may be transformed or mapped to XGL representations. For each type of model representation, mapping rules may be provided for mapping the model representation to the XGL representation 506. Different mapping rules may be provided for mapping a model representation to an XGL representation.
This XGL representation 506 that is created from a model representation may then be used for processing in the runtime environment. For example, the XGL representation 506 may be used to generate a machine-executable runtime GUI (or some other runtime representation) that may be executed by a target device. As part of the runtime processing, the XGL representation 506 may be transformed into one or more runtime representations, which may indicate source code in a particular programming language, machine-executable code for a specific runtime environment, executable GUI, and so forth, which may be generated for specific runtime environments and devices. Since the XGL representation 506, rather than the design-time model representation, is used by the runtime environment, the design-time model representation is decoupled from the runtime environment. The XGL representation 506 can thus serve as the common ground or interface between design-time user interface modeling tools and a plurality of user interface runtime frameworks. It provides a self-contained, closed, and deterministic definition of all aspects of a graphical user interface in a device-independent and programming-language independent manner. Accordingly, abstract representation 506 generated for a model representation 502 is generally declarative and executable in that it provides a representation of the GUI of model representation 502 that is not dependent on any device or runtime platform, is not dependent on any programming language, and unambiguously encapsulates execution semantics for the GUI. The execution semantics may include, for example, identification of various components of the GUI, interpretation of connections between the various GUI components, information identifying the order of sequencing of events, rules governing dynamic behavior of the GUI, rules governing handling of values by the GUI, and the like. The abstract representation 506 is also not GUI runtime-platform specific. The abstract representation 506 provides a self-contained, closed, and deterministic definition of all aspects of a graphical user interface that is device independent and language independent.
Abstract representation 506 is such that the appearance and execution semantics of a GUI generated from the XGL representation work consistently on different target devices irrespective of the GUI capabilities of the target device and the target device platform. For example, the same XGL representation may be mapped to appropriate GUIs on devices of differing levels of GUI complexity (i.e., the same abstract representation may be used to generate a GUI for devices that support simple GUIs and for devices that can support complex GUIs), the GUI generated by the devices are consistent with each other in their appearance and behavior.
Abstract representation generator 504 may be configured to generate abstract representation 506 for models of different types, which may be created using different modeling tools 340. It will be understood that modeling environment 516 may include some, none, or other sub-modules or components as those shown in this example illustration. In other words, modeling environment 516 encompasses the design-time environment (with or without the abstract generator or the various representations), a modeling toolkit (such as 340) linked with a developer's space, or any other appropriate software operable to decouple models created during design-time from the runtime environment. Abstract representation 506 provides an interface between the design time environment and the runtime environment. As shown, this abstract representation 506 may then be used by runtime processing.
As part of runtime processing, modeling environment 516 may include various runtime tools 508 and may generate different types of runtime representations based upon the abstract representation 506. Examples of runtime representations include device or language-dependent (or specific) source code, runtime platform-specific machine-readable code, GUIs for a particular target device, and the like. The runtime tools 508 may include compilers, interpreters, source code generators, and other such tools that are configured to generate runtime platform-specific or target device-specific runtime representations of abstract representation 506. The runtime tool 508 may generate the runtime representation from abstract representation 506 using specific rules that map abstract representation 506 to a particular type of runtime representation. These mapping rules may be dependent on the type of runtime tool, characteristics of the target device to be used for displaying the GUI, runtime platform, and/or other factors. Accordingly, mapping rules may be provided for transforming the abstract representation 506 to any number of target runtime representations directed to one or more target GUI runtime platforms. For example, XGL-compliant code generators may conform to semantics of XGL, as described below. XGL-compliant code generators may ensure that the appearance and behavior of the generated user interfaces is preserved across a plurality of target GUI frameworks, while accommodating the differences in the intrinsic characteristics of each and also accommodating the different levels of capability of target devices.
For example, as depicted in example
It should be apparent that abstract representation 506 may be used to generate GUIs for Extensible Application Markup Language (XAML) or various other runtime platforms and devices. The same abstract representation 506 may be mapped to various runtime representations and device-specific and runtime platform-specific GUIs. In general, in the runtime environment, machine executable instructions specific to a runtime environment may be generated based upon the abstract representation 506 and executed to generate a GUI in the runtime environment. The same XGL representation may be used to generate machine executable instructions specific to different runtime environments and target devices.
According to certain embodiments, the process of mapping a model representation 502 to an abstract representation 506 and mapping an abstract representation 506 to some runtime representation may be automated. For example, design tools may automatically generate an abstract representation for the model representation using XGL and then use the XGL abstract representation to generate GUIs that are customized for specific runtime environments and devices. As previously indicated, mapping rules may be provided for mapping model representations to an XGL representation. Mapping rules may also be provided for mapping an XGL representation to a runtime platform-specific representation.
Since the runtime environment uses abstract representation 506 rather than model representation 502 for runtime processing, the model representation 502 that is created during design-time is decoupled from the runtime environment. Abstract representation 506 thus provides an interface between the modeling environment and the runtime environment. As a result, changes may be made to the design time environment, including changes to model representation 502 or changes that affect model representation 502, generally to not substantially affect or impact the runtime environment or tools used by the runtime environment. Likewise, changes may be made to the runtime environment generally to not substantially affect or impact the design time environment. A designer or other developer can thus concentrate on the design aspects and make changes to the design without having to worry about the runtime dependencies such as the target device platform or programming language dependencies.
One or more runtime representations 550a, including GUIs for specific runtime environment platforms, may be generated from abstract representation 506. A device-dependent runtime representation may be generated for a particular type of target device platform to be used for executing and displaying the GUI encapsulated by the abstract representation. The GUIs generated from abstract representation 506 may comprise various types of GUI elements such as buttons, windows, scrollbars, input boxes, etc. Rules may be provided for mapping an abstract representation to a particular runtime representation. Various mapping rules may be provided for different runtime environment platforms.
Methods and systems consistent with the subject matter described herein provide and use interfaces 320 derived from the business object model 318 suitable for use with more than one business area, for example different departments within a company such as finance, or marketing. Also, they are suitable across industries and across businesses. Interfaces 320 are used during an end-to-end business transaction to transfer business process information in an application-independent manner. For example the interfaces can be used for fulfilling a sales order.
1. Message Overview
To perform an end-to-end business transaction, consistent interfaces are used to create business documents that are sent within messages between heterogeneous programs or modules.
a) Message Categories
As depicted in
(1) Information
Information 606 is a message sent from a sender 602 to a recipient 604 concerning a condition or a statement of affairs. No reply to information is expected. Information 606 is sent to make business partners or business applications aware of a situation. Information 606 is not compiled to be application-specific. Examples of “information” are an announcement, advertising, a report, planning information, and a message to the business warehouse.
(2) Notification
A notification 608 is a notice or message that is geared to a service. A sender 602 sends the notification 608 to a recipient 604. No reply is expected for a notification. For example, a billing notification relates to the preparation of an invoice while a dispatched delivery notification relates to preparation for receipt of goods.
(3) Query
A query 610 is a question from a sender 602 to a recipient 604 to which a response 612 is expected. A query 610 implies no assurance or obligation on the part of the sender 602. Examples of a query 610 are whether space is available on a specific flight or whether a specific product is available. These queries do not express the desire for reserving the flight or purchasing the product.
(4) Response
A response 612 is a reply to a query 610. The recipient 604 sends the response 612 to the sender 602. A response 612 generally implies no assurance or obligation on the part of the recipient 604. The sender 602 is not expected to reply. Instead, the process is concluded with the response 612. Depending on the business scenario, a response 612 also may include a commitment, i.e., an assurance or obligation on the part of the recipient 604. Examples of responses 612 are a response stating that space is available on a specific flight or that a specific product is available. With these responses, no reservation was made.
(5) Request
A request 614 is a binding requisition or requirement from a sender 602 to a recipient 604. Depending on the business scenario, the recipient 604 can respond to a request 614 with a confirmation 616. The request 614 is binding on the sender 602. In making the request 614, the sender 602 assumes, for example, an obligation to accept the services rendered in the request 614 under the reported conditions. Examples of a request 614 are a parking ticket, a purchase order, an order for delivery and a job application.
(6) Confirmation
A confirmation 616 is a binding reply that is generally made to a request 614. The recipient 604 sends the confirmation 616 to the sender 602. The information indicated in a confirmation 616, such as deadlines, products, quantities and prices, can deviate from the information of the preceding request 614. A request 614 and confirmation 616 may be used in negotiating processes. A negotiating process can consist of a series of several request 614 and confirmation 616 messages. The confirmation 616 is binding on the recipient 604. For example, 100 units of X may be ordered in a purchase order request; however, only the delivery of 80 units is confirmed in the associated purchase order confirmation.
b) Message Choreography
A message choreography is a template that specifies the sequence of messages between business entities during a given transaction. The sequence with the messages contained in it describes in general the message “lifecycle” as it proceeds between the business entities. If messages from a choreography are used in a business transaction, they appear in the transaction in the sequence determined by the choreography. This illustrates the template character of a choreography, i.e., during an actual transaction, it is not necessary for all messages of the choreography to appear. Those messages that are contained in the transaction, however, follow the sequence within the choreography. A business transaction is thus a derivation of a message choreography. The choreography makes it possible to determine the structure of the individual message types more precisely and distinguish them from one another.
2. Components of the Business Object Model
The overall structure of the business object model ensures the consistency of the interfaces that are derived from the business object model. The derivation ensures that the same business-related subject matter or concept is represented and structured in the same way in all interfaces.
The business object model defines the business-related concepts at a central location for a number of business transactions. In other words, it reflects the decisions made about modeling the business entities of the real world acting in business transactions across industries and business areas. The business object model is defined by the business objects and their relationship to each other (the overall net structure).
Each business object is generally a capsule with an internal hierarchical structure, behavior offered by its operations, and integrity constraints. Business objects are semantically disjoint, i.e., the same business information is represented once. In the business object model, the business objects are arranged in an ordering framework. From left to right, they are arranged according to their existence dependency to each other. For example, the customizing elements may be arranged on the left side of the business object model, the strategic elements may be arranged in the center of the business object model, and the operative elements may be arranged on the right side of the business object model. Similarly, the business objects are arranged from the top to the bottom based on defined order of the business areas, e.g., finance could be arranged at the top of the business object model with CRM below finance and SRM below CRM.
To ensure the consistency of interfaces, the business object model may be built using standardized data types as well as packages to group related elements together, and package templates and entity templates to specify the arrangement of packages and entities within the structure.
a) Data Types
Data types are used to type object entities and interfaces with a structure. This typing can include business semantic. Such data types may include those generally described at pages 96 through 1642 (which are incorporated by reference herein) of U.S. patent application Ser. No. 11/803,178, filed on May 11, 2007 and entitled “Consistent Set Of Interfaces Derived From A Business Object Model”. For example, the data type BusinessTransactionDocumentID is a unique identifier for a document in a business transaction. Also, as an example, Data type BusinessTransactionDocumentParty contains the information that is exchanged in business documents about a party involved in a business transaction, and includes the party's identity, the party's address, the party's contact person and the contact person's address. BusinessTransactionDocumentParty also includes the role of the party, e.g., a buyer, seller, product recipient, or vendor.
The data types are based on Core Component Types (“CCTs”), which themselves are based on the World Wide Web Consortium (“W3C”) data types. “Global” data types represent a business situation that is described by a fixed structure. Global data types include both context-neutral generic data types (“GDTs”) and context-based context data types (“CDTs”). GDTs contain business semantics, but are application-neutral, i.e., without context. CDTs, on the other hand, are based on GDTs and form either a use-specific view of the GDTs, or a context-specific assembly of GDTs or CDTs. A message is typically constructed with reference to a use and is thus a use-specific assembly of GDTs and CDTs. The data types can be aggregated to complex data types.
To achieve a harmonization across business objects and interfaces, the same subject matter is typed with the same data type. For example, the data type “GeoCoordinates” is built using the data type “Measure” so that the measures in a GeoCoordinate (i.e., the latitude measure and the longitude measure) are represented the same as other “Measures” that appear in the business object model.
b) Entities
Entities are discrete business elements that are used during a business transaction. Entities are not to be confused with business entities or the components that interact to perform a transaction. Rather, “entities” are one of the layers of the business object model and the interfaces. For example, a Catalogue entity is used in a Catalogue Publication Request and a Purchase Order is used in a Purchase Order Request. These entities are created using the data types defined above to ensure the consistent representation of data throughout the entities.
c) Packages
Packages group the entities in the business object model and the resulting interfaces into groups of semantically associated information. Packages also may include “sub”-packages, i.e., the packages may be nested.
Packages may group elements together based on different factors, such as elements that occur together as a rule with regard to a business-related aspect. For example, as depicted in
Packages also may combine different components that result in a new object. For example, as depicted in
Another grouping within a package may be subtypes within a type. In these packages, the components are specialized forms of a generic package. For example, as depicted in
Packages also may be used to represent hierarchy levels. For example, as depicted in
Packages can be represented in the XML schema as a comment. One advantage of this grouping is that the document structure is easier to read and is more understandable. The names of these packages are assigned by including the object name in brackets with the suffix “Package.” For example, as depicted in
d) Relationships
Relationships describe the interdependencies of the entities in the business object model, and are thus an integral part of the business object model.
(1) Cardinality of Relationships
(2) Types of Relationships
(a) Composition
A composition or hierarchical relationship type is a strong whole-part relationship which is used to describe the structure within an object. The parts, or dependent entities, represent a semantic refinement or partition of the whole, or less dependent entity. For example, as depicted in
(b) Aggregation
An aggregation or an aggregating relationship type is a weak whole-part relationship between two objects. The dependent object is created by the combination of one or several less dependent objects. For example, as depicted in
(c) Association
An association or a referential relationship type describes a relationship between two objects in which the dependent object refers to the less dependent object. For example, as depicted in
(3) Specialization
Entity types may be divided into subtypes based on characteristics of the entity types. For example,
Subtypes may be defined based on related attributes. For example, although ships and cars are both vehicles, ships have an attribute, “draft,” that is not found in cars. Subtypes also may be defined based on certain methods that can be applied to entities of this subtype and that modify such entities. For example, “drop anchor” can be applied to ships. If outgoing relationships to a specific object are restricted to a subset, then a subtype can be defined which reflects this subset.
As depicted in
e) Structural Patterns
(1) Item
An item is an entity type which groups together features of another entity type. Thus, the features for the entity type chart of accounts are grouped together to form the entity type chart of accounts item. For example, a chart of accounts item is a category of values or value flows that can be recorded or represented in amounts of money in accounting, while a chart of accounts is a superordinate list of categories of values or value flows that is defined in accounting.
The cardinality between an entity type and its item is often either 1:n or 1:cn. For example, in the case of the entity type chart of accounts, there is a hierarchical relationship of the cardinality 1:n with the entity type chart of accounts item since a chart of accounts has at least one item in all cases.
(2) Hierarchy
A hierarchy describes the assignment of subordinate entities to superordinate entities and vice versa, where several entities of the same type are subordinate entities that have, at most, one directly superordinate entity. For example, in the hierarchy depicted in
Because each entity has at most one superordinate entity, the cardinality between a subordinate entity and its superordinate entity is 1:c. Similarly, each entity may have 0, 1 or many subordinate entities. Thus, the cardinality between a superordinate entity and its subordinate entity is 1:cn.
3. Creation of the Business Object Model
As discussed above, the designers create message choreographies that specify the sequence of messages between business entities during a transaction. After identifying the messages, the developers identify the fields contained in one of the messages (step 2100,
Next, the designers determine the proper name for the object according to the ISO 11179 naming standards (step 2104). In the example above, the proper name for the “Main Object” is “Purchase Order.” After naming the object, the system that is creating the business object model determines whether the object already exists in the business object model (step 2106). If the object already exists, the system integrates new attributes from the message into the existing object (step 2108), and the process is complete.
If at step 2106 the system determines that the object does not exist in the business object model, the designers model the internal object structure (step 2110). To model the internal structure, the designers define the components. For the above example, the designers may define the components identified below.
During the step of modeling the internal structure, the designers also model the complete internal structure by identifying the compositions of the components and the corresponding cardinalities, as shown below.
After modeling the internal object structure, the developers identify the subtypes and generalizations for all objects and components (step 2112). For example, the Purchase Order may have subtypes Purchase Order Update, Purchase Order Cancellation and Purchase Order Information. Purchase Order Update may include Purchase Order Request, Purchase Order Change, and Purchase Order Confirmation. Moreover, Party may be identified as the generalization of Buyer and Seller. The subtypes and generalizations for the above example are shown below.
After identifying the subtypes and generalizations, the developers assign the attributes to these components (step 2114). The attributes for a portion of the components are shown below.
The system then determines whether the component is one of the object nodes in the business object model (step 2116,
During the integration step, the designers classify the relationship (i.e., aggregation or association) between the object node and the object being integrated into the business object model. The system also integrates the new attributes into the object node (step 2120). If at step 2116, the system determines that the component is not in the business object model, the system adds the component to the business object model (step 2122).
Regardless of whether the component was in the business object model at step 2116, the next step in creating the business object model is to add the integrity rules (step 2124). There are several levels of integrity rules and constraints which should be described. These levels include consistency rules between attributes, consistency rules between components, and consistency rules to other objects. Next, the designers determine the services offered, which can be accessed via interfaces (step 2126). The services offered in the example above include PurchaseOrderCreateRequest, PurchaseOrderCancellationRequest, and PurchaseOrderReleaseRequest. The system then receives an indication of the location for the object in the business object model (step 2128). After receiving the indication of the location, the system integrates the object into the business object model (step 2130).
4. Structure of the Business Object Model
The business object model, which serves as the basis for the process of generating consistent interfaces, includes the elements contained within the interfaces. These elements are arranged in a hierarchical structure within the business object model.
5. Interfaces Derived from Business Object Model
Interfaces are the starting point of the communication between two business entities. The structure of each interface determines how one business entity communicates with another business entity. The business entities may act as a unified whole when, based on the business scenario, the business entities know what an interface contains from a business perspective and how to fill the individual elements or fields of the interface. As illustrated in
As illustrated in
To illustrate the hierarchization process,
For example, object A 27016, object B 27018, and object C 27020 have information that characterize object X. Because object A 27016, object B 27018, and object C 27020 are superordinate to leading object X 27014, the dependencies of these relationships change so that object A 27016, object B 27018, and object C 27020 become dependent and subordinate to leading object X 27014. This procedure is known as “derivation of the business document object by hierarchization.”
Business-related objects generally have an internal structure (parts). This structure can be complex and reflect the individual parts of an object and their mutual dependency. When creating the operation signature, the internal structure of an object is strictly hierarchized. Thus, dependent parts keep their dependency structure, and relationships between the parts within the object that do not represent the hierarchical structure are resolved by prioritizing one of the relationships.
Relationships of object X to external objects that are referenced and whose information characterizes object X are added to the operation signature. Such a structure can be quite complex (see, for example,
The newly created business document object contains all required information, including the incorporated master data information of the referenced objects. As depicted in
The following provides certain rules that can be adopted singly or in combination with regard to the hierarchization process. 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.
Package templates specify the arrangement of packages within a business transaction document. Package templates are used to define the overall structure of the messages sent between business entities. Methods and systems consistent with the subject matter described herein use package templates in conjunction with the business object model to derive the interfaces.
The system also receives an indication of the message type from the designer (step 2202). The system selects a package from the package template (step 2204), and receives an indication from the designer whether the package is required for the interface (step 2206). If the package is not required for the interface, the system removes the package from the package template (step 2208). The system then continues this analysis for the remaining packages within the package template (step 2210).
If, at step 2206, the package is required for the interface, the system copies the entity template from the package in the business object model into the package in the package template (step 2212,
At step 2210, after the system completes its analysis for the packages within the package template, the system selects one of the packages remaining in the package template (step 2218,
If, at step 2222, the entity is required for the interface, the system retrieves the cardinality between a superordinate entity and the entity from the business object model (step 2230,
The system then selects a leading object from the package template (step 2240,
The system then selects an entity that is subordinate to the leading object (step 2250,
6. Use of an Interface
The XI stores the interfaces (as an interface type). At runtime, the sending party's program instantiates the interface to create a business document, and sends the business document in a message to the recipient. The messages are preferably defined using XML. In the example depicted in
From the component's perspective, the interface is represented by an interface proxy 2400, as depicted in
When the message arrives, the recipient's inbound proxy 2508 calls its component-specific method 2514 for creating a document. The proxy 2508 at the receiving end downloads the data and converts the XML structure into the internal data structure of the recipient component 2504 for further processing.
As depicted in
In collaborative processes as well as Q&A processes, messages should refer to documents from previous messages. A simple business document object ID or object ID is insufficient to identify individual messages uniquely because several versions of the same business document object can be sent during a transaction. A business document object ID with a version number also is insufficient because the same version of a business document object can be sent several times. Thus, messages require several identifiers during the course of a transaction.
As depicted in
The administrative information in the business document message header 2624 of the payload or business document 2620 includes a BusinessDocumentMessageID (“ID3”) 2628. The business entity or component 2632 of the business entity manages and sets the BusinessDocumentMessageID 2628. The business entity or component 2632 also can refer to other business documents using the BusinessDocumentMessageID 2628. The receiving component 2632 requires no knowledge regarding the structure of this ID. The BusinessDocumentMessageID 2628 is, as an ID, unique. Creation of a message refers to a point in time. No versioning is typically expressed by the ID. Besides the BusinessDocumentMessageID 2628, there also is a business document object ID 2630, which may include versions.
The component 2632 also adds its own component object ID 2634 when the business document object is stored in the component. The component object ID 2634 identifies the business document object when it is stored within the component. However, not all communication partners may be aware of the internal structure of the component object ID 2634. Some components also may include a versioning in their ID 2634.
7. Use of Interfaces Across Industries
Methods and systems consistent with the subject matter described herein provide interfaces that may be used across different business areas for different industries. Indeed, the interfaces derived using methods and systems consistent with the subject matter described herein may be mapped onto the interfaces of different industry standards. Unlike the interfaces provided by any given standard that do not include the interfaces required by other standards, methods and systems consistent with the subject matter described herein provide a set of consistent interfaces that correspond to the interfaces provided by different industry standards. Due to the different fields provided by each standard, the interface from one standard does not easily map onto another standard. By comparison, to map onto the different industry standards, the interfaces derived using methods and systems consistent with the subject matter described herein include most of the fields provided by the interfaces of to different industry standards. Missing fields may easily be included into the business object model. Thus, by derivation, the interfaces can be extended consistently by these fields. Thus, methods and systems consistent with the subject matter described herein provide consistent interfaces or services that can be used across different industry standards.
For example,
Accordingly, the third layer 2903 separates the inherent data of the first layer 2901 and the technologies used to access the inherent data. As a result of the described structure, the business object reveals only an interface that includes a set of clearly defined methods. Thus, applications access the business object via those defined methods. An application wanting access to the business object and the data associated therewith usually includes the information or data to execute the clearly defined methods of the business object's interface. Such clearly defined methods of the business object's interface represent the business object's behavior. That is, when the methods are executed, the methods may change the business object's data. Therefore, an application may utilize any business object by providing the information or data without having any concern for the details related to the internal operation of the business object. Returning to method 2800, a service provider class and data dictionary elements are generated within a development environment at step 2803. In step 2804, the service provider class is implemented within the development environment.
Regardless of the particular hardware or software architecture used, the disclosed systems or software are generally capable of implementing business objects and deriving (or otherwise utilizing) consistent interfaces that are suitable for use across industries, across businesses, and across different departments within a business in accordance with some or all of the following description. In short, system 100 contemplates using any appropriate combination and arrangement of logical elements to implement some or all of the described functionality.
Moreover, the preceding flowcharts and accompanying description illustrate example methods. The present services environment contemplates using or implementing any suitable technique for performing these and other tasks. It will be understood that these methods are for illustration purposes only and that the described or similar techniques may be performed at any appropriate time, including concurrently, individually, or in combination. In addition, many of the steps in these flowcharts may take place simultaneously and/or in different orders than as shown. Moreover, the services environment may use methods with additional steps, fewer steps, and/or different steps, so long as the methods remain appropriate.
The business object Appointment Activity is a planned or unplanned activity that is maintained in a calendar of an employee of a company. The business object Appointment Activity includes external appointments and scheduled meetings with other business partners. An appointment usually includes information regarding the business partner involved, the date on which the appointment is to take place, and whether it is related to business or is private in nature. The Appointment Activity business object belongs to the process component Activity Management. The Appointment Activity business object belongs to the deployment unit Foundation. The Appointment Activity business object is a projection of Activity_Template.
An activity template is a template for business transaction documents within activity management which represents interactions and tasks undertaken by employees on behalf of a company. In some implementations, a template is not a business object in a business sense. That is, a template might not be included in a business object map and might not be used in any process component as a business object. In some implementations, a template is not instantiated. A template can be used to ensure the consistency, integrity, and reusability of business objects that are derived from the template. The following business objects are derived from the activity template using projection: Appointment Activity, Email Activity, Letter Activity, Fax Activity, Phone Call Activity, Activity TO (Task Object), and Activity Task. The business object Appointment Activity has an object category of Business Transaction Document and a technical category of Standard Business Object.
The business object Appointment Activity is involved in the following Process Component Interactions: Activity Management_Standard Based Groupware_Calendar Event, Activity Processing_External Activity Processing_Appointment Replication, External Activity Management_Activity Management, External Activity Management_Activity Management_Manage Appointment Activity, External Activity Management_Activity Management_Query Appointment Activity, External Activity Processing_Activity Processing_Appointment Replication, and Standard Based Groupware_Activity Management_Calendar Event.
A service interface Appointment Activity Replication Confirmation Initiated by External Out has a technical name of AppointmentActivityReplicationConfirmationInitiatedByExternalOut, and is part of the process component interaction External Activity Processing_Activity Processing_Appointment Replication. An operation Process Appointment Activity Replication Confirmation has a technical name of
AppointmentActivityReplicationConfirmationInitiatedByExternalOut.ProcessAppointmentActivityReplicationConfirmation, and can be based on a message type Appointment
Activity Replication Confirmation that is derived from the business object Appointment Activity.
A service interface Appointment Activity Bulk Replication Confirmation In has a technical name of AppointmentActivityBulkReplicationConfirmationIn and is part of the process component interaction Activity Processing_External Activity Processing_Appointment Replication. An operation Process Appointment Activity Replication Confirmation has a technical name of AppointmentActivityBulkReplicationConfirmationIn.ProcessAppointmentActivityReplicationConfirmation, and can be based on a message type Appointment Activity Replication Confirmation that is derived from the business object Appointment Activity.
A service interface Appointment Replication Initiated by External In has a technical name of AppointmentReplicationInitiatedByExternalIn is part of the process component interaction External Activity Processing_Activity Processing_Appointment Replication, and is an interface to replicate an appointment initiated by an external system. A Replicate Appointment operation has a technical name of AppointmentReplicationInitiatedByExternalIn.ReplicateAppointment, is an operation that replicates an Appointment Activity, and is based on a message type Appointment Activity Replication Request that is derived from the business object Appointment Activity.
A service interface Appointment Replication Out has a technical name of AppointmentReplicationOut, is part of the process component interaction Activity Processing_External Activity Processing_Appointment Replication, and is an interface to replicate an appointment. A Request Appointment Replication operation has a technical name of AppointmentReplicationOut.RequestAppointmentReplication, and is based on a message type Appointment Activity Replication Request that is derived from the business object Appointment Activity.
A service interface Calendar Event Notification In has a technical name of ActivityManagementCalendarEventNotificationIn, is part of the process component interaction Standard Based Groupware_Activity Management_Calendar Event, and is an interface to create, change, or cancel appointment activities. A Cancel Activity operation has a technical name of ActivityManagementCalendarEventNotificationIn.CancelActivity, can be used to cancel an appointment activity, and is based on the message type Calendar Event Cancellation Notification. A Maintain Activity operation has a technical name of ActivityManagementCalendarEventNotificationIn.MaintainActivity, can be used to create or change an appointment activity, and is based on a message type Calendar Event Notification.
A service interface Calendar Event Notification Out has a technical name of ActivityManagementCalendarEventNotificationOut, is part of the process component interaction Activity Management_Standard Based Groupware_Calendar Event, and is an interface to notify of a creation, change, or cancelation of an appointment activity. A Notify of Calendar Event operation has a technical name of ActivityManagementCalendarEventNotificationOut.NotifyOfCalendarEvent, can be used to notify of a creation or change of an appointment activity, and is based on the message type Calendar Event Notification. A Notify of Calendar Event Cancellation has a technical name of ActivityManagementCalendarEventNotificationOut.NotifyOfCalendarEventCancellation, can be used to notify of a cancelation of an appointment activity, and is based on a message type Calendar Event Cancellation Notification.
A service interface Manage Appointment Activity In has a technical name of ManageAppointmentActivityIn, and is part of the following process component interactions: External Activity Management_Activity Management, and External Activity Management_Activity Management_Manage Appointment Activity. service interface Manage Appointment Activity In is an interface to replicate appointment activity data from a source system or file to a target system. A Manage Appointment Activity In Check Maintain as Bundle operation has a technical name of ManageAppointmentActivityIn.CheckMaintainBundle, can be used to check whether one or more appointment activities can be maintained using imported structured data, and can be based on a message type Appointment Activity Confirmation Bundle Check Maintain Response_sync that is derived from the business object Appointment Activity and on a message type Appointment Activity Request Bundle Check Maintain Query_sync that is derived from the business object Appointment Activity. A Manage Appointment Activity In Check Maintain as Bundle operation has a technical name of ManageAppointmentActivityIn.CheckMaintainBundle, can be used to check if an appointment activity can be created, updated, or deleted without errors, and can be based on a message type Appointment Activity Confirmation Bundle Check Maintain Response_sync that is derived from the business object Appointment Activity and on a message type Appointment Activity Request Bundle Check Maintain Query_sync that is derived from the business object Appointment Activity. An operation Manage Appointment Activity In Maintain as Bundle has a technical name of ManageAppointmentActivityIn.MaintainBundle, can be used to maintain one or more appointment activities using imported structured data, and is based on a message type Appointment Activity Bundle Maintain Confirmation_sync that is derived from the business object Appointment Activity and on a message type Appointment Activity Bundle Maintain Request_sync that is derived from the business object Appointment Activity. An operation Manage AppointmentActivity In Maintain as Bundle has a technical name of ManageAppointmentActivityIn.MaintainBundle, can be used to create, update, or delete Appointment Activities, and is based on a message type Appointment Activity Bundle Maintain Confirmation_sync that is derived from the business object Appointment Activity and on a message type Appointment Activity Bundle Maintain Request_sync that is derived from the business object Appointment Activity.
A service interface Query Appointment Activity In has a technical name of QueryAppointmentActivityIn, is part of the process component interaction External Activity Management_Activity Management_Query Appointment Activity, and is an interface to query appointment activity data. A Find By Elements operation has a technical name of QueryAppointmentActivityIn.FindByElements, can be used to find appointment activities, and is based on a message type AppointmentActivity By Elements Query_Sync that is derived from the business object Appointment Activity and on a message type AppointmentActivity By Elements Response_sync that is derived from the business object Appointment Activity.
A service interface ZactivityAppointmentOutbound has a technical name of ZactivityAppointmentOutbound. A ZreplicateActivityAppointment operation has a technical name of ZActivityAppointmentOutbound.ZreplicateActivityAppointment, and is based on a message type ZActivityAppointmentOutboundMessageType that is derived from the business object Appointment Activity.
The business object Appointment Activity can include a root mode. As mentioned, an Appointment Activity can represent an interaction or task used in activity management that is undertaken by employees on behalf of a company. The Appointment Activity root node can include the priority, sensitivity, and category of an activity, and at least one party that is involved in the activity. If applicable, the root node can also include information on locations and attachments that are assigned to the activity, and can provide detailed information on the activity and a reference to a business document that provides a business context of the activity. Appointment Activity can be time dependent on Time Point.
The elements located directly at the node Appointment Activity are defined by the inline structure APP_S_ACTV_EL. These elements include: UUID, ID, GroupwareItemID, GroupwareItemCreationDateTime, GroupwareItemLastChangedDateTime, GroupwareSynchronizationRelevanceIndicator, GroupwareItemSynchronizationConflictIndicator, GroupwareItemSynchronizationConflictReasonCode, GroupwareItemProcessingConflictReasonCode, SystemAdministrativeData, TypeCode, ProcessingTypeCode, Name, PriorityCode, InitiatorCode, MessageFromName, InformationSensitivityCode, Group Code, SalesTerritoryID, SalesTerritoryUUID, TerritoryDeterminationMethodCode, DataOriginTypeCode, ReportedDateTime, MigratedDataAdaptationTypeCode, CompletionDateTime, Status, ActivityFollowUpServiceRequestBlockingReasonCode, InitiatingActivityUUID, PredecessorActivityUUID, ActivitySentimentTypeCode, and SocialMediaActivityProviderUUID.
UUID may be an alternative key, is an internally assigned UUID of an Activity on which other business objects can define foreign keys, and may be based on datatype GDT: UUID. ID may be an alternative key, is a unique identifier for an Activity, may be assigned by the user, and may be based on datatype GDT: BusinessTransactionDocumentID. GroupwareItemID may be an alternative key, is a unique identifier of a groupware item assigned to an Activity, and may be based on datatype GDT: GroupwareItemID GroupwareItemCreationDateTime may be optional, is a time point at which a groupware item has been created, and may be based on datatype GDT: GLOBAL_DateTime, with a qualifier of Creation. The CreationDateTime of groupware items can also be used for the identification of groupware items in a groupware system. GroupwareItemLastChangedDateTime may be optional and may be based on datatype GDT: GLOBAL_DateTime. GroupwareSynchronizationRelevanceIndicator may be optional, specifies whether an Activity is relevant for Groupware synchronization, and may be based on datatype GDT: Indicator, with a qualifier of Relevance. GroupwareItemSynchronizationConflictIndicator may be optional, is an indicator that specifies whether a conflict occurred in synchronizing a groupware item, and may be based on datatype GDT: Indicator. GroupwareItemSynchronizationConflictReasonCode may be optional, is a coded representation of a reason for a conflict during groupware item synchronization, and may be based on datatype GDT: GroupwareItemSynchronisationConflictReasonCode. SystemAdministrativeData includes administrative data recorded by the system, such as system users and change dates/times, and may be based on datatype GDT: SystemAdministrativeData.
TypeCode is a coded representation of an Activity type, or of a business object projected from this type, and may be based on datatype GDT: BusinessTransactionDocumentTypeCode. Codes can represent the business objects AppointmentActivity, EmailActivity, LetterActivity, FaxActivity and PhoneCallActivity. ProcessingTypeCode is a coded representation of Activity processing within a process component, and may be based on datatype GDT: BusinessTransactionDocumentProcessingTypeCode. Name is a name of an Activity, and may be based on datatype GDT: EXTENDED_Name. PriorityCode may be optional, is a priority of an Activity, and may be based on datatype GDT: PriorityCode. InitiatorCode is a coded representation of whether an Activity was initiated inside or outside a company, and may be based on datatype GDT: ActivityInitiatorCode. MessageFromName may be optional, is a brief description of an Activity assigned by a sender, and may be based on datatype GDT: LANGUAGEINDEPENDENT_MEDIUM_Name. InformationSensitivityCode may be optional, defines a confidentiality level of an Activity, and may be based on datatype GDT: InformationSensitivityCode. GroupCode specifies a group of activities to which an Activity is assigned, and may be based on datatype GDT: ActivityGroupCode. SalesTerritoryID may be optional and may be based on datatype GDT: SalesTerritoryID. SalesTerritoryUUID may be optional and may be based on datatype GDT: UUID. TerritoryDeterminationMethodCode may be optional and may be based on datatype GDT: TerritoryDeterminationMethodCode. DataOriginTypeCode may be optional, is a coded representation of where data originates, and may be based on datatype GDT: ActivityDataOriginTypeCode. The type of source of a customer-specific transaction document can provide a technical source of a transaction document, such as a technical system in which the transaction document was created. ReportedDateTime may be optional, is a time point at which an activity is reported, and may be based on datatype GDT: GLOBAL_DateTime, with a qualifier of Reported. A ReportedTimePoint is a time point that corresponds with a ScheduledPeriod/TimePointPeriod/StartTimePoint for AppointmentActivities, PhoneCallActivities and ActivityTasks, and that corresponds with a SentTimePoint/TimePoint or ReceiptTimePoint/TimePoint for EmailActivities, LetterActivities and FaxActivities.
MigratedDataAdaptationTypeCode may be optional, is a coded representation of a type of data adaptation performed during migration, and may be based on datatype GDT: MigratedDataAdaptationTypeCode. CompletionDateTime may be optional and may be based on datatype GDT: GLOBAL_DateTime. Status may be optional, is a current step in the life cycle of the root node, and may be based on datatype BOIDT: ActivityStatus. Status can include Status/LifeCycleStatusCode, which may be optional, represents the life cycle of an activity, and may be based on datatype GDT: ActivityLifeCycleStatusCode. ActivityFollowUpServiceRequestBlockingReasonCode may be optional and may be based on datatype GDT: ActivityFollowUpServiceRequestBlockingReasonCode. InitiatingActivityUUID may be optional and may be based on datatype GDT: UUID. PredecessorActivityUUID may be optional and may be based on datatype GDT: UUID. ActivitySentimentTypeCode may be optional and may be based on datatype GDT: SentimentTypeCode. SocialMediaActivityProviderUUID may be optional and may be based on datatype GDT: UUID.
The following composition relationships to subordinate nodes exist: BusinessTransactionDocumentReference, with a cardinality of 1:CN; BusinessProcessVariantType, with a cardinality of 1:N; Location, with a cardinality of 1:CN; Party, with a cardinality of 1:CN; and Period, with a cardinality of 1:CN.
The following composition relationships to dependent objects exist: AccessControlList, with a cardinality of 1:1, which is a list of access groups that have access to an activity_template; AttachmentFolder, with a cardinality of 1:C, which is a folder for one or more documents in electronic form including additional information about an activity_template; and TextCollection, with a cardinality of 1:C, which is a collection of natural-language texts with additional information about an activity_template.
The following inbound association relationship may exist: CreationIdentity, from the business object Identity/node Identity, with a cardinality of 1:CN, which is an identity that has created an Activity; and LastChangeIdentity, from the business object Identity/node Identity, with a cardinality of 1:CN, which is an identity that has changed an Activity.
The following specialization associations for navigation may exist: Main Business Process Variant Type, to the node Business Process Variant Type, with a target cardinality of 1, which specifies a main BusinessProcessVariantType; and ActivityParty, on the Party node, with a target cardinality of CN, which represents a Party in the activity.
The following specialization associations for navigation may exist to the node Business Transaction Document Reference: ActivityBusinessTransactionDocumentReference, with a target cardinality of CN, which provides a reference to the business objects AppointmentActivity, EmailActivity, LetterActivity, FaxActivity and PhoneCallActivity that are linked to an activity; CampaignBusinessTransactionDocumentReference, with a target cardinality of C, which provides a reference to the business object Campaign; and OtherBusinessTransactionDocumentReference, with a target cardinality of CN; which provides a reference to other business objects that are linked to an activity, such as CustomerQuote, Opportunity, SalesOrder, ServiceOrder, SalesContract, PurchaseOrder, OutboundDelivery and Customerinvoice.
The following specialization associations for navigation may exist to the node Location: Main Location, with a target cardinality of C, which is a main location in a location specialization, and which may be located at the BusinessTransactionDocumentReference node. The following specialization associations for navigation may exist to the node Party: Activity Party, with a target cardinality of CN; Other Party, with a target cardinality of CN; Activity Unit Party, with a target cardinality of C; Attendee Party, with a target cardinality of CN, which is a party in the MessageTo Party specialization; MessageFromParty, with a target cardinality of C; Employee Responsible Party, with a target cardinality of C; Main Activity Party, with a target cardinality of C, which is a party in the MainActivity Party specialization; AttendeeParty, with a target cardinality of CN; Main Attendee Party, with a target cardinality of C, which is a main party in the Attendee Party specialization; ProcessorParty, with a target cardinality of C; Main Reference Party, with a target cardinality of C, which is a party in the MainReference Party specialization; ActivityUnitParty, with a target cardinality of C; Organizer Party, with a target cardinality of C; and Reference Party, with a target cardinality of CN.
The following specialization associations for navigation may exist: Scheduled Period, to the node Period, with a target cardinality of C; Activity Body Text Collection Text, to the node Text, with a target cardinality of C; and Business Document Flow, to the business object Business Document Flow/node Business Document Flow, with a target cardinality of C, which specifies an association relationship to business objects that use an Activity in a business process.
In some implementations, the ID is not changed once it has been created. In some implementations, the TypeCode is determined by the system and cannot be set using an interface. In some implementations, the ProcessingTypeCode is not changed once it has been created. In some implementations, the SystemAdministrativeData is set internally by the system and such data is not assigned or changed externally. In some implementations, the composition's property for Overview node Enabled-Attribute_value is set to False and Enabled-Final is set to True.
A RequestToSendCalendarEvent action can be used to send a request to a groupware system to send a calendar event meeting request to attendees in a calendar event. In some implementations, the RequestToSendCalendarEvent is enabled if Activity Management with Groupware Integration is active. A RequestToSendCalendarEventCancellation action can be used to send a request to groupware to send a calendar event cancellation request to attendees in a calendar event. In some implementations, the RequestToSendCalendarEventCancellation action is enabled only if Activity Management with Groupware Integration is active.
An Add Reference with Data Provision action creates a BusinessTransactionDocumentReference in an Activity and provides the Activity with data from the referenced document. A new Activity can be generated. The action elements are defined by the data type ActivityAddReferenceWithDataProvisionActionElements. These elements include: BusinessTransactionDocumentKey, which may include BusinessTransactionDocumentKey/BusinessTransactionDocumentID and BusinessTransactionDocumentKey/BusinessTransactionDocumentTypeCode. BusinessTransactionDocumentKey may be optional and may be based on datatype KDT: BusinessTransactionDocumentKey. BusinessTransactionDocumentKey/BusinessTransactionDocumentID may be optional, is a unique identifier for a business transaction document, and may be based on datatype GDT: BusinessTransactionDocumentID. BusinessTransactionDocumentKey/BusinessTransactionDocumentTypeCode may be optional, is a coded representation of a document type that occurs in business transactions. The document type describes the business nature of similar documents and defines the basic features of such a type of documents. BusinessTransactionDocumentTypeCode may be based on datatype GDT: BusinessTransactionDocumentTypeCode.
An Add Visit Report action can be used to add a visit report to an Activity. An interactive form “Visit Report” can be used by sales and service representatives for the reporting of business activities such as customer visits or ongoing opportunities. The Add Visit Report action creates an interactive form and adds the form to an attachment folder of the activity.
A Cancel action can be used to cancel an activity. A Complete action closes the processing of an Activity. A Copy action can be used to create an Activity from an existing Activity, from which relevant data is transferred. The two Activities might not be linked in a business sense. A Create From Business Partner action creates an activity with a provided Business Partner as a main Activity Party. A Create From Business Partner Contact action creates an activity with a provided Business Partner Contact and a Business Partner derived from the Business Partner Contact. A Create with Reference action creates an activity with reference to an existing document, from which relevant data is transferred. A Process action sets the LifeCycleStatus to “In Process”. The Activity can be processed after execution of the Process action. A Reopen action sets the LifeCycleStatus of an Activity back to an initial status.
A Destroy action can be used to destroy an object in accordance with the specified data retention rules. Destruction of data can imply either physical deletion or anonymization. The Destroy action can be usable for Information Lifecycle Management. The object does not necessarily perform all business logic checks.
A Select All query provides the NodeIDs of all instances of the root node and can be used to enable an initial load of data for a Fast Search Infrastructure. A Query By Elements query returns a list of Activities that are found for an object type, transaction type, name, priority, InitiatorCode, short name of a sender, level of confidentiality, group, origin type of the data, status, person responsible, ActivityParty, location, and postal code. The query elements are defined by the inline structure APP_S_ACTV_EL_QRY_EL.
These elements include: ID, SystemAdministrativeData, CreationBusinessPartnerCommonPersonNameGivenName, CreationBusinessPartner_CommonPersonNameFamilyName, LastChangeBusinessPartner_CommonPersonNameGivenName, LastChangeBusinessPartnerCommonPersonNameFamilyName, ProcessingTypeCode, Name, PriorityCode, InitiatorCode, MessageFromName, InformationSensitivityCode, GroupCode, DataOriginTypeCode, ReportedDateTime, Status, PartyRoleCode, PartyPartyKey, PartyName, PartyAdditionalName, PartyAdditional, PartySortingFormattedName, PartyActivityPartyCityName, PartyActivityPartyPostalCode, PartyActivityPartyKey, PartyActivityPartyContactPartyKey, PartyEmployeeResponsiblePartyKey, PartyContactPartyKey, BusinessTransactionDocumentReferenceBusinessTransactionDocumentReferenceID, BusinessTransactionDocumentReferenceBusinessTransactionDocumentReferenceTypeCode, SearchText, AttachmentSearchText, InitiatingActivityUUID, and PredecessorActivityUUID. ID may be based on datatype GDT: BusinessTransactionDocumentID.
SystemAdministrativeData may be based on datatype GDT: SystemAdministrativeData. CreationBusinessPartnerCommon_PersonNameGivenName is a first name of a person who has created an Activity, and may be based on datatype GDT: MEDIUM_Name. CreationBusinessPartner_CommonPersonNameFamilyName is a last name of a person who has created an Activity, and may be based on datatype GDT: MEDIUM_Name. LastChangeBusinessPartner_CommonPersonNameGivenName is a first name of a person who has changed an Activity, and may be based on datatype GDT: MEDIUM_Name. LastChangeBusinessPartner_CommonPersonNameFamilyName is a last name of a person who has changed an Activity, and may be based on datatype GDT: MEDIUM_Name. ProcessingTypeCode may be based on datatype GDT: BusinessTransactionDocumentProcessingTypeCode. Name may be based on datatype GDT: EXTENDED_Name. PriorityCode may be based on datatype GDT: PriorityCode. InitiatorCode may be based on datatype GDT: ActivityInitiatorCode. MessageFromName may be based on datatype GDT: LANGUAGEINDEPENDENT_MEDIUM_Name. InformationSensitivityCode may be based on datatype GDT: InformationSensitivityCode. GroupCode may be based on datatype GDT: ActivityGroupCode. DataOriginTypeCode may be based on datatype GDT: ActivityDataOriginTypeCode.
ReportedDateTime is a time point at which an activity is reported, and may be based on datatype GDT: GLOBAL_DateTime, with a qualifier of Reported. Status includes the LifeCycleStatus and TransmissionStatus of an Activity, and may be based on datatype BOIDT: ActivityStatus. Status can include Status/LifeCycleStatusCode, which represents the life cycle of an activity and may be based on datatype GDT: ActivityLifeCycleStatusCode. PartyRoleCode is a role of a party that occurs in an Activity, and may be based on datatype GDT: PartyRoleCode. PartyPartyKey is an identification of a party that occurs in an Activity, and may be based on datatype KDT: PartyKey. Party can include PartyPartyKey/PartyID, which is an identifier for a party, and may be based on datatype GDT: PartyID.
PartyName is a name of a party that occurs in an Activity, (e.g., a FamilyName of a business partner, such as BusinessPartnerCommonPersonNameFamilyName), and may be based on datatype GDT: LANGUAGEINDEPENDENT_LONG_Name. PartyAdditionalName is an additional name of a party that occurs in an activity (e.g., a given name of a business partner, such as BusinessPartnerCommonPersonNameGivenName), and may be based on datatype GDT: LANGUAGEINDEPENDENT_MEDIUM_Name, with a qualifier of PartyAdditional. PartySortingFormattedName is a sorting formatted name of a party that occurs in an activity, (e.g., SortingFormattedName of a business partner, such as BusinessPartnerCommonSortingFormattedName), and may be based on datatype GDT: LONG_Name. PartyActivityPartyCityName can be determined using the address of a business partner that occurs in an ActivityParty specialization, and may be based on datatype GDT: LANGUAGEINDEPENDENT_MEDIUM_Name, with a qualifier of City. PartyActivityPartyPostalCode can be determined from the address of a business partner that occurs in an ActivityParty specialization in an Activity, and may be based on datatype GDT: PostalCode.
PartyActivityPartyKey may be based on datatype KDT: PartyKey. PartyActivityPartyKey may include PartyActivityPartyKey/PartyID, which is an identifier for a party and may be based on datatype GDT: PartyID. PartyActivityPartyContactPartyKey may be based on datatype KDT: PartyKey. PartyActivityPartyContactPartyKey may include PartyActivityPartyContactPartyKey/PartyID, which is an identifier for a party and may be based on datatype GDT: PartyID. PartyEmployeeResponsiblePartyKey may be based on datatype KDT: PartyKey. PartyEmployeeResponsiblePartyKey may include PartyEmployeeResponsiblePartyKey/PartyID, which is an identifier for a party and may be based on datatype GDT: PartyID. PartyContactPartyKey may be based on datatype KDT: PartyKey. PartyContactPartyKey may include PartyContactPartyKey/PartyID, which is an identifier for a party and may be based on datatype GDT: PartyID.
BusinessTransactionDocumentReferenceBusinessTransactionDocumentReferenceID is an identifier of a referenced business transaction document, and may be based on datatype GDT: BusinessTransactionDocumentID.
Business TransactionDocumentReferenceBusinessTransactionDocumentReferenceTypeCode is a type of a referenced business transaction document, and may be based on datatype GDT: BusinessTransactionDocumentTypeCode. SearchText includes free text including one or several word terms used to search for Activities, and may be based on datatype GDT: SearchText. The different terms of the search text can be matched against a subset of the query parameters and the Activities instances can be returned as if all the terms were specified in each query parameter. AttachmentSearchText is text that is searched for within binary content of a particular Attachment for Activities, and may be based on datatype GDT: AttachmentSearchText. “Text” can refer to any limited character string and can also include special characters (e.g., *, ′, ″), to control the search. InitiatingActivityUUID may be based on datatype GDT: UUID. PredecessorActivityUUID may be based on datatype GDT: UUID.
Business Transaction Document Reference is a unique reference between an activity_template and another business transaction document or business transaction document item. The elements located directly at the node Business Transaction Document Reference are defined by the inline structure APP_S_ACTV_BTDR_EL. These elements include: BusinessTransactionDocumentReference, BusinessTransactionDocumentRelationshipRoleCode, and DataProviderIndicator.
BusinessTransactionDocumentReference includes a unique reference to a business document or to an item in a business document, and may be based on datatype GDT: BusinessTransactionDocumentReference. BusinessTransactionDocumentRelationshipRoleCode may be optional, indicates a role that an Activity adopts within a relationship to another business document or business document item, and may be based on datatype GDT: BusinessTransactionDocumentRelationshipRoleCode. DataProviderIndicator may be optional, is an indicator that specifies whether an Activity stores additional data in a relationship to a business document, and may be based on datatype GDT: Indicator, with a qualifier of DataProvider.
The following composition relationships to subordinate nodes exist: BusinessTransaction DocumentReferenceActualValues, with a cardinality of 1:C. The following inbound association relationships may exist: ActivityTask, from the business object Activity Task/node Activity Task, with a cardinality of C:CN, which represents when an Activity references an ActivityTask; AppointmentActivity, from the business object Appointment Activity/node Appointment Activity, with a cardinality of C:CN, which represents when an Activity references an AppointmentActivity; Customerinvoice, from the business object Customer Invoice/node Customer Invoice, with a cardinality of C:CN, which represents when an Activity references a Customerinvoice; Customer Quote, from the business object Customer Quote/node Customer Quote, with a cardinality of C:CN, which represents when an Activity references a CustomerQuote; EmailActivity, from the business object Email Activity/node Email Activity, with a cardinality of C:CN, which represents when an Activity references an EmailActivity; FaxActivity, from the business object Fax Activity/node Fax Activity, with a cardinality of C:CN, which represents when an Activity references a FaxActivity; LetterActivity, from the business object Letter Activity/node Letter Activity, with a cardinality of C:CN, which represents when an Activity references a LetterActivity; Opportunity, from the business object Opportunity/node Opportunity, with a cardinality of C:CN, which represents when an Activity references an Opportunity; PhoneCallActivity, from the business object Phone Call Activity/node Phone Call Activity, with a cardinality of C:CN, which represents when an Activity references a PhoneCallActivity; PurchaseOrder, from the business object Purchase Order/node Purchase Order, with a cardinality of C:CN, which represents when an Activity references a PurchaseOrder; SalesOrder, from the business object Sales Order/node Sales Order, with a cardinality of C:CN, which represents when an Activity references a SalesOrder; and ServiceOrder, from the business object Service Order/node Service Order, with a cardinality of C:CN, which represents when an Activity references a ServiceOrder. The following specialization associations for navigation may exist to the node Appointment Activity: Parent, with a target cardinality of 1; and Root, with a target cardinality of 1.
Business Transaction Document Reference Actual Values are actual values of a unique reference between Activities and another business transaction document or business transaction document item. The elements located directly at the node Business Transaction Document Reference Actual Values are defined by the inline structure APP_S_ACTV_BTDR_ACT_VALUES_EL. These elements include MarketingActivityID, which is a unique identifier of a Marketing Activity, and may be based on datatype GDT: MarketingActivityID. The following specialization associations for navigation may exist: Root, to the node Appointment Activity, with a target cardinality of 1; and Parent, to the node Business Transaction Document Reference, with a target cardinality of 1.
Business Process Variant Type is a representation of a typical way of processing an activity_template within a process component, from a business point of view. The elements located directly at the node Business Process Variant Type are defined by the inline structure APP_S_ACTV_BPV_EL. These elements include BusinessProcessVariantTypeCode and MainIndicator. BusinessProcessVariantTypeCode is a coded representation of a business process variant of an Activity, and may be based on datatype GDT: BusinessProcessVariantTypeCode. MainIndicator specifies whether a current BusinessProcessVariantTypeCode is a main variant, and may be based on datatype GDT: Indicator, with a qualifier of Main. The following specialization associations for navigation may exist to the node Appointment Activity: Parent, with a target cardinality of 1; and Root, with a target cardinality of 1. In some implementations, only one instance of the BusinessProcessVariantType may be flagged as a main BusinessProcessVariantType.
Location represents a physical or logical location that is used in an activity template in a location role. The elements located directly at the node Location are defined by the inline structure APP_S_ACTV_LOC_EL. These elements include: LocationID, LocationUUID, AddressReference, RoleCode, RoleCategoryCode, DeterminationMethodCode, and Name. AddressReference can include AddressReference/AddressHostUUID,
AddressReference/AddressHostTypeCode, AddressReference/BusinessObjectTypeCode, AddressReference/InstalledBaseID, AddressReference/InstallationPointID, and AddressReference/PartyKey. AddressReference/PartyKey can include AddressReference/PartyKey/PartyTypeCode and AddressReference/PartyKey/PartyID. LocationID is a unique 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 is a unique reference to an address of a party, and may be based on datatype BOIDT: ObjectNodeLocationAddressReference. AddressReference/AddressHostUUID is a universally unique identifier for an address of a business partner, an organizational unit or associated specializations, the business object InstalledBase, or the business object InstallationPoint. AddressHostUUID may be may be based on datatype GDT: UUID. AddressReference/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 the Location Address composition, and may be based on datatype GDT: AddressHostTypeCode.
AddressReference/BusinessObjectTypeCode may be optional, is a coded representation of a type of the business object in which an address referenced in the LocationAddressUUID is integrated as a dependent object, and may be based on datatype GDT: BusinessObjectTypeCode. AddressReference/InstalledBaseID is an identifier for an installed base that references an address using an AddressUUID, and may be based on datatype GDT: InstalledBaseID. AddressReference/InstallationPointID is an identifier for an installation point that references an address using an AddressUUID, and may be based on datatype GDT: InstallationPointID. AddressReference/PartyKey is an alternative identifier of a party that represents a business partner or an organizational unit that references an address using an AddressUUID, and may be based on datatype KDT: PartyKey. AddressReference/PartyKey/PartyTypeCode is a coded representation of a type of party, and may be based on datatype GDT: BusinessObjectTypeCode. AddressReference/PartyKey/PartyID is an identifier for a party, and may be based on datatype GDT: PartyID. RoleCode may be optional, is a role of a location, and may be based on datatype GDT: LocationRoleCode. RoleCategoryCode may be optional, is a category of a Location, and may be based on datatype GDT: LocationRoleCategoryCode. DeterminationMethodCode may be optional, is a coded representation of a location determination method, and may be based on datatype GDT: LocationDeterminationMethodCode. Name is a description for a location, and may be based on datatype GDT: LONG_Name.
The following inbound aggregation relationship may exist: Address Snapshot, from the business object Address Snapshot/node Root, with a cardinality of C:CN; Location, from the business object Location/node Location, with a cardinality of C:CN, which is a location that is involved in an Activity. The following specialization associations for navigation may exist: Parent, to the node Appointment Activity, with a target cardinality of 1; Root, to the node Appointment Activity, with a target cardinality of 1; and Used Address, to the business object Used Address/node Used Address, with a target cardinality of C, which is an address of a Party that is involved in an Activity.
Party is a natural or legal person, an organization, an organizational unit, or a group that is involved in an activity_template in a party role. The elements located directly at the node Party are defined by the data type ActivityPartyElements. These elements include: PartyKey, PartyUUID, RoleCategoryCode, RoleCode, AddressReference, DeterminationMethodCode, MainIndicator, and Name. PartyKey is an identifier of a party within a business document or master data object, and may be based on datatype KDT: PartyKey. PartyKey can include PartyKey/PartyTypeCode, which is coded representation of a type of party and may be based on datatype GDT: BusinessObjectTypeCode. PartyKey can include PartyKey/PartyID, which is an identifier for a party and may be based on datatype GDT: PartyID. PartyUUID is a unique identifier for a business partner, an organizational unit, or associated specializations, and may be based on datatype GDT: UUID. RoleCategoryCode may be optional, is a category of a PartyRole in a business document, and may be based on datatype GDT: PartyRoleCategoryCode. RoleCode may be optional, is a role of a party in a business document, and may be based on datatype GDT: PartyRoleCode. AddressReference is a unique reference to an address of a party, and may be based on datatype GDT: PartyAddressReference. DeterminationMethodCode may be optional, is a coded representation of a party determination method, and may be based on datatype GDT: PartyDeterminationMethodCode. MainIndicator may be optional, indicates whether a party is emphasized in a group of parties with a same PartyRole, and may be based on datatype GDT: Indicator, with a qualifier of Main. Name may be optional, is a description for a party, and may be based on datatype GDT: LANGUAGEINDEPENDENT_LONG_Name.
The following composition relationships to subordinate nodes exist: PartyContactParty, with a cardinality of 1:CN. The following inbound aggregation relationships may exist: Address Snapshot, from the business object Address Snapshot/node Root, with a cardinality of C:CN; and Party, from the business object Party/node Party, with a cardinality of C:CN, which is a party that is involved in an Activity. The following specialization associations for navigation may exist: Address Snapshot Overview, to the business object Address Snapshot/node Overview, with a target cardinality of C; Parent, to the node Appointment Activity, with a target cardinality of 1; Root, with a target cardinality of 1; Main Party Contact Party, to the node Party Contact Party, with a target cardinality of C; and Used Address, to the business object Used Address/node Used Address, with a target cardinality of C, which is an address of a Party that is involved in an Activity.
In some implementations, there is one aggregation relationship to a business partner, an organizational unit, or to an associated specialization. In some implementations, if the PartyUUID exists, the PartyTypeCode also exists. In some implementations, only one association exists for an address. Such an address can be a master data address of a business partner, organizational unit, or associated specialization referenced by PartyUUID. A Destroy action can be used to destroy an object in accordance with the specified data retention rules. Destruction of data can imply either physical deletion or anonymization. The Destroy action can be usable for Information Lifecycle Management. The object does not necessarily perform all business logic checks.
Party Contact Party is a natural person or organizational unit that can be contacted for an activity_template party. The contact can be a contact person or a secretariat, for example. Communication data can be available for the contact. The elements located directly at the node Party Contact Party are defined by the inline structure APP_S_ACTV_PTY_CONTACT_PTY_EL. These elements include: PartyKey, PartyUUID, AddressReference, DeterminationMethodCode, MainIndicator, and Name. PartyKey is an identifier of a contact within a business document or master data object, and may be based on datatype KDT: PartyKey. PartyKey can include PartyKey/PartyTypeCode, which is a coded representation of a type of party and may be based on datatype GDT: BusinessObjectTypeCode. PartyKey can include PartyKey/PartyID, which is an identifier for a party and may be based on datatype GDT: PartyID. PartyUUID is a unique identifier for a business partner, an organizational unit, or an associated specialization, and may be based on datatype GDT: UUID. AddressReference is a unique reference to an address of a contact, and may be based on datatype GDT: PartyAddressReference. DeterminationMethodCode may be optional, is a coded representation of a party determination method, and may be based on datatype GDT: PartyDeterminationMethodCode. MainIndicator may be optional, indicates whether a contact is emphasized in a group of contacts, and may be based on datatype GDT: Indicator, with a qualifier of Main. Name may be optional, is a description for a contact, and may be based on datatype GDT: LANGUAGEINDEPENDENT_LONG_Name.
The following inbound aggregation relationships may exist: Address Snapshot, from the business object Address Snapshot/node Root, with a cardinality of C:CN; and Party, from the business object Party/node Party, with a cardinality of C:CN, which is a Party that is involved in an Activity. The following specialization associations for navigation may exist: Address Snapshot Overview, to the business object Address Snapshot/node Overview, with a target cardinality of C; Root, to the node Appointment Activity, with a target cardinality of 1; Parent, to the node Party, with a target cardinality of 1; and Used Address, to the business object Used Address/node Used Address, with a target cardinality of C, which is an address of a Party that is involved in an Activity. In some implementations, one association exists for an address. Such an address can be a master data address of a business partner, organizational unit, or associated specialization referenced by PartyUUID. A Destroy action can be used to destroy an object in accordance with the specified data retention rules. Destruction of data can imply either physical deletion or anonymization. The Destroy action can be usable for Information Lifecycle Management. The object does not necessarily perform all business logic checks.
Period is a unit of time in which an activity or a similar object derived from an activity_template is performed. The elements located directly at the node Period are defined by the inline structure APP_S_ACTV_PERIOD_EL. These elements include: PeriodRoleCode, TimePointPeriod, StartTimePointDateCalculationFunctionReference, EndTimePointDateCalculationFunctionReference, and FullDayIndicator. PeriodRoleCode is a role of a specified period, and may be based on datatype GDT: PeriodRoleCode. TimePointPeriod is a specified period. The business role of the period can be specified by the PeriodRoleCode. TimePointPeriod may be based on datatype GDT: TimePointPeriod. StartTimePointDateCalculationFunctionReference is a reference to a function with which a start time point of a period is calculated, and may be based on datatype GDT: DateCalculationFunctionReference. EndTimePointDateCalculationFunctionReference is a reference to a function with which an end time point of a period is calculated, and may be based on datatype GDT: DateCalculationFunctionReference. FullDayIndicator may be optional, specifies whether a time point covers a full day, and may be based on datatype GDT: Indicator, with a qualifier of FullDay. The following specialization associations for navigation may exist to the node Appointment Activity: Parent, with a target cardinality of 1; and Root, with a target cardinality of 1.
An inbound service ManageAppointmentActivityIn can be used to manage appointment activities, can have a process component name of ActivityManagement, and can have a web service type that is inbound and stateless. A deployment unit Foundation can be associated with the ManageAppointmentActivityIn inbound service. The inbound service ManageAppointmentActivityIn can be associated with a Manage AppointmentActivity In Maintain as Bundle operation and a Manage Appointment Activity In Check Maintain as Bundle operation.
The inbound service ManageAppointmentActivityIn can be an interface used to migrate appointment activity data from a source system or a file. The inbound service ManageAppointmentActivityIn can be a web service interface and can enable connecting external applications to a system and creating and editing appointment activities within the system. The web service interface Manage Appointment Activity In can be relevant to a company that wants to access and manage appointment activity data from external applications. The web service interface Manage Appointment Activity In can provide operations MaintainBundle and CheckMaintainBundle. An example web service request for ManageAppointmentActivityIn is shown below:
Prerequisites of the inbound service ManageAppointmentActivityIn can include existence of referenced master data or business documents, such as Employee, Customer, (e.g., used to name a Processor or Employee Responsible for related customers), Campaigns, or other business documents.
The Maintain Bundle operation can enable external applications to create and change business document data. The Check Maintain Bundle operation can enable external applications to simulate maintain bundle requests without changing business document data. The Check Maintain Bundle operation can return system messages similar to corresponding maintain bundle operations and provide a same message type as a corresponding operation Maintain Bundle. In some implementations, the Check Maintain Bundle operation does not assign internal numbers from a productive number range interval (e.g., number range statuses might not be increased). In some implementations, the Check Maintain Bundle operation does not change any business documents.
One or more action codes can be used with the inbound service ManageAppointmentActivityIn. An action code can represent an instruction to a recipient of a web service request to process transmitted message node elements. An action code of “01” can represent a creation. An error message can be returned if the node element to create already exists. An action code of “02” can represent an update. An error message can be returned if the node element to update does not exist. An action code of “03” can represent a deletion. An error message can be returned if the node element to delete does not exist. An action code of “04” can represent a save. During a save, node element data can be created or changed. An action code of “05” can represent a removal. A node element can be deleted. In some implementations, if the node element to be removed does not exist, an error message is not sent. An action code of “06” can represent “no action”. A corresponding node element is not changed if such an action code is indicated. In some implementations, a default action code is “04” (save). In some implementations, if action code “04” (save) is specified, the system creates business documents if the system is not able to identify a matching target business document. For example, one or more business documents can be created if no business document ID or UUID is provided by a web service consumer. The web service consumer (e.g., external application) can be responsible for providing correct business document IDs or UUIDs in order to avoid accidental creation of duplicate business documents.
List processing can be performed in association with the inbound service ManageAppointmentActivityIn. For example, node elements with cardinality >1 can be processed (e.g., a list of descriptions in different languages, a list of telephone numbers). List processing can be controlled using List Complete Transmission Indicators (LCTI). A LCTI can indicate whether a list of node elements is transmitted completely. The LCTI of a node element with cardinality >1 can be modeled as an attribute of an associated parent node element. For example, an attribute can be represented using the following notation: attribute name: <name of child element>ListCompleteTransmissionIndicator.
In some implementations, a LCTI with a value of “false” can be used. Such a LCTI can indicate that a corresponding list of node elements has not been completely transmitted. Accordingly, all node elements that are not transmitted may be unchanged. If transmitted node elements in the list can be uniquely identified, the system can process the node elements according to an action code. If transmitted node elements in the list cannot be uniquely identified, the system can append the node element to a corresponding list of node elements in a target business document. In some implementations, a LCTI with a value of “true” can be used, which can indicate that the list of elements has been completely transmitted. Accordingly, all node elements that are not transmitted can be removed. If no node element is transmitted, a complete list can be removed. In some implementations, a default LCTI has a value of “false”. An LCTI can refer to the completeness of a list of node elements and may not imply completeness of sub-elements.
In some implementations, optional leaf elements in request messages that are not transmitted within a web service request are not changed in corresponding business documents. For example, when updating an appointment activity, a request can update a name. The priority code can remain unchanged, such as if an element “PriorityCode” is not included in an associated XML document (e.g., in the example below, the PriorityCode element is commented out):
In some implementations, an empty element can cause an error condition to occur. As another example, in the example code above, the request can be sent as an attempt to delete or update information associated with a sensitivity code with an initial value. In some implementations, an error message can result since an initial value might not be allowed for the information sensitivity code.
The Maintain Bundle and Check Maintain Bundle operations can be mass-enabled stateless synchronous web service operations. With such operations, transferring or requesting amounts of large data can cause communication timeouts. In some implementations, the web service consumer is responsible for ensuring reasonable sizes of data for mass operations. For example, in some implementations, a reasonable size of data is in the order of magnitude of one hundred kilobytes. Larger or smaller data sizes can be used.
In some implementations, the Maintain Bundle and Check Maintain Bundle operations support exactly one execution. In such implementations, to ensure exactly one execution of web service requests, the web service consumer can provide unique values for the elements ID or UUID of a BasicMessageHeader node element.
In some implementations, a change state identifier (e.g., element name ChangeStateID) can be used by external applications to enforce that a modifying operation is not executed if the state of a business document has changed since the external application last read data of the business document. For example, the change state ID can be an uninterpretable string that is provided by query and read operations and can be utilized by modifying operations.
In some implementations, if the change state identifier is provided when calling a modifying operation, the system does not perform the operation if the state of the business document instance has changed since the change state ID was computed. In some implementations, if the change state ID is not provided by the web service consumer, the system performs the web service operation without checking the state of the business document. In some implementations, the web service consumer (e.g., external application) is responsible for preventing accidental changes to business documents. In some implementations, for the web service ManageAppointmentActivityIn, the change state ID does not apply to the ContactPerson, Relationship, CommunicationArrangement, DirectResponsibility, SalesArrangement, or PaymentData node elements.
In some implementations, request node elements with cardinality >1 include an object node sender technical identifier to relate response message elements and log items to corresponding node elements in the request message. The object node sender technical identifiers can be provided as ObjectNodeSenderTechnicalID in request message types and can be referred to as ReferenceObjectNodeSenderTechnicalID in corresponding response message types. If the object node sender technical ID is initial, the object node sender technical ID of the parent node element in the request can be returned as a reference object node sender technical ID. If the object node sender technical IDs of all parent node elements are initial, the reference object node sender technical ID can also be returned as initial. Values specified in the ObjectNodeSenderTechnicalID can be transient values that establish a correspondence between elements for a single call. In some implementations, the web service consumer is not required to specify values in the ObjectNodeSenderTechnicalID. In some implementations, the service provider does not interpret the values in the ObjectNodeSenderTechnicalID. The service provider can return values in the ObjectNodeSenderTechnicalID to the web service consumer in one or more ReferenceObjectNodeSenderTechnicalID elements. ObjectNodeSenderTechnicalID can be used to identify failed business document modifications in a mass operation.
Below is an example using ObjectNodeSenderTechnicalID, where the Child elements correspond to a request and the Log element corresponds to a response, with the ReferenceObjectNodeSenderTechnicalID in the Log element including a value corresponding to a Child item in the request which includes some erroneous content. The Log item includes a corresponding error message.
The structure of a response message can include two parts: 1) a business document-specific part including information about IDs and UUIDs of created and changed business documents; and 2) Log items including system messages, including errors, warnings, and information messages raised by the system during processing of the web service request.
In some implementations, external applications consuming web services can have special requirements and restrictions regarding the format of WSDL (Web Services Definition Language) definitions. In some implementations, some external applications can use service definition WSDL definitions describing a web service signature. Such a definition can be sufficient for the creation of static client-side proxies. In some implementations, other external applications, such as applications that do not create static client-side proxies, may use binding WSDL definitions including an endpoint definition and authentication policy information. In some implementations, external applications may impose special restrictions on the structure or the size of WSDL definitions. For example, a first system may use binding WSDL definitions and may consider elements with the attribute/value pair “minOccurs=0” as “mandatory”. However, a second system may consider the attribute/value pair “minOccurs=0” as “optional”. In order to handle such differing interpretations, a WSDL definition can be saved locally and an additional attribute/value pair, such as “nillable=true”, can be added to make a query parameter optional for the first system.
For small clients (e.g., mobile devices), the size of a WSDL may become a problem (e.g., due to the complexity of the WSDL definition, e.g., a small client may experience long runtimes during serialization of a request or deserialization of a response. For many requests and responses, the client only uses a very small part of the signature of a WSDL definition. To address the long runtime issues, a WSDL definition can be saved locally and the optional parts of the signature can be removed before the WSDL is imported or static client-side proxies are generated.
External applications can take into account that web service request and response message types can be enhanced with additional elements and attributes. Enhancements can be created by an enterprise system manufacturer, by partners of the enterprise system manufacturer, or by administrators, to name a few examples. Enhancements of request message types can be optional elements or attributes. The enterprise system may or may not require the external application to provide values in the request. Enhancements of response message types can include mandatory elements or attributes. The external application can be configured to process extended responses. Standard XML element and attribute names are generally stable. Technical definitions of data types can be enhanced in a compatible manner. Such enhancements may result in changed data type names. External applications can rely on standard XML element names and attribute names, but in some implementations generally do not rely on consistency of enhanced data type names.
Possible scenarios related to the ManageAppointmentActivityIn service include a Create Appointment scenario and an Update Appointment scenario. The MaintainBundle operation can be used to create an appointment. The MaintainBundle operation can be used to update an existing appointment. Below is an example web service request to create an appointment activity. The action code of “01” indicates a creation. As a request response, the ID of the created Appointment Activity can be returned.
Below is an example of a web service request to update the name of an appointment activity. An action code value of “02” indicates an update.
In addition to updating an activity, a party that has 1:n cardinality can be updated. In some implementations, a party ID and party role are not unique keys for a party instance. In such implementations, for parties with a 1:n cardinality, in case of updates (e.g., change, delete) a CompleteTransmissionIndicator can be set and a full list of updated parties that are to replace an existing list of parties can be provided. For example, for a ReferenceParty, an existing list of ReferenceParty elements to be changed can include elements with identifiers of MCP6049, MCPB9785, and MCPC9785. Desired updates can include, for example, deletion of party MCP6049, retaining party MCPB9785, changing the identifier of party MCPC9785 to be MCP17101, and adding parties MCP17102 and MDECP9786.
Suppose for example, that no unique identification of a party instance is possible via party ID and party role. In this example, a referencePartyListCompleteTransmission Indicator can be set to “true”. Accordingly, the list of parties is completely transmitted and all parties that are not transmitted are removed. If no party is transmitted, the complete list is removed. In the above example, a list that includes parties MCPB9785, MCP17101, MCP17102, and MDECP9786 can be provided.
A corresponding example XML document for such an example is below. The parties to include in the list are enclosed in ReferenceParty elements.
As another example, a new party instance can be specified to be appended to an existing list of parties by providing the new party and setting the ListCompleteTransmission Indicator to “false”. For example, suppose an existing list of parties includes parties MCP6049, MCPB9785, and MCPC9785. Suppose also that each party in the existing list of parties is to be retained and that new parties MCP8300 and MCP60500 are to be added. The ListCompleteTransmissionIndicator can be set to false and a list that includes just the parties to add can be provided. A corresponding XML document which can be used to achieve the above example is shown below. The two parties to add are enclosed in ReferenceParty elements.
The inbound service ManageAppointmentActivityIn can be associated with a Manage AppointmentActivity In Maintain as Bundle operation, which can be synchronous, can have a name of MaintainBundle, and which can be used to maintain e-mail activities (e.g., to create, update, or delete Appointment activities).
A request message of the operation MaintainBundle can include a BasicMessageHeader node element as well as an AppointmentActivity node element that includes task data to be created or updated. The task node can occur multiple times in the request message. For example, multiple activity tasks can be created and updated through a single web service request. A response message type of the operation MaintainBundle can include log items, processing information, and an AppointmentActivity-specific node that includes ReferenceObjectNodeSenderTechnicalID and ChangeStateID elements. In addition, AppointmentActivity, InternalID and Account UUID elements can also be included.
The AppointmentActivity node element includes general task information, such as ID, UUID, names, and other forms of identification. The data for the AppointmentActivity node can be related to general data associated with an Appointment Activity user interface. In some implementations, the user interface does not display the InternalID element. For example, the InternalID element can be generated in a backend system. The UUID element can be used to identify the Appointment Activity node element. The ID is a unique identifier for identifying an appointment. ID is typically not shown in the user interface, and can be automatically generated by the system. The UUID is a unique identifier of an Appointment Activity which can be generated by a web service or can be provided by a consumer.
MigratedDataAdaptationTypeCode is a coded representation of a migrated data adaptation type. Adaptation types can include unchanged, changed, quantity, and items changed or omitted. Name is a subject of an Appointment Activity as it may be presented in the user interface. Priority Code specifies a priority of an Activity Task and can include one of the following codes: immediate, urgent, normal, low. If not specified by the consumer, a default priority code can be set by the web service.
The Information Sensitivity Code specifies the sensitivity of an activity task and can include values representing normal, personal, private, or confidential. If not specified by the consumer, a default information sensitivity code can be set by the web service. The Group Code can be used to group activity task according to a certain aspect. The Group Code can be configured by the consumer. If not specified by the consumer, a default group code can be set by the web service. The Data Origin Type Code specifies the origin of an activity task and can include values representing manual data entry, groupware, direct mailing, or telephony. If not specified by the consumer, a default data origin type code can be set by the web service. The LifeCycleStatusCode indicates a status of an activity task and can include values that represent open, in-process, or completed. In some implementations, if not specified by the consumer, a default life cycle status code can be set by the web service.
The StartDateTime and EndDateTime can be used to specify a period in which an activity task is scheduled for processing. A timestamp for each DateTime can be provided. Both dates can be set together. The Full Day Indicator can be set to indicate a full day appointment. If the Full Day indicator is set, StartDateTime and EndDateTime can be configured to represent a duration of 24 hours. For example, StartDateTime can indicate the beginning of a day.
Parties can be provided and identified in various ways. For example, BPInternalID, Name, EmployeeInternalID, and EmailURI can be used. BPInternalID is an internal identifier of a business partner. EmployeeInternalID is an internal employee identifier of the business partner. EmailURI is an EMailURI of a business. The EmailURI can be uniquely assigned to a business partner. If no party can be identified by a provided EmailURI, a party without an identifier can be created with an EmailURI stored in a document address. The Name is generally not used for identification, but can be stored in an address with a party that is not identifiable by a given EmailURI.
The following types of parties can be used: Organizer Party, where an organizer party is a party who created an appointment, such as by inviting attendees, and where the organizer party can be specified either by a Business partner ID or an Employee ID; Attendee Party, where an attendee party is a party who was invited to the appointment as a participant, and where the attendee party can be specified either by a Business partner ID or an Employee ID; Employee Responsible Party, where an employee responsible party is an employee who is responsible for an activity task, and where the employee responsibility party can be specified either by a Business partner ID or an Employee ID; Main Activity Party, where a main activity party is a party involved in an activity, and where the main activity party can be specified by a Business partner ID; Reference Party, where a reference party is a party to which an activity task is related, and where the reference party can be specified either by a Business partner ID or an Employee ID; and Activity Unit Party, where an activity unit party is an organizational unit where the activity task is reported, and where the activity unit party can be specified by an organizational center.
BusinessTransactionDocumentReference can be used to link an activity task to other business documents such as an opportunity or campaign. ID, UUID, and TypeCode of a related business document can be provided as well as a RefRoleCode specifying the type of relationship. RefRoleCodes can include Predecessor and Successor. The following XML is an example of linking an opportunity as a predecessor, where a RoleCode of “1” indicates a predecessor.
In some implementations, campaigns are linked as predecessors, independent of how a consumer specifies the RoleCode. The Text Node element can be used to set one or more text values for an activity task. The following text types are allowed: Activity Body and Internal Comment. In some implementations, one Activity Body (e.g., a description of the activity task) is allowed in an AppointmentActivity. In some implementations, there can be multiple Internal Comments. For each Internal Comment, a timestamp as a CreationDateTime can be provided to build a sequence of comments, as shown in the following XML example. TextTypeCode of “10002” indicates an Activity Comment and TextTypeCode of “10011” indicates an internal comment.
The AttachmentFolder node element can be used to add and remove activity task attachments. Data for the AttachmentFolder node can be presented on the activity task user interface as attachments. On the user interface, files and links can be created. In the web service request, links and files can be differentiated through a CategoryCode. CategoryCode can include values which represent a document or a link, for example. An attachment can be designated as a standard attachment or some other type of attachment. To create a link attachment, document elements can be set as follows: VisibleIndicator=true, CategoryCode=3 (indicating a Link), TypeCode=none, AlternativeName set to the document title, ExternalLinkWebURI set to the link URI, and a description specified using Description. To create a file attachment, document elements can be set as follows: VisibleIndicator=true, CategoryCode=2 (indicating a document), TypeCode=none, Name set to document title, AlternativeName set to document title, and Description set to a description.
The inbound service ManageAppointmentActivityIn can be associated with a Manage Appointment Activity In Check Maintain as Bundle operation, which can have a name of CheckMaintainBundle, can be synchronous, and can be used to check e-mail activities (e.g., to check if an appointment activity can be created, updated, or deleted without errors). In some implementations, the web service request and response message types for the CheckMaintainBundle operation are the same as those of the Maintain Bundle operation.
The message type Appointment Activity Bundle Maintain Request_sync is derived from the business object Appointment Activity as a leading object together with its operation signature. The structure of the message type Appointment Activity Bundle Maintain Request_sync is determined by the message data type AppointmentActivityMaintainRequestBundleMessage_sync. The message data type AppointmentActivityMaintainRequestBundleMessage_sync includes the packages BasicMessageHeader and EmailActivity.
The package BasicMessageHeader includes the entity BasicMessageHeader. BasicMessageHeader is typed by BusinessDocumentBasicMessageHeader. The package EmailActivity includes the sub-package Party and the entity AppointmentActivity.
AppointmentActivity includes the following attributes: actionCode, AttendeePartyListCompleteTransmissionIndicator, referencePartyListCompleteTransmissionIndicator, and businessTransactionDocumentReferenceListCompleteTransmissionIndicator. The actionCode attribute may have a multiplicity of 0..1 and may be based on datatype BGDT:ActionCode. The AttendeePartyListCompleteTransmissionIndicator attribute may have a multiplicity of 0..1 and may be based on datatype CDT:Indicator. The referencePartyListCompleteTransmissionIndicator may have a multiplicity of 0..1 and may be based on datatype CDT:Indicator. The businessTransactionDocumentReferenceListCompleteTransmissionIndicator attribute may have a multiplicity of 0..1 and may be based on datatype CDT:Indicator. The textListCompleteTransmissionIndicator attribute may have a multiplicity of 0..1 and may be based on datatype CDT:Indicator.
AppointmentActivity includes the following non-node elements: ObjectNodeSenderTechnicalID, ChangeStateID, ID, UUID, MigratedDataAdaptationTypeCode, Name, PriorityCode, InitiatorCode, InformationSensitivityCode, GroupCode, DataOriginTypeCode, LifeCycleStatusCode, StartDateTime, EndDateTime, FullDayIndicator, CompletionDateTime, ActiyityFollowUpSeryiceRequestBlockingReasonCode, and GroupwareItemID ObjectNodeSenderTechnicalID may have a multiplicity of 0..1 and may be based on datatype BGDT:ObjectNodePartyTechnicalID. ChangeStateID may have a multiplicity of 0..1 and may be based on datatype BGDT:ChangeStateID. ID may have a multiplicity of 0..1 and may be based on datatype BGDT:BusinessTransactionDocumentID. UUID may have a multiplicity of 0..1 and may be based on datatype BGDT:UUID. MigratedDataAdaptationTypeCode may have a multiplicity of 0..1 and may be based on datatype BGDT:MigratedDataAdaptationTypeCode. Name may have a multiplicity of 0..1 and may be based on datatype CDT:LANGUAGEINDEPENDENT_EXTENDED_Name. PriorityCode may have a multiplicity of 0..1 and may be based on datatype BGDT:PriorityCode. InitiatorCode may have a multiplicity of 0..1 and may be based on datatype BGDT:ActiyityInitiatorCode. InformationSensitivityCode may have a multiplicity of 0..1 and may be based on datatype BGDT:InformationSensitivityCode. GroupCode may have a multiplicity of 0..1 and may be based on datatype BGDT:ActivityGroupCode. DataOriginTypeCode may have a multiplicity of 0..1 and may be based on datatype BGDT:ActivityDataOriginTypeCode. LifeCycleStatusCode may have a multiplicity of 0..1 and may be based on datatype BGDT:ActivityLifeCycleStatusCode. StartDateTime may have a multiplicity of 0..1 and may be based on datatype CDT:LOCALNORMALISED_DateTime. EndDateTime may have a multiplicity of 0..1 and may be based on datatype CDT:LOCALNORMALISED_DateTime. FullDayIndicator may have a multiplicity of 0..1 and may be based on datatype CDT:Indicator. CompletionDateTime may have a multiplicity of 0..1 and may be based on datatype CDT:GLOBAL_DateTime. ActivityFollowUpServiceRequestBlockingReasonCode may have a multiplicity of 0..1 and may be based on datatype BGDT:ActivityFollowUpServiceRequestBlockingReasonCode. GroupwareItemID may have a multiplicity of 0..1 and may be based on datatype BGDT:GroupwareItemID
AppointmentActivity includes the following node elements: LocationName, in a 1:C cardinality relationship; OrganizerParty, in a 1:1 cardinality relationship; AttendeeParty, in a 1:CN cardinality relationship; EmployeeResponsibleParty, in a 1:C cardinality relationship; MainActivityParty, in a 1:C cardinality relationship; ActivityUnitParty, in a 1:C cardinality relationship; BusinessTransactionDocumentReference, in a 1:CN cardinality relationship; Text, in a 1:CN cardinality relationship; AttachmentFolder, in a 1:C cardinality relationship; and ReferenceParty, in a 1:CN cardinality relationship. The package EmailActivity includes the entities LocationName, OrganizerParty, AttendeeParty, EmployeeResponsibleParty, MainActivityParty, ActivityUnitParty, BusinessTransactionDocumentReference, Text, and AttachmentFolder.
LocationName includes the LocationName non-node element, which may have a multiplicity of 0..1 and may be based on datatype CDT:LANGUAGEINDEPENDENT_MEDIUM_Name. OrganizerParty includes the following non-node elements: BusinessPartnerinternalID, EmployeeID, EmailURI, and Name. BusinessPartnerInternalID may have a multiplicity of 0..1 and may be based on datatype BGDT:BusinessPartnerinternalID. EmployeeID may have a multiplicity of 0..1 and may be based on datatype BGDT:BusinessPartnerID. EmailURI may have a multiplicity of 0..1 and may be based on datatype BGDT:EmailURI. Name may have a multiplicity of 0..1 and may be based on datatype CDT:LANGUAGEINDEPENDENT_Name.
AttendeeParty includes the following non-node elements: ObjectNodeSenderTechnicalID, BusinessPartnerInternalID, EmployeeID, EmailURI, Name, and MainIndicator. ObjectNodeSenderTechnicalID may have a multiplicity of 0..1 and may be based on datatype BGDT:ObjectNodePartyTechnicalID. BusinessPartnerInternalID may have a multiplicity of 0..1 and may be based on datatype BGDT:BusinessPartnerinternalID. EmployeeID may have a multiplicity of 0..1 and may be based on datatype BGDT:BusinessPartnerID. EmailURI may have a multiplicity of 0..1 and may be based on datatype BGDT:EmailURT. Name may have a multiplicity of 0..1 and may be based on datatype CDT:LANGUAGEINDEPENDENT_Name. MainIndicator may have a multiplicity of 0..1 and may be based on datatype CDT:Indicator.
EmployeeResponsibleParty includes the following non-node elements: BusinessPartnerInternalID, EmployeeID, and EmailURI. BusinessPartnerInternalID may have a multiplicity of 0..1 and may be based on datatype BGDT:BusinessPartnerinternalID.
EmployeeID may have a multiplicity of 0..1 and may be based on datatype BGDT:BusinessPartnerID. EmailURI may have a multiplicity of 0..1 and may be based on datatype BGDT:EmailURI.
MainActivityParty includes the BusinessPartnerInternalID non-node element, which may have a multiplicity of 0..1 and may be based on datatype BGDT:BusinessPartnerinternalID. ActivityUnitParty includes the OrganisationalCentreID non-node element, which may have a multiplicity of 0..1 and may be based on datatype BGDT:OrganisationalCentreID.
BusinessTransactionDocumentReference includes the actionCode attribute, which may have a multiplicity of 0..1 and may be based on datatype BGDT:ActionCode. BusinessTransactionDocumentReference includes the following non-node elements: ObjectNodeSenderTechnicalID, ID, UUID, TypeCode, and RoleCode. ObjectNodeSenderTechnicalID may have a multiplicity of 0..1 and may be based on datatype BGDT:ObjectNodePartyTechnicalID. ID may have a multiplicity of 0..1 and may be based on datatype BGDT:BusinessTransactionDocumentID. UUID may have a multiplicity of 0..1 and may be based on datatype BGDT:UUID. TypeCode may have a multiplicity of 0..1 and may be based on datatype BGDT:BusinessTransactionDocumentTypeCode. RoleCode may have a multiplicity of 0..1 and may be based on datatype BGDT:BusinessTransactionDocumentRelationshipRoleCode.
Text includes the actionCode attribute, which may have a multiplicity of 0..1 and may be based on datatype BGDT:ActionCode. Text includes the following non-node elements: ObjectNodeSenderTechnicalID, TextID, TextTypeCode, ContentText, and CreationDateTime. ObjectNodeSenderTechnicalID may have a multiplicity of 0..1 and may be based on datatype BGDT:ObjectNodePartyTechnicalID. TextID may have a multiplicity of 0..1 and may be based on datatype BGDT:TextCollectionTextID. TextTypeCode may have a multiplicity of 0..1 and may be based on datatype BGDT:TextCollectionTextTypeCode. ContentText may have a multiplicity of 0..1 and may be based on datatype CDT:LANGUAGEINDEPENDENT_Text. CreationDateTime may have a multiplicity of 0..1 and may be based on datatype CDT:GLOBAL_DateTime.
AttachmentFolder includes the following attributes: DocumentListCompleteTransmissionIndicator and ActionCode. DocumentListCompleteTransmissionIndicator may have a multiplicity of 0..1 and may be based on datatype CDT:Indicator. ActionCode may have a multiplicity of 0..1 and may be based on datatype BGDT:ActionCode. AttachmentFolder includes the UUID non-node element, which may have a multiplicity of 0..1 and may be based on datatype BGDT:UUID. AttachmentFolder includes the following node elements: Document, in a 1:CN cardinality relationship.
Document includes the following attributes: PropertyListCompleteTransmissionIndicator and ActionCode. PropertyListCompleteTransmissionIndicator may have a multiplicity of 0..1 and may be based on datatype CDT:Indicator. ActionCode may have a multiplicity of 0..1 and may be based on datatype BGDT:ActionCode. Document includes the following non-node elements: UUID, LinkInternalIndicator, VisibleIndicator, CategoryCode, TypeCode, MIMECode, Name, AlternativeName, InternalLinkUUID, Description, and ExternalLinkWebURI. UUID may have a multiplicity of 0..1 and may be based on datatype BGDT:UUID. LinkInternalIndicator may have a multiplicity of 0..1 and may be based on datatype CDT:Indicator. VisibleIndicator may have a multiplicity of 0..1 and may be based on datatype CDT:Indicator. CategoryCode may have a multiplicity of 0..1 and may be based on datatype BGDT:DocumentCategoryCode. TypeCode may have a multiplicity of 0..1 and may be based on datatype BGDT:DocumentTypeCode. MIMECode may have a multiplicity of 0..1 and may be based on datatype BGDT:MIMECode. Name may have a multiplicity of 0..1 and may be based on datatype CDT:LANGUAGEINDEPENDENT_Name. AlternativeName may have a multiplicity of 0..1 and may be based on datatype CDT:LANGUAGEINDEPENDENT_Name. InternalLinkUUID may have a multiplicity of 0..1 and may be based on datatype BGDT:UUID. Description may have a multiplicity of 0..1 and may be based on datatype BGDT:Description. ExternalLinkWebURI may have a multiplicity of 0..1 and may be based on datatype BGDT:WebURI. Document includes the following node elements: Property, in a 1:CN cardinality relationship; and FileContent, in a 1:C cardinality relationship.
Property includes the following attributes: PropertyValueListCompleteTransmissionIndicator and ActionCode. PropertyValueListCompleteTransmissionIndicator may have a multiplicity of 0..1 and may be based on datatype CDT:Indicator. ActionCode may have a multiplicity of 0..1 and may be based on datatype BGDT:ActionCode. Property includes the following non-node elements: TechnicalID, Name, DataTypeFormatCode, VisibleIndicator, ChangeAllowedIndicator, MultipleValueIndicator, NamespaceURI, and Description. TechnicalID may have a multiplicity of 0..1 and may be based on datatype BGDT:ObjectNodeTechnicalID. Name may have a multiplicity of 0..1 and may be based on datatype CDT:LANGUAGEINDEPENDENT_Name. DataTypeFormatCode may have a multiplicity of 0..1 and may be based on datatype BGDT:PropertyDataTypeFormatCode. VisibleIndicator may have a multiplicity of 0..1 and may be based on datatype CDT:Indicator. ChangeAllowedIndicator may have a multiplicity of 0..1 and may be based on datatype CDT:Indicator. MultipleValueIndicator may have a multiplicity of 0..1 and may be based on datatype CDT:Indicator. NamespaceURI may have a multiplicity of 0..1 and may be based on datatype BGDT:NamespaceURI. Description may have a multiplicity of 0..1 and may be based on datatype BGDT:Description.
Property includes the node element PropertyValue, in a 1:CN cardinality relationship. PropertyValue includes the ActionCode attribute, which may have a multiplicity of 0..1 and may be based on datatype BGDT:ActionCode. PropertyValue includes the following non-node elements: TechnicalID, Text, Indicator, DateTime, and IntegerValue. TechnicalID may have a multiplicity of 0..1 and may be based on datatype BGDT:ObjectNodeTechnicalID. Text may have a multiplicity of 0..1 and may be based on datatype CDT:LANGUAGEINDEPENDENT_Text. Indicator may have a multiplicity of 0..1 and may be based on datatype CDT:Indicator. DateTime may have a multiplicity of 0..1 and may be based on datatype CDT:GLOBAL_DateTime. IntegerValue may have a multiplicity of 0..1 and may be based on datatype BGDT:IntegerValue.
FileContent includes the ActionCode attribute, which may have a multiplicity of 0..1 and may be based on datatype BGDT:ActionCode. FileContent includes the following non-node elements: TechnicalID and BinaryObject. TechnicalID may have a multiplicity of 0..1 and may be based on datatype BGDT:ObjectNodeTechnicalID. BinaryObject may have a multiplicity of 0..1 and may be based on datatype CDT:BinaryObject.
The package EmailActivityParty includes the entity ReferenceParty. ReferenceParty includes the following non-node elements: ObjectNodeSenderTechnicalID, BusinessPartnerInternalID, EmployeeID and MainIndicator. ObjectNodeSenderTechnicalID may have a multiplicity of 0..1 and may be based on datatype BGDT:ObjectNodePartyTechnicalID. BusinessPartnerinternalID may have a multiplicity of 0..1 and may be based on datatype BGDT:BusinessPartnerinternalID. EmployeeID may have a multiplicity of 0..1 and may be based on datatype BGDT:BusinessPartnerID. MainIndicator may have a multiplicity of 0..1 and may be based on datatype CDT:Indicator.
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.