ROMA Connect接入自定义数据源

概述

ROMA Connect支持把自定义的连接器作为一个数据源，并用于数据集成任务。在使用自定义数据源前，您需要先接入数据源。

ROMA Connect提供了常见的数据源连接支持，如关系型数据库、消息队列、API、NoSQL、对象存储等，这些数据源可以直接在ROMA Connect中使用，您只需要接入数据源，创建并启动数据集成任务，就可以将您的源端数据集成到目标端。

如果ROMA Connect支持的数据源类型无法接入您使用的数据源，您可以自行开发一个数据源插件，用于实现对数据源的读写。同时，这个数据源插件以标准RESTful接口形式供ROMA Connect接入，最终实现ROMA Connect对数据源的读写。这个数据源插件称为连接器，这类通过连接器接入的数据源称为自定义数据源。

连接器可以直连数据源，是数据源与ROMA Connect的数据交换通道。ROMA Connect对数据源的读写请求，通过调用连接器开放标准的RESTful接口完成。

在完成连接器的开发和部署后，您需要在ROMA Connect上创建连接器，定义连接器的对接参数。

在ROMA Connect中创建连接器后，您需要发布一个连接器实例，实现ROMA Connect与已部署连接器的对接。ROMA Connect通过已发布的连接器实例接入自定义数据源，实现对数据源的读写。

前提条件

• 每个接入的数据源都要归属到某个集成应用下，在接入数据源前您需要有可用的集成应用，否则请提前创建集成应用。
• 已完成连接器的线下开发和部署，连接器与ROMA Connect的对接接口开发请参考连接器RESTful接口规范。

创建FDI连接器

1. 登录ROMA Connect控制台，在左侧导航栏选择“资产管理”。
2. 单击页面右上角的“创建连接器”。
3. 在创建连接器页面中填写连接器的相关配置信息。

   表1 连接器配置

   参数	配置说明
   连接器名称	填写连接器的名称，根据规划自定义。建议您按照一定的命名规则填写连接器名称，方便您快速识别和查找。
   类型	选择连接器操作数据的权限类型。 读写：连接器可对数据源进行读写操作。 读：连接器仅可对数据源进行读操作。 写：连接器仅可对数据源进行写操作。
   描述	填写连接器的描述信息。
   数据源定义	定义数据源的接入参数。在配置ROMA Connect接入该数据源时，需要配置此处定义的接入参数。ROMA Connect与连接器间交互的消息数据为JSON格式，参数以Key-Value形式传递。 单击“添加参数”，添加数据源的接入参数。 参数名称：参数在数据源接入配置界面的显示名称，仅用于识别参数，在实际数据集成任务中不产生作用。 参数键：数据源接入请求中传递的参数Key。 参数值类型：参数值在数据源接入配置界面的配置样式。 Text：字符输入框。 Select：下拉选择框。 Date：日期控件，可选择日期与时间。 Textarea：字符输入框，可换行。 校验规则：是否对输入的参数值进行校验。 无：不校验。 不允许有特殊字符：校验参数值是否有特殊字符，约定字符范围包含数字、字母、中划线、下划线。 默认值：参数值如果没有填写时，是否传递一个默认值，置空则表示不传递默认值。 是否必填：参数是否必须填写。
   读端参数定义	定义数据源的读端参数，在数据集成任务的源端选择该数据源时，需要配置此处定义的读端参数。ROMA Connect与连接器间交互的消息数据为JSON格式，参数以Key-Value形式传递。 单击“添加参数”，添加数据源的读端参数，具体的参数配置说明与“数据源定义”类似。
   写端参数定义	定义数据源的写端参数，在数据集成任务的目标端选择该数据源时，需要配置此处定义的写端参数。ROMA Connect与连接器间交互的消息数据为JSON格式，参数以Key-Value形式传递。 单击“添加参数”，添加数据源的写端参数，具体的参数配置说明与“数据源定义”类似。

   图1 连接器参数定义示例
   
4. 完成后单击“创建”，完成连接器的创建。

发布FDI连接器

1. 登录ROMA Connect控制台，在左侧导航栏选择“资产管理”。
2. 在资产管理页面的“连接器”页签下，单击连接器上的“发布”。
3. 在发布连接器弹窗中配置相关发布参数，完成后单击“确定”

   表2 连接器配置

   参数	配置说明
   连接器实例名称	填写连接器实例的名称，根据规划自定义。建议您按照一定的命名规则填写连接器实例名称，方便您快速识别和查找。
   连接地址	已部署连接器的访问地址。
   认证方式	选择访问连接器实例所使用的安全认证方式，为简单起见，此处选择“无”。 无：不对接入请求进行认证。 AppKey：使用AppKey和AppSecret进行接入认证。
   AppKey	填写用于连接器接入认证的AppKey，自定义。
   AppSecret	填写用于连接器接入认证的AppSecret，自定义。

   

   仅“编辑”状态的连接器可编辑，“发布”状态的连接器无法进行编辑。

接入自定义数据源

1. 登录ROMA Connect控制台，在左侧导航栏选择“资源管理”，在实例页面单击实例，进入实例控制台。
2. 在左侧的导航栏选择“数据源管理”，单击页面右上角的“接入数据源”。
3. 在接入数据源页面的“自定义数据源”页签下，选择要作为自定义数据源的连接器，然后单击“下一步”。
4. 在页面中配置数据源的连接信息。

   表3 数据源连接信息

   参数	配置说明
   数据源名称	填写数据源的名称，根据规划自定义。建议您按照一定的命名规则填写数据源名称，方便您快速识别和查找。
   编码格式	默认“utf-8”格式。
   集成应用	选择数据源所归属的集成应用。
   描述	填写数据源的描述信息。
   连接器实例	选择该连接器下已发布的连接器实例。
   其他配置参数	后续的其他配置参数，是基于您在创建连接器时所定义的数据源信息而定。 您可以在ROMA Connect控制台的“资产管理”页面中，在“连接器”页签下单击连接器名称，查看连接器的“数据源定义”信息。

   以接入一个读取邮件数据的自定义数据源为例，该自定义数据源的接入配置示例如下图所示。

   其中，email server、protocol、user和password参数为连接器中定义的数据源参数。

   图2 自定义数据源配置示例
   
5. 完成数据源接入配置后，单击“创建”，完成数据源的接入。