カスタム関数の管理

カスタム関数の管理

お知らせ：当社は、お客様により充実したサポート情報を迅速に提供するため、本ページのコンテンツは機械翻訳を用いて日本語に翻訳しています。正確かつ最新のサポート情報をご覧いただくには、本内容の英語版を参照してください。

カスタム関数を使用すると、Delugeでユーザー定義関数を開発して実行できます。簡単なプログラムスニペットを実行して、プロセスの自動化や、サードパーティまたはZohoアプリケーションとの連携を行えます。   

カスタム関数のビジネスでの活用

  1. 特定の遷移やカードの更新が実行されたときに、カスタム関数を使用してカードを前または次のステージに自動的に移動できます。
  2. カスタム関数を使用して、Zoho Desk、Zoho Cliq、MS Teamsなど、組織で使用している他のアプリケーションにコメント、メッセージ、更新情報を投稿することもできます。
ユーザーは、新しいカスタム関数を設定するか、 関数ギャラリーで利用可能な定義済み関数を使用できます。

カスタム関数呼び出し用のAPI認証

カスタム関数は、ブループリントやビジネスルールを使用してQntrl内から呼び出すことも、API呼び出しを使用して他のサードパーティアプリケーションから呼び出すこともできます。APIを使用して関数をトリガーするために、Qntrlでは次の2つの認証方法をサポートしています。
  1. OAuth 2.0
  2. APIキー


OAuth 2.0 プロトコルは、組織内で取得、作成、更新、削除操作を実行するために、ユーザーがREST APIにアクセスできる安全な認証方式です。

QntrlでOAuth 2.0を使用して認証する方法については、こちらをご参照ください。

APIキーは一度限りの認証に使用できますが、OAuth 2.0認証ほど安全ではありません。OAuth 2.0プロトコルではアクセストークンを1時間ごとに再生成する必要がありますが、APIキーでは認証用のキーが1回発行されます。

APIキーを使用して認証するには、次のリクエストURL形式を使用します。

  1. https://core.qntrl.com/blueprint/ <organization-name>/customfunction/executeFunction/<custom-function-ID>
ベストプラクティス
  1. APIキーにアクセスできるユーザーはすべての操作を実行できるため、権限のないユーザーや外部ユーザーとAPIキーを共有しないでください。
  2. セキュリティを確保するため、APIキーを定期的に再生成することをおすすめします。

OAuth 2.0認証
APIキー認証
OAuth 2.0プロトコルでは、認証にヘッダーを使用します。
APIキーはリクエストURLで認証されます。
Qntrl のすべてのカスタム関数は、OAuth 2.0プロトコルを使用して認証できます。
APIキーを使用して認証できるのは、スタンドアロン関数のみです。
OAuth 2.0認証では、アクセストークンは1時間ごとに期限切れになります。更新トークンを使用して、新しいアクセストークンを生成します。
APIキーは一度だけ生成する必要があります。期限切れになりません。

ビジネスシナリオ  

  • 採用プロセスで候補者が選定されたら、募集中の職位数を会社のWebサイトに動的に反映します。

  • ユーザーが各ステージで費やした合計時間を計算し、請求用の詳細な概要をクライアントにメールで送信します。

  • Qntrlをカレンダーアプリケーションと連携し、選考通過者に面接招待を送信します。

  • Qntrlを Jiraと連携し、Jiraで作成された各プロジェクトに対してQntrlにカードを追加します。


カードベースのカスタム関数の作成

  1. に移動し、 メニューの［詳細設定］で［カスタム関数］を選択します 。

  2. ［新しいカスタム関数］ をクリックします。

  3. 詳細を入力します。

    • ［タブの種類］：関数でカード引数が必要な場合は、 ［カード］を選択します。

    • ［関数名］ ：関数に名前を付けます。

    • ［戻り値の種類］：カードベースのカスタム関数の戻り値の種類は常に void です。

    • ［説明］ ：関数の動作を説明します。

    • ［引数］ ：コードスニペットで使用する引数を入力します。 カスタム値を使用するか、ドロップダウンからフォーム項目を選択できます。フォーム項目は、カスタム関数に対応するカード項目から動的な値を取得します。  

    • ［接続］ ：内部連携またはサードパーティ連携をこちらで設定します。接続の詳細については、こちらをご参照ください。

    • カスタム関数をコーディングします。

  4. ［保存］または［保存して実行］をクリックします。    

  1. カードベースのカスタム関数は、OAuth 2.0プロトコルでのみ呼び出せます。
  2. ブループリントとビジネスルールから呼び出せるのは、カードベースのカスタム関数のみです。
  3. ［タブの種類］は、一度選択すると編集できません。
  4. ドロップダウン項目の引数は、APIで取得した項目 IDを使用して渡せます。



スタンドアロンのカスタム関数の作成

  1.   に移動し、 メニューの ［詳細設定］ で［カスタム関数］を選択します。  

  2. ［新しいカスタム関数］をクリックします。

  3. 詳細を入力します。

    • ［タブの種類］：関数で独立した引数のみが必要な場合は、［スタンドアロン］を選択します。

    • ［関数名］：関数に名前を付けます。

    • ［戻り値の種類］：カスタム関数の戻り値の種類を選択します。

    • ［説明］：関数の動作を説明します。

    • ［引数］：コードスニペットで使用する引数を入力します。

    • ［接続］：内部連携または外部サービス連携をこちらで設定します。接続の詳細はこちらをご参照ください。

    • カスタム関数のコードを記述します。

  4. ［保存］または ［保存して実行］ をクリックします。    

  1. スタンドアロンのカスタム関数は、OAuth 2.0プロトコルまたはAPIキーを使用して呼び出せます。
  2. ［タブの種類］は、一度選択すると編集できません。



APIキーを使用したスタンドアロン関数の呼び出し  

APIキーを使用してスタンドアロン関数を呼び出すには、まず有効にする必要があります。APIキーが組織設定で生成されていることを確認してください。

  1. カスタム関数にカーソルを合わせ、をクリックします。
  2. ドロップダウンから［REST API］を選択します。
  3. APIキーの横にあるボタンを切り替えて有効にします。

カスタム関数のスケジュール設定

カスタム関数は、Qntrlのスケジュールを使用して、定期的または指定した時間間隔で実行できます。

スケジュールで使用中のカスタム関数は削除できません。

ブループリントへのカスタム関数の関連付け


カスタム関数は、ブループリントで遷移が実行された後に起動するよう設定できます。ブループリントの詳細はこちらをご参照ください。
  1. ［ボード］に移動し、左パネルで対象のボードにカーソルを合わせ、をクリックして［ボードの管理］を選択します。（または）
  2.  に移動してボードを選択します。
  3. ステップ2：［ブループリントの設計］に移動します。
  4. 遷移をクリックし、右パネルの ［後］ セクションに移動します。
  5. 次に、   ［即時処理］ または ［スケジュール処理］ で、 アイコン（ ［カスタム関数の関連付け］ の横）をクリックします。
  6. ［関数ギャラリー］ または ［設定済みの関数］から関数を選択します。
    1. 関数ギャラリーから関数を関連付ける場合は、 ［新規として保存］をクリックします。
    2. 設定済みの関数を関連付ける場合は、 ［保存］ または ［保存して実行］ をクリックします。

  7. 関数を設定したら、［保存］をクリックしてブループリントを保存します。



ブループリントの各遷移には、最大3件のカスタム関数を関連付けることができます。

ビジネスルールへのカスタム関数の関連付け


ビジネスルールは、カードが作成または更新されたとき、または項目が更新されたときに実行されるように設定します。 詳細： ビジネスルールについてはこちらをご参照ください。ビジネスルールに関連付けられたカスタム関数を実行することもできます。

  1.     に移動し、［ビジネスルール］をメニューの ［自動化］ から選択します。（または）

  2. クイックアクセス設定を使用して、ボード固有のビジネスルールに移動します。詳細はこちら。
  3. 新しいビジネスルールを作成するか、既存のルールを開きます。ビジネスルールの詳細はこちらをご参照ください。
  4. ルールの詳細を入力し、［条件と処理］に進みます。
  5. 次に、アイコン（［即時処理］または［スケジュール処理］の横）をクリックし、ドロップダウンから ［カスタム関数］    を選択します。

  6. ［関数ギャラリー］ または ［設定済みの関数］から関数を選択します。

    • 関数ギャラリーから関数を関連付ける場合は、 ［新規として保存］ をクリックします。

    • 設定済みの関数を関連付ける場合は、 ［保存］ または ［保存して実行］ をクリックします。

  7. 関数を設定したら、 ［保存］ をクリックします。  




各ビジネスルールには、最大3件のカスタム関数を関連付けることができます。

カスタム関数の優先実行


カスタム関数がQntrl でトリガーされると、実行までに1〜2分かかる場合があります。ただし、特定のカスタム関数を優先して即時に実行するよう選択できます。
  1. ブループリント／ビジネスルールで、関連付けられているカスタム関数に移動し、カーソルを合わせます。
  2. ［その他のオプション］をクリックし、［この関数の実行を優先］にチェックを入れます。
  

メモ：
  1. スケジュール処理に設定されたカスタム関数は優先実行できません。
  2. 即時処理ブロックごとに優先実行できるカスタム関数は1件のみです。

カスタム関数の削除


不要になったカスタム関数は削除できます。削除すると、関連付けられているブループリントの遷移とビジネスルールから削除されます。  

  1.   に移動し、 メニューから［カスタム関数］を［詳細設定］配下で選択します。（または）

  2. ​クイックアクセス設定を使用して、ボード固有のビジネスルールに移動します。詳細はこちら。


  3. 削除する関数名にマウスのカーソルを合わせます。

  4. をクリックし、［削除］を選択します。

  5. 操作を確定します。


    • Related Articles

    • REST API

      お知らせ：当社は、お客様により充実したサポート情報を迅速に提供するため、本ページのコンテンツは機械翻訳を用いて日本語に翻訳しています。正確かつ最新のサポート情報をご覧いただくには、本内容の英語版を参照してください。 アクセス権限 APIキーは、組織の所有者のみが生成できます。 APIキーは、QntrlでAPI呼び出しを実行するための一回限りの認証に使用します。APIキーを使用して呼び出せるのは、スタンドアロンのカスタム関数のみです。 に移動し、［REST API］を［組織］から選択します。 ...