ReportingService2010.CreateSubscription 方法
定義
重要
部分資訊涉及發行前產品,在發行之前可能會有大幅修改。 Microsoft 對此處提供的資訊,不做任何明確或隱含的瑕疵擔保。
在報告伺服器資料庫或 SharePoint 文件庫 中建立指定項目的訂閱。 此方法適用於 Report 物品類型。
public:
System::String ^ CreateSubscription(System::String ^ ItemPath, ReportService2010::ExtensionSettings ^ ExtensionSettings, System::String ^ Description, System::String ^ EventType, System::String ^ MatchData, cli::array <ReportService2010::ParameterValue ^> ^ Parameters);
[System.Web.Services.Protocols.SoapDocumentMethod("http://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer/CreateSubscription", 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("ServerInfoHeaderValue", Direction=System.Web.Services.Protocols.SoapHeaderDirection.Out)]
[System.Web.Services.Protocols.SoapHeader("TrustedUserHeaderValue")]
public string CreateSubscription(string ItemPath, ReportService2010.ExtensionSettings ExtensionSettings, string Description, string EventType, string MatchData, ReportService2010.ParameterValue[] Parameters);
[<System.Web.Services.Protocols.SoapDocumentMethod("http://schemas.microsoft.com/sqlserver/reporting/2010/03/01/ReportServer/CreateSubscription", 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("ServerInfoHeaderValue", Direction=System.Web.Services.Protocols.SoapHeaderDirection.Out)>]
[<System.Web.Services.Protocols.SoapHeader("TrustedUserHeaderValue")>]
member this.CreateSubscription : string * ReportService2010.ExtensionSettings * string * string * string * ReportService2010.ParameterValue[] -> string
Public Function CreateSubscription (ItemPath As String, ExtensionSettings As ExtensionSettings, Description As String, EventType As String, MatchData As String, Parameters As ParameterValue()) As String
參數
- ItemPath
- String
項目的完整限定網址,包括檔名,以及在 SharePoint 模式下的副檔名。
- ExtensionSettings
- ExtensionSettings
一個 ExtensionSettings 包含特定於交付擴充功能的設定清單的物件。
- Description
- String
一個有意義的描述,會顯示給使用者。
- EventType
- String
觸發訂閱的事件類型。 有效值為 TimedSubscription 或 SnapshotUpdated。
- MatchData
- String
與指定 EventType 參數相關聯的資料。 這個參數被事件用來將訂閱與已觸發的事件匹配。
- Parameters
- ParameterValue[]
一個包含該項目參數清單的物件陣列 ParameterValue 。
傳回
一個訂閱 ID,唯一識別該訂閱在報表伺服器資料庫或 SharePoint 文件庫 中。
- 屬性
範例
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
備註
下表顯示此操作的標頭與權限資訊。
| SOAP 標頭的使用 | (在) TrustedUserHeaderValue (出局) ServerInfoHeaderValue |
| 原生模式所需權限 | ExecuteAndView 且 (CreateAnySubscription 或 CreateSubscription) |
| SharePoint 模式 必要權限 | <xref:Microsoft.SharePoint.SPBasePermissions.ViewListItems> 且 (<xref:Microsoft.SharePoint.SPBasePermissions.ManageAlerts> 或 <xref:Microsoft.SharePoint.SPBasePermissions.CreateAlerts>) |
你可以用這個 GetExtensionSettings 方法取得交付擴充所需的設定清單。 你必須在參數 ExtensionSettings 中傳遞這些必要設定的值。 有關電子郵件投遞設定的資訊,請參閱 Reporting Services Delivery 擴充設定。
參數的 EventType 值必須對應於為報告伺服器設定的事件。 用於建立訂閱的兩個事件為 TimedSubscription 和 SnapshotUpdated。 使用該 ListEvents 方法回傳為報告伺服器所設定的所有事件清單。
參數的 MatchData 值取決於事件類型。 若事件為 TimedSubscription 事件,則需物件 ScheduleDefinition 作為 MatchData 參數。 你必須先將物件序列化 ScheduleDefinition 為 XML,然後以字串值傳遞,並根據排程建立訂閱。 XML 結構可能類似以下範例中的結構:
<ScheduleDefinition>
<WeeklyRecurrence>
<StartDateTime>2004-06-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,其中「CC」代表世紀,「YY」代表年份,「MM」代表月份,「DD」代表日。 字母「T」代表日期與時間分隔符,「hh」、「mm」、「ss」分別代表時、分鐘和秒。 此表示法後面可緊接「Z」表示協調世界時(UTC)。 為了表示時區,以當地時間與協調世界時的差值表示,「Z」前會加上「+」或「-」符號,接著是與UTC的差值,表示為hh:mm。
如果 a TimedSubscription 的排程定義是共享排程,你必須將共享排程的排程 ID 作為 MatchData 參數傳遞。 Schedule ID 會以 String,例如「4608ac1b-fc75-4149-9e15-5a8b5781b843」傳遞。 可透過呼叫該 ListSchedules 方法取得排程 ID。
你可以用這個 System.Xml.Serialization.XmlSerializer 類別自動將物件類別轉換成 XML 字串。
如果活動是訂閱制SnapshotUpdated,的MatchData值應該是null(或Nothing在 Visual Basic 中)。
使用此方法時,會將認購的性質設LastExecutedSpecified為 false,Statusnew subscription認購的 屬性 ,以及認購物件false的所有性質 Active。
ModifiedBy
ModifiedDate報告的性質也已更新。
參數中指定的 MatchData 任何排程必須在同一站點且 ItemPath。