ReportingService2005.SetDataDrivenSubscriptionProperties 方法
定義
重要
部分資訊涉及發行前產品,在發行之前可能會有大幅修改。 Microsoft 對此處提供的資訊,不做任何明確或隱含的瑕疵擔保。
設定資料驅動訂閱的屬性。
public:
void SetDataDrivenSubscriptionProperties(System::String ^ DataDrivenSubscriptionID, ReportService2005::ExtensionSettings ^ ExtensionSettings, ReportService2005::DataRetrievalPlan ^ DataRetrievalPlan, System::String ^ Description, System::String ^ EventType, System::String ^ MatchData, cli::array <ReportService2005::ParameterValueOrFieldReference ^> ^ Parameters);
public void SetDataDrivenSubscriptionProperties(string DataDrivenSubscriptionID, ReportService2005.ExtensionSettings ExtensionSettings, ReportService2005.DataRetrievalPlan DataRetrievalPlan, string Description, string EventType, string MatchData, ReportService2005.ParameterValueOrFieldReference[] Parameters);
member this.SetDataDrivenSubscriptionProperties : string * ReportService2005.ExtensionSettings * ReportService2005.DataRetrievalPlan * string * string * string * ReportService2005.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
訂閱的 ID,透過方法回傳 CreateDataDrivenSubscription(String, ExtensionSettings, DataRetrievalPlan, String, String, String, ParameterValueOrFieldReference[]) 。
- ExtensionSettings
- ExtensionSettings
一個 ExtensionSettings 包含特定於交付擴充功能的設定清單的物件。
- DataRetrievalPlan
- DataRetrievalPlan
一個 DataRetrievalPlan 包含一套設定清單的物件,這些設定是從訂閱的傳遞查詢中取得資料所需的。
- Description
- String
一個有意義的描述,會顯示給使用者。
- EventType
- String
觸發訂閱的事件類型。 有效值為 TimedSubscription 或 SnapshotUpdated。
- MatchData
- String
與指定事件類型相關的資料。 這些資料會被事件處理擴充功能用來將訂閱與已觸發事件匹配。
- Parameters
- ParameterValueOrFieldReference[]
一個包含報告參數清單的物件陣列 ParameterValue 。
備註
下表顯示此操作的標頭與權限資訊。
| SOAP 標頭 | (在) BatchHeaderValue (出局) ServerInfoHeaderValue |
| 必要權限 | UpdateAnySubscription |
為了讓資料驅動訂閱能正常運作,物件所參考的資料來源 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>
當 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 參數傳遞。 Schedule ID 會以 String,例如「4608ac1b-fc75-4149-9e15-5a8b5781b843」傳遞。 可透過呼叫該 ListSchedules 方法取得排程 ID。
你可以使用 XmlSerializer 類別自動將物件類別轉換成 XML 字串。 欲了解更多關於 XmlSerializer 類別的資訊,請參閱 Microsoft .NET Framework 文件中的「System.Xml.XmlSerializer 類別」。
如果事件是快照更新訂閱,參數值MatchData應該是null(Nothing在 Visual Basic 中)。