ReportingService2005.SetDataDrivenSubscriptionProperties(String, ExtensionSettings, DataRetrievalPlan, String, String, String, ParameterValueOrFieldReference[]) Método
Definição
Importante
Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.
Define as propriedades de uma assinatura controlada por dados.
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())
Parâmetros
- DataDrivenSubscriptionID
- String
A ID da assinatura retornada pelo método CreateDataDrivenSubscription(String, ExtensionSettings, DataRetrievalPlan, String, String, String, ParameterValueOrFieldReference[]).
- ExtensionSettings
- ExtensionSettings
Um objeto ExtensionSettings que contém uma lista de configurações específicas à extensão de entrega.
- DataRetrievalPlan
- DataRetrievalPlan
Um objeto DataRetrievalPlan que contém uma lista de configurações necessárias para recuperar dados da consulta de entrega da assinatura.
- Description
- String
Uma descrição significativa exibida aos usuários.
- EventType
- String
O tipo de evento que dispara a assinatura. Os valores válidos são TimedSubscription
ou SnapshotUpdated
.
- MatchData
- String
Os dados associados ao tipo de evento especificado. Esses dados são usados por um evento que está processando a extensão para corresponder a assinatura com um evento acionado.
- Parameters
- ParameterValueOrFieldReference[]
Uma matriz de objetos ParameterValue que contém uma lista de parâmetros para o relatório.
Comentários
A tabela a seguir mostra o cabeçalho e as informações de permissão sobre esta operação.
Cabeçalhos SOAP | (In) BatchHeaderValue (Out) ServerInfoHeaderValue |
Permissões necessárias | UpdateAnySubscription |
Para que a assinatura controlada por dados seja executada corretamente, a fonte de dados à qual o DataRetrievalPlan objeto faz referência deve ter uma CredentialRetrieval propriedade definida como Store
.
Os Field objetos contidos no DataSet são verificados em relação aos campos que são mapeados para as configurações de extensão de entrega e valores de parâmetro de relatório. Todos os campos que são referenciados em configurações de extensão de entrega e valores de parâmetro de relatório também devem ser enumerados no conjunto de relatórios.
Nenhuma validação é executada para garantir que os campos enumerados no conjunto de conjuntos sejam retornados pela consulta de entrega. Se um campo enumerado no conjunto de um não for retornado pela consulta de entrega, o servidor de relatório gerará um erro quando a assinatura for processada.
O valor do EventType
parâmetro deve corresponder a uma extensão de processamento de eventos configurada no servidor de relatório. Se um evento não for tratado por uma extensão de processamento de eventos, uma exceção SOAP será lançada com o código de erro rsInvalidEvent
. O evento deve ser tratado por uma extensão de processamento de eventos que cria notificações. Quando um valor para o EventType
parâmetro é recebido, a extensão de processamento de eventos é consultada para determinar se ele cria notificações. Se não tiver, uma exceção SOAP será lançada com o código de erro rsEventNonSubscribeable
.
O valor do MatchData
parâmetro depende do tipo de evento. Se o evento for um evento TimedSubscription , um ScheduleDefinition objeto será necessário como o MatchData
parâmetro. Primeiro, você deve serializar o ScheduleDefinition objeto como XML para passá-lo como um valor de cadeia de caracteres e criar uma assinatura com base na agenda. A estrutura XML pode ser parecida com a do exemplo a seguir:
<ScheduleDefinition>
<WeeklyRecurrence>
<StartDateTime>2003-02-24T09:00:00-08:00</StartDateTime>
<WeeksInterval>1</WeeksInterval>
<DaysOfWeek>
<Monday>True</Monday>
</DaysOfWeek>
</WeeklyRecurrence>
</ScheduleDefinition>
O valor do elemento StartDateTime quando passado como uma cadeia de caracteres XML deve corresponder ao formato de data ISO 8601. Esse padrão de data e hora internacional é o formato estendido formato CCAA-MM-DDThh: mm: SS +/-Z em que "CC" representa o século, "YY" o ano, "MM" o mês e "DD" no dia. A letra "T" é o separador de data e hora e "HH", "mm", "SS" representam a hora, minuto e segundo, respectivamente. Essa representação pode ser seguida imediatamente por um "Z" para indicar o tempo universal coordenado (UTC). Para indicar o fuso horário, representado como a diferença entre a hora local e o tempo universal coordenado, "Z" é precedido por um sinal "+" ou "-", seguido pela diferença do UTC representado como hh: mm.
Se a definição da agenda de um TimedSubscription for uma agenda compartilhada, você deverá passar a ID da agenda compartilhada como o MatchData
parâmetro. A ID da agenda é passada como um String
, por exemplo, "4608ac1b-fc75-4149-9e15-5a8b5781b843". A ID da agenda pode ser obtida chamando o ListSchedules método.
Você pode usar a classe XmlSerializer para converter automaticamente sua classe de objeto em uma cadeia de caracteres XML. Para obter mais informações sobre a classe XmlSerializer , consulte "System.Xml.Xmlclasse do serializador" na documentação do Microsoft .NET Framework.
Se o evento for uma assinatura de atualização de instantâneo, o valor do MatchData
parâmetro deverá ser null
( Nothing
em Visual Basic).