(中文)vtiger二次开发资料

vTigerCRM基于国际著名的开源软件SugarCRM开发。SugarCRM是国际CRM领域的后期之秀，总部位于美国加利福尼亚。它提供著名的开源软件SugarCRM开源版，所谓开源简单理解就是开放程序代码，采用开放式研发模式，免费提供用户使用的意思。与SugarCRM一样，vTigerCRM采用B/S架构，使用MySQL数据库，Appach网页发布服务器。它能满足国内许多中小型企业对于客户关系管理的入门级需求。核心模块比SugarCRM开源版略有增加， 包括： 1、客户 2、联系人 3、产品/价格 4、报价单 5、线索 6、机会 7、订单（采购订单和销售订单） 8、发票 9、统计报表 10、统计图表 11、日程 12、活动 13、服务台/知识库 14、电子邮件 15、RSS新闻聚合器 16、备忘录 ----------------------------------------- 这是vtigerCRM5.x 中文使用指南 ### vTiger CRM 二次开发概述 vTiger CRM 是一款基于开源软件 SugarCRM 开发的客户关系管理系统。SugarCRM 总部位于美国加利福尼亚州，以其强大的开源 CRM 解决方案闻名于世。vTiger CRM 采用了 B/S 架构，支持 MySQL 数据库及 Apache Web 服务器，这使得其能够很好地满足中小型企业的 CRM 需求。 ### vTiger CRM 核心模块解析 vTiger CRM 提供了一系列核心模块，以满足不同业务场景的需求： 1. **客户** - 管理客户基本信息，支持细分市场及客户分类。 2. **联系人** - 维护企业与个人之间的联系信息，便于后续沟通。 3. **产品/价格** - 记录产品信息及定价策略，支持复杂的产品配置。 4. **报价单** - 创建并管理报价，支持报价审批流程。 5. **线索** - 跟踪潜在客户，评估转化可能性。 6. **机会** - 管理销售机会，跟踪销售过程。 7. **订单（采购订单和销售订单）** - 处理内外部订单流程，支持订单跟踪及管理。 8. **发票** - 发布电子发票，支持自动催款及账期管理。 9. **统计报表** - 提供各种报表，支持数据驱动决策。 10. **统计图表** - 可视化数据分析，便于趋势分析及问题发现。 11. **日程** - 管理日常工作安排，支持日历同步。 12. **活动** - 记录及跟踪营销活动，评估活动效果。 13. **服务台/知识库** - 支持客户服务请求管理及知识分享。 14. **电子邮件** - 集成邮件系统，支持群发邮件及自动回复。 15. **RSS 新闻聚合器** - 聚合相关信息源，保持信息更新。 16. **备忘录** - 快速记录重要事项，支持提醒功能。 ### vtlib 库介绍 vtlib 是 vTiger CRM 的一个重要组成部分，主要用于简化新模块的开发。通过提供一系列 API 和工具，vtlib 帮助开发者快速创建或修改现有模块，从而扩展系统的功能。 #### vtlib 主要特点 - **API 支持**：提供用于创建或修改模块后端元素的 API，如数据库表结构、字段定义等。 - **模块管理器**：支持模块的打包、安装及卸载等功能，使得模块可以在不同的 vTiger CRM 安装之间共享。 - **模块类型**：支持多种类型的模块，包括实体模块、扩展模块和语言包。 ### vtlib API 快速参考 - **Vtiger_Module**：模块的基本类，提供模块创建、配置等功能。 - **name**：设置模块名称。 - **addBlock()**：向模块添加 UI 块。 - **addFilter()**：添加筛选条件。 - **initTables()**：初始化数据库表。 - **setRelatedList()**：设置相关列表。 - **setDefaultSharing()**：设置默认共享规则。 - **enableTools() / disableTools()**：启用/禁用模块工具。 - **save()**：保存模块配置。 - **addLink()**：添加自定义链接。 - **Vtiger_Menu**：管理模块菜单项。 - **addModule()**：添加模块到菜单。 - **Vtiger_Block**：定义 UI 块。 - **label**：设置块标签。 - **addField()**：添加字段。 - **Vtiger_Field**：定义字段属性。 - **table**：指定字段所在表。 - **column**：字段名称。 - **columntype**：字段类型。 - **uitype**：UI 类型。 - **typeofdata**：数据类型。 - **setHelpInfo()**：设置帮助信息。 - **setEntityIdentifier()**：设置实体标识符。 - **setPicklistValues()**：设置下拉列表值。 - **setRelatedModules()**：设置关联模块。 - **Vtiger_Filter**：定义筛选条件。 - **name**：筛选条件名称。 - **isdefault**：是否为默认筛选条件。 - **addField()**：添加字段。 - **addRule()**：添加筛选规则。 - **Vtiger_Event**：注册事件处理器。 - **register()**：注册事件。 ### 模块类型详解 - **实体模块**：创建实体记录，如客户、联系人等。提供 CRUD 视图。 - **扩展模块**：扩展实体模块功能，如仪表盘、报告等。 - **语言包**：为系统提供多语言支持。 ### 创建新实体模块步骤 1. **创建模块实例**：使用 Vtiger_Module 初始化模块。 2. **创建数据库表**：使用 initTables() 方法初始化数据库表。 3. **添加 UI 块**：使用 addBlock() 方法定义 UI 块。 4. **添加字段**：使用 addField() 方法定义字段，并将其关联到相应的块。 5. **设置实体标识符**：至少设置一个字段为实体标识符。 6. **创建默认筛选条件**：确保至少有一个名为“全部”的默认筛选条件。 7. **创建相关列表**：定义相关列表以展示更多相关信息。 8. **设置共享 ESS 规则**：定义共享规则以控制数据访问权限。 9. **设置模块工具选项**：启用/禁用模块工具，如导入/导出功能。 10. **创建模块目录和文件**：根据 vTiger CRM 的文件结构创建模块所需的目录和文件。 11. **包装模块**：使用模块管理器将模块打包为 ZIP 文件，以便安装。 ### 结论 通过以上介绍可以看出，vTiger CRM 不仅提供了丰富的核心功能模块，还通过 vtlib 提供了强大的二次开发能力。开发者可以利用 vtlib 的 API 和工具快速开发出符合特定业务需求的新模块，从而极大地扩展 vTiger CRM 的应用范围和价值。无论是中小企业还是大型企业，都能通过 vTiger CRM 的定制化功能实现高效的企业管理和客户关系维护。