Certificação do Power Query Connector

Artigo
01/18/2024

Nota

Este artigo descreve os requisitos e o processo para enviar um conector personalizado do Power Query para certificação. Leia atentamente o artigo na íntegra antes de iniciar o processo de certificação.

Introdução

Com o SDK do Power Query, todos têm poderes para criar um conector personalizado do Power Query para ligar a uma origem de dados a partir do Power Query. Atualmente, os conectores personalizados só têm suporte em modelos semânticos do Power BI (Power BI Desktop e serviço Power BI) e exigem o uso de um gateway de dados local para atualizar por meio do serviço do Power BI. Os conectores personalizados precisam ser distribuídos individualmente pelo desenvolvedor.

Os proprietários de fontes de dados que desenvolvem um conector personalizado para sua fonte de dados podem querer distribuir seu conector personalizado de forma mais ampla para os usuários do Power Query. Depois que um conector personalizado tiver sido criado, usado e validado pelos usuários finais, o proprietário da fonte de dados poderá enviá-lo para certificação Microsoft.

A certificação de um conector personalizado do Power Query torna o conector disponível publicamente, pronto para uso, em modelos semânticos do Power BI (Power BI Desktop e serviço Power BI), fluxos de dados do Power BI e datamarts do Power BI. Os conectores certificados são suportados no PowerBI.com e em todas as versões do Power BI Premium.

Os conectores certificados são:

Mantido pelo desenvolvedor parceiro
Suportado pelo desenvolvedor parceiro
Certificado pela Microsoft
Distribuído pela Microsoft

Trabalhamos com parceiros para tentar garantir que eles tenham suporte na manutenção, mas os problemas do cliente com o conector em si serão direcionados ao desenvolvedor parceiro.

Diferenças de conector certificado e conector personalizado

Os conectores certificados são incluídos imediatamente no Power BI Desktop e implantados no Serviço do Power BI, nos fluxos de dados do Power BI e nos datamarts do Power BI. Os conectores personalizados são suportados apenas em modelos semânticos do Power BI e precisam ser carregados no Power BI Desktop, conforme descrito em Carregando sua extensão no Power BI Desktop. Os conectores certificados e personalizados podem ser atualizados por meio do Power BI Desktop ou do Serviço do Power BI usando um gateway de dados local implementando um TestConnection. O gateway de dados local é necessário para conectores personalizados.

Os conectores certificados no Power BI Desktop com uma TestConnection implementação também oferecem suporte à atualização de ponta a ponta por meio da nuvem (Serviço do Power BI) sem a necessidade de um gateway de dados local. O ambiente de serviço do Power BI essencialmente hospeda um "gateway de nuvem" que é executado de forma semelhante ao gateway local. Após a certificação, implantamos seu conector nesse ambiente para que ele esteja disponível para todos os clientes do Power BI.

Os conectores personalizados e certificados com componentes extras (por exemplo, driver ODBC) precisam que o componente extra seja instalado na máquina do usuário final e exigem o gateway de dados local, a menos que o componente extra seja implantado na nuvem do Power BI. Atualmente, não estamos certificando e implantando novos componentes extras na nuvem do Power BI, portanto, a certificação de conectores com dependência de um componente extra não removerá o requisito de gateway de dados local.

Distribuição de conector personalizada

Os conectores personalizados podem e devem ser distribuídos aos usuários finais antes da certificação.

Como M é uma linguagem versátil que, como visto em Manipulando autenticação, tem a capacidade de interagir com credenciais armazenadas, precisamos dar aos usuários uma maneira de permitir que apenas conectores confiáveis sejam executados.

Do ponto de vista de um desenvolvedor, eles precisam autoassinar seu conector personalizado e fornecer aos usuários as informações (impressão digital) para carregá-lo com segurança.

Do ponto de vista do usuário, os usuários precisam usar a impressão digital do desenvolvedor para confiar e carregar com segurança o conector personalizado para uso. Como alternativa, os usuários podem optar por reduzir suas configurações de segurança para permitir o carregamento de código não certificado pela Microsoft ou outro desenvolvedor, mas essa opção não é recomendada.

Visão Geral da Certificação

Pré-requisitos

Para garantir a melhor experiência para nossos clientes, consideramos apenas conectores que atendam a um conjunto de pré-requisitos para certificação:

O conector deve ser para um produto público.
O conector deve ser considerado code-complete para uma versão de lançamento inicial. O programa permite iterações e atualizações frequentes. Observe que a Microsoft não oferece assistência técnica ou consultoria de desenvolvimento de conector personalizado. Recomendamos aproveitar recursos públicos, como nossa documentação do SDK e repositório de exemplos. Se você precisar de mais assistência, podemos compartilhar uma lista de consultores conhecidos de desenvolvimento de conectores personalizados do setor de 3ª parte que você pode querer contratar diretamente, separados de qualquer programa ou parceria da Microsoft. Observe que a Microsoft não é afiliada a nenhum desses consultores e não é responsável pelo uso dos serviços deles. A Microsoft fornece a lista para sua conveniência e sem quaisquer garantias, recomendações ou garantias. Entre em contato com seu contato de certificação da Microsoft para saber mais.
O desenvolvedor deve fornecer uma estimativa de uso. Sugerimos que os desenvolvedores de conectores para produtos muito boutique usem nossos recursos de autoassinatura de conectores para fornecê-los diretamente ao cliente.
O conector já deve estar disponível aos clientes diretamente para atender a uma necessidade do usuário ou cenário de negócios. Esses critérios podem ser atendidos usando um programa de visualização privada distribuindo o conector concluído diretamente para usuários finais e organizações por meio de autoassinatura. Cada usuário ou organização deve ser capaz de fornecer feedback e validação de que há uma necessidade comercial para o conector e que o conector está funcionando com êxito para atender aos seus requisitos de negócios.
O conector deve estar funcionando com êxito em um nível previsto de uso pelos clientes.
Deve haver um thread no fórum do Power BI Ideas orientado pelos clientes para indicar a demanda para tornar o conector disponível publicamente no Power BI Desktop. Não há um limite definido de engajamento. No entanto, quanto mais engajamento, mais forte será a demanda evidenciada pelo conector.

Esses pré-requisitos existem para garantir que os conectores que passam pela certificação tenham necessidades significativas de clientes e negócios para serem usados e suportados após a certificação.

Processo e Prazos

Os conectores certificados são lançados com versões mensais do Power BI Desktop, portanto, os prazos para cada versão funcionam de volta a partir de cada data de lançamento do Power BI Desktop. A duração esperada do processo de certificação, desde o registo até à libertação, varia em função da qualidade e complexidade da apresentação do conector. A Microsoft não fornece nenhuma garantia de cronograma específica em relação a qualquer revisão e aprovação do conector. Os prazos rígidos para cada revisão do conector são descritos nas etapas a seguir, mas a Microsoft não garante a adesão a esses prazos.

Registro: notificação de intenção de certificar seu conector personalizado. Esse registro deve ocorrer até o dia 15 do mês, dois meses antes da versão de desktop do Power BI de destino.
- Por exemplo, para a versão de abril do Power BI Desktop, o prazo seria 15 de fevereiro.
Submissão: envio de ficheiros de conector para revisão da Microsoft. Esse envio deve ocorrer até o dia 1º do mês anterior à versão de desktop do Power BI de destino.
- Por exemplo, para a versão de abril do Power BI Desktop, o prazo seria 1º de março.
Revisão técnica: finalização dos arquivos do conector, passando pela revisão e certificação da Microsoft. Essa revisão deve ocorrer até o dia 15 do mês anterior à versão de destino do Power BI Desktop.
- Por exemplo, para a versão de abril do Power BI Desktop, o prazo seria 15 de março.

Devido à complexidade das revisões técnicas e possíveis atrasos, rearquitetura e problemas de teste, é altamente recomendável enviar com antecedência e um longo prazo para a versão inicial e certificação. Se você acha que seu conector é importante para entregar a alguns clientes com sobrecarga mínima, recomendamos autoassinar e fornecê-lo dessa forma.

Requisitos de certificação

Temos um certo conjunto de requisitos para a certificação. Reconhecemos que nem todos os desenvolvedores podem atender a esses requisitos, e esperamos introduzir um conjunto de recursos que atenda às necessidades dos desenvolvedores em pouco tempo.

Arquivos de envio (artefatos)

Verifique se os arquivos do conector enviados incluem todos os seguintes:

Arquivo do conector (.mez)
- O arquivo .mez deve seguir padrões de estilo e ter um nome semelhante ao nome do produto ou serviço. Não deve incluir palavras como "Power BI", "Conector" ou "API".
- Nomeie o arquivo .mez: ProductName.mez
Arquivo do Power BI Desktop (.pbix) para teste
- Necessitamos de um exemplo de relatório do Power BI (.pbix) para testar o seu conector.
- O relatório deve incluir pelo menos uma consulta para testar cada item na tabela de navegação.
- Se não houver um esquema definido (por exemplo, bancos de dados), o relatório precisará incluir uma consulta para cada "tipo" de tabela que o conector pode manipular.
Testar a conta para sua fonte de dados
- Usamos a conta de teste para testar e solucionar problemas do seu conector.
- Forneça uma conta de teste que seja persistente, para que possamos usar a mesma conta para certificar quaisquer atualizações futuras.
Instruções de teste
- Forneça qualquer documentação sobre como usar o conector e testar sua funcionalidade.
Links para dependências externas (por exemplo, drivers ODBC)

Características e estilo

O conector deve seguir um conjunto de regras de recurso e estilo para atender a um padrão de usabilidade consistente com outros conectores certificados.

O conector DEVE:
- Use o formato de documento da seção.
- Conter um cabeçalho/adorno da versão acima do documento da seção.
- Forneça metadados de documentação da função.
- Tenha o manipulador TestConnection.
- Siga as convenções de nomenclatura (por exemplo, DataSourceKind.FunctionName). Não deve incluir palavras como "Power BI", "Conector" ou "API".
- Tenha o sinalizador Beta definido como True na versão inicial.
O FunctionName deve fazer sentido para o domínio (por exemplo, "Conteúdo", "Tabelas", "Documento", "Bancos de dados", e assim por diante).
O conector DEVE:
- Tem ícones.
- Forneça uma tabela de navegação.
- Coloque cadeias de caracteres em um resources.resx arquivo. URLs e valores devem ser codificados no código do conector e não devem ser colocados no resources.resx arquivo.

Segurança

Há considerações de segurança específicas que o conector deve lidar.

Se Extension.CurrentCredentials() for utilizado:
- O uso é obrigatório? Em caso afirmativo, para onde são enviadas as credenciais?
- É garantido que os pedidos sejam feitos através de HTTPS?
  - Você pode usar a função auxiliar de imposição HTTPS.
- Se as credenciais forem enviadas usando Web.Contents() via GET:
  - Pode ser transformado num POST?
  - Se GET for necessário, o conector DEVE usar o CredentialQueryString registro no Web.Contents() registro de opções para passar credenciais confidenciais.
Se as funções Diagnostics.* forem usadas:
- Validar o que está a ser rastreado; os dados não devem conter PII ou grandes quantidades de dados desnecessários.
- Se você implementou um rastreamento significativo no desenvolvimento, deverá implementar um sinalizador de variável ou recurso que determine se o rastreamento deve estar ativado. Esse rastreamento deve ser desativado antes do envio para certificação.
Se Expression.Evaluate() for utilizado:
- Valide de onde a expressão está vindo e o que ela é (ou seja, pode construir dinamicamente chamadas para Extension.CurrentCredentials() e assim por diante).
- O Expression não deve ser fornecido pelo usuário nem aceitar a entrada do usuário.
- O Expression não deve ser dinâmico (ou seja, recuperado de uma chamada web).

Registo para Certificação

Se você estiver interessado em obter a certificação de seu conector personalizado, certifique-se de que seu cenário e conector atendam aos pré-requisitos e requisitos descritos neste artigo. Não fazer isso causará atrasos na certificação, pois nossa equipe exigirá que você corrija quaisquer problemas ou inconsistências antes de avançar com a certificação.

Verifique se o conector está com código completo e foi testado tanto na criação no Power BI Desktop quanto na atualização e consumo no Serviço do Power BI. Certifique-se de ter testado a atualização completa de ponta a ponta no Serviço do Power BI por meio do uso de um gateway de dados local.

Para começar, preencha nosso formulário de registro e um contato da Microsoft entrará em contato para iniciar o processo.

Após a Certificação

Depois que seu conector for certificado e liberado por meio do Power BI Desktop e do serviço Power BI, há algumas coisas que você deve fazer para garantir que possa usar corretamente o conector certificado publicamente disponível implantado em produção.

Você e os usuários finais devem usar a versão do conector certificado incluída no Power BI Desktop e o gateway de dados local e remover todos os arquivos .mez ou .pqx existentes (conectores personalizados) usados antes da certificação. Se não o fizer, poderá resultar na utilização inadvertida do conector personalizado de teste pelo Power Query em vez do conector recém-certificado.
Conectores personalizados só devem ser usados para testar novas versões do conector.
Ao trabalhar com usuários finais e clientes, certifique-se de que eles entendam que a versão do conector personalizado usada nos testes antes da certificação deve ser removida depois que o teste for concluído e a nova versão do conector certificado estiver disponível.

Aplicativos de modelo (recomendado)

Depois de desenvolver um conector para uma fonte de dados, considere ajudar os clientes a começar a trabalhar rapidamente criando um aplicativo modelo. Um aplicativo de modelo fornece aos clientes um relatório pré-criado conectado aos seus dados que eles podem usar prontos ou personalizar conforme necessário.