Electronic work environment for a data processing system

• US 5,913,066 A
• Filed: 09/17/1997
• Issued: 06/15/1999
• Est. Priority Date: 01/27/1993
• Status: Expired due to Term

• Current Assignee: Alcatel Network Systems India Limited (Nokia Corporation)
• Original Assignee: Alcatel Network Systems India Limited (Nokia Corporation)
• Inventors: Benzenberg, Craig Kay, Roe, Colleen Ann, Oslund, Lawrence Carl, Mann, Lloyd Steven
• Primary Examiner(s): Peeso, Thomas R.
• Assistant Examiner(s): Nguyen, Cuong H.
• Application Number:
  US08/931,899
• Time in Patent Office: 636 Days
• Field of Search: 395/500, 395/712, 395/200.33, 395/200.49, 395/652, 395/183.13, 395/183.16, 395/183.22, 395/200.47, 395/200.58, 395/200.61, 395/285, 395/671 , 395/828, 395/680, 707/10, 707/104, 265/472, 265/462, 345/341, 345/326, 345/121, 345/339, 345/349, 345/352
• US Class Current: 717/174
• CPC Class Codes: G06F 11/2247 Verification or detection of system hardware configuration

Abstract

An electronic work environment for a data processing system includes documentation modules which execute on the hardware elements of the system. The documentation modules exchange data between the software elements and hardware elements of the data processing system to produce interaction between the documentation modules and the data processing system. A common user interface module displays the results of the interaction between the software and hardware elements and the documentation modules. Accordingly, the documentation becomes part of the operating environment of the data processing system. The documentation modules are generalized documentation modules including online documentation for every possible configuration of the hardware and software elements of the data processing system. The electronic work environment electronically generates customized documentation modules based upon the actual configuration of the hardware and software elements of the system to which it applies, or in response to user queries. The customized documentation modules, or portions thereof, are displayed in response to user requests.

Claims

1. A data processing system comprising:

a plurality of predetermined hardware and software elements arranged in a predetermined configuration;

a generalized documentation module including generalized online documentation for said data processing system, said generalized documentation module including documentation relating to said plurality of predetermined hardware and software elements, and further including documentation relating to other hardware and software elements in addition to said predetermined hardware and software elements;

means for electronically identifying said predetermined configuration of said predetermined hardware and software elements without requiring user identification;

means, responsive to said generalized documentation module and to said identifying means, for generating a customized online documentation module which is customized to the electronically identified predetermined configuration of said predetermined hardware and software elements; and

means, responsive to said generating means, for displaying selected portions of the customized documentation module in response to a user request.

2. The data processing system of claim 1 wherein said generalized documentation module includes a generalized system description module, and wherein said customizing means comprises means for generating a customized system description module which reflects said predetermined configuration of said hardware and software elements.

3. The data processing system of claim 1 wherein said generalized documentation module includes a generalized applications guide module, and wherein said customizing means comprises means for generating a customized applications guide module which reflects said predetermined configuration of said hardware and software elements.

4. The data processing system of claim 1 wherein said generalized documentation module includes a generalized installation procedures module, and wherein said customizing means comprises means for generating a customized installation procedures module which reflects said predetermined configuration of said hardware and software elements.

5. The data processing system of claim 1 wherein said generalized documentation module includes a generalized troubleshooting guide module, and wherein said customizing means comprises means for generating a customized troubleshooting guide module which reflects said predetermined configuration of said hardware and software elements.

6. The data processing system of claim 5 wherein said generalized documentation module further includes a generalized ordering guide module, and wherein said customizing means further comprises means for generating a customized ordering guide module which reflects said predetermined configuration of said hardware and software elements;

said data processing system further comprising means, responsive to an error in said data processing means upon execution of said customized troubleshooting guide module, for executing said customized ordering module and ordering a replacement part.

7. The data processing system of claim 1 wherein said generalized documentation module includes a generalized ordering guide module, and wherein said customizing means comprises means for generating a customized ordering guide module which reflects said predetermined configuration of said hardware and software elements.

8. The data processing system of claim 4 wherein said generalized documentation module further includes a generalized troubleshooting guide module, and wherein said customizing means further comprises means for generating a customized troubleshooting guide module which reflects said predetermined configuration of said hardware and software elements;

said data processing system further comprising means, responsive to an error in said data processing system upon execution of said customized installation procedures, for displaying a predetermined portion of said customized troubleshooting guide which corresponds to said error.

9. The data processing system of claim 6:

wherein said generalized documentation module includes a generalized installation procedures module, and wherein said customizing means comprises means for generating a customized installation procedures module which reflects said predetermined configuration of said hardware and software elements;

said electronic work environment further comprising means, responsive to an indication that the replacement part has arrived, for serially executing said customized installation procedures guide and said troubleshooting guide, to facilitate installation of the replacement part and troubleshooting of the data processing system including the installed replacement part, respectively.

10. A method for operating a data processing system, the data processing system comprising a plurality of hardware elements and a plurality of software elements for causing said hardware elements to perform predetermined application functions upon execution of said software elements on said hardware elements, said method comprising the following steps which are performed by said data processing system:

storing in said data processing system a plurality of online documentation modules, including at least one of a system description module, an application guide module, an ordering guide module, an installation procedures module, and a system administration module;

exchanging data between at least one of said software elements and at least one of said online documentation modules, in response to execution of said plurality of software elements and said plurality of documentation modules on at least one of said hardware elements, to produce interaction between said at least one software element and said at least one documentation module; and

displaying results of the interaction between said at least one software element and said at least one online documentation module via a common user interface.

11. The method of claim 10 wherein said data exchanging step includes the step of generating at least one customized documentation module from the plurality of documentation modules, which reflects said predetermined configuration of said hardware and software elements.

12. A data processing system, comprising:

a plurality of hardware elements;

a plurality of software elements which cause said hardware elements to perform predetermined application functions upon execution of said software elements on said hardware elements;

a plurality of online documentation modules which execute on at least one of said hardware elements, including at least one of a system description module, an application guide module, an ordering guide module, an installation procedures module, and a system administration module;

means, responsive to execution of said plurality of software elements and said plurality of online documentation modules on at least one of said hardware elements, for exchanging data between at least one of said software elements and at least one of said online documentation modules, to produce interaction between said at least one software element and said at least one online documentation module;

displaying means; and

a common user interface module, responsive to said data exchanging means, for displaying on said displaying means, results of the interaction between said at least one software element and said at least one documentation module.

13. The data processing system of claim 12 wherein said data exchanging means comprises a plurality of documentation application software modules.

14. The data processing system of claim 12 wherein said common user interface module includes an interactive multimedia module.

15. The data processing system of claim 12 wherein said data exchanging means includes means for generating at least one customized documentation module which reflects said predetermined configuration of said hardware and software elements.

16. The data processing system of claim 13 wherein said document application software modules include an expert system.

17. A method for operating a data processing system including predetermined hardware and software elements arranged in a predetermined configuration, comprising the following steps which are performed by said data processing system:

storing in said data processing system, a generalized documentation module including generalized online documentation for said data processing system, said generalized documentation module including documentation relating to said plurality of predetermined hardware and software elements and further including documentation relating to other hardware and software elements in addition to said predetermined hardware and software elements;

electronically identifying said predetermined configuration of said predetermined hardware and software elements without requiring user identification;

customizing the generalized online documentation module to the electronically identified predetermined configuration of said predetermined hardware and software elements; and

displaying selected portions of the customized online documentation module in response to a user request.

18. The method of claim 17 wherein said generalized documentation module includes a generalized system description module, and wherein said customizing step comprises the step of customizing the generalized system description module to reflect said predetermined configuration of said hardware and software elements.

19. The method of claim 17 wherein said generalized documentation module includes a generalized applications guide module, and wherein said customizing step comprises the step of customizing the generalized applications guide module to reflect said predetermined configuration of said hardware and software elements.

20. The method of claim 17 wherein said generalized documentation module includes a generalized installation procedures module, and wherein said customizing step comprises the step of customizing the generalized installation procedures module to reflect said predetermined configuration of said hardware and software elements.

21. The method of claim 17 wherein said generalized documentation module includes a generalized troubleshooting guide module, and wherein said customizing step comprises the step of customizing the generalized troubleshooting guide module to reflect said predetermined configuration of said hardware and software elements.

22. The method of claim 21 wherein said generalized documentation module further includes a generalized ordering guide module, and wherein said customizing step further comprises the step of customizing the generalized ordering guide module to reflect said predetermined configuration of said hardware and software elements;

said method further comprising the step of executing said customized ordering module and ordering a replacement part in response to an error in said data processing means upon execution of the customized troubleshooting guide module.

23. The method of claim 17 wherein said generalized documentation module includes a generalized ordering guide module, and wherein said customizing step comprises the step of customizing the generalized ordering guide module to reflect said predetermined configuration of said hardware and software elements.

24. The method of claim 20 wherein said generalized documentation module further includes a generalized troubleshooting guide module, and wherein said customizing step further comprises the step of customizing the generalized troubleshooting guide module to reflect said predetermined configuration of said hardware and software elements;

said method further comprising the step of displaying a predetermined portion of the customized troubleshooting guide in response to an error in said data processing system upon execution of said customized installation procedures.

25. The method of claim 22:

wherein said generalized documentation module further includes a generalized installation procedures module, and wherein said customizing step comprises the step of customizing the generalized installation procedures module to reflect said predetermined configuration of said hardware and software elements;

said method further comprising the following step which is performed in response to an indication that the replacement part has arrived;

serially executing said customized installation procedures guide and said troubleshooting guide, to facilitate installation of the replacement part and troubleshooting of the data processing system including the installed replacement part, respectively.

26. A computer program product which provides online documentation for a plurality of predetermined hardware and software elements arranged in a predetermined configuration;

said computer program product comprising;

a computer-readable storage medium having computer-readable program code means embodied in said medium, said computer-readable program code means comprising;

computer readable program code means which provides a generalized documentation module including generalized on-line documentation for said data processing system, said generalized documentation module including documentation relating to said plurality of predetermined hardware and software elements, and further including documentation relating to other hardware and software elements in addition to said predetermined hardware and software elements;

computer-readable program code means for electronically identifying said predetermined configuration of said predetermined hardware and software elements without requiring user identification;

computer-readable program code means, responsive to said generalized documentation module and to said identifying means, for generating a customized online documentation module which is customized to the electronically identified predetermined configuration of said predetermined hardware and software elements; and

computer-readable program code means, responsive to said generating means, for displaying selected portions of the customized documentation module on display device in response to a user request.

27. The computer program product of claim 26 wherein said generalized documentation module includes a generalized ordering guide module, wherein said customizing means comprises means for generating a customized ordering guide module which reflects said predetermined configuration of said hardware and software elements.

28. The computer program product of claim 26 wherein said generalized documentation module includes a generalized troubleshooting guide module, and wherein said customizing means comprises means for generating a customized troubleshooting guide module which reflects said predetermined configuration of said hardware and software elements.

29. The computer program product of claim 28 wherein said generalized documentation module further includes a generalized ordering guide module, and wherein said customizing means further comprises means for generating a customized ordering guide module which reflects said predetermined configuration of said hardware and software elements;

said computer program product further comprising computer-readable program code means, responsive to an error in said data processing means upon execution of said customized troubleshooting guide module, for executing said customized ordering module and ordering a replacement part.

30. The computer program product of claim 26 wherein said generalized documentation module includes a generalized installation procedures module, and wherein said customizing means comprises means for generating a customized installation procedures module which reflects said predetermined configuration of said hardware and software elements.

31. The computer program product of claim 26 wherein said generalized documentation module includes a generalized system description module, and wherein said customizing means comprises means for generating a customized system description module which reflects said predetermined configuration of said hardware and software elements.

32. The computer program product of claim 26 wherein said generalized documentation module includes a generalized applications guide module, and wherein said customizing means comprises means for generating a customized applications guide module which reflects said predetermined configuration of said hardware and software elements.

33. The computer program product of claim 30 wherein said generalized documentation module further includes a generalized troubleshooting guide module, and wherein said customizing means further comprises means for generating a customized troubleshooting guide module which reflects said predetermined configuration of said hardware and software elements;

said computer program product further comprising computer-readable program code means, responsive to an error in said data processing system upon execution of said customized installation procedures, for displaying a predetermined portion of said customized troubleshooting guide which corresponds to said error.

34. The computer program product of claim 32:

wherein said generalized documentation module includes a generalized installation procedures module, and wherein said customizing means comprises means for generating a customized installation procedures module which reflects said predetermined configuration of said hardware and software elements;

said computer program product further comprising computer-readable program code means, responsive to an indication that the replacement part has arrived, for serially executing said customized installation procedures guide and said troubleshooting guide, to facilitate installation of the replacement part and troubleshooting of the data processing system including the installed replacement part, respectively.

35. A computer program product for execution on a data processing system comprising a plurality of hardware elements, said computer program product comprising:

a computer-readable storage medium having computer-readable program code means embodied in said medium, said computer-readable program code means comprising;

computer-readable program code means which provides a plurality of software elements which cause said hardware elements to perform predetermined application functions upon execution of said software elements on said hardware elements;

computer-readable program code means which provides a plurality of online documentation modules which execute on at least one of said hardware elements, including at least one of a system description module, an application guide module, an ordering guide module, an installation procedures module, and a system administration module;

computer-readable programmable means, responsive to execution of said plurality of software elements and said plurality of online documentation modules on at least one of said hardware elements, for exchanging data between at least one of said software elements and at least one of said online documentation modules, to produce interaction between said at least one software element and said at least one online documentation module; and

computer readable program code means which provides a common user interface module, responsive to said data exchanging means, for displaying on a display, results of the interaction between said at least one software element and said at least one online documentation module.

36. The data processing system of claim 35 wherein said data exchanging means comprises a plurality of documentation application software modules.

37. The computer program product of claim 36 wherein said document application software modules include an expert system.

38. The computer program product of claim 35 wherein said common user interface module includes an interactive multimedia module.

39. The computer program product of claim 35 wherein said data exchanging means includes means for generating at least one customized documentation module which reflects said predetermined configuration of said hardware and software elements.