配置管理工具使用说明手册

RD-SWORD-PUB-STA-V5.0

文件编号：

文件编号：RD-SWORD-PUB-STA-V5.0配置管理工具使用说明

当前版本号SWORDV5.0

最初发布日期

最新修订日期

审核者日期

批准者日期

中国软件与技术服务股份有限公司

修订记录

日期版本修订内容说明作者SWORDV5.0

目录

1.系统设计概述 (1)

(11)

1.1.系统描述....................................................................................................................

(11)

1.2.系统功能....................................................................................................................

2.工具使用 (2)

2.1.登录访问....................................................................................................................

(22)

2.2.SQL配置管理 (3)

(55)

2.3.异常配置管理............................................................................................................

(77)

2.4.权限管理....................................................................................................................

1.系统设计概述

1.1.系统描述

开发人员开发相关业务代码时通常需要关注两个配置文件：sql

sql-*-*-*.xml .xml 和exception exception-*-*-*.properties .properties 。这两个配置文件中维护了程序中所需的sql 信息和异常配置信

息。

配置文件管理工具主要是对这两个配置文件中的数据进行结构化管理。方便对大量SQL 和异常信息的维护工作。

通过该工具，开发人员可以录入修改相关sql 和异常配置信息；导出所需的配置文件；配置管理人员可以导出相应的配置文件进行集成发布。

通过异常码生成规则，可以规范异常码的使用，避免私自生成无规律的异常码。

SQL 配置文件组成：sqlKey 、sql 、tablenames 。异常配置文件组成：exceptionCode(异常码):description

1.2.系统功能

1、SQL 配置信息

2、异常配置信息

3、权限管理

2.工具使用

2.1.登录访问

管理员登录后的菜单比普通用户菜单多了一项“权限管理”，提供最简单的人员和所属组的权限维护功能。

2.2.SQL配置管理

对SQL配置信息，进行分类查询、新增、修改、删除、导出的功能。文件可以根据查询结果导出，并可直接在应用程序中部署。

保存信息中带有版本信息，标识为第几次修改，每次修改加1。

同时支持多个分支的管理，在查询和保存信息中可以选择需要的分支信息。用来支持多个分支并行开发的需要。

后台提供导出接口，可根据查询条件导出指定SQL配置文件。

点击SQL配置管理菜单，如图所示：

点击【新增】按钮或者sqlKey链接就可以进入SQL配置的新增和修改页面。

注意：在保存时会对【表名列表】选项进行校验，校验规则为，该表名需要在上面录入的SQ

SQL L 语句中出现，多个表名用逗号分隔，在填写时请注意中英文全角半角字符的输入。

2.3.异常配置管理

对异常配置信息，进行分类查询、新增、修改、删除、导出的功能。文件可以更具查询结果导出，并可直接在应用程序中部署。

保存信息中带有版本信息，标识为第几次修改，每次修改加1。

后台提供导出接口，可根据查询条件导出指定异常配置文件。

点击【新增】按钮或者异常Key链接时，会弹出异常信息新增修改页面。

异常码根据一定规范生成，格式如下：

系统类别+功能分类+异常类型+用例编号+顺序号

举例：核心征管（101）+优惠域（06）+系统用例（1）+业务用例（0008）+顺序号（012）

1010610008012

系统类别、功能分类、异常类型需要在后台维护管理，如果有变动或者新增需要联系管理员进行配置。

新增页面，如图所示：

修改页面，如图所示：

注意：由于已经生成异常Key，为了不影响已经使用的异常信息，所以异常异常信息保存后只能修改异常描述或者直接删除。

2.4.权限管理

1、业务组管理

业务组管理用来维护工具中的开发业务组或者分类，是业务分类的最小单元。

点击“业务组管理”菜单，进入业务组管理页面，如图所示：

新增分组，点击列表最下方的【新增分组】按钮，弹出新增分组信息页面。

在这里除了可以保存业务组信息之外，还可以选择组下维护人员的信息。支持一个人同属于多个组。

2、用户管理

点击“用户管理”菜单，进入用户管理信息管理页面。

展示列表中会列出当前系统中所有用户的信息。

新增用户

点击列表最下方的【新增用户】按钮，会弹出新增用户页面。

该页面中需要维护最基本的帐号信息，以及角色信息，现在系统支持三个角色，管理员、组员和组长。

持久层组件说明

中国软件与技术服务股份有限公司