ドキュメント: 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 からのインポート — 連絡先、会社、案件、製品。新しい連絡先への Issue の紐付けは別アクションです。
対象ユーザー
- サポート — メールリクエスト、クライアントへの返信、品質評価。
- 営業 — クライアント、案件、カタログ、サブスクリプション。
- Redmine 管理者 — 案件ステータス、メール、テンプレート、インポート。
互換性
Redmine: 6.0 - 7.0
データベース: MySQL, PostgreSQL, SQLite
Redmine 設定で REST web service を有効にする必要があります。そうでない場合、プラグイン設定ページに警告 「Enable REST web service」 が表示されます。
インストールと更新
-
古いプラグインバージョンがインストールされている場合は削除します。
cd redmine/plugins rm -r clientdesk -
clientdeskフォルダをredmine/plugins/にコピーします。 -
Redmine のルートからマイグレーションを実行します。
bundle exec rake redmine:plugins:migrate RAILS_ENV=production NAME=clientdesk -
Redmine を停止して起動します。Docker などの一部の構成では、再起動ではなく完全な停止と起動が必要です。
アンインストール
-
Redmine のルートから実行します:
bundle exec rake redmine:plugins:migrate RAILS_ENV=production NAME=clientdesk VERSION=0 -
プラグインフォルダを削除します。
cd redmine/plugins rm -r clientdesk -
Redmine を停止して起動します。
セットアップ
- Redmine 設定で REST web service を有効にします。
- Administration → Roles and permissions の ClientDesk セクションで権限を付与します。
- Project → Settings → Modules で ClientDesk モジュールを有効にします。
- プラグイン設定を開き、案件ステータスを作成します。
- クライアントへの返信が必要な場合は、SMTP プロファイルを作成し、プロジェクト設定で選択します。
- 受信メールが必要な場合は、IMAP メールボックスを追加し、プロジェクトに紐付けます。
管理
プラグイン設定は、Redmine 管理者が次の 2 つの方法で利用できます。
- Administration → Plugins → ClientDesk CRM plugin → Configure。
- 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 — 1 行に 1 パターン; 正規表現も可。
「Test connection」 ボタンはフォルダ、メッセージ数、新しいメッセージ数を表示します。
SMTP タブ
送信プロファイル: ホスト、ポート、アカウント、パスワード、接続セキュリティ、送信者アドレス。1 つのプロファイルをデフォルトとしてマークできます。プロジェクトでは、このプロファイル、別のプロファイル、または共有の 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 タブ
管理者のみ向けの 3 つのアクション。
- Import from RedmineUp — 連絡先、案件、製品を作成します。このステップでは Issue は紐付けられません。
- 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 メニュー項目は、モジュールが有効で、クライアント、案件、製品のいずれかの View 権限が少なくとも 1 つある場合に表示されます。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 ヘッダーには、現在のコンテキスト内のクライアント、案件、製品を横断する検索があります。一覧はフィルタでき、クエリとして保存できます。
トップメニューまたはアプリケーションメニューの項目は、1 つのプロジェクトに縛られずに同じ CRM を開きます。一覧には、モジュールが有効で View 権限があるプロジェクトのレコードが含まれます。
クライアント
一覧フィルタ: All、Contacts、Companies。
クライアントカードには連絡先詳細、関連する案件、Issue、メモ、カスタムフィールドが表示されます。連絡先では、会社フィールドで直接会社を作成できます。会社カードにはその連絡先が表示されます。
主な連絡先フィールド: 名、ミドルネーム、姓、メール、電話、役職、会社、誕生日、住所、市区町村、地域、国、言語、ウェブサイト、税 ID、ソース、担当者、および 「Do not contact」。会社の場合 — 名前、業種、会社規模。
ファイルは「file」タイプのカスタムフィールド経由でクライアントに添付できます。ジャーナルには誰がいつレコードを変更したかが表示されます。
クライアントはプライマリプロジェクトに属します。他のプロジェクトでも表示可能にできます: プライマリの親子プロジェクト、すべてのプロジェクト、または 「Additionally available in projects」 リスト。Issue またはメールをクライアントのプロジェクトに紐付けても、それだけではクライアントはそのプロジェクトに追加されません。
連絡先作成時にメールが既に存在する場合、プラグインは 2 つ目のカードを作成しません。既存の連絡先を開く、プロジェクトを表示対象に追加する、またはプライマリプロジェクトを変更することを提案します。利用可能なアクションは権限に依存します。
「Remove from project」 は現在のプロジェクトでクライアントを非表示にし、プライマリには残します。カードの削除はプライマリプロジェクトで行います。Issue または案件に紐付いているクライアントは削除できません。
案件とサブスクリプション
案件はクライアントとプロジェクトに紐付きます。名前、ステータス、金額、通貨、期日、メモ、明細行があります。明細行は製品、数量、価格、順序番号です。製品は選択したプロジェクトカタログから来ます。価格は案件の通貨を使用します。
クライアントカードから、クライアントが既に選択された状態で案件を作成できます。両方のプロジェクトに Manage deals 権限があり、クライアントがそこで表示可能な場合、案件を別のプロジェクトに移動できます。
サブスクリプションはタイプ 「Subscription」 で期間が 1 month または 1 year の製品です。開始日は案件で設定され、終了日は期間から計算されます。案件の期日がサブスクリプション終了日と一致しない場合、プラグインは期日の置き換えを提案します。
Issue ページで連絡先名にホバーするとカードが開きます: 名前、メール、案件、サブスクリプション。有効および期限切れのサブスクリプションは別に表示されます。連絡先に会社がある場合、カードにはその案件も表示されます。その会社の他の連絡先の案件は 「Other deals」 の下にまとめられます。
製品
プロジェクトカタログ。製品タイプ: Goods、Service、または Subscription。サブスクリプションには期間が必要です。製品には名前、説明、SKU、価格があります。価格の通貨は 「Available currencies」 から選択します。
案件で既に使用されている製品は削除できません。製品カードには使用されている案件が表示されます。
Issues
モジュールが有効で 「View clients」 権限がある場合:
- Issue フォームで連絡先フィールドを見つけ、名前の入力を開始します。検索は 2 文字後に始まります。
- 連絡先を選択して Issue を保存します。
- Issue ページでは、連絡先がブロック内とサイドバーカードに表示されます。CRM を開かずにカードを変更またはクリアできます。
- 「Manage clients」 権限があれば、そのカードから連絡先を作成できます。
Issue には現在の連絡先が 1 つあります。連絡先の変更はリクエスト履歴に保存されます。
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 チェックボックスがあります。クライアント、案件、製品を 1 つのグループとして検索します。Clientdesk (N) カウンタはそれらの結果のみを残します。
単一プロジェクトでは、モジュールが有効で View 権限がある場合にチェックボックスが表示されます。複数プロジェクトを横断して検索する場合、チェックボックスは常に表示されますが、アクセスできないプロジェクトのレコードは返されません。
検索対象は名前、タイトル、メール、電話、役職、ウェブサイト、税 ID、案件名とメモ、製品説明、および 「Searchable」 とマークされたカスタムフィールドです。メモと添付ファイルは検索されません。「Search titles only」 は名前とタイトルに限定します。
結果リンクは CRM でカードを開きます。
よくある質問
ClientDesk メニューが表示されないのはなぜですか?
次の 3 つの条件を確認してください。
- プロジェクトで ClientDesk モジュールが有効になっている。
- ロールに少なくとも 「View clients」、「View deals」、または 「View products」 がある。
- プロジェクト外の項目については 「Show in top menu」 または 「Show in application menu」 が有効で、少なくとも 1 つのプロジェクトに同じ View 権限がある。
設定ページに「Enable REST web service」と表示されるのはなぜですか?
CRM は Redmine REST API 経由で動作します。Administration → Settings → API でサービスを有効にしてください。
CRM データをインポートしてすぐに Issue を紐付けできますか?
いいえ。まず 「Import from RedmineUp」 を実行し、カードを確認してから 「Link issues to new contacts」 を実行します。インポートに失敗した場合、「Delete all」 はインポート済みデータを消去し、ステータス、メール、テンプレートには触れません。
メールが新しい Issue にならなかったのはなぜですか?
件名に既に開いている Issue 番号が含まれ、「Use issue number from the subject」 が有効な場合、メールはコメントとして追加されます。ブラックリストのメールは Issue を作成しません。繰り返しのメールは 「Communications」 タブで確認できます。
クライアント評価は誰が見られますか?
リクエストの作成者がメールリンク経由で評価を設定します。Redmine では、Issue にアクセスできるユーザーが Issue 上および Issue 一覧の列で確認できます。