ReportingService2010.SetExecutionOptions Method

Definition

Namespace:

ReportService2010

Assembly:

ReportService2010.dll

Sets execution options and associated execution properties for a specified item. This method applies to the Report item type.

public:
 void SetExecutionOptions(System::String ^ ItemPath, System::String ^ ExecutionSetting, ReportService2010::ScheduleDefinitionOrReference ^ Item);

[System.Web.Services.Protocols.SoapDocumentMethod("http://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer/SetExecutionOptions", ParameterStyle=System.Web.Services.Protocols.SoapParameterStyle.Wrapped, RequestNamespace="http://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer", ResponseNamespace="http://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer", Use=System.Web.Services.Description.SoapBindingUse.Literal)]
[System.Web.Services.Protocols.SoapHeader("TrustedUserHeaderValue")]
[System.Web.Services.Protocols.SoapHeader("ServerInfoHeaderValue", Direction=System.Web.Services.Protocols.SoapHeaderDirection.Out)]
public void SetExecutionOptions (string ItemPath, string ExecutionSetting, ReportService2010.ScheduleDefinitionOrReference Item);

[<System.Web.Services.Protocols.SoapDocumentMethod("http://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer/SetExecutionOptions", ParameterStyle=System.Web.Services.Protocols.SoapParameterStyle.Wrapped, RequestNamespace="http://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer", ResponseNamespace="http://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer", Use=System.Web.Services.Description.SoapBindingUse.Literal)>]
[<System.Web.Services.Protocols.SoapHeader("TrustedUserHeaderValue")>]
[<System.Web.Services.Protocols.SoapHeader("ServerInfoHeaderValue", Direction=System.Web.Services.Protocols.SoapHeaderDirection.Out)>]
member this.SetExecutionOptions : string * string * ReportService2010.ScheduleDefinitionOrReference -> unit

Public Sub SetExecutionOptions (ItemPath As String, ExecutionSetting As String, Item As ScheduleDefinitionOrReference)

Parameters

ItemPath

String

The fully qualified URL of the item including the file name and, in SharePoint mode, the extension.

ExecutionSetting

String

A string that describes when the item executes. The value can be either Live or Snapshot.

Item

ScheduleDefinitionOrReference

The schedule definition or shared schedule (ScheduleDefinitionOrReference object) that the report server uses to execute an item on a schedule.

Attributes

SoapDocumentMethodAttribute SoapHeaderAttribute

Examples

using System;  
using System.Collections.Generic;  
using System.IO;  
using System.Text;  
using System.Web;  
using System.Web.Services;  
using System.Web.Services.Protocols;  

class Sample  
{  
    static void Main(string[] args)  
    {  
        ReportingService2010 rs = new ReportingService2010();  
        rs.Url = "http://<Server Name>/_vti_bin/ReportServer/" +  
            "ReportService2010.asmx";  
        rs.Credentials =   
            System.Net.CredentialCache.DefaultCredentials;  

        ScheduleDefinition definition = new ScheduleDefinition();  

        // Create the schedule definition.  
        definition.StartDateTime =   
            new DateTime(2010, 2, 22, 10, 15, 0);  
        MinuteRecurrence recurrence = new MinuteRecurrence();  
        recurrence.MinutesInterval = 60;  
        definition.Item = recurrence;  

        // Apply execution settings  
        try  
        {  
            rs.SetExecutionOptions("http://<Server Name>" +  
                "/Docs/Documents/AdventureWorks Sample Reports/" +  
                "Sales Order Detail.rdl",   
                "Snapshot", definition);  
        }  

        catch (SoapException ex)  
        {  
            Console.WriteLine(ex.Detail.OuterXml);  
        }  
    }  
}  

Imports System  
Imports System.IO  
Imports System.Text  
Imports System.Web.Services  
Imports System.Web.Services.Protocols  

Class Sample  

    Public Shared Sub Main()  

        Dim rs As New ReportingService2010()  
        rs.Url = "http://<Server Name>/_vti_bin/ReportServer/" + _  
            "ReportService2010.asmx"  
        rs.Credentials = _  
            System.Net.CredentialCache.DefaultCredentials  

        Dim definition As New ScheduleDefinition()  
        definition.StartDateTime = _  
            New DateTime(2003, 2, 22, 10, 15, 0)  
        Dim recurrence As New MinuteRecurrence()  
        recurrence.MinutesInterval = 60  
        definition.Item = recurrence  

        Try  
            rs.SetExecutionOptions("http://<Server Name>" + _  
                "/Docs/Documents/AdventureWorks Sample Reports/" + _  
                "Sales Order Detail.rdl", _  
                "Snapshot", definition)  
        Catch ex As SoapException  
            Console.WriteLine(ex.Detail.OuterXml)  
        End Try  

    End Sub  

End Class  

Remarks

The table below shows header and permissions information on this operation.

SOAP Header Usage	(In) TrustedUserHeaderValue (Out) ServerInfoHeaderValue
Native Mode Required Permissions	UpdatePolicy
SharePoint Mode Required Permissions	<xref:Microsoft.SharePoint.SPBasePermissions.EditListItems>

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 an item are based on a shared schedule and that shared schedule is deleted, the schedule is then associated with the individual item.

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