Gerenciamento do Suporte a Gateway

Teste a conexão

O suporte ao Conector Personalizado está disponível nos modos Pessoal e Standard do gateway de dados local. Ambos os modos de gateway dão suporte a Importar. A Consulta Direta só tem suporte no modo Standard. Atualmente, o OAuth para conectores personalizados por meio de gateways tem suporte apenas para administradores de gateway, mas não para outros usuários da fonte de dados.

O método para implementar a funcionalidade TestConnection provavelmente será alterado enquanto a funcionalidade do Conector de Dados Personalizados do Power BI estiver em versão prévia.

Para dar suporte à atualização agendada por meio do gateway de dados local, seu conector deve implementar um manipulador TestConnection. A função é chamada quando o usuário está configurando credenciais para sua origem e usada para garantir que elas sejam válidas. O manipulador TestConnection é definido no registro tipo fonte de dados e tem a seguinte assinatura:

(dataSourcePath) as list => ...

Onde dataSourcePath está o valor do Caminho da Fonte de Dados para sua função e o valor retornado é uma lista composta de:

• O nome da função a ser chamada (essa função deve ser marcada como #shared, e geralmente é sua função de fonte de dados primária).
• Um ou mais argumentos a serem passados para sua função.

Se a invocação da função resultar em um erro, TestConnection será considerado com falha e a credencial não será mantida.

Exemplo: conector sem argumentos necessários

O trecho de código abaixo implementa o TestConnection para uma fonte de dados sem parâmetros necessários (como aquele encontrado no tutorial TripPin). Conectores sem parâmetros necessários (conhecidos como 'Singletons') não precisam de nenhuma entrada fornecida pelo usuário para testar uma conexão (além de credenciais). Nesse caso, o dataSourcePath valor seria igual ao nome do Tipo de Fonte de Dados e pode ser ignorado. A TripPin.Contents função é invocada sem parâmetros adicionais.

TripPin = [
    TestConnection = (dataSourcePath) => { "TripPin.Contents" },
    Authentication = [
        Anonymous = []
    ],
    Label = "TripPin"
];

Exemplo: conector com um parâmetro de URL

Se a função de fonte de dados tiver um único parâmetro necessário do tipo Uri.Type, ela dataSourcePath será igual à URL fornecida pelo usuário. O trecho de código a seguir mostra a implementação TestConnection do Exemplo do Github.

GithubSample = [
    TestConnection = (dataSourcePath) => {"GithubSample.Contents", dataSourcePath},
    Authentication = [
        OAuth = [
            StartLogin = StartLogin,
            FinishLogin = FinishLogin,
            Label = Extension.LoadString("AuthenticationLabel")
        ]
    ]
];

Exemplo: conector com parâmetros necessários

Se a função de fonte de dados tiver vários parâmetros ou um único parâmetro não URL, o dataSourcePath valor será uma cadeia de caracteres JSON que contém os parâmetros. O snippet a seguir vem do exemplo DirectQueryForSQL .

DirectSQL = [
    TestConnection = (dataSourcePath) =>
        let
            json = Json.Document(dataSourcePath),
            server = json[server],
            database = json[database]
        in
            { "DirectSQL.Database", server, database },
    Authentication = [
        Windows = [],
        UsernamePassword = []
    ],
    Label = "Direct Query for SQL"
];