U.S. patent application number 11/741318 was filed with the patent office on 2008-10-30 for method of deriving web service interfaces from form and table metadata.
This patent application is currently assigned to MICROSOFT CORPORATION. Invention is credited to Rognvaldur Kristinn Rafnsson.
Application Number | 20080271047 11/741318 |
Document ID | / |
Family ID | 39888609 |
Filed Date | 2008-10-30 |
United States Patent
Application |
20080271047 |
Kind Code |
A1 |
Rafnsson; Rognvaldur
Kristinn |
October 30, 2008 |
Method of Deriving Web Service Interfaces From Form and Table
Metadata
Abstract
A system and method of deriving web service interfaces from form
and table metadata is disclosed. The method uses a discovery
subsystem to discover services that are available on an application
server, retrieves the metadata descriptions of the services on the
application server and uses the services discovered and the
metadata descriptions to create web services interfaces such that
the service is available using web services description
language.
Inventors: |
Rafnsson; Rognvaldur Kristinn;
(Reykjavik, IS) |
Correspondence
Address: |
MARSHALL, GERSTEIN & BORUN LLP (MICROSOFT)
233 SOUTH WACKER DRIVE, 6300 SEARS TOWER
CHICAGO
IL
60606
US
|
Assignee: |
MICROSOFT CORPORATION
Redmond
WA
|
Family ID: |
39888609 |
Appl. No.: |
11/741318 |
Filed: |
April 27, 2007 |
Current U.S.
Class: |
719/311 ;
707/E17.107 |
Current CPC
Class: |
G06F 16/95 20190101;
G06F 40/174 20200101; G06F 9/451 20180201 |
Class at
Publication: |
719/311 |
International
Class: |
G06F 3/00 20060101
G06F003/00 |
Claims
1. A method of deriving web service interfaces from form and table
metadata comprising: using a discovery subsystem to discover
services that are available on an application server; retrieving
the metadata descriptions of the services on the application
server; and using the services discovered and the metadata
descriptions from a discovery subsystem to create web services
interfaces such that the service is available using web services
description language.
2. The method of claim 1, wherein the metadata is retrieved using a
web services definition language request.
3. The method of claim 1, further comprising communicating to the
application server using http for discovery and metadata
retrieval.
4. The method of claim 1, further comprising communicating from a
service client to the application server using soap over http for
service interactions.
5. The method of claim wherein the discovery subsystem response is
in DISCO format.
6. The method of claim 1 wherein abstractions intended to be web
accessible as a web-service are registered in a database table.
7. The method of claim 6, wherein the discovery subsystem is
populated from the database table.
8. The method of claim 7, wherein each record in the database
becomes an entry in the response if the record has been marked as a
service.
9. The method of claim 8, wherein each entry in the response
contains a uniform resource locator (url) pointing to the web
services description language (wsdl) description of the
service.
10. The method of claim 1, wherein a metadata provider provides the
description of the service interface that can be used by standard
tools that are compatible with the WSDL format.
11. The method of claim 10, wherein the metadata is used to define
the value types that are passed to the services in addition to the
messages.
12. The method of claim 10, wherein the form metadata points out
what fields from what tables the form saves its data to and wherein
the form metadata points out what fields from the tables are shown
on the form.
13. The method of claim 10, wherein the table metadata contains the
fields and their properties.
14. The method of claim 10, wherein an XML type is built from form
metadata and table metadata and the name of the service.
15. The method of claim 1, wherein each field on the form appears
as fields on the value type where the name and type of field is
used.
16. A computer readable storage medium comprising computer
executable code for deriving web service interfaces from form and
table metadata, wherein the computer code further comprises code
for: using a discovery subsystem to discover services that are
available on an application server; retrieving the metadata
descriptions of the services on the application server wherein the
metadata is retrieved using a web services definition language
request; and using the services discovered and the metadata
descriptions from a discovery subsystem to create web services
interfaces such that the service is available using web services
description language.
17. The computer readable medium of claim 16, wherein abstractions
intended to be web accessible as a web-service are registered in a
database table and wherein the discovery subsystem is populated
from the database table.
18. The computer readable medium of claim 16, wherein each entry in
the response contains a uniform resource locator (url) pointing to
the web services description language (wsdl) description of the
service.
19. A computer system comprising a processor for executing computer
executable code, a memory for storing computer executable code and
an input/output circuit, the computer executable code further
comprising code for deriving web service interfaces from form and
table metadata, wherein the computer code further comprises code
for: using a discovery subsystem to discover services that are
available on an application server; retrieving the metadata
descriptions of the services on the application server wherein the
metadata is retrieved using a web services definition language
request; and using the services discovered and the metadata
descriptions from a discovery subsystem to create web services
interfaces such that the service is available using web services
description language.
20. The computer system of claim 19, wherein a metadata provider
provides the description of the service interface that can be used
by standard tools that are compatible with the WSDL format; wherein
the form metadata points out what fields from what tables the form
saves its data to and wherein the form metadata points out what
fields from the tables are shown on the for; and wherein the table
metadata contains the fields and their properties.
Description
BACKGROUND
[0001] This Background is intended to provide the basic context of
this patent application and it is not intended to describe a
specific problem to be solved.
[0002] Computer applications that are designed to work in one
environment often are needed to work in a different environment.
For example, a computer application may be designed to be installed
on a hard drive of a computer such that the data is readily
available. However, as times change, a different environment may be
desired. For example, it may be desirable to have an application
available over the Internet in which case the application would not
be installed on every hard drive on every computer that is using
the application. Modifying the application to be available over the
Internet requires careful review and modification, although data is
available that describes the forms and tables used in the
application.
SUMMARY
[0003] This Summary is provided to introduce a selection of
concepts in a simplified form that are further described below in
the Detailed Description. This Summary is not intended to identify
key features or essential features of the claimed subject matter,
nor is it intended to be used to limit the scope of the claimed
subject matter.
[0004] Many applications are data driven applications where
abstractions of the data such as forms and tables are the driving
forces of the applications design. Considerable effort has gone
into defining the metadata behind those abstractions (tables,
forms, etc.) in applications. The metadata describes an interface
to the applications such as what fields are meaningful and what
interactions are available. For example, metadata for a sales order
form contains the fields for a header (buyer, date, delivery terms,
etc.) and the lines to create the form. The metadata may also
contain what the user can do with the form such as save, post,
ship, etc. By using this data, programmatic access may be granted
using simple object access protocol or SOAP.
[0005] A system and method of deriving web service interfaces from
form and table metadata is disclosed. The method uses a discovery
subsystem to discover services that are available on an application
server. The method retrieves the metadata descriptions of the
services on the application server. The method uses the services
discovered and the metadata descriptions to create web services
interfaces such that the service is available using web services
description language.
DRAWINGS
[0006] FIG. 1 is a block diagram of a computing system that may
operate in accordance with the claims;
[0007] FIG. 2 is an illustration of a flowchart of a method of
deriving web service interfaces from form and table metadata;
[0008] FIG. 3 is an illustration of system that implements the
method of FIG. 2; and
[0009] FIG. 4 is an illustration of the parts of the method that
assist in implementing the system.
DESCRIPTION
[0010] Although the following text sets forth a detailed
description of numerous different embodiments, it should be
understood that the legal scope of the description is defined by
the words of the claims set forth at the end of this patent. The
detailed description is to be construed as exemplary only and does
not describe every possible embodiment since describing every
possible embodiment would be impractical, if not impossible.
Numerous alternative embodiments could be implemented, using either
current technology or technology developed after the filing date of
this patent, which would still fall within the scope of the
claims.
[0011] It should also be understood that, unless a term is
expressly defined in this patent using the sentence "As used
herein, the term `______` is hereby defined to mean . . . " or a
similar sentence, there is no intent to limit the meaning of that
term, either expressly or by implication, beyond its plain or
ordinary meaning, and such term should not be interpreted to be
limited in scope based on any statement made in any section of this
patent (other than the language of the claims). To the extent that
any term recited in the claims at the end of this patent is
referred to in this patent in a manner consistent with a single
meaning, that is done for sake of clarity only so as to not confuse
the reader, and it is not intended that such claim term by limited,
by implication or otherwise, to that single meaning. Finally,
unless a claim element is defined by reciting the word "means" and
a function without the recital of any structure, it is not intended
that the scope of any claim element be interpreted based on the
application of 35 U.S.C. .sctn.112, sixth paragraph.
[0012] FIG. 1 illustrates an example of a suitable computing system
environment 1 00 on which a system for the steps of the claimed
method and apparatus may be implemented. The computing system
environment 100 is only one example of a suitable computing
environment and is not intended to suggest any limitation as to the
scope of use or functionality of the method of apparatus of the
claims. Neither should the computing environment 100 be interpreted
as having any dependency or requirement relating to any one or
combination of components illustrated in the exemplary operating
environment 100.
[0013] The steps of the claimed method and apparatus are
operational with numerous other general purpose or special purpose
computing system environments or configurations. Examples of well
known computing systems, environments, and/or configurations that
may be suitable for use with the methods or apparatus of the claims
include, but are not limited to, personal computers, server
computers, hand-held or laptop devices, multiprocessor systems,
microprocessor-based systems, set top boxes, programmable consumer
electronics, network PCs, minicomputers, mainframe computers,
distributed computing environments that include any of the above
systems or devices, and the like.
[0014] The steps of the claimed method and apparatus may be
described in the general context of computer-executable
instructions, such as program modules, being executed by a
computer. Generally, program modules include routines, programs,
objects, components, data structures, etc. that perform particular
tasks or implement particular abstract data types. The methods and
apparatus may also be practiced in distributed computing
environments where tasks are performed by remote processing devices
that are linked through a communications network. In a distributed
computing environment, program modules may be located in both local
and remote computer storage media including memory storage
devices.
[0015] With reference to FIG. 1, an exemplary system for
implementing the steps of the claimed method and apparatus includes
a general purpose computing device in the form of a computer 1 10.
Components of computer 110 may include, but are not limited to, a
processing unit 120, a system memory 130, and a system bus 121 that
couples various system components including the system memory to
the processing unit 120. The system bus 121 may be any of several
types of bus structures including a memory bus or memory
controller, a peripheral bus, and a local bus using any of a
variety of bus architectures. By way of example, and not
limitation, such architectures include Industry Standard
Architecture (ISA) bus, Micro Channel Architecture (MCA) bus,
Enhanced ISA (EISA) bus, Video Electronics Standards Association
(VESA) local bus, Peripheral Component Interconnect (PCI) bus also
known as Mezzanine bus, and the Peripheral Component
Interconnect-Express (PCI-E).
[0016] Computer 110 typically includes a variety of computer
readable media. Computer readable media can be any available media
that can be accessed by Computer 110 and includes both volatile and
nonvolatile media, removable and non-removable media. By way of
example, and not limitation, computer readable media may comprise
computer storage media and communication media. Computer storage
media includes both volatile and nonvolatile, removable and
non-removable media implemented in any method or technology for
storage of information such as computer readable instructions, data
structures, program modules or other data. Computer storage media
includes, but is not limited to, RAM, ROM, EEPROM, flash memory or
other memory technology, CD-ROM, digital versatile disks (DVD) or
other optical disk storage, magnetic cassettes, magnetic tape,
magnetic disk storage or other magnetic storage devices, or any
other medium which can be used to store the desired information and
which can accessed by computer 110. Communication media typically
embodies computer readable instructions, data structures, program
modules or other data in a modulated data signal such as a carrier
wave or other transport mechanism and includes any information
delivery media. The term "modulated data signal" means a signal
that has one or more of its characteristics set or changed in such
a manner as to encode information in the signal. By way of example,
and not limitation, communication media includes wired media such
as a wired network or direct-wired connection, and wireless media
such as acoustic, RF, infrared and other wireless media.
Combinations of the any of the above should also be included within
the scope of computer readable media.
[0017] The system memory 130 includes computer storage media in the
form of volatile and/or nonvolatile memory such as read only memory
(ROM) 131 and random access memory (RAM) 132. A basic input/output
system 133 (BIOS), containing the basic routines that help to
transfer information between elements within computer 110, such as
during start-up, is typically stored in ROM 131. RAM 132 typically
contains data and/or program modules that are immediately
accessible to and/or presently being operated on by processing unit
120. By way of example, and not limitation, FIG. 1 illustrates
operating system 134, application programs 135, other program
modules 136, and program data 137.
[0018] The computer 110 may also include other
removable/non-removable, volatile/nonvolatile computer storage
media. By way of example only, FIG. 1 illustrates a hard disk drive
140 that reads from or writes to non-removable, nonvolatile
magnetic media, a magnetic disk drive 151 that reads from or writes
to a removable, nonvolatile magnetic disk 152, and an optical disk
drive 155 that reads from or writes to a removable, nonvolatile
optical disk 156 such as a CD ROM or other optical media. Other
removable/non-removable, volatile/nonvolatile computer storage
media that can be used in the exemplary operating environment
include, but are not limited to, magnetic tape cassettes, flash
memory cards, digital versatile disks, digital video tape, solid
state RAM, solid state ROM, and the like. The hard disk drive 141
is typically connected to the system bus 121 through a
non-removable memory interface such as interface 140, and magnetic
disk drive 151 and optical disk drive 155 are typically connected
to the system bus 121 by a removable memory interface, such as
interface 150.
[0019] The drives and their associated computer storage media
discussed above and illustrated in FIG. 1, provide storage of
computer readable instructions, data structures, program modules
and other data for the computer 110. In FIG. 1, for example, hard
disk drive 141 is illustrated as storing operating system 144,
application programs 145, other program modules 146, and program
data 147. Note that these components can either be the same as or
different from operating system 134, application programs 135,
other program modules 136, and program data 137. Operating system
144, application programs 145, other program modules 146, and
program data 147 are given different numbers here to illustrate
that, at a minimum, they are different copies. A user may enter
commands and information into the computer 20 through input devices
such as a keyboard 162 and pointing device 161, commonly referred
to as a mouse, trackball or touch pad. Other input devices (not
shown) may include a microphone, joystick, game pad, satellite
dish, scanner, or the like. These and other input devices are often
connected to the processing unit 120 through a user input interface
160 that is coupled to the system bus, but may be connected by
other interface and bus structures, such as a parallel port, game
port or a universal serial bus (USB). A monitor 191 or other type
of display device is also connected to the system bus 121 via an
interface, such as a video interface 190. In addition to the
monitor, computers may also include other peripheral output devices
such as speakers 197 and printer 196, which may be connected
through an output peripheral interface 190.
[0020] The computer 110 may operate in a networked environment
using logical connections to one or more remote computers, such as
a remote computer 180. The remote computer 180 may be a personal
computer, a server, a router, a network PC, a peer device or other
common network node, and typically includes many or all of the
elements described above relative to the computer 110, although
only a memory storage device 181 has been illustrated in FIG. 1.
The logical connections depicted in FIG. 1 include a local area
network (LAN) 171 and a wide area network (WAN) 173, but may also
include other networks. Such networking environments are
commonplace in offices, enterprise-wide computer networks,
intranets and the Internet.
[0021] When used in a LAN networking environment, the computer 110
is connected to the LAN 171 through a network interface or adapter
170. When used in a WAN networking environment, the computer 110
typically includes a modem 172 or other means for establishing
communications over the WAN 173, such as the Internet. The modem
172, which may be internal or external, may be connected to the
system bus 121 via the user input interface 160, or other
appropriate mechanism. In a networked environment, program modules
depicted relative to the computer 110, or portions thereof, may be
stored in the remote memory storage device. By way of example, and
not limitation, FIG. 1 illustrates remote application programs 185
as residing on memory device 181. It will be appreciated that the
network connections shown are exemplary and other means of
establishing a communications link between the computers may be
used.
[0022] FIG. 2 is an illustration of a method of deriving web
service interfaces from form and table metadata. As more and more
applications are being shifted from being locally based to web
based, there has been a need to automate the process of converting
locally based applications to applications that are available over
a broader network, such as the Internet. Most business applications
are data driven applications where abstractions of the data such as
forms and tables are the driving forces of the applications'
design. Considerable effort has gone into defining the metadata
behind those abstractions (tables, forms, etc.) in applications.
The metadata describes an interface to the applications such as
what fields are meaningful and what interactions are available. For
example, metadata for a sales order form contains the fields for a
header (buyer, date, delivery terms, etc.) and the lines to create
the form. The metadata may also contain what the user can do with
the form such as save, post, ship, etc this might be represented as
a button or menu option on a form or by other means. By using this
data, programmatic access may be granted using simple object access
protocol or SOAP.
[0023] In some applications, tables may be considered the lowest
level of abstraction. For example, a table may define a set of
fields that are related to an entity and those fields may contain
value or be calculated from values both with in this table or other
tables. Field also may have properties such as type of value
(string, integer, etc.) and its size (string length of 50, for
example). In addition, a table also may include indices to optimize
finding of entities and triggers/events for validation logic on
insert, update and delete.
[0024] Code unit abstraction is a standard method oriented
procedural abstraction that defines an interface to a method in a
manner similar to program languages like visual basic.
[0025] Form abstraction defines user interfaces for an application.
Form abstraction groups together fields for users and only shows
the fields that are relevant for the user. Form abstraction may
also provide the means for a user to interact with the data such as
view, insert and modify as well as access to the functionality of
the system such as posting an order or generating a shipment
notice. The form defines the external view for an entity (such as a
sales order), it defines the fields in the view and if the view
permits or allows functions such as read, modify, insert, delete as
well as defining what fields are read only and what fields are
editable. By deriving from, the user interface for an application,
the application may be made available using remote technology such
as web service technology.
[0026] Referring again to FIG. 2, at block 200, a discovery
subsystem may be used to discover services that are available on an
application server. FIG. 3 may be an illustration of a sample
system deployment of the method. A service client 305 may be a
consumer or developer of the service. The service client 305 may
communicate a discovery request 310 to a server 315 of the
application through the communication cloud 320. In one embodiment,
the communication cloud is the internet and the communication
occurs using http over TCP/IP. Of course, other embodiments are
possible. For example, the client and server could be local, such
as on an intranet.
[0027] At block 210, the service client 305 (FIG. 3) may request
metadata descriptions 325 of the services on the application server
315. The server 315 may return the metadata request 325 using the
communication cloud 320. In another embodiment, the metadata is
retrieved using a web services definition language request. Service
requests 330 may also use the communication cloud 320.
[0028] At block 220, the services discovered 310 and the metadata
descriptions 325 are used to create web services interfaces such
that the service is available using web services description
language. Communication from the service client to the application
server may use soap over http for service interactions such as
insert and update.
[0029] FIG. 4 is an illustration of how the various requests may be
handled. As previously mentioned, a client or developer 405 may
request metadata 410 from an application. The request may be
delivered by the server infrastructure (IIS) 415 to the service
broker 420. The service broker 420 may then determine what type of
request it is and then route to an applicable subsystem. The
individual subsystems handle the requests.
[0030] One subsystem is the discovery subsystem 425. The discovery
subsystem allows clients/developers to discover what services are
available from the system. The response may be in a variety of
formats including the DISCO format from Microsoft Corporation. Once
a Web Service has been deployed, potential users must be able to
discover where it is and how it works. DISCO is a Microsoft.RTM.
technology for publishing and discovering Web Services, Universal
Description, Discovery, and Integration (UDDI) is an industry-wide
initiative that defines a SOAP-based protocol for updating and
querying Web Service information repositories. Like DISCO, UDDI
makes it possible to publish and discover a Web Service, maximizing
the site's reach and ultimate success.
[0031] The Web Service Description Language (WSDL) is an ongoing
initiative that's attempting to standardize how Web Services can be
described in XML format. A WSDL document describes a service's
operations in terms of messages and (typically) XML Schema type
definitions, as well as how they are bound to various protocols and
endpoints. Once a client can get its hands on a WSDL document, it
should have enough information to know how to interact with the
target Web Service. If the client knows where the WSDL document
resides, it can simply ask for it via HTTP. However, if the client
doesn't know where the WSDL lives, a discovery mechanism is
needed.
[0032] Discovery with DISCO
[0033] In the past, most consumers found out about new Web Services
(and their endpoint addresses) by browsing the Web, receiving an
e-mail, or by word-of-mouth. DISCO can define a document format
along with an interrogation algorithm, making it possible to
discover the Web Services exposed on a given server. DISCO also
makes it possible to discover the capabilities of each Web Service
(via documentation) and how to interact with it (via WSDL). To
publish a deployed Web Service using DISCO, a user needs to
register a service with in application server.
[0034] The .disco response is an XML document that simply contains
links to other resources that describe the Web Service, much like
an HTML file that contains human-readable documentation or a WSDL
file containing the interface contract.
[0035] Abstractions from the data underlying the application that
is intended to be web accessible as a web-service such as forms 430
and tables 435 are registered in a database table. The discovery
subsystem 425 is populated from the database table. Each record in
the database becomes a web service entry with in DISCO response in
the response if a user has marked it as a service. Each entry in
the response may contain a uniform resource locator (url) pointing
to the web services description language (wsdl) description of the
service.
[0036] METADATA Provider
[0037] The metadata provider 440 may provide the description of the
service interface that may be used by standard tools such as tools
that can understand the WSDL format. A client/developer may request
a description of a specific service. The system loads the metadata
427 that describes this service such as the forms 430 and tables
435. The metadata 427 is then used to define the value types that
are passed to the service as well as the messages.
[0038] The value type part of the WSDL is derived from metadata 427
described both on forms 430 and tables 435. The system starts by
loading the form metadata 427 and the form metadata 427 holds
information about what tables 435 to which the form 430 saves data.
The form 430 metadata 427 also points out what fields from the
tables 435 are shown on the form 430. The table metadata 437
contains the fields and their properties like type (and size) and
name. An xml type is built from this metadata information 427 in
addition to the name of the service. The name of the service forms
the name of the value type, then each field on the form show up as
field on the value type where the name and type of the field is
used.
[0039] Say an application has a table 435.
TABLE-US-00001 table id=1 => Customers { field id=1 =>
Name:string(100), field id=2 => TelephoneNumber:string(16),
field id=3 => Rating:int } And a form 430: form id=2 =>
CustomerCard{ table-ref 1, field-ref 1, field-ref 2, can-read true,
can-insert true, can-modify true, can-delete false }
[0040] This form 430 can insert a new record in table Customers.
This form 430 also can edit and read fields Name and
TelephoneNumber but it can not delete a record nor read or edit the
Rating field. It would be desirable to have access to this
view/form 430 as a programmatic construct. To do so, the view/form
430 may be registered as a service.
[0041] Register Form:2 as Customer
[0042] By registering the form 430 CustomerCard as a service, the
WSDL description may be retrieved and services may be invoked
described in the WSDL. The WSDL file contains following
information:
[0043] The methods: Find, Insert, Update and Get,
[0044] It contains a type called Customer that has 2 fields: Name
and TelephoneNumber.
[0045] This type is the parameter to the methods.
[0046] Dispatcher
[0047] The dispatcher 445 receives the actual service requests. The
service request is formatted to the specification provided in WSDL
provided by metadata provider 440. The basic operation of the
dispatcher 445 is to dispatch a message by virtually filing out the
form 430 and invoking the right methods of the form 430 or fill out
the response with information from the form 430.
[0048] Although the forgoing text sets forth a detailed description
of numerous different embodiments, it should be understood that the
scope of the patent is defined by the words of the claims set forth
at the end of this patent. The detailed description is to be
construed as exemplary only and does not describe every possible
embodiment because describing every possible embodiment would be
impractical, if not impossible. Numerous alternative embodiments
could be implemented, using either current technology or technology
developed after the filing date of this patent, which would still
fall within the scope of the claims.
[0049] Thus, many modifications and variations may be made in the
techniques and structures described and illustrated herein without
departing from the spirit and scope of the present claims.
Accordingly, it should be understood that the methods and apparatus
described herein are illustrative only and are not limiting upon
the scope of the claims.
* * * * *