【接口服务】操作手册

接口服务

1.1.1功能概述

接口服务模块主要通过接口的方式，实现EAS Cloud和其他EAS Cloud或非EAS Cloud系统之间的数据集成以及基础资料同步，共包括四个三级菜单，涵盖的内容可分为三大部分：本地服务、通用配置、数据转换配置、执行与监控。

1.1.2 本地服务

1.1.2.1 接口服务

主要功能：

按不同的服务类型，定义相应的服务。

1、 从路径“接口服务->本地服务->接口服务”进入接口主界面，如下图所示：

该界面上主要字段的说明：

（1） 左树：可新增左树分组类别，也可以移动节点；

（2） 包含下级节点：包含所有分组类别的接口服务；

2、 点击新增按钮，弹出新增界面，如下图所示：

该界面上主要字段的说明：

（1） 编码：当前服务的编号，在新建时手工填写。

（2） 名称：当前服务的名称，在新建时手工填写。

（3） 服务类型：如为推送接口，服务类型可以选择新增、更新、删除。如为查询服务，服务类型默认为查询，且不可修改。如为抓取服务，服务类型为抓取，且不可修改。如为推送服务，服务类型为外送，且不可修改。

（4） EAS Cloud查询模板：选择数据转换模板。

（5） EAS Cloud数据模型：选择数据模型。

（6） 远程服务：服务类型为外发时需要选择远程服务。

（7） 返回值模板：选择数据转换模板。

（8） 接口服务状态：已使用、已启用、预置。

3、 保存后，对服务进行启用操作后，便于后台系统使用。

1.1.3 通用配置

1.1.3.1识别码管理

主要功能：

对数据集成的源及目标系统进行标识。

1、 从路径“接口服务->通用配置->识别码管理”双击进入识别码管理界面中，如下图所示：

该界面为列表形式，主要字段说明如下：

（1） 启用：新增识别码成功后，点击启用，便于系统识别；

（2） 禁用：选择禁用后，可以禁用识别码，禁用状态的识别码可以进行修改；

（3） 已使用：如系统调用了此识别码后，状态会显示已使用。已使用状态的识别码不可删除；

（4） 预置配置：系统会预置EAS_DEFAULT这个识别码，用于EAS Cloud内调用时使用：

2、 点击新增按钮，弹出识别码新增的界面，如下图所示：

该界面上重要字段说明：

（1） 编码：用户手动写入，为此识别码的编码，方便查询所用；

（2） 名称：用户手动输入；

（3） 密钥：系统自动生成，通过密钥进行数据的加密；

（4） 组织：可以按组织设定标识符，实现数据按组织的隔离；

3、 识别码创建好之后，启用。

1.1.3.2远程服务

主要功能：

配置对接系统提供的服务信息。

1、 从路径“接口服务->通用配置->远程服务”进入远程服务序时簿界面，如下图所示：

该界面上主要字段的说明：

（1） 左树：可新增左树分组类别，设置相应对接系统的编码、名称、服务类型、服务器地址、服务器端口、描述。界面如下：

（2） 包含下级节点：包含所有分组类别的远程服务；

（3） 服务测试：与对接系统的远程连接测试，失败时会有提示信息。

（4） 启用、禁用：对远程服务的启禁用操作。

2、 点击新增远程服务，弹出新增界面，举例如下：

该界面上的主要字段说明：

（1） 编码：手工输入，用于标识远程服务；

（2） 名称：手工输入，用于标识远程服务；

（3） 授权/登陆：复选框，标识远程服务是否涉及授权或登陆服务；

（4） 已使用：服务被调用过后会被标识已使用，已使用的远程服务不可删除；

（5） 已启用：用于标识远程服务是否已启用。

（6） 远程服务地址：从远程服务类别中自动带出来，无须输入。

（7） 远程服务方法：手工输入需要调用的方法；

（8） 服务实现类：提供给用户的自定义接口；

（9） 参考信息：备注字段；

（10） 分录体数据区域：选择头体区域，Head或Body；

（11） 分录体登陆返回值：复选框，针对登陆服务而言；

（12） 分录体转换模板：选择定义的转换模板；

（13） 分录体参数编码：手工输入参数编码；

（14） 分录体参数名称：手工输入参数名称；

（15） 分录体参数默认值：手工输入参数默认值；

（16） 分录体参数类型：选择STRING或INTEGER；

（17） 登陆服务：如涉及到登陆，需要选择相应接口服务；

1.1.4 数据转换配置

1.1.4.1数据模型

主要功能：

配置数据接收方对数据新增、查询和转换的规则。

1、 接口服务->数据转换配置->数据模型 路径进入数据模型主界面。如下图所示：

2、 点击新增，弹出数据模型新增界面，举例如下：

该界面上的主要字段说明：

（1） 编码：新建时用户自己手工输入编码；

（2） 名称：新建时用户自己手工输入名称，方便查询用，名称不可重复；

（3） 实现类类型：可选择元数据查询实体、元数据Façade、元数据实体、自定义实现类、查询语句；

（4） 实现类：由用户提供实现接口；

（5） 实现方法：由用户提供实现方法；

（6） 对应的实体：由用户指定相应实体；

（7） 存储原始数据：复选框，由用户勾选是否存储原始数据；

（8） 存储中间数据：复选框，由用户勾选是否存储中间数据；

（9） 预置：用以标识是否系统预置，不可填写；

（10） 备注：手工输入需要备注的信息；

（11） 分录体区域：可选择head、entry、subentry；

（12） 分录体唯一值：复选框，标识唯一性；

（13） 分录体必填：复选框，标识字段是否必填；

（14） 分录体源字段：手工输入需要映射转换的源字段；

（15） 分录体目标字段：手工输入需要映射转换的目标字段；

（16） 分录体源系统字段别名：手工输入需要映射转换的源字段别名；

（17） 分录体默认值：手工输入字段默认值；

（18） 分录体取数策略：默认值取数策略，可选择原值优先、默认值优先、原值空取默认值三种方式；

（19） 分录体基础资料类型映射：选择相应的基础类型映射方案；

（20） 分录体转换后取值字段：手工输入转换后，对应的字段；

（21） 分录体格式化：针对日期字段，对字段进行格式化；

（22） 分录体字段类型：选择字段对应的类型，共12种可选择；

（23） 分录体字段长度：手工输入；

（24） 分录体字段精度：手工输入；

（25） 分录体字段小数位数：手工输入；

3、 保存后，对数据模型进行发布操作，发布后系统进行相应调用，进行后续实现。

1.1.4.2数据转换模板

主要功能：

将源系统数据进行过滤及解析。

1、 从路径“接口服务->数据转换配置->数据转换模板”进入数据转换模板界面，如下图所示：

该界面上主要字段的说明：

（1） 左树：可新增左树分组类别，也可以移动节点；

（2） 包含下级节点：包含所有分组类别的接口服务；

2、 点击新增按钮，弹出新增界面，如下图所示：

该界面上的主要字段说明：

（1） 编码：新建时用户自己手工输入编码；

（2） 名称：新建时用户自己手工输入名称，方便查询用，名称不可重复；

（3） 描述：手工输入转换模板的说明；

（4） 数据转换模板：手工输入具体代码；

1.1.4.3 基础资料类型映射

主要功能：

配置源系统基础资料类型与目标数据库基础资料类型之间的对应关系，例如：币别－币别。

1、 从路径“接口服务->数据转换配置->基础资料类型映射”进入基础资料类型映射界面，如下图所示：

2、 点击新增按钮，弹出新增界面，如下图所示：

该该界面上的主要字段说明：

（1） 源系统数据库来源：选择数据来源类型，选择“数据库（jdbc）”或“本地文件”；

（2） 连接：选择一个在“数据库连接”功能中已经创建的连接，如源系统数据来源选择了“本地文件”，该项灰显；

（3）