開源 CRM 系統 SplendidCRM 二次開發全流程指南

前言

SplendidCRM 是 .NET 平台優秀的開源 CRM 系統，但中文二次開發資料稀缺。本文結合官方文檔與實戰經驗，以「新增模組」為例，系統梳理資料庫、存儲過程、視圖、中繼資料、UI 控件的完整開發步驟。

一、 資料庫表結構規範

主表（模組表）必要欄位

• ID (PK)、DELETED、CREATED_BY、DATE_ENTERED、MODIFIED_USER_ID、DATE_MODIFIED、ASSIGNED_USER_ID、TEAM_ID

自訂欄位表（_cstm 後綴）

• ID_C (PK) 對應主表 ID，擴充使用者自訂欄位。

多對多關係表

• 依命名慣例建立關聯表，支援多對多導航。

二、 存儲過程建立與代碼生成

1. 建立 sp模組名_Update、sp模組名_Delete。
2. 執行 _devtools/procedures.aspx 自動生成 SqlProc.cs。
3. 覆蓋 _code/DbLevel/SqlProc.cs。

三、 視圖建立（最少三個）

• 核心視圖（基礎查詢）。
• vw模組名_List：列表頁資料源。
• vw模組名_Edit：編輯/詳情頁資料源。
• 命名慣例：vw 開頭。

四、 註冊模組：spMODULES_InsertOnly

exec spMODULES_InsertOnly 
  @MODIFIED_USER_ID=..., @MODULE_NAME='NewModule', @DISPLAY_NAME='新模組',
  @RELATIVE_PATH='NewModule', @MODULE_ENABLED=1, @TAB_ENABLED=1, @TAB_ORDER=10,
  @PORTAL_ENABLED=0, @CUSTOM_ENABLED=1, @REPORT_ENABLED=1, @IMPORT_ENABLED=1,
  @IS_ADMIN=0, @TABLE_NAME='NewModule'

亦可透過「系統管理 → 工作室 → 配置模組」UI 設定。

五、 建立快捷方式：spSHORTCUTS_InsertOnly

exec spSHORTCUTS_InsertOnly 
  @MODIFIED_USER_ID=..., @MODULE_NAME='NewModule', @DISPLAY_NAME='新模組',
  @RELATIVE_PATH='NewModule/ListView.aspx', @IMAGE_NAME='icon.png',
  @SHORTCUT_ENABLED=1, @SHORTCUT_ORDER=1, @SHORTCUT_MODULE='NewModule',
  @SHORTCUT_ACLTYPE='Module'

六、 動態按鈕：spDYNAMIC_BUTTONS_CopyDefault

exec spDYNAMIC_BUTTONS_CopyDefault '.EditView', 'NewModule.EditView', 'NewModule';
exec spDYNAMIC_BUTTONS_CopyDefault '.DetailView', 'NewModule.DetailView', 'NewModule';

七、 列表欄位配置（GRIDVIEWS 系列）

1. 執行 spGRIDVIEWS_InsertOnly 建立列表主記錄。
2. 透過「系統管理 → 頁面佈局 → 網格佈局」UI 配置欄位（Bound、Date、List、HyperLink 等類型）。

八、 詳情欄位配置（DETAILVIEWS 系列）

1. 執行 spDETAILVIEWS_InsertOnly 建立詳情主記錄。
2. 「系統管理 → 頁面佈局 → 詳情佈局」配置欄位（Blank、Bound、Button、CheckBox、HyperLink 等）。

九、 編輯欄位配置（EDITVIEWS 系列）

1. 執行 spEDITVIEWS_InsertOnly 建立編輯主記錄。
2. 「系統管理 → 頁面佈局 → 編輯佈局」配置欄位。

十、 UI 控件專案建立

1. 在網站目錄下建立模組資料夾，複製相似模組檔案。
2. 重命名命名空間、檔案名、類別名。
3. 核心控件：ListView.ascx、DetailView.ascx、EditView.ascx、NewRecord.ascx、MassUpdate.ascx。
4. 修改 .ascx.cs 中 InitializeComponent、Page_Load、Page_Command 對應邏輯。

結語

SplendidCRM 採「資料庫優先、中繼資料驅動、UI 後綁」架構。二次開發核心在於：規範建表 → 存儲過程代碼生成 → 視圖定義 → 中繼資料註冊（模組/快捷方式/按鈕/列表/詳情/編輯） → UI 控件適配。熟悉此流程可高效擴充業務模組。