スタンドアロン機能の実行

スタンドアロン機能の実行

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

外部パラメーターで操作されるデータを処理するためのスタンドアロン関数を使用します。Zoho Sprints では、関数を作成し、REST API を利用して実行し、シンプルな業務ソリューションを実現できます。これらの関数は、サードパーティサービスやウェブから実行可能です。

スタンドアロン関数は、2つの方法で実行できます。関数を実行するためのスケジュールを作成する方法と、API を使用して実行する方法です。

シナリオ 1: スケジュールによる実行

Info
管理者ユーザーとして、期限切れの作業アイテムをユーザーに通知する必要があるとします。この要件を満たすため、スタンドアロン関数を作成し、期限切れアイテムの一覧ファイルを添付した週次メールリマインダーを送信できます。また、この関数のために繰り返しの週次スケジュールを設定し、定期的に実行させることも可能です。1時間程度のスクリプト作成で、重要な業務プロセスを自動化できます。

シナリオ 2: API による実行

Info
Zoho CRM から関数を呼び出す場合を想定します。CRM に新規リードを追加する際、Zoho Sprints に対応する作業アイテムを作成したいと考えています。そのためには、アイテム項目をカスタムパラメーターとして渡す必要があります。

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

スタンドアロン関数の作成方法:
  1. 右上のギアアイコンをクリックします。設定ウィンドウが表示されます。
  2. 自動化内の カスタム関数 を選択します。
  3. 関数ボタンのドロップダウンをクリックします。
  4. 関数 を選択します。「カスタム関数の作成」ウィンドウが表示されます。
  5. 表示名を入力します。
  6. 関数名を入力します。
    メモ: 一般的な命名規則により、関数名にスペースは使用できません。
  7. カテゴリーで Standalone を選択します。
  8. 関数の実行頻度を決定するため、繰り返し種別を選択します。
  9. 繰り返し種別に基づき、スケジュールの詳細を入力します。
  10. 関数の説明を入力します。
  11. Deluge スクリプトビルダーを使って関数を記述します。
  12. 保存をクリックして関数の作成を完了、または 保存して実行 をクリックして関数の作成と同時に実行を完了します。
 

API を使った関数の実行

API を利用すると、関数の一意の ID を使用してリモートで関数を実行できます。

Info
https://sprintsapi.Zoho.com/zsapi/team/{teamId}/customfunction/{functionId}/実行する/?arguments={'パラメーター':{'key1':'value1','key2':'value2', ....最大25パラメーター}}

パラメーターの利用

スタンドアロン関数でカスタムパラメーターを渡すことができます。パラメーターとは、関数に渡される値を指します。この値を渡すことで、必要なレスポンスや出力を取得できます。パラメーターの形式は、キーと値のペアとなります。

Info
delugeでパラメータ「key1」にアクセスするには、入力値 = sprintsAPIRequestMap.toMap().取得する('params').toMap().取得する('key1'); と記述します。
 
Notes
メモ:
  1. リクエスト内でステータスコードをカスタマイズしたり、カスタムヘッダーを送信したりできます。
  2. 最大25個までパラメーターを入力できます。
 

レスポンスオブジェクトの定義

APIのレスポンス形式を定義します。関数の初期設定レスポンス形式は、「返品する」がnullの場合はJSONです。ただし、Sprintsのスタンドアロン関数では、XML、HTML、プレーンテキストなど他の形式もサポートしており、オブジェクトのマッピングが必要です。レスポンス形式データを初期設定のレスポンス形式で指定したい場合は、「sprintsAPIResponse」キーにマップとして渡してください。