ReportingService2005.SetExecutionOptions Method

Article
12/03/2008

Sets execution options and associated execution properties for a specified report.

Namespace: Microsoft.WSSUX.ReportingServicesWebService.RSManagementService2005
Assembly: ReportService2005 (in reportingservice2005.dll)

Syntax

'Declaration
<SoapHeaderAttribute("BatchHeaderValue")> _
<SoapHeaderAttribute("ServerInfoHeaderValue", Direction:=SoapHeaderDirection.Out)> _
<SoapDocumentMethodAttribute("https://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices/SetExecutionOptions", RequestNamespace:="https://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices", ResponseNamespace:="https://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices", Use:=SoapBindingUse.Literal, ParameterStyle:=SoapParameterStyle.Wrapped)> _
Public Sub SetExecutionOptions ( _
    Report As String, _
    ExecutionSetting As ExecutionSettingEnum, _
    Item As ScheduleDefinitionOrReference _
)

[SoapHeaderAttribute("BatchHeaderValue")] 
[SoapHeaderAttribute("ServerInfoHeaderValue", Direction=SoapHeaderDirection.Out)] 
[SoapDocumentMethodAttribute("https://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices/SetExecutionOptions", RequestNamespace="https://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices", ResponseNamespace="https://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices", Use=SoapBindingUse.Literal, ParameterStyle=SoapParameterStyle.Wrapped)] 
public void SetExecutionOptions (
    string Report,
    ExecutionSettingEnum ExecutionSetting,
    ScheduleDefinitionOrReference Item
)

[SoapHeaderAttribute(L"BatchHeaderValue")] 
[SoapHeaderAttribute(L"ServerInfoHeaderValue", Direction=SoapHeaderDirection::Out)] 
[SoapDocumentMethodAttribute(L"https://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices/SetExecutionOptions", RequestNamespace=L"https://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices", ResponseNamespace=L"https://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices", Use=SoapBindingUse::Literal, ParameterStyle=SoapParameterStyle::Wrapped)] 
public:
void SetExecutionOptions (
    String^ Report, 
    ExecutionSettingEnum ExecutionSetting, 
    ScheduleDefinitionOrReference^ Item
)

/** @attribute SoapHeaderAttribute("BatchHeaderValue") */ 
/** @attribute SoapHeaderAttribute("ServerInfoHeaderValue", Direction=SoapHeaderDirection.Out) */ 
/** @attribute SoapDocumentMethodAttribute("https://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices/SetExecutionOptions", RequestNamespace="https://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices", ResponseNamespace="https://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices", Use=SoapBindingUse.Literal, ParameterStyle=SoapParameterStyle.Wrapped) */ 
public void SetExecutionOptions (
    String Report, 
    ExecutionSettingEnum ExecutionSetting, 
    ScheduleDefinitionOrReference Item
)

SoapHeaderAttribute("BatchHeaderValue") 
SoapHeaderAttribute("ServerInfoHeaderValue", Direction=SoapHeaderDirection.Out) 
SoapDocumentMethodAttribute("https://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices/SetExecutionOptions", RequestNamespace="https://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices", ResponseNamespace="https://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices", Use=SoapBindingUse.Literal, ParameterStyle=SoapParameterStyle.Wrapped) 
public function SetExecutionOptions (
    Report : String, 
    ExecutionSetting : ExecutionSettingEnum, 
    Item : ScheduleDefinitionOrReference
)

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.

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 that references an existing shared schedule. If you are defining a unique schedule, set the value of Item to the 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.

If you change the value of ExecutionSetting from Live to Snapshot, the report is removed from the cache.

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:

using System;
using System.Web.Services.Protocols;

class Sample
{
   public static void Main()
   {
      ReportingService2005 rs = new ReportingService2005();
      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);
      }
   }
}

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms