SuiteCRM模块与字段自定义

本文目录导读：

1. 模块自定义
2. 字段自定义
3. 视图布局自定义
4. 高级自定义
5. 代码自定义
6. 最佳实践
7. 常见问题解决

我来为你详细介绍SuiteCRM的模块与字段自定义方法。

模块自定义

Studio模块构建器

• 进入：管理员 → Studio
• 功能：创建新模块、修改现有模块
• 支持：标准模块和自定义模块

创建自定义模块

管理员 → Studio → 新建模块
步骤：
1. 定义模块名称（英文）
2. 设置显示标签（中文）
3. 选择模块类型
4. 配置字段
5. 设置布局

模块属性设置

• 审计日志：记录变更历史
• 复制操作：支持模块复制
• 导入导出：数据迁移功能
• 团队管理：权限控制
• 标签管理：高级搜索

字段自定义

字段类型

// 常用字段类型
- 文本字段 (varchar)
- 整数字段 (int)
- 浮点字段 (float)
- 日期字段 (date)
- 时间字段 (datetime)
- 下拉选择 (enum)
- 多选字段 (multienum)
- 关联字段 (relate)
- 货币字段 (currency)
- 文本区域 (text)
- 富文本 (html)

添加自定义字段

方法1：Studio界面

管理员 → Studio → 选择模块 → 字段 → 新建字段
配置项：
- 字段名称（系统名称）
- 显示标签（界面显示）
- 字段类型
- 是否必填
- 默认值
- 验证规则

方法2：数据库直接操作

ALTER TABLE suitecrm_accounts 
ADD COLUMN custom_field VARCHAR(255) DEFAULT NULL;

字段属性配置

// 验证规则
- required: 必填验证
- email: 邮箱格式
- url: URL格式
- numeric: 数字类型
- alphanumeric: 字母数字
- regex: 正则表达式
// 显示设置
- 列表视图显示
- 详情视图显示
- 编辑视图显示
- 搜索视图显示

视图布局自定义

模块布局编辑

管理员 → Studio → 选择模块 → 布局
布局类型：
- 列表视图 (ListView)
- 编辑视图 (EditView)
- 详情视图 (DetailView)
- 搜索视图 (SearchView)
- 快速创建 (QuickCreate)

自定义面板

// 创建字段分组
- 基本面板
- 高级面板
- 自定义面板
- 隐藏面板
// 面板属性
- 显示标签
- 折叠/展开
- 显示顺序
- 权限控制

高级自定义

关系字段设置

// 一对一关系
one_to_one:
  - accounts → contacts
// 一对多关系
one_to_many:
  - accounts -> contacts
// 多对多关系
many_to_many:
  - accounts -> opportunities

计算字段

// 公式字段
- 总和计算
- 条件判断
- 字符串拼接
- 日期计算
// 示例：订单总价
formula: $amount * $quantity

依赖字段

// 条件显示
if $status == "已关闭" then
  show $close_date
else
  hide $close_date

代码自定义

定义字段文件

// custom/Extension/modules/你的模块/Ext/Vardefs/
$dictionary['YourModule']['fields']['custom_field'] = array(
    'name' => 'custom_field',
    'vname' => 'LBL_CUSTOM_FIELD',
    'type' => 'varchar',
    'len' => '255',
    'audited' => true,
    'required' => false,
    'massupdate' => true,
    'comments' => '自定义字段说明'
);

语言包修改

// custom/Extension/modules/你的模块/Ext/Language/
$mod_strings['LBL_CUSTOM_FIELD'] = '自定义字段';
$mod_strings['LBL_CUSTOM_PANEL'] = '自定义面板';

逻辑钩子

// custom/modules/你的模块/logic_hooks.php
$hook_array['before_save'][] = array(
    1,
    '自定义逻辑',
    'custom/modules/你的模块/CustomLogic.php',
    'CustomLogic',
    'beforeSaveMethod'
);

最佳实践

命名规范

// 字段命名
- 使用小写字母
- 下划线分隔
- 前缀说明：custom_、ext_、user_
- 避免关键字
// 举例
- custom_field_name
- ext_order_number
- user_department_code

性能优化

// 索引建议
- 常用搜索字段建索引
- 关系字段建索引
- 避免过多自定义字段
// 缓存管理
- 修复快速修复
- 清除缓存
- 重建索引

备份策略

// 导出自定义包
管理员 → Studio → 导出 → 模块导出
// 备份文件
- custom/ 目录
- 数据库表 structure
- 语言文件
- 配置文件

常见问题解决

字段不显示

// 检查步骤
1. 修复Quick Repair
2. 清除缓存
3. 检查权限
4. 验证布局配置
5. 重新部署

数据类型错误

// 常见错误
- 字段类型不匹配
- 长度限制超标
- 字符集问题
- 索引冲突

模块冲突

// 解决方案
1. 检查模块命名冲突
2. 修改模块键值
3. 重新安装模块
4. 数据库修复

需要我详细解释某个具体的自定义方法或示例吗？