logo

RedmineKanban

Login
最後更新: 2026/11/18

文档:ClientDesk

ClientDesk 是面向 Redmine 的 CRM 插件。它在项目中管理客户、交易和产品,将请求关联到联系人,并在无需单独 CRM 的情况下处理邮件。

CRM 界面在 Redmine 页面内打开。打开的客户、交易或产品会保留在页面 URL 中,因此您可以刷新链接或与同事共享。


主要功能

向 Redmine 添加的内容

  • 项目模块“ClientDesk” 以及项目菜单项 ClientDesk。
  • 顶部菜单与应用程序菜单。 ClientDesk 项可单独启用。它会打开所有可访问项目中的 CRM。
  • 管理菜单。 ClientDesk 项打开插件设置。
  • Issue。 联系人字段、侧栏中的客户卡片、回复客户、模板、评分与 AI 建议。
  • Issue 列表。 针对联系人、公司、渠道、响应时间、回复时间、解决时间与评分的额外列和筛选器。
  • Redmine 搜索。 Clientdesk 复选框可搜索客户、交易和产品。
  • 用于客户、交易和产品的 自定义字段。

客户、交易和产品

  • 客户 — 联系人与公司。联系人包含公司、电子邮件、电话、地址、国家、语言、经办人和备注。
  • 交易 — 状态、金额、货币、截止日期、备注以及来自目录的明细行。
  • 产品 — 商品、服务或订阅,支持不同货币的价格。
  • 订阅 — 周期为 1 个月或 1 年的交易明细行。卡片显示有效与已过期的订阅。
  • Dashboard — 客户、交易和产品的汇总。区块取决于用户权限。
  • 客户、交易和产品的 变更日志。

邮件、回复与评分

  • IMAP — 项目收件箱。邮件会创建 Issue,或在已打开的 Issue 上添加评论。
  • SMTP — 发信配置。项目为回复客户选择配置。
  • 带有客户名称、Issue 编号及其他字段占位符的 回复模板。
  • 请求评分。 关闭 Issue 时,可向作者发送带链接的电子邮件。该链接无需登录 Redmine 即可打开。
  • 在设定小时数后 自动关闭请求,并向客户发送电子邮件。
  • AI。 在 Issue 页面上,可根据简短提示生成回复。
  • 从 RedmineUp 导入 — 联系人、公司、交易和产品。将 Issues 关联到新联系人是单独操作。

适用对象

  • 支持 — 邮件请求、回复客户与质量评分。
  • 销售 — 客户、交易、目录与订阅。
  • Redmine 管理员 — 交易状态、邮件、模板与导入。

兼容性

Redmine:6.0 - 7.0

数据库:MySQL、PostgreSQL、SQLite

必须在 Redmine 设置中启用 REST web service。否则插件设置页会显示警告 “Enable REST web service”。


安装与更新

  1. 若已安装旧版插件,请先删除。

    cd redmine/plugins
    rm -r clientdesk
    
  2. 将 clientdesk 文件夹复制到 redmine/plugins/。

  3. 从 Redmine 根目录运行迁移。

    bundle exec rake redmine:plugins:migrate RAILS_ENV=production NAME=clientdesk
    
  4. 停止并启动 Redmine。在某些环境(例如 Docker)中,需要完整停止并启动,而不是重启。


卸载

  1. 从 Redmine 根目录运行:

    bundle exec rake redmine:plugins:migrate RAILS_ENV=production NAME=clientdesk VERSION=0
    
  2. 删除插件文件夹。

    cd redmine/plugins
    rm -r clientdesk
    
  3. 停止并启动 Redmine。


设置

  1. 在 Redmine 设置中启用 REST web service。
  2. 在 Administration → Roles and permissions 的 ClientDesk 部分授予权限。
  3. 在 Project → Settings → Modules 中启用 ClientDesk 模块。
  4. 打开插件设置并创建交易状态。
  5. 若需要回复客户,请创建 SMTP 配置并在项目设置中选择它。
  6. 若需要接收邮件,请添加 IMAP 邮箱并将其关联到项目。

管理

Redmine 管理员可通过两种方式访问插件设置。

  1. Administration → Plugins → ClientDesk CRM plugin → Configure。
  2. Administration → ClientDesk。

General 选项卡

  • Show in top menu — Redmine 顶部菜单中的 ClientDesk 项。
  • Show in application menu — 应用程序菜单中的 ClientDesk 项。
  • Contact name format — “First Last”、“First Middle Last”、“Last First” 或 “Last First Middle”。
  • Default country for new contacts。
  • Default language for new contacts。
  • Available currencies — 用于交易货币和产品价格的列表。
  • Automatically close requests after — 小时数。关闭由后台作业完成,见下文。
  • Send an automatic email to the client — 关闭邮件的主题与正文。启用该选项时两个字段均为必填。

可在关闭邮件的主题和正文中插入:%{ticket.id}、%{ticket.subject}、%{ticket.project}、%{ticket.author.name}、%{ticket.author.email}、%{client.name}、%{ticket.status}。

Mail 选项卡

IMAP 邮箱列表。邮箱与项目关联。

为邮箱设置主机、端口、用户名、密码、认证方法、连接安全与 SSL 验证。然后设置 IMAP 文件夹、成功处理消息的文件夹以及失败消息的文件夹。

Issue 创建规则:

  • 新 Issue 的跟踪器和状态;
  • Create contacts — 为未知发件人创建新联系人;
  • Use issue number from the subject — 若主题包含未关闭的 Issue 编号,邮件将变为评论而非新 Issue;
  • Sender blacklist — 每行一个模式;允许正则表达式。

“Test connection” 按钮显示文件夹、消息数与新消息数。

SMTP 选项卡

发信配置:主机、端口、账户、密码、连接安全与发件人地址。可将一个配置标记为默认。在项目中可选择此配置、其他配置或共享的 Redmine 邮件设置。

Deal statuses 选项卡

所有项目共用的目录。状态包含名称、颜色、活动标志以及类型:Open、Won 或 Lost。通过拖动行更改顺序。已在交易中使用的状态无法删除。

Reply templates 选项卡

模板包含名称与文本。可将客户、Issue 与回复作者字段插入文本:

%{client.name}、%{client.first_name}、%{client.last_name}、%{client.email}、%{ticket.id}、%{ticket.subject}、%{ticket.project}、%{ticket.tracker}、%{ticket.status}、%{response.author}、%{response.author.first_name}、%{response.author.last_name}。

在 Issue 页面上,从 “Insert template” 列表选择模板。这需要 Issue 编辑权限和客户查看权限。

Communications 选项卡

收发消息的日志。它显示哪些邮件已创建 Issue 或评论,避免同一邮件被处理两次。此选项卡没有设置保存按钮。

AI 选项卡

插件用于生成回复所调用服务的地址。Issue 页面上的行为在项目设置中启用。

Request rating 选项卡

请求评分的共享邮件模板。复选框 “When closing an issue, ask the author for a rating” 启用该模板。主题与正文为必填。

下方是启用了 ClientDesk 模块的项目表。为每个项目选择模式:Disabled、Use admin template 或 Project template。当共享模板已填写并启用时,可使用管理模板模式。

在此选项卡上,模板变量使用花括号:{%ticket.id%}、{%ticket.subject%}、{%ticket.project%}、{%ticket.author.name%}、{%ticket.author.email%}、{%client.name%}、{%vote.url%}。

Import 选项卡

仅管理员可用的三项操作。

  • Import from RedmineUp — 创建联系人、交易和产品。此步骤不关联 Issues。
  • Link issues to new contacts — 为已导入的客户从 helpdesk 获取关联。已有 ClientDesk 联系人的 Issue 将被跳过。
  • Delete all — 永久删除联系人、公司、交易、产品、备注与 Issue 关联。交易状态、邮箱与模板保留。

若数据库中缺少 RedmineUp 表,导入会报告该情况且不创建任何内容。

角色与权限

在 ClientDesk 部分:

  • View clients — 客户列表与卡片、备注、搜索、Issue 上的联系人字段。
  • Manage clients — 创建、编辑和删除客户与备注;从 Issue 卡片创建联系人。
  • View deals — 交易与订阅。
  • Manage deals — 创建、编辑和删除交易。
  • View products — 目录。
  • Manage products — 创建、编辑和删除产品。

Manage 权限不包含 View 权限。请分别授予。

当模块已启用且至少有一项查看权限(客户、交易或产品)时,ClientDesk 菜单项可见。CRM 内选项卡按其权限显示。

项目邮件设置由拥有项目编辑权限的用户更改。对此不需要 CRM 权限。

后台作业

可从项目设置手动启动邮件抓取。若需定时执行,从 Redmine 根目录:

bundle exec rake clientdesk:fetch_mail

自动关闭请求仅通过以下命令运行:

bundle exec rake clientdesk:auto_close_issues

项目设置

Project → Settings → ClientDesk。

IMAP

此项目的收件邮箱列表。一个项目可以有多个邮箱。还可从此处运行 “Test connection” 和 “Fetch mail”。

抓取后,页面显示已处理的邮件数、已创建的 Issue 数以及已添加的评论数。

SMTP

用于回复客户的发信配置。若未选择配置,回复时会显示警告:请在 Settings → ClientDesk → Mail 中设置 SMTP。

Feedback

When closing an issue, ask the author for a rating:

  • Disabled;
  • Use admin template;
  • Project template — 自定义主题与正文。两个字段均为必填。

项目模板占位符:%{ticket.id}、%{ticket.subject}、%{ticket.project}、%{ticket.author.name}、%{ticket.author.email}、%{client.name}、%{vote.url}。

AI 设置

  • Enable AI suggestions for client replies 以及系统提示词。
  • Enable a prefilled prompt for clients 以及该提示词的文本。

使用

打开 CRM

Project → ClientDesk。

选项卡:

  • Dashboard — 客户、交易和产品计数器。拥有交易权限时,还会显示货币合计与订阅。
  • Clients。
  • Deals。
  • Products。

CRM 标题栏可在当前上下文中搜索客户、交易和产品。列表可筛选并保存为查询。

顶部菜单或应用程序菜单项会打开同一 CRM,且不绑定到单个项目。列表包含模块已启用且具有查看权限的项目中的记录。

客户

列表筛选:All、Contacts、Companies。

客户卡片显示联系详情、相关交易、Issues、备注与自定义字段。对于联系人,可直接在公司字段中创建公司。公司卡片显示其联系人。

主要联系人字段:名、中间名、姓、电子邮件、电话、职位、公司、生日、地址、城市、地区、国家、语言、网站、税号、来源、经办人以及 “Do not contact”。对于公司 — 名称、行业与公司规模。

可通过类型为 “file” 的自定义字段将文件附加到客户。日志显示谁在何时更改了记录。

客户属于主项目。也可在其他项目中可见:主项目的父子项目、所有项目,或 “Additionally available in projects” 列表。将 Issue 或邮件关联到客户的项目本身不会把客户加入该项目。

创建联系人时若电子邮件已存在,插件不会创建第二张卡片。它会建议打开现有联系人、将项目加入可见范围,或更改主项目。可用操作取决于权限。

“Remove from project” 会在当前项目中隐藏客户,并保留在主项目中。删除卡片在主项目中进行。已关联 Issues 或交易的客户无法删除。

交易与订阅

交易关联到客户与项目。它包含名称、状态、金额、货币、截止日期、备注与明细行。明细行包含产品、数量、价格与序号。产品来自所选项目目录。价格使用交易货币。

可从客户卡片创建已选好客户的交易。若两个项目都有 Manage deals 权限且客户在该处可见,可将交易移至另一项目。

订阅是类型为 “Subscription”、周期为 1 month 或 1 year 的产品。开始日期在交易上设置;结束日期由周期计算。若交易截止日期与订阅结束日期不一致,插件会建议替换截止日期。

在 Issue 页面上将鼠标悬停在联系人名称上会打开卡片:名称、电子邮件、交易与订阅。有效与已过期订阅分开显示。若联系人有公司,卡片还会显示其交易。该公司其他联系人的交易归在 “Other deals” 下。

产品

项目目录。产品类型:Goods、Service 或 Subscription。订阅需要周期。产品包含名称、描述、SKU 与价格。价格货币从 “Available currencies” 中选择。

已在交易中使用的产品无法删除。产品卡片显示使用它的交易。

Issues

若模块已启用且存在 “View clients” 权限:

  1. 在 Issue 表单中找到联系人字段并开始输入名称。搜索在两个字符后开始。
  2. 选择联系人并保存 Issue。
  3. 在 Issue 页面上,联系人显示在区块与侧栏卡片中。无需打开 CRM 即可更改或清除卡片。
  4. 拥有 “Manage clients” 权限时,可从该卡片创建联系人。

一个 Issue 有一个当前联系人。更改联系人会记录在请求历史中。

可为 Issue 列表添加列与筛选器:联系人、联系人公司、请求渠道、首次响应时间、首次回复时间、解决时间、客户评分、最后一条消息及其日期。渠道:电子邮件、电话、聊天、API。所选列会包含在 Issue 列表导出中。

回复客户

在带有联系人的 Issue 评论中有 “Reply to client”。可设置 To、Cc 和 Bcc。邮件通过项目 SMTP 发送。Issue 日志会记录已发送回复。来自邮件的客户回复会作为评论到达,并标记为客户回复。

若项目中启用了建议,评论字段上方会有 “write a reply with AI”。简短提示与 Issue 数据会发送到 AI 服务;生成的文本放入评论字段。

请求评分

若项目中启用了评分请求,关闭 Issue 时作者会收到带链接的电子邮件。评分页面无需登录即可打开。评分:Excellent、Normal、Poor。评论为可选。保存最新评分。可在 Issue 上以及 Issue 列表列中查看。

Redmine 搜索

在搜索页面与标题栏快速搜索中有 Clientdesk 复选框。它将客户、交易和产品作为一组搜索。Clientdesk (N) 计数器仅保留这些结果。

在单个项目中,当模块已启用且存在查看权限时显示复选框。跨多个项目搜索时始终显示复选框,但不会返回无法访问项目中的记录。

搜索覆盖名称、标题、电子邮件、电话、职位、网站、税号、交易名称与备注、产品描述,以及标记为 “Searchable” 的自定义字段。不搜索备注与附件。“Search titles only” 仅保留名称与标题。

结果链接在 CRM 中打开卡片。


常见问题

为什么看不到 ClientDesk 菜单?

请检查三个条件。

  1. 项目中已启用 ClientDesk 模块。
  2. 角色至少拥有 “View clients”、“View deals” 或 “View products”。
  3. 对于项目外的菜单项,已启用 “Show in top menu” 或 “Show in application menu”,且至少一个项目中存在相同的查看权限。

为什么设置页显示 “Enable REST web service”?

CRM 通过 Redmine REST API 工作。请在 Administration → Settings → API 中启用该服务。

能否导入 CRM 数据并立即关联 Issues?

不能。请先执行 “Import from RedmineUp”,检查卡片,然后执行 “Link issues to new contacts”。若导入失败,“Delete all” 会清除已导入数据,且不触及状态、邮件或模板。

为什么邮件没有变成新的 Issue?

若主题包含已打开的 Issue 编号且启用了 “Use issue number from the subject”,邮件会作为评论添加。黑名单中的邮件不会创建 Issue。重复邮件可在 “Communications” 选项卡中查看。

谁能看到客户评分?

请求作者通过邮件链接设置评分。在 Redmine 中,可访问该 Issue 的用户可在 Issue 上以及 Issue 列表列中看到它。