Java_AlertslUI_Explain.html 3.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384
  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 AlertsUI 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">AlertsUI.java - Emails a report.</p>
  16. <p class="formText">The Java AlertsUI sample program contains methods that manage alert lists.</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;- URL text box<br>
  35. &nbsp;&nbsp;&nbsp;&nbsp;- Alert Option selection dropdown box<br>
  36. &nbsp;&nbsp;&nbsp;&nbsp;- Report selection dropdown box<br>
  37. &nbsp;&nbsp;&nbsp;&nbsp;- Send Request button<br>
  38. &nbsp;&nbsp;&nbsp;&nbsp;- Output Pane<br>
  39. <br>
  40. Select an alert option from the drop down box, select a report (if applicable), and click on the 'Send Request' button to run the sample program.</p>
  41. <!-- * * * * * * * * * -->
  42. <!-- -->
  43. <!-- Expected Results -->
  44. <!-- -->
  45. <!-- * * * * * * * * * -->
  46. <p class="FormLabel">Expected Results</p>
  47. <p class="formText">When the 'Add Notification' option is selected, the user is added to the alert list for the selected report, if the report allows this and if the user has an email address configured.</p>
  48. <p class="formText">When the 'Delete Notification' option is selected, the user removed from the alert list of the specified report..</p>
  49. <p class="formText">When the 'Delete All Notifications' option is selected, the user is removed from all object alert lists. </p>
  50. <p class="formText">When the 'Clear Notifications' option is selected, all entries are removed from the alert list for the specified report.</p>
  51. <p class="formText">
  52. When the 'Query Notification' option is selected, information is returned about whether the report supports alerts, and whether the user is currently on the report's alert list.</p>
  53. <!-- * * * * * * * * * -->
  54. <!-- -->
  55. <!-- Documentation -->
  56. <!-- -->
  57. <!-- * * * * * * * * * -->
  58. <p class="FormLabel">Documentation</p>
  59. <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>
  60. <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>
  61. </BODY>
  62. </HTML>