CRM系统概要设计说明书

1、 武汉爱维特信息技术有限公司 概要设计说明书文档名称：crm系统概要设计说明书文档编号：iwit-wh-2009-0000-000归档日期：2009-编写者：薛旺审核者：批准者：修改记录修订日期作者修订内容备注*the information contained in this message is confidential and should not be disclosed to any third party whether or not you are the intended addressee indicated in the message.*本文件所含内容为保密信息，未经授权

2、请勿随意复制、编改和泄露给任何第三方。武汉爱维特 版 权 所 有copyright 2009 wuhan iwit., ltd . all rights reserved目录1. 引言11.1. 文档目的11.2. 背景11.3. 定义11.4. 参考资料12. 总体设计12.1. 系统功能描述1系统总体功能1子系统功能22.2. 系统性能要求92.3. 运行环境设计102.3.1 设备102.3.2 支持软件102.3.3 接口102.3.4 控制102.4. 设计约束、限制102.4.1编程规范112.4.2模块编号122.4.3模块命名规则132.4.4注释规范142.4.5 排版152

3、.5. 系统结构设计152.5.1整体结构图152.5.2 后台管理152.5.3 账户管理162.5.4 客户信息172.5.5 销售管理172.5.6 财务管理172.5.7 客户服务182.6. 公共模块设计182.7. 人工处理过程182.8. 尚未问决的问题183. 接口设计183.1. 用户接口183.2. 外部接口183.3. 内部接口184. 运行设计194.1. 运行模块组合194.2. 运行控制194.3. 运行时间195. 系统数据结构设计195.1. 逻辑结构设计195.2. 物理结构设计255.3. 数据结构与程序的关系256. 系统出错处理设计266.1. 出错信息

4、266.2. 补救措施266.3. 系统维护设计261. 引言1.1. 文档目的从该阶段开发正式进入软件的实际开发阶段，本阶段完成系统的大致设计并明确系统的数据结构与软件结构。在软件设计阶段主要是把一个软件需求转化为软件表示的过程，这种表示只是描绘出软件的总的概貌。本概要设计说明书的目的就是进一步细化软件设计阶段得出的软件总体概貌，把它加工成在程序细节上非常接近于源程序的软件表示。本文档的预期读者包括软件开发所有成员。1.2. 背景u 系统中文名：crm系统u 任务提出者：隆岩u 开发者：武汉爱维特开发团队u 用户：使用crm系统的全部用户1.3. 定义1.4. 参考资料编号文档标题版本号日期

5、参考章节1bs架构crm系统规划书全文2crm系统需求规格说明书全文2. 总体设计2.1. 系统功能描述整个系统主要包括后台管理、账户管理、客户管理、销售管理、财务管理、客户管理几个功能。系统总体功能 子系统功能2.1.1.1. 后台管理功能流程u 后台管理主要包括企业登记、收费登记、服务开通、企业数据维护、企业服务记录、短信提醒功能。u 后台管理数据流图2.1.1.2. 账户管理功能流程u 主要对企业用户帐号信息维护管理。主要有企业个人用户帐号信息修改、查看（其中只有对应的系统管理员才能对企业信息进行修改及删除）；企业角色组的建立及相应操作，系统管理员对企业用户角色组的建立、信息修改及删除等

6、相关操作；企业用户帐号的建立及相应操作，系统管理员对企业用户帐号的建立（在相应的角色组或直接建立用户）及删除、信息修改等相关操作；企业角色组权限的建立、修改、维护2.1.1.3. 客户信息管理流程u 客户信息管理主要包括对所有客户信息树的建立、联系人的管理。行政区划的管理：对行政区划的增删改查，注意添加行政区划节点需判断其父节点是否为根节点或行政区划节点并验证其节点的数量（需跨数据库查询）。单位管理：对单位的增删改查，注意添加单位节点需判断其父节点是否为行政区划节点并验证其节点的数量（需跨数据库查询）。部门管理：对部门的增删改查，注意添加部门节点需判断其父节点是否为单位节点并验证其节点的数量（

7、需跨数据库查询）。联系人管理：对联系人的增删改查，注意添加联系人的上级节点是否为单位或者部门；只有系统管理员才有删除联系人功能；要验证联系人的数量限制（需跨数据库查询）。u 客户信息管理流程图：u 联系人管理流程图u 客户信息数据流图2.1.1.4. 销售管理流程u 主要是对企业销售人员的管理，包括对具体客户的销售计划、销售总结、客户销售计划跟踪。u 销售计划流程图注意：可对此销售计划添加评语和添加计划的审核对象，并且只有该对象才可以加评语；提交前，可以新建和删除、修改，提交后不可以。u 跟踪记录流程图注意：添加对该记录的留言板，企业任何有效用户均可对此添加留言。u 销售工作总结流程图注意：销

8、售工作总结的状态，包括完成、未完成新加工作（无计划但有跟踪），如果未完成进行说明；提交前，可以新建和删除、修改，提交后不可以。2.1.1.5. 财务管理流程u 财务管理主要包括合同管理、供货管理、收款管理和发票管理。合同管理：管理客户的合同。注意添加用户合同的有效期。主要字段为：合同编号、客户名、签订日期、变更日期、我方经办人、项目名称、销售类型、销售名称、销售单价、销售数量、销售总额、付款方式、备注等信息。供货管理：对客户的供给货物的管理。注意欠款查询将以此为依据，而不在是合同，可填写合同单号为索引。主要字段为：客户、供货时间、供货金额，经办人。收款管理：对客户的收款记录进行管理。主要字段为

9、：新建时间、新建人、修改时间、修改人、总金额、回款金额、回款时间、回款百分比、到款单位、回款余额、下次回款的金额、时间、百分比、备注信息。发票管理：对客户的发票信息管理。主要字段为：发票的开据时间、修改时间、修改人、开据内容、开据金额、开据单位、发票号、经办人、是否作废、备注。u 财务管理数据流图2.1.1.6. 客服管理流程u 客服管理主要包括客服信息登记、客服登记、客服处理几个主要功能。u 客服管理流程图u 客服管理数据流图2.2. 系统性能要求 主要质量属性详细要求正确性数据的精确性：数据加载等功能必须精确，保证数据的准确性健壮性稳定可靠性可靠性能，效率查询速度：客户树的查询速度。处理速

10、度：保证跨数据库查询的效率。易用性人机界面友好，输入输出方便，检索查询简单快捷兼容性不影响手机的其它功能可移植性可移植到其它类型的手机且能正常运行2.3. 运行环境设计资讯平台v3系统的设计要求强调软件工程的标准化和可扩展性。同时考虑软件开发、运行和维护的成本以及系统的安全性等。具体硬件运行环境如下：l 服务器的配置：e54052/1g4/300g2/电源2。l 客户端的配置：一般pc机即可。具体软件运行环境如下：l 操作系统软件：windows 2003sp2 server。l 服务软件：基于windows 2003sp2 server的服务套件。l 数据库管理软件：sqlserver200

11、0。2.3.1 设备 终端类别机器名设备编号配置说明服务器端ibm x3650e54052/1g4/300g2/电源2客户端pc机一般pc机配置2.3.2 支持软件 pc端：windows xp以上操作系统server端：java运行环境，sqlserver2000数据库系统2.3.3 接口 本系统主要涉及到pc端、server端之间的跨数据库查询，基于客户树的一些功能扩展。2.3.4 控制 本软件平台运行在一般pc机普通配置即可。2.4. 设计约束、限制2.4.1编程规范2.4.1.1变量命名规范序号项目前缀备注1全局变量g global2实例变量iinstant3局部变量llocal2.4

12、.1.1.1数据变量类型序号项目前缀备注1布尔型bboolean2字符型cchar,character3日期型ddate4时间型ttime5日期时间型dtdatetime6双精度型dbdouble7整型iint,integer8长整型llong9实型rreal10字符串型sstring11无符号整型uiuint,unsignedint,unsignedinteger12无符号长整型ululong,unsignedlong13枚举型eenum2.4.1.1.2变量命名变量类别 + 数据类型变量/对象类型变量 + _ + 变量英文名。如：gs_username。2.4.1.2标识符命名规则2.4.

13、1.2.1全局使用的标识符l2.4.1.2.2变量l 同一个文件使用一种命名方式；变量可以加后缀表示类型l 禁止使用汉语拼音作为标识符；各种标识符避免使用缩写；程序中不要出现标识符完全相同的局部变量和全局变量。2.4.1.2.3常量2.4.1.3空格的使用规范l 紧跟括号的关键字用空格 如：while (true); 。l 空格位于参数列表中逗号的后面。l 运算符应与操作数之间用空格。l 强制转换类型后应用空格。l for语句中的表达式应用空格。2.4.1.4声明2.4.1.4.1变量的声明l 一行一个声明，这样写以利于写注释。如：int level; int size;l 不要将不同类型变量

14、的声明放在同一行。l 尽量减少全局变量的使用，多使用局部变量。l 类型转换和变量比较时注意变量的表示范围。2.4.1.4.2 初始化l 尽量在声明局部变量的同时初始化。唯一不这么做的理由是变量的初始值依赖于某些先前发生的计算。l 如果某变量不存在依赖关系，则在声明局部变量的同时进行初始化。2.4.1.4.3 布局只在代码块的开始处声明变量。（一个块是指任何被包含在大括号和中间的代码。）不要在首次用到该变量时才声明。否则会妨碍代码在该作用域内的可移植性。2.4.1.4.5类和接口的声明l 在方法名与其参数列表之前的左括号(间不要有空格。l 左大括号位于声明语句同行的末尾。l 右大括号另起一行，与

15、相应的声明语句对齐，除非是一个空语句，应紧跟在之后方法与方法之间以空行分隔。2.4.2模块编号编号模块（中/英）一级子模块（中/英）一级子模块编号b后台管理个人信息管理personal information managementb_p企业管理enterprise managementb_e等级管理level managementb_l服务管理service managementb_s角色管理management roleb_m权限管理rights managementb_r管理员管理administrator managementb_aa账户管理用户管理user managementa_u账

16、户查询account inquirya_i账户管理account managementa_a我的桌面my desktopa_mc客户信息客户信息管理customer informationc_i联系人管理contact managementc_cs销售管理销售计划sales plans_p记录跟踪track records_t工作总结job summarys_jf财务管理合同管理contract managementf_c供货管理supplier managementf_s回款管理cash managementf_c发票管理invoice managementf_ics客户服务客服服务cust

17、omer servicecs2.4.3模块命名规则2.4.3.1功能编号定义主模块编号+一级子模块编号+二级子模块编号+功能编号例如: mi01012.4.3.2模块过程，函数命名主模块编号+一级子模块编号+”_”+操作 + “_” + 操作对象ms_register_user2.4.4注释规范2.4.4.1所有源码文件的头部都应有注释所有源代码文件（.h, .hpp, .def, .inc, .c, .cpp等）的头部必须有注释，包括版权声明，作者，创建日期，版本，模块功能说明，修改历史记录等。格式如下：/* * file file description * description: ma

18、in function description* version:* creation date: * author xxx* copyright (c), 2009, iwit co., ltd. */2.4.4.2所有函数头部应有注释注释内容包括功能说明，参数类型，参数取值范围，函数的返回结果。格式如下：/* *function description. * param a an integer argument. * param s a constant character pointer. * return the test results */2.4.4.3对定义的变量（全局变量）、

19、结构应有注释要对结构的成员，枚举类型，变量做详细注释，包括作用，类型，取值范围等。单行注释应该跟在代码后面。使用/ 格式或者/* */格式。如下：enum info a, /* enum value a. */ b, /、:、.、等运算符前后，及&（取地址）、*（取值）等运算符之后不得有空格。2.5. 系统结构设计2.5.1整体结构图2.5.2 后台管理u 个人信息管理管理个人的信息，包括查看个人的登陆名、角色、邮箱、电话、备注信息并对除登录名以外的属性可进行修改。u 企业管理添加注册企业的信息，交费记录相关信息。主要对注册企业的等级、价格、状态等有效管理。u 服务管理企业的服务级别。u 等级

20、管理将企业分成若干个等级，然后对企业的各种等级进行管理，主要包括等级的名称、价格、u 管理员管理u 角色管理u 权限管理2.5.3 账户管理2.5.4 客户信息2.5.5 销售管理2.5.6 财务管理2.5.7 客户服务2.6. 公共模块设计说明本系统用到的公共模块的作用和使用方法。2.7. 人工处理过程说明在本软件系统的工作过程中不得不包含的人工处理过程（如果有的话）。2.8. 尚未问决的问题说明在概要设计过程中尚未解决而设计者认为在系统完成之前必须解决的各个问题。3. 接口设计总体说明外部用户、软、硬件接口；内部模块间接口（接口可以看作是系统界面）3.1. 用户接口说明将向用户提供的命令和

21、它们的语法结构，以及软件的回答信息。3.2. 外部接口说明本系统同外界的所有接口的安排包括软件与硬件之间的接口、本系统与各支持软件之间的接 口关系。3.3. 内部接口4. 运行设计4.1. 运行模块组合说明对系统施加不同的外界运行控制时所引起的各种不同的运行模块组合，说明每种运行所历经的内部模块和支持软件。4.2. 运行控制说明每一种外界的运行控制的方式方法和操作步骤。4.3. 运行时间说明每种运行模块组合将占用各种资源的时间。5. 系统数据结构设计5.1. 逻辑结构设计crm_account 账户信息表列名数据类型及字符长度可否为空(y/n)?备注a_idintn账户id（pk）a_name

22、varchar(20)n账户登录名a_pwdvarchar(50)n账户密码a_telvarchar(20)n账户电话a_mailvarchar(20)y账户邮箱ro_idinty账户所属角色（fk）a_remarkvarchar(20)y账户备注crm_role 账户角色表列名数据类型及字符长度可否为空(y/n)?备注ro_idintn角色id(pk)ro_namevarchar(20)n角色名称ro_remarkvarchar(100)n角色备注 crm_access账户权限表列名数据类型及字符长度可否为空(y/n)?备注ac_idint n账户权限编号（pk）ac_namevarchar

23、(20)n权限名ac_keyvarchar(50)n权限属性ac_valuevarchar(50)n权限值ac_remarkvarchar(100)权限备注crm_access 账户角色权限表列名数据类型及字符长度可否为空(y/n)?备注ra_idintn角色权限id（pk）ro_idintn角色id（fk1）ac_idintn权限id（fk2）crm_sales_comment 销售评论表列名数据类型及字符长度可否为空(y/n)?备注com_idint n销售评论id（pk）tra_idintn跟踪记录id（fk1）a_idint n账户id（fk2）com_contentvarchar(5

24、00)n评论内容crm_sales_check 审核表列名数据类型及字符长度可否为空(y/n)?备注chk_idint n审核id（pk）pl_idintn计划id（fk1）a_idint n账户id（fk2）chk_advicevarchar(500)y建议内容crm_sales_check 销售跟踪表列名数据类型及字符长度可否为空(y/n)?备注tra_idint n跟踪id（pk）pl_idintn计划id（fk）tra_dtimedatetimentra_titlevarcahr(100)ntra_contentvarcahr(5000)ntra_remarkvarcahr(100)y

25、crm_sales_plan 销售计划表列名数据类型及字符长度可否为空(y/n)?备注pl_idint n计划id（pk）a_idintn账户id（fk2）pl_namevarchar(50)n计划名称t_idintn针对的客户id（fk1）pl_starttimedatetimen计划起始时间pl_endtimedatetimen计划结束时间pl_contentvarchar(10)n计划内容pl_statusvarchar(10)y提交与否pl_remarkvarchar(10)y计划备注crm_sales_summary 销售总结表列名数据类型及字符长度可否为空(y/n)?备注summ_

26、idint n总结id（pk）pl_idintn所属的计划id（fk）summ_statusvarchar(20)n计划的状态summ_reasonvarchar(500)n原因summ_remarkvarchar(100)n备注crm_finan_contract 合同表列名数据类型及字符长度可否为空(y/n)?备注co_idint n合同id（fk1）t_idint n客户id（fk）co_bookdtimedatetimen签订日期co_modifydtimedatetimen变更日期co_authorvarchar(100)n经办人co_availabledatedatetimen有效

27、期co_moneyfloatn合同金额co_projnamevarchar(100)n项目名称co_codevarchar(50)n合同号co_salemoneyfloatn销售额co_paytypevarbinary(50)n付款方式co_branchvarchar(100)n所属分公司co_branpecfloaty分公司提成比例co_modulusfloaty业绩系数co_barnsumvarbinary(50)y分公司结算co_branpectypevarbinary(50)y分公司提成分配方式co_deptvarchar(100)y所属事业部co_yejivarchar(100)y销

28、售业绩co_rewardvarchar(100)y总部销售团队奖励co_remarkvarchar(100)y备注crm_finan_invoce 发票表列名数据类型及字符长度可否为空(y/n)?备注in_idint n发票管理id（pk）co_idintn合同id（fk）in_dtimedatetimen开具时间in_contentvarchar(100)n开具内容in_moneyfloatn金额in_codevarchar(50)n发票编号in_unitvarchar(50)n单位in_authorvarchar(20)n经办人in_availablevarchar(10)n是否作废in_

29、remarkvarchar(100)y备注crm_finan_continfo 合同信息表列名数据类型及字符长度可否为空(y/n)?备注ci_idint n合同内容的id（pk）co_idint n合同id（fk）ci_typevarchar(50)n销售类型ci_namevarchar(50)n名称ci_pricefloatn单价ci_amountintn数量ci_totalfloatn小计crm_finan_goods 供货表列名数据类型及字符长度可否为空(y/n)?备注gs_idint n供货id（pk）t_idint n客户id(fk2)gs_authorvarchar(50)n供货人

30、gs_dtimedatetimen时间gs_moneyfloatn金额crm_finan_fund 回款表列名数据类型及字符长度可否为空(y/n)?备注fn_idint n回款id（pk）co_idint n所属合同id（fk1）fn_dtimedatetimen回款时间fn_moneyfloatn金额fn_percentfloatn百分比fn_unitvarchar(50)n到款单位fn_leftmoneyfloatn回款余额fn_expectdtimedatetimey预计下次回款时间fn_exceptmoneyfloaty预计下次回款金额fn_exceptpercentfloaty预计下

31、次回款百分比fn_remarkvarchar(100)y备注crm_help_info 客服信息表列名数据类型及字符长度可否为空(y/n)?备注ifo_idintn客服记录id（pk）t_idintn客户（fk） ifo_namevarchar(20)n问题具体联系人 ifo_contactvarchar(50)n联系方式ifo_questionvarchar(5000)n反映问题ifo_answervarchar(5000)n解决方法ifo_slovevarchar(5)n解决与否ifo_submitvarchar(5)y提交与否ifo_receiveuservarchar(20)n问题接受

32、人ifo_receivedtimedatetimen接收日期ifo_submituservarchar(20)y提交受理人ifo_submitdtimedatetimey提交日期ifo_solvedtimedatetimey解决日期crm_help_memo 客服信息备忘录列名数据类型及字符长度可否为空(y/n)?备注mm_idint n客服备忘id（pk）t_idintn客户id(fk)mm_contentvarchar(5000)n备忘内容crm_cust_prov 客户信息_行政区划表列名数据类型及字符长度可否为空(y/n)?备注p_idint n行政区划编号（pk）t_idint n客

33、户id（fk2）p_leadervarchar(10)n负责人p_mobilevarchar(20)n手机号码p_telvarchar(20)n电话号码ar_idintn隶属区域编号p_addrvarchar(100)n地址p_marketvarchar(200)y市场描述p_remarkvarchar(200)y备注crm_cust_dept 客户信息_部门表列名数据类型及字符长度可否为空(y/n)?备注de_idintn部门编号（pk）t_idint n客户id（fk2）de_namevarchar(20)n部门名称lm_idintn联系人id（fk1）de_telvarchar(20)n

34、部门电话de_addrvarchar(100)n部门地址de_remarkvarchar(200)n备注crm_cust_linkman 客户信息_联系人表列名数据类型及字符长度可否为空(y/n)?备注lm_idintn联系人id（pk）lm_nameintn姓名lm_falgcodevarchar(20)n助记码lm_depttimevarchar(20)n部门lm_dutyvarchar(20)n职务lm_telvarchar(20)n电话lm_mobilevarchar(20)n手机lm_mailvarchar(20)n邮箱lm_othervarchar(20)y其他联系lm_sexva

35、rchar(5)n性别lm_jiguanvarchar(10)y籍贯lm_minzuvarchar(10)y民族lm_birthdatetimey生日lm_marriedvarchar(5)y婚否lm_hometelvarbinary(20)y家庭电话lm_homeaddrvarbinary(100)y家庭住址lm_interestvarchar(20)y兴趣爱好lm_backvarchar(200)y背景lm_remarkvarchar(200)y备注crm_cust_unit 客户信息_单位表列名数据类型及字符长度可否为空(y/n)?备注un_idintn单位id（pk）t_idintn客

36、户id（fk5）un_namevarchar(50)n单位名称ut_idintn单位类型id（fk1）up_idintn单位省份id（fk2）un_addrvarchar(100)n单位地址un_telvarchar(20)n电话un_postcodevarchar(10)n邮编un_faxvarchar(20)y传真un_webvarchar(100)n主页un_mailvarchar(50)y邮箱un_scalevarchar(20)y规模or_idinty客户来源（fk3）lm_idinty单位负责人（fk4）un_remarkvarchar(200)y备注crm_cust_area 客户信息_区域表列名数据类型及字符长度可否为空(y/n)?备注ar_idint