SetExecutionOptions Method
ReportingService.SetExecutionOptions Method
Sets execution options and associated execution properties for a specified report.
Public Sub SetExecutionOptions( ByVal Report As String _ ByVal ExecutionSetting As [Namespace].ExecutionSettingEnum _ ByVal Item As [Namespace].ScheduleDefinitionOrReference _ ) Member of [Namespace].ReportingService
public void SetExecutionOptions( string Report, [Namespace].ExecutionSettingEnum ExecutionSetting, [Namespace].ScheduleDefinitionOrReference Item ); Member of [Namespace].ReportingService
Parameters
- Report
- The full path name of the report.
- ExecutionSetting
- One of the ExecutionSettingEnum values that describe when the report executes. The value can be either Live or Snapshot.
- Item
- The schedule definition or shared schedule (ScheduleDefinitionOrReference object) that the report server uses to execute a report on a schedule.
Permissions
| Operation | Description |
|---|---|
| Update Policy | Required to set the execution options of a report. |
Remarks
The Item parameter is valid only if the value of the ExecutionSetting parameter is Snapshot. Set the value of Item to null (Nothing in Visual Basic) if ExecutionSetting is set to Live. If you are using a shared schedule, set the value of Item to a ScheduleReference object, which references an existing shared schedule. If you are defining a unique schedule, set the value of Item to the schedule definition (ScheduleDefinition object) that defines a unique schedule. If the execution options for a report are based on a shared schedule and that shared schedule is deleted, the schedule is then associated with the individual report.
Changing the value of ExecutionSetting from Live to Snapshot can result in the removal of a report from the cache. If the report is cached, the CacheReport parameter is set to false.
Example
To compile the following code example, you must reference the Reporting Services WSDL and import certain namespaces. For more information, see Compiling and Running Code Examples. The following code example uses the SetExecutionOptions method to set the options for the Company Sales report to run as a snapshot on a schedule:
Imports System
Imports System.Web.Services.Protocols
Class Sample
Public Shared Sub Main()
Dim rs As New RSWebService()
rs.Credentials = System.Net.CredentialCache.DefaultCredentials
Dim definition As New DataSourceDefinition()
definition.CredentialRetrieval = CredentialRetrievalEnum.Integrated
definition.ConnectString = "data source=(local);initial catalog=AdventureWorks2000"
definition.Enabled = True
definition.EnabledSpecified = True
definition.Extension = "SQL"
definition.ImpersonateUser = False
definition.ImpersonateUserSpecified = True
definition.Prompt = Nothing
definition.WindowsCredentials = False
Try
rs.SetDataSourceContents("/SampleReports/AdventureWorks", definition)
Catch e As SoapException
Console.WriteLine(e.Detail.OuterXml)
End Try
End Sub 'Main
End Class 'Sample
using System;
using System.Web.Services.Protocols;
class Sample
{
public static void Main()
{
RSWebService rs = new RSWebService();
rs.Credentials = System.Net.CredentialCache.DefaultCredentials;
ScheduleDefinition definition = new ScheduleDefinition();
// Create the schedule definition.
definition.StartDateTime = new DateTime( 2003, 2, 22, 10, 15, 0 );
MinuteRecurrence recurrence = new MinuteRecurrence();
recurrence.MinutesInterval = 60;
definition.Item = recurrence;
// Apply execution settings
try
{
rs.SetExecutionOptions("/SampleReports/Company Sales", ExecutionSettingEnum.Snapshot, definition);
}
catch (SoapException ex)
{
Console.WriteLine(ex.Detail.OuterXml);
}
}
}
