ReportingService2005.SetDataDrivenSubscriptionProperties メソッド

データ ドリブン サブスクリプションのプロパティを設定します。

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

構文

'宣言
Public Sub SetDataDrivenSubscriptionProperties ( _
    DataDrivenSubscriptionID As String, _
    ExtensionSettings As ExtensionSettings, _
    DataRetrievalPlan As DataRetrievalPlan, _
    Description As String, _
    EventType As String, _
    MatchData As String, _
    Parameters As ParameterValueOrFieldReference() _
)
'使用
Dim instance As ReportingService2005 
Dim DataDrivenSubscriptionID As String 
Dim ExtensionSettings As ExtensionSettings 
Dim DataRetrievalPlan As DataRetrievalPlan 
Dim Description As String 
Dim EventType As String 
Dim MatchData As String 
Dim Parameters As ParameterValueOrFieldReference()

instance.SetDataDrivenSubscriptionProperties(DataDrivenSubscriptionID, _
    ExtensionSettings, DataRetrievalPlan, _
    Description, EventType, MatchData, _
    Parameters)

public void SetDataDrivenSubscriptionProperties(
    string DataDrivenSubscriptionID,
    ExtensionSettings ExtensionSettings,
    DataRetrievalPlan DataRetrievalPlan,
    string Description,
    string EventType,
    string MatchData,
    ParameterValueOrFieldReference[] Parameters
)

public:
void SetDataDrivenSubscriptionProperties(
    String^ DataDrivenSubscriptionID, 
    ExtensionSettings^ ExtensionSettings, 
    DataRetrievalPlan^ DataRetrievalPlan, 
    String^ Description, 
    String^ EventType, 
    String^ MatchData, 
    array<ParameterValueOrFieldReference^>^ Parameters
)

member SetDataDrivenSubscriptionProperties : 
        DataDrivenSubscriptionID:string * 
        ExtensionSettings:ExtensionSettings * 
        DataRetrievalPlan:DataRetrievalPlan * 
        Description:string * 
        EventType:string * 
        MatchData:string * 
        Parameters:ParameterValueOrFieldReference[] -> unit

public function SetDataDrivenSubscriptionProperties(
    DataDrivenSubscriptionID : String, 
    ExtensionSettings : ExtensionSettings, 
    DataRetrievalPlan : DataRetrievalPlan, 
    Description : String, 
    EventType : String, 
    MatchData : String, 
    Parameters : ParameterValueOrFieldReference[]
)

パラメーター

• DataDrivenSubscriptionID
  型: System.String
  CreateDataDrivenSubscription メソッドによって返されるサブスクリプションの ID です。

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

• DataRetrievalPlan
  型: ReportService2005.DataRetrievalPlan
  サブスクリプションの配信クエリからデータを取得するために必要な設定の一覧を格納した DataRetrievalPlan オブジェクトです。

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

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

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

• Parameters
  型: array<ReportService2005.ParameterValueOrFieldReference[]
  レポートのパラメーターの一覧を表す ParameterValue オブジェクトの配列です。

説明

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

SOAP ヘッダー	(In) BatchHeaderValue (Out) ServerInfoHeaderValue
必要な権限	UpdateAnySubscription

データ ドリブン サブスクリプションを正しく実行するためには、DataRetrievalPlan オブジェクトが参照するデータ ソースの CredentialRetrieval プロパティに Store を設定する必要があります。

DataSet に格納された Field オブジェクトは、配信拡張機能の設定とレポート パラメーター値にマップされるフィールドに対して確認されます。 配信拡張機能の設定やレポート パラメーター値で参照されるすべてのフィールドは、データセットでも列挙される必要があります。

データセットで列挙されるフィールドが配信クエリによって返されるかどうかを確認するための検証は行われません。 データセットで列挙されるフィールドが配信クエリによって返されない場合は、サブスクリプションの処理時にレポート サーバーでエラーが発生します。

EventType パラメーターの値は、レポート サーバーで構成されたイベント処理拡張機能に対応する必要があります。 イベントがイベント処理拡張機能で処理されない場合、エラー コード rsInvalidEvent の SOAP 例外がスローされます。 イベントは、通知を作成するイベント処理拡張機能で処理される必要があります。 EventType パラメーターの値を受信すると、イベント処理拡張機能のクエリが実行され、通知を作成するかどうかが決まります。 通知を作成しない場合、エラー コード rsEventNonSubscribeable の SOAP 例外がスローされます。

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

<ScheduleDefinition>
   <WeeklyRecurrence>
      <StartDateTime>2003-02-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 文字列に自動的に変換できます。 XmlSerializer クラスの詳細については、Microsoft .NET Framework のドキュメントの「System.Xml.XmlSerializer クラス」を参照してください。

イベントがスナップショット更新サブスクリプションである場合、MatchData パラメーターの値は nullNULL 参照 (Visual Basic では Nothing) (Visual Basic では Nothing) である必要があります。

関連項目

参照

ReportingService2005 クラス

ReportService2005 名前空間