ReportingService2010.SetDataDrivenSubscriptionProperties メソッド
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
データ ドリブン サブスクリプションのプロパティを設定します。
public:
void SetDataDrivenSubscriptionProperties(System::String ^ DataDrivenSubscriptionID, ReportService2010::ExtensionSettings ^ ExtensionSettings, ReportService2010::DataRetrievalPlan ^ DataRetrievalPlan, System::String ^ Description, System::String ^ EventType, System::String ^ MatchData, cli::array <ReportService2010::ParameterValueOrFieldReference ^> ^ Parameters);
[System.Web.Services.Protocols.SoapDocumentMethod("http://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer/SetDataDrivenSubscriptionProperties", ParameterStyle=System.Web.Services.Protocols.SoapParameterStyle.Wrapped, RequestNamespace="http://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer", ResponseNamespace="http://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer", Use=System.Web.Services.Description.SoapBindingUse.Literal)]
[System.Web.Services.Protocols.SoapHeader("TrustedUserHeaderValue")]
[System.Web.Services.Protocols.SoapHeader("ServerInfoHeaderValue", Direction=System.Web.Services.Protocols.SoapHeaderDirection.Out)]
public void SetDataDrivenSubscriptionProperties (string DataDrivenSubscriptionID, ReportService2010.ExtensionSettings ExtensionSettings, ReportService2010.DataRetrievalPlan DataRetrievalPlan, string Description, string EventType, string MatchData, ReportService2010.ParameterValueOrFieldReference[] Parameters);
[<System.Web.Services.Protocols.SoapDocumentMethod("http://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer/SetDataDrivenSubscriptionProperties", ParameterStyle=System.Web.Services.Protocols.SoapParameterStyle.Wrapped, RequestNamespace="http://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer", ResponseNamespace="http://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer", Use=System.Web.Services.Description.SoapBindingUse.Literal)>]
[<System.Web.Services.Protocols.SoapHeader("TrustedUserHeaderValue")>]
[<System.Web.Services.Protocols.SoapHeader("ServerInfoHeaderValue", Direction=System.Web.Services.Protocols.SoapHeaderDirection.Out)>]
member this.SetDataDrivenSubscriptionProperties : string * ReportService2010.ExtensionSettings * ReportService2010.DataRetrievalPlan * string * string * string * ReportService2010.ParameterValueOrFieldReference[] -> unit
Public Sub SetDataDrivenSubscriptionProperties (DataDrivenSubscriptionID As String, ExtensionSettings As ExtensionSettings, DataRetrievalPlan As DataRetrievalPlan, Description As String, EventType As String, MatchData As String, Parameters As ParameterValueOrFieldReference())
パラメーター
- DataDrivenSubscriptionID
- String
CreateDataDrivenSubscription(String, ExtensionSettings, DataRetrievalPlan, String, String, String, ParameterValueOrFieldReference[]) メソッドによって返されるサブスクリプションの ID です。
- ExtensionSettings
- ExtensionSettings
配信拡張機能固有の設定の一覧を格納した ExtensionSettings オブジェクトです。
- DataRetrievalPlan
- DataRetrievalPlan
サブスクリプションの配信クエリからデータを取得するために必要な設定の一覧を格納した DataRetrievalPlan オブジェクトです。
- Description
- String
ユーザーに対して表示される説明文です。
- EventType
- String
サブスクリプションを開始するイベントの種類です。 有効な値は または TimedSubscription
SnapshotUpdated
です。
- MatchData
- String
指定した種類のイベントに関連付けられているデータです。 このデータは、サブスクリプションと発生したイベントの照合のために、イベント処理拡張機能で使用されます。
- Parameters
- ParameterValueOrFieldReference[]
レポートのパラメーターの一覧を表す ParameterValue オブジェクトの配列です。
- 属性
注釈
次の表に、この操作に関連するヘッダーおよび権限の情報を示します。
SOAP ヘッダーの使用方法 | (In) TrustedUserHeaderValue (Out) ServerInfoHeaderValue |
ネイティブ モードで必要なアクセス許可 | UpdateAnySubscription |
SharePoint モードで必要なアクセス許可 | <xref:Microsoft.SharePoint.SPBasePermissions.ManageAlerts> |
データ ドリブン サブスクリプションを正しく実行するためには、DataRetrievalPlan オブジェクトが参照するデータ ソースの CredentialRetrieval プロパティを Store
に設定する必要があります。
Field に格納された DataSet オブジェクトは、配信拡張機能の設定とレポート パラメーター値にマップされるフィールドに対して確認されます。 配信拡張機能の設定やレポート パラメーター値で参照されるすべてのフィールドは、データセットでも列挙される必要があります。
データセットで列挙されるフィールドが配信クエリによって返されるかどうかを確認するための検証は行われません。 データセットで列挙されるフィールドが配信クエリによって返されない場合は、サブスクリプションの処理時にレポート サーバーでエラーが発生します。
EventType
パラメーターの値は、レポート サーバーで構成されたイベント処理拡張機能に対応する必要があります。 イベントがイベント処理拡張機能で処理されない場合、エラー コード rsInvalidEvent
の SOAP 例外がスローされます。 イベントは、通知を作成するイベント処理拡張機能で処理される必要があります。 EventType
パラメーターの値を受信すると、イベント処理拡張機能のクエリが実行され、通知を作成するかどうかが決まります。 通知を作成しない場合、エラー コード rsEventNonSubscribeable
の SOAP 例外がスローされます。
MatchData
パラメーターの値は、イベントの種類によって異なります。 イベントが TimedSubscription イベントの場合は、 ScheduleDefinition パラメーターとして MatchData
オブジェクトが必要です。 ScheduleDefinition オブジェクトを文字列値として渡し、スケジュールに基づくサブスクリプションを作成するには、まずこのオブジェクトを XML としてシリアル化する必要があります。 XML 構造は、次の例のようになります。
<ScheduleDefinition>
<WeeklyRecurrence>
<StartDateTime>2003-02-24T09:00:00-08:00</StartDateTime>
<WeeksInterval>1</WeeksInterval>
<DaysOfWeek>
<Monday>True</Monday>
</DaysOfWeek>
</WeeklyRecurrence>
</ScheduleDefinition>
XML 文字列として渡されたときの StartDateTime 要素の値は、日付形式 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 クラスの詳細については、「System.Xml」を参照してください。Microsoft .NET Framework ドキュメントの XmlSerializer クラス」を参照してください。
イベントがスナップショット更新サブスクリプションである場合、MatchData
パラメーターの値は null
(Visual Basic では Nothing
) である必要があります。