[アーティクル]
04/01/2012

CreateSubscription メソッド

指定したアイテムのサブスクリプションをレポートサーバーデータベースまたは SharePoint ライブラリに作成します。このメソッドは、アイテムの種類 Report に適用されます。

名前空間: ReportService2010
アセンブリ: ReportService2010 (ReportService2010.dll)

構文

'宣言
<SoapHeaderAttribute("ServerInfoHeaderValue", Direction := SoapHeaderDirection.Out)> _
<SoapDocumentMethodAttribute("https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer/CreateSubscription", 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("TrustedUserHeaderValue")> _
Public Function CreateSubscription ( _
    ItemPath As String, _
    ExtensionSettings As ExtensionSettings, _
    Description As String, _
    EventType As String, _
    MatchData As String, _
    Parameters As ParameterValue() _
) As String
'使用
Dim instance As ReportingService2010
Dim ItemPath As String
Dim ExtensionSettings As ExtensionSettings
Dim Description As String
Dim EventType As String
Dim MatchData As String
Dim Parameters As ParameterValue()
Dim returnValue As String

returnValue = instance.CreateSubscription(ItemPath, _
    ExtensionSettings, Description, _
    EventType, MatchData, Parameters)

[SoapHeaderAttribute("ServerInfoHeaderValue", Direction = SoapHeaderDirection.Out)]
[SoapDocumentMethodAttribute("https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer/CreateSubscription", 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("TrustedUserHeaderValue")]
public string CreateSubscription(
    string ItemPath,
    ExtensionSettings ExtensionSettings,
    string Description,
    string EventType,
    string MatchData,
    ParameterValue[] Parameters
)

[SoapHeaderAttribute(L"ServerInfoHeaderValue", Direction = SoapHeaderDirection::Out)]
[SoapDocumentMethodAttribute(L"https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer/CreateSubscription", RequestNamespace = L"https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer", 
    ResponseNamespace = L"https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer", 
    Use = SoapBindingUse::Literal, ParameterStyle = SoapParameterStyle::Wrapped)]
[SoapHeaderAttribute(L"TrustedUserHeaderValue")]
public:
String^ CreateSubscription(
    String^ ItemPath, 
    ExtensionSettings^ ExtensionSettings, 
    String^ Description, 
    String^ EventType, 
    String^ MatchData, 
    array<ParameterValue^>^ Parameters
)

[<SoapHeaderAttribute("ServerInfoHeaderValue", Direction = SoapHeaderDirection.Out)>]
[<SoapDocumentMethodAttribute("https://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer/CreateSubscription", 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("TrustedUserHeaderValue")>]
member CreateSubscription : 
        ItemPath:string * 
        ExtensionSettings:ExtensionSettings * 
        Description:string * 
        EventType:string * 
        MatchData:string * 
        Parameters:ParameterValue[] -> string

public function CreateSubscription(
    ItemPath : String, 
    ExtensionSettings : ExtensionSettings, 
    Description : String, 
    EventType : String, 
    MatchData : String, 
    Parameters : ParameterValue[]
) : String

パラメーター

ItemPath
型: System. . :: . .String
ファイル名と拡張子 (SharePoint モードの場合) を含む、アイテムの完全修飾 URL です。

ExtensionSettings
型: ReportService2010. . :: . .ExtensionSettings
配信拡張機能固有の設定の一覧を格納した ExtensionSettings オブジェクトです。

Description
型: System. . :: . .String
ユーザーに対して表示される説明文です。

EventType
型: System. . :: . .String
サブスクリプションを開始するイベントの種類です。有効な値は、TimedSubscription または SnapshotUpdated です。

MatchData
型: System. . :: . .String
指定した EventType パラメーターに関連付けられているデータです。このパラメーターは、サブスクリプションと発生したイベントの照合のために、イベントで使用されます。

Parameters
型: array<ReportService2010. . :: . .ParameterValue> [] () [] []
アイテムのパラメーターの一覧を表す ParameterValue オブジェクトの配列です。

戻り値

型: System. . :: . .String
レポートサーバーデータベースまたは SharePoint ライブラリのサブスクリプションを一意に識別するサブスクリプション ID です。

説明

次の表に、この操作に関連するヘッダーおよび権限の情報を示します。

SOAP ヘッダーの使用方法

(In) TrustedUserHeaderValue

(Out) ServerInfoHeaderValue

ネイティブモードで必要な権限

ExecuteAndView および (CreateAnySubscription または CreateSubscription)

SharePoint モードで必要な権限

ViewListItems()()()() および (ManageAlerts()()()() または CreateAlerts()()()())

GetExtensionSettings メソッドを使用すると、配信拡張機能に必須の設定の一覧を取得できます。これらの必須の設定の値は、ExtensionSettings パラメーターで渡す必要があります。電子メールの配信設定については、「Reporting Services 配信拡張機能の設定」を参照してください。

EventType パラメーターの値は、レポートサーバー用に構成されたイベントに対応する必要があります。サブスクリプションの作成に使用されるイベントは、TimedSubscription と SnapshotUpdated の 2 つです。レポートサーバー用に構成されたすべてのイベントの一覧を返すには、ListEvents メソッドを使用します。

MatchData パラメーターの値は、イベントの種類によって異なります。イベントが TimedSubscription イベントである場合は、MatchData パラメーターとして ScheduleDefinition オブジェクトが必要です。ScheduleDefinition オブジェクトを文字列値として渡し、スケジュールに基づくサブスクリプションを作成するには、まずこのオブジェクトを XML としてシリアル化する必要があります。XML 構造は、次の例のようになります。

<ScheduleDefinition>
   <WeeklyRecurrence>
      <StartDateTime>2004-06-24T09:00:00-08:00</StartDateTime>
      <WeeksInterval>1</WeeksInterval>
      <DaysOfWeek>
         <Monday>True</Monday>
         </DaysOfWeek>
   </WeeklyRecurrence>
</ScheduleDefinition>

StartDateTime 要素を XML 文字列として渡すときの値は、ISO 8601 の日付形式に対応する必要があります。この日付と時刻の表記に関する国際規格は拡張形式 CCYY-MM-DDThh:mm:ss+/-Z となっており、"CCYY" が年、"MM" が月、"DD" が日を表します。文字 "T" は日付と時刻の区切り記号を表し、"hh"、"mm"、"ss" はそれぞれ時、分、秒を表します。協定世界時 (UTC) を表す場合には、すぐ後ろに "Z" を付けます。ローカル時刻と協定世界時の差でタイムゾーンを示すには、"Z" の前に "+"記号か "-" 記号を付け、"Z" の後ろに UTC との差を hh:mm の形式で表します。

TimedSubscription のスケジュール定義が共有スケジュールである場合、共有スケジュールの ID を MatchData パラメーターとして渡す必要があります。スケジュール ID は、"4608ac1b-fc75-4149-9e15-5a8b5781b843" のように、String として渡されます。スケジュール ID は、ListSchedules メソッドを呼び出すことにより取得されます。

XmlSerializer クラスを使用して、オブジェクトクラスを XML 文字列に自動的に変換できます。

イベントが SnapshotUpdated サブスクリプションである場合、MatchData の値は NULL (Visual Basic では Nothing) である必要があります。

このメソッドを使用すると、サブスクリプションの LastExecutedSpecified プロパティが false に、サブスクリプションの Status プロパティが new subscription に、サブスクリプションの Active オブジェクトのすべてのプロパティが false に、それぞれ設定されます。また、レポートの ModifiedBy プロパティと ModifiedDate プロパティも更新されます。

MatchData パラメーターに指定されたすべてのスケジュールは、同じサイトおよび ItemPath に含まれている必要があります。

使用例

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;

        string report = "http://<Server Name>" +
            "/Docs/Documents/AdventureWorks Sample Reports" +
            "/Sales Order Detail.rdl";
        string desc = "Send to Document Library";
        string eventType = "TimedSubscription";
        string scheduleXml =
           @"<ScheduleDefinition>" +
            "   <StartDateTime>2003-02-24T09:00:00-08:00" +
            "   </StartDateTime>" +
            "   <WeeklyRecurrence>" +
            "      <WeeksInterval>1</WeeksInterval>" +
            "      <DaysOfWeek>" +
            "         <Monday>True</Monday>" +
            "      </DaysOfWeek>" +
            "   </WeeklyRecurrence>" +
            "</ScheduleDefinition>";

        ParameterValue[] extensionParams = new ParameterValue[6];

        extensionParams[0] = new ParameterValue();
        extensionParams[0].Name = "RENDER_FORMAT";
        extensionParams[0].Value = "EXCEL";

        extensionParams[1] = new ParameterValue();
        extensionParams[1].Name = "FILENAME";
        extensionParams[1].Value = "Sales Order Detail";

        extensionParams[2] = new ParameterValue();
        extensionParams[2].Name = "FILEEXTN";
        extensionParams[2].Value = "True";

        extensionParams[3] = new ParameterValue();
        extensionParams[3].Name = "PATH";
        extensionParams[3].Value = "http://<Server Name>" +
            "/Docs/Documents/AdventureWorks Sample Reports/";

        extensionParams[4] = new ParameterValue();
        extensionParams[4].Name = "WRITEMODE";
        extensionParams[4].Value = "Overwrite";

        extensionParams[5] = new ParameterValue();
        extensionParams[5].Name = "AUTOCOPY";
        extensionParams[5].Value = "False";

        string matchData = scheduleXml;
        ExtensionSettings extSettings = new ExtensionSettings();
        extSettings.ParameterValues = extensionParams;
        extSettings.Extension = "Report Server DocumentLibrary";

        try
        {
            rs.CreateSubscription(report, extSettings, desc, 
                eventType, matchData, null);
        }

        catch (SoapException e)
        {
            Console.WriteLine(e.Detail.InnerXml.ToString());
        }
    }
}

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 report As String = "http://<Server Name>/Docs/" + _
            "Documents/AdventureWorks Sample Reports/" + _
            "Sales Order Detail.rdl"
        Dim desc As String = "Send to Document Library"
        Dim eventType As String = "TimedSubscription"
        Dim scheduleXml As String = _
            "<ScheduleDefinition>" + _
            "   <StartDateTime>2003-02-24T09:00:00-08:00</StartDateTime>" + _
            "   <WeeklyRecurrence>" + _
            "      <WeeksInterval>1</WeeksInterval>" + _
            "      <DaysOfWeek>" + _
            "         <Monday>True</Monday>" + _
            "      </DaysOfWeek>" + _
            "   </WeeklyRecurrence>" + _
            "</ScheduleDefinition>"

        Dim extensionParams(6) As ParameterValue

        extensionParams(0) = New ParameterValue()
        extensionParams(0).Name = "RENDER_FORMAT"
        extensionParams(0).Value = "EXCEL"

        extensionParams(1) = New ParameterValue()
        extensionParams(1).Name = "FILENAME"
        extensionParams(1).Value = "Sales Order Detail"

        extensionParams(2) = New ParameterValue()
        extensionParams(2).Name = "FILEEXTN"
        extensionParams(2).Value = "True"

        extensionParams(3) = New ParameterValue()
        extensionParams(3).Name = "PATH"
        extensionParams(3).Value = "http://<Server Name>" + _
            "/Docs/Documents/AdventureWorks Sample Reports/"

        extensionParams(4) = New ParameterValue()
        extensionParams(4).Name = "WRITEMODE"
        extensionParams(4).Value = "Overwrite"

        extensionParams(5) = New ParameterValue()
        extensionParams(5).Name = "AUTOCOPY"
        extensionParams(5).Value = "False"

        Dim matchData As String = scheduleXml
        Dim extSettings As New ExtensionSettings()
        extSettings.ParameterValues = extensionParams
        extSettings.Extension = "Report Server DocumentLibrary"

        Try
            rs.CreateSubscription(report, extSettings, desc, _
                eventType, matchData, Nothing)
        Catch e As SoapException
            Console.WriteLine(e.Detail.InnerXml.ToString())
        End Try

    End Sub

End Class

次の方法で共有

CreateSubscription メソッド

構文

パラメーター

戻り値

説明

使用例

関連項目

参照

その他のリソース