02CMCC统一数字档案系统接口规范v15.docx

1、02CMCC统一数字档案系统接口规范v15中国移动集团统一数字档案管理系统接口规范书目 录1 项目背景 12 范围 13 使用方法 14 规范组成文件 15 缩略语 26 系统接口概述 26.1 归档内容 36.2 归档过程描述 46.3 接口实现方式 86.4 接口概述 97 Web服务接口描述 107.1 数据归档接口 107.2 档案校验结果反馈 138 中间库接口描述 148.1 数据归档接口 148.2 数据迁移接口 169 FTP存储命名描述 189.1 目录命名规范 1810 总结 18前言管理信息系统作为辅助企业内部管理和运营支撑的后台保障力量，对企业高效运作起到至关重要的作用

2、。从中国移动现实情况出发，完善的管理信息系统对组织融合、业务融合、机制融合等各个方面都是不可或缺的有益资源。统一数字档案管理系统作为IT管理信息系统的重要组成部分，统一数字档案管理系统实现对公司各种介质、各种类型的档案全流程管理，支撑档案收集、档案保存、档案管理、档案利用、档案销毁的档案全生命周期管理，实现全集团档案数据共享，提高档案数据利用率，有效地为生产经营服务。本规范为统一数字档案管理系统的接口规范，用于指导中国移动各系统实现与统一数字档案管理系统的电子化归档。1项目背景中国移动为了实现“一个中国移动（OneCM）”的企业战略，目前在管理支撑域正在进行“一网多包”的建设和规划，升级现有的

3、信息管理系统，以更好的支撑企业战略目标。作为一网多包的重点项目，中国移动统一数字档案的落地实施将为一网多包的建设提供经验。2范围本规范仅针对统一数字档案管理一期系统与各省已有目标系统之间的接口关系提出规范要求。本规范的制订旨在指导并规范中国移动总部、各省分公司及直属单位的统一数字档案管理系统建设，即本规范内容适用于总部、各省公司及相关直属单位。3使用方法中国移动总部、各省分公司及直属单位的统一数字档案管理系统建设过程中，根据各自的具体情况，选择接口服务的类型，按规范要求实现相应的接口，实现档案归档。4规范组成文件本规范由如下文件组成：CMCC_统一数字档案系统_接口规范：描述了系统接口规范的要

4、求和内容CMCC_统一数字档案系统_电子文件封装规范：规范了档案外围系统向档案归档文件时，文件的著录项的封装格式CMCC_统一数字档案系统_档案元数据规范：规范了档案外围系统向档案归档文件时，用于描述文件著录项的元数据信息CMCC_统一数字档案系统_元数据与档案分类数据映射表：档案外围系统向档案归档文件时，7个档案分类的著录项的组成信息和要求。5缩略语英文缩写英文名称中文名称WSFLWeb Service Flow Language叙述网络服务流程的语言SOAPSimple Object Access Protocol 简单对象访问协议UDDIUniversal Description, Di

5、scovery, and Integration 统一描述、发现和集成。UDDI 允许动态发现相关的 Web 服务并将其集成到聚合的业务过程中。WSDLWeb Services Description Language WEB 服务描述语言XMLExtensible Markup Language 可扩展标记语言HTTPHypertext Transfer Protocol 超文本传输协议FTPFile Transfer Protocol 文件传输协议W3CWorld Wide Web Consortium 互联网联合组织SGMLStandard Generalized Markup Lang

6、uage标准通用置标语言6系统接口概述中国移动总部、各省分公司及直属单位的统一数字档案管理系统建设过程中，根据各自的具体情况，选择接口服务的类型。根据相应的服务接口的规范，开发相应的服务接口调用程序及FTP服务调用程序，分别处理档案正文（含Word和PDF）、附件（压缩包，含Word和PDF）、底稿、流转单、著录项的元数据。本规范制定的接口包括档案归档接口和历史数据迁移接口两类，其中档案归档接口用于指导档案外围系统将统一数字档案一期系统支持的七类档案归档到档案系统中，历史数据迁移接口用于各省将已有档案系统的历史数据(七类档案的历史数据)迁移到统一数字档案一期系统中。6.1归档内容本规范规定的采

7、集归档的档案类型包括文书、招投标、合同、工程、会计、审计和特殊载体档案7个档案分类，其中归档档案的数据内容按不同档案分类将包括档案著录项以及正文、附件、底稿和流转单,档案数据包括档案新增数据和档案历史数据，其中正文包括PDF和Word形式的两份、附件归档文件类型为压缩包（zip格式或RAR格式，含附件的Word形式和PDF形式），底稿归档文件类型为word文件，流转单归档文件类型为MHT文件（推荐）或HTML文件。档案著录项格式为XML文件，格式要求见电子文件封装规范及元数据规范，其中针对不同的档案类型的元数据要求，对应的XML文件封装要求也有区别，具体参见元数据规范。6.2归档过程描述 接口

8、前期设置：统一数字档案归档接口过程6.2.1接口使用前配置统一数字档案外围系统归档接口：1.接口在使用前，需要按集团档案业务分类规范，确认各系统对应的档案分类，以及其中各必填项字段的输入数据；2.接口在使用前，根据待归档系统的类型和要求，配置归档数据归档到待归档库或归档库；3.接口根据业务需要，支持业务系统采用按月、按天或实时的方式进行归档；统一数字档案历史数据归档接口：1.接口在使用前，需要提供历史档案数据的数据结构，以及数据与现有档案分类元数据的映射关系；6.2.2接口归档过程统一数字档案外围系统归档接口：上图中红色区域中为各省需要将新增数据导入到统一数字档案系统而需要开发的程序，总共包括

9、一个三个模块。 档案文件同步模块：开发FTP客户端程序，负责调用接口机FTP服务。主要完成的功能是将前面所需的7类档案文件及著录项XML文件通过FTP协议的方式传送到部署在各省的接口机中。这个过程中需要记录接口调用的返回结果以备联调。 档案信息同步模块：根据系统要求，选择采用WebService方式或中间表方式，开发客户端，负责调用接口机的服务端。主要完成的功能是将每个档案的属性信息（档案标识、档案名称、编写者、档案类型、档案附件数量、每个附件的大小、档案校验码等档案基本信息以及对应的调用接口的系统标识、系统名称等来源信息）传递给接口服务。这个过程中需要记录接口调用的返回结果以备联调。（步骤）

10、 错误档案退回模块：开发服务端，接收接口机传过来的数据校验结果。程序调用过程：1. 档案信息同步模块通过调用接口机提供的归档服务，同步需要传递的档案的信息。在接口调用失败的情况下，同步模块需要记录下失败的信息，并有重试的处理。2. 档案文件同步模块通过调用接口机提供的FTP服务，同步需要传递的档案的档案内容。在接口调用失败的情况下需要相应的记录及重试的处理。3. （接口机完成过程）通过档案信息同步模块传递的档案信息，对档案文件同步接口传递的档案文件进行校验。针对每次档案信息同步接口调用所同步的档案信息进行校验，对失败的档案标识进行整理，调用错误档案退回接口。4.错误档案退回模块收集接口机传递的

11、数据校验结果，对错误的文件进行处理后，再通过档案信息同步模块进行归档处理。5.系统管理员可以通过接口界面查看归档的情况，以及出错信息。统一数字档案历史数据归档接口：对于历史数据而言，各省同样需要提供相应的程序处理历史数据的导入，与上面的处理过程类似，包含的主要模块为： 历史档案文件导入模块：开发FTP客户端程序，负责调用接口机FTP服务。主要完成的功能是将历史档案文件及其著录项XML文件通过FTP协议的方式传送到部署在各省的接口机中。这个过程中需要记录接口调用的返回结果以备联调。 历史档案信息导入模块：开发WebService客户端，负责调用接口机的WebService服务端。主要完成的功能是

12、将每个档案的属性信息（档案标识、档案名称、编写者、档案类型、档案附件数量、每个附件的大小、档案校验码等档案基本信息以及对应的调用接口的系统标识、系统名称等来源信息）传递给接口机WebService服务。这个过程中需要记录接口调用的返回结果以备联调。（步骤） 历史错误档案退回模块：开发WebService服务端，接收接口机传过来的数据校验结果。对于历史数据而言，由于历史数据的档案类型、数据结构等与现有的档案类型、数据结构之间存在差异，需要整理历史档案类型与现有的档案类型的映射，同时针对每一类的档案类型映射，还需要整理具体的数据结构上的映射关系，并将整理后的映射关系导入到统一数字档案系统。程序调用

13、过程：1. 档案历史信息导入模块通过调用接口机提供的WebService服务，导入需要传递的历史档案的信息。在接口调用失败的情况下需要相应的记录及重试的处理。2. 档案文件导入模块通过调用接口机提供的FTP服务，导入需要传递的档案的档案内容。在接口调用失败的情况下需要相应的记录及重试的处理。3. （接口机完成过程）通过档案信息导入模块传递的档案信息，对档案文件导入模块传递的档案文件进行校验。针对档案信息导入模块调用所导入的档案信息进行校验，对失败的档案标识进行整理，调用错误档案退回接口。4.错误档案退回模块收集接口机传递的数据校验结果。6.3接口实现方式所建设的接口实现方式考虑到外部系统的复杂

14、性，接口平台提供了两种实现方式：一是 “中间库”，二是“Web服务”模式。接下来将简单介绍两种方式实现。(一) 中间库方式由于domino 6.5以下版本不支持Web Service,所以引入了中间库接口方式。根据电子文件归档与管理规范 GB/T 18894-2002的要求，在各上游业务系统与统一数字档案管理系统之间建立一个中间逻辑数据库，该库包含一系列数据表及视图，在上游业务系统中提交归档的数据信息都存放在此中间逻辑数据库中，同时将档案正文（含Word和PDF）、附件（压缩包含Word和PDF）、著录项、底稿、流转单等相关文件放置到待归档的FTP服务器上，在此中间逻辑数据库和统一数字档案管理

15、系统之间开发应用程序，该应用程序可以将此中间逻辑数据库中和FTP服务器中的信息转换到统一数字档案管理系统的数据库中。存放在统一数字档案管理系统的数据暂存库中，以便进行数据接收入库及文件归档工作。如下图：(二) WEB服务模式统一数字档案管理系统中提供档案归档和查询数据接口，在归档时，上游业务系统将原文上传至指定FTP服务器 ，然后接口系统提交XML信息至统一数字档案的WEB服务，将归档数据写入统一数字档案管理系统实现供后期文件检索利用的目的。各上游业务系统可以通过这个WEB服务向档案系统导入数据。由于原文一般都比较大，为了系统的稳定性WEB服务不直接接收原文信息，各上游业务系统先将原文信息导至

16、中间介质，由档案系统根据条件对应至中间介质中取出原文信息。中间介质，一般采用FTP方式。各接口系统，首先将原文信息导入至中间FTP服务器，确认成功后再调用相应的接口WEB服务。6.4接口概述统一数字档案系统提供的服务接口概述：序号服务名称服务功能描述服务类型提供方消费方读/写1. 外围系统档案归档信息服务将可归档的文件进行归档生成档案或对已归档但又有内容变更的文件进行再次归档Web Service统一数字档案管理系统上游业务系统写入2. 外围系统档案归档信息服务将可归档的文件进行归档生成档案或对已归档但又有内容变更的文件进行再次归档中间表统一数字档案管理系统上游业务系统写入3. 原有档案系统数

17、据迁移信息服务各省原有档案系统通过该接口完成系统中原有档案数据向统一数字档案管理系统迁移中间表统一数字档案管理系统原有档案系统写入7Web服务接口描述7.1数据归档接口7.1.1服务名称英文名称： ImportArchiveInfo中文名称：数据归档接口7.1.2服务描述将需要归档的文件信息导入统一数字档案管理系统生成归档档案。服务提供方：统一数字档案管理系统服务消费方：上游业务系统。7.1.3接口类型 读出 写入 读出写入7.1.4输入参数参数信息：序号是否必填字段名称字段描述数据类型字段约束1. YARCHIVE_ID档案标识VARCHAR2(64)系统简称_档案唯一标示2. YCOMPA

18、NY_ID公司代码VARCHAR2(64)见代码体系编制规则v1.52.2.1公司代码的编制方法3. YCATEGORY档案分类VARCHAR2(64)见5.2.5字典项4. YFILE原始正文VARCHAR2(200)该文件在FTP上的地址，地址存放格式见9.2节5. Nfile_PDF转换后正文VARCHAR2(200)该文件在FTP上的地址，地址存放格式见9.2节6. NATTACHMENT档案附件VARCHAR2(200)该文件在FTP上的地址, 地址存放格式见9.2节，压缩包包含原始文件和转换后的文件7. YLlbCollection著录项（包括权限）VARCHAR2(200)该文件

19、在FTP上的地址，地址存放格式见9.2节。XML格式文件。该文件须遵循电子文件封装规范, 8. NWORKFLOW流程单VARCHAR2(200)该文件在FTP上的地址。地址存放格式见9.2节。MHT格式文件。9. NDRAFT底稿VARCHAR2(200)该文件在FTP上的地址。地址存放格式见9.2节。10. NFILE_MD5原始正文校验码VARCHAR2(200)该文件的校验码，使用MD5方式生成。11. Nfile_PDF_MD5转换后正文校验码12. NATTACHMENT_MD5档案附件校验码VARCHAR2(200)该文件的校验码，使用MD5方式生成。13. YLlbCollec

20、tion_MD5著录项校验码（包括权限）VARCHAR2(200)该文件的校验码，使用MD5方式生成。14. NWORKFLOW_MD5流程单校验码VARCHAR2(200)该文件的校验码，使用MD5方式生成。15. NDRAFT_MD5底稿校验码VARCHAR2(200)该文件的校验码，使用MD5方式生成。16. YOP_LOGIN操作员VARCHAR2(64)使用接口的用户7.1.5接口数据字典档案分类（CATEGORY） 字典项：档案分类编码档案分类名称WS文书档案GC工程档案ZT招投标档案HT合同档案SJ审计档案TS特殊载体档案KJ会计档案CP产品档案QYZL专利档案QYBZ标准化档案

21、JX教学档案KY科研档案SW实物档案QZ权证档案ZT专题档案7.1.6接口接入注意事项如果上游系统的用户信息与集团SMAP系统一致,著录项中的授权对象值需要与集团SMAP系统中用户全名保持一致；如果上游系统的用户信息与集团SMAP系统不一致，著录项中的授权对象为空。7.1.7输出参数参数信息：序号字段名称字段描述数据类型备注1. RETURN_VALUE服务执行结果VARCHAR2(64)0001：服务返回操作成功0002：服务返回操作失败2. RETURN_INFO返回结果内容VARCHAR2(4000)7.2档案校验结果反馈7.2.1服务名称英文名称： ArchiveVerificatio

22、nResult中文名称：档案校验结果反馈7.2.2服务描述接受档案的校验结果服务提供方：上游业务系统服务消费方：统一数字档案管理系统7.2.3接口类型 读出 写入 读出写入7.2.4输入参数信息：序号是否必填字段名称字段描述数据类型字段约束1. YARCHIVE_CODE档案标识VARCHAR2(64)系统简称_档案唯一标示2. YSTATUS_ID校验结果代码VARCHAR2(64)3. YRECEIVE_TIME档案接收时间VARCHAR2(64)7.2.5输出参数信息：序号字段名称字段描述数据类型备注3. RETURN_VALUE服务执行结果VARCHAR2(64)0001：服务返回操作

23、成功0002：服务返回操作失败4. RETURN_INFO返回结果内容VARCHAR2(4000)8中间库接口描述8.1数据归档接口8.1.1接口名称英文名称：ImportArchiveInfo中文名称：数据归档接口8.1.2接口描述业务系统根据统一数字档案管理系统档案归档范围将系统中待归档数据，以中国移动电子文件封装规范的规范进行封装后，推送到中间库，推送到中间库的数据通过中间接口系统展现给档案员，有档案员选择数据并归档。8.1.3接口类型 读出 写入 读出写入8.1.4中间表结构S_INFO：序号是否必填字段名称字段描述数据类型字段约束1. YARCHIVE_ID档案标识VARCHAR2(

24、64)系统简称_档案唯一标示2. YCOMPANY_ID公司代码VARCHAR2(64)见代码体系编制规则v1.52.2.1公司代码的编制方法3. YCATEGORY档案分类VARCHAR2(64)见5.2.5字典项4. YFILE原始正文VARCHAR2(200)该文件在FTP上的地址，地址存放格式见9.2节5. Nfile_PDF转换后正文VARCHAR2(200)该文件在FTP上的地址，地址存放格式见9.2节6. NATTACHMENT档案附件VARCHAR2(200)该文件在FTP上的地址, 地址存放格式见9.2节，压缩包包含原始文件和转换后的文件7. YLlbCollection著录

25、项（包括权限）VARCHAR2(200)该文件在FTP上的地址，地址存放格式见9.2节。XML格式文件。该文件须遵循电子文件封装规范, 8. NWORKFLOW流程单VARCHAR2(200)该文件在FTP上的地址。地址存放格式见9.2节。MHT格式文件。9. NDRAFT底稿VARCHAR2(200)该文件在FTP上的地址。地址存放格式见9.2节。10. NFILE_MD5原始正文校验码VARCHAR2(200)该文件的校验码，使用MD5方式生成。11. Nfile_PDF_MD5转换后正文校验码12. NATTACHMENT_MD5档案附件校验码VARCHAR2(200)该文件的校验码，使

26、用MD5方式生成。13. YLlbCollection_MD5著录项校验码（包括权限）VARCHAR2(200)该文件的校验码，使用MD5方式生成。14. NWORKFLOW_MD5流程单校验码VARCHAR2(200)该文件的校验码，使用MD5方式生成。15. NDRAFT_MD5底稿校验码VARCHAR2(200)该文件的校验码，使用MD5方式生成。16. YOP_LOGIN操作员VARCHAR2(64)使用接口的用户8.1.5接口接入注意事项如果上游系统的用户信息与集团SMAP系统一致,著录项中的授权对象值需要与集团SMAP系统中用户全名保持一致；如果上游系统的用户信息与集团SMAP系统

27、不一致，著录项中的授权对象为空。8.2数据迁移接口8.2.1接口名称英文名称： ArchiveMigration中文名称：数据迁移接口8.2.2接口描述数据迁移接口供各省原有档案系统根据统一数字档案管理系统档案归档范围将系统中已归档数据，在对历史数据进行归档之前，需要将历史已归档数据的映射关系整理并提交统一档案管理系统中。然后按照中国移动电子文件封装规范要求完成封装后，推送到中间库，推送到中间库的数据根据数据映射的要求，通过数据迁移程序迁移到统一数字档案系统中，数据迁移不涉及权限数据的迁移，依照现有统一数字档案系统权限规则处理。8.2.3接口类型 读出 写入 读出写入8.2.4中间表结构S_I

28、NFO：序号是否必填字段名称字段描述数据类型字段约束1. YARCHIVE_ID档案标识VARCHAR2(64)系统简称_档案唯一标示2. YCOMPANY_ID公司代码VARCHAR2(64)见代码体系编制规则v1.52.2.1公司代码的编制方法3. YCATEGORY档案分类VARCHAR2(64)见5.2.5字典项4. YFILE原始正文VARCHAR2(200)该文件在FTP上的地址，地址存放格式见9.2节5. Nfile_PDF转换后正文VARCHAR2(200)该文件在FTP上的地址，地址存放格式见9.2节6. NATTACHMENT档案附件VARCHAR2(200)该文件在FTP上的地址, 地址存放格式见9.2节，压缩包包含原始文件和转换后的文件7. YLlbCollection著录项（包括权限）VARCHAR2(200)该文件在FTP上的地址，地址存放格式见9.2节。XML格式文件。该文件须遵循电子文件封装规范, 8. NWORKFLOW流程单VARCHAR2(200)该文件在FTP上的地址。地址存放格式见9.2节。MHT格式文件。9. NDRAFT底稿VARCHAR2(200)该文件在FTP上的地址。地址存放格