TripPin 第 9 部分 - TestConnection

此多部分教程介绍如何为 Power Query 创建新的数据源扩展。 本教程旨在按顺序完成 — 每个课程都基于在上一课中创建的连接器上构建,以增量方式向连接器添加新功能。

在本课中,你将:

  • 添加 TestConnection 处理程序
  • 配置本地数据网关(个人模式)
  • 通过 Power BI 服务测试计划的刷新

自定义连接器支持已添加到 2018 年 4 月发布的 个人本地数据网关。 此新的(预览版)功能允许对使用自定义连接器的报告进行计划刷新。

本教程介绍启用连接器进行刷新的过程,并提供配置网关的步骤的快速演练。 具体而言,你:

  1. 将 TestConnection 处理程序添加到连接器。
  2. 在个人模式下安装本地数据网关。
  3. 在网关中启用自定义连接器支持。
  4. 发布一个使用您的连接器到 PowerBI.com 的工作簿。
  5. 配置定期刷新以测试连接器。

有关 TestConnection 处理程序的详细信息,请转到 处理网关支持

背景

使用 PowerBI.com 为计划刷新配置数据源有三个先决条件:

  • 支持数据源: 目标网关环境知道要刷新的查询中包含的所有函数。
  • 提供凭据: 若要显示正确的凭据输入对话框,Power BI 需要知道给定数据源的支持身份验证机制。
  • 凭据有效: 用户提供凭据后,通过调用数据源的 TestConnection 处理程序对其进行验证。

前两项是通过向网关注册连接器来处理的。 当用户尝试在 PowerBI.com 中配置计划刷新时,查询信息将被发送到您的个人网关,以确定是否存在任何 Power BI 服务中无法识别的数据源(即您创建的自定义数据源)并确保这些数据源在那里可用。 第三项通过调用为数据源定义的 TestConnection 处理程序来处理。

添加“TestConnection”处理程序

TestConnection 处理程序将添加到数据源类型声明记录(声明其支持的身份验证类型的位置相同)。 处理器是一个 function,具有一个类型为 any 的参数,并返回一个 list。 列表中的第一个值是调用以实际测试连接的函数。 此函数通常与主数据源函数相同。 在某些情况下,可能需要公开单独的 shared 函数以提供高效的连接测试,但通常应避免这样做。

由于 TripPin 数据源函数没有任何必需的参数,因此 TestConnection 的实现非常简单:

// 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"
];

注释

可以使用 Run TestConnection 函数的命令在 Power Query SDK 中验证 TestConnection 的实现。

在个人网关中启用自定义连接器

下载并安装 本地数据网关。 运行安装程序时,选择个人模式。

安装完成后,启动网关并登录到 Power BI。 登录过程会自动将你的网关注册到 Power BI 服务。 登录后,请执行以下步骤:

  1. 选择“ 连接器 ”选项卡。

  2. 选择该开关以启用对 自定义数据连接器的支持。

  3. 选择要从中加载自定义连接器的目录。 此选择通常与用于 Power BI Desktop 的目录相同,但该值是可配置的。

  4. 页面现在应列出目标目录中的所有扩展文件。

    显示网关连接器配置对话框的网关屏幕截图。

有关网关的详细信息,请访问在线文档

测试计划的刷新

打开 Power BI Desktop 并创建使用 TripPin 连接器导入数据的报表。

导航器的屏幕截图,其中显示了 TripPin 数据。

将一个或多个视觉对象添加到报表页(可选),然后将报表发布到 PowerBI.com。

发布后,转到 PowerBI.com 并查找已发布报表的语义模型。 选择省略号,然后选择“ 计划刷新”。 展开 网关连接数据源凭据 部分。

“TripPin 设置”对话框的屏幕截图,可在其中进行选择。

注释

如果语义模型配置页显示报表包含未知数据源,则可能无法正确配置网关/自定义连接器。 前往个人网关配置界面,并确保 TripPin 连接器旁边没有错误。 可能需要重启网关(在 “服务设置 ”选项卡上)以选取最新配置。

选择 “编辑凭据 ”链接以显示身份验证对话框,然后选择登录。

注释

如果收到类似于“无法更新数据源凭据”的错误,则很可能是 TestConnection 处理程序出现问题。

显示数据源凭据错误的“配置 TripPin”对话框的屏幕截图。

成功调用 TestConnection 后,将接受凭据。 现在可以计划刷新,或选择语义模型省略号,然后选择“ 立即刷新”。 可以选择 “刷新历史记录 ”链接以查看刷新状态(通常需要几分钟才能启动)。

TripPin 设置的屏幕截图,显示成功配置消息。

结论

祝贺! 现在,你已有一个生产就绪的自定义连接器,支持通过 Power BI 服务自动刷新。

后续步骤

TripPin 第 10 部分 - 查询折叠