本文为您介绍开发使用扩展程序前的准备工作。

使用限制

  • 仅DataWorks企业版及以上版本支持扩展程序功能。
    说明 如果使用的企业版DataWorks版本到期后,所有扩展程序均会失效,无法再触发事件检查。已触发且未到终态的检查会自动通过。
  • 扩展程序注册并开启后,多个扩展程序可关联同一个触发事件,即同一个事件支持触发多个扩展程序。
  • 有内部节点的组合类节点(机器学习(PAI)节点do-while节点for-each节点)触发检查时,需要内部节点都检查通过才可继续进行下一步操作。

准备工作1:开启消息订阅

扩展程序功能通常需要联合OpenEvent功能一起使用,通过OpenEvent来订阅扩展点事件,再通过扩展程序对事件进行处理,因此在开发使用扩展程序前,您需先开启消息订阅,获取消息订阅的EventBridge信息、订阅事件的消息体格式,用于后续扩展程序的代码开发。

准备工作2:注册扩展程序

开发使用扩展程序前,您需要先在DataWorks上注册好一个扩展程序获取对应的Extension Code,用于后续的扩展程序代码开发,操作步骤如下。

  1. 登录DataWorks控制台并进入扩展程序页面。
    1. 以阿里云主账号或拥有AliyunDataWorksFullAccess权限的RAM用户登录DataWorks控制台
    2. 在左侧导航栏选择开放平台,在开发者后台页面选择扩展程序页签,进入扩展程序页面。
      扩展程序页面
  2. 单击注册扩展程序,在弹窗中配置填的注册信息。
    说明 准备工作阶段,您仅需配置必填的注册信息,待后续扩展程序开发调试完成,部署后可再进一步完善扩展程序的其他信息。
    注册扩展程序其中,准备工作阶段必填的参数有扩展程序名称、处理的扩展点、负责人和测试用工作空间,其他参数可在扩展程序开发部署完成后进一步完善。详细的参数解释如下。
    参数如何配置
    扩展程序名称自定义扩展程序的名称,用于标识扩展程序。
    处理的扩展点选择该扩展程序用于处理哪几类扩展事件触发的消息。当前支持的扩展点及其详情请参见支持的扩展点事件列表,您可根据实际情况选择。
    说明 选择完成后,配置界面会自动根据选择结果匹配所属事件适用模块,无需手动配置。
    负责人选择扩展程序的负责人,方便扩展程序使用者遇到问题时能及时联系到负责人。
    测试用工作空间指定用于扩展程序测试用的工作空间。

    扩展程序无需进行上线操作,即可在测试用工作空间中生效。

    即开发人员可以在上线前,在测试空间中进行完整链路的测试验证,通过触发事件,来测试DataWorks通过EventBridge发送消息、扩展程序接收消息并进行消息审核与回调。

    扩展程序详情地址填写介绍扩展程序详情的地址,用于帮助扩展程序的用户更好的理解和使用此扩展程序。

    您可以在开发部署扩展程序时,同时开发一个扩展程序的详情展示页面,完成后把页面地址配置在此处,以便使用者在触发扩展程序校验时,可通过此链接查看扩展程序完整的校验过程,例如,此次扩展程序检查链路和阻塞的原因。

    扩展程序文档地址填写扩展程序的帮助文档地址,供扩展程序的使用者阅读。

    您可以在开发部署扩展程序时,同时开发一个扩展程序的帮助文档页面,完成后把页面地址配置在此处,以便使用者学习了解扩展程序的校验逻辑与属性。

    扩展程序参数配置DataWorks支持在扩展程序开发过程中使用参数来提高扩展程序开发和应用效率,并为您提供了典型应用场景的内置参数供您直接使用,您也可以自定义参数,在扩展程序代码开发时,将需要应用的参数添加到此处即可。

    支持添加多个参数,一行一个参数,参数格式为key=value格式。更多参数的使用详情和要求请参见高级应用:扩展程序参数配置

    扩展程序选项配置扩展程序开发者可通过该选项定义可供扩展程序使用者使用的功能配置项,扩展程序选项配置可实现该扩展程序选项,在不同工作空间进行个性化管控。扩展程序开发者需要在此界面通过JSON字符串定义选项。例如:您可以通过选项配置让扩展程序使用者自行管控sql长度。JSON格式可参考文档:高级应用:扩展程序选项配置
  3. 单击确定,完成扩展程序注册。
    此时您可以在扩展程序页面查看到扩展程序的Extension Code。extension code

后续步骤

完成准备工作后,您即已获取开发扩展程序所需的EventBridge信息、事件消息体格式、Extension Code等必要信息,后续可开展扩展程序代码开发及部署工作,详情请参见开发部署扩展程序