JT-T-1020-2016交通信息系统数据字典编制规范

Ⅲ/—本标准由交通运输信息通信及导航标准化技术委员会提出并归口ꎮ本标准起草单位:长安大学、交通运输部公路科学研究院、北京中交国通智能交通系统技术有限公司ꎮⅣ数据是信息系统核心价值的重要组成部分,软件文档是对数据进行正确理解的主要参考资料。《计算机软件文档编制规范》(GB/T8567)是软件文档编制的主要参考标准,但该规范主要用于系统的开发和维护服务,未对数据字典的内容和格式进行详细规定。为便于实现交通运输行业信息系统之间的互联互通和数据共享,特制定本标准,通过对交通运输信息系统数据字典的内容和格式进行统一规定,保证数据字典的编制质量,同时,也便于利用自动化工具对交通运输信息系统的数据字典进行处理。1JT/T1020—2016交通运输信息系统数据字典编制规范本标准规定了交通运输信息系统数据字典的内容、域含义及填写要求ꎬ以及数据字典文档编制要求ꎮ本标准适用于以共享交换为目的的交通运输信息系统数据字典文档的编制ꎮ2规范性引用文件下列文件对于本文件的应用是必不可少的ꎮ凡是注日期的引用文件ꎬ仅注日期的版本适用于本文件ꎮ凡是不注日期的引用文件ꎬ其最新版本(包括所有的修改单)适用于本文件ꎮGB/T2260中华人民共和国行政区划代码GB/T8567—2006计算机软件文档编制规范JT/T1058交通运输信息系统数据库字段命名及属性定义3术语和定义信息系统数据字典informationsystemdatadictionary在信息系统开发过程中ꎬ存储数据的含义、来源、组织方式、用途、格式以及和其他数据的关系等信息的文档ꎮ通常包括数据项的说明、数据结构、数据流、数据存储、处理过程等内容ꎮ交通运输信息系统数据字典datadictionaryfortransportationinformationsystem交通运输信息系统的数据字典ꎮ本标准中特指交通运输信息系统数据库的数据字典ꎮ数据项dataitem数据字典中具有独立含义的最小数据单位ꎮ4编制总则交通运输信息系统数据字典编制应遵循以下原则:a)参考标准ꎬ制定有据ꎮ在编制过程中ꎬ数据项的定义需遵守国家和交通运输行业相关数据标准ꎬ包括数据元、数据字典、代码和编码标准等ꎻb)切合实际ꎬ简洁实用ꎮ数据字典的编制应站在系统开发和维护角度、共享和交换角度进行编c)及时更新ꎬ保证一致ꎮ若系统需求和设计发生变更ꎬ应及时更新数据字典ꎬ保证数据字典和最终实现的一致性ꎮ2JT/T1020—20165数据字典内容、域含义及填写要求5.1.1交通运输信息系统数据字典的内容应包括:a)数据字典基本信息ꎻb)数据库基本信息ꎻc)数据表清单ꎻd)数据表结构定义ꎮ5.1.2交通运输信息系统数据字典的内容宜包括:a)值域代码清单表ꎻc)用户自定义代码表ꎮ5.2数据字典基本信息域含义及填写要求交通运输信息系统数据字典基本信息中需要填写的各域含义及填写要求见表1ꎮ表1数据字典基本信息域含义及填写要求序号域名名称数据类型格式必填项备注1DictDate编写日期YYYYMMDD是数据字典编写日期2DictAuthor编写人字符型文本是数据字典编写人姓名ꎬ用逗号分隔3DictCheckDate审核日期YYYYMMDD是审核日期4DictChecker审核人字符型文本是数据字典审核人姓名5DictVersion版本字符型文本是数据字典版本号ꎬ例如v3.16DictCont内容描述文本型文本否对编写或变更内容的简要描述注:YYYYMMDD是由8位数字组成的字符串ꎬ其中YYYY代表年份ꎬMM代表月份ꎬDD代表日期ꎮ5.3数据库基本信息域含义及填写要求交通运输信息系统数据库基本信息中需要填写的各域含义及填写要求见表2ꎮ表2数据库基本信息域含义及填写要求序号域名名称数据类型格式必填项备注1DBName数据库名称字符型文本是数据库的名称2DBDescription数据库中文说明字符型文本是数据库的中文简要说明3DBNumber数据库编号字符型an10是图14DBMSType数据库管理系统类型代码字符型文本是数据库管理系统的类型代码ꎬ见表33JT/T1020—2016表2(续)序号域名名称数据类型格式必填项备注5DBMSVersion数据库管理系统版本字符型文本是数据库管理系统的版本6ProjName建设项目名称字符型文本是数据库所属的建设项目名称7AppSystem系统名称字符型文本否数据库所属的信息系统的名称8DevpComp开发单位字符型文本否设计和开发单位的名称9ConsComp建设单位字符型文本否数据库的建设单位ManaComp管理维护单位字符型文本否数据库管理和维护单位SurpComp监理单位字符型文本否数据库的监理单位注:a)数据库使用单位所属省份代码按照GB/T2260的规定ꎬ取6位行政区划代码ꎻb)数据库所属业务领域代码按照JT/T1058给出的业务领域缩写规则ꎬ用两位字符表示ꎻc)数据库管理系统类型代码如表3所示ꎬ用两位数字表示ꎻd)数据库顺序号ꎬ由各省(自治区、直辖市)交通运输科技部门或信息化主管部门给出ꎬ用两位数字ꎮ图1数据库编号规则表3数据库管理系统类型代码代码数据库管理系统备注Oracle用户可以使用类型代码80~99自行扩充MicrosoftSQLServerDB2SybaseMySQLInformixKingBaseOpenBase……5.4数据表清单域含义及填写要求交通运输信息系统数据库数据表清单需要填写的各域含义及填写要求见表4ꎮ４/—表４数据表清单域含义及填写要求序号域名名称数据类型格式必填项备注１数据库名称字符型文本是数据库的英文名称２数据表名称字符型文本是数据表的英文名称３中文名称字符型文本是数据表的中文含义４功能介绍文本型文本是数据表的功能简介５是否共享交换布尔型否初步设计文件规定的该数据６参照标准名称字符型标准编号否字段参照的主要标准名称７触发器描述文本型文本否多个触发器的集中描述８索引描述文本型文本否多索引的集中描述交通运输信息系统数据表结构定义需要填写的各域含义及填写要求见表５ꎮ表５数据表结构定义域含义及填写要求序号域名名称数据类型格式必填项备注１数据表名称字符型文本是字段所属数据表的英文名称２字段名字符型文本是字段的中文或英文名称的字母拼接３中文名称文本型文本是字段的中文描述４字段类型字符型文本是字段的数据类型ꎬ包括格式ꎬ例如()５值域文本型文本否字段的值域６单位字符型文本否字段的单位７是否共享交换项布尔型否初步设计文件中规定的用途ꎬ８参照标准数据项编号字符型位的数字和英文否对该字段进行规定的标准项编号９是否可以为空布尔型否主键布尔型否外键布尔型否外键表名称字符型文本否外键关联的数据表名称默认值文本型文本否字段的默认值备注文本型文本否字段的备注5JT/T1020—20165.6值域代码清单表域含义及填写要求交通运输信息系统值域代码清单表需要填写的各域含义及填写要求见表6ꎮ表6值域代码清单表域含义及填写要求序号域名名称数据类型格式必填项备注1CodeName代码名称字符型文本是代码的名称2CodeMark代码标识字符型文本是代码的标识3CodeReference代码所在标准文本型标准号是代码引用的标准号4CodeList代码列表文本型文本是代码及其代表数据内容的详细列表5.7用户自定义数据类型域含义及填写要求交通运输信息系统用户自定义数据类型需要填写的各域含义及填写要求见表7ꎮ表7用户自定义数据类型域含义及填写要求序号域名名称数据类型格式必填项备注1UDTypeName数据类型名称字符型an..30是数据库中的存储名称2UDCName数据类型中文名称字符型文本是中文名称3UDDescription数据类型描述文本型文本是数据类型的详细描述4UDLength长度数值型是字节数5.8用户自定义代码表域含义及填写要求交通运输信息系统用户自定义代码表需要填写的各域含义及填写要求见表8ꎮ表8用户自定义代码表域含义及填写要求序号域名名称数据类型格式必填项备注1Code代码名称字符型文本是代码对应的名称2CodeObject中文名称字符型文本是代码的所指代对象的中文名称3CodeMark代码表标识字符型文本是识别代码的唯一标识4CodeUnit计量单位字符型文本否代码的计量单位5CodeMethod编码方法字符型文本否代码编码方法的详细说明6CodeRegExpr编码的正则表达式文本型文本否编码的正则表达式7CodeExp代码说明文本型文本否代码的详细含义及附加说明8CodeCont代码值字符型文本是定义代码名称的取值9CodeIndex代码序号字符型文本否代码的排序序号6JT/T1020—20166数据字典文档编制要求数据字典文档应单独成册ꎮ每个数据库实例形成一个数据字典文档ꎮ其他与开发和维护相关的数据字典内容ꎬ例如存储过程、视图等ꎬ用户应按照GB/T8567的要求进行编制ꎮ6.2文档存储格式数据字典文档电子版宜使用“.doc”、“.docx”、“.WPS”、“.xls”以及“.xlsx”等通用格式存储ꎮ6.3文档样例及编辑说明数据字典文档样例参见附录Aꎮ编辑说明如下:a)所有表格行数和列数不限ꎬ用户可自行增加ꎮ但为了便于自动化处理ꎬ增加列时ꎬ应在现有列后增加ꎬ不应在现有列中插入ꎻb)附录中的斜体字在实际数据字典编写时应进行替换ꎻc)数据字典中的字体和字号用户可根据习惯进行设置ꎻd)用户在数据字典文档编制时可根据需要插入相应的内容ꎮ7JT/T1020—2016附录A(资料性附录)交通运输信息系统数据字典文档样例A.1数据字典文档封面样例数据字典文档封面的样例ꎬ见图A.1ꎮ图A.1数据字典文档封面样例8JT/T1020—2016A.2数据字典基本信息表样例数据字典基本信息表的样例ꎬ见表A.1ꎮ表A.1数据字典基本信息表编写日期编写人审核日期审核人状态YYYYMMDD×××YYYYMMDD×××初稿变更或编写内容的简要说明2.0……终稿A.3数据字典目录样例数据字典目录样例ꎬ见图A.2ꎮ1××××××××××××××× 11.1××××××××××××××××××××××××××××××××××××××××××××× 11.2××××××××××××××××××××××××××××××××××××××××××××× 22××××××××××××××× 3……图A.2数据字典目录样例A.4数据字典正文样例A.4.1数据库基本信息数据库基本信息样例ꎬ见表A.2ꎮ表A.2数据库基本信息表数据库基本信息表数据库名称Data__lib数据库中文说明××省道路运政信息数据库数据库编号SXDY010001数据库管理系统类型Oracle数据库管理系统版本11g建设项目名称示范工程系统名称×××管理系统开发单位×××软件公司建设单位×××省交通信息中心管理维护单位×××省信息化处监理单位×××A.4.2数据表清单数据表清单样例ꎬ见表A.3ꎮ９/—数据库名称(××省道路运政信息数据库)序号数据表名称中文名称功能介绍是否共享交换参照标准名称触发器描述索引描述１经营业户表存储××省所有道路运输经营业户基本信息的表是路运输信息基础数据元２车辆表存储××省所有货运车辆基础信息的表否路运输信息基础数据元……序号数据类型名称数据类型中文名称长度数据类型描述１管理人员类型长度为的数字和长度为的字符２管理机构类型两个长度为的字符数据……数据表名称序号字段名名称字段类型值域单位是否共享交换项参照标准数据项编号是否可以为空主键外键外键表名称默认值备注１管理机构名称()０１０管理范围２管理机构状态(１)０００……数据表名称序号字段名名称字段类型值域单位是否共享交换项参照标准数据项编号是否可以为空主键外键外键表名称默认值备注１２…/—序号代码名称代码标识代码所在