関数のスケジュール設定

関数のスケジュール設定

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

スケジュール関数とは？

スケジュール関数を使用すると、毎時、毎日、毎週、毎月など、指定したスケジュールに基づいてカスタム関数を実行できます。この機能は、毎月のレポート作成や、今後公開予定のマイルストーンや期限についてポータルユーザーに自動メールを送信するなど、特定の処理に依存せずに繰り返し行う処理を自動化する際に役立ちます。

カスタム関数とスケジュール関数の違い

カスタム関数は、特定の処理やプロセスを自動化するためのコードです。スケジュール関数は、これらの処理やプロセスをいつ、どの頻度で実行するかを決定し、ユーザーが実行間隔を指定できるようにします。

利用例

プロジェクトマネージャーにとって、ポータルデータの定期的なバックアップを維持することは、データのセキュリティと完全性を確保するうえで不可欠です。バックアップデータを手動でエクスポートするのは時間がかかります。スケジュール関数を使用してバックアップデータのエクスポート処理を自動化し、定期的なバックアップを確実に実行できます。

これを設定するには、ProjectDataBackupExport という名前のスケジュール関数を作成し、最初の実行スケジュール（例：毎週または毎月）を指定し、繰り返し種別を選択し、必要に応じて終了条件と休日の動作を設定します。以下の Deluge スクリプトを入力し、エクスポート処理を自動化するようにカスタマイズします。Zoho プロジェクト内のスケジュール関数ログを監視して実行状況を確認できます。

Deluge スクリプト:


// TODO: Zoho プロジェクトサービス用に、スコープ 'ZohoProjects.portals.READ' を持つコネクションを作成し、'xxxxxxxxx' をコネクション名に置き換えてください。コネクションの作成方法については、以下のリンクをクリックして参照してください。

// https://help.zoho.com/portal/en/kb/projects/integration/connections/articles/connections-23-5-2022#How_to_establish_a_Connection

projectsAPIEndPoint = 'https://projectsapi.zoho.com/api/v3';

exportResponse = invokeurl

[

url :projectsAPIEndPoint + '/portal/' + portalId + '/portal_export'

種類 :POST

connection:'xxxxxxxxx'

];

info exportResponse;

スケジュール関数を作成する

  1. 右上隅の をクリックします。
  2. 開発者向け情報 > Schedule Functions に移動します。
  3. Create Schedule Function をクリックします。
  4. Function 名前 と 説明 を入力し、Arguments を設定します。
  5. 最初の実行のスケジュール日時を設定します。
  6. 希望に応じて 繰り返し Types を選択します。
    1. Once: スケジュール関数は指定した日時に 1 回だけ実行されます。それ以降は実行されません。
    2. 毎時間: 関数を毎時間の間隔で繰り返し実行したい場合に選択します。繰り返し頻度項目で希望する時間間隔を指定すると、関数は「A」時間ごと（例：2 時間ごと、4 時間ごと）に実行されます。
    3. 毎日: 各実行の間隔となる日数を選択します。毎日実行する場合は 1、1 日おきに実行する場合は 2、というように繰り返し頻度項目で指定します。
    4. Weekly: 繰り返し頻度項目で「A」週間ごとの頻度を定義します。繰り返し On 項目から希望する曜日（Monday、Tuesday など）を選択すると、関数は指定した曜日に「A」週間ごとにのみ実行されます。
    5. 月間: 繰り返し頻度項目から「A」か月ごとの頻度を選択します。繰り返し On 項目で「A specific day」を選択し、1 日、15 日など、月内の特定の日付を指定できます。また、月末に実行する、または繰り返し On 項目から第 2 金曜日、第 3 木曜日、最終金曜日など N 番目の曜日に実行するように設定することもできます。
  7. End Conditions を指定し、スケジュール関数をいつ終了させるかを設定します。
    1. Never: 関数は手動で停止するまで無期限に実行され続けます。
    2. On: 最終実行日となる特定の日付（例：12-03-2024）を指定します。関数は指定した日付のその日の終わりに終了します。
    3. After: 関数を停止するまでに実行する回数を入力します。
  8. Holidays における関数の動作を制御します。
    1. Run Schedule: 休日であっても関数を実行します。
    2. Skip Schedule: 休日に当たる場合はスケジュール関数をスキップし、次回は指定した繰り返し種別に従って開始されます。
    3. Run On Previous Working Day: 実行日を直前の営業日に繰り上げます。
    4. Run On Next Working Day: 実行日を次の営業日に繰り延べします。
  9. 画面を下にスクロールし、Deluge スクリプトエディターにコードを入力するか、エディター左側パネルの利用可能なパラメーターをドラッグ＆ドロップしてカスタマイズします。
  10. Schedule をクリックして保存およびスケジュールするか、Run をクリックしてすぐに関数を実行します。
  1. 「Run On Previous Working Day」オプションと同様に、直前の営業日がすでにスケジュール時刻を過ぎている場合、スケジュール関数はスキップされます。
  1. 休日の動作を「Skip Schedule」「Run On Previous Working Day」「Run On Next Working Day」に設定している場合、10 連続で休日または週末に当たるとスケジュールは自動的に停止します。

 

スケジュール関数を編集する

  1. 右上隅の をクリックします。
  2. 開発者向け情報 > Schedule Functions に移動します。
  3. 対象のスケジュール関数にカーソルを合わせ、> 編集 をクリックします。
  4. 必要な変更を行い、保存 をクリックします。
    1. 更新後の日付は将来の日付である必要があります。
  5. または、スケジュール関数名をクリックして編集することもできます。
スケジュール関数の日付を更新すると、その後の実行に対するスケジュールが再設定されます。

スケジュール関数を管理する

  1. 右上隅の をクリックします。
  2. 開発者向け情報 > Schedule Functions に移動します。
  3. 対象のスケジュール関数にカーソルを合わせ、> 複製する をクリックして、既存のスケジュール関数を複製します。
  4. 削除 をクリックして、スケジュール関数を削除します。
  5. Run Now をクリックして、スケジュール関数を即時実行します。
  6. ステータスのトグルをオン／オフに切り替えて、スケジュール関数を有効化／無効化します。
  7. スケジュール関数にカーソルを合わせ、表示する Info をクリックすると、最終更新時刻、更新者、作成者、作成時刻を確認できます。
  8. 右上隅の をクリックし、Logs をクリックして、スケジュール関数の実行履歴を確認します。
スケジュール日時がすでに過ぎている場合、または指定した実行回数に達している場合は、スケジュール関数を有効化することはできません。