GB2354862A - Automatic documentation of configurable systems - Google Patents

Abstract

A method for production and management of documentation for configurable systems comprises retrieving configuration parameters from the configurable system and merging them with text segments to produce a document specific to the system as configures. Alternatively different text segments are selected or compiled responsively to the value of certain configuration parameters. The system may be a medicated documentation server for automatic documentation generation and management, connected to the configurable system via a data network, such as an intranet or the internet. The configurable system is self-documenting. A collector program 120 may be used to retrieve the configuration parameters. The documentation may be displayed on a web browser. Text templates may be used to generate the documents.

Description

2354862 1 I Method and system for Automatic Documentation of 2

Configurable Systems.

3 4 The present invention relates to computer systems in general, and more particularly to systems and'methods for 6 the generation and management of automatic documentation for 7 configurahle computerized systems.

8 9 Background of the Invention

Collaborative computerized configurable systems are computer 11 software systems, computer hardware systems or combinations 12 thereof, wherein a system behavior is controlled and 13 modifiable by a set of configuration data. Examples of such 14 systems include, (but are not limited to), database management systems, electronic messaging and mail software 16 and servers, electronic commerce systems, computer operating 17 systems, (especially multi user system such as Unix@ or 18 Microscft Windows NTO), database management systems, 19 configurable network equipment such as routers switches, and the like. Those systems may comprise a single computer or 2 1 multiple, interconnected computers, known as multi-server 2 systems.

3 4 Configuration data is a collection of configuration parameters and data objects that control and modify at least 6 a portion of the configurable system behavior. Complex 7 configurable systems typically have a large number of such 8 configuration parameters, often ranging in the hundreds and 9 sometimes thousands of parameters. Often cross dependencies are observed, where a change of one parameter 11 will cause unforeseen and unintended system behavior 12 requiring change to other parameters. Configuring such 13 systems is difficult, and requires a high level of 14 knowledge, skill and experience. The problem becomes exponentially more complex when several such systems are 16 conneited together, for example a number of cooperating 17 computer servers, distributed e-mail servers, distributed 18 database systems, and cooperating network switches and 19 routers or any other distributed configurable system. In those cases, changing a parameter on one system may even 21 disrupt the operation of another.

22 23 Due to the complexity involved in the configuration, once 24 configured, the configurable system becomes a system of its own merit, a special case separate from the general case of 26 the generic non-configured system. While the configured 27 system behavior may be constructed and understood using 28 documentation for the generic system combined with 29 configurat-ion data, such construction is time consuming and 3 1 often wasteful and expensive. Therefore it is highly 2 desirable to document the specific case of every instance of 3 the configured system separately, in order to ease 4 maintenance and troubleshooting, as well as to facilitate knowledge transfer to new personnel, and generally increase 6 operational efficiency.

7 8 Generating such documentation is an extremely tedious job 9 that often requires a highly trained professional to perform. Since the configuration of such systems changes 11 with time, the task is a continual one, taxing information 12 technology personnel. And thus automatic generation of such 13 documentation as shown by the present invention is clearly 14 advantageous. In these specifications, the word "automatic" and its derivative means an operation that is, 16 or may be, created or coordinated primarily by a machine or 17 a computer, especially as compared to chores and tasks that 18 were formerly done primarily by human labor. In an 19 automatic documentation generation step for example, little or no manual user intervention is necessary. Manual 21 intervent'Lon implies steps such as manual data entry of 22 configuration parameters, repeated text entries, etc.

23 24 Constraint programming (alternatively referred to as "constraints-based reasoning", or "constraint satisfaction") 26 is a technique, most appropriate for computer use, which is 27 based on creating a model of a problem in terms of the 28 requirements for a solution. By defining acceptable values 29 to variables and constraints that define and optionally 4 1 quantify the allowed relationships among the values assigned 2 to variables, a formal representation of the problem is 3 produced. Standard constraints programming methods can use 4 this representation to find a solution to the problem. The technique also offers an efficient approach to problem 6 solving by making inferences on possible solutions. The 7 technology is well known in the art. By way of example, 8 constraints programming was used as an aid to system 9 configuration as described in US patent 5,708,798 to Lynch et al. and in PCT/US97/21218 to Elfe et al. Constraint 11 programming easily lends itself to diagnostics and also to 12 the autom,tic documentation process described herewith.

13 14 While most configurable systems provide means for reading and printing the system configuration data, a distinction 16 should be drawn between raw configuration data and 17 documentation. Raw configuration data often relates to a 18 single system in a multi-system environment, and is mostly a 19 cryptic list of variable names with their associated values, with little if any explanation of their meaning. An 21 excellent example of raw configuration data may be found in 22 Windows Registry, which is a common configuration space for 23 the Microsoft Windowso operating systems. Documentation on 24 the other hand, is an organized collection of knowledge that, separately or in combination, represents the state or 26 configuration of a system, teaches system operation, and 27 aids in troubleshooting. Documentation is 28 characteristically constructed of complete sentences in a 29 human readable language, with appropriate punctuation, paragraph and optionally section separation. Typically, 1 documentation also includes access tools such as a table of 2 contents (TOC) or an -L'ndex to further ease access to 3 specific sections of the data. Generally, documentation 4 also attempts to explain the meaning behind the configuration parameters, optionally including the 6 relationships between multiple systems and the meaning of 7 several key parameters and their effect on system operation.

8 Another optional feature of documentation is the ability to 9 propose configurable parameter values for sample systems, or, in the case of the current invention, the system being 11 documented. Optionally, drawings depicting the condition and 12 interrelationship between the described system elements 13 further enhance the documentation. It should also be noted 14 that dccumentation is characterized primarily by its content and organization, and not by the medium on which it is 16 presented. Thus documentation may be printed on paper, 17 viewed or edited on a computer screen by the likes of a word 18 processor or a World Wide Web browser, etc. Whether viewed 19 on a computer screen or printed on paper, documentation helps preserve and manage the knowledge accumulated in an 21 organization. It thus increases operational efficiency, 22 helps educate new members, and aids in problem solving and 23 design for future expansion.

24 There are currently several aids to grouping and displaying 26 raw configuration data relating to computer systems. One 27 such example is available from MessageWisea in Ottawa, 28 Ontario, Canada. This system reads configuration data from 29 several Microsoft Exchange servers, and places them in a database. Queries can then be placed against the data to 6 find answers to specific question. However the MessageWise 2 system does not provide a well-documented meaning of a 3 textual and visual description, organized in an easily read 4 document as described above.

6 Another configuration data collection tool named Emap and 7 distributed by Microsofto' Corporation of Redmond WA, USA, 8 provides a graphical representation of connections between 9 exchange servers in an organization. Similarly, several products allow representing an organizational data or voice 11 network by drawings representing the network structure.

12 These types of products are exemplified in US patent 13 5,926,463 to Ahern et al.

14 None of the above solutions provide documentation as 16 described earlier in these specifications. All lack the

17 effects and efficiency of teachings that a well organized 18 textual and visual document provides, and thus do not 19 provide t.e dept of knowledge preservation and knowledge management provided by such documents. It is clear 21 therefore that there is an unfulfilled need in the industry 22 to provide automated documentation generation, re 23 generation, and management tools for highly configurable 24 systems.

26 Summary of the Invention

7 1 It is therefore a goal of the current invention to provide a 2 method and a system for automatic generation of 3 documentation for computerized configurable systems.

4 The embodiments of the invention derive documentation from a 6 combination of generic system knowledge and the 7 configuration data of a specific system instance, such as 8 one or more configured systems. They thus retrieve or 9 gather, configuration parameters into a computer, and the computer selects predetermined explanatory text segments 11 corresponding with relevant configuration parameters.

12 (Retrieve, collect or gather are used interchangeably in 13 this application and in this context of gathering 14 configuration parameters from a configurable system) The computer outputs the selected text segments together with 16 the corresponding parameters, thus forming a document 17 specific to the configurable system. Preferably, the output 18 is divided into sections and paragraphs where the parameter 19 or a group of parameters, associated with a specific segment or paragraph is outputted in proximity to each other.

21 Furthermore, the current invention preferably groups 22 interrelai-ed parameters and their associated text segments 23 in proximity to each other.

24 Text selection is generally done by a template, implemented 26 by any convenient method. The template will generally 27 include placeholders for the configuration variables and 28 their values, and optionally drawings and other explanatory 29 material. The template may be implemented as a collection 8 1 of text stored in a file, embedded within the program code, 2 or in a database. Alternatively or in combination, the 3 template may comprise text segments included as print 4 statements that are selectively executed according to specific system configurations and other environmental 6 conditions such as system location, ownership data and the 7 like. These specifications relate interchangeably to

8 different methods of producing a document from predetermined 9 text segments merged with configuration parameters, as utilizing a template. Specific embodiments may use 11 different methods as a matter of technical choice.

12 13 Preferably, the invention also automatically generates tools 14 to ease the access to the information in such a document.

optionally, the invention also provides a table of contents 16 (TOC) detailing the relative locations of certain sections 17 of the document. An index of selected parameters and 18 sections in the document is also provided, detailing their 19 relative locations. Both the table of contents and the index may be adapted best to the document media, for example 21 a printed TOC and index when the document is printed on 22 paper, and alternatively hyperlinks or other computerized 23 access methods may be used when the documentation is viewed 24 on computer screen.

26 The invention is easily adaptable for various types of 27 configurable systems having configurable parameters 28 accessible by computer, especially for configurable software 29 applications. Listed below are but a small sample of the 9 1 systems and system types for which the invention is 2 especially adaptable and beneficial: electronic messaging 3 and mail delivery systems such as Microsoft Exchangeo 4 (Microsoft Corp, Redmond, WA, USA), computer operating systems such as Microsoft Windows NTO or Windows 20000 and 6 different varieties of the Unix0operating systems, groups 7 of computers such as one or more Windows NT domains.

8 Similarly, complex database management systems such as DB20 9 (IBM Corp, Armonk, NY, USA), Informixo (Informix, Menlo 0 Park, CA, USA), or Microsoft SQL Server, and groupware 11 applications like Lotus Notes@ (Lotus Corp, Cambridge, MA, 12 USA) and GroupWise@ (Novell Corp., Provo, Utah, USA) all 13 lend themselves to being documented by the present 14 invention. Additional examples of configurable systems that may benefit from the current invention include electronic 16 commerce applications, enterprise management systems such as 17 SAPO (SAP AG, Waldorf, Germany), BAAN (BAAN Corp, Barneveld, 18 Netherland) and Peoplesofto (Peoplesoft, Pleasanton, CA, 19 USA) and enterprise storage systems such as EMC 28 (EMC Corp, Hopkinton, MA, USA) and Legatoo (Legato Corp, Palo Alto, CA, 21 USA), and network nodes such as Ciscoe routers (Cisco Corp, 22 San Jose, CA, USA) 23 24 Preferably, the invention provides a computer readable set of rules describing knowledge about the system. The rules 26 have embedded in them a set of acceptable values associated 27 with specific configuration parameter (s). The invention 28 then compare the values of configuration parameters against 29 the values expressed in the associated rules, and output an error or warning condition if a parameter violates those I rules. The acceptable values may be fixed in the rule, or 2 alternatively, may be computably modified based on one or 3 more configuration parameters. In addition to acceptable 4 values, the program may also include indications of desired values that may be outputted as needed.

6 7 A method or providing the set of rules and the knowledge 8 functionality as described above may be provided by a 9 computer readable generic data model of the configurable system. The generic model corresponds to the 11 interrelationship of the sub-components of the configurable 12 system and thus reflects its underlying structure. After 13 the configuration data is retrieved from the configured 14 system, an instance model is constructed in accordance with the generic model. Optionally, the generic model 16 incorporates the system knowledge described above, and 17 includes sets of acceptable values and other 18 interrelationships between the system sub-components.

19 Preferably the system knowledge is implemented utilizing constraints programming logic and techniques, which allows 21 for fast and efficient checking of a complex set of 22 requirements, and easy flagging of error conditions. The 23 generic model also facilitates the creation of a document 24 that is organized in a manner most closely related to the structure of the configurable system, and further enhances 26 the readability and reduces the time required to comprehend 27 the system.

28 11 I In a preferred embodiment of the invention, the raw data is 2 parsed by a data parser program module, entered into a 3 database, and merged into a unified or segmented text 4 template. Rules as described above may be coded into the program or embedded in a database, to specify values, method 6 of computing values or locations of finding the appropriate 7 values, against which the configuration parameters of the 8 sampled system may be checked. The invention thus provides 9 identification of configuration mismatches or potential problems in a configuration and flags those conditions to 11 the user.

12 13 Using the raw data database described above further allows 14 the user to change the presentation of the document by embedding the results of queries against the database into 16 the document in ways the user best believes will enhance 17 system understanding or troubleshooting. Using such a 18 database is also advantageous due to the simplicity and low 19 cost of the implementation.

21 Another alternative object of the invention is to provide 22 means of comparing current and previous configurations and 23 to point out differences between them. Such comparisons are 24 useful during the troubleshooting of a system, which malfunctions due to unknown reason. By comparing an old, 26 "known good" configuration with the current configuration, 27 differences become apparent and, due to the documentation 28 generating nature of the current invention, such changes may 29 easily be placed in context and thus aid in determining if 12 1 any of the modified parameters may have caused the 2 malf uncti(.:,n.

3 4 It should be pointed out specifically that the invention, with its several capabilities, applies to multi-server 6 configurable systems as well as single server configurable 7 systems. This is a clear advantage since, as mentioned 8 earlier, the system complexity grows exponentially with the 9 number of servers. Examples of such multi-server environments are a plurality of server computers operating I I under the Windows NT operating system within a single 12 domain, or multiple communicating domains with or without B trust telationships. Another example is one or more 14 Microsoft Exchange electronic mail servers in an organization. Similar in nature is a set of co-operating 16 configurable network nodes such as routers, switches, 17 concentrators, frame relay access devices, and other nodes 18 comprising a data or voice network.

19 It should also be noted that the invention may be integrated 21 within the configurable system itself, either as an integral 22 part of the system software or by having a separate program 23 active on a computer that is a part of the configurable 24 system. Thus for example a configurable software application may be made self documenting by including 26 program code that ret-ieves configuration parameters and 27 merges them into explanatory material (template), 28 implemented in any convenient manner, thus creating a 13 1 document describing the specific instance of the 2 configurable system.

3 4 In such an embodiment most of the configuration data is available to the document generation module from within the 6 program, and additional data may be derived from data stores 7 such as an active directory, or from other computers that 8 are a part of the configurable system. The document 9 generation module comprises primarily of an external text template, text segments coded within the module, or any 11 other convenient manner to store the explanatory text and 12 optional drawings. The module also contains program code to 13 merge the configuration data within such template and output 14 the template with the merged data as a document. The program code may be integrated directly into the 16 configurable system as an integral part of the configurable 17 system code or may be implemented as an add-on module loaded 18 and executed by the configurable system at run-time.

19 The invention operates generally by collecting configuration 21 data from individual systems or from system sub-components 22 that comprise the configurable system to be documented.

23 Preferably, a collector program is deployed to collect the 24 configuration data. A collector program is a program constructed to collect configuration data from one or more 26 configurable systems, and is constructed specifically for 27 each platform or configurable system and collects the raw 28 data for transmission into a Documentor. The configuration 29 data is then preferably encrypted (especially in the case of 14 1 transmitting the data over the Internet) before being 2 transmitted to the Documentor.

3 4 A Documentor, (alternatively referred herein as a Documentation Server) is a computer program or a collection 6 of computer programs, that receives configuration data as 7 its input and generates documentation as its output, 8 primarily when receivIng the data from a configurable system 9 and generating documentation pertaining to the system. it performs this function by outputting a template, or pre 11 determined text segments relating to configuration 12 parameters or to a group of inter-related configuration 13 parameters. The text segments of which the document is 14 comprised are primarily explanatory in nature and are composed to improve the understanding of meaning and effects 16 of the configuration parameters to which they relate.

17 optionally, drawings and tables are also outputted as needed 18 to increase the understanding and readability of the 19 produced document. The drawings, tables, and text segments are outputted to paper, a computer screen, the Internet, or 21 any other appropriate output device or method. Additionally 22 the Documentor may output the document to a computer file.

23 It should also be noted that methods for dynamic generation 24 of drawings and diagrams (as described for example by the Ahern et al. patent supra or other methods generally known 26 in the art) may be integrated with this invention to 27 generate drawings depicting the configurable system in part 28 or as a whole.

29 1 In one alternative embodiment for a Documentor, a generic 2 operational model is provided. The operational model 3 embeds therein information and knowledge which is required 4 for a proper generic system operation, and may be viewed as a set of generic implementations of operational 6 configurations specific to the generic system. The generic 7 model therefore, details the underlying structure of the 8 interrelationships between different sub-components of the 9 generic case of the configurable system. Each allowable configured system is a subset of the generic configurable 11 system. Similarly, each model of a configured system 12 constructed according to the generic model is a subset of 13 the generic model that reflects the configured system 14 underlying, structure as configured. Such specific models of configured systems are called "instance models".

16 17 Currently it is believed that such model is best created 18 utilizing constraints programming, wherein the knowledge is 19 expressed as a set of constraints on the system's configuration parameters. However as will be seen below, 21 other, less complex methodology may be applied, both to 22 model creation and to the primary goal of automatic 23 documentation generation, without detracting from the 24 invention. In a constraints-based implementation, the collection of configuiation data is examined in light of the 26 constraints expressed in the generic model and is entered 27 into an instance model. Once completed, the instance model 28 is a representation of the specific instance of the 29 configurable system as configured.

16 2 Parameters that violate constraints are flagged as an error, 3 and may o--., may not be entered into the instance model.

4 Optionally, parameters may be assigned values according to the level into which they fit the generic model, and such 6 values may be utilized later to propose changes to optimize 7 the configurable system.

8 9 In one preferred embodiment, the collector program is downloaded onto a computer connected to the configurable 11 system via a data network. The program then collects 12 configuration data from all relevant individual systems 13 comprising the configurable system. The data is transferred 14 via the- data network (e.g. Internet, Intranet, LAN, WAN, etc.) to the Documentcr that processes the configuration 16 data and prepares the documentation. The documentation is 17 then made available to the user over the Internet or 18 Intranet, using World Wide Web like technologies such as 19 HTML. Optionally, the collector program may be operated from within a World Wide Web browser and starts operating 21 automatically after being downloaded.

22 23 In the preferred implementation, a documentation server 24 comprising the collector program and the Documentor portion is coupled to a local area network, or an Intranet that is 26 in commun,-"-cation with the configurable system to be 27 documented. An Int:ranet is one or more interconnected 28 computer networks that are characterized by being primarily 29 within the electronic bounds of an organization. Typically 17 1 electronic access to an Intranet is not open to the general 2 public, and it thus affords a protected computing 3 environment for storing and accessing organization 4 confidential data. Many Intranets utilize Internet like technologies, and some utilize communications provided by 6 public communication:-,ieans, for example, a dedicated line in 7 a PSTN network. However data access to an Intranet is 8 controlled from within the owning organization.

9 Coupling a documentation server directly to an Intranet 11 overcomes a disadvantage of an Internet coupled server by 12 maintaining the configuration data within the organization 13 controlled network. In an Internet coupled server the data, 14 even if encoded and encrypted, may present a security risk for certain configurable systems. An Intranet coupled 16 documentation server, especially when implemented as a 17 dedicated computer, becomes a Documentation Appliance, 18 operating within the confines of an organization. The 19 Documentation Appliance is readily available to company personnel, offers local system documentation and storage of 21 previous configurations, all while avoiding the need to send 22 sensitive data over public networks.

23 24 Such a Documentation Appliance is preferably a dedicated server that may be adapted for documenting one or more types 26 of configurable systems. It is also preferable to have such 27 a Documentation Appliance keep logs of document production 28 and that such logs will be remotely accessible to ease 29 debugging and service. The Appliance may be coupled 18 1 directly to the configurable system or may utilize an 2 intermediary computer.

3 4 A Documentation Appliance server attached to an organization Intranet may also be configured to retrieve the configurable 6 system configuration information according to a pre 7 determined schedule, and activate updated documentation 8 production automatically. Together with the capability to 9 compare previous and _-urrent sets of configuration parameters, a Documentation Appliance may thus produce a 11 list of c.anges that occurred between activations, in effect 12 to create a log, tracking modifications and changes in the 13 configurable system.

14 There are clear advantages to accessing the documentation 16 via a computer. To facilitate that, the invention also 17 provides for a World Wide Web type server that is 18 constructed to distribute the documents produced by the 19 current invention to a web browser. Since the documentation in the preferred implementation is produced by a print 21 engine capable of producing HTML, the integration of a web 22 server within the appliance allows any person with access 23 rights to browse, search and view the documentation as 24 needed.

26 Brief description of the drawings

19

Claims (1)

1 This invention may be better understood from the 2 descriptions and

Claims which follow, and from the 3 accompanying drawings in which:

4 Fig. 1 depicts a general schematic component and data flow 6 diagram of a preferred embodiment of the invention 7 Fig. 2 is a generalized flow diagram of the collector 8 program portion of an embodiment of the invention.

9 Fig. 3 is a flow diagram for generating an instance model in 10 accordance with the invention 11 Fig. 4 depicts a generic model ob ject in accordance with an 12 embodiment of the present invention.

13 Fig. 5 is a partial and simplified 'C++'-like code of 14 several classes used in model creation in one preferred 15 embodiment.

16 Fig. 6 depicts 'C++"-like code of two 'document' methods 17 referred to in Fig. S classes.

18 Fig. 7 depicts an example of a simplified portion of text 19 template for another preferred embodiment of the present 20 invention.

21 Fig. 8 is partial pseudo code showing a method for 22 generating warning messages to the user according to the 23 present invention.

24 Fig. 9 is a screen depiction of web based screen from which 25 the documentation operation begins.

26 Fig. 10 is a screen depiction of an HTML page prior to 27 sending collected data to documentation browser.

1 Fig. 11 depicts a partial sample of a table of contents for 2 a document generated in accordance with the present 3 invention.

4 Fig. 12 depicts a partial sample of documentation generated 5 in accordance with the present invention.

6 Fig. 13 depicts another partial sample of documentation 7 generated in accordance with the present invention.

8 Fig. 14 depicts another schematic implementation of the 9 invention utilizing a database and a text template in 10 accordance with the present invention.

11 Fig. 15 depicts a simplified diagram showing connection 12 method of a documentation appliance in accordance with the 13 present invention.

14 Fig. 16 is a simplified flow diagram depicting a 15 documentation generation process according to the present 16 invention.

17 18 Detailed description of the invention 19 This invention will be explained with reference primarily to Microsoft Exchangeo and Windows NTO platforms by way of 21 example only. Microsoft Exchange is a popular electronic 22 mail server (hereinafter "Exchange"), and Microsoft Windows 23 NT is a popular operating system (hereinafter "NT" or 24 "Windows NT" interchangeably). It will be clear however to those skilled in the art that primarily the platform 26 specific data need to be modified in order to modify the 27 documentor portion of the invention to handle other types of 28 configurable systems. Such platform specific data includes 21 1 appropriate text sections and appropriate constraints or 2 rules to define the underlying structure and the acceptable 3 variable values and relationships. Similarly, it will be 4 clear that while the collector portion of the current invention is platform and application specific, adapting the 6 collector program described in this application to operate 7 in a specific platform is a matter of common skill. An 8 Application Programming Interface or API exists for most 9 configurable systems that is designed to provide access to the configuration parameters, ideally fitted in most cases 11 for a collector program or module as described herein.

12 13 In its most basic form, the invention involves a database 14 containing a set of predetermined text sentences or paragraphs, associated with at least one specific variable.

16 A collector program is provided for reading configuration 17 parameters from a configurable system, and the associated 18 text paragraph is outputted together with the configuration 19 parameters. Optionally entries are made in a table of conterits for text paragraphs, and the table of contents is 21 outputted as well. The output may be to a printer, a 22 screen, or a file. Output may also utilize the World Wide 23 Web technology to offer organized access to the 24 documentation, in which case the table of contents is best composed of hyperlinks; to appropriate sections. Another 26 alternative output forms include audio and video output. An 27 audio output may be generated by a text to speech 28 translation module. Video output require a video template, 29 similar to the text template described herein, but adapted for video signals and for embedding external values such as 22 1 configuration parameter values, in a predetermined video 2 stream.

3 4 As noted above, the invention may also be practiced by integrating the steps described herein into the configurable 6 system code. For example, a module may be integrated into a 7 Microsoft Exchange server that will retrieve all 8 configuration parameters directly from the Exchange system 9 within which it operates. Alternatively, a Documentor program may be operated on a computer that is a part of the 11 configurahle system. For example, a Documentor program may 12 be operated on a computer utilized as a Windows NT domain 13 controller, where much of the configuration data is locally 14 available in a system adapted for documenting a Windows NT environment. The document generation steps described herein 16 are similar with the primary difference being the location 17 where certain portions of the invention are executed.

18 19 While novel and useful even at this basic level, the invention further benefits the user by grouping similar 21 features and/or variables together, for example listing all 22 domain controllers in an NT domain, or creating a list of 23 all mail transfer age,-,.ts (MTA) scheduled to run in an 24 Exchange organization, including their prospective protocols or schedule. Optionally, the Documentor portion may collect 26 similar information from multiple servers. So, for example, 27 replication information between database servers may be 28 listed together to ease understanding of the proper 29 propagation order. Such information will preferably be 23 1 groupea in close proximity with several paragraphs 2 explaining the process of propagation and the meaning of 3 each of the related variables. As further explained below, 4 utilizing constraints or rules eases verification of proper configuration.

6 7 The preferred implementation will contain general data 8 explaining the generic operation of the configurable system, 9 together with system specific data as configured.

Preferably, generic and specific advice relating to 11 configuration will be placed in proximity to system 12 information relating specifically to the system being 13 documented. The documentor may thus compile text segments 14 responsively to the conditions of the configurable system to produce a document that closely relate to the configurable 16 system as configured.

17 18 For an explanation of the operation of the invention, 19 reference is now made to the drawings, depicting preferred embodiments of the invention, shown here for illustrative 21 purposes only, primarily for operation on a Microsoft 22 Exchange platform.

23 24 In Fig. 1 the documentation server 100 in a preferred implementation is located remotely to the client Exchange 26 organization 170. The documentation server 100 is connected 27 to Exchange organization 170 via the Internet or an 28 Intranet. Optionally, an intermediate workstation 150 29 connects between the documentation server 100 and the 24 1 Exchange organization 170. When connected to the Internet, 2 the client workstation 150 acts as a security gateway 3 between an Internet based documentation generator and a 4 configurable system, to provide both a data path and sufficient access rights to the configurable system. it 6 will be c-1-ear however, that the client workstation 150 may 7 be an integral part of the Exchange organization 170 in Fig.

8 1, or even an Exchange server per se, such as 174, 180 or 9 185. Additionally, in this preferred implementation, the intermediate workstation 150 should have an operational web 11 browser 160 from which documentation production operations 12 may be initiated. Workstation 1SO is unnecessary if the 13 documentation server 100 has sufficient access rights and 14 immediate network access to the Exchange organization to allow a program running thereon to access the required 16 configuration data of the configurable system, as depicted 17 in Fig. 15.

18 19 The exchange organization depicted in Fig.1 is a generic organization having at least one Exchange Source Server 174, 21 and any number of servers, only two of which are shown, 22 designated as 180 and 185. The Exchange directory 176 23 resides on the source server 174.

24 Utilizing the process begins with a client creating a 26 connection from client workstation 150 to the documentation 27 server 100 via the web browser 160. The client than 28 downloads 11 a copy 125 of the collector program 120 to the 29 client workstation. In this preferred embodiment the 1 collector program is constructed as an ActiveX 0 program or 2 a Javae (Sun Microsystems, Palo Alto, CA) program, and the 3 copy of the collector 125 begins operating automatically 4 after it was downloaded.

6 Fig. 2 depicts the operation of a collector program 7 constructed for an embodiment configured as depicted in Fig.

8 1. After program initialization 200, the collector program 9 125 connects to the Exchange Source Server 174 as depicted in step 12 in Fig.1, and extracts 220 the Exchange Directory 11 information 176. Next, the collector program proceeds to 12 extract 240 registry data 178 from the Exchange Source 13 Server 174 in step 13, and retrieves registry data 182 and 14 187 for all other Exchange servers in the organization, as shown in steps 13 a, b... n in Fig. 1. Clearly, while Fig.1 16 shows only three servers, this depiction is for explanation 17 purposes, and the number of servers may vary from one to any 18 number supportable by the configurable platform. For 19 increased efficiency, the steps of collecting the configuration data from the various servers in steps 13b 21 through 13n are carried out simultaneously.

22 23 Collector program 125 then creates 250 an HTML page 255, 24 compresses the data collected in steps 12 and 13 a...n, and encodes 260 the data for compatibility with transmission 26 using the HTTP protocol. The data is than embedded in HTML 27 page 255, preferably as hidden text. The collector program 28 125 than loads HTML page 255 into web browser 160, and 29 points 270 client web browser 160 to the page 255. An 26 1 example of the HTML page 255 when acted upon by the web 2 browser as depicted in Fig. 10. The user is given the 3 option, by activating button 1010, to send the data to 4 documentation server 100.

6 While the mechanism of collecting the configuration data 7 shown in steps 220 and 240 is described uniquely as 8 applicable to Exchange environment, those steps constitute 9 the mechanics of collecting configuration information specific to the platform. The function of automatic 11 collection of the configuration data may be performed by any 12 known ipea--ns without d4?parting from the invention.

13 Adaptation of the collector program described above for 14 different platforms requires only regular programming skills and general knowledge of the platform. Alternatively, the 16 collector program may be constructed to operate through 17 other communication and collecting methods such as SNMP for 18 network nodes, in which case no HTML communications is 19 required and is often unavailable. In the case of the Documentation Appliance, the collector program may be 21 implemented as a collector program module operating on the 22 Appliance, with the configuration data retrieved directly 23 from the configurable system by the module.

24 Fig. 3 details the operation of instance model creator 134.

26 The model creation happens within the document generator 27 130. Once the user sends the data embedded in HTML page 255 28 to the documentation server 100, the program retrieves 310 29 the information from the web page, decodes and decompresses 27 1 320 the data. The data is then parsed into variable names 2 and corresponding values in steps 330 and 350. The raw data 3 is stored in a database 132. Doing so allows easy approach 4 to differEnt data views as needed. The parsed data is then presented one variable at a time, to step 360 in which an 6 instance model is created.

7 8 In a preferred embodiment the instance model 145 is an 9 object-oriented artifact assembled from instances of predefined object types described in a generic model 140 11 that is incorporated into the documentation server 100.

12 The generic model 140 for a specific application domain 13 (e.g., Microsoft Exchange, SAP database, or a specific 14 computer operating system) consists of a set of classes describing objects av---iilable in the configurable system 16 universe. Thus, generic models are specific to a particular 17 configurable system domain: for example, at least one 18 generic model is provided for Microsoft Exchange, while 19 another one is provided for Windows NT, and so on.

21 Each type of object in the configurable system universe that 22 is relevant to the task performed by the current invention 23 is represented in the generic model in the form of a class.

24 The class describes its composition (in terms of lower level objects) and structure (in terms of relationships among its 26 components, e.g. Part-Of, Is-A, etc.). Optionally, behavior 27 can also be expressed as part of the model, in the form of 28 additional relations among constituent parts and/or 29 attributes, describing correct and/or faulty functioning.

28 2 By way of example, in a Windows NT domain, there will be a 3 library object describing a server, and certain server 4 characteristic parameters such as name, version information, and the like. Constraints may be attached to each of those 6 variables, for example a constraint that the domain name has 7 to be the same for the server as for the whole domain is 8 needed to verify that the domain is consistent. However 9 more complex requirements, for example communications capability between servers, require that a whole class of 11 objects dealing with network communications be enabled and 12 consistent. Such structural demands comprise the structural 13 generic model 145, together with a set of constraints that 14 are applied to this underlying structure. By adopting the generic model and the object library to specific platforms, 16 such as mail servers, operating systems, network equipment, 17 etc., the documentation server 100 can be modified to 18 operate on various platforms.

19 A partial example of several objects relating to a model for 21 the Microsoft Exchange platform is shown in Fig. 5 in 'C++' 22 like notation. By way of example, class 'Organization' 510 23 is the root of the model, and comprises internal attributes 24 such as the organization name 511, and other subservient objects comprising the rest of the organization model. In 26 this example, the vector of subservient objects is of type 27 'Site' shown as 516. The class Organization 510 also 28 incorporates several methods. The posting step described 29 below is carried out in the method "post' 512. Rules or 29 1 constraints applied to the object to check the validity of 2 the object against the generic model are applied using the 3 'validate' method 513, and the method 'document' 515 is used 4 to create the documentation that is specific to the configurable system instance.

6 7 Examining class Site 520 shows a close similarity to class 8 organization 510 above, with the major structural 9 differences being the members included in the class. While the Organization clast; 510 included a vector 516 detailing a 11 list of s-L.tes, each Site object details a list of Server 12 objects 526 and a list of Protocols objects 524 with similar 13 collection of methods. In class Server 530 we see a similar 14 pattern yet again. Class Protocol 540 also incorporates similar methods, but being a leaf of the hierarchical model 16 structure, it does not include any vector of inherent 17 objects connected thereto. It will therefore be clear to 18 any person familiar with the organization and operation of 19 the Microsoft Exchange software, that the construction shown in Fig. 5 represents not only a collection of objects of the 21 types described above, but also the underlying structure of 22 a Micrcsoft Exchange installation. It will also be clear 23 that similar constructs may be created for other 24 configurable systems such as a Windows NT domain, a network organization, Lotus Notes software, database servers etc.

26 27 In the process of instance model creation 360, each 28 applicable configuration variable is examined against the 29 generic model. In this step, known as the 'post' or 1 "posting' step, an object instance is created for each 2 relevant configuration variable. Variables that conform to 3 the generic model and pass the constraints imposed on the 4 instance object are posted in the instance model. Posting occurs in an object-oriented manner that maintains a 6 structural semblance to the underlying principles defined in 7 the generic model for the platform as described above.

8 9 Constraints may be divided primarily into two categories:

hard and soft constraints. Hard constraints are such that a 11 violation thereof may prevent the system from operating, 12 while soft- constraints are mainly related to performance 13 issues, and a violation of such soft constraints will allow 14 continued system operation, albeit in less than optimal manner. Whether a constraint is a hard or soft, is 16 particular to each constraint and is responsive to the value 17 of one or more variables. Additionally, as is well known in 18 the art, constraints may be quantitative, and assign values 19 corresponding to a level of conformance with the generic model. For example, such values are utilized for providing 21 the user with suggestions and warnings related to optimizing 22 the configurable system performance and/or to modifications 23 required for maintaining optimal system operational status.

24 Fig. 4 presents a simplified view of the document 26 construction carried cut in the document generation module 27 138 portion of the documentation generator 130. A 28 documentation template 430 describing and explaining 29 different aspects of the system is created and stored in the 31 1 documentation server 100. The template may be stored in 2 separate files, as part of the model, or as data available 3 to the documentation generator 138 in any convenient format.

4 Internal attributes and sub-components are integrated into the template as needeb. Figs. 12 and 13 are sample 6 documentation pages, while Fig. 11 is a sample of a table of 7 contents; all generated by the current invention. As can be 8 observed in Figs. 12 and 13 drawings may also be embedded in 9 the template.

11 Fig. 6 is a partial listing of a computer program, written 12 in a 'C++'-like language. The numeral 610 designates a 13 simplified sample of the 'document' method 525 code of an 14 object of class "Site" 520. The method uses the "C++' standard output stream "cout'. Portions of the 16 documentation template 430 are embedded in the first output 17 stateruent 613 in the form of text strings like "'The site" 18 618. The output statement 613 also includes internal 19 attributes 420 such as the variable 'm-name' 615 and sub components 410 such as the method 'm-servers. size()' 617.

21 Additionally, the method calls other documenting methods in 22 all servers in its 'm-servers' lists seen in 614 and all 23 protocols in its 'm-protocols' list as seen in 616. While 24 simple attributes such as Im-name' are outputted directly from class members or global variables, other outputs occur 26 from methods internal as well as external to the method.

27 Since each 'document' method dictates the order in which the 28 subservient objects print, a very orderly and well-organized 29 document can easily be produced. Attention is also called for the "endl' state=t 619 at the end of the cout 32 1 statement 613, which is an example of the formatting 2 information imparted by the program. More complex 3 formatting, merging information, tables and drawings may be 4 incorporated from such predetermined data or taken from files external to the program to be merged in the output 6 document.

7 8 Fig. 6 al.-o shows a method of generating the table of 9 contents or TOC. Statement 611 supplies the current location in the output stream to a procedure named 11 TOC-Entry, which stores the context and associated location 12 for further generation of the table of contents. Similarly, 13 the procedure "Index-Entryo" provides the index context, in 14 the example the site name and the location within the output document. If for example the standard output stream 'cout' 16 statements is redirected to one computer file, both the TOC 17 and index generating procedures simply output the indexing 18 information into one or more separate index files.

19 Generating an index and TOC from such files is a simple procedure, and the TOC and index may be created according to 21 the viewing method, e.g. by hyperlinks that are dynamically 22 generated when the document is read on screen, or by 23 printing the information when the document is reproduced on 24 paper.

26 Fig. 6 also shows another example of the document method 27 common to most if not all nodes in the model. In the 28 'Server::document' method 650 output statement 660 generates 29 documentation output without calling any external method.

33 2 In a preferred implementation, the output produced by the 3 Documentor is a set of printing instructions for a virtual 4 printing machine. Using specific drivers, the documentor is then able to produce documentation in different formats such 6 as HTML, Postscript, PCL, Latex Adobe Acrobato Microsoft 7 Wordo document, or any other desired format. The language 8 for the virtual printing machine contains, among other 9 constructs, commands for describing the document layout, such as chapter, section, subsection, and similar 11 constructs. Those commands automatically create the 12 appropriate entry in the optional TOC and index. Other 13 commands for the virtual printing machine include commands 14 for specifying document composition, such as structured elements such as tables and bulleted lists, and/or 16 unstructured elements such as paragraph, note, warning, and 17 hints. Additional virtual printing machine commands include 18 formatting instructions like vertical/horizontal space, 19 indentation justification and the like, as well as font management functions such as color, bold, italic, etc.

21 22 The virtual printing machine is implemented using object 23 orientEd programming techniques, which provides a 24 multiplexer class. Implementing the commands described above in a mannE!r similar to the standard 'C++' stream 26 manipulators and overloading the "<<' operator, from the 27 point of view of the Documentor, the multiplexer class is 28 used the same way as standard 'C++' streams. The virtual 29 printing machine also provides several driver classes, one 34 1 for each type of format or formatting language. Each class 2 implements the translation of the printing commands to the 3 target formatting language.

4 A simplified description of the output process is as 6 follows: The Documentor creates one multiplexer instance to 7 which it attaches instances of drivers for all the required 8 types of output. Every time the documentor uses the output 9 '<<' operator, the desired information or printing construct is sent to the multiplexer which distributes it to all the 11 drivers currently attached to it. Each driver than creates 12 an output according to its specific formatting language.

13 The drivers also create the table of contents and index in a 14 desirec. manner that fits the formatted output, such as HTML style hyperlinks for En HTML document or as formatted and 16 printable TOC and index for paper output.

17 18 Preferably, the invention may further use the raw data 19 database 132 to allow user specified view of data specific to the configurable system in question. The raw data 21 database may best be managed by a database management system 22 against which queries may be posted, and in which the data 23 retrieved forms the basis for the view. The creation of 24 such a view will allow generating partial documentation, for example detailing the entire information specific to a 26 single subnet in a network. This allows users to 27 concentrate on limiteJ areas of interest; for example, a 28 network under direct supervision of a specific user. This 29 feature may be further enhanced by the addition of pointers 1 from the database to related objects in the instance model, 2 since only the relevant portion of the instance model can 3 easily be created as separate documentation with grouping of 4 similar parameters in stored separate subsections of the model. Query results may also be embedded in the output 6 document either according as predetermined by the template 7 or according to user preferences, in a system that includes 8 a user interface portion to accept user input for selecting 9 document generation options.

11 In a simpler embodiment of the present invention depicted 12 generally in Fig. 14, the process of document generation 13 does not include constraint-based model creation. In such 14 an embodiment the raw data is placed in raw data database 132 and is associated with parts of the documentation, (or 16 text segments) that form template 1450 that correspond to 17 the variables relevant to the documentation of the 18 configurable system. Alternatively, template 1450 may be a 19 predeterm--'-ned document template, which includes placeholders for the results of specific queries such as the names of all 21 servers, name of all domain controllers, etc. A 22 documentation generation module 1410 reads the template, and 23 when a query is encountered, it is parsed, presented to the 24 database 132 and the results outputted to the document by a documentation generation module 1410. Fig. 7 presents a 26 simple portion of a template to generate partial 27 documentation for a Windows NT domain. Queries to the 28 database 710, 720 and 730 are enclosed between character 29 strings "<<<' and ">>>'. When the documentation generation module 141-0 encounters a query such as 710, it parses the 36 1 query and the results are inserted into the output stream.

2 The documentation generation module 1410 can also parse 3 constructs such as variable name resolution and 4 substitution, and an if statement as shown in 720, and decide which of the two statements 730 or 740 to output.

6 The example depicted in Fig. 7 shows a simple but effective 7 method to automatically generate elaborate documentation 8 from the collected configuration data without the use of a 9 complete object oriented model.

to 11 Optionally, a simple error checking and reporting routine 12 may also be incorporated, in which a collection of rules is 13 stored in the program and relevant variables are checked 14 against those rules. Fig. 8 depicts a pseudo-code portion of such rule-checking program. In accordance with Fig. 8 an 16 example 810 of such rules is to warn the user 820 if the 17 number of mailboxes on the server multiplied by the desired 18 mailbox disk space allocation, (or 5 MB in this example) is 19 smaller than the available disk space. The rule may further be constructed to issue warning or error messages, or to 21 proposE more fitting values for a parameter based on the 22 value of one or more parameters. For example, the rules or 23 constraints may compute and output a suggestion to modify 24 the size of a virtual memory disk swap file in response to actual RAM memory and available disk space in a server 26 operating under Windows NT. Such proposed values may be 27 based on an arbitrarily complex set of computations 28 emanating from the configuration parameters or based on 29 general system knowledge and experience. The examples given in Fig. 7 andFig. 8 are but a sample of the many ways rules 37 1 may be applied to check conf iguration data and warn users of 2 various inconsistencies and optimization issues.

3 4 Another objective of the current invention was previously described as comparing current with previous configurations 6 of the configurable system to aid in troubleshooting. This 7 objective is easily achieved by storing an older model or 8 raw configuration data of an operational system. When a 9 problem is observed in the configurable system operation, a present model or raw data set is collected and the new and 11 old sets of configuration data or model are compared to each 12 other. Outputting variables with different values between 13 the two configurations will allow consideration of only 14 those variables that have been modified, and thus will ease troubleshooting of the system as presently configured.

16 17 Fig. 15 depicts another preferred embodiment for a 18 Documentation Appliance 1500 described above. While the 19 methods of document generation are similar to the methods already described, the Documentation Appliance 1500 utilizes 21 a collector module 1520 to perform the configuration data 22 retrieval directly from the configurable system. The 23 documentation appliance is connected to an Intranet 1510 24 that comprises one or more interconnected networks and that is coapled to the configurable system as depicted by the 26 Exchange Organization 170. In this case, all of the needed 27 computers in the configurable system are directly available 28 to the Documentation Appliance 1500, and therefore this 29 embodiment does not require the services of an intermediate 38 1 workstation 150 as described in the embodiment depicted in 2 Fig. 1. Optionally, the documentation appliance also incorporates a web server 1560 to distribute the 4 document at- ion to othei. computers. Optionally a scheduler 5 1550 is provided to activate the documentation generation 6 according to a predetermined schedule.

7 8 Fig. 16 is a simplified flow diagram showing an overview of 9 the documentation process in a preferred embodiment of the invention. Beginning with the retrieval of the 11 configuration parameters 1605 and their storage 1610 in a 12 raw data database 132. In step 1615 the main execution loop 13 is initialized with a selection of a first parameter, 14 preferably the root or most important data of the configurable system. This variable is assigned as the 16 Current Parameter or P. The main loop or some variant 17 thereof will be executed for all relevant parameters.

18 19 Step 1620 checks if the CP is indeed relevant to the documentation process. If not, step 1622 is executed to 21 continue to the next step. If CP is relevant, a check is 22 done to see if the value of the parameters is within preset 23 boundaries 1625. If the value is outside the boundaries, 24 an error message is generated 1627. Step 1625 may be used for more complex error checking, computation of boundary 26 values, and optimization 27 28 One or more explanatory text segments, (as well as optional 29 drawings and tables) is drawn from the template 1680 in 39 1 stage 1630. If the template data relevant to the CP 2 requires other parameters (as shown in fig. 7 for example) 3 step 1637 is executed, in which the required parameters are 4 recursively obtained, merged and outputted into the same output stream of step 1650. Once all parameters are merged 6 into the relevant template segment 1640, the results are 7 outputted in stage 1650. If more parameters 1660 are 8 present the loop continues through 1622 and back into step 9 1620. Otherwise, the documenting process stops at 1699.

Database 132 may also be conveniently used to store the 11 rules or boundaries as well as text segments and other data.

12 Once a document is generated with a computer readable main 13 body and a table of contents, additional capabilities, such 14 as searching and editing, may be easily added to the features of the current invention as is well known in the 16 art.

17 18 While there have been described what are at present 19 considered to be the preferred embodiments of this invention, it will be obvious to those skilled in the art 21 that various other embodiments, changes, and modifications 22 may be made therein without departing from the spirit or 23 scope of this invention and that it is, therefore, aimed to 24 cover all such changes and modifications as fall within the true spirit and scope of the invention, for which letters 26 patent is applied.

1 Claims 2 3 1 A self documenting configurable software system, 4 comprising:

a) a plurality of text segments comprising 6 explanatory text relating to said configurable 7 system; and 8 b) at least one software module constructed to merge 9 a plurality of configuration parameters of said configurable system with related text segments, 11 and output said text segment and configuration 12 parameters to form a document specific to the instance of said configurable system.

14 2. The self documenting configurable software system of 16 Claim 1 wherein said software module is embedded within 17 said configurable system.

18 19 3. The self documenting configurable software system of Clair, 1 or Claim 2 wherein said software module is 21 constructed to be integrated into said configurable 22 system while said configurable system is being executed 23 by at least one computer.

24 4. The system of any preceding claim further comprising a 26 set of acceptable values for at least one of said 27 configuration parameters, and wherein an error 28 condition indication is outputted if the value of a 29 confliguration parameter violates said values.

41 5. The system of any of any preceding claim further 2 comprising a database and a database management system 3 for storing said configuration parameters.

4 6. The system of claim 5 wherein said database is adapted 6 to store at least two sets of said configuration 7 Darameters.

8 9 7. The system of Claim 6 further comprising software adapted to store at least a first and a second set of 11 said configuration parameters and to output parameters 12 having value difference between said first and second 13 set.

14 8. The system of any preceding claim further comprising a 16 scheduler.

17 18 9. The system of any preceding claim further comprising 19 software to generate a table of content for said documentation.

21 10. The system of claim 9 wherein said table of contents 22 comprises at least one hyperlink to a location 23 contained in said document.

24 11. The system of any preceding claim further comprising 26 software to generate an index of selected parameters 27 and paragraphs detailing relative location of said 28 parameters and paragraphs within said document.

42 1 12. The system of any preceding claim wherein at least two 2 of said explanatory text segments are grouped in 3 accordance with the interrelationship of their 4 corresponding parameters.

6 13. The system of any preceding claim further comprising a 7 computer readable set of rules, at least one of said 8 rules having a range of acceptable values associated 9 with one or more configuration parameters for said configurable system for comparing retrieved 11 confliguration parameters against said set of rules.

12 13 14. The system of claim 13 further comprising software 14 adapted. to output an indication of error condition if at least one of said configuration parameters violates 16 one or more of said rules.

17 18 15. The system of claim 13 or 14 wherein at least one of 19 rules also comprise indication of desired values for said associated parameter, and further comprising 21 software adapted to output information conveing said 22 desired value.

23 24 16. The system of claim 15 wherein said desired value is computably modifiable.

26 27 17. The system of any preceding claim further comprising 28 software adapted to embed at least one drawing within 29 said document.

43 1 18. The system of any preceding Claim wherein said 2 explanatory text is arranged in a text template having 3 placeholders embedded therein and further comprising 4 software constructed to merge the values associated with said configuration variables with the template in 6 accordance with said placeholders.

7 8 19. The system of any preceding claim further comprising a 9 world wide web server for communicating said document to another computer.

11 12 20. The system of any preceding claim wherein said 13 configurable software system is of a type selected from 14 an electronic messaging system, a computer operating system, a database management system, an enterprise 16 management system, and a network switching node 17 operating system.

18 19 21. A computer program comprising program instructions which, when loaded onto one or more computers in a 21 software system, cause it to perform as the self 22 documenting configurable software system of any of 23 claims 1 to 20.

24 22. A computer program product comprising instructions 26 stored in a computer readable medium which, when loaded 27 onto one or more computers in a software system, cause 28 it to perform as the self documenting configurable 29 software system of any of claims 1 to 20.

44 1 23. A method for automatic production of documentation for 2 software configurable systems, comprising the steps of:

3 a) merging a plurality of configuration parameters of 4 said configurable system with related text segments, 6 b) outputting said explanatory text segments merged 7 with at least one of said configuration parameters 8 and the value associated therewith, to form a 9 document or a portion thereof; wherein said step of merging is being performed by a 11 software module integrated within said software 12 configurable system.

13 14 24. The method of Claim 23 further comprising the step of automatically selecting said explanatory text segments 16 by a computer, in accordance with said configuration 17 i-arameters.

18 19 25. The method of claims 23 or 24 further comprising the step of storing values associated with said 21 configuration parameters in a computer readable store.

22 23 26. The method of any of Claims 23 to 25, further 24 comprising the step of constructing a table of contents for said document.

26 1 27. The method of Claim 26 wherein said table of contents 2 comprises at least one hyperlink to a location 3 contained in said document.

4 28. The method of any claim 23 to 27 wherein at least two 6 of said explanatory text segments are grouped in 7 accordance with the interrelationship of their 8 corresponding parameters.

9 29. The rr,.ethod of any claim 23 to 28 further comprising the 11 step of generating an index of selected parameters and 12 paragraphs detailing relative location of said 13 parameters and paragraphs within said document.

14 30. The method of any of Claims 23 to 29 further comprising 16 the steps of:

17 a) providing a computer readable set of rules, at 18 least one of said rules having a range of 19 acceptable values associated with one or more configuration parameters for said configurable 21 system; and, 22 b) comparing said retrieved configuration parameters 23 against said set of rules.

24 31. The method of Claim 30 further comprising the step of 26 outputting an indication of error conditions (if at 27 least one of said configuration parameters violates one 28 or more of said rules.

46 1 32. The method of Claim 30 or Claim 31 wherein at least one 2 of said rules also comprise indications of desired 3 values for said associated parameter, and further 4 comprising the step of outputting information conveying said desired values.

6 7 33. The method of Claim 32 wherein said desired values are 8 computably modifiable.

9 34. The method of Claims 23 to 33 wherein said explanatory 11 text is arranged in a text template having placeholders 12 embedded therein and further comprising the step of 13 merging the values associated with said configuration 14 variables with the template in accordance with said placeholders.

16 17 35. The method of any of claims 23 to 34 wherein said step is of outputting further comprises the step of embedding 19 one or more drawings within said document.

21 36. The method of any of claims 23 to 35 further comprising 22 the step of communicating said document to another 23 computer by means of a World Wide Web server.

24 37. The method of any of claims 23 to 36 further comprising 26 the step of storing sets of configuration parameters of 27 said ccnfigurable system in a database adapted to store 28 one or more sets of configuration variables, and 47 1 retrieve portions of one or more said sets in response 2 to queries.

3 4 38. The method of Claim 37 further comprising the step of embedding results of queries within said document.

6 7 39. The method of any claims 37 or 38 further comprising 8 the steps of:

9 a) storing a first set of configuration parameters from a configurable system; 11 b) storing a second set of configuration parameters 12 from a configurable system; and, 13 c) outputting at least one difference between said 14 first and second sets of configuration parameters.

40. A computer program comprising program instructions for 16 causing a computer to perform the process of any of 17 claims 21 to 39.

18 41. A computer program product comprising program 19 instruction stored in a computer readable medium which, for causing a computer to perform the process of any of 21 claims 21 to 39.