Automatic documentation of configurable systems by outputting explanatory information of configuration parameters in a narrative format and configuration parameters differences

• US 6,981,207 B1
• Filed: 01/11/2000
• Issued: 12/27/2005
• Est. Priority Date: 01/11/2000
• Status: Expired due to Term

• Current Assignee: Versata Incorporated (ESW Capital, LLC)
• Original Assignee: Ecora Software Corporation
• Inventors: Hulubei, Tudor, Bakman, Alexander, Sabin, Daniel, Wertsberger, Shalom
• Primary Examiner(s): Hong, Stephen S.
• Assistant Examiner(s): Paula, Cesar B.
• Application Number:
  US09/481,069
• Time in Patent Office: 2,177 Days
• Field of Search: 715/500, 715/501.1, 715/513, 715/531, 715/721, 717/123, 709200-203, 707/500, 707/501, 707/513, 707/531
• US Class Current: 715/210
• CPC Class Codes: G06F 11/2257 using expert systems
• CPC Class Codes: G06F 11/327 Alarm or error message display
• CPC Class Codes: G06F 2201/875 Monitoring of systems including the internet
• CPC Class Codes: G06F 40/174 Form filling; Merging

Abstract

An automatic documentation generation and management system and method, for documenting configurable systems such as complex software applications and hardware systems is disclosed. The method retrieves configuration parameters from the configurable system and utilizes them to automatically generate an explanatory document specific to the configured system. The invention also discloses a documentation appliance system, which is a dedicated documentation server coupled to the configurable system via a communication network, preferably via an Intranet. In yet another alternative, the invention may be practiced by integrating code for automatic documentation generation within the configurable system program.

Claims

1. A method for automatic production of documentation for configurable computerized systems, comprising the steps of:

retrieving configuration parameters having values associated therewith, from a configurable system;

outputting explanatory information corresponding to at least one of said configuration parameters and a value associated with said parameter;

organizing said explanatory information, based on at least one of a content of said information and said value associated with said parameter, into a narrative format descriptive of a configuration of the configurable system, the narrative format constituting the documentation, or a portion of the documentation, for said configurable system;

storing a first set of configuration parameters from a configurable system;

storing a second set of configuration parameters from a configurable system; and

outputting differences between said first and second sets of configuration parameters.

2. The method of claim 1 further comprising the step of automatically selecting said explanatory information by said computer, in accordance with said configuration parameters.

3. The method of claim 2 wherein said step of selecting is being performed by a software module integrated into said configurable system.

4. The method of claim 2 wherein said step of retrieving is performed using a collector computer program operating on a first computer, and collecting said configuration parameters from said configurable system, wherein said step of selecting is performed by a second computer.

5. The method of claim 4 further comprises the step of transferring said configuration parameters from said first computer to said second computer via the Internet.

6. The method of claim 4 further comprising the step of downloading said collector program onto said first computer.

7. The method of claim 6 further comprising the step of automatically activating said collector program after said step of downloading.

8. The method of claim 6 further comprising the step of initiating said step of downloading from within a World Wide Web Browser.

9. The method of claim 1 wherein said configurable system is at least one selected from a group consisting of a configurable software application, a computer operating system, an electronic messaging system, a database management system, a mass storage platform, file server system, a network router, and a network switching device.

10. The method of claim 1 wherein said configurable system is at least one selected from a group consisting of an organization, a server, a domain, an operating system, a mass storage system, an enterprise management system, database management system, and a server database management system.

11. The method of claim 1 wherein said configurable system is an enterprise management system.

12. The method of claim 1 wherein said configurable system is a messaging system.

13. The method of claim 1 wherein at least a portion of said explanatory information is grouped in accordance with interrelationship between configuration parameters corresponding to said portion of said explanatory information.

14. The method of claim 1 further comprising the steps of:

a) providing a computer readable set of rules, at least one of said rules having a range of acceptable values associated with one or more configuration parameters for said configurable system; and

,

b) comparing said retrieved configuration parameters against said set of rules.

15. The method of claim 14 further comprising the step of outputting an indication of error conditions if at least one of said configuration parameters violates one or more of said rules.

16. The method of claim 14 wherein at least one of said rules also comprise indications of desired values for said associated parameter, and further comprising the step of outputting information conveying said desired values.

17. The method of claim 16 wherein said desired values are computably modifiable.

18. The method of claim 1 wherein said step of retrieving is preformed using a collector computer program that collects said configuration parameters from said configurable system.

19. The method of claim 18 further comprising the step of activating said collector computer program from within a World Wide Web browser.

20. The method of claim 18 wherein said collector program is an ActiveX program.

21. The method of claim 18 further comprising the step of constructing said collector program using the Java programming language.

22. The method of claim 1, wherein said explanatory information is arranged in a template having placeholders embedded therein, said method further comprising the step of merging the values associated with said configuration variables with the template in accordance with said placeholders.

23. The method of claim 1 wherein said step of outputting further comprises embedding one or more drawings within said document.

24. The method for claim 1 further comprising the step of storing said retrieved configuration parameters in a database adapted to store one or more sets of configuration variables, and retrieve portions of one or more said sets in response to queries.

25. The method of claim 24 further comprising the step of embedding results of queries within said document.

26. The method of claim 1 wherein said computer is integrated into said configurable system.

27. The method of claim 1 wherein said step of outputting is being performed by a software module integrated into said configurable system.

28. The method according to claim 1, wherein said explanatory information comprises text segments.

29. A method for automatic production of documentation for configurable computerized systems, comprising the steps of:

retrieving configuration parameters having values associated therewith, from a configurable system into a computer;

outputting explanatory information corresponding to at least one of said configuration parameters and a value associated with said parameter in a narrative format descriptive of a configuration of the configurable system, to form the documentation or a portion thereof;

constructing a table of contents for said documentation, or a portion thereof;

storing a first set of configuration parameters from a configurable system;

storing a second set of configuration parameters from a configurable system; and

,

outputting differences between said first and second sets of configuration parameters.

30. The method of claim 29 wherein said configurable system is at least one selected from a group consisting of a configurable software application, a computer operating system, an electronic messaging system, a database management system, an enterprise resource planing system, a mass storage platform, file server system, a network router, and a network switching device.

31. The method of claim 29 wherein said configurable system is an enterprise management system.

32. The method of claim 29 wherein said configurable system is a messaging system.

33. The method according to claim 29, wherein said explanatory information comprises text segments.

34. A method for automatic production of documentation for configurable computerized systems, comprising the steps of:

retrieving configuration parameters having values associated therewith, from a configurable system into a computer;

outputting explanatory information corresponding to at least one of said configuration parameters and a value associated with said parameter in a narrative format descriptive of a configuration of the configurable system, to form the documentation or a portion thereof;

generating an index of at least selected parameters of said configuration parameters, and said explanatory information, said index detailing relative location of at least one of said selected parameters and at least a portion of said explanatory information within said document;

storing a first set of configuration parameters from a configurable system;

storing a second set of configuration parameters from a configurable system; and

outputting differences between said first and second sets of configuration parameters.

35. The method according to claim 34, wherein said explanatory information comprises text segments.

36. A system for automatic production of documentation for configurable computerized systems, comprising:

a first computer having data communication capability;

means for retrieving configuration parameters from a configurable system and communicating said parameters into said first computer;

means for generating explanatory information specific to said configurable system in accordance with said configuration parameters;

means for organizing said explanatory information, based on at least one of a content of said explanatory information and values associated with said configuration parameters, into a narrative format descriptive of a configuration of the configurable system, the narrative format constituting a documentation, or a portion of said documentation, for said configurable system;

means for outputting said documentation; and

means for storing at least a first and a second set of said configuration parameters,

wherein said means for outputting said documentation is further adapted to output difference between said first and second set.

37. The system of claim 36 wherein said means for retrieving comprises a computer program executed on a second computer coupled to said configurable system and wherein said first computer is in communication with said second computer via a data network.

38. The system of claim 36 wherein said communication is conducted by means of the Internet.

39. A computer readable media containing software that when executed by a computer will cause said computer to substantially perform as the system of claim 36.

40. The system according to claim 36, wherein said explanatory information comprises text segments.

41. A system for automatic production of documentation for configurable computerized systems, comprising:

a) a collector computer program adapted to retrieve configuration parameters from at least one configurable system;

b) a documentation generator program, comprising;

i. a template having explanatory information and place holders indicating placement of one or more configuration parameters;

ii. a data parser in communication with said collector program, said parser adapted to parse said configuration parameters into associated values and merge said values into said template; and

iii. an output module adapted to organize said explanatory information, based on at least one of a content of said explanatory information and said values associated with said configuration parameters and to output said template with said merged values in a narrative format descriptive of a configuration of the configurable system, to form the documentation or a portion of said documentation, for said at least one configurable system,

wherein said system is further adapted to store at least a first and a second set of said configuration parameters and to output difference between said first and second set.

42. The system of claim 41 further comprising a set of acceptable values for at least one of said configuration parameters and wherein an error condition indication is outputted if the value of a configuration parameter violates said acceptable values.

43. The system of claim 41 further comprising a database and a database management system for storing said configuration parameters, and wherein said database management system is adapted to respond to queries and output a portional view of said configuration parameters for output into said document.

44. The system according to claim 41, wherein said explanatory information comprises text segments.

45. A method for automated production of documentation for configurable computerized system, comprising the steps of:

downloading a collector computer program to a first computer which is in communication with a configurable system;

collecting configuration parameters from said configurable system using said collector program;

transmitting said configuration parameters into a second computer having a documentation generator program operable thereon;

outputting, using said documentation generation program, a document in a narrative format descriptive of a configuration of the configurable system, comprising;

i. explanatory information, regarding at least a portion of said configuration parameters;

ii. said portion of said configuration parameters; and

iii. a table of contents detailing relative location of at least certain segments of said explanatory information;

storing a first and a second set of configuration parameters; and

comparing said first set and second set and outputting differences therebetween.

46. The method of claim 45 wherein said configurable system is at least one selected from a group consisting of a configurable software application, a computer operating system, an electronic messaging system, a database management system, an enterprise resource planning system, a mass storage platform, file server system, a network router, and a network switching device.

47. The method of claim 45 wherein said configurable system an enterprise management system.

48. The method of claim 45 wherein said configurable system is a messaging system.

49. The method according to claim 45, wherein said explanatory information comprises text segments.

50. A method for automatic production of documentation for configurable computerized systems, comprising the steps of:

coupling a computer with at least a portion of a configurable system via a network;

retrieving configuration parameters having values associated therewith, from said configurable system into said computer;

outputting explanatory information corresponding with at least one of said configuration parameters and a value associated with said parameter;

organizing said explanatory information, based on at least one of a content of said information and said value associated with said parameter, into a narrative format descriptive of the configuration of a configurable system, the narrative format constituting the documentation, or a portion of the documentation, for said configurable system;

storing a first set of configuration parameters from a configurable system;

storing a second set of configuration parameters from a configurable system; and

outputting differences between said first and second sets of configuration parameters.

51. The method of claim 50 further comprising the step of automatically selecting said explanatory information by said computer, in accordance with said configuration parameters.

52. The method of claim 50 wherein said step of retrieving is performed using a collector computer program coupled to said configurable system.

53. The method of claim 50 further comprising the step of constructing said collector program using the Java programming language.

54. The method of claim 50 further comprising the step of automatically retrieving said configuration parameters in accordance with a predetermined schedule.

55. The method of claim 50 wherein said computer is adapted to produce documentation for a plurality of configurable systems.

56. The method of claim 50 wherein said configurable system is at least one selected from a group consisting of a configurable software application, a computer operating system, an electronic messaging system, a database management system, a mass storage platform, file server system, a network router, and a network switching device.

57. The method of claim 50 wherein said configurable system is at least one selected from a group consisting of an organization, a server, a domain, an operating system, a mass storage system, an enterprise management system, a database management system, and a server database management system.

58. The method of claim 50 wherein said configurable system is an enterprise management system.

59. The method of claim 50 wherein said configurable system is a messaging system.

60. The method of claim 50 wherein at least a portion of said explanatory information is grouped in accordance with interrelationship between configuration parameters corresponding to said portion of said explanatory information.

61. The method of claim 50 further comprising the steps of:

c) providing a computer readable set of rules, at least one of said rules having a range of acceptable values associated with one or more configuration parameters for said configurable system; and

,

d) comparing said retrieved configuration parameters against said set of rules.

62. The method of claim 61 further comprising the step of outputting an indication of error conditions if at least one of said configuration parameters violates one or more of said rules.

63. The method of claim 61 wherein at least one of said rules also comprise indications of desired values for said associated parameter, and further comprising the step of outputting information conveying said desired values.

64. The method of claim 63 wherein said desired values are computably modifiable.

65. The method of claim 50 wherein at least a portion of said explanatory information is grouped in accordance with interrelationship between configuration parameters corresponding to said portion of said explanatory information.

66. The method of claim 50 wherein said step of outputting further comprises the step of embedding one or more drawings within said document.

67. The method of claim 50 further comprising the step of communicating said document to another computer by means of a World Wide Web server.

68. The method for claim 50 further comprising the step of storing said retrieved configuration parameters in a database adapted to store one or more sets of configuration variables, and retrieve portions of one or more said sets in response to queries.

69. The method of claim 68 further comprising the step of embedding results of queries within said document.

70. The method according to claim 50, wherein said explanatory information comprises text segments.

71. A method for automatic production of documentation for configurable computerized systems, comprising the steps of:

coupling a computer with at least a portion of a configurable system via a network;

retrieving configuration parameters having values associated therewith, from a configurable system into a computer;

outputting explanatory information, corresponding with at least one of said configuration parameters and a value associated with said parameter, in a narrative format descriptive of a configuration of the configurable system, to form the documentation or a portion thereof;

constructing a table of contents for said documentation, or a portion thereof;

storing a first set of configuration parameters from a configurable system;

storing a second set of configuration parameters from a configurable system; and

outputting differences between said first and second sets of configuration parameters.

72. The method of claim 71 wherein said computer is coupled via an Intranet to at least one configurable system selected from a group consisting of a configurable software application, a computer operating system, an electronic messaging system, a database management system, an enterprise resource planning system, a mass storage platform, file server system, a network router, and a network switching device.

73. The method of claim 71 wherein said configurable system is at least one selected from a group consisting of a server, an operating system, a mass storage system, an enterprise management system, a database management system, and a server database management system.

74. The method according to claim 71, wherein said explanatory information comprises text segments.

75. A method for automatic production of documentation for configurable computerized systems, comprising the steps of:

coupling a computer with at least a portion of a configurable system via a network;

retrieving configuration parameters having values associated therewith, from a configurable system into a computer;

outputting explanatory information, corresponding with at least one of said configuration parameters and a value associated with said parameter, in a narrative format descriptive of a configuration of the configurable system, to form the documentation or a portion thereof; and

maintaining an activity log detailing operations of said steps of retrieving and outputting;

storing a first set of configuration parameters from a configurable system;

storing a second set of configuration parameters from a configurable system; and

outputting differences between said first and second sets of configuration parameters.

76. The method according to claim 75, wherein said explanatory information comprises text segments.

77. A method for automatic production of documentation for configurable computerized systems, comprising the steps of:

coupling a computer with at least a portion of a configurable system via a network;

retrieving configuration parameters having values associated therewith, from a configurable system into a computer;

outputting explanatory information, corresponding with at least one of said configuration parameters and a value associated with said parameter, in a narrative format descriptive of a configuration of the configurable system, to form the documentation or a portion thereof;

generating an index of at least selected parameters of said configuration parameters, and said explanatory information, said index detailing relative location of at least one of said selected parameters and at least a portion of said explanatory information within said document;

storing a first set of configuration parameters from a configurable system;

storing a second set of configuration parameters from a configurable system; and

outputting differences between said first and second sets of configuration parameters.

78. The method according to claim 77, wherein said explanatory information comprises text segments.

79. A system for automatic production of documentation for configurable computerized systems, comprising:

a computer adapted to be coupled to a configurable system via a network;

means for retrieving configuration parameters from said configurable system into said computer;

means for generating explanatory information specific to said configurable system in accordance with said configuration parameters;

means for organizing said explanatory information, based on at least one of a content of said explanatory information and values associated with said configuration parameters, into a narrative format descriptive of a configuration of the configurable system, the narrative format constituting a documentation, or a portion of said documentation, for said configurable system;

means for outputting said documentation; and

means for storing at least a first and a second set of said configuration parameters,

wherein said means for outputting said documentation is further adapted to output difference between said first and second set.

80. The system of claim 79 wherein said means for retrieving comprises a computer program executed on a second computer coupled to said configurable system and wherein said computer is in communication with said second computer via an Intranet.

81. The system according to claim 79, wherein said explanatory information comprises text segments.

99. A computer readable media containing software that when executed by a computer will cause said computer to substantially perform as the system of claim 79.

82. A system for automatic production of documentation for configurable computerized systems, comprising:

a) a computer coupled to said configurable system via a network;

b) a collector program module operated on said computer and adapted to retrieve configuration parameters from at least one configurable system;

c) a documentation generator program module, comprising;

i. a template having explanatory information and place holders indicating placement of one or more configuration parameters;

ii. a data parser in communication with said collector program module, said parser adapted to parse said configuration parameters into associated values and merge said values into said template; and

iii. an output module adapted to organize said explanatory information, based on at least one of a content of said explanatory information and said values associated with said configuration parameters, and to output said template with said merged values in a narrative format descriptive of a configuration of the configurable system, to form the documentation or a portion of said documentation, for said at least one configurable system,

wherein said system is adapted to store at least a first and a second set of said configuration parameters and to output difference between said first and second set.

83. The system of claim 82 further comprising a set of acceptable values for at least one of said configuration parameters and wherein an error condition indication is outputted if the value of a configuration parameter violates said acceptable values.

84. The system of claim 82 further comprising a database and a database management system for storing said configuration parameters, and wherein said database management system is adapted to respond to queries and output a portional view of said configuration parameters for output into said document.

85. The system of claim 82 further comprising a World Wide Web server adapted to communicate said documentation to another computer.

86. The system according to claim 82, wherein said explanatory information comprises text segments.

87. A method for automated production of documentation for configurable computerized system, comprising the steps of:

retrieving configuration parameters from a configurable system, into a computer that is in communication with said configurable system via a network;

selecting explanatory information in accordance with said configuration parameters;

outputting, in a narrative format descriptive of a configuration of the configurable system, a document comprising;

i. said explanatory information;

ii. values associated with said configuration parameters; and

iii. a table of contents detailing relative location of at least certain segments of said explanatory information;

storing a first and a second set of configuration parameters; and

comparing said first set and second set and outputting differences therebetween.

88. The method of claim 87 wherein said configurable system is selected from a group consisting of a configurable software application, a computer operating system, an electronic messaging system, a database management system, an enterprise resource planning system, a mass storage platform, file server system, a network router, a network switching device, or a combination thereof.

89. The system of claim 87 further comprising a World Wide Web server adapted to communicate said documentation to another computer.

90. The method according to claim 87, wherein said explanatory information comprises text segments.

91. A self documenting configurable system, comprising:

a) explanatory information related to said configurable system;

b) at least one software module constructed to

i. merge a plurality of configuration parameters of said configurable system with corresponding portions of said explanatory information related to said configurable system,

ii. organize said explanatory information, based on at least one of a content of said explanatory information and values associated with said configuration parameters, and

iii. output said explanatory information and said configuration parameters in a narrative format descriptive of a configuration of the configurable system, to form a document specific to an instance of said configurable system,

wherein said system is adapted to store at least a first and a second set of said configuration parameters and to output difference between said first and second set.

92. The self documenting configurable system of claim 91 wherein said software module is embedded within said configurable system.

93. The self documenting configurable software system of claim 91 wherein said software module is constructed to be integrated into said configurable system while said configurable system is being executed by at least one computer.

94. The system according to claim 91, wherein said explanatory information comprises text segments.

95. A method for automated production of documentation for a configurable software system, having at least a portion of its behavior modifiable by configuration parameters stored in a computer accessible store, said method comprising the steps of:

embedding into said configurable software system a software module constructed to merge configuration parameters and explanatory information associated with said configuration parameters;

retrieving said configuration parameters, said configuration parameters having values associated therewith, from said configurable system into a computer;

outputting explanatory information corresponding with at least one of said configuration parameters and a value associated with said parameter;

organizing said explanatory information, based on at least one of a content of said information and said value associated with said parameter, into a narrative format descriptive of the configuration of a configurable system, the narrative format constituting the documentation, or a portion of the documentation, describing specifically said configurable software system as configured;

storing a first and a second set of configuration parameters; and

comparing said first set and second set and outputting differences therebetween.

96. The method according to claim 95, wherein said explanatory information comprises text segments.

97. A self documenting configurable software system having configuration parameters stored in at least one computer data store, comprising:

a) a first software module constructed to retrieve at least a portion of said configuration parameters from said computer data store; and

c) a second software module constructed to

i. merge explanatory information and related parameters of at least said portion of said configuration parameters,

ii. organize said explanatory information, based on at least one of a content of said information and values associated with said relates parameters, into a narrative format descriptive of the configuration of a configurable system, the narrative format constituting a document, or a portion of the document, containing a description specific to said configurable system, and

iii. output said document,

wherein said system is adapted to store at least a first and a second set of said configuration parameters and to output difference between said first and second set.

98. The system according to claim 97, wherein said explanatory information comprises text segments.