ReportingService2005.CreateDataDrivenSubscription Methode
Definition
Wichtig
Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.
Erstellt ein datengetriebenes Abonnement für einen bestimmten Bericht.
public:
System::String ^ CreateDataDrivenSubscription(System::String ^ Report, ReportService2005::ExtensionSettings ^ ExtensionSettings, ReportService2005::DataRetrievalPlan ^ DataRetrievalPlan, System::String ^ Description, System::String ^ EventType, System::String ^ MatchData, cli::array <ReportService2005::ParameterValueOrFieldReference ^> ^ Parameters);
public string CreateDataDrivenSubscription(string Report, ReportService2005.ExtensionSettings ExtensionSettings, ReportService2005.DataRetrievalPlan DataRetrievalPlan, string Description, string EventType, string MatchData, ReportService2005.ParameterValueOrFieldReference[] Parameters);
member this.CreateDataDrivenSubscription : string * ReportService2005.ExtensionSettings * ReportService2005.DataRetrievalPlan * string * string * string * ReportService2005.ParameterValueOrFieldReference[] -> string
Public Function CreateDataDrivenSubscription (Report As String, ExtensionSettings As ExtensionSettings, DataRetrievalPlan As DataRetrievalPlan, Description As String, EventType As String, MatchData As String, Parameters As ParameterValueOrFieldReference()) As String
Parameter
- Report
- String
Die vollständig qualifizierte URL des Berichts, für die ein datenbasiertes Abonnement erstellt werden soll.
- ExtensionSettings
- ExtensionSettings
Ein Objekt, das eine Liste von Einstellungen enthält, die spezifisch für die Liefererweiterung ExtensionSettings sind.
- DataRetrievalPlan
- DataRetrievalPlan
Ein Objekt, das Einstellungen DataRetrievalPlan bereitstellt, die erforderlich sind, um Daten aus einer Lieferanfrage abzurufen. Das Objekt DataRetrievalPlan enthält eine Referenz auf ein DataSetDefinition Objekt und ein DataSourceDefinitionOrReference Objekt.
- Description
- String
Eine aussagekräftige Beschreibung, die den Nutzern angezeigt wird.
- EventType
- String
Die Art von Ereignis, die das datengetriebene Abonnement auslöst. Die gültigen Werte sind TimedSubscription oder SnapshotUpdated.
- MatchData
- String
Die Daten, die mit dem angegebenen EventType Parameter verknüpft sind. Dieser Parameter wird von einem Ereignis verwendet, um das datengetriebene Abonnement mit einem ausgelösten Ereignis abzugleichen.
- Parameters
- ParameterValueOrFieldReference[]
Ein Array von ParameterValueOrFieldReference Objekten, das eine Liste von Parametern für den Bericht enthält.
Gibt zurück
Ein Wert, der String eine Abonnement-ID enthält und das datengetriebene Abonnement in der Berichtsdatenbank eindeutig identifiziert.
Beispiele
Um dieses Codebeispiel zu kompilieren, müssen Sie auf die Reporting Services WSDL zurückgreifen und bestimmte Namensräume importieren. Weitere Informationen finden Sie unter Beispiele für Kompilierung und Ausführung von Coden. Das folgende Codebeispiel wird verwendet CreateDataDrivenSubscription , um ein neues datengetriebenes Abonnement zur Berichtsdatenbank hinzuzufügen:
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 description As String = "My new data driven subscription"
' Set the extension setting as report server email.
Dim settings As New ExtensionSettings()
settings.Extension = "Report Server Email"
' Set the extension parameter values.
Dim extensionParams(7) As ParameterValueOrFieldReference
Dim [to] As New ParameterFieldReference() ' Data-driven.
[to].ParameterName = "TO"
[to].FieldAlias = "EmailAddress"
extensionParams(0) = [to]
Dim replyTo As New ParameterValue()
replyTo.Name = "ReplyTo"
replyTo.Value = "dank@adventure-works.com"
extensionParams(1) = replyTo
Dim includeReport As New ParameterValue()
includeReport.Name = "IncludeReport"
includeReport.Value = "False"
extensionParams(2) = includeReport
Dim renderFormat As New ParameterValue()
renderFormat.Name = "RenderFormat"
renderFormat.Value = "HTML4.0"
extensionParams(3) = renderFormat
Dim priority As New ParameterValue()
priority.Name = "Priority"
priority.Value = "NORMAL"
extensionParams(4) = priority
Dim subject As New ParameterValue()
subject.Name = "Subject"
subject.Value = "Your sales report"
extensionParams(5) = subject
Dim comment As New ParameterValue()
comment.Name = "Comment"
comment.Value = "Here is the link to your report."
extensionParams(6) = comment
Dim includeLink As New ParameterValue()
includeLink.Name = "IncludeLink"
includeLink.Value = "True"
extensionParams(7) = includeLink
settings.ParameterValues = extensionParams
' Create the data source for the delivery query.
Dim delivery As New DataSource()
delivery.Name = ""
Dim dataSourceDefinition As New DataSourceDefinition()
dataSourceDefinition.ConnectString = "data source=(local);initial catalog=Employee"
dataSourceDefinition.CredentialRetrieval = CredentialRetrievalEnum.Store
dataSourceDefinition.Enabled = True
dataSourceDefinition.EnabledSpecified = True
dataSourceDefinition.Extension = "SQL"
dataSourceDefinition.ImpersonateUserSpecified = False
dataSourceDefinition.UserName = "username"
dataSourceDefinition.Password = "runUnAtt1"
delivery.Item = dataSourceDefinition
' Create the fields list.
Dim fieldsList(1) As Field
fieldsList(0) = New Field()
fieldsList(0).Name = "EmailAddress"
fieldsList(0).Alias = "EmailAddress"
fieldsList(1) = New Field()
fieldsList(1).Name = "EmpID"
fieldsList(1).Alias = "EmpID"
' Create the data set for the delivery query.
Dim dataSetDefinition As New DataSetDefinition()
dataSetDefinition.AccentSensitivitySpecified = False
dataSetDefinition.CaseSensitivitySpecified = False
dataSetDefinition.KanatypeSensitivitySpecified = False
dataSetDefinition.WidthSensitivitySpecified = False
dataSetDefinition.Fields = fieldsList
Dim queryDefinition As New QueryDefinition()
queryDefinition.CommandText = "Select * from MailList"
queryDefinition.CommandType = "Text"
queryDefinition.Timeout = 45
queryDefinition.TimeoutSpecified = True
dataSetDefinition.Query = queryDefinition
Dim results As New DataSetDefinition()
Dim changed As Boolean
Dim paramNames as String() = Nothing
Try
results = rs.PrepareQuery(delivery, dataSetDefinition, changed, paramNames)
Catch e As SoapException
Console.WriteLine(e.Detail.InnerText.ToString())
End Try
Dim dataRetrieval As New DataRetrievalPlan()
dataRetrieval.DataSet = results
dataRetrieval.Item = dataSourceDefinition
' Set the event type and match data for the delivery.
Dim eventType As String = "TimedSubscription"
Dim matchData As String = "<ScheduleDefinition><StartDateTime>2003-04-14T19:15:00-07:00</StartDateTime><WeeklyRecurrence><WeeksInterval>1</WeeksInterval><DaysOfWeek><Monday>True</Monday><Tuesday>True</Tuesday><Wednesday>True</Wednesday><Thursday>True</Thursday><Friday>True</Friday></DaysOfWeek></WeeklyRecurrence></ScheduleDefinition>"
' Set the report parameter values.
Dim parameters(2) As ParameterValueOrFieldReference
Dim empID As New ParameterFieldReference() ' Data-driven.
empID.ParameterName = "EmpID"
empID.FieldAlias = "EmpID"
parameters(0) = empID
Dim reportYear As New ParameterValue()
reportYear.Name = "ReportYear"
reportYear.Value = "2004"
parameters(1) = reportYear
Dim reportMonth As New ParameterValue()
reportMonth.Name = "ReportMonth"
reportMonth.Value = "6" ' June
parameters(2) = reportMonth
Try
Dim subscriptionID As String = rs.CreateDataDrivenSubscription(report, settings, dataRetrieval, description, eventType, matchData, parameters)
Catch e As SoapException
Console.WriteLine(e.Detail.InnerText.ToString())
End Try
End Sub 'Main
End Class 'Sample
using System;
using System.Web.Services.Protocols;
class Sample
{
public static void Main()
{
ReportingService rs = new ReportingService2005();
rs.Credentials = System.Net.CredentialCache.DefaultCredentials;
string report = "/SampleReports/Employee Sales Summary";
string description = "My new data driven subscription";
// Set the extension setting as report server email.
ExtensionSettings settings = new ExtensionSettings();
settings.Extension = "Report Server Email";
// Set the extension parameter values.
ParameterValueOrFieldReference[] extensionParams =
new ParameterValueOrFieldReference[8];
ParameterFieldReference to = new ParameterFieldReference(); // Data-driven.
to.ParameterName = "TO";
to.FieldAlias = "EmailAddress";
extensionParams[0] = to;
ParameterValue replyTo = new ParameterValue();
replyTo.Name = "ReplyTo";
replyTo.Value ="dank@adventure-works.com";
extensionParams[1] = replyTo;
ParameterValue includeReport = new ParameterValue();
includeReport.Name = "IncludeReport";
includeReport.Value = "False";
extensionParams[2] = includeReport;
ParameterValue renderFormat = new ParameterValue();
renderFormat.Name = "RenderFormat";
renderFormat.Value = "HTML4.0";
extensionParams[3] = renderFormat;
ParameterValue priority = new ParameterValue();
priority.Name = "Priority";
priority.Value = "NORMAL";
extensionParams[4] = priority;
ParameterValue subject = new ParameterValue();
subject.Name = "Subject";
subject.Value = "Your sales report";
extensionParams[5] = subject;
ParameterValue comment = new ParameterValue();
comment.Name = "Comment";
comment.Value = "Here is the link to your report.";
extensionParams[6] = comment;
ParameterValue includeLink = new ParameterValue();
includeLink.Name = "IncludeLink";
includeLink.Value = "True";
extensionParams[7] = includeLink;
settings.ParameterValues = extensionParams;
// Create the data source for the delivery query.
DataSource delivery = new DataSource();
delivery.Name = "";
DataSourceDefinition dataSourceDefinition = new DataSourceDefinition();
dataSourceDefinition.ConnectString = "data source=(local);initial catalog=Employee";
dataSourceDefinition.CredentialRetrieval = CredentialRetrievalEnum.Store;
dataSourceDefinition.Enabled = true;
dataSourceDefinition.EnabledSpecified = true;
dataSourceDefinition.Extension = "SQL";
dataSourceDefinition.ImpersonateUserSpecified = false;
dataSourceDefinition.UserName = "username";
dataSourceDefinition.Password = "runUnAtt1";
delivery.Item = dataSourceDefinition;
// Create the fields list.
Field[] fieldsList = new Field[2];
fieldsList[0] = new Field();
fieldsList[0].Name = "EmailAddress";
fieldsList[0].Alias = "EmailAddress";
fieldsList[1] = new Field();
fieldsList[1].Name = "EmpID";
fieldsList[1].Alias = "EmpID";
// Create the data set for the delivery query.
DataSetDefinition dataSetDefinition = new DataSetDefinition();
dataSetDefinition.AccentSensitivitySpecified = false;
dataSetDefinition.CaseSensitivitySpecified = false;
dataSetDefinition.KanatypeSensitivitySpecified = false;
dataSetDefinition.WidthSensitivitySpecified = false;
dataSetDefinition.Fields = fieldsList;
QueryDefinition queryDefinition = new QueryDefinition();
queryDefinition.CommandText = "Select * from MailList";
queryDefinition.CommandType = "Text";
queryDefinition.Timeout = 45;
queryDefinition.TimeoutSpecified = true;
dataSetDefinition.Query = queryDefinition;
DataSetDefinition results = new DataSetDefinition();
bool changed;
string[] paramNames;
try
{
results = rs.PrepareQuery(delivery, dataSetDefinition, out changed, out paramNames);
}
catch (SoapException e)
{
Console.WriteLine(e.Detail.InnerText.ToString());
}
DataRetrievalPlan dataRetrieval = new DataRetrievalPlan();
dataRetrieval.DataSet = results;
dataRetrieval.Item = dataSourceDefinition;
// Set the event type and match data for the delivery.
string eventType = "TimedSubscription";
string matchData = "<ScheduleDefinition><StartDateTime>2003-04-14T19:15:00-07:00</StartDateTime><WeeklyRecurrence><WeeksInterval>1</WeeksInterval><DaysOfWeek><Monday>True</Monday><Tuesday>True</Tuesday><Wednesday>True</Wednesday><Thursday>True</Thursday><Friday>True</Friday></DaysOfWeek></WeeklyRecurrence></ScheduleDefinition>";
// Set the report parameter values.
ParameterValueOrFieldReference[] parameters = new ParameterValueOrFieldReference[3];
ParameterFieldReference empID = new ParameterFieldReference(); // Data-driven.
empID.ParameterName = "EmpID";
empID.FieldAlias = "EmpID";
parameters[0] = empID;
ParameterValue reportYear = new ParameterValue();
reportYear.Name = "ReportYear";
reportYear.Value = "2004";
parameters[1] = reportYear;
ParameterValue reportMonth = new ParameterValue();
reportMonth.Name = "ReportMonth";
reportMonth.Value = "6"; // June
parameters[2] = reportMonth;
try
{
string subscriptionID = rs.CreateDataDrivenSubscription(
report, settings, dataRetrieval, description, eventType, matchData, parameters);
}
catch (SoapException e)
{
Console.WriteLine(e.Detail.InnerText.ToString());
}
}
}
Hinweise
Die untenstehende Tabelle zeigt Header- und Berechtigungsinformationen zu dieser Operation.
| SOAP-Überschriften | (In) BatchHeaderValue (Aus) ServerInfoHeaderValue |
| Erforderliche Berechtigungen | ExecuteAndView UND CreateAnySubscription |
Die Länge des Parameters Report darf 260 Zeichen nicht überschreiten; andernfalls wird eine SOAP-Ausnahme mit dem Fehlercode rsItemLengthExceeds ausgelöst.
Der Parameter Report kann weder null noch leer sein oder die folgenden reservierten Zeichen enthalten: : ? ; @ & = + $ , \ * > < | . ". Du kannst das Forward-Schrägstrichzeichen (/) verwenden, um Elemente im vollständigen Pfadnamen des Ordners zu trennen, aber am Ende des Ordnernamens kannst du es nicht verwenden.
Sie können die Methode GetExtensionSettings nutzen, um eine Liste der erforderlichen Einstellungen für eine Liefererweiterung abzurufen. Sie müssen Werte für diese erforderlichen Einstellungen im Parameter ExtensionSettings übergeben. Informationen zu E-Mail-Zustelleinstellungen finden Sie unter Reporting Services Delivery Extension Settings.
Der Parameter DataRetrievalPlan nimmt ein DataRetrievalPlan Objekt als Argument. Das Objekt DataRetrievalPlan enthält einen Datensatz mit einer Lieferanfrage. Die Eigenschaft CommandType der Lieferanfrage (QueryDefinition Objekt) ist standardmäßig für Text datengetriebene Abonnements gesetzt und muss nicht angegeben werden. Wenn Sie einen Wert für die Eigenschaft CommandType angeben, muss der Wert sein Text.
Die im Datensatz für die Lieferanfrage bereitgestellte oder referenzierte Datenquelle muss eine CredentialRetrieval Einstellung von Storehaben.
Werte für Liefererweiterungseinstellungen und -parameter können entweder auf statische Werte oder auf Feldreferenzen gesetzt werden. Wenn eine Feldreferenz für die Einstellung der Liefererweiterung oder eines Parameters angegeben wird, ist der Wert der Einstellung oder des Parameters datengesteuert. Der Datensatz mit der Lieferanfrage enthält eine Reihe von Feldern (Field Objekten), die auf Liefererweiterungseinstellungen (ExtensionParameter Objekte) und Berichtsparameterwerte (ParameterValue Objekte) abgebildet sind. Alle in den Liefererweiterungseinstellungen und Berichtsparameterwerten referenzierten Felder müssen den Feldern im Datensatz entsprechen. Wenn die Lieferanfrage kein Feld zurückgibt, das in einer Liefererweiterung festgelegt ist, oder keinen Parameterwert, erzeugt der Berichtsserver einen Fehler, wenn das Abonnement verarbeitet wird.
Der Wert des Parameters EventType muss einem Ereignis entsprechen, das für den Berichtsserver konfiguriert ist. Die beiden Ereignisse, die zur Erstellung von Abonnements verwendet werden, sind TimedSubscription und SnapshotUpdated. Verwenden Sie die Methode ListEvents , um eine Liste aller für den Berichtsserver konfigurierten Ereignisse zurückzugeben.
Der Wert des Parameters MatchData hängt vom Ereignistyp ab. Wenn das Ereignis ein Ereignis TimedSubscription ist, wird ein ScheduleDefinition Objekt als Parameter MatchData benötigt. Sie müssen das ScheduleDefinition Objekt zunächst als XML serialisieren, um es als String-Wert zu übergeben und ein Abonnement basierend auf dem Zeitplan zu erstellen. Die XML-Struktur könnte der im folgenden Beispiel ähneln:
<ScheduleDefinition>
<WeeklyRecurrence>
<StartDateTime>2003-02-24T09:00:00-08:00</StartDateTime>
<WeeksInterval>1</WeeksInterval>
<DaysOfWeek>
<Monday>True</Monday>
</DaysOfWeek>
</WeeklyRecurrence>
</ScheduleDefinition>
Der Wert des StartDateTime Elements, wenn es als XML-String übergeben wird, sollte dem Datumsformat ISO 8601 entsprechen. Dieser internationale Datums- und Uhrzeitstandard ist das erweiterte Format CCYY-MM-DDThh:mm:ss+/-Z, wobei "CC" das Jahrhundert, "YY" das Jahr, "MM" den Monat und "DD" den Tag darstellt. Der Buchstabe "T" ist der Trenner von Datum und Uhrzeit, und "hh", "mm", "ss" stehen jeweils für Stunde, Minute und Sekunde. Diese Darstellung kann unmittelbar von einem "Z" gefolgt werden, um die koordinierte Universalzeit (UTC) anzuzeigen. Um die Zeitzone anzuzeigen, dargestellt als Differenz zwischen der Ortszeit und der koordinierten Universalzeit, wird "Z" von einem "+" oder "-" Zeichen vorangestellt, gefolgt von der Differenz von UTC, die als hh:mm dargestellt wird.
Wenn die Zeitplandefinition für einen TimedSubscription geteilten Zeitplan ist, müssen Sie die Planungs-ID des gemeinsamen Zeitplans als Parameter MatchData übergeben. Die Schedule-ID wird beispielsweise als String"4608ac1b-fc75-4149-9e15-5a8b5781b843" weitergegeben. Die Zeitplan-ID kann durch Aufruf der Methode ListSchedules erhalten werden.
Du kannst die Klasse XmlSerializer verwenden, um deine Objektklasse automatisch in eine XML-Zeichenkette umzuwandeln. Weitere Informationen zur Klasse XmlSerializer finden Sie unter "System.Xml.XmlSerializer Class" in der Microsoft .NET Framework-Dokumentation.
Wenn das Ereignis ein SnapshotUpdated Abonnement ist, sollte der Wert von MatchData sein null (oder Nothing in Visual Basic).
Mit diesem Verfahren setzt die LastExecutedSpecified Eigenschaft des Abonnements auf none, die Status Eigenschaft des Abonnements auf new subscription, und alle Eigenschaften des Objekts Active des Abonnements auf false. Auch die Eigenschaften ModifiedBy des ModifiedDate Berichts werden aktualisiert.