カスタム関数の作成と利用

カスタム関数の作成と利用

カスタム関数を使うと、Zoho Deskの機能を拡張し、複雑な処理に対応できます。要件に応じた独自の処理を自動化し、業務に合わせた処理を実装できます。たとえば、Zoho CRMの販売情報をもとに問い合わせの優先度を設定する場合は、カスタム関数で処理を作成し、問い合わせを更新できます。

カスタム関数は、Zoho独自のスクリプト言語であるDelugeを使用して作成します。特別なツールや設備を用意する必要はありません。Zoho Desk内で作成可能であるため、複雑な業務処理も簡単に自動化できます。

カスタム関数はさまざまなタイミングで実行できます。
例:
  1. ワークフロールールの実行条件を満たしたとき。
  2. ブループリントの遷移時。
  3. スケジュール処理で指定した日時や間隔になったとき。
カスタム関数を使うと、業務を自動化し、手作業を減らし、組織の業務に合った自動処理を実行できます。

利用条件

情報必要な権限
システム管理者の権限を持つユーザーは、カスタム関数を作成して適用できます。
各プランの機能と制限を確認する

カスタム関数の作成

カスタム関数は、Delugeスクリプトの作成ツールを使って作成できます。ドラッグ&ドロップでスクリプトを記述することが可能です。Delugeの構文や関数を覚えなくても作成できるため、関数を簡単に作成できます。

ZiaによるDelugeスクリプトの生成(Delugeのコーディング支援ボット)

Delugeとは、Zoho独自のスクリプト言語です。Zoho Deskのカスタム関数の設定画面では、Ziaに対して指示文を入力し、Delugeスクリプトを生成できます。手動でスクリプトを記述する代わりにZiaに要件を説明するだけで、スクリプトを生成することが可能です。これまで、カスタム関数を作成する際には、Delugeを通じて手動でスクリプトを記述し、関数のテストを行う必要がありました。Ziaと連携することで、関数を自動で作成できます。スクリプトを手動で記述する手間を省くことが可能です。

たとえば、顧客のメールに記載されている説明を抽出し、問い合わせの[説明]項目に自動で追加したいとします。この場合、Delugeスクリプトを手動で記述する代わりに、Ziaに対して次の指示文を入力し、スクリプトを生成することが可能です。
「メールの経路を通じて問い合わせが作成された際に、メールの本文と最新のメールのスレッドの内容を取得して、問い合わせの[説明]の項目を更新してください。」
指示文の内容をもとに、Ziaのコーディング支援ボットを通じてDelugeスクリプトが生成されます。このスクリプトによって、メールの最新のスレッドが取得され、問い合わせの[説明]項目が自動で更新されます。

Delugeのコーディング支援ボットの有効化

システム管理者は、必要に応じてDelugeのコーディング支援ボットを有効にできます。初期設定では、Delugeのコーディング支援ボットは無効になっています。カスタム関数の編集画面でDelugeのコーディング支援ボットを使用するには、事前にDelugeのコーディング支援ボットを有効にする必要があります。

メモ
メモ:
  1. Delugeのコーディング支援ボットの設定は、組織単位で適用されます。有効にすると、該当の組織全体においてDelugeのコーディング支援ボットが有効になります。
  2. Delugeのコーディング支援ボットは、ワークフロー用のカスタム関数においてのみ利用できます。
Delugeのコーディング支援ボットを有効にするには
  1. (設定)[Zia][生成AI]の順に移動します。
  2. [機能の設定]タブで、[Delugeのコーディング支援ボット]を有効にします。
  3. AIへのデータの開示に関する確認画面で、承認ボタンをクリックします。


関数を作成するには
  1. (設定)[自動化][ワークフロー][カスタム関数]の順に移動します。
  2. [新しい関数]をクリックします。
  3. [基本情報]のページで、以下の手順を実行します。
    1. 関数の名前と説明を入力します。
    2. 関数を実行するタブを選択します。
  4. 入力値の関連付け]の欄で、以下の操作を実行します。
    1. メソッド名を入力します。
    2. 関数と項目を関連付けるにあたって、入力値(引数)の名前を入力し、対象の項目を選択します。
    3. 入力値をさらに追加するには、(追加)ボタンをクリックして上記の手順を繰り返し行います。
  5. Delugeスクリプトの編集画面で、スクリプトを記述します。
  6. スクリプトを記述するにあたって、手動で入力したり、Delugeのコーディング支援ボットを使用したりできます。
    1. 画面右上にある[Zia]アイコンをクリックします。
    2. Ziaに対する指示文を入力し、送信アイコンをクリックします。
    3. 生成されたスクリプトを確認し、画面右上のコピーアイコンをクリックします。
    4. コピーしたスクリプトをDelugeスクリプトの編集画面に貼り付けます。

  7. [スクリプトを保存する]をクリックし、スクリプトを実行します。
  8. [スクリプトを保存して実行する]をクリックし、コードを実行します。

メモ

各種上限

  1. 関数の実行回数:1日あたり50,000回
  2. ステートメント数:関数ごとに200,000件
  3. 連携タスク:1か月あたり500,000回のAPIの実行
  4. URLの呼び出し:無制限
  5. メールの送信:2,500通/日
  6. カスタム関数は、2回までのみ繰り返し実行されます。この制限は、システムの負荷の増大や不要なAPI呼び出しを防止する目的で設けられています。
通知

主なエラーメッセージ

カスタム関数の使用中に表示される可能性のある主なエラーメッセージは、以下のとおりです。
  1. メールタスクの実行エラー:メール送信タスクを実行できなかった場合に表示されます。
  2. API実行タスクの評価エラー「{0}」:APIを実行できなかった場合に表示されます。
  3. 間違ったデータの種類が指定されました。テンプレート変数「{0}」の種類は{1}である必要があります:「set variable」(変数の設定)タスクにおいてデータの種類をテキストとして指定していたにもかかわらず、整数値を指定した場合に表示されます。
  4. {0}タスクの実行エラー:「call function」(関数の実行)で外部連携によるタスクを実行しようとしたにもかかわらず、実行できなかった場合に表示されます。
  5. テンプレート変数「{0}」を更新できません:テンプレート内で使っている変数に値を入れようとしたにもかかわらず、その値を計算するための式が正しく実行できなかった場合に表示されます。
  6. URL呼び出しの評価エラー:URLを呼び出す処理を実行しようとしたにもかかわらず、設定されたパラメーターが間違っているか、URLからの適切な応答がなかった場合に表示されます。

ワークフロールールでのカスタム関数の利用

カスタム関数は、テストと検証の完了後にワークフロールールの処理として設定できます。たとえば、顧客の種別に応じて問い合わせの優先度を自動で設定する関数を作成することが可能です。関数をテストした後、関数をワークフロールールに関連付けると、保守契約のある顧客の問い合わせの作成時に関数が自動で実行され、問い合わせの優先度が自動で「高」に更新されます。

ワークフロールールにカスタム関数を関連付けるには
  1. (設定)[自動化][ワークフロー]の順に移動します。
  2. ワークフロールールの設定ページで、[ルールを作成する]をクリックします。
  3. ワークフローに関する基本情報を入力して、[次へ]をクリックします。
  4. 次の画面で、ルールを実行する処理とルールの条件を指定します。
  5. [処理]の設定欄で追加)アイコンをクリックします。
  6. 既存のカスタム関数を選択します。
  7. [保存する]をクリックします。


スケジュール処理でのカスタム関数の利用

カスタム関数は、スケジュール処理として実行するように設定することもできます。日時に基づく処理や定期的な処理を自動で実行できます。スケジュール処理についての詳細は、「Zoho Deskでのスケジュール処理の作成と管理」をご参照ください。

実行履歴の表示

実行履歴では、カスタム関数の実行結果を確認できます。成功した処理と失敗した処理の両方の履歴データが表示されます。履歴は、ワークフロールールなどの自動化処理で関数が実行された際に自動で記録されます。

カスタム関数の実行履歴で確認可能な情報

  1. 実行ステータスと詳細
  2. 関数に入力された値
  3. print文の出力内容
カスタム関数の動作を確認し、自動処理のステータスを把握できます。

実行履歴の用途

  1. 関数の実行が失敗した際の問題の調査。
  2. エラーの原因の特定。
  3. 正常に実行された処理の確認
メモ
メモ:
  1. カスタム関数の履歴は、実行が成功した場合と失敗した場合の両方について確認できます。
  2. 履歴は、関数の実行後に生成されます。[業務の自動化]の権限を持つユーザーが確認できます。
  3. 成功した処理の履歴は、24時間保持されます。
  4. 失敗した処理の履歴は、30日間保持されます。

カスタム関数の実行履歴を表示するには
  1. (設定)[自動化][ワークフロー]の順に移動します。
  2. 画面左側のメニューで[ワークフロー]内にある[カスタム関数]をクリックします。
  3. [実行履歴]をクリックします。
  4. 実行履歴の一覧ページで、画面を下にスクロールして実行履歴を確認します。

メモ
実行履歴が表示されない場合の注意点:
  1. カスタム関数がまだ実行されていない場合、実行履歴は表示されません。
  2. 最新の履歴データを表示するには、ページを手動で更新する必要があります。
実行履歴を利用する際の注意点:
  1. カスタム関数の実行回数が上限に達すると、履歴の生成は翌日まで停止します。
  2. 実行履歴の表示件数に上限はありません。
  3. 新しく実行されたカスタム関数の履歴を表示するには、ページを更新します。

Delugeスクリプト作成ツールの使用

Delugeスクリプト作成ツールでは、ドラッグ&ドロップの操作で関数の内容を設定でき、Zoho Desk内でその関数を実行できます。Delugeスクリプトの構文や関数を覚える必要もなく、処理の内容を簡単に記述することが可能です。

Delugeの標準の認証情報

Delugeスクリプトの編集画面では、あらかじめ定義されている2種類の認証情報のみを使用できます。
  1. loginUserId:現在Zoho Deskポータルにサインインしているユーザー
  2. adminUserId:DRE(外部連携の管理ページ)の管理者
カスタム関数や新しい連携を最初に作成/実行したZoho Deskユーザーは、DREの管理者に設定されます。

Delugeスクリプトの編集画面でコマンドを実行するには:

カスタム関数スクリプトでのadminUserIdの使用

カスタム関数でadminUserIdを差出人としてメールを送信すると、受信トレイではメールの差出人として現在のDREの管理者のユーザー名が表示されます。


カスタム関数スクリプトでのadminUserIdの更新

adminUserIdは、Delugeスクリプトの編集画面から直接更新できません。管理者を別のユーザーに変更する場合は、下記の必要情報を添えてサポート窓口にご依頼ください。
      現在の情報
            メールアドレス(例:abc@zylkers.com
            ZUID(例:12345)
      更新後の情報
            メールアドレス(例:xyz@zylkers.com
            ZUID(例:98765)
情報の確認が完了すると、更新対応が開始されます。 

Delugeの処理の一覧