ReportingService2010.SetExecutionOptions Method (String, String, ScheduleDefinitionOrReference)

Applies To: SQL Server 2016 Preview

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

Namespace:   ReportService2010
Assembly:  ReportService2010 (in ReportService2010.dll)

Syntax

[SoapHeaderAttribute("TrustedUserHeaderValue")]
[SoapDocumentMethodAttribute("https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer/SetExecutionOptions", 
    RequestNamespace = "https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer", 
    ResponseNamespace = "https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer", 
    Use = SoapBindingUse.Literal, ParameterStyle = SoapParameterStyle.Wrapped)]
[SoapHeaderAttribute("ServerInfoHeaderValue", Direction = SoapHeaderDirection.Out)]
public void SetExecutionOptions(
    string ItemPath,
    string ExecutionSetting,
    ScheduleDefinitionOrReference Item
)

public:
[SoapHeaderAttribute("TrustedUserHeaderValue")]
[SoapDocumentMethodAttribute("https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer/SetExecutionOptions", 
    RequestNamespace = "https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer", 
    ResponseNamespace = "https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer", 
    Use = SoapBindingUse::Literal, ParameterStyle = SoapParameterStyle::Wrapped)]
[SoapHeaderAttribute("ServerInfoHeaderValue", Direction = SoapHeaderDirection::Out)]
void SetExecutionOptions(
    String^ ItemPath,
    String^ ExecutionSetting,
    ScheduleDefinitionOrReference^ Item
)

[<SoapHeaderAttribute("TrustedUserHeaderValue")>]
[<SoapDocumentMethodAttribute("https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer/SetExecutionOptions",
    RequestNamespace = "https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer",
    ResponseNamespace = "https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer",
    Use = SoapBindingUse.Literal, ParameterStyle = SoapParameterStyle.Wrapped)>]
[<SoapHeaderAttribute("ServerInfoHeaderValue", Direction = SoapHeaderDirection.Out)>]
member SetExecutionOptions : 
        ItemPath:string *
        ExecutionSetting:string *
        Item:ScheduleDefinitionOrReference -> unit

<SoapHeaderAttribute("TrustedUserHeaderValue")>
<SoapDocumentMethodAttribute("https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer/SetExecutionOptions",
    RequestNamespace := "https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer",
    ResponseNamespace := "https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer",
    Use := SoapBindingUse.Literal, ParameterStyle := SoapParameterStyle.Wrapped)>
<SoapHeaderAttribute("ServerInfoHeaderValue", Direction := SoapHeaderDirection.Out)>
Public Sub SetExecutionOptions (
    ItemPath As String,
    ExecutionSetting As String,
    Item As ScheduleDefinitionOrReference
)

Parameters

• ItemPath
  Type: System.String

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

• ExecutionSetting
  Type: System.String

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

• Item
  Type: ReportService2010.ScheduleDefinitionOrReference

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

Remarks

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

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.

Examples

Legacy Code Example

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

See Also

ReportingService2010 Class
ReportService2010 Namespace

Return to top