csharp_reportrunner_Explain.html 4.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293
  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. <META name="Copyright (C) 2008 Cognos ULC, an IBM Company. All rights reserved.">
  11. <META name="Cognos (R) is a trademark of Cognos ULC, (formerly Cognos Incorporated)">
  12. <TITLE>IBM Cognos Software Development Kit C# reportrunner Program Sample</TITLE>
  13. <link rel="STYLESHEET" type="text/css" href="../../../webcontent/samples/samplesFonts.css">
  14. </HEAD>
  15. <BODY>
  16. <p class="headerTitle"><img src="../../../webcontent/samples/sdk/asp/images/go_logo_small.gif">&nbsp;IBM Cognos Sample Programs</p>
  17. <p class="FormLabel">reportrunner.sln - Run a Report and Save the Output in HTML Format.</p>
  18. <p class="formText">The C# reportrunner sample program lets you specify a report to be run and the results saved in HTML format.<br><br>
  19. Requirements:<br>
  20. - IBM Cognos Software Development Kit<br>
  21. - .NET Framework Version 3 or later<br>
  22. - a running IBM Cognos server<br>
  23. - the IBM Cognos samples databases and samples deployment archive must be installed and configured (if you do not specify a report name on the command-line)<br>
  24. - appropriate permissions set up for the Anonymous account, or a user specified on the command-line</p>
  25. <br>
  26. <!-- * * * * * * * * * -->
  27. <!-- -->
  28. <!-- Dependent Files -->
  29. <!-- -->
  30. <!-- * * * * * * * * * -->
  31. <p class="FormLabel">Dependent Files</p>
  32. <p class="formText">All associated files are contained in the bin directory of the csharp directory.</p>
  33. <!-- * * * * * * * * * -->
  34. <!-- -->
  35. <!-- How To Run -->
  36. <!-- -->
  37. <!-- * * * * * * * * * -->
  38. <p class="FormLabel">How To Run The Sample Program</p>
  39. <p class="formText">Launch the command window and navigate to the sample program bin directory in the csharp directory.<br>Type reportrunner.exe<br>The options for the command are:<br>
  40. -host hostName&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Host name of an IBM Cognos server.<br>
  41. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: localhost<br>
  42. -port portNumber&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Port number of the IBM Cognos server 'host'.<br>
  43. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: 9300<br>
  44. -report searchPath&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Search path for a report in the content store.<br>
  45. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: /content/folder[@name='Samples']/folder[@name='Models']/package[@name='GO Data Warehouse (query)']/folder[@name='SDK Report Samples']/report[@name='Product Description List']<br>
  46. -output outputPath&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;File name for the output HTML document.<br>
  47. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: reportrunner.html<br>
  48. -user userName&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;User to log on as. Must exist in 'userNamespace'.<br>
  49. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: Anonymous<br>
  50. -password userPassword&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Password for 'userName' in 'userNamespace'.<br>
  51. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: none<br>
  52. -namespace userNamespace&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;ID of security namespace to log on to.<br>
  53. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default: none<br><br>
  54. A new window will be opened.</p>
  55. <!-- * * * * * * * * * -->
  56. <!-- -->
  57. <!-- Expected Results -->
  58. <!-- -->
  59. <!-- * * * * * * * * * -->
  60. <p class="FormLabel">Expected Results</p>
  61. <p class="formText">The report is saved in HTML format with the name specified or the default name reportrunner.html<br> <br><br></p>
  62. <p class="formText">This sample does not demonstrate working with parameters or prompts. Select a report that does not prompt for parameter values.</p>
  63. <!-- * * * * * * * * * -->
  64. <!-- -->
  65. <!-- Documentation -->
  66. <!-- -->
  67. <!-- * * * * * * * * * -->
  68. <p class="FormLabel">Documentation</p>
  69. <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>
  70. <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>
  71. </BODY>
  72. </HTML>