变更记录
产品版本 | 更新内容 | 更新日期 |
V5.0.023 | 初始版本 | 2023年06月30日 |
V6.0.4
| 增加迁入迁出功能 文本类型的最大字段长度从1000变为2000
| 2023年12月27日 |
V6.0.8 | 增加接口字段 外部数据模型字段增加禁用 字段类型增加整数类型
| 2024年3月31日 |
V6.0.14
| 1.描述字段扩展至255字段
| 2024年6月30日 |
1 简介
1.1 功能介绍
注:外部数据接入功能只是为异构系统生成凭证时,提供灵活定义中间表结构和接口报文结构的能力。产品上虽然支持已导入数据的查询,但此功能是用于监控导入状态/查看报错信息的。因此它不提供单据的功能,例如手动的增、删、改、多维度筛选、审批、打印、接入附件、影像集成、业务流程处理等。如果需要这类能力,仍然需要通过单据集成来实现。
外部数据模型(原事件模型菜单)是一种用于定义数据结构的,可视化配置工具。通过配置数据模型,可以同时完成:数据接口的报文结构定义、数据存储结构定义(接口表)。系统集成时通过预设的模型完成外部业务数据的导入。
1.2 应用场景
外部数据模型主要用于接入其他厂商的单据信息到星瀚系统,将接入的数据进行结构化存储;支持根据模型配置凭证模板,生成总账凭证。
1.3 系统路径
【财务云】→【会计事件库】→【外部数据接入】→【外部数据模型】
注意事项:用户实际使用的菜单与产品出厂菜单可能不同,若因路径不同导致无法找到最终菜单,可通过页面右上角的搜索栏搜索菜单。
1.4 关键字段/按钮说明
模型基本信息字段说明
字段名称 | 详细解释 |
编码 | 指外部数据模型的编码,需要以英文字母开头,且由字母、数字和下划线组成。编码需要保持在模型编码、分组编码及字段编码中都不重复 |
名称 | 指外部数据模型的名称 |
创建人 | 创建外部数据模型的用户,新建模型时自动带出值 |
版本号 | 用于记录外部数据模型的版本。当模型修改后再次发布,且上一次发布的模型有外部数据导入记录,则会自动转到下一个版本(系统自动计算版本号) |
分组 | 用户指定外部数据模型的分组,分组可在外部数据模型列表新增 |
单据模板 | 用于快速新增字段,可以引入标准单据上字段。选择了单据模板后,可通过数据字段定义右侧的<批量增加>按钮,批量新增所选单据上的字段 |
数据字段分组字段说明
字段名称 | 详细解释 |
系统字段 | 系统预置的必传字段,除了<显示>属性外,其余系统字段设置均不能修改,也不允许新增、删除系统字段 |
数据头字段分组 | 用于设置外部数据的头字段,支持设置多个头面板信息(只支持一层级),设置头字段需要先在【数据头分组】定义具体的数据头面板 |
数据分录分组 | 用于设置外部数据的分录字段,支持设置多个分录面板信息(可以支持二级分录),设置分录字段需要先在【数据分录分组】定义具体的数据分录面板或者子分录面板 |
数据字段自定义说明
字段名称 | 详细解释 |
字段编码 | 字段编码,需要以英文字母开头,且由字母、数字和下划线组成。编码需要保持在模型编码、分组编码及字段编码中都不重复 |
字段名称 | 设置异构系统传入字段的名称 |
创建方式 | 包括系统预置和自定义添加 |
接口字段编码 | 设置异构系统传入编码,支持英文字母大小、数字和下划线组成,接口传入时大小写敏感 |
字段类型 | 设置传入字段的数据类型,包括文本、数值、日期、基础资料、辅助资料、布尔、整数 |
基础资料 | 当字段类型为基础资料时,需要在此绑定具体的基础资料类型 |
辅助资料 | 当字段类型为辅助资料时,需要在此绑定具体的辅助资料类型 |
字段属性 | 用于设置字段的长度、精度、日期格式等属性,具体控制逻辑见【字段属性字段说明】 |
显示 | 控制字段是否显示在外部数据详情查看页面中,如果未开启<显示>,则字段数据能够正常导入,但在外部数据页面无法看到字段 |
必录 | 控制字段是否必录,如果必录字段未传入值,且字段未设置默认值,则无法通过外部数据导入校验 |
必录条件 | 设置必录条件,在满足设置的条件下,字段才需要必录 |
字段属性字段说明
字段名称 | 详细解释 |
字段长度 | 如果字段类型是【文本】/【基础资料】/【辅助资料】,则需要设置字段长度,默认值为50,可以支持长度为1-2000 |
字段精度 | 如果字段类型是【数值】,则需要设置字段精度,默认值为2,可以支持精度为0-10 如果字段类型是【整数】,则字段精度默认为0,不可修改 |
日期格式 | 如果字段类型是【日期】,则需要设置日期格式,可支持的格式: • yyyy • yyyy.MM • MM.yyyy • yyyy.MM.dd • MM.dd.yyyy • yyyy.MM.dd HHss • MM.dd.yyyy HHss |
显示属性 | 如果字段类型是【基础资料】/【辅助资料】,则需要设置显示属性,可以支持: • 显示名称 • 显示编码 • 显示编码+名称 |
默认值 | 1.默认值设置需要满足符合【字段类型】、【字段长度】、【字段精度】、【日期格式】等设置 2. 如果填写了默认值,则: • 外部有传入数据,字段取值为传入的数据 • 外部没有传入数据,字段取值为默认值 |
字段描述 | 用于描述字段填写信息,可以在导出json串格式中,把已设置的描述信息提示出来 |
关键按钮说明
按钮名称 | 详细解释 |
发布 | 新增/修改模型后,需要<发布>才能够使用新模型,否则仍然使用当前发布态的模型 |
预览 | 新建模型后,可以通过<预览>查看生成外部数据的样式。 注意事项:只有保存模型后才允许预览 |
json示例 | 可以导出已勾选模型的json格式样例 |
查看表名 | 查看已勾选模型下所有的表及表名 |
版本记录 | 查看已勾选模型的所有版本记录,并支持查看历史版本配置详情 |
2 主要操作
2.1 新老模型参数设置
适用场景
对于在5.0023之前已使用外部数据(原会计事件)的客户,可以选择继续新增旧版本的老模型,也可以启用5.0023之后的新模型。但对于5.0023才启用外部数据的客户,只允许新增新模型
操作步骤
步骤1:在【公共设置】-【系统参数】-【财务云】-【会计事件库】的【外部数据接入】页签找到<启用新外部数据模型>参数,如果参数打开,则新增的模型为新模型,关闭则新增的模型为老模型
注意事项:1.新模型的使用需要两种许可,一是会计事件库的许可;二是苍穹的二开许可
2.打开参数后,新增的模型是新模型,但是不影响原本系统里老模型的使用,老模型的使用方法仍与原来保持一致
3.打开参数后,老模型不会自动升级为新模型,允许系统里面老模型和新模型两套方式并行
4.<启用新外部数据模型>参数为全局参数,只允许在组织设置是否启用
5.5.0023以后的客户只允许新增新模型,无法新增老模型

2.2 定义外部数据模型分组
适用场景
用户根据自己的业务场景抽象外部数据模型模型分组,例如:定义AR应收的分组,将外部数据模型为“应收开票”和“确认收入”放入“应收”分组中
操作步骤
步骤1:在【外部数据模型列表】定义【外部数据模型分组】,点击<新增>分组
步骤2: 填写编码和名称
注意事项:编码需要以英文字母开头,由字母、数字和下划线组成,且不允许重复

后续操作
外部数据模型分组支持新增、修改、删除

1:新增;2:修改;3:删除
2.3 定义外部数据模型
适用场景
与异构系统约定好要传输的内容,有哪些字段,字段存储类型,单据数据结构等
操作步骤
步骤1: 定义外部数据模型时,需要关联具体的外部数据模型分组
在列表里显示所有定义的外部数据模型,新增外部数据模型的方法有两种:
• 先选择外部数据模型分组,直接点击<新增>进行填写。
• 在右边选择外部数据模型进行<复制>新增。

步骤2:定义数据字段分组,分为三个分组,系统字段分组、数据头分组和数据分录分组。其中:
• 系统字段分组不允许编辑,是外部数据导入的必填字段,只允许修改<显示>属性;
• 数据头分组用于设置外部数据的头字段,支持设置多个头面板信息(只支持一层级);
• 数据分录分组用于设置外部数据的分录字段,支持设置多个分录面板信息(可以支持二级分录)
注意事项:需要先新增分组,再在对应分组下新增字段

步骤3: 定义需要从异构系统导入的所有字段。选择了字段类型后,自动设置字段属性默认值,字段属性可以根据具体业务应用场景更改

2.4 外部数据预览
适用场景
定义好外部数据模型后,可以预览模型打开外部数据页面,检查外部数据模型设置是否满足需求
操作步骤
步骤1:新建好模型后,需要先保存
注意事项:【保存】状态的模型还不允许导入数据,只有【发布】状态的模型才能用于导入数据,新模型发布后版本号+1,需要检查当前模型满足需求才【发布】
步骤2:点左上角<预览>按钮,预览外部数据格式
注意事项:1.仅新模型支持预览;2.仅展示为预览格式,字段值均显示为空

2.5 查看json示例
适用场景
定义好外部数据模型后,可以查看模型对应的json示例,根据示例格式导入数据
操作步骤
步骤1:勾选一条外部数据模型模型,点<json示例>按钮
注意事项:仅新模型支持查看json示例

2.6 查看表名
适用场景
定义好外部数据模型后,可以查看模型对应表名
操作步骤
步骤1:勾选一条外部数据模型模型,点【查看表名】按钮

注意事项:仅新模型支持查看表名
2.7 查看版本记录
适用场景
定义好外部数据模型后,可以查看模型对应版本记录
操作步骤
步骤1:勾选一条外部数据模型模型,点<版本记录>按钮
注意事项:1.仅新模型支持查看版本记录
2.版本变更逻辑为:当前版本已经接入了数据,然后修改模型后再次发布,则版本号+1

后续操作
按照定义好的外部数据模型所需格式导入外部数据
2.8 迁入迁出
适用场景
将调试好的外部数据模型迁移到不同环境中
操作步骤
步骤1:勾选一条外部数据模型模型,点<迁出>按钮
注意事项:
1.仅用于迁移模型数据,不支持迁出在系统外修改
2.仅支持新模型迁移(模型上【是否新模型】字段为“是”)
3.仅支持【启用】状态下的模型迁移(涉及到发布逻辑等校验)
4.仅迁移模型本身,不迁移模型相关的关系(即【外部数据模型关系】菜单内容),如果设置了关系,需要手动维护
5.迁出内容为列表上显示的最新发布版本,包含完整的模型配置信息(不迁移对应的历史版本内容)

步骤2:在目标环境中点<迁入>按钮,并将步骤1迁出的模型勾选迁入
注意事项:
1.如果字段属性中设置了【默认值】,且默认值是一个基础资料时,需要注意保持两个系统内的基础资料编码一致性。(最好两个系统基础资料的ID也保持一致,如果ID不一致,同一个编码匹配出多条数据就会报错,如果只有唯一一条数据就可以通过校验)
2.迁入新环境中,如果通过校验,新版本则会直接设置为【发布】状态,但是如果有以下几个情况不会直接为发布状态,需要人工检查模型是否正确:
2.1如果默认值的基础资料在新环境中未找到唯一对应的基础资料时(找不到和找到多个都不行),此时状态是【暂存】,且会清空对应的默认值。逻辑跟手动在系统里面修改模型但是没有通过发布校验一样,不会覆盖新环境中【发布】状态的版本的,但是可以点【修改】进去编辑发布
2.2字段【必录条件】没有办法完全迁移,如果设置了【必录条件】,需要检查迁移到新环境中的必录条件配置是否有误,尤其是如果必录条件里面设置了函数,需要重新在新环境中手动再配置一遍函数
3.版本号逻辑:迁入时根据模型编码进行唯一匹配,如果系统内已有同编码模型,视为更新迁入。
3.1如果校验到迁入的版本跟系统内版本没有差异,则不保存新版本
3.2如果有差异,且字段校验通过(导入校验逻辑跟系统内修改逻辑一致,不允许删除已有字段等),则按照新环境的版本号新增一个版本
3.3如果有差异,且字段校验不通过,则迁入失败
4.迁入时,如果系统内相同编码的模型已存在【暂存】状态的版本,会自动先清除新环境系统内的【暂存】版本
5.迁入时,不会将迁出系统内的创建人、修改人、发布人等信息同时迁移过去,而是迁入新环境的操作人为对应的迁创建人、修改人、发布人(如果通过校验直接发布的情况)
6.迁入内容不包括外部数据模型的分组,需要先在新环境中设置好分组。迁入时模型分组按照分组编码校验是否存在,如果新环境中不存在对应的分组,则清除模型中的分组设置(会增加一个二级分组【默认分组】放在最前面)

后续操作
查看迁入迁出日志

3 版本升级说明
【V5.0.022】版本到【V5.0.023】版本外部数据模型做了重大调整,主要差异点如下:
1.外部数据模型列表:
1)菜单名由【事件模型】变更为【外部数据模型】
2)新增<发布>功能,只有发布状态的外部数据模型才允许导入数据
3)新增<json示例>功能,支持查看模型对应的json示例
4)新增<查看表名>功能,支持查看模型对应的表名
5)新增版本功能,支持外部数据模型版本化,追溯外部数据导入时使用的模型版本。如果模型未发布,则在【版本号】字段显示为未发布,否则显示对应的版本号
6)新增<版本记录>功能,支持查看模型对应的版本记录
7)新增【是否新模型】字段,区分新老模型
2.外部数据模型配置:
1)数据字段定义分为左树右表形式,将原本在【字段类型】中定义【分录】关联子表的形式拆分,移动到左树的【数据分录分组】中,分别在【数据头分组】和【数据分录分组】定义外部数据的头和分录结构
2)预置【系统字段】,即导入外部数据预设字段,系统字段不允许增删修改,只允许修改【显示】属性
3)新增【字段属性】设置,可以定义字段的长度、精度、日期格式、基础资料的显示格式、默认值、字段描述信息等
4)原模型中的【前置事件】设置移出,单独新建关系设置页面【外部数据模型关系】
3.新老模型分别走两套逻辑,新增功能(如查看表名等功能)只允许新模型使用,不允许老模型使用