カスタム関数の活用

カスタム関数の活用

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

概要

カスタム関数を使用すると、共有、移動、コピー、項目の更新、アクセス制限といった標準のワークフローアクションを超えた高度な自動化を WorkDrive のワークフローに追加できます。
カスタム関数を使用すると、次のことができます：
  1. Deluge スクリプトを実行して、複雑なファイル管理ロジックを自動化する
  2. WorkDrive を他の Zoho 製品やサードパーティアプリケーションと連携する
  3. WorkDrive コネクションを使用して REST API 経由でデータを送受信する
  4. 高度な複数ステップのワークフローアクションを自動的に実行する
ファイルやフォルダーがワークフロー条件を満たすと、WorkDrive は関連付けられたカスタム関数を実行し、スクリプトで定義された処理を自動で行います。
カスタム関数はDeluge スクリプト言語で作成されます。これにより、開発者はデータ処理、WorkDrive コンテンツの更新、外部サービスとの連携を柔軟に実装できます。

カスタム関数を作成する

WorkDrive のカスタム関数は Deluge で記述され、管理コンソール > カスタム関数 セクションに保存されます。これらの関数は、チーム内の任意のワークフルールに関連付けることができます。
Notesメモ: カスタム関数を作成および管理できるのはチーム管理者のみです。


カスタム関数を作成する手順：
  1. 管理コンソール > カスタム関数 に移動します。
  2. + 新しい関数 をクリックします。



  3. 関数の作成 フォームで、次の項目を入力します。
    1. 関数名（コード内で使用）
      例: calculate_storage_cost

      メモ: 関数名は英字またはアンダースコアで始める必要があり、使用できるのは英字、数字、アンダースコアのみです。50 文字以内で指定してください。

    2. 表示名（一覧に表示）
      例: Calculate Storage Cost

    3. 説明（任意）
      関数の処理内容を簡潔に記載します。

  4. 作成 をクリックして、Deluge スクリプトエディターを開きます。
  5. エディターで関数ロジックを記述します（下記「カスタム関数をプログラムする」を参照）。
  6. 保存 をクリックして変更内容を保存します。
Notes
メモ: カスタム関数を自動実行するには、後で必ずワークフルールに関連付ける必要があります。

カスタム関数をプログラムする

カスタム関数は Deluge（Data Enriched Language for the Universal Grid Environment） によって動作します。Deluge を使用して、ワークフローデータの読み取り、計算処理、WorkDrive API の呼び出し、コネクションを介したサードパーティサービスとの連携などを行うことができます。



Deluge スクリプトエディターの利用
WorkDrive のカスタム関数エディターには、次の機能があります：
  1. スクリプトを記述するペイン
  2. 動的パラメーター用の参照フィールド候補
  3. 自動構文検証
  4. 引数（string 型および int 型）のサポート
  5. テスト実行時のコンソールログ

カスタム関数をテストする

カスタム関数をワークフローに関連付ける前に、関数エディターから直接テストできます。
カスタム関数をテストする手順：
  1. 管理コンソール > カスタム関数 から対象の関数を開きます。
  2. 保存してテスト をクリックします。


  3. 関数に引数が定義されている場合は、テスト値を入力するダイアログが表示されます。
  4. 確認 をクリックして関数を実行します。
  5. コンソールペインで結果を確認します。
    1. 実行ステータス（成功 / 失敗）
    2. 処理時間
    3. ログおよびデバッグ出力
これにより、ロジックの検証、API エラーの検出、関数の動作確認を行うことができます。

カスタム関数をワークフルールに関連付ける

作成したカスタム関数は、ワークフルールに関連付ける必要があります。レコードがワークフルールの条件に一致してルールがトリガーされると、関連付けられたカスタム関数も自動的に実行されます。

カスタム関数をワークフルールに関連付ける手順
  1. 管理コンソール > ワークフロー に移動します。
  2. 新しいワークフローを作成するか、既存のワークフローを編集します。
  3. その他のアクション で、カスタム関数を実行 を選択します。



  4. 一覧から対象の関数を選択します。
  5. 関数に引数がある場合：
    各引数を固定値にマッピングするか、「#」セレクターを使用してワークフローの動的値を割り当てます。サポートされるワークフローの動的値については、こちらを参照してください



  6. 保存 をクリックします。

カスタム関数を管理する

作成したすべてのカスタム関数は、「カスタム関数」ホームページに一覧表示されます。
  1. 管理コンソール > カスタム関数 にアクセスして、カスタム関数の画面を開きます。
  2. 関数名の横にある その他の操作 アイコン（…）をクリックして、利用可能な管理オプションを表示します。
  3. 利用可能なオプション：
    1. 関数を編集: 関数、スクリプト、メタデータを変更します
    2. 削除: ワークフローに関連付けられていない関数を削除します
Notes
メモ:
  1. カスタム関数がワークフローに関連付けられている場合、その関数を削除することはできません。
  2. 削除する前に、すべてのワークフローから当該関数を削除する必要があります。

制限事項

  1. 現在、1 チームあたり最大 50 個までカスタム関数を作成できます。
  2. カスタム関数は void 型の戻り値のみ使用できます。他の戻り値の型はサポートされていません。
  3. カスタム関数は、自動化カテゴリにのみ属することができます。
  4. 関数パラメーターは string 型または int 型のみ使用でき、その他の型は指定できません。
  5. 自動ワークフローでは、すべてのアクションはワークフロー作成者の権限で実行されます。カスタム関数は、自動ワークフローにおけるワークフローレベルの権限条件には従いません。
  6. すべてのカスタム関数のアクション（外部 API 呼び出しを含む）は、その関数を設定し、関連コネクションを作成したユーザーの権限で実行されます。

Deluge の制限

一定時間内に実行できる関数呼び出し数以外にも、関数内の行数やタイムアウトなど、いくつかの要素が各関数のパフォーマンスに影響します。以下の表は、機能別に適用される Deluge 関数の制限を示しています。

機能

説明

制限値

実行時間

関数は指定された時間内に実行を完了する必要があります。

1 分

レスポンスサイズの制限

関数が返すレスポンスには、上限サイズが設定されています。

10 MB

実行行数

関数は、コード内の実行行数に基づいて処理されます。

200,000 行

メール送信

send mail 構文を使用してメールを送信できます。

1,000 件/日

Webhook

GET および POST の URL

50,000 リクエスト/日

ダウンロード制限

カスタム関数内でダウンロードおよび処理できるファイルの最大サイズは 5 MB です。

5 MB

あわせてお読みください:
  1. WorkDrive でコネクションを作成する方法