GlobalCube
/
analytics


			
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187
							<HTML>
 <HEAD>
<!--
Licensed Materials - Property of IBM

IBM Cognos Products: DOCS

(C) Copyright IBM Corp. 2005, 2008

US Government Users Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with
IBM Corp.
-->
  <TITLE>IBM Cognos Software Development Kit C# Samples</TITLE>
	  <link rel="STYLESHEET" type="text/css" href="../../webcontent/samples/samplesFonts.css">
 </HEAD>


<BODY>

<p class="headerTitle"><img src="../../webcontent/samples/sdk/asp/images/go_logo_small.gif">&nbsp;IBM Cognos Sample Programs</p>

<p class="FormLabel">List of C# Sample Programs for IBM Cognos Software Development Kit</p>

<p class="formText">The sample files are installed in subdirectories under the <em>installation_location</em>/sdk/csharp directory.
Each sample is in its own subdirectory. These subdirectories are
as follows:</p>
<br>

<p class="FormLabel">AddReport</p>

<p class="formText">This sample demonstrates
how to add a report to the content store based on an existing report
specification. The explanation file is <a href="AddReport/CSharp_AddReport_Explain.html">AddReport/CSharp_AddReport_Explain.html</a></p>

<p class="FormLabel">Cancel</p>

<p class="formText">This sample cancels a running report. The explanation file is <a href="Cancel/CSharp_Cancel_Explain.html">Cancel/CSharp_Cancel_Explain.html</a>.</p>

<p class="FormLabel">Capabilities</p>

<p class="formText">This sample removes the Administration
capability from the user running the sample. The explanation file is <a href="Capabilities/CSharp_Capabilities_Explain.html">Capabilities/CSharp_Capabilities_Explain.html</a>.</p>
<p class="formText">This directory
contains the user interface for the Capabilities sample. The methods
used by this sample are in the Security directory.</p>

<p class="FormLabel">CMQuery</p>

<p class="formText">This sample gets the objects from the
content store in the Folder/LOCATION specified by the search option. The explanation file is <a href="CMQuery/csharp_CMQuery_Explain.html">CMQuery/csharp_CMQuery_Explain.html</a>.</p>

<p class="FormLabel">CMTester</p>

<p class="formText">This sample tests whether the content
store is operational. The explanation file is <a href="CMTester/csharp_CMTester_Explain.html">CMTester/csharp_CMTester_Explain.html</a>.</p>

<p class="FormLabel">ContentStoreExplorer</p>

<p class="formText">This sample displays all
the objects in the content store. The explanation file is <a href="ContentStoreExplorer/csharp_CSExplorer_Explain.html">ContentStoreExplorer/csharp_CSExplorer_Explain.html</a>.</p>

<p class="FormLabel">Copy</p>

<p class="formText">This sample copies an object in the content
store. The explanation file is <a href="Copy/CSharp_Copy_Explain.html">Copy/CSharp_Copy_Explain.html</a>.</p>

<p class="FormLabel">CreateDrillThroughTarget</p>

<p class="formText">This sample creates a drillthrough target.
The explanation file is <a href="CreateDrillThroughTarget/CSharp_CreateDrillThroughTarget_Explain.html">CreateDrillThroughTarget/CSharp_CreateDrillThroughTarget_Explain.html</a>.</p>

<p class="FormLabel">CreateReport</p>

<p class="formText">This sample creates a report.
The explanation file is <a href="CreateReport/CSharp_CreateReport_Explain.html">CreateReport/CSharp_CreateReport_Explain.html</a>.</p>

<p class="FormLabel">DeleteReport</p>

<p class="formText">This sample deletes a report that
you specify. The explanation file is <a href="DeleteReport/csharp_DeleteReport_Explain.html">DeleteReport/csharp_DeleteReport_Explain.html</a>.</p>

<p class="FormLabel">Email</p>

<p class="formText">This sample demonstrates how to run a report
and send the output as an email to a specific user. The IBM Cognos
server must be configured with permissions to send email to a
valid email server. For more information, see the <em>Administration
and Security Guide</em>. The explanation file is <a href="Email/CSharp_Email_Explain.html">Email/CSharp_Email_Explain.html</a>.</p>

<p class="FormLabel">ExecuteReport</p>

<p class="formText">This sample contains methods for
executing different types of reports. The explanation file is <a href="ExecuteReport/CSharp_ExecReports_Explain.html">ExecuteReport/CSharp_ExecReports_Explain.html</a>.</p>

<p class="FormLabel">Move</p>

<p class="formText">This sample moves an object in the content
store. The explanation file is <a href="Move/CSharp_Move_Explain.html">Move/CSharp_Move_Explain.html</a>.</p>

<p class="FormLabel">Permissions</p>

<p class="formText">This sample denies the current user
read permission to that user's MyFolders folder. The explanation file is <a href="Permissions/CSharp_Permissions_Explain.html">Permissions/CSharp_Permissions_Explain.html</a>.</p>
<p class="formText">This
directory contains the user interface for the Permissions sample.
The methods used by this sample are in the Security directory.</p>

<p class="FormLabel">PrintReport</p>

<p class="formText">This sample prints a report that you
specify. You can also add entries to the list of printers, or remove
existing ones from it. The explanation file is <a href="PrintReport/CSharp_PrintReport_Explain.html">PrintReport/CSharp_PrintReport_Explain.html</a>.</p>
<p class="formText">For information about setting
up IBM Cognos services to use network printers on a Windows installation,
see the <em>Administration and Security Guide</em></p>

<p class="FormLabel">ReportParameters</p>

<p class="formText">This sample gets or retrieves
parameters associated with the specified report. The explanation file is <a href="ReportParameters/csharp_ReportParameters_Explain.html">ReportParameters/csharp_ReportParameters_Explain.html</a>.</p>

<p class="FormLabel">reportrunner</p>

<p class="formText">This sample runs a report that you
specify, and produces results that are saved in HTML format.. The explanation file is <a href="reportrunner/csharp_reportrunner_Explain.html">reportrunner/csharp_reportrunner_Explain.html</a>.</p>

<p class="FormLabel">SamplesCommon</p>

<p class="formText">This sample includes many common
classes that are used by the other C# .NET samples. It does not
include a sample executable program, but instead builds a DLL that
the other samples use. The explanation file is <a href="SamplesCommon/csharp_Common_Explain.html">SamplesCommon/csharp_Common_Explain.html</a>.</p>

<p class="FormLabel">Save</p>

<p class="formText">This sample runs a report that you specify,
and saves the output or allows you to save it with a new name. The explanation file is <a href="Save/CSharp_Save_Explain.html">Save/CSharp_Save_Explain.html</a>.</p>

<p class="FormLabel">Schedule</p>

<p class="formText">This sample creates a new schedule for
a report. The explanation file is <a href="Schedule/CSharp_Schedule_Explain.html">Schedule/CSharp_Schedule_Explain.html</a>.</p>

<p class="FormLabel">Security</p>

<p class="formText">These samples allow you to perform a
number of security related tasks, such as logging on to a secured
namespace, logging off, and displaying the current logon information.
If you are not logged on when you attempt to display your logon
information, you will be prompted to log on. The explanation file is <a href="Security/CSharp_Security_Explain.html">Security/CSharp_Security_Explain.html</a>.</p>
<p class="formText">Although
most of the samples will work when Anonymous access is enabled,
they serve as more robust examples when a secured namespace is used.</p>

<p class="FormLabel">Submit</p>

<p class="formText">This sample creates a new job and submits it. The explanation file is <a href="Submit/CSharp_Submit_Explain.html">Submit/CSharp_Submit_Explain.html</a>.</p>

<p class="FormLabel">ViewAll</p>

<p class="formText">This sample displays a list of all packages,
reports, and queries in the content store. The explanation file is <a href="ViewAll/csharp_ViewAll_Explain.html">ViewAll/csharp_ViewAll_Explain.html</a>.</p>

<p class="FormLabel">ViewPackages</p>

<p class="formText">This sample displays a list of all
packages in the content store. The explanation file is <a href="ViewPackages/csharp_ViewPackages_Explain.html">ViewPackages/csharp_ViewPackages_Explain.html</a>.</p>

<p class="FormLabel">ViewReports</p>

<p class="formText">This sample displays a list of all
reports, and queries in the content store. The explanation file is <a href="ViewReports/csharp_ViewReports_Explain.html">ViewReports/csharp_ViewReports_Explain.html</a>.</p>


<!-- * * * * * * * * * -->
<!--                   -->
<!-- Documentation     -->
<!--                   -->
<!-- * * * * * * * * * -->
<p class="FormLabel">Documentation</p>

<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>
<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>

</BODY>
</HTML>