酒美接口设计说明书1.5

1、共 15 页-第 0 页 产品设计说明书产品设计说明书 项目委托单位项目委托单位( (甲方）：甲方）： 项目名称项目名称： 文件标识： 当前版本：1.5 作者： 完成日期：2011 年 11 月 15 日 版版 本本 历历 史史 版本状态作者参与者开始日期结束日期备注 1.0 刘春晖 2011.11.04 1.1 刘春晖 2011.11.11 1.2 吴琼刘春晖 2011.11.112011.11.14 1.3 刘春晖 2011.11.142011.11.15 1.4 刘春晖 2011.11.162011.11.16 1.5刘春晖2011.11.172011.11.17 目 录 1 文档介绍文

2、档介绍.2 共 15 页-第 1 页 1.1 文档目的.2 1.2 读者对象.2 1.3 参考资料.2 1.4 术语与缩写解释.2 2 接口数据交互业务模型接口数据交互业务模型.3 3 3 接口数据模型接口数据模型.3 4 系统功能设计系统功能设计.4 4.1 系统功能列表.4 4.2 系统配置.4 4.3 自动运行配置.5 4.4 自动运行调度.5 4.5 手动运行调用.6 4.6 业务接口.6 4.7 日志管理.13 4.8 管理员密码.15 5 部署内容部署内容.15 5.1 限制条件.15 5.2 部署流程（图）.15 5.3 部署拓扑图.15 5.4 部署内容.15 6 系统出错处理

3、设计系统出错处理设计.15 6.1 出错信.15 6.2 补救措施.15 6.3 系统维护设计.15 1 文档介绍文档介绍 1.1 文档目的 A. 说明需求说明书内容的具体设计实现思路； 共 15 页-第 1 页 B. 为开发，测试和维护提供指导。 1.2 读者对象 A. 乙方软件项目人员，包括项目经理，设计师，开发人员等； B. 甲方相关人员。 1.3 参考资料 A. 需求规格说明书； B. 甲方提供的数据资料。 1.4 术语与缩写解释 缩写、术语缩写、术语解解 释释 K/3 金蝶软件（中国）有限公司的软件产品：K/3 ERP 系统 B2C 共 15 页-第 2 页 2 接口数据交互业务模型

4、接口数据交互业务模型 B2C B. 显示界面：调用每个业务接口的时候，需要在界面显示显示执行情况。 C. 包含内容：进度条；在执行业务接口名称。 4.6.2 统一处理说明统一处理说明 手工调用和自动调用的业务接口处理模式一致，即业务接口组件的处理遵循统一的流 程。 K/3数据库中间数据库 日志主表 日志子表 业务表 K/3业务表 写入数据 A. 读取数据要求： 读取同步状态为 0(待处理)的信息。 B. 检查数据要求： 1). 读取状态为 0(待处理)的信息； 2). 按照错误类型列表进行排错； 共 15 页-第 6 页 a. 出现错误(检查未通过)，在日志表写入相应错误信息，状态置为 3(检

5、查错误)； b. 没有错误(检查通过)，状态置为 1(待写入)。 C. 写入数据要求： 1). 读取状态为 1(待写入)的信息； 2). 写入出错，在日志表写入错误信息，状态置为 4(写入错误)； 3). 写入成功，状态置为 2(写入成功) D. 统一处理流程图： 1). 统一处理字段状态： 0 - 待处理；1 待写入；2 写入成功；3 检查错误；4 - 写入错误 2). 统一处理字段说明： a. 同步状态：表示接口程序同步操作的状态； b. 错误信息：接口程序进行同步操作时所发生的错误； c. 创建时间：B2C 第一次创建数据时写入创建时间； d. 使用时间：接口程序进行操作(检查、写入)时

6、的时间。 E. B2C 向中间库传递数据时要统一把同步状态置为向中间库传递数据时要统一把同步状态置为 0(待处理待处理)； B2C 向中间库传递数据时要统一写入创建时间。向中间库传递数据时要统一写入创建时间。 错误类型列表： 同步类别同步类别错误定义错误定义说明说明 计量单位不存在中间表提供的计量单位在 K/3 表中不存在 商品 科目不存在中间表提供的科目分类在 K/3 表中不存在 金额不合法金额 0 编号不存在中间表提供的编号在 K/3 表中不存在 供应商不存在中间表提供的供应商在 K/3 表中不存在 部门不存在中间表提供的部门在 K/3 表中不存在 制单人不存在中间表提供的制单人在 K/3

7、 表中不存在 负责人不存在中间表提供的负责人在 K/3 表中不存在 商品编码不存在中间表提供的商品编码在 K/3 表中不存在 采购 收料仓库不存在中间表提供的收料仓库在 K/3 表中不存在 金额不合法金额 0 编号不存在中间表提供的编号在 K/3 表中不存在 购货单位不存在中间表提供的购货单位在 K/3 表中不存在 商品不存在中间表提供的商品在 K/3 表中不存在 销售 发货仓库不存在中间表提供的发货仓库在 K/3 表中不存在 收款单金额不合法金额 0 检查检查( (读取状态读取状态 0 0 的信息的信息) )写入写入( (读取状态读取状态 1 1 的信息的信息) )序序 号号 中文名称中文名

8、称英文名称英文名称读取读取 通过通过未通过未通过写入成功写入成功写入未成功写入未成功 1 同步状态 FStatus01324 2 错误信息 FError 无操作无操作写入错误信息无操作写入错误信息 3 创建时间 FCreateTime 无操作无操作无操作无操作无操作 4 使用时间 FUseTime 无操作写入写入写入写入 共 15 页-第 7 页 编号不存在中间表提供的编号在 K/3 表中不存在 4.6.3 商品接口商品接口 A. 子接口调用顺序：商品数据由接口从中间数据库取得，然后写入 K/3 系统。 B.不考虑删除、修改情况，如发生，则两个业务系统手工处理。 界面级字段业务对应说明： 数据

9、库设计： 商品接口商品接口( (关联关联 K/3K/3 物料物料) ) 表名：M_ICItem；位置：中间数据库；类型：新建 序号序号字段中文名称字段中文名称字段数据库名称字段数据库名称字段类型字段类型长度长度输入方输入方说明说明 1. 中间库主键 FIDInt 自动生成自增 2. 商品编码 FNumberVarchar10B2C 自动传递,B2C 提供编码规则 3. 商品名称 FNameVarchar200B2C 4. 年份 FYearIntB2C K/3 自定义项 5. 重量 FWeightMoneyB2C K/3 自定义项 6. 介质 FMediumVarchar50B2C K/3 自定

10、义项 7. 规格 FModelVarchar100B3C 8. 计量单位 FUnitGroupVarchar50B2C 9. 一级物料分类 FGoodsType1Varchar100B2C 需要酒美确认，传输方式需 要确认 10. 二级物料分类 FGoodsType2Varchar100B2C 需要酒美确认，传输方式需 要确认 11. N 级物料分类 FGoodsType3Varchar100B2C 需要酒美确认，传输方式需 要确认 12. 进货类型 FTypeVarchar100B2C K/3 自定义项 13. 计价方法 FTrackVarchar100K/3 K/3 默认，固定先进先出 1

11、4. 存货科目代码 FAcctVarchar100K/3 K/3 默认，需要酒美确认， 科目需要验证，手工维护一 致 15. 销售收入科目代码 FSaleAcctVarchar100K/3 K/3 默认，需要酒美确认， 科目需要验证，手工维护一 致 16. 销售成本科目代码 FCostAcctVarchar100K/3 K/3 默认，需要酒美确认， 科目需要验证，手工维护一 致 共 15 页-第 8 页 4.6.4 采购接口采购接口 A. 子接口调用顺序：商品接口-采购接口； B. 读取新增和写入处理模式为统一结构； C. 接口从中间库取出数据并在 K/3 生成相应数据； D. 不考虑删除、修

12、改情况，如发生，则两个业务系统手工处理。 数据库设计： 采购单主表采购单主表 表名：M_Purchase；位置：中间数据库；类型：新建 序号序号字段中文名称字段中文名称字段数据库名称字段数据库名称字段类型字段类型长度长度输入方输入方说明说明 1. 中间库主键 FIDInt 自动生成自增 2. 源系统单据内码 FOrgIDVarchar15B2C B2C 单据内码 3. 合同 FContactNoIntB2C K/3 自定义字段 4. 供应商 FSupplyVarchar6 传递编码 5. 事业部 FDepartmentVarchar100B2C K/3 自定义字段，传 递名称 6. 制单人 F

13、B2CBillerVarchar32B2C K/3 自定义字段，传 递名称 7. 经手人 FManagerVarchar32B2C K/3 自定义字段，传 递名称 8. 日期 FDateDateTimeB2C 9. 备注 FExplanationVarchar500B2C 10. 采购标志 FSignVarchar50B2C K/3 自定义字段(返厂、 采购) 11. 经销方式 FModeVarchar50B2C K/3 自定义字段(经销、 代销) 12. 制单 FBillerVarchar50K/3 固定 B2C 13. 保管 FSManagerVarchar50K/3 固定 B2C 14.

14、 验收 FFManagerVarchar50K/3 固定 B2C 15. K/3 内码 FK3IDIntK/3 生成后回填 17. K3 内码 FK3IDInt K/3 生成基础资料后反写 18. 同步状态 FStatusIntK/3 0-待处理；1-待写入；2-写 入成功；3-错误 19. 错误信息 FErrorVarchar500K/3 20. 创建时间 FCreateTimedatetimeK/3 格式：yyyy-mm-dd:hh:mm:ss 21. 修改时间 FUseTimedatetimeK/3 格式：yyyy-mm-dd:hh:mm:ss 共 15 页-第 9 页 16. 同步状态

15、 FStatusIntK/3 0-待处理；1-待写入； 2-写入成功；3-检查 错误；4-写入错误 17. 错误信息 FErrorIntK/3 K/3 导入是进行数据 检验，如有错误回写 18. 创建时间 FCreateTimedatetimeK/3 格式：yyyy-mm- dd:hh:mm:ss 19. 使用时间 FUseTimedatetimeK/3 格式：yyyy-mm- dd:hh:mm:ss 采购单分录表采购单分录表 表名：M_PurchaseEntry；位置：中间数据库；类型：新建 序号序号字段中文名称字段中文名称字段数据库名称字段数据库名称字段类型字段类型长度长度输入方输入方说明

16、说明 1. 源系统单据内码 FOrgIDVarchar50B2C B2C 单据内码 2. 商品编码 FItemNumberVarchar10B2C 3. 数量 FQtyDecimal18,4B2C 4. 单价(不含税) FPriceMoneyB2C 5. 含税单价 FAllPriceMoneyB2C K/3 自定义字段 6. 税率 FTaxRateMoneyB2C K/3 自定义字段 7. 金额 FAmountMoney 公式数量单价(不含税) 8. 含税金额 FAllAmountMoney 公式 K/3 自定义字段，数 量含税单价 9. 税额 FTaxAmountMoney 公式 K/3 自

17、定义字段，含 税金额-金额 10. 进货库房 FDCStockVarchar10B2C 传递编码 11. 分录号 FK3EntryIDIntK/3 K/3 生成后回填 15 错误信息 FErrorIntK/3 K/3 导入是进行数据 检验，如有错误回写 4.6.5 销售接口销售接口 A. 子接口调用顺序：商品接口-采购接口-销售接口； B. 读取新增和写入处理模式为统一结构； C. 接口从中间库取出数据并在 K/3 生成相应数据； D. 不考虑删除、修改情况，如发生，则两个业务系统手工处理。 数据库设计： 销售单主表（关联销售单主表（关联 K/3K/3 出库单主表）出库单主表） 表名：M_Sa

18、le；位置：中间数据库；类型：新建 序序 号号 字段中文名称字段中文名称字段数据库名称字段数据库名称字段类型字段类型长度长度输入方输入方说明说明 1. 中间库主键 FIDInt 自动生成自增 共 15 页-第 10 页 2. 源系统单据内码 FOrgIDVarchar50B2C B2C 单据内码 3. 销售模式 FSaleModeVarchar50B2C K/3 自定义字段，例： 个人客户、渠道分销、 内部领用 4. 订单类型 FBillTypeVarchar50B2C K/3 自定义字段 5. 购货单位(B2C 结算单位) FCustVarchar200B2C K/3 必填项 6. 配送商

19、FSupplyVarchar64B2C K/3 自定义字段，传 递名称 7. 日期 FDateDatetimeB2C 8. 经销方式 FModeVarchar10B2C K/3 自定义字段(经销、 代销) 9. 销售方式 FSaleStyleVarchar50K/3 K/3 必填项，需要确 认 10. 发货人 FFManagerVarchar50K/3 K/3 必填项，固定 B2C 11. 保管人 FSManagerVarchar50B2C K/3 必填项，固定 B2C 12. K/3 内码 FK3IDVarchar100K/3 生成后回填 13. 同步状态 FStatusIntK/3 0-待

20、处理；1-待写入； 2-写入成功；3-检查 错误；4-写入错误 14. 错误信息 FErrorIntK/3 K/3 导入是进行数据 检验，如有错误回写 15. 创建时间 FCreateTimedatetimeK/3 格式：yyyy-mm- dd:hh:mm:ss 16. 使用时间 FUseTimedatetimeK/3 格式：yyyy-mm- dd:hh:mm:ss 销售单分录表（关联销售单分录表（关联 K/3K/3 销售单分录表）销售单分录表） 表名：M_SaleEntry；位置：中间数据库；类型：新建 序号序号字段中文名称字段中文名称字段数据库名称字段数据库名称字段类型字段类型长度长度 说

21、明说明 1. 源系统单据内码 FOrgIDVarchar50B2C B2C 单据内码 2. 商品编码 FItemNumberVarchar10B2C 3. 单价 FPriceMoneyB2C 4. 含税单价 FAllPriceMoneyB2C K/3 自定义字段 5. 数量 FQtyDecimal18,4B2C 6. 金额(不含税) FAmountMoney 公式 7. 含税金额 FAllAmountMoneyB2C K/3 自定义字段 8. 发出仓库 FSCStockVarchar10B2C 传递编码 9. 分录号 FK3EntryIDIntK/3 K/3 生成后回填 10. 错误信息 FE

22、rrorIntK/3 K/3 导入是进行数据 检验，如有错误回写 共 15 页-第 11 页 4.6.6 收款接口收款接口 A. 子接口调用顺序：商品接口-采购接口-销售接口-收款接口； B. 读取新增和写入处理模式为统一结构； C. 接口从中间库取出数据并在 K/3 生成相应数据； D. 不考虑删除、修改情况，如发生，则两个业务系统手工处理。 数据库设计： 收款接口收款接口(K/3(K/3 收款单收款单) ) 表名：M_ReceiveBill；位置：中间数据库；类型：新建 序号序号字段中文名称字段中文名称字段数据库名称字段数据库名称字段类型字段类型长度长度输入方输入方说明说明 1. 中间库主

23、键 FIDInt 自动生成自增 2. 源系统单据内码 FOrgIDVarchar50B2C B2C 单据内码 3. 客户编码(K/3 核算项目) FCustVarchar200B2C 4. 单据日期 FDateDateTimeB2C 5. 财务日期 FFincDateDateTime 同单据日期 6. 单据金额 FAmountMoneyB2C 需要酒美确认 7. 收款单分类 FBillTypeVarchar50B2C K/3 自定义字段 8. K/3 内码 FK3IDIntK/3 生成后回填 9. 同步状态 FStatusIntK/3 0-待处理；1-待写入；2-写 入成功；3-检查错误；4-

24、写 入错误 10. 错误信息 FErrorIntK/3 K/3 导入是进行数据检验， 如有错误回写 11. 创建时间 FCreateTimedatetimeK/3 格式：yyyy-mm-dd:hh:mm:ss 12. 使用时间 FUseTimedatetimeK/3 格式：yyyy-mm-dd:hh:mm:ss 4.74.7 日志管理日志管理 4.7.1 日志主界面日志主界面 A. 在调用业务接口的时候，进行日志的写入操作。 B. 日志写入分为主表和子表。主表按照类型写入，每次调用某业务接口，调用过程中和完 成调用，写入日志。主表事物代号每项调用取得最大值写入；子表写入规则：事物代号+中 间表

25、主键。 C. 字段列表见下节数据表说明。 D. 界面提供过滤功能，过滤条件： （1）时间范围：1）开始时间；2）结束时间。条件范围选择到日期即可。 （2）业务类型：5 种类型中选择。 （3）是否出错：是；否选择。 共 15 页-第 12 页 （4）错误类型：连接错误；数据错误选择。 （5）运行时间：调用开始时间到结束的时间间隔。 4.7.2 日志明细界面日志明细界面 A. 选择某行主日志，进入明细数据读取展示界面。界面展示 4.6 业务接口说明中某项业务 的全字段信息。展示取数方式为根据选择的事物代号下面的中间表 ID，根据业务类型取得 对应中间表的数据。展示的字段组成根据不同的业务展示。 B. 提供操作功能： （1）错误数据忽略处理。即已经出错的数据，如果不再进行业务处理，忽略标志打入， 后面调用不再处理。注：业务接口的调用，每项子业务是顺序调用，如某项业务 数据，第一次写入的时候出现错误，在错误排除并且未从数据源重新读取的时候， 再运行接口，这些业务数据还会进行写入操作。执行此动作后，此类数据标记更 换，不再进行处理。 （2）错误数据重新读取：已经出错的数据，如果对应的数据源已经调整，需要重新读 取，则需要在此打上重新读取标记，这类业务数据重新从数据源读