System and method utilizing an interface component to query a document

[0001] This application claims priority to U.S. Provisional Patent Application No. 60/347,919, filed Oct. 18, 2001, entitled APPLICATION VIEW, as well as application Ser. No. 60/347,901, filed Oct. 18, 2001, entitled EVENT ADAPTER, each of which is hereby incorporated herein by reference.

[0002] 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 of the patent disclosure, as it appears in the Patent and Trademark Office patent file or records, but otherwise reserves all copyright rights whatsoever.

[0003] The following applications are cross-referenced and incorporated herein by reference:

[0004] The following applications are cross-referenced and incorporated herein by reference:

[0005] U.S. patent application Ser. No. ______ entitled APPLICATION VIEW COMPONENT FOR SYSTEM INTEGRATION, by Mitch Upton, filed Oct. 15, 2002.

[0006] U.S. patent application Ser. No. ______ entitled SYSTEM AND METHOD FOR PROVIDING A JAVA INTERFACE TO AN APPLICATION VIEW COMPONENT, by Mitch Upton, filed Oct. 15, 2002.

[0007] U.S. patent application Ser. No. ______ entitled SYSTEM AND METHOD FOR INVOKING BUSINESS FUNCTIONALITY FOR A WORKFLOW, by Mitch Upton, filed Oct. 15, 2002.

[0008] U.S. patent application Ser. No. ______ entitled SYSTEM AND METHOD FOR USING WEB SERVICES WITH AN ENTERPRISE SYSTEM, by Mitch Upton, filed Oct. 15, 2002.

[0009] U.S. patent application Ser. No. ______ entitled SYSTEM AND METHOD FOR IMPLEMENTING AN EVENT ADAPTER, by Mitch Upton, filed Oct. 15, 2002.

[0010] U.S. patent application Ser. No. ______ entitled SYSTEM AND METHOD USING A CONNECTOR ARCHITECTURE FOR APPLICATION INTEGRATION, by Mitch Upton, filed Oct. 15, 2002.

[0011] U.S. patent application Ser. No. ______ entitled SYSTEM AND METHOD FOR IMPLEMENTING A SCHEMA OBJECT MODEL IN APPLICATION INTEGRATION, by Mitch Upton, filed Oct. 15, 2002.

[0012] U.S. patent application Ser. No. ______ entitled SYSTEM AND METHOD USING ASYNCHRONOUS MESSAGING FOR APPLICATION INTEGRATION, by Mitch Upton, filed Oct. 15, 2002.

[0013] U.S. patent application Ser. No. ______ entitled SYSTEMS AND METHODS FOR INTEGRATION ADAPTER SECURITY, by Mitch Upton, filed Oct. 15, 2002.

[0014] U.S. patent application Ser. No. ______ entitled SYSTEM AND METHOD FOR IMPLEMENTING A SERVICE ADAPTER, by Mitch Upton, filed Oct. 15, 2002.

[0015] The invention relates generally to systems and methods for integrating applications.

[0016] E-commerce has become a major driving factor in the new economy. To be successful in the long-term, e-commerce will require many companies to engage in cross-enterprise collaborations. To achieve cross-enterprise integration, a company must first integrate its internal applications. Using existing technology and tools, application integration can be an expensive proposition. No integration solution exists that is easy to use, affordable, and based on industry standards. Neither does a solution exist that is based on an industry standard infrastructure, has universal connectivity, is capable of massive scalability, and has accessible business process tools.

[0017] Application integration to this point has been very inward-focused. Many existing integration systems have not focused on integrating applications between enterprises. Even when integration solutions were used for cross-enterprise integration, the solutions were still narrowly focused and aimed at vertical markets. This inward focus did little to help companies field external business-to-consumer and business-to-business applications, such as applications that can utilize the Internet to generate revenue and reduce costs. The requirement for Internet-enabled applications led to the rise of the application server market. To date, application servers have primarily been used to host external applications targeted at customers and partners. Application servers are themselves packaged applications that, instead of solving a specific problem, are general-purpose platforms that host vertical solutions.

[0018] The first attempts at application integration were primarily focused on low-level implementation details such as the format of the data, the byte ordering between machines, and character encoding. The focus on low-level data formats was necessary because, for the first generation of application integration solutions, there were no widely adopted standards for data encoding that could be deployed across multiple vertical applications.

[0019] The traditional approach involved connecting individual systems to, in effect, hardwire the systems together. This approach can be complex, as connecting different systems can require an intimate, low-level knowledge of the proprietary technologies of multiple systems.

[0020] Present integration systems, which have moved away from hardwiring systems together, still suffer from a lack of standards. Each integration vendor typically provides a proprietary solution for application integration, message transformation, message formats, message transport, and routing. Not one of these systems to date has achieved significant market share to enable its technologies to become the de-facto standard. This lack of standards has given packaged application vendors little incentive to integrate these systems with their. Further, each of these integration systems or servers has its own proprietary API, such that packaged application vendors cannot leverage development beyond a single integration server. This fragmentation of the integration market has provided little financial incentive for third parties.

[0021] Systems and methods in accordance with embodiments of the present invention allow communication to be passed between components, such as an enterprise system and a client application, by taking advantage of schemas. A schema can be used to ensure that a communication, such as a request or response, is in the proper format for one of the components. For instance, metadata can be received from an enterprise system in response to a request from a client application. That metadata can be transformed to a response document that conforms to a schema. The document can be validated against the schema and passed on to the client application. In order to validate the document, elements of the document can be queried through a document interface component.

[0022] Other features, aspects, and objects of the invention can be obtained from a review of the specification, the figures, and the claims.

[0023] FIG. 1 is a diagram of an integration system that can be used in accordance with one embodiment of the present invention.

[0024] FIG. 2 is a diagram of an integration system that can be used in accordance with another embodiment of the present invention.

[0025] FIG. 3 shows a method that can be used with the systems of FIGS. 1 and 2.

[0026] FIG. 4 is a flowchart showing a process that can be used with the systems of FIGS. 1 and 2.

[0027] Application integration components can be used to integrate a variety of applications and systems, such as Enterprise Information Systems (EISs). Information technology (IT) organizations typically utilize several highly-specialized applications. Without a common integration platform to facilitate application-level integration, these applications cannot be integrated without extensive, highly-specialized development efforts.

[0028] Application integration can utilize adapters to establish an enterprise-wide, united framework for integrating any current or future application. Adapters can simplify integration efforts by allowing each application to be integrated with an application server, instead of requiring that each application being integrated with every other application.

[0029] The development and widespread acceptance of standards such as the Java 2 Platform, Enterprise Edition (J2EE) from Sun Microsystems, Inc. of Santa Clara, Calif., as well as the eXtensible Markup Language (XML), has laid the groundwork for a standardized approach to the development of these adapters. Perhaps the most significant of these standards for application integration is the J2EE Connector architecture. The J2EE Connector architecture provides a standardized approach for the development of adapters for all types of applications, from legacy mainframe applications, such as CICS from IBM, to packaged applications such as PeopleSoft, Siebel, and SAP. The adoption of such standards enables businesses to develop adapters that work on any J2EE-compliant application server, for example.

[0030] Integration Architecture

[0031] Application integration can build on this standardized approach in an application integration framework by providing a standards-based architecture for hosting J2EE Connector architecture-based adapters. Developers can build J2EE Connector architecture-compliant adapters and deploy these adapters, in the integration framework, to connect enterprise applications to an application server.

[0032] These adapters can be used to define business-focused interfaces to an EIS, the interfaces referred to herein as application views of the respective adapters. An application view can provide a simple, self-describing, consistent interface to services and events in an application. Application views can make use of an adapter for an EIS, making it possible to expose existing information systems as business services. Unlike adapters, however, an application view does not require users to have intimate knowledge of the EIS or the client interface for that EIS, such that non-programmers or technical analysts can use application views. An application view can provide a business-oriented way for business analysts to access enterprise data without worrying about the programmatic details defined in an adapter. These same users may be otherwise unable to use an adapter directly, due to a lack of familiarity with the EIS.

[0033] An application integration component directed at enterprise application integration can have several primary aspects. If the functionality of an EIS such as a PeopleSoft system or an SAP system is to be invoked, an implementation of the J2EE Connector Architecture can be used. If something occurs inside an EIS system, such as a trigger going off, an event can be generated. This event may, in some embodiments, need to be communicated to an external application. An event architecture in an application integration component can handle this communication.

[0034] Application Views

[0035] An application view can provide significant value to an application integration component. An application view can abstract away much of the complexity in dealing with an application, such as a backend EIS system. Application views can also simplify the way in which adapters are accessed. Application views can provide a layer of abstraction, for example, between an adapter and the EIS functions exposed by that adapter. Instead of accessing an EIS by direct programming a user can simply: edit an adapter's application views, create new application views, or delete any obsolete application view(s). A layer of abstraction formed by application views can help non-programmers maintain the services and events exposed by an adapter. Each application view can be specific to a single adapter, and can define a set of business functions on that adapter's EIS. After an adapter is created, a Web-based interface for the adapter can be used to define application views.

[0036] If an application view is used as a primary user interface for an adapter, a number of features can be included that are not commonly found in existing enterprise application integration technologies. Application views can, for example, use XML as a common language among applications. Service and event definitions can be used to expose application capabilities. XML schemas can be used to define the data for services and events. Bidirectional communication can also be supported in adapters.

[0037] An application view can be an integral part of an integration framework. An application view can provide a view of the application capabilities exposed by an adapter that a user can customize to meet specific needs. A user can tailor an application view, for example, for a specific business purpose. As a result, the application view can provide an effective alternative to the one size fits all approach that many applications provide for the design of a client interface. An application view can be defined for only the business or other capabilities that are applicable for a specific purpose. The capabilities can be customized such as by naming, describing, and defining the data requirements.

[0038] In one example, shown in FIG. 1, adapters 106, 108, 110 can be developed that allow a client application 100 to communicate with an Enterprise Information System 104 through the use of an application view 102. A developer can begin by coding an adapter that exposes the functionality in the enterprise application that accesses enterprise data. The functionality the adapter exposes could, for example, update records in a database using SQL statements, or could request information from an SAP system using its BAPI or IDOC interfaces. A business analyst, working with the developer, can then define an application view of the adapter using an application view interface.

[0039] An example of another system is shown in FIG. 2. In this figure, a client application 200 can communicate with an EIS 218 through an integration server 202. The integration server can be, for example, a web server or application server, and can be included in a cluster or integration system, represented here by the dotted line. The integration server can include an application view component 204 and a resource adapter 206 for the EIS 218. An XML schema API 208, useful in generating an XML schema 214 for the client application 200 using the schema object model 212 can be included in the integration server 202. An XML document API 210, which can provide an interface to an XML document using an IDocument component 216 such as IDoc class libraries, for example, can also be included on the integration server 202. The schema object model 212, XML schema 214, and IDocument component 216 do not need to be contained on the integration server 202, but should be accessible to the integration server.

[0040] An application view is an object, which can be implemented in one embodiment as a stateless session JavaBean. There can be a Java interface to the application view for the client application. A Java application can be custom coded to use that object, such as by passing XML in and receiving XML back. In addition, a business process manager component can be included that allows process engineers to define workflows, and allows application views to be invoked as business services. In a workflow, a callout can be made to an EIS to get information such as a customer's credit record. The fact that the application view is a Java object or enterprise JavaBean can be hidden from the process and designer.

[0041] A web services interface can also be used with an application view. A protocol such as SOAP can be used to invoke a web service. Another protocol that may be used includes UDDI, a platform-independent, open framework for describing services, discovering businesses, and integrating business services using the Internet. A WSDL protocol can also be used, which is an XML format for describing network services . A web services layer can be provided on top of the application view so that any application view can be invoked as a web service.

[0042] In application integration, new application views can be hot-deployed against an existing EIS through a web-based interface. An application view is hot-deployed when it is deployed with the system running, without restarting the destination server. A new customer management tool for SAP, for example, can also be defined through a web browser.

[0043] Integration Framework

[0044] Application integration can utilize an integration framework, which can provide a systematic, standards-based architecture for hosting application views. Features of such a framework can include application views for exposing application functions and design-time graphical user interfaces (GUIs), such as web-based interfaces that can be used for creating application views. The integration framework utilizes adapters, instead of hardwiring enterprise systems together. Once an adapter is deployed for an EIS, other components and applications can use that adapter to access data on the EIS.

[0045] A framework in accordance with one embodiment of the present invention relies on XML as the standard format for messages. XML includes XSLT, a standard for transforming XML documents into other XML documents. XSLT is designed for use as part of XSL, which is a stylesheet language for XML. In XSLT, an XML document is used to specify the operations to perform on a class of XML documents in order to transform the documents' structure and content. An XSLT transformation can make use of any of the operations built into the Java programming language, or can make use of custom operations written either in Java or in native code. An integration framework allows a business process to invoke an XSLT engine in order to transform XML messages.

[0046] An integration framework can also rely on standards for transporting messages such as Java Message Service (JMS) and HTTPS. JMS is a standard API for interfacing with message transport systems. Using JMS, a framework can utilize any message transport mechanism that provides a JMS interface. The J2EE Connector architecture standard does not specify a message transport mechanism, but an application integration framework can specify such a transport mechanism.

[0047] An integration framework can be based on an existing standard infrastructure, such as an application server that supports J2EE, JMS, and the J2EE Connector architecture. Using such a standard infrastructure also provides for high availability and scalability, such as by clustering and resource pooling. The framework can provide for universal connectivity by enabling the construction of XML-based application adapters that can connect to any legacy and packaged application. An adapter development kit can be used to allow users such as customers, system integrators, and packaged application vendors to quickly develop J2EE connector architecture-compliant and integration framework-based adapters. The framework can utilize XML, which means that the same data format can be used for both within- and between-enterprise integration, since many e-commerce systems use XML as the standard message format.

[0048] An integration framework can also utilize a business-process engine to allow non-programmers to graphically construct and maintain business processes. An integration framework can implement a common model on top of the J2EE Connector architecture that is focused on business-level concepts. This model, which can consist of XML-encoded events and services, allows the management of a consistent integration environment, regardless of the interface required between adapters and their target applications. The business processes can react to events generated by applications, and they can invoke an application's functionality via services that are exposed by an application adapter.

[0049] Adapter Development

[0050] XML development tools, such as may be included in an ADK, can be considered part of a metadata support layer for a design-time framework. These tools, which can comprise an XML Toolkit, can include an XML schema API, which can be characterized by a Schema Object Model (SOM). This API can be used to programmatically build XML schemas. An adapter can call an enterprise system or EIS for specific request and response metadata, which can then be programmatically transformed into an XML schema. The SOM is a set of tools that can extract many of the common details, such as syntactical complexities of XML schema operations so that a user can focus on its more fundamental aspects. Another tool that can be included is an XML Document API, which can be characterized by IDocument. This API can provide an x-path interface to a document object model (DOM) document.

[0051] An IDocument, which can facilitate XML input and output from the CCI layer in an adapter, is a higher-order wrapper around the W3C Document Object Model (DOM). The primary value-add of the IDocument interface is that it provides an XPath interface to elements in an XML document. Xpath is a language that can be used to address parts of an XML document, which can be used by both XSLT and Xpointer, for example. IDocument objects are queryable and updatable using XPath strings. For example, the following XML document describes a person named Bob and some of the details about Bob.

<Person nameBob>
	<Home squareFeet2000/>
	<Family>
	<Child nameJimmy>
	<Stats gendermale hairbrown eyesblue/>
	</Child>
	<Child nameSusie>
	<Stats genderfemale hairblonde eyesbrown/>
	</Child>
	</Family>
</Person>

[0052] By using IDocument, Jimmy's hair color can be retrieved using code such as:

	System.out.println(Jimmy's hair color:
	person.getStringFrom(//PersonnameBob/Family/Child
	nameJimmy/Stats/hair);

[0053] On the other hand, if DOM is used it would be necessary to use code such as:

	String strJimmysHairColor null;
	org.w3c.dom.Element root doc.getDocumentElement( );
	if (root.getTagName( ).equals(Person) &&
	root.getAttribute(name).equals(Bob)
	org.w3c.dom.NodeList list root.
	getElementsByTagName(Family);
	if (list.getLength( ) > 0)
	org.w3c.dom.Element family (org.w3c.dom.
	Element)list.item(0);
	org.w3c.dom.NodeList childList family.getElementsBy
	TagName(Child);
	for (int i0; i < childList.getLength( ); i)
	org.w3c.dom.Element child childList.item(i);
	if (child.getAttribute(name).equals(Jimmy))
	org.w3c.dom.NodeList statsList
	child.getElementsByTagName(Stats);
	if (statsList.getLength( ) > 0)
	org.w3c.dom.Element stats statsList.item(0);
	strJimmysHairColor stats.getAttribute(hair);

[0054] XCCI Design Pattern

[0055] XCCI is a low-level interface. It is an extension of the standard CCI interface for JCA, providing XML-formatted input and output to adapters. It also extends the standard DOM interface by supporting XPath functionality, thus making it convenient to use for navigating output documents. Application Views can be are built on top of XCCI, adding design-time data vs. runtime data features, as well as asynchronous capabilities not specified by JCA 1.0.

[0056] A common design pattern that emerges when using an XCCI approach is to support the definition of services in an interaction implementation. In other words, a javax.resource.cci.Interaction implementation for an adapter can allow a client program to retrieve metadata from an underlying EIS in order to define an Integration service. Specifically, this means that the interaction must be able to generate the request and response XML schemas and additional metadata for a service. Additionally, the Interaction could also allow a client program to browse a catalog of functions provided by the EIS. This approach facilitates a thin client architecture for an adapter.

[0057] Data Transformation Method

[0058] Data transformation is the process of taking data from an enterprise system and transforming the data into an XML schema that can be read by the application server. For each event, a schema can define what the XML output looks like. This can accomplished by using SOM and IDocument class libraries.

[0059] The following sample code listings show one data transformation sequence. The following code can be used to transform data from an EIS into an XML schema:

	SOMSchema schema new SOMSchema( );
	SOMElement root new SOMElement(SENDINPUT);
	SOMComplexType mailType new SOMComplexType( );
	root.setType(mailType);
	SOMSequence sequence mailType.addSequence( );
	SOMElement to new SOMElement(TO);
	to.setMinOccurs(1);
	to.setMaxOccurs(unbounded);
	sequence.add(to);
	SOMElement from new SOMElement(FROM);
	from.setMinOccurs(1);
	from.setMaxOccurs(1);
	sequence.add(from);
	SOMElement cc new SOMElement(CC);
	cc.setMinOccurs(1);
	cc.setMaxOccurs(unbounded);
	sequence.add(cc);
	SOMElement bcc new SOMElement(BCC);
	bcc.setMinOccurs(1);
	bcc.setMaxOccurs(unbounded);
	sequence.add(bcc);
	SOMElement subject new SOMElement(SUBJECT);
	subject.setMinOccurs(1);
	subject.setMaxOccurs(1);
	sequence.add(bcc);
	SOMElement body new SOMElement(BODY);
	if (template null)
	body.setMinOccurs(1);
	body.setMaxOccurs(1);
	else
	Iterator iter template.getTags( );
	if (iter.hasNext( ))
	SOMComplexType bodyComplex new
	SOMComplexType( );
	body.setType(bodyComplex);
	SOMAll all new SOMAll( );
	while (iter.hasNext( ))
	SOMElement eNew new
	SOMElement((String)iter.next( ));
	all.add(eNew);
	//endwhile
	bodyComplex.setGroup(all);
	//endif
	//endif
	sequence.add(body);
	schema.addElement(root);

[0060] The following example shows an XML schema created by the above code:

<xsd:schema xmlns:xsdhttp://www.w3.org/2001/XMLSchema>
<xsd:element nameSENDINPUT>
	<xsd:complexType>
	<xsd:sequence>
	<xsd:element nameTO maxOccursunbounded
	typexsd: string/>
	<xsd:element nameFROM typexsd:string/>
	<xsd:element nameCC maxOccursunbounded
	typexsd:string/>
	<xsd:element nameBCC maxOccurs
	unbounded typexsd:string/>
	<xsd:element nameBCC maxOccursunbounded
	typexsd:string/>
	<xsd:element nameBODY typexsd:string/>
	</xsd:sequence>
	</xsd:complexType>
</xsd:element>

[0061] The following example shows a valid XML document created by the schema shown above:

	</xsd:schema>
	<xml version1.0>
	<DOCTYPE SENDINPUT>
	<SENDINPUT>
	<TO/>
	<FROM/>
	<CC/>
	<BCC/>
	<BCC/>
	<BODY/>
	</SENDINPUT> <xsd:schema xmlns:xsd
	http://www.w3.org/2001/XMLSchema>

[0062] The adapter can be tested and then deployed. An adapter can be deployed manually, or through a tool such as a server or integration console.

[0063] XML Toolkit

[0064] An XML toolkit can be utilized that can help to develop valid XML documents to transmit information from an enterprise system to the application on the other side of the adapter. The toolkit can incorporate many of the operations required for XML manipulation into a single location, relieving the user of these often tedious chores.

[0065] An XML toolkit can be comprised primarily of two Java packages, such as a com.document package and a com.schema package. These packages can include complete Javadocs for each class, interface, and method.

[0066] IDOC

[0067] An IDocument, or IDoc, is a container that combines the W3C Document Object Model (DOM) with an XPath interface to elements in an XML document. This combination makes IDocument objects queryable and updatable simply by using XPath strings. These strings can eliminate the need to parse through an entire XML document to find specific information by allowing a user to specify just the elements the user wants to query and then returning the values of those queries.

[0068] IDocument can be a public interface that represents an XML document. An IDocument can provide a document type name, which can be used to refer to a description of its structure and usage. In addition, IDocuments can be mutable, and can provide methods for retrieving, modifying, adding, and removing data elements. All IDocument objects can be queryable, and can be updatable such as by using XPath strings. Also, IDocument instances can be serializable to, and un-serializable from, XML. IDocument objects can implement a Java interface such as java.io.Serializable.

[0069] The default representation of the document represented by an IDocument can be a W3C DOM instance, such as org.w3c.dom.Document. The IDocument may at times be in an unparsed state. This can happen if the IDocument was explicitly constructed this way, by using a method such as DocumentFactory.createDocument(String, boolean), for example, where the boolean argument is true. The internal state of an IDocument can be determined using a method such as isParsed(). If this returns true, then the content of the document has been parsed into a DOM. If false is returned, the IDocument may contain just the raw XML text.

[0070] In cases where an IDocument is in an unparsed state, the content can be parsed using a SAX (Simple API for XML) parsing scheme that allows a user to build an in-memory representation of the document that is not DOM. A method such as from XML (ContentHandler) can be used for this purpose, allowing a user to parse the document's content manually using an interface such as an implementation of a ContentHandler interface. A user could achieve similar results by getting the raw content from the IDocument and creating/invoking a custom SAX parser.

[0071] IDocument can simplify the code necessary to query and find information in a document, as opposed to code such as DOM code. For example, the following XML document describes a person named Bob and some of the details about Bob:

	<Person nameBob>
	<Home squareFeet2000/>
	<Family>
	<Child nameJimmy>
	<Stats sexmale hairbrown eyesblue/>
	</Child>
	<Child nameSusie>
	<Stats sexfemale hairblonde eyesbrown/>
	</Child>
	</Family>
	</Person>

[0072] In order to retrieve Jimmy's hair color from the <child> element by using IDocument, an XPath string can be created that seeks exactly that information, as shown the following IDocument data retrieval code sample:

System.out.println(Jimmy's hair color: person.getStringFrom
	(//PersonnameBob/Family/ChildnameJimmy/Stats/hair);

[0073] Schema Object Model (SOM)

[0074] A schema object model (SOM) is an interface useful for programmatically building schemas, such as XML schemas. SOM can comprise a set of tools that can extract and validate many of the common details, such as syntactical complexities of schema, so that a user can focus on more fundamental aspects. As shown in the method of FIG. 3, for example, an XML schema can be created for a client application using a schema object model 300. A component such as a resource adapter can call into an EIS for specific request/response metadata. Metadata will be received from the EIS in response to the request 302, which can be programmatically transformed into an XML document that conforms to the XML schema for the client application 304. At least a portion of the XML document can be validated against the XML schema for the client application 306. An IDocument interface can be used to parse and/or retrieve elements or portions from the XML document in order to validate those elements or portions. Once the XML document is validated, it can be passed to the client application as a response document 308.

[0075] A flowchart for such a method is shown in FIG. 4. The request is received from the client application to an EIS 400. The EIS returns metadata in response to the request 402. The metadata is transformed into an XML document 404. At least portions of the XML document can be parsed or extracted, such as by using an IDocument interface, and can be compared to the XML schema for the client application in order to validate those portions 406. A determination is made as to whether each portion is valid 408. If each portion is valid, the validated XML document can be returned to the client as a response document 410. If each portion is not valid, a determination should be made whether the client application should receive invalid documents 412. If the client should receive an invalid document, each error can be logged 414 and the validated (or invalidated) XML document is passed to the client as a response document 410.

[0076] If the client should not receive an invalid XML document, a determination can be made whether an end condition has been met 416. An end condition can be set so that an infinite loop is not created if the metadata cannot be transformed into a valid XML document. Valid in this instance means that the XML document is valid against the XML schema, not that the document is a valid XML document. The client application can receive a document that conforms to the XML schema but that is not a proper XML document. If the end condition has not been met, another attempt can be made to transform the metadata into an XML document 404. If the end condition has been met, such as a number of iterations or timeout period end being reached, an error can be returned to the client application and processing of this request can stop 418.

[0077] An XML schema is like a contract between the EIS and an application on the other side of the adapter. This contract can specify how data coming from the EIS must appear in order for the application to manipulate it. A document, or an XML-rendered collection of metadata from an EIS, can be considered valid if it meets the rules specified in the schema, regardless of whether or not the XML is correct. For example, if a schema required a name to appear in a <name> element and that element required two child elements, such as <firstname>and <lastname>, to be valid, the document from the EIS would have to appear in a form such as:

	<name>
	<firstname>Joe</firstname>
	<lastname>Smith</lastname>
	</name>

[0078] and the schema would have to appear in a form such as:

	<schema>
	<element namename>
	<complexType>
	<sequence>
	<element namefirstname />
	<element namelastname />
	</sequence>
	</complexType>
	</element>
	</schema>

[0079] No other form of <name></name>, such as <name>Joe Smith</name> would be valid, even though the XML is correct.

[0080] Creating the Schema

[0081] An XML schema can be created programmatically by using the classes and methods provided with SOM. One benefit of using such a tool is that it allows a user to tailor a schema for that user's needs simply by populating the variables in the program components. For instance, the following code examples create a schema that validates a purchase order document:

import com.bea.schema.*;
import com.bea.schema.type.SOMType;
public class PurchaseOrder
	public static void main(String args)
	System.out.println(getSchema( ).toString( ));
	public static SOMSchema getSchema( )
	SOMSchema po_schema new SOMSchema( );
	po_schema.addDocumentation(Purchase order schema for
	Example.com.nCopyright 2000 Example.com.nAll rights
	reserved.);
	SOMElement purchaseOrder
	po_schema.addElement(purchaseOrder);
	SOMElement comment po_schema.addElement(comment);
	SOMComplexType usAddress
	po_schema.addComplexType(USAddress);
	SOMSequence seq2 usAddress.addSequence( );
	// adding an object to a SOMSchema defaults to typestring
	seq2.addElement(name);
	seq2.addElement(street);
	seq2.addElement(city);
	seq2.addElement(state);
	seq2.addElement(zip, SOMType.DECIMAL);

[0082] One benefit to such a tool is that it is only necessary to populate the variables in the program components to tailor a schema for particular needs. Attributes can be set in the same way that elements are created, such as:

	SOMAttribute country_attr
	usAddress.addAttribute(country,
	SOMType.NMTOKEN);
	country_attr.setUse(fixed);
	country_attr.setValue(US);

[0083] To correctly set these attributes, their addressibility should be maintained. Like complexTypes, simpleTypes can be added to the root of the schema, such as:

	SOMSimpleType skuType po_schema.addSimpleType(SKU);
	SOMRestriction skuRestrict skuType.addRestriction
	(SOMType.STRING);
	skuRestrict.setPattern(d3-A-Z2);
	SOMComplexType poType
	po_schema.addComplexType(PurchaseOrderType);
	purchaseOrder.setType(poType);
	poType.addAttribute(orderDate, SOMType.DATE);

[0084] The addSequence() method of a SOMComplexType object can return a SOMSequence reference, allowing a user to modify the element that was added to the element. In this way objects can be added to the schema, such as by implementing an addSequence() method to modify an element:

	SOMSequence poType_seq poType.addSequence( );
	poType_seq.addElement(shipTo, usAddress);
	poType_seq.addElement(billTo, usAddress);

[0085] Attributes of an element within a schema can be set by calling setter methods of a SOMElement object. For example, an the implementation of setMinOccurs() and setMaxOccurs() can be given by:

SOMElement commentRef new SOMElement(comment);
	commentRef.setMinOccurs(0);
	poType_seq.add(commentRef);
	SOMElement poType_items poType_seq.addElement(items);
SOMComplexType itemType po_schema.addComplexType(Items);
SOMSequence seq3 itemType.addSequence( );
SOMElement item new SOMElement(item);
	item.setMinOccurs(0);
	item.setMaxOccurs(1);
	seq3.add(item);
SOMComplexType t new SOMComplexType( );
	item.setType(t);
SOMSequence seq4 t.addSequence( );
	seq4.addElement(productName);
SOMElement quantity seq4.addElement(quantity);
SOMSimpleType st new SOMSimpleType( );
	quantity.setType(st);
SOMRestriction restrict
	st.addRestriction(SOMType.POSITIVEINTEGER);
	restrict.setMaxExclusive(100);

[0086] In this example, the Items element for PurchaseOrderType was created before Items type. The reference can be created and the type set once the Items type object is available, such as by using:

[0087] poType_items.setType(itemType);

[0088] An element can also be added to the schema, such as by implementing an addElement() method of SOMSequence, or the add() method from a previously created SOMElement. These methods can be shown by:

seq4.addElement(USPrice, SOMType.DECIMAL);
	SOMElement commentRef2 new SOMElement(comment);
	commentRef2.setMinOccurs(0);
	seq4.add(commentRef2);
	SOMElement shipDate new SOMElement(shipDate,
	SOMType.DATE);
	shipDate.setMinOccurs(0);
	seq4.add(shipDate);
	t.addAttribute(partNum, skuType);
	return po_schema;

[0089] When running the code shown in the previous examples, the following schema can be created:

<xml version1.0 >
<DOCTYPE schema (View Source for full doctype...)>
	<xsd:schema xmlns:xsdhttp://www.w3.org/2000/XMLSchema>
	<xsd:annotation>
	<xsd:documentation>Purchase order
	schema for Example.com.
	Copyright 2000 Example.com. All rights
	reserved.</xsd:documentation>
	</xsd:annotation>
	<xsd:simpleType nameSKU>
	<xsd:annotation>
	</xsd:annotation>
	<xsd:restriction basexsd:string>
	<xsd:pattern valued3-A-Z2 / 22
	</xsd:restriction>
	</xsd:simpleType>
	<xsd:complexType namePurchaseOrderType>
	<xsd:sequence>
	<xsd:element typeUSAddress
	nameshipTo 22
	<xsd:element typeUSAddress namebillTo 22
	<xsd:element refcomment minOccurs0 22
	<xsd:element typeItems nameitems 22
	</xsd:sequence>
	<xsd:attribute nameorderDate typexsd:date 22
	</xsd:complexType>
	<xsd:complexType nameItems>
	<xsd:sequence>
	<xsd:element maxOccursunbounded
	nameitem
	minOccurs0>
	<xsd:complexType>
	<xsd:sequence>
	<xsd:element typexsd:string
	nameproductName 22
	<xsd:element namequantity>
	<xsd:simpleType>
	<xsd:restriction base
	xsd:positiveInteger>
	<xsd:maxExclusive value100 22
	</xsd:restriction>
	</xsd:simpleType>
	</xsd:element>
	<xsd:element typexsd:decimal name
	USPrice 22
	<xsd:element refcomment
	minOccurs0 22
	<xsd:element typexsd:date
	nameshipDate minOccurs0 22
	</xsd:sequence>
	<xsd:attribute namepartNum
	typeSKU 22
	</xsd:complexType>
	</xsd:element>
	</xsd:sequence>
	</xsd:complexType>
	<xsd:complexType nameUSAddress>
	<xsd:sequence>
	<xsd:element typexsd:string namename 22
	<xsd:element typexsd:string namestreet 22
	<xsd:element typexsd:string namecity 22
	<xsd:element typexsd:string namestate >
	<xsd:element typexsd:number namezip 22
	</xsd:sequence>
	<xsd:attribute namecountry usefixed valueUS
	typexsd:NMTOKEN 22
	</xsd:complexType>
	<xsd:element typePurchaseOrderType
	namepurchaseOrder 22
	<xsd:element typexsd:string namecomment 22
	</xsd:schema>

[0090] Validating an XML Document

[0091] Once the schema is created, it can be used to validate a document sent from the EIS. SOM can be used to validate XML DOM documents by using a SOMSchema method such as isValid(). SOMElement can have a corresponding isValid() method for validating an element instead of the DOM document. The isValid() method can determine if document or element is valid, and if not, can compile a list of the errors. If the document is valid, isValid() can return true and the list of errors can be empty.

[0092] An isValid() method can be implemented in a number of different ways, including the following ways:

	public boolean isValid(org.w3c.dom.Document doc,
	java.util.List errorList)
	public boolean isValid(IDocument doc,
	List errorList)

[0093] In this example, doc refers to the document instance to be validated, and errorList refers to a list of errors found in the document and/or doc.

[0094] The isValid() method can return a boolean value of true if the document is valid with respect to this schema. If the document is not valid with respect to the schema, isValid() can return false and the errorList can be populated. The errorList is a java.util.List for reporting errors found in the document, doc. The error list is cleared before validating the document. Therefore, the list implementation used must support the clear() method. If isValid() returns false, the error list is populated with a list of errors found during the validation procedure. The items in the list are instances of the class com.bea.schema.SOMValidationException. If isValid() returns true, errorList is empty. The following shows an example of an isValid() implementation:

	SOMSchema schema ...;
	IDocument doc DocumentFactory.createDocument
	(new FileReader(f));
	java.util.LinkedList errorList new
	java.util.LinkedList( );
	boolean valid schema.isValid(doc, errorList);...
	if ( valid)
	System.out.println(Document was invalid.
	Errors were:);
	for (Iterator i errorList.iterator; i.hasNext( );)
	System.out.println(((SOMValidationException)
	i.next).toString( ));

[0095] The foregoing description of preferred embodiments of the present invention has been provided for the purposes of illustration and description. It is not intended to be exhaustive or to limit the invention to the precise forms disclosed. Many modifications and variations will be apparent to one of ordinary skill in the art. The embodiments were chosen and described in order to best explain the principles of the invention and its practical application, thereby enabling others skilled in the art to understand the invention for various embodiments and with various modifications that are suited to the particular use contemplated. It is intended that the scope of the invention be defined by the following claims and their equivalence.