应用扩展程序

完成扩展程序的开发、部署与注册后,您需要通过测试、审批、上线流程后,除了扩展程序责任人之外的其他管理员可在管理中心启用该扩展程序。本文为您介绍如何测试并上线使用扩展程序。

背景信息

扩展程序注册完成后,需通过测试与审核后,才可以正式上线。上线成功后的扩展程序,可供各空间管理员或租户级管理员在管理中心中启用。

image

前提条件

开放平台侧

开放平台管理员租户管理员可通过以下步骤完成扩展程序的测试、审核与上线操作。

步骤一:进入开放平台扩展页

在开放平台扩展页面可查看已注册完成的扩展程序。

  1. 进入开放平台页面。

    登录DataWorks控制台,切换至目标地域后,单击左侧导航栏的更多 > 开放平台,进入开放平台的开发者后台页面。

  2. 查看扩展程序详情。

    在开发者后台页面中单击扩展程序,进入扩展程序页面。找到目标需要发布上线的扩展程序,单击操作列的详情,即可查看该扩展程序配置的详情信息。

步骤二:测试扩展程序

扩展程序注册完成后,将默认处于测试状态,此状态下,扩展程序无需进行上线操作,便可在以下特定场景中生效以便您测试扩展程序。

  • 租户级扩展事件

    扩展程序负责人可前往管理中心启用扩展程序,该扩展程序仅支持当前扩展程序负责人操作,详情请参见步骤二:启用扩展程序

    例如:一个测试中状态、用于处理数据下载卡点校验的扩展程序,当扩展程序负责人在管理中心启用后,扩展程序负责人执行数据下载操作将触发扩展程序卡点直至扩展程序返回校验结果。

  • 空间级扩展事件

    若扩展点事件为空间级扩展点事件,则会在您注册扩展程序时指定的工作空间内生效。查看指定的扩展程序测试空间,详情可参见查看扩展程序详情

请针对扩展程序处理的事件类型,在扩展程序上线前,可在测试空间启用扩展程序,测试DataWorks发送消息、扩展程序接收消息以及进行消息审核与回调完整链路。

步骤三:上线扩展程序

当扩展程序测试无误后,请参考步骤一,前往开放平台扩展程序详情页面,单击扩展程序操作列的提交按钮,将扩展程序提交至DataWorks平台审核,待审核通过后,点击扩展程序操作列的上线按钮,上线扩展程序。

说明

提交扩展程序审核后,DataWorks平台将在T+3工作日内完成审核。若审核未通过,您可以将鼠标悬浮至审核未通过的告警提示图标查看未通过原因,根据提示整改扩展程序后重新提交审核。

步骤四:管理扩展程序状态

开放平台开发者后台 > 扩展程序的扩展程序列表的操作列,对扩展程序进行查看详情编辑提交、上线、禁用删除等操作。状态列则会向您展示扩展程序的不同状态:

  • 测试中:新注册的扩展程序默认为测试中,已上线的扩展程序下线后也会变为测试中的状态,测试中的扩展程序仅测试空间可使用。

  • 审核中:测试中的扩展程序点击提交后,将处于审核中的状态,经平台审批通过的扩展程序状态将变更为审核通过,审批通过后扩展程序才可以进行上线操作。若平台审批未通过,该扩展程序的状态将变更为审核未通过

  • 已上线:在扩展程序的操作列,单击上线后,扩展程序状态变为已上线,上线后,所有扩展程序适用的工作空间都可以使用扩展程序(空间管理员可在工作空间配置界面查看并启用该扩展程序)。

  • 已禁用:在扩展程序的操作列,单击禁用后,扩展程序状态变为已禁用,此时该扩展程序失效,启用此扩展程序的工作空间的触发事件流程直接通过,不会触发检查或阻断。

  • 已过期:当DataWorks企业版版本过期后,扩展程序状态会变更为已过期状态,此状态的扩展程序失效,与已禁用状态类似。

管理中心侧

空间管理员可在管理中心内的扩展程序页中开启所属空间的空间级扩展点事件的扩展程序,租户管理员可通过管理中心内的扩展程序页开启租户级扩展点事件的扩展程序。

步骤一:进入管理中心扩展程序页

  1. 进入管理中心页面。

    登录DataWorks控制台,切换至目标地域后,单击左侧导航栏的更多 > 管理中心,在下拉框中选择对应工作空间后单击进入管理中心

  2. 查看可启用的扩展程序。

    在管理中心单击左侧菜单内的扩展程序,进入扩展程序页面,该页面展示可启用的扩展程序。

步骤二:启用扩展程序

不同级别的扩展程序开启后,针对的卡点范围不同,具体如下:

  • 租户级扩程序阿里云主账号,拥有AliyunDataWorksFullAccess权限的子账号以及租户管理员可以开启。在扩展程序开启后,所有空间针对该扩展点的操作均会卡点,直至扩展程序返回校验结果。

  • 空间级扩程序空间管理员可以开启,开启空间级扩展程序需要指定扩展程序生效的空间范围后,才可以进行开启,开启后的空间下针对该扩展点的操作均会卡点,直至扩展程序返回校验结果。

说明
  • 若此处没有找到您需要的扩展程序,请前往开放平台 > 扩展程序页面查看该扩展程序是否已上线。

  • 若您扩展程序在配置时有配置选项配置,您可在管理中心 > 扩展程序操作列单击设置按钮进行配置。

具体模块侧

空间管理员租户管理员通过上述操作在空间或租户下开启扩展程序卡点校验的情况下,开发或运维等人员在空间或租户下对扩展点执行操作变更时,操作将被阻塞,直至扩展程序返回校验结果。具体拦截场景示例,您可参考如下文档。