Java_EditReportSpecUI_Explain.html 3.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687
  1. <HTML>
  2. <HEAD>
  3. <!--
  4. Licensed Materials - Property of IBM
  5. IBM Cognos Products: DOCS
  6. (C) Copyright IBM Corp. 2005, 2008
  7. US Government Users Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with
  8. IBM Corp.
  9. -->
  10. <TITLE>IBM Cognos Java EditReportSpecUI Program Sample</TITLE>
  11. <link rel="STYLESHEET" type="text/css" href="../../../webcontent/samples/samplesFonts.css">
  12. </HEAD>
  13. <BODY>
  14. <p class="headerTitle"><img src="../../../webcontent/samples/sdk/asp/images/go_logo_small.gif">&nbsp;IBM Cognos Sample Programs</p>
  15. <p class="FormLabel">EditReportSpecUI.java - Modify a report.</p>
  16. <p class="formText">The Java EditReportSpecUI sample program contains methods to retrieve a list report, add a column, update the report specification and save the updated report back to the content store.</p>
  17. <br>
  18. <!-- * * * * * * * * * -->
  19. <!-- -->
  20. <!-- Dependent Files -->
  21. <!-- -->
  22. <!-- * * * * * * * * * -->
  23. <p class="FormLabel">Dependent Files</p>
  24. <p class="formText">Associated files are contained under the java sample folder.<br>
  25. Additional files required for running are identified in the CLASSPATH definitions in run.bat file.</p>
  26. <!-- * * * * * * * * * -->
  27. <!-- -->
  28. <!-- How To Run -->
  29. <!-- -->
  30. <!-- * * * * * * * * * -->
  31. <p class="FormLabel">How To Run The Sample Program</p>
  32. <p class="formText">Double click on the file run.bat.<br><br>
  33. A window will be opened containing:<br>
  34. &nbsp;&nbsp;&nbsp;&nbsp;- Report selection dropdown box<br>
  35. &nbsp;&nbsp;&nbsp;&nbsp;- Edit Report command button<br>
  36. &nbsp;&nbsp;&nbsp;&nbsp;- URL text box<br>
  37. &nbsp;&nbsp;&nbsp;&nbsp;- Output Pane<br>
  38. <br>
  39. Select a list report using the drop down box and click on the 'Edit Report' button to run the sample program.<br>
  40. Use the Report Wizard window for selecting modifications to the report specification.</p>
  41. <p class="formText">Note that the sample works only with list reports, and requires a column for each item in the query.<br>
  42. For example, to modify the report Order Product List, first edit the report in Report Studio to remove Revenue from the query.</p>
  43. <p class="formText">The sample has been coded to work with the Go Data Warehouse (query) package.<br>
  44. For example, select the report Order Product List, and from the Product table, add the Product description column.<br>
  45. If you modify this report, however, please update it in Report Studio to remove the extra column and restore Revenue to the query in case other users are referring to this sample.
  46. Alternatively, you can use Report Studio to create a simple list report in the package to modify.<br>
  47. To work with another package, you may need to edit the Metadata class to select nodes differently.<br>
  48. (Edit both occurrences of "/ResponseRoot/folder/folder/folder/querySubject")</p>
  49. <!-- * * * * * * * * * -->
  50. <!-- -->
  51. <!-- Expected Results -->
  52. <!-- -->
  53. <!-- * * * * * * * * * -->
  54. <p class="FormLabel">Expected Results</p>
  55. <p class="formText">The specified report will be modified according to your selections in the Report Wizard and saved in the content store.</p>
  56. <!-- * * * * * * * * * -->
  57. <!-- -->
  58. <!-- Documentation -->
  59. <!-- -->
  60. <!-- * * * * * * * * * -->
  61. <p class="FormLabel">Documentation</p>
  62. <p class="formText">The IBM Cognos Software Development Kit Developer Guide contains additional information about the samples. See the chapter titled 'Methods' and the appendix titled 'Code Samples and Language-Specific Coding Practices'.</p>
  63. <p class="formText">Please note that the samples are not intended to be treated as end-user applications. Refer to the sample code for examples of how to use the API when developing your own applications.</p>
  64. </BODY>
  65. </HTML>