ReportingService2006.SetExecutionOptions Method

Article
12/03/2008

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

Namespace: ReportService2006
Assembly: ReportService2006 (in reportservice2006.dll)

Syntax

'Declaration
Public Sub SetExecutionOptions ( _
    Report As String, _
    ExecutionSetting As ExecutionSettingEnum, _
    Item As ScheduleDefinitionOrReference _
)

public void SetExecutionOptions (
    string Report,
    ExecutionSettingEnum ExecutionSetting,
    ScheduleDefinitionOrReference Item
)

public:
void SetExecutionOptions (
    String^ Report, 
    ExecutionSettingEnum ExecutionSetting, 
    ScheduleDefinitionOrReference^ Item
)

public void SetExecutionOptions (
    String Report, 
    ExecutionSettingEnum ExecutionSetting, 
    ScheduleDefinitionOrReference Item
)

public function SetExecutionOptions (
    Report : String, 
    ExecutionSetting : ExecutionSettingEnum, 
    Item : ScheduleDefinitionOrReference
)

Parameters

Report
The fully qualified URL of the report including the file name and .rdl file name extension.

ExecutionSetting
One of the ExecutionSettingEnum values that describes 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

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)
    {
        ReportingService2006 rs = new ReportingService2006();
        rs.Url = "http://<Server Name>/_vti_bin/ReportServer/" +
            "ReportService2006.asmx";
        rs.Credentials = 
            System.Net.CredentialCache.DefaultCredentials;

        ScheduleDefinition definition = new ScheduleDefinition();

        // Create the schedule definition.
        definition.StartDateTime = 
            new DateTime(2006, 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", 
                ExecutionSettingEnum.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 ReportingService2006()
        rs.Url = "http://<Server Name>/_vti_bin/ReportServer/" + _
            "ReportService2006.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", _
                ExecutionSettingEnum.Snapshot, definition)
        Catch ex As SoapException
            Console.WriteLine(ex.Detail.OuterXml)
        End Try

    End Sub

End Class

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

Windows 98, Windows 2000, Windows 2000 Server, Windows CE, Windows Server 2008, Windows 98 Second Edition, Pocket PC, Smart Phone, Windows Server 2003, Windows XP Professional with Service Pack 2 (SP2), Windows 2000 Professional, Windows 2000 Advanced Server, Windows XP Home Edition, For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005., Windows Vista, Windows Mobile 5.0, Windows Mobile 2003 for Pocket PC, Windows CE 5.0

Share via