マイクロアプリ

Zendeskの統合

Zendeskと統合して、デバイス、イントラネット、またはメッセンジャーから要求を送信および監視します。

注:

2つのZendesk統合テンプレートが提供されています。ほとんどのユースケースでは、新しいHTTP統合を使用することをお勧めします。このHTTP統合は、キャッシュされたデータ構造を構成するためのより強力な機能です。各統合で使用可能なマイクロアプリについて詳しくは、「Zendeskマイクロアプリの使用」を参照してください。

次のプロセスを使用して、Zendesk統合を有効にします。前提条件を満たしていることを確認し、クライアントIDとシークレットトークンを取得します。このプロセスを完了すると、Citrixマイクロアプリの使用によって実行されたすべてのアクションを含む、既存のレベルの監査ログが保持されます。

追加設定不要のZendeskマイクロアプリの一覧については、「Zendeskマイクロアプリの使用」を参照してください。

必須条件の確認

専用のZendeskアカウントを作成し、それを使用してZendesk統合をセットアップします。このアカウントには、完全なデータアクセス特権を持つ管理者などの役割が割り当てられている必要があります。Zendeskでこの統合をセットアップした後、Citrix Workspaceマイクロアプリに統合を追加するには、以下のアーティファクトが必要になります:

  • ベースURL:ベースURLは次のモデルに従います:https://{customer-id}.zendesk.com/
  • 顧客ID:上記のように、URLの顧客ID部分を使用して、セットアッププロセス中にcustomer-idを置き換えます。
  • クライアントID:クライアントIDは、承認サーバーに固有のクライアント登録情報を表す文字列です。ZendeskアカウントでOAuthクライアントを登録して、これとシークレットを収集します。
  • クライアントシークレット:クライアントシークレットは、ターゲットアプリケーション統合のセットアップ時に発行される一意の文字列です。
  • アカウント:サービスアカウントのユーザー名です。
  • パスワード:サービスアカウントのパスワードです。

統合プロセスを開始する前に、以下の前提条件を満たしておく必要があります:

  • Citrix GatewayがZendeskのシングルサインオンに対応するように構成して、ユーザーがログインすると、再度資格情報を入力しなくても自動的に再ログインできるようにします。Zendesk Single Sign-on構成の手順に従ってください。SSOの構成について詳しくは、「Citrix Gatewayサービス」を参照してください。

Zendeskには、ユーザーがチケットにHoldステータスを割り当てることができる[Enable On-hold status]オプションがあります。マイクロアプリの [チケット] を使用すると、ユーザーはZendeskチケットの詳細を表示できます。また、[チケットの更新]ページには [ステータス] フィールドがあり、ここでHoldはオプションです。ZendeskインスタンスでHoldが許可されていない場合は、StatusリストからHoldアイテムを削除する必要があります。詳しくは、「Zendeskマイクロアプリの使用」を参照してください。

Zendesk統合のセットアップ

  1. 専用ユーザーアカウントでwww.zendesk.comにログインします。
  2. 左側のサイドバーの [Admin](設定アイコン)を選択します。[Admin][API] を選択します。
  3. [OAuth Clients] タブを選択してから、[+](プラス)アイコンを選択します。
  4. アプリの クライアント名 を入力します。
  5. (オプション)説明会社、および ロゴ を追加します。
  6. 自動入力された 一意の識別子 の値を、後で使用するためにコピーしておきます。
  7. 以下に示すようにリダイレクトURLを設定します。
  8. [Save][OK] の順に選択します。
  9. ページが更新されると、事前設定された新しいシークレットフィールドが表示されます。生成されたシークレットトークンを、後で使用するためにコピーしておきます。これは、この画面を終了した後には使用できません。
  10. [Save] を選択します。

Citrix Workspaceマイクロアプリで統合を完了する準備ができました。

コールバックURLの追加

インスタンス構成にカスタムURLを追加して、プライベートデータへのアクセスを許可し、OAuth認証済みユーザーアクションを有効にします。一覧の最初のコールバックは変更されません。2番目のコールバックはターゲットアプリケーションによって異なり、統合の作成時にURLアドレスバーに表示されます。セクション{yourmicroappserverurl}は、テナント部分、リージョン部分、環境部分で構成されています:https://{tenantID}.{region(us/eu/ap-s)}.iws.cloud.com

管理者としてZendeskにログインし、この統合用に以下の承認済みリダイレクトURLを追加します:

  • https://{yourmicroappserverurl}/admin/api/gwsc/auth/serverContext
  • https://{yourmicroappserverurl}/app/api/auth/serviceAction/callback

Citrix Workspaceマイクロアプリへの統合の追加

次の手順に従って、Zendesk HTTP統合をセットアップします。ほとんどのユースケースでは、新しいHTTP統合を使用することをお勧めします。認証オプションは事前に選択されています。プロセスの完了時に、これらのオプションが選択されていることを確認してください。ほとんどのユースケースでは、この新しいHTTP統合を使用することをお勧めします。このHTTP統合は、キャッシュされたデータ構造を構成するためのより強力な機能です。

注:

デフォルトでは、この統合は3か月間のデータを同期します。目的やチケットの通常の有効期間に基づいて、この値を変更することをお勧めします。フィルターは最終更新に基づいており、作成されません。これを変更するには、データを読み込むエンドポイントで変数start_timeを変更する必要があります。「データ読み込み変数の置換」を参照してください。

次の手順を実行します:

  1. [マイクロアプリ統合] ページで [新しい統合を追加] および [Citrix提供のテンプレートから新しい統合を追加する] を選択します。
  2. [統合] の下にあるZendeskタイルを選択します。
  3. 統合の [統合名] を入力します。
  4. コネクタのパラメーターを入力します。
    • [ベースURL] を入力するか、例の{customer-id}を顧客IDに置き換えます。
    • アイコンライブラリから統合のアイコンを選択するか、デフォルトのZendeskアイコンのままにしておきます。

    HTTP zendeskコネクタパラメーター

    • オンプレミス接続を作成する場合は、[オンプレミスインスタンス] を有効にします。詳しくは、「オンプレミスインスタンス」を参照してください。

    HTTP zendeskコネクタオンプレミス

  5. [サービス認証][認証方法] メニューから [OAuth 2.0] を選択して認証の詳細を完了します。認証オプションは事前に選択されています。プロセスの完了時に、これらのオプションが選択されていることを確認してください。OAuth 2.0セキュリティプロトコルを使用して、委任されたアクセスの要求/承認トークンを生成します。利用可能な場合は、サービス認証方法として常にOAuth 2.0を使用することをお勧めします。OAuth 2.0は、統合が、構成済みのマイクロアプリとの最大限のセキュリティコンプライアンスを満たすことを保証します。

    1. [許可の種類のフロー] メニューで [認証コード] を選択します。これによって、クライアントが交換するアクセストークン用の一時コードが付与されます。コードは認証サーバーから取得され、そこでクライアントが要求している情報を確認できます。この許可の種類のみが、安全なユーザーの偽装を有効にします。これにより、アプリケーションの登録時に使用する [コールバックURL] が表示されます。
    2. [許可の種類の値] フィールドに「authorization_code」と入力します。
    3. [トークン認証] メニューから [認証ヘッダー] を選択します。
    4. [トークンコンテンツの種類] メニューから [URLエンコード形式] を選択します。
    5. [認証URL] を入力するか、例の{customer-id}を顧客IDに置き換えます。これが、ターゲットアプリケーション統合をセットアップするときに提供される承認サーバーのURLです。
    6. [トークンURL] を入力するか、例の{customer-id}を顧客IDに置き換えます。これが、アクセス承認トークンのURLです。
    7. アクセス要求のスコープを定義するために、[スコープ][読み取り/書き込み] が入力されていることを確認してください。
    8. [クライアントID] を入力します。クライアントIDは、承認サーバーに固有のクライアント登録情報を表す文字列です。ZendeskアカウントでOAuthクライアントを登録して、これとシークレットを収集します。統合構成ページに表示される [コールバックURL] を追加する必要があります。
    9. [クライアントシークレット] を入力します。クライアントシークレットは、ターゲットアプリケーション統合のセットアップ時に発行される一意の文字列です。
    10. [ヘッダープレフィックス] を入力します。(オプション)ベアラープレフィックスがデフォルトのヘッダーと異なる場合、ヘッダープレフィックスを入力します。

    Zendesk HTTPサービス認証

    1. [OAuth 2.0] 認証方式を選択した場合、[+パラメーターの追加] を選択して [アクセストークンパラメーター] を含めます。アクセストークンパラメーターでは、ターゲットアプリケーション承認サーバーによる要求に従って、必要に応じてアクセストークンパラメーターを定義します。

    Zendesk HTTPトークン

  6. [サービスアクション認証][[アクション]で個別のユーザー認証を使用する] を有効にします。サービスアクション認証は、サービスアクションレベルで認証します。資格情報は、サービス認証レベルと同じです。認証オプションは事前に選択されています。プロセスの完了時に、これらのオプションが選択されていることを確認してください。

    1. [認証方法] メニューから [OAuth 2.0] を選択して認証の詳細を完了します。
    2. [許可の種類のフロー] メニューで [認証コード] を選択します。これによって、クライアントが交換するアクセストークン用の一時コードが付与されます。コードは認証サーバーから取得され、そこでクライアントが要求している情報を確認できます。この許可の種類のみが、安全なユーザーの偽装を有効にします。これにより、アプリケーションの登録時に使用する [コールバックURL] が表示されます。
    3. [許可の種類の値] フィールドに「authorization_code」と入力します。
    4. [トークン認証] メニューから [認証ヘッダー] を選択します。
    5. [トークンコンテンツの種類] メニューから [URLエンコード形式] を選択します。
    6. [認証URL] を入力するか、例の{customer-id}を顧客IDに置き換えます。これが、ターゲットアプリケーション統合をセットアップするときに提供される承認サーバーのURLです。
    7. [トークンURL] を入力するか、例の{customer-id}を顧客IDに置き換えます。これが、アクセス承認トークンのURLです。
    8. アクセス要求のスコープを定義するために、[スコープ][読み取り/書き込み] が入力されていることを確認してください。
    9. [クライアントID] を入力します。クライアントIDは、承認サーバーに固有のクライアント登録情報を表す文字列です。ZendeskアカウントでOAuthクライアントを登録して、これとシークレットを収集します。統合構成ページに表示される [コールバックURL] を追加する必要があります。
    10. [クライアントシークレット] を入力します。クライアントシークレットは、ターゲットアプリケーション統合のセットアップ時に発行される一意の文字列です。
    11. [ヘッダープレフィックス] を入力します。(オプション)ベアラープレフィックスがデフォルトのヘッダーと異なる場合、ヘッダープレフィックスを入力します。

    HTTP zendeskサービスアクション認証

  7. [要求レート制限] トグルが有効になっており、[時間間隔]あたりの [要求数][500] /分に設定されています。
  8. (オプション)サポートのために24時間のログを保持するには、[ログ] を有効にします。
  9. [要求タイムアウト] フィールドは、デフォルトで120に設定されています。

    レート制限とログの切り替え

  10. [保存] を選択して続行します。
  11. [OAuth認証][承認] を選択して、サービスアカウントにログインします。Webexのログイン画面がポップアップで表示されます。
    1. サービスアカウントのユーザー名とパスワードを入力し、[ログイン] を選択します。
    2. [同意] を選択します。 サービス認証

次の手順に進み、セットアッププロセスを完了します。

データ読み込み変数の置換

デフォルトでは、完全同期中に、この統合は過去3か月間に変更されたチケットのみを読み込みます。これを変更する必要がある場合は、この統合データ読み込み設定で [チケット] エンドポイントのstart_timeテンプレート変数パラメーターを変更します目的やチケットの通常の有効期間に基づいて、この値を変更することをお勧めします。フィルターは最終更新に基づいており、作成されません。

  1. [マイクロアプリ統合] ページから、Zendesk統合の横にあるメニューを選択し、[編集] を選択します。[データの読み込み] 画面が開きます。設定画面が表示されている場合は、左側のナビゲーション列から [データの読み込み] を選択します。
  2. [チケット] エンドポイントの隣にあるメニューを選択して [編集] を選択するか、エンドポイントの名前「チケット」を選択します。
  3. [データエンドポイントの編集] 画面の [テンプレート変数] で、必要に応じて、変数start_timeの値を、変更したい時間パラメーターの値と数値に置き換えます。
  4. 画面下部の [適用] を選択し、確定します。

    レート制限とログの切り替え

これで、最初のデータ同期を設定して実行する準備ができました。同期ルール、スケジュールを満たさない同期、および拒否ルールの詳細については、「データの同期」を参照してください。

APIエンドポイントとテーブルエンティティについて詳しくは、「Zendeskコネクタの仕様」を参照してください。

Zendeskマイクロアプリの使用

既存のアプリケーション統合には、追加設定不要のマイクロアプリが付属しています。これらのマイクロアプリから開始して、ニーズに合わせてカスタマイズします。

注: 2つのZendesk統合テンプレートが提供されています。ほとんどのユースケースでは、古いJavaベースの統合よりも新しいHTTP統合を使用することをお勧めします。それぞれに含まれるマイクロアプリは多少異なります。

Zendeskマイクロアプリの使用

Zendesk HTTP統合には、以下の設定済みで追加設定不要のマイクロアプリが付属しています:

Zendeskマイクロアプリ

チケットの追加: Zendeskチケットを送信します。

通知またはページ ユースケースワークフロー
チケット追加ページ チケットを送信するためのフォームを提供します。

チケット: 詳細なZendeskチケットを表示します。ZendeskインスタンスでHoldが許可されていない場合は、[チケット更新]ページでStatusリストからHoldアイテムを削除する必要があります。

通知またはページ ユースケースワークフロー
新規チケット割り当て(変更)通知 既存のチケットがユーザーに割り当てられると、ユーザーは通知を受け取ります。
新規チケット割り当て(新規)通知 新しいチケットがユーザーに割り当てられると、ユーザーは通知を受け取ります。
チケット状況変更通知 チケットの状況が変更されると、チケットの送信者は通知を受け取ります。
チケット更新通知 チケットが更新されると、送信者は通知を受け取ります。
コメントの追加ページ チケットにコメントを追加するためのページが表示されます。
コメントの詳細ページ コメントの読み取り専用ビューとコメントの詳細が表示されます。
自分のチケットページ パーソナライズされた、ユーザーに関連するチケットとチケットの詳細へのリンクの一覧を提供します。
チケットの詳細ページ チケットの詳細の読み取り専用ビューを提供します。
チケット更新ページ 管理者がチケットを変更するためのページが表示されます。フィールドには、[優先度]、[種類]、[ステータス]などがあります。

Zendeskレガシー統合の追加

以下の手順に従って、従来のJavaベースのZendesk統合をセットアップします。

次の手順を実行します:

  1. [マイクロアプリ統合] ページで [新しい統合を追加] および [Citrix提供のテンプレートから新しい統合を追加する] を選択します。
  2. [レガシー] 下でZendeskタイルを選択します。
  3. 統合の名前を入力します。

    zendeskのコネクタのパラメーター、URL、クライアントID、クライアントシークレット、読み込むチケットの月数

  4. 前提条件として収集したコネクタのパラメーターを入力します。
    • インスタンスの [URL] を入力します。
    • [Client ID] を入力します。この値は、アプリケーションをZendeskに登録したときに取得した一意の識別子です。
    • クライアントシークレット を入力します。この値は、Zendeskでアプリケーションを登録したときにコピーされたシークレットです。
    • 読み込むチケットの月数の値を選択します。
  5. [Zendeskアカウントでログインする] を選択して、OAuth認証を有効にします。Zendeskサインインページが新しいタブで開きます。アカウント名の入力、アクセスの確認、パスワードの入力を求められます。
  6. [追加] を選択します。

[マイクロアプリ統合] ページが開き、追加した統合とそのマイクロアプリが表示されています。ここから別の統合を追加したり、追加設定不要のマイクロアプリのセットアップを続行したり、この統合用の新しいマイクロアプリを作成したりできます。

これで、最初のデータ同期を設定して実行する準備ができました。統合アプリケーションからマイクロアプリプラットフォームに大量のデータをプルできるので、[テーブル] ページを使用して、最初のデータ同期のエンティティをフィルタリングし、同期を高速化することをお勧めします。詳しくは、「必要なエンティティの確認」を参照してください。同期ルール、スケジュールを満たさない同期、および拒否ルールの詳細については、「データの同期」を参照してください。

APIエンドポイントとテーブルエンティティについて詳しくは、「Zendeskコネクタの仕様」を参照してください。

従来のZendeskマイクロアプリ

JavaベースのZendesk統合には、以下の設定済みで追加設定不要のマイクロアプリが付属しています:

Zendeskマイクロアプリ

チケットの追加: Zendeskチケットを送信します。

通知またはページ ユースケースワークフロー
チケットの送信ページ チケットを送信するためのフォームを提供します。

チケット: 詳細なZendeskチケットを表示します。

通知またはページ ユースケースワークフロー
新規チケット割り当て(変更)通知 既存のチケットがユーザーに割り当てられると、ユーザーは通知を受け取ります。
新規チケット割り当て(新規)通知 新しいチケットがユーザーに割り当てられると、ユーザーは通知を受け取ります。
チケット状況変更通知 チケットの状況が変更されると、チケットの送信者は通知を受け取ります。
チケット更新通知 チケットが更新されると、送信者は通知を受け取ります。
自分のチケットページ パーソナライズされた、ユーザーに関連するチケットとチケットの詳細へのリンクの一覧を提供します。
チケットの詳細ページ チケットの詳細の読み取り専用ビューを提供します。