System and method for generic configuration for web interfaces
The disclosed system and method provides a generic user interface that can be dynamically configured with configuration data provided by a product coupled to the user interface. The user interface may be hosted on a client system and obtain product configuration data through a server based on requests to and responses from the server. A generic user interface document containing configuration keys can be initially loaded into the user interface. The generic document is scanned to detect the configuration keys, at least some of which configuration keys are used to construct a request for configuration data from the product. The request is processed to return configuration data to the user interface, which can then completely render all the interface components representative of the configuration of the product. The product may be implemented as a gateway, for example, in a telecommunications network.
1 . A method for dynamically configuring a user interface for use with a product, the method comprising:
loading a generic document having configuration keys into the user interface;
scanning the generic document to detect at least some configuration keys;
composing a request having a content related to the detected configuration keys for submission to the product to obtain configuration data from the product;
receiving a response having configuration data corresponding to the detected configuration keys from the product; and
rendering the user interface with the configuration data.
2 . The method according to claim 1 , further comprising:
constructing the generic document as an HTML document.
3 . The method according to claim 1 , further comprising:
scanning the generic document using scanning logic.
4 . The method according to claim 3 , wherein:
using scanning logic further comprises using a script.
5 . The method according to claim 1 , further comprising:
composing the request as an XML file.
6 . The method according to claim 1 , further comprising:
receiving XML formatted data as the response having configuration data corresponding to the detected configuration keys for the product.
7 . The method according to claim 6 , further comprising:
providing one or more data types in the XML formatted data.
8 . The method according to claim 6 , further comprising:
providing configuration data in the XML formatted data indicating, for an interface component or group of interface components, one or more of a restart being required, disablement, a change to a label or an error condition.
9 . The method according to claim 1 , further comprising:
rendering the user interface with the configuration data using a script engine.
10 . The method according to claim 1 , further comprising:
implementing the product as a gateway with an embedded web server.
11 . The method according to claim 1 , wherein receiving a response further comprises:
receiving all attributes of an interface component used to render the interface component in the user interface.
12 . The method according to claim 1 , further comprising:
composing an AJAX request for submission to the product to obtain configuration data from a product.
13 . The method according to claim 1 , further comprising composing:
a request to obtain configuration data for one or more of an interface component or a group of interface components.
14 . The method according to claim 1 , further comprising:
using the rendered user interface to undertake one or more of a product maintenance, upgrade, configuration, status query or operating parameter query.
15 . The method according to claim 1 , further comprising:
representing a group of interface components with at least one configuration key.
16 . A client-server system implementing the method of claim 1 with the client hosting the user interface and the server interacting with the product.
17 . A method for dynamically configuring a user interface with configuration data related to a product and obtained through a server, the method comprising:
loading a generic document having configuration keys into the user interface;
scanning the generic document to detect the configuration keys;
composing a request having a content related to the detected configuration keys for submission to the server to obtain configuration data for the user interface;
processing the request at the server to generate a response having configuration data corresponding to the detected configuration keys;
providing the response to the user interface; and
rendering the user interface with the configuration data.
18 . The method according to claim 17 , further comprising:
providing configuration data in the response as XML formatted data indicating, for an interface component or group of interface components, one or more of a restart being required, disablement, a change to a label or an error condition.
19 . A system for dynamically configuring a user interface for use with a product, comprising:
a processing engine coupled to a memory storage being operable to store program instructions executable by the processing engine to:
load a generic document having configuration keys into the user interface;
scan the generic document to detect the configuration keys;
compose a request having a content related to the detected configuration keys for submission to the product to obtain configuration data from the product;
receive a response having configuration data corresponding to the detected configuration keys from the product; and
render the user interface with the configuration data.
20 . The system according to claim 19 , further comprising:
the generic document being implemented as an HTML document.
21 . The system according to claim 19 , further comprising:
a scripting engine accessible by the processing engine to scan the generic document to detect the configuration keys.
22 . The system according to claim 19 , wherein:
the response further comprises an XML file.
23 . The system according to claim 19 , wherein:
the product further comprises a gateway with an embedded web server.
24 . A system according to claim 19 , further comprising:
the configuration data in the response being provided in an XML format and having an indication, for an interface component or group of interface components, for one or more of a restart being required, disablement, a change to a label or an error condition.