Language

ReportingService2005.CreateSubscription メソッド

定義

名前空間:
ReportService2005
アセンブリ:
ReportService2005.dll

レポートサーバーデータベースで指定されたレポートのサブスクリプションを作成します。

public:
 System::String ^ CreateSubscription(System::String ^ Report, ReportService2005::ExtensionSettings ^ ExtensionSettings, System::String ^ Description, System::String ^ EventType, System::String ^ MatchData, cli::array <ReportService2005::ParameterValue ^> ^ Parameters);
public string CreateSubscription(string Report, ReportService2005.ExtensionSettings ExtensionSettings, string Description, string EventType, string MatchData, ReportService2005.ParameterValue[] Parameters);
member this.CreateSubscription : string * ReportService2005.ExtensionSettings * string * string * string * ReportService2005.ParameterValue[] -> string
Public Function CreateSubscription (Report As String, ExtensionSettings As ExtensionSettings, Description As String, EventType As String, MatchData As String, Parameters As ParameterValue()) As String

パラメーター

Report
String

サブスクリプションを作成するためのレポートのフルパス名。

ExtensionSettings
ExtensionSettings

デリバリー拡張機能に特有の設定リストを含む ExtensionSettings オブジェクトです。

Description
String

ユーザーに表示される意味のある説明。

EventType
String

サブスクリプションをトリガーするイベントの種類。 有効な値は、TimedSubscription または SnapshotUpdatedです。

MatchData
String

指定された EventType パラメータに関連付けられたデータ。 このパラメータはイベントがサブスクリプションと発生したイベントをマッチングするために使われます。

Parameters
ParameterValue[]

レポートのパラメータリストを含む ParameterValue オブジェクトの配列です。

返品

String

サブスクリプションIDは、レポートサーバーデータベース内でサブスクリプションを一意に識別します。

例

このコード例をコンパイルするには、Reporting Services WSDLを参照し、特定の名前空間をインポートする必要があります。 詳細については 、「コード例のコンパイルと実行」をご覧ください。 以下のコード例は、 CreateSubscription を使ってレポートサーバーデータベースに新しいサブスクリプションを追加しています。

Imports System  
Imports System.Web.Services.Protocols  

Class Sample  
   Public Shared Sub Main()  
      Dim rs As New ReportingService2005()  
      rs.Credentials = System.Net.CredentialCache.DefaultCredentials  

      Dim report As String = "/SampleReports/Employee Sales Summary"  
      Dim desc As String = "Send email to anyone@microsoft.com"  
      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(7) As ParameterValue  

      extensionParams(0) = New ParameterValue()  
      extensionParams(0).Name = "TO"  
      extensionParams(0).Value = "dank@adventure-works.com"  

      extensionParams(1) = New ParameterValue()  
      extensionParams(1).Name = "ReplyTo"  
      extensionParams(1).Value = "reporting@adventure-works.com"  

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

      extensionParams(3) = New ParameterValue()  
      extensionParams(3).Name = "RenderFormat"  
      extensionParams(3).Value = "MHTML"  

      extensionParams(4) = New ParameterValue()  
      extensionParams(4).Name = "Subject"  
      extensionParams(4).Value = "@ReportName was executed at @ExecutionTime"  

      extensionParams(5) = New ParameterValue()  
      extensionParams(5).Name = "Comment"  
      extensionParams(5).Value = "Here is your daily sales report for Michael."  

      extensionParams(6) = New ParameterValue()  
      extensionParams(6).Name = "IncludeLink"  
      extensionParams(6).Value = "True"  

      extensionParams(7) = New ParameterValue()  
      extensionParams(7).Name = "Priority"  
      extensionParams(7).Value = "NORMAL"  

      Dim parameter As New ParameterValue()  
      parameter.Name = "EmpID"  
      parameter.Value = "38"  

      Dim parameters(1) As ParameterValue  
      parameters(0) = parameter  

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

      Try  
         rs.CreateSubscription(report, extSettings, desc, eventType, matchData, parameters)  

      Catch e As SoapException  
         Console.WriteLine(e.Detail.InnerXml.ToString())  
      End Try  
   End Sub 'Main  
End Class 'Sample  

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

class Sample  
{  
   public static void Main()  
   {  
      ReportingService2005 rs = new ReportingService2005();  
      rs.Credentials = System.Net.CredentialCache.DefaultCredentials;  

      string report = "/SampleReports/Employee Sales Summary";  
      string desc = "Send email to anyone@microsoft.com";  
      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[8];  

      extensionParams[0] = new ParameterValue();  
      extensionParams[0].Name = "TO";  
      extensionParams[0].Value = "dank@adventure-works.com";  

      extensionParams[1] = new ParameterValue();  
      extensionParams[1].Name = "ReplyTo";  
      extensionParams[1].Value = "reporting@adventure-works.com";  

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

      extensionParams[3] = new ParameterValue();  
      extensionParams[3].Name = "RenderFormat";  
      extensionParams[3].Value = "MHTML";  

      extensionParams[4] = new ParameterValue();  
      extensionParams[4].Name = "Subject";  
      extensionParams[4].Value = "@ReportName was executed at @ExecutionTime";  

      extensionParams[5] = new ParameterValue();  
      extensionParams[5].Name = "Comment";  
      extensionParams[5].Value = "Here is your daily sales report for Michael.";  

      extensionParams[6] = new ParameterValue();  
      extensionParams[6].Name = "IncludeLink";  
      extensionParams[6].Value = "True";  

      extensionParams[7] = new ParameterValue();  
      extensionParams[7].Name = "Priority";  
      extensionParams[7].Value = "NORMAL";  

      ParameterValue parameter = new ParameterValue();  
      parameter.Name = "EmpID";  
      parameter.Value = "38";  

      ParameterValue[] parameters = new ParameterValue[1];  
      parameters[0] = parameter;  

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

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

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

注釈

以下の表は、この操作のヘッダーおよび権限情報を示しています。
SOAPヘッダー (イン) BatchHeaderValue

(アウト) ServerInfoHeaderValue
必要なアクセス許可 ExecuteAndView そして(CreateAnySubscription または CreateSubscription)

GetExtensionSettingsメソッドを使って、配送延長に必要な設定のリストを取得できます。 これらの必要な設定の値を ExtensionSettings パラメータに渡す必要があります。 メール配信設定の詳細については、「Reporting Services Delivery Extension Settings」をご覧ください。

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で、「CC」は世紀、「YY」は年、「MM」は月、「DD」は日を表します。 「T」は日付と時間の区切り符、「hh」「mm」「ss」はそれぞれ時、分、秒を表します。 この表現の直後に「Z」がついて調整ユニバーサル時(UTC)を示すことができます。 標準時を示すために、「Z」の前に「+」または「-」記号が付けられ、UTCとの差はhh:mmで表されます。

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

XmlSerializerクラスを使って、オブジェクトクラスを自動的にXML文字列に変換できます。 XmlSerializerクラスの詳細については、Microsoft .NET Frameworkドキュメントの「System.Xml.XmlSerializer Class」をご覧ください。

イベントがSnapshotUpdatedサブスクリプションの場合、MatchDataの値はnull(またはVisual BasicではNothing)されるべきです。

この方法を使うと、サブスクリプションの LastExecutedSpecified プロパティは false、サブスクリプションの Status プロパティは new subscriptionに、サブスクリプションの Active オブジェクトのすべてのプロパティは falseに設定されます。 報告書の ModifiedBy および ModifiedDate 特性も更新されています。

適用対象