TripPin parte 9 - TestConnection
Este tutorial com várias partes aborda a criação de uma nova extensão de fonte de dados para o Power Query. O tutorial deve ser feito sequencialmente — cada lição se baseia no conector criado nas lições anteriores, adicionando incrementalmente novos recursos ao seu conector.
Nesta lição, você:
- Adicionar um manipulador TestConnection
- Configurar o gateway de dados local (modo pessoal)
- Testar a atualização agendada através do serviço do Power BI
O suporte ao conector personalizado foi adicionado à versão de abril de 2018 do gateway de dados pessoal local. Essa nova funcionalidade (visualização) permite a atualização agendada de relatórios que usam seu conector personalizado.
Este tutorial aborda o processo de habilitação do conector para atualização e fornece um passo a passo rápido das etapas para configurar o gateway. Especificamente, você:
- Adicione um manipulador TestConnection ao seu conector.
- Instale o Gateway de Dados local no modo Pessoal.
- Habilite o suporte ao Conector Personalizado no Gateway.
- Publique uma pasta de trabalho que use seu conector para PowerBI.com.
- Configure a atualização agendada para testar o conector.
Vá para Handling Gateway Support para obter mais informações sobre o manipulador TestConnection.
Fundo
Há três pré-requisitos para configurar uma fonte de dados para atualização agendada usando PowerBI.com:
- A fonte de dados é suportada: isso significa que o ambiente do gateway de destino está ciente de todas as funções contidas na consulta que você deseja atualizar.
- As credenciais são fornecidas: para apresentar a caixa de diálogo de entrada de credenciais correta, o Power BI precisa conhecer o mecanismo de autenticação de suporte para uma determinada fonte de dados.
- As credenciais são válidas: depois que o usuário fornece credenciais, elas são validadas chamando o manipulador da fonte de
TestConnection
dados.
Os dois primeiros itens são tratados registrando seu conector com o gateway. Quando o usuário tenta configurar a atualização agendada no PowerBI.com, as informações de consulta são enviadas ao seu gateway pessoal para determinar se alguma fonte de dados que não é reconhecida pelo serviço do Power BI (ou seja, as personalizadas que você criou) está disponível lá. O terceiro item é manipulado invocando o manipulador TestConnection definido para sua fonte de dados.
Adicionando um manipulador TestConnection
O manipulador TestConnection é adicionado ao registro de declaração Data Source Kind (o mesmo local em que você declara seus tipos de autenticação suportados).
O manipulador é um function
com um único parâmetro do tipo any
, que retorna um list
arquivo .
O primeiro valor na lista é a função que será chamada para realmente testar a conexão. Isso geralmente é o mesmo que sua função de fonte de dados principal.
Em alguns casos, você pode precisar expor uma função separada shared
para fornecer um teste de conexão eficiente, no entanto, isso geralmente deve ser evitado.
Como a função de fonte de dados TripPin não tem argumentos necessários, a implementação para TestConnection é bastante simples:
// Data Source Kind description
TripPin = [
// TestConnection is required to enable the connector through the Gateway
TestConnection = (dataSourcePath) => { "TripPin.Contents" },
Authentication = [
Anonymous = []
],
Label = "TripPin Part 9 - TestConnection"
];
Nota
Pode validar a implementação de TestConnection no SDK do Power Query utilizando o comando para a função Executar TestConnection.
Habilitando conectores personalizados no gateway pessoal
Baixe e instale o gateway de dados local. Ao executar o instalador, selecione o modo pessoal.
Após a conclusão da instalação, inicie o gateway e entre no Power BI. O processo de entrada registrará automaticamente seu gateway com os serviços do Power BI. Depois de entrar, execute as seguintes etapas:
- Selecione a guia Conectores .
- Selecione a opção para habilitar o suporte para conectores de dados personalizados.
- Selecione o diretório a partir do qual deseja carregar conectores personalizados. Normalmente, esse será o mesmo diretório que você usaria para o Power BI Desktop, mas o valor é configurável.
- A página agora deve listar todos os arquivos de extensão em seu diretório de destino.
Vá para a documentação on-line para obter mais informações sobre o gateway.
Testando a atualização agendada
Abra o Power BI Desktop e crie um relatório que importe dados usando o conector TripPin.
Adicione um ou mais elementos visuais à sua página de relatório (opcional) e, em seguida, publique o relatório no PowerBI.com.
Depois de publicar, vá para PowerBI.com e encontre o modelo semântico do relatório publicado. Selecione as reticências e, em seguida, selecione Agendar atualização. Expanda as seções Conexão de gateway e Credenciais da fonte de dados.
Nota
Se a página de configuração do modelo semântico indicar que o relatório contém fontes de dados desconhecidas, o gateway/conector personalizado pode não estar configurado corretamente. Vá para a interface do usuário de configuração do gateway pessoal e verifique se não há erros ao lado do conector TripPin. Talvez seja necessário reiniciar o gateway (na guia Configurações do Serviço) para obter a configuração mais recente.
Selecione o link Editar credenciais para abrir a caixa de diálogo de autenticação e, em seguida, selecione entrar.
Nota
Se você receber um erro semelhante ao abaixo ("Falha ao atualizar as credenciais da fonte de dados"), provavelmente terá um problema com o manipulador TestConnection.
Após uma chamada bem-sucedida para TestConnection, as credenciais serão aceitas. Agora você pode agendar a atualização ou selecionar a elipse do modelo semântico e, em seguida, selecionar Atualizar agora. Você pode selecionar o link Histórico de atualizações para exibir o status da atualização (que geralmente leva alguns minutos para ser iniciada).
Conclusão
Parabéns! Agora você tem um conector personalizado pronto para produção que oferece suporte à atualização automatizada por meio do serviço do Power BI.