《管理信息化系统设计规范》由会员分享，可在线阅读，更多相关《管理信息化系统设计规范（25页珍藏版）》请在金锄头文库上搜索。
1、系統設計規範V1.0C&D ERP ImplementationProject系统设计规范_v1.0.8Prepared by： LION TECHOLOGY CO.,LTD.Created Date：2010/02/11系统设计规范SignatureCompanys NameNameSignatureDate版本修订记录版本修订日期页数修订者修订说明1.0.02010/02/11Uni初版。1.0.12010/3/25Janny系统提示讯息规范补充1.0.22010/3/29Uni依据SD内部会议讨论结果修改,以深红色字底标注1.0.32010/03/30Uni依据SD,SA讨论结果修改,以
2、紫色字底标注1.0.42010/04/01Uni依据SD讨论结果修订,以分红色标注1.0.52010/4/20Hellen调整档案格式1.0.62010/4/29Janny增加删除方式说明及Session使用说明1.0.72010/4/30Janny系统讯息UI呈现模式1.0.82010/5/6Janny加入Ajax使用时机说明1.0.92010/5/11JannyDB Schema设计加入是否启用说明1.0.102010/5/13Janny与Rebo讨论后调整1.0.112010/5/20Janny系统编码原则补充增加程序开发时需参考的字段类型与长度说明1.0.122010/5/25Jann
3、y增加档案上传相关规范1.0.132010-5-27Hellen调整维护区下拉选单预设选项1.0.142010/6/18Hellen根据与Joan的确认结果补充针对币别字段的处理说明1.0.152010/6/25TonyData Log 处理机制说明1.0.162010/8/23Hellen将币别字段清单中的显示值有币别中文改为币别英文1.0.172010/9/4Lucifer规范统一调整1.0.182010-9-25Hellen根据SA回复，调整及补充规范文件，主要更新：Window.open开窗相关处理， datast栏位的查询限制，快选单失焦点的处理方式1.0.192010/10/7He
4、llen增加针对金额字段及对应有币别换算的金额字段长度说明.3.51.0.202010/10/8LuciferIframe页面需传入参数，查询去查询条件暂存1.0.212010-10-15Hellen增加13.5调用共享组件相关功能DB Schema开立规范1.0.222010-10-21Hellen根据与月琼确认规范进行补充：主要补充目录17,18：查询条件处理规范资料拥有者栏位处理方式说明1.0.232010-11-3Hellen根据Joan提供的删除按钮规范补充文件,对应目录11.91.0.242010-11-12Hellen根据月琼寄出规范进行补充英文名称栏位检核规则，对应目录11.1
5、01.0.252010-12-6Hellen根据月琼寄出规范进行补充针对查询条件日期及天数区间的检核规范，对应目录11.111.0.262011-1-4Hellen根据月琼寄出规范进行补充针对系统自行异动或存档的功能，系统参数存值规范1.0.272011/1/5Hellen变更系统参数规范存值目录1命名原則及規範81.1檔檔案命名原則81.2程式檔案命名原則81.3方法(Method)名稱命名原則 (動作+形容)91.4欄位變數及常數命名原則91.5專案自訂控制項命名原則(UserControl)91.6按鈕類型的控制項命名(Xxx :目標名稱)92編碼原則102.1介面文字編碼原則(UTF-
6、8)102.2語系檔編碼規則請參照語系檔編碼規劃 v1.1.xls。103資料格式顯示及輸入規範103.1代碼類型的資料若需將代碼一併顯示:103.2日期資料103.3時間資料113.4數位資料113.5金額欄位113.6下拉選單123.7快選單123.7.1在查詢欄位輸入代碼，當onblur時，系統自動查詢代碼後，帶回其對應的名稱在所要顯示的位置。123.7.2由使用者自行點選彈跳視窗進行查詢。123.7.3查詢欄位不允許輸入，使用者只能點選彈跳視窗進行查詢。133.7.4如SA另有特別要求，請參照SA特別方式處理。133.7.5可输入方案，失焦点时处理方式：133.7.5.1離開焦點時，則
7、把欄位內的值進行查詢。133.7.5.2查詢結果133.7.5.2.1查詢結果有一筆時，則帶回查詢結果的值。133.7.5.2.2查詢結果有多筆時，則不彈跳視窗，也不帶回值。133.7.5.2.3查詢結果為0筆時，則彈跳視窗。133.8默認值問題：13頁面欄位的默認值由SA進行提供，若有檢核區間，則默認值取區間內最小值。非輸入型默認值若SA沒有說明則默認第一個選項。134資料檢核驗證規範134.1Client端資料檢核135訊息提示規範145.1檢核驗證訊息145.2一般訊息提示規範145.3Confirm提示訊息規範156系統訊息UI呈現模式156.1系統訊息157多語系處理規範158Log
8、處理規範159異常處理16異常部分應在BusinessRule層調用，拋出異常後，在BasePage捕捉到異常判斷，程式異常跳轉Error頁面，業務異常彈出提示框，用戶點選後返回異常之前的狀態。發生異常時系統呈現給user的錯誤畫面如下: 17異常處理判斷部分，由Master母版頁對AJAX請求處理。如下圖：17異常處理判斷部分，由BasePage請求處理。如下圖：1710多資料庫支援18系統只支援LOG，報表功能劃分出去作為單獨的資料庫。18每添加一台資料庫，需添加一個NHibernate配置檔。同時需在NHibernateISessionFactory.cs（如下圖一）中添加一個靜態的二級
9、緩存（如下圖二），及資料庫篩選（如圖三）。18圖一18圖二19圖三19現提供DataLog、ErrorLog、報表功能使用的NHibernate配置文檔，均從Web.config中設置。如下圖：1911共通性規範2011.1英文字母存入資料庫時的處理方式2011.2Table間的Join方式2011.3Ajax使用時機2011.4刪除方式2011.5查询方式2011.6Session說明與使用2011.7欄位類型與長度2111.8Window.open开窗相关处理方式2111.8.1关闭弹出窗口，父页面是否要刷新:2111.8.2父页面处于编辑状态，关闭弹出窗口，是否要刷新？2111.8.3子
10、窗体未关闭，父页面关闭了，怎么处理？2111.9子页签删除按钮状态控制2211.10英文名称栏位检核规则2211.11查询条件，区间栏位检核规范2212檔案上傳及命名規範2212.1Web.Config設定2212.2上傳路徑2212.3資料夾命名2212.4檔案命名2213DB Schema設計規範2214SD檔撰寫細則2315Iframe页面需传入参数23传入参数值SD文件中应注明。2316查询区查询条件暂存2417查询条件处理规范2418资料拥有者栏位处理方式说明24檔目的本文之目的在说明系统整体共通性的相关设计规范，包含设计上的各种命名、编码原则、以及与使用者接口的标准化、操作接口的一
11、致化等相关的设计规范等。为使系统的开发能够有标准及设计良好的产出，举凡与系统整体性相关的各种主题，皆应制定良好的设计规范加以约束。1 命名原则及规范本章节说明项目中所有与命名相关的各种原则及规范。举凡于项目中跟命名有关的主题，将一律收录于本章节中进行说明。1.1 档档案命名原则项目中的档命名原则：档案类型_系统模块+模块代码+功能代码+”_”+主Table.例如:URS_PUB0101_CodeListManagement.docSRS_PUB0101_CodeListManagement.docSDS_PUB0101_CodeListManagement.doc1.2 程序档案命名原则1.2
12、.1 WebForm的aspx程序命名原则为：依系统目录文件3层定义，为系统模块代码 + 模块代码+ 功能代码。1.2.1.1 系统模块代码以英文缩写命名(共享模块用COM)1.2.1.2 模块代码以两码数字命名1.2.1.3 功能代码1.2.1.3.1 Menu上的菜单单，以两码数字命名1.2.1.3.2 若该功能存在子程序，则后面追加”-两码数字”1.2.1.3.3 例如:Base0101.aspx - BaseCustomerSearchBase0101-01.aspx - BaseCustomerSearchDetail共享程序的程序代码命名依该只程序的操作功能给予一个有意义的名称进行
13、命名。1.3 方法(Method)名称命名原则 (动作+形容)1.3.1 若方法执行的操作属于数据库的存取时1.3.1.1 查询操作SearchXXX1.3.1.2 新增操作InsertXXX1.3.1.3 修改操作ModifyXXX1.3.1.4 删除操作DeleteXXX1.3.1.5 格式操作：FormatXXX (日期 / 金额千分位)1.3.1.6 数据转换操作：ConvertXXX (币别转换)1.3.1.7 取得资料操作：GetXXX1.3.1.8 设定数据操作：SetXXX1.3.1.9 验证操作：CheckXXX1.3.2 若方法执行的操作属于业务逻辑性的判断、检核、等其它处理时，请参考程序开发规范（.NET）1.4 字段变量及常数命名原则于程序撰写中针对变量（或常数、属性等）进行命名时，请依以下原则命名：1.4.1 遵循程序开发规范(.NET)的约定。1.4.2 依该控件所对应的DB字段名称进行命名。1.5 项目自订控件命名原则(UserControl)依SD定义命名,要有含义1.6 按钮类型的控件命名(Xxx :目标名称)按钮名称命名原则(前缀前缀)
