cybozu developer network

カテゴリー内の他の記事

Zendesk for kintone

こちらのプラグインは、2015年9月13日のアップデート以前、kintone製品内の「プラグインストア」にあるZendeskプラグインと同じ機能をもったプラグインです。
(一部デザインの変更をしています。)

Index

注意事項

  • サンプルプラグインは、その動作を保証するものではありません。
  • サンプルプラグインの技術的なサポート等は行っていません。
  • kintoneプラグインはスタンダードコースでのみご利用いただけます。ライトコースではご利用いただけませんのでご注意ください。

概要

Zendesk Inc. の提供するサービス「Zendesk」を利用している方向けのプラグインです。 Zendesk の詳細はこちら
アプリに Zendesk for kintone プラグインを追加すれば、レコードに Zendesk で管理している問い合わせ(チケット)を表示できます。
アプリの指定したフィールドの値をキーワードにチケットが検索され、検索条件に一致するチケットがレコードに表示されます。
たとえば、 kintone のアプリで顧客情報を管理していれば、顧客名のフィールドを検索キーワードに指定することで、顧客から受けた問い合わせをレコードに表示できます。

検索対象には、チケットの次の情報を指定できます。

  • リクエスタ
  • 担当者
  • タグ

※スマートフォンでは、チケットの閲覧ができません。
※Zendesk の制約により、リクエスタや担当者の名称を変更した際に、リクエスタや担当者に関連するチケットが新しい名称で検索できないことがあります。チケットが終了していない場合、チケットの内容を更新することで検索できるようになります。

完成イメージ

レコード詳細画面

Zendesk1.PNG


レコード詳細画面(チケット行クリック時最新のコメントを5件表示)

Zendesk2.PNG


以下エラーが表示された場合は、エラーのリンクをクリックし表示されたzendeskの画面でログイン処理を行ってください。

zendesk_error.PNG

プラグインを利用する

STEP1:フォームを設定する

アプリのフォームを設定します。次の2つのフィールドを配置します。ほかのフィールドの配置は任意です。

検索キーワードにするフィールド チケットの検索キーワードとして使用するフィールドを配置します。次の種類のフィールドを使用できます。
・文字列(1行)フィールド
・リンクフィールド
・レコード番号

※レコード番号を検索キーワードにする場合、アプリにアプリコードを設定していると、アプリコードを含めた番号が検索キーワードになります。
※テーブルに設定したフィールドは使用できません。

チケットを表示するフィールド チケットを表示する場所に、「スペース」フィールドを配置します。
配置したフィールドには、任意の「要素ID」を指定する必要があります。


Zendesk3.PNG

STEP2: アプリにプラグインを追加する

アプリに Zendesk for kintone プラグインを追加します。プラグインの追加方法は、kintone ヘルプを参照してください。
プラグインを追加する

STEP3: プラグインを設定する

STEP2で追加したプラグインに、必要な設定を行います。

1. アプリ管理画面の「設定」>「プラグイン」を開き、Zendesk for kintone プラグインの歯車マークをクリックします。

2. 各項目を設定します。

Zendesk ドメイン名 ご利用の Zendesk のサブドメイン名を指定します。
OAuth クライアント Zendesk で取得した、OAuth の「一意のID」と「シークレット」を入力します。
Zendesk での OAuth クライアントの設定は、Zendesk のヘルプを参照してください。
「リダイレクト URL」には次の URL を指定します。
https://oauth.cybozu.com/redirect
検索条件 ・kintone Field
検索キーワードにするフィールドを選択します。
・Zendesk Ticket Property
検索対象を選択します。
フィルター 表示するチケットをさらに絞り込む場合に、絞り込み条件を指定します。
kintone スペースフィールド STEP1でフォームに配置した「スペース」フィールド(チケットを表示するフィールド)の「要素ID」を指定します。

Zendesk4.PNG

3. [Save]をクリックします。

4. 「アプリの設定」画面で[設定完了]をクリックすると、プラグインの設定がアプリに反映されます。

サンプルプラグイン

プラグイン開発のためのサンプルであり、サポート対象外であることをご理解の上、ダウンロードしてください。

SAMPLE_zendesk_plugin.zip

更新履歴

2015/09/04 v5.0.0 を公開しました。
2017/09/12 v6.0.0 を公開しました。下記の機能が追加されました。

  • チケット合計数の表示
  • チケットデータが表示された行をクリックすることでコメントの表示
  • 検索条件でカスタムフィールドの選択
  • 一部日本語対応
  • その他画面の表示など微修正

2017/09/15 v6.0.1 を公開しました。下記の修正を行いました。

  • グループフィールドを配置した場合、設定画面のスペースのIDが取得できない不具合を改修しました。
  • その他画面の表示など微修正を行いました。

制限事項

  • 検索条件にカスタムフィールドを選択した場合、全てのカスタムフィールドのバリューが検索対象となります。
  • コメントの表示時に添付ファイルの表示不可、一部HTML表示が変わります。
  • コメントの表示時に「#2」等の相対リンクのリンク先がZendeskのリンクになりません。

利用している OSS のライセンス情報

このプラグインで利用している OSS のライセンスは次のとおりです。

記事に関するフィードバック

記事のコメント欄は記事に対するフィードバックをする場となっております。
右の記事フィードバックのためのガイドを参照してコメントしてください。
記事のリンク切れなど、気になる点がある場合も、こちらのフォームからフィードバックいただけますと幸いです。

Avatar
m.kito

フォームにグループフィールドを配置した場合、
プラグイン設定画面「kintone スペースフィールド」のリストが選択できないようです。
※v6(2017/09/12)を利用しております。

レイアウト取得API - レスポンス例 内容からの推察となりますが、
グループフィールドのレスポンスにfields配列が存在しないため、
スペースフィールドが正常に認識されない状況ではないでしょうか。

お手数をお掛けし大変申し訳ございませんが、
一度ご確認いただけますと幸いです。

Avatar
cybozu Development team

m.kito 様

お世話になっております。

ご指摘いただいてありがとうございます。

ソースコードを確認したところ、グループ中のスペースフィールドは対応されていないようです。
頂いた内容は、要望として承りました。

また、ご提示いただいたリンク先のURL「https://(サブドメイン名).cybozu.com/k/v1/app/form/layout.json」を使えば、
グループ中のスペースを取得することは可能です。
グループ中のスペースのJSON形式は次のような感じ:

引き続きdeveloper networをよろしくお願いいたします。

Avatar
m.kito

ご確認くださいましてありがとうございます。

> グループ中のスペースフィールドは対応されていないようです。

状況を正しくお伝えできておらず申し訳ございません。
フォームには、空のグループフィールドとスペースフィールドの2つのみを配置しております。

グループフィールドが存在すると、フォームのスペースフィールドが認識されず、
グループフィールドを削除すると、フォームのスペースが認識される状況です。

上記の動作から、恐らくレイアウトAPIを利用してフィールドの情報を取得しており、
グループフィルードのレスポンス内容の違いが考慮されておらず、
フォームのスペースフィールドの取得に影響が出ているのでは、と推察いたしました。
※的を得ていない場合はご容赦ください。

そこで改めての確認となり恐縮ではございますが、
グループフィルードが存在している場合において、
グループフィールド外のスペースフィールドは認識対象か否か、ご教示ください。

 

Avatar
cybozu Development team

m.kito 様

早速ご返事いただいてありがとうございます。

理解ズレてしまい申し訳ありませんでした。

ご丁寧な説明を頂いてありがとうございます。
こちらでも同じ現象を確認できました。
原因を判明次第、またご報告させていただきます。

Avatar
cybozu Development team

m.kito 様

お待たせいたしました。

>グループフィルードが存在している場合において、グループフィールド外のスペースフィールドは認識対象か否か、ご教示ください。
ご指摘の通り、認識できませんでした。

認識できるように修正させていただきましたので、ご確認お願い致します。

引き続きよろしくお願いいたします。

 

Avatar
m.kito

ご連絡くださいましてありがとうございます。

> 認識できるように修正させていただきましたので、ご確認お願い致します。

スペースフィールドが認識される事を確認いたしました。
迅速なご対応に感謝申し上げます。

活用させていただきます!

サインインしてコメントを残してください。