Apparatus and method for transforming web services into managed workflow actions

Description

FIELD OF THE INVENTION

This invention relates generally to data storage and retrieval in a networked environment. More particularly, this invention is directed to transforming a web service on the internet into a managed workflow action for use within a workflow automation system.

BACKGROUND OF THE INVENTION

A web service is a method of communication between two electronic devices in a networked environment, such as the internet. More particularly, a web service is a software system designed to support interoperable machine-to-machine interactions over a network. A web service has an interface described in a machine-processable format (e.g., Web Services Description Language or WSDL). Other systems interact with the web service in a manner prescribed by its description using Simple Object Access Protocol (SOAP) messages, typically conveyed using Hypertext Transport Protocol (HTTP) with an Extendable Markup Language (XML) serialization in conjunction with other Web-related standards.

Google® has a web service that provides weather information for a specified locale. The web service call http://www.google.com/ig/api?weather=seattle produces the following results.

	<?xml version=″1.0″ ?>
	- <xml_api_reply version=″1″>
	- <weather module_id=″0″ tab_id=″0″ mobile_row=″0″
	mobile_zipped=″1″ row=″0″ section=″0″>
	- <forecast_information>
	<city data=″Seattle, WA″ />
	<postal_code data=″seattle″ />
	<latitude_e6 data=″″ />
	<longitude_e6 data=″″ />
	<forecast_date data=″2012-06-20″ />
	<current_date_time data=″2012-06-20 19:53:00 +0000″ />
	<unit_system data=″US″ />
	</forecast_information>
	- <current_conditions>
	<condition data=″Clear″ />
	<temp_f data=″68″ />
	<temp_c data=″20″ />
	<humidity data=″Humidity: 49%″ />
	<icon data=″/ig/images/weather/sunny.gif″ />
	<wind_condition data=″Wind: NW at 14 mph″ />
	</current_conditions>
	- <forecast_conditions>
	<day_of_week data=″Wed″ />
	<low data=″54″ />
	<high data=″73″ />
	<icon data=″/ig/images/weather/mostly_sunny.gif″ />
	<condition data=″Mostly Sunny″ />
	</forecast_conditions>
	- <forecast_conditions>
	<day_of_week data=″Thu″ />
	<low data=″55″ />
	<high data=″81″ />
	<icon data=″/ig/images/weather/mostly_sunny.gif″ />
	<condition data=″Mostly Sunny″ />
	</forecast_conditions>
	- <forecast_conditions>
	<day_of_week data=″Fri″ />
	<low data=″54″ />
	<high data=″64″ />
	<icon data=″/ig/images/weather/chance_of_rain.gif″ />
	<condition data=″Chance of Showers″ />
	</forecast_conditions>
	- <forecast_conditions>
	<day_of_week data=″Sat″ />
	<low data=″52″ />
	<high data=″61″ />
	<icon data=″/ig/images/weatherichance_of_rain.gif″ />
	<condition data=″Chance of Rain″ />
	</forecast_conditions>
	</weather>
	</xml_api_reply>

The foregoing web service results have an ad hoc structure. The results include information, such as the forecast date, the current time, condition data, the temperature in Fahrenheit, the temperature in Centigrade, humidity data, wind condition data, a low temperature for the day, and the high temperature for the day. Similar data is provided for subsequent days of the week.

A user accessing this data may want a subset of the data and may want it formatted in a certain manner. Such customization is possible for a technically proficient individual, but is not practical for most computer users.

Tools have been developed that allow non-technical computer users to specify a workflow to accomplish a data processing task. A workflow is a computer controlled sequence of connected workflow actions. A workflow action is a computer controlled operation on one or more inputs to produce one or more outputs. Thus, a workflow action is a unit of work, such as connecting to a data source, performing a data transformation or initiating an interaction, such as granting approval or providing other forms of data.

A defined workflow is a user specified workflow. For example, a canvas may be used to graphically represent connected workflow actions forming a defined workflow.

The defined workflow may be operated in a closed domain of an enterprise. A closed domain is a private network. The private network may maintain privacy through controlled connections and/or through the use of an enterprise firewall. An open domain is a public network, such as the publicly accessible internet. An open domain has shared connections and observes various communication protocols.

Since an enterprise may operate in a closed domain, it is possible to control communication protocols and otherwise provide interoperability between components in the enterprise. A defined workflow may be formed with enterprise workflow actions. In such a case, the workflow is controlled by the enterprise to insure interoperability between workflow actions.

There are many resources outside a closed domain. That is, the open domain has a practically unlimited store of information. Much of this information is available through web services. Unfortunately, it is difficult to incorporate this open domain information into closed domain systems because of incompatible protocols and formats. As demonstrated with the exemplary method call above, information returned from a call to a web service may have an unruly format and may include information of no value to a user.

In view of the foregoing, it would be desirable to provide techniques to allow technically unsophisticated computer users to define workflows. More particularly, it would be desirable to provide tools to allow such users to create a defined workflow with enterprise workflow actions and open domain workflow actions. Ideally, enterprise style management and control features would be added to the open domain workflow actions so that they could be added to workflows in the same way as enterprise workflow actions.

SUMMARY OF THE INVENTION

A non-transitory computer readable storage medium includes executable instructions to supply a catalog of open domain workflow actions, receive a selected open domain workflow action and operate a service interface responsive to the execution of a defined workflow that includes the selected open domain workflow action. The service interface includes executable instructions to retrieve information from a web service and format the information for utilization in the defined workflow.

A non-transitory computer readable storage medium includes executable instructions to provide a workflow designer, receive a defined workflow including enterprise workflow actions and an open domain workflow action. The defined workflow is executed in a closed domain by processing the enterprise workflow actions natively and processing received formatted information in response to an open domain method call associated with the open domain workflow action.

BRIEF DESCRIPTION OF THE FIGURES

The invention is more fully appreciated in connection with the following detailed description taken in conjunction with the accompanying drawings, in which:

FIG. 1 illustrates a system configured in accordance with an embodiment of the invention.

FIG. 2 illustrates processing operations associated with an embodiment of the invention.

FIG. 3 illustrates a workflow canvas that may be utilized in accordance with an embodiment of the invention.

FIG. 4 illustrates a catalog of open domain workflow actions that may be supplied in accordance with an embodiment of the invention.

FIG. 5 illustrates a selected open domain workflow action on the canvas.

FIG. 6 illustrates open domain workflow action parameters that may be set in accordance with an embodiment of the invention.

FIG. 7 illustrates a canvas with a defined workflow comprising enterprise workflow actions and open domain workflow actions.

Like reference numerals refer to corresponding parts throughout the several views of the drawings.

DETAILED DESCRIPTION OF THE INVENTION

FIG. 1 illustrates a system 100 configured in accordance with an embodiment of the invention. The system 100 includes a set of enterprise computers 102_1 through 102_N. The enterprise computers 102 operate in a closed domain, but are connected to external servers 104_1 through 104_N and 106_1 through 106_N via a network 107, which may be any wired or wireless network. Closed domain isolation for the enterprise computers 102 may be established through the use of a firewall (not shown). Consequently, the enterprise computers 102 may operate in both the closed domain and access the open domain.

Each enterprise computer 102 includes standard components, such as a central processing unit 110 and input/output devices 112 connected via a bus 114. The input/output devices 112 may include standard components, such as a keyboard, mouse, display, printer and the like. A network interface circuit 116 is also connected to the bus 114 to provide network connectivity. A memory 120 is also connected to the bus 114. The memory 120 stores executable instructions to implement operations of the invention. In one embodiment, the memory 120 stores a workflow designer 122. The workflow designer 122 includes executable instructions to produce a defined workflow 128. In one embodiment, the workflow designer 122 includes a set of enterprise workflow actions 124. The enterprise workflow actions 124 are workflow actions defined within the closed domain. The enterprise workflow actions execute natively within the closed domain.

The workflow designer 122 may also include open domain workflow actions 126. The open domain workflow actions are workflow actions that retrieve information from the open domain. The open domain workflow actions execute in the closed domain after processing performed in accordance with the invention. In particular, the processing includes accessing a web service through an open domain hosted resource with a service interface. The service interface includes executable instructions to retrieve information from a web service and format the information for utilization in the defined workflow.

One or more of the servers 104 may operate as the open domain hosted resource. Server 104_1 includes standard components, such as a central processing unit 160 and input/output devices 164 connected via a bus 162. A network interface circuit 166 is also connected to the bus 162. A memory 170 is also connected to the bus 162. The memory stores executable instructions implementing an open domain workflow action manager 172. The open domain workflow action manager 172 is responsive to an open domain workflow action call. In response to the call, the open domain workflow action manager retrieves information from a web service and formats the information for utilization in the defined workflow.

Servers 106 may host various web services. Server 106_1 includes standard components, such as a central processing unit 180 connected to input/output devices 184 via a bus 182. A network interface circuit 186 is also connected to bus 182. A memory 190 stores a web service module 192, which provides standard web service functionality.

The configuration of system 100 is exemplary. Alternate system configurations may be used in accordance with embodiments of the invention. For example, individual processing modules may be duplicated on various machines or distributed across various machines.

FIG. 2 illustrates processing operations associated with an embodiment of the invention. FIG. 2 illustrates interactions between an enterprise domain, the open domain workflow action manager and a web service. Initially, the workflow designer 122 is invoked in the enterprise domain 200. A user may then construct a defined workflow by selecting enterprise workflow actions 202. A user may also access an open domain workflow action interface 204. In one embodiment, this results in a call to a hosting server 104 in the open domain. In particular, a call is made to the open domain workflow action manager 172, which supplies a catalog 206. The catalog is a list of available open domain workflow actions. The catalog is received at the enterprise domain 208. A user may then select an open domain workflow action. This results in a call to the open domain workflow manager 210, which receives the selection. The open domain workflow manager may supply configuration parameters associated with the open domain workflow action 212. The configuration parameters specify the types of information available and various formats for the information. Ideally, the configuration parameters are presented in a similar manner for all open domain workflow actions. Such an approach makes configuration setting simpler for a technically unsophisticated user. In the enterprise domain, configuration parameters are specified 214. The configuration parameters are then sent to and are received by the open domain workflow action manager 216.

Selection of enterprise workflow actions and open domain workflow actions results in a defined workflow 218. The defined workflow 218 may be subsequently executed 220. When an open domain workflow action is encountered in the defined workflow, a call is made to the open domain workflow action manager, which provides a service interface 222. The service interface 222 calls a web service, which supplies data 224. The service interface 222 formats the information for utilization in the defined workflow. The formatted information is then passed back to the defined workflow that is being executed.

The operations of the invention are more fully appreciated with a specific example. FIG. 3 illustrates a canvas 300 that may be used to construct a workflow. The canvas may be part of a workflow designer 122 operating on an enterprise computer 102. Enterprise workflow actions may be selected from one or more menus or lists in an enterprise workflow actions block 302. Open domain workflow actions may be accessed by clicking on a catalog button 304. This produces a call to the open domain workflow action manager 172 of server 104, which supplies the catalog.

FIG. 4 illustrates a catalog 400 of open domain workflow actions. The catalog 400 may include additional information 402, such as service provider details, a service description, service information and legal notices. The catalog 400 allows a user to easily identify open domain workflow actions. In this example, the user selects the Google® open domain workflow action 404.

The open domain workflow action appears as an action 500 in the workflow actions block 502 of FIG. 5. A user may drag and drop the action onto the canvas 300. This results in a workflow action block 502 between a start block 504 and an end block 506. Clicking on the workflow action block 502 may invoke a configuration parameter menu. Alternately, the configuration parameter menu may be automatically presented upon receipt of an action selection.

FIG. 6 illustrates an example of a configuration menu 600. In this example, the configuration menu allows one to specify a city name input 602 and a unit of measure input 604. Various output parameters are available for selection. For example, the output parameters may be selected from temperature 606, current conditions 608, humidity 610, unit of measure 612 and wind condition 614. Observe here that these outputs correspond to some, but not all, of the outputs provided by the example web service call above. For example, the forecast date, forecast time and weather conditions for additional days of the week were available in the results shown above, but this workflow action is configured to provide only some of the available outputs. Thus, the open domain workflow action may be configured to provide all web service outputs or a subset thereof. The configuration parameters may be default parameters.

The configuration menu allows a non-technical user to set parameters for a web service. The open domain workflow action manager provides a simplified interface to the web service and brokers communications with the web service, thereby isolating the non-technical user from the complications associated with a web service. Consequently, a generic web service may be utilized in an enterprise domain workflow.

Once the parameters are set, either by default or customization, an open domain workflow action is established. The open domain workflow action may then be used in a defined workflow.

The follow code is an example of an open domain workflow action constructed by the open domain workflow action manager for the Google® weather web service. This code allows the open domain workflow action to interface with enterprise workflow actions in a defined workflow. The code calls the open domain workflow action manager and provides specified parameters. The open domain workflow action manager contacts the specified web service to retrieve results and then formats those results for the defined workflow. The code below is annotated with asterisks (***) and numerals that correspond to the parameters specified in FIG. 6.

	<ConfigResponse xmlns=″http://contracts.nintex.com/live/2011/09/30″>
	<ServiceConfigs xmlns:i=″http://www.w3.org/2001/XMLSchema-instance″>
	<ServiceConfig>
	<TimeStamp xmlns=″http://schemas.datacontract.org/2004/07/Core.Contracts.Bus
	inessModels.Persistent″>0001-01-01T00:00:00</TimeStamp>
	<ProviderId>763f09e7-8d18-4bc1-a49c-d2f547c4b2d4</ProviderId>
	<ServiceId>8f08e3ec-8fd8-44bf-aab1-83e7936ab3a1</ServiceId>
	<ServiceVersionId>20110513130000</ServiceVersionId>
	<IconUrl>https://nintexlive.blob.core.windows.net/serviceicon/image_a01a520a
	-4379-4659-98ea-8b443d1ff7f3.png</IconUrl>
	<IconToolboxUrl>https://nintexlive.blob.core.windows.net/serviceicon/image_c
	c05409d-0995-422a-8db8-ad0eba15b74d.png</IconToolboxUrl>
	<ServiceName>Google weather</ServiceName>
	<Description>Get the current weather details for a specified
	location.</Description>
	<DefaultLcid>1033</DefaultLcid>
	<Parameters>
	<ConfigParameter>
	<InternalName>InputCityName</InternalName> ***602***
	<Name>City name</Name>
	<Description/>
	<ValueType>
	<IsDefault>false</IsDefault>
	<Name>String</Name>
	<Value>6</Value>
	</ValueType>
	<ParameterType>
	<IsDefault>true</IsDefault>
	<Name>UserProvided</Name>
	<Value>0</Value>
	</ParameterType>
	<LookupValueCollection xmlns:a=″http://schemas.microsoft.com/2003/10/Ser
	ialization/Arrays″/>
	<PropertyBag xmlns:a=″http://schemas.microsoft.com/2003/10/Serialization
	/Arrays″/>
	<Direction>
	<IsDefault>false</IsDefault>
	<Name>Input</Name>
	<Value>1</Value>
	</Direction>
	<Required>true</Required>
	</ConfigParameter>
	<ConfigParameter>
	<InternalName>InputUnit</InternalName>
	<Name>Unit of measure</Name>
	<Description/>
	<ValueType>
	<IsDefault>false</IsDefault>
	<Name>String</Name>
	<Value>6</Value>
	</ValueType>
	<ParameterType>
	<IsDefault>false</IsDefault>
	<Name>LookupList</Name>
	<Value>1</Value>
	</ParameterType>
	<LookupValueCollection xmlns:a=″http://schemas.microsoft.com/2003/10/Ser
	ialization/Arrays″>
	<a:KeyValueOfstringanyType>
	<a:Key>Celsius</a:Key>
	<a:Value i:type=″b:string″ xmlns:b=″http://www.w3.org/2001/
	XMLSchema″>c</a:Value>
	</a:KeyValueOfstringanyType>
	<a:KeyValueOfstringanyType>
	<a:Key>Farenheitqa:Key> ***604***
	<a:Value i:type=″b:string″ xmlns:b=″http://www.w3.org/2001/
	XMLSchema″>f</a:Value>
	</a:KeyValueOfstringanyType>
	</LookupValueCollection>
	<PropertyBag xmlns:a=″http://schemas.microsoft.com/2003/10/Serialization
	/Arrays″/>
	<Direction>
	<IsDefault>false</IsDefault>
	<Name>Input</Name>
	<Value>1</Value>
	</Direction>
	<Required>true</Required>
	</ConfigParameter>
	<ConfigParameter>
	<InternalName>OutputTemperature</InternalName>
	<Name>Temperature</Name> ***606***
	<Description/>
	<ValueType>
	<IsDefault>false</IsDefault>
	<Name>Double</Name>
	<Value>3</Va1ue>
	</ValueType>
	<ParameterType>
	<IsDefault>true</IsDefault>
	<Name>UserProvided</Name>
	<Value>0</Va1ue>
	</ParameterType>
	<LookupValueCollection xmlns:a=″http://schemas.microsoft.com/2003/10/Ser
	ialization/Arrays″/>
	<PropertyBag xmlns:a=″http://schemas.microsoft.com/2003/10/Serialization
	/Arrays″>
	<a:KeyValue0fComplexPropertiesanyTypeLODWZCN7>
	<a:Key>
	<IsDefault>false</IsDefault>
	<Name>VisibleByDefault</Name>
	<Value>5</Value>
	</a:Key>
	<a:Value i:type=″b:string″ xmlns:b=″http://www.w3.org/2001/
	XMLSchema″>True</a:Value>
	</a:KeyValue0fComplexPropertiesanyTypeLODWZCN7>
	</PropertyBag>
	<Direction>
	<IsDefault>false</IsDefault>
	<Name>Output</Name>
	<Value>2</Value>
	</Direction>
	<Required>false</Required>
	</ConfigParameter>
	<ConfigParameter>
	<InternalName>OutputCondition</InternalName>
	<Name>Current conditions</Name> ***608***
	<Description/>
	<ValueType>
	<IsDefault>false</IsDefault>
	<Name>String</Name>
	<Value>6</Va1ue>
	</ValueType>
	<ParameterType>
	<IsDefault>true</IsDefault>
	<Name>UserProvided</Name>
	<Value>0</Va1ue>
	</ParameterType>
	<LookupValueCollection xmlns:a=″http://schemas.microsoft.com/2003/10/Ser
	ialization/Arrays″/>
	<PropertyBag xmlns:a=″http://schemas.microsoft.com/2003/10/Serialization
	/Arrays″/>
	<Direction>
	<IsDefault>false</IsDefault>
	<Name>Output</Name>
	<Value>2</Va1ue>
	</Direction>
	<Required>false</Required>
	</ConfigParameter>
	<ConfigParameter>
	<InternalName>OutputHumidity</InternalName>
	<Name>Humidity</Name> ***610***
	<Description/>
	<ValueType>
	<IsDefault>false</IsDefault>
	<Name>String</Name>
	<Value>6</Value>
	</ValueType>
	<ParameterType>
	<IsDefault>true</IsDefault>
	<Name>UserProvided</Name>
	<Value>0</Value>
	</ParameterType>
	<LookupValueCollection xmlns:a=″http://schemas.microsoft.com/2003/10/Ser
	ialization/Arrays″/>
	<PropertyBag xmlns:a=″http://schemas.microsoft.com/2003/10/Serialization
	/Arrays″/>
	<Direction>
	<IsDefault>false</IsDefault>
	<Name>Output</Name>
	<Value>2</Value>
	</Direction>
	<Required>false</Required>
	</ConfigParameter>
	<ConfigParameter>
	<InternalName>OutputUnit</InternalName>
	<Name>Unit of measure</Name> ***612***
	<Description/>
	<ValueType>
	<IsDefault>false</IsDefault>
	<Name>String</Name>
	<Value>6</Value>
	</ValueType>
	<ParameterType>
	<IsDefault>true</IsDefault>
	<Name>UserProvided</Name>
	<Value>0</Value>
	</ParameterType>
	<LookupValueCollection xmlns:a=″http://schemas.microsoft.com/2003/10/Ser
	ialization/Arrays″/>
	<PropertyBag xmlns:a=″http://schemas.microsoft.com/2003/10/Serialization
	/Arrays″/>
	<Direction>
	<IsDefault>false</IsDefault>
	<Name>Output</Name>
	<Value>2</Value>
	</Direction>
	<Required>false</Required>
	</ConfigParameter>
	<ConfigParameter>
	<InternalName>OutputWindCondition</InternalName>
	<Name>Wind condition</Name> ***614***
	<Description/>
	<ValueType>
	<IsDefault>false</IsDefault>
	<Name>String</Name>
	<Value>6</Value>
	</ValueType>
	<ParameterType>
	<IsDefault>true</IsDefault>
	<Name>UserProvided</Name>
	<Value>0</Value>
	</ParameterType>
	<LookupValueCollection xmlns:a=″http://schemas.microsoft.com/2003/10/Ser
	ialization/Arrays″/>
	<PropertyBag xmlns:a=″http://schemas.microsoft.com/2003/10/Serialization
	/Arrays″/>
	<Direction>
	<IsDefault>false</IsDefault>
	<Name>Output</Name>
	<Value>2</Value>
	</Direction>
	<Required>false</Required>
	</ConfigParameter>
	</Parameters>
	</ServiceConfig>
	</ServiceConfigs>
	</ConfigResponse>

The open domain workflow action manager 172 may include additional code for message queue management. For example, the code may place a message (e.g., a web service request) in a queue if the message cannot be immediately serviced. In addition, the queue may be used in the event that a selected request fails because a web service is offline, in which case the message may be queued and the request to the offline web service may be attempted at a later time. The open domain workflow action manager may also include code to perform authentication operations.

FIG. 7 illustrates a defined workflow 700. The defined workflow has the same components as in FIG. 5, but includes additional enterprise workflow actions 702, 704 and 706. Enterprise workflow action 702 compares a received temperature from open domain workflow action 502 to a specified threshold. If the temperature is not cold, then an enterprise workflow action 704 is invoked. The workflow action 704 requests a seaside room, for example through an enterprise application that utilizes a pre-arranged rate at a designated hotel. If the temperature is cold, then an enterprise workflow action 706 is invoked to perform an alternate action.

An embodiment of the present invention relates to a computer storage product with a computer readable storage medium having computer code thereon for performing various computer-implemented operations. The media and computer code may be those specially designed and constructed for the purposes of the present invention, or they may be of the kind well known and available to those having skill in the computer software arts. Examples of computer-readable media include, but are not limited to: magnetic media such as hard disks, floppy disks, and magnetic tape; optical media such as CD-ROMs, DVDs, and holographic devices; magneto-optical media; and hardware devices that are specially configured to store and execute program code, such as application-specific integrated circuits (“ASICs”), programmable logic devices (“PLDs”) and ROM and RAM devices. Examples of computer code include machine code, such as produced by a compiler, and files containing higher-level code that are executed by a computer using an interpreter. For example, an embodiment of the invention may be implemented using JAVA®, C++, or other object-oriented programming languages and development tools. Another embodiment of the invention may be implemented in hardwired circuitry in place of, or in combination with, machine-executable software instructions.

The foregoing description, for purposes of explanation, used specific nomenclature to provide a thorough understanding of the invention. However, it will be apparent to one skilled in the art that specific details are not required in order to practice the invention. Thus, the foregoing descriptions of specific embodiments of the invention are presented for purposes of illustration. They are not intended to be exhaustive or to limit the invention to the precise forms disclosed; obviously, many modifications and variations are possible in view of the above teachings. The embodiments were chosen and described in order to best explain the principles of the invention and its practical applications, they thereby enable others skilled in the art to best utilize the invention and various embodiments with various modifications as are suited to the particular use contemplated. It is intended that the following claims and their equivalents define the scope of the invention.