数字档案系统通用标准接口规范.docx
《数字档案系统通用标准接口规范.docx》由会员分享，可在线阅读，更多相关《数字档案系统通用标准接口规范.docx（17页珍藏版）》请在冰豆网上搜索。
数字档案系统通用标准接口规范
数字档案管理系统外部系统
通用接口规范说明
1
业务系统电子文件归档法律规范与要求
根据国家档案局发布法律法规文件要求，在《企业数字档案馆（室）建设指南》和《企业电子文件归档和电子档案管理指南》两个文件中明确提出企业在业务系统建设时应充分考虑电子文件归档要求。
归档接口应与业务系统同设计、同开发、同测试和同实施，实施时未开发归档接口的业务系统应及时通过二次开发实现。
企业已实施的支撑主营业务的信息系统均应具有归档功能，导出的归档电子文件存储格式、元数据等均应符合电子文件归档和电子档案管理的有关要求。
企业电子文件归档范围应包括各业务活动中形成的各种结构化和非结构化数据，以独立文档形式存储的具有保存价值的信息记录，包括办公自动化系统、产品或业务系统、财务会计管理信息系统、人力资源管理信息系统、门户网站、微博、微信、公务邮件系统及本企业其他职能活动业务系统中形成的电子文件，以及从外部接收的电子文件。
企业有些信息系统有可能通过租用基础设施或以云计算服务的形式存在，所形成的电子文件不一定存在于本企业的服务器中，但其产生的电子文件也应纳入本企业文件材料归档范围予以归档。
数字档案馆系统建设时充分考虑未来业务需求及系统可扩展性，避免每新上业务系统要求实现电子文件归档时档案系统平台都要作相应的开发及调整，档案系统与业务系统集成采用建立档案数据交换标准接口的方式，以提供良好的可扩展性、可重用性、可维护性和可管理性。
2技术架构
（1）档案系统与业务系统集成采用建立档案数据交换标准接口的方式，以提供良好的可扩展性、可重用性、可维护性和可管理性。
（2）档案数据交换标准接口提供与外围业务系统的接口规范、统一模型、数据交换格式定义等。
（3）业务系统主动将数据上传到档案服务器，即采用推的方式将包含了元数据和电子原文的档案数据主动推送给档案系统。
（4）档案系统对业务系统推送过来的档案数据不做二次加工，保证档案数据的准确性和原始性。
（5）档案数据交换标准接口的日志与监测通过档案系统消息模块统一实现。
3接口规范要求说明
档案系统通用标准接口定义了业务系统归档数据包标准，按照此标准由前端业务系统开发把需要归档的数据和电子文件打包推送到档案系统中间平台，归档数据表都以目录（XML格式）+电子文件（PDF格式）形式推送，每个文件都有相应的描述目录信息、电子文件属性信息，同时电子文件作为目录的附件推送。
要求：
目录信息要求XML格式，电子文件要求PDF格式。
4功能调用
4.1上传归档文件
归档文件包采用FTP方式上传至档案服务器的指定目录，业务系统每个批次的归档文件集中在一个文件夹中上传。
文件夹结构下：
4.1.1归档目录文件的文件夹结构
|-ArchiveData
|-20130328abc
|-data.xml
|-flag.txt
Ø其中“ArchiveData”为FTP的根目录。
Ø20130328abc为批号，由业务系统生成，数据长度不超过128.每个批次的归档文件夹的批号应唯一。
Ødata.xml为归档文件属性信息的描述文件，详细见第4、5、6部分《案卷信息描述规范》《元数据描述规范》《电子原文描述规范》。
Øflag.txt为上传状态标记文件，归档接口使用此文件中的数据来判定FTP上传是否结束。
业务系统在完成上传后，应将此文件中的内容置为1.（0：
未结束；1：
上传已结束；2归档已正常结束；3归档已失败结束）。
4.1.2归档电子文件的文件夹结构
|-ArchiveData
|-20130328abc
|-2013032801efg
|-招标基础信息表.doc
|-审批记录.doc
|-中标通知书.doc
Ø其中“ArchiveData”为FTP的根目录。
Ø20130328abc为批号，由业务系统生成，数据长度不超过128.每个批次的归档文件夹的批号应唯一。
Ø2013032801efg为该文件夹下的文件对应的归档目录的主键。
Ø招标基础信息表.doc、审批记录.doc和中标通知书.doc为需要归档的电子文件，具体内容以实际情况为准。
4.2归档状态
归档状态的文件由本接口程序产生，业务人员可读取状态文件来确定文件是否已归档。
当完成上传后，档案系统的归档接口会以一定的时间间隔来轮询出来归档文件夹（轮询时间视配置而定），当接口程序开始处理归档文件时，会将结果输出到指定的结果文件夹中，如下面的文件结构：
|-Results
|-20130328abc.status.txt
|-20130328abc.error.txt
在结果文件夹中会以【批号】+“.status.txt”为文件名来生成状态文件，如果有错误信息会以【批号】+“.error.txt”为文件名来生成错误信息文件。
以下为状态文件的例子：
BatchNumber=20100701abc
BatchStatus=1
UpdateTime=2010年7月2日14:
23:
05
ØBatchNumber为此批处理的批号
ØBatchStatus为本批处理的状态（1：
已经上传至档案系统；2：
处理出错）
ØUpdateTime为此状态文件最后一次更新的时间
错误信息文件中以可读的字符串形式简要列出出错信息。
批次状态和归档文件状态关系说明：
当批次中所有的归档文件都已处于“已经归档”状态时，批次的状态为“已经上传至档案系统”。
归档成功后，回写该批次中flag.txt的标志：
2为归档成功，3位归档失败。
说明：
2.1中上传的归档文件是由业务系统接口产生的
2.2中的状态文件是由档案系统接口产生的。
4.3元数据描述规范
对于data.xml格式的定义由以下的例子来说明：
按件：
-------------------------根节点
OA节点--------------根节点下面的第一层节点名称
20100701abc--------批次号
A0001------------------案卷id
收文------------------文件类型（第二层节点名称）
admin------------------创建人
XX案卷------------------案卷题名
3------------------总份数
XX科------------------编制单位
XX标------------------主题词
2005------------------年度
备注信息------------------备注信息
OA------------------案卷来源，如OA、ERP、招标投标、合同
------------------设备位号
------------------项目代号
------------------子项代号
2------------------页数
王五------------------移交人
2005/2/13------------------移交时间
XX单位------------------责任人
......
-------------------------------行节点，元数据
A0001------------------案卷id
S0001------------------数据id
1------------------原文标志
admin------------------创建人id
系统管理员------------------创建人名
测试文件------------------文件题名
2005/2/13-------------------文件时间
XX科------------------编制单位
20130808----------------文件编号（合同号、招标编号、订单号等等）
6-------------------页数
OA-----------------------文件来源，如OA、ERP、招标投标、合同
2005-----------------------年度
永久-----------------------保管期限
公开-----------------------密级
主题词-----------------------主题词
王五------------------------移交人
2005/2/13------------------移交时间
3-------------------页次
4f-------------------阶段号
OA-1-------------------项目代号
测试单位-------------------归档单位（移交单位）
测试单位-------------------录制单位
-------------------录制时间
-------------------制式
-------------------底片类型
XX责任单位-------------------责任者。
请传递责任单位。
收文-----------------------文件类型（第二层节点名称）
备注信息-----------------------备注
----------------------每一个Entry代表一个归档文件
oa1489563355148882.pdf-----------------------电子名称
测试文件-----------------------显示名称
pdf-----------------------电子格式
20-----------------------电子大小
OA-----------------------电子来源
2-----------------------页数
oa1489563355148882-----------------------电子名称
admin-----------------------创建人
200-----------------------帧宽度（单位像素）
378-----------------------帧高度（单位像素）
00:
00:
15.09------------------时长
539kb/s-----------------总比特率（视频）
300dotsperinch-----------------------水平分辨率（图片）
300dotsperinch-----------------------垂直分辨率（图片）
NIKOND200-----------------------捕获设备（照相机型号）
25fps-----------------------帧速率
200-----------------------视频编码标准
aac（HE-AAC）（mp4a/0x6134706D）--------音频编码标准
47kb/s（default）-----------------------音频采样精度
44100Hz-----------------------音频采样率
fltp-----------------------音频采样精度
2-----------------------音频声道数（1单声道2立体声0无）
yuv420p-----------------------色彩空间
2010/9/179:
20:
51-----------------------摄影时间（图片）
1-----------------------原文排序
8F119D3CE2FD8CE409C51FFE065DB91B---------电子文件校验码
12stgyufwq23143141/0EDCEB2BF935E159482576D40009C1A4/评标报告.PDF-----------------------存放路径
......
-------------------------------行节点
......
XML文件实例如下：
注：
WJLY（文件来源）为必须字段，用于区分业务系统数据来源；WJLX（文件类型）为必须字段用于区分业务系统内的业务分类节点，便于数据分类显示。
非图片和音视频格式的文件无需写入蓝色标识信息
5档案数据交换标准接口运行过程描述
接口有手动执行和自动执行两种运行方式，手动执行需要人工点击执行按钮，接口会到ArchiveData文件夹遍历该文件夹下所有的flag.txt文件的内容，若flag.txt文件内容不为1，则跳过该文件夹，若flag.txt文件内容为1，则将该文件夹下的data.xml文件里的案卷数据、元数据数据和其对应的电子文件归档到档案系统，否则跳过该文件夹继续执行，直到所有文件夹遍历结束。
自动执行需要人工先设置接口轮询执行的间隔，然后点击执行启动程序，接口会到ArchiveData文件夹遍历该文件夹下所有的flag.txt文件的内容，若flag.txt文件内容不为1，则跳过该文件夹，若flag.txt文件内容为1，则将该文件夹下的data.xml文件里的数据和其对应的电子文件归档到档案系统,并写status.txt，如果失败跳过该文件夹并写status.txt和error.txt继续执行，直到所有文件夹遍历结束，当到达轮询时间，程序会再次执行归档操作。
归档时，除了写入data.xml中传递的值到数据库表中，还需设置系统默认值，YG_BZ_AJXX_MIDDEL设置SFSD默认为0；YG_BZ_YSJ_MIDDLE表中设置YLZSFL1默认为0，SFSD默认为0；YG_BZ_DZYW_MIDDLE表中设置SJBM为YG_BZ_YSJ_MIDDLE、CJSJ为当前时间、GLJ为flag.txt所在的路径（/结尾），CKCS查看次数默认为0。
说明：
保存期限和密级的可用值依赖于档案系统的设定，在档案系统部署后，会设定可用值。
业务系统接口可根据文件的保存期限和密级在XML文件中写入相应的值。
6XML标准案卷信息表字段列表
序号
中文字段名称
英文字段名称
约束性
可重复性
元素类型
数据类型
1.
案卷id
ajid
必选
不可重复
基本型
字符型
2.
文件类型（第二层节点名称）
wjlx
必选
可重复
基本型
字符型
3.
创建人
cjr
必选
可重复
基本型
字符型
4.
案卷题名
ajtm
必选
可重复
基本型
字符型
5.
总份数
zfs
可选
可重复
基本型
数字型
6.
编制单位
bzdw
可选
可重复
基本型
字符型
7.
主题词
ztc
可选
可重复
基本型
字符型
8.
年度
nd
可选
可重复
基本型
字符型
9.
备注
bzh
可选
可重复
基本型
字符型
10.
案卷来源，如OA、ERP、招标标、合同
ajly
可选
可重复
基本型
字符型
11.
设备位号
sbwh
可选
可重复
基本型
字符型
12.
项目代号
xmdh
可选
可重复
基本型
字符型
13.
子项代号
zxdh
可选
可重复
基本型
字符型
14.
总页数
ysh
可选
可重复
基本型
数字型
15.
移交人
jcr
可选
可重复
基本型
字符型
16.
移交时间
jcsj
可选
可重复
基本型
日期
17.
责任人
zrr
可选
可重复
基本型
字符型
18.
可选
可重复
基本型
数字型
7XML标准元数据表字段列表
序号
中文字段名称
英文字段名称
约束性
可重复性
元素类型
数据类型
1.
数据id
sjid
必选
不可重复
基本型
字符型
2.
电子原文标志（0无1有）
ywbz
必选
可重复
基本型
字符型
3.
创建人id
cjr
必选
可重复
基本型
字符型
4.
创建人名
cjrm
必选
可重复
基本型
字符型
5.
文件题名
wjtm
必选
可重复
基本型
字符型
6.
文件时间
wjsj
必选
可重复
基本型
日期
7.
编制单位
bzdw
可选
可重复
基本型
字符型
8.
文件编号
wjbh
可选
可重复
基本型
字符型
9.
页数
ysh
可选
可重复
基本型
数字型
10.
文件来源（OA/CAPP/AVIDM/ESE）
wjly
必选
可重复
基本型
字符型
11.
年度
nd
可选
可重复
基本型
字符型
12.
保管期限
bgqx
可选
可重复
基本型
字符型
13.
密级
mj
可选
可重复
基本型
字符型
14.
主题词
ztc
可选
可重复
基本型
字符型
15.
移交人
yjr
必选
可重复
基本型
字符型
16.
移交时间
yjsj
必选
可重复
基本型
日期
17.
页次
yc
可选
可重复
基本型
字符型
18.
阶段号
jdh
可选
可重复
基本型
字符型
19.
项目代号
xmdh
可选
可重复
基本型
字符型
20.
归档单位
gddw
可选
可重复
基本型
字符型
21.
录制单位
lzdw
可选
可重复
基本型
字符型
22.
录制时间
lzsj
可选
可重复
基本型
字符型
23.
制式
zhishi
可选
可重复
基本型
字符型
24.
底片类型
dplx
可选
可重复
基本型
字符型
25.
责任者
zrz
可选
可重复
基本型
字符型
26.
文件类型
wjlx
必选
可重复
基本型
字符型
27.
标准目录号
Bzmlh
可选
可重复
基本型
字符型
8XML标准电子原文表字段列表
序号
中文字段名称
英文字段名称
约束性
可重复性
元素类型
数据类型
1.
电子名称
dzmc
必选
不可重复
基本型
字符型
2.
显示名称
xshmc
必选
可重复
基本型
字符型
3.
电子格式
dzgs
必选
可重复
基本型
字符型
4.
电子大小
dzdx
必选
可重复
基本型
字符型
5.
电子来源
dzly
必选
可重复
基本型
字符型
6.
页数
ysh
可选
可重复
基本型
数字型
7.
原文id
（请使用：
系统名英文缩写或拼音+当前时间微秒数+6位随机数）
ywid
可选
可重复
基本型
字符型
8.
创建人
cjr
可选
可重复
基本型
字符型
9.
（帧）宽度（单位像素）
zkd
可选
可重复
基本型
字符型
10.
（帧）高度（单位像素）
zgd
可选
可重复
基本型
字符型
11.
时长
sc
可选
可重复
基本型
字符型
12.
总比特率（视频）
zbtl
可选
可重复
基本型
字符型
13.
水平分辨率（图片）
wdpi
可选
可重复
基本型
字符型
14.
垂直分辨率（图片）
hdpi
可选
可重复
基本型
字符型
15.
捕获设备（照相机型号）
bhsb
可选
可重复
基本型
字符型
16.
帧速率
zsl
可选
可重复
基本型
字符型
17.
视频编码标准
spbmbz
可选
可重复
基本型
字符型
18.
音频编码标准
ypbmbz
可选
可重复
基本型
字符型
19.
音频比特率
ypbtl
可选
可重复
基本型
字符型
20
升级会员 