Apex スケジューラーを使用したジョブのスケジュール
学習の目的
一緒にトレイルを進みましょう
インストラクターと一緒にこの手順を進めますか? 次の動画をご覧ください。これは Trailhead Live の「Trail Together」(一緒にトレイル) シリーズの一部です。
(この動画は 1:09:53 の時点から始まります。戻して手順の最初から見直す場合はご注意ください。)
スケジュール済みの Apex
Apex スケジューラーを使用すると、Apex クラスの実行を遅らせて、指定した日時に実行できます。このスケジューラーは、Apex 一括処理を使用した日次または週次のメンテナンス作業に最適です。スケジューラーを活用するには、Schedulable
インターフェースを実装する Apex クラスを記述して、特定のスケジュールで実行されるようにクラスをスケジュールします。
スケジュール済み Apex の構文
特定の時間に実行される Apex クラスを呼び出すには、まずクラスに Schedulable
インターフェースを実装します。次に、System.schedule()
メソッドを使用して、特定の時間に実行されるようにクラスのインスタンスをスケジュールします。
このクラスは Schedulable
インターフェースを実装し、このインターフェースに含まれるメソッド (execute()
メソッド) のみを実装する必要があります。
このメソッドのパラメーターは SchedulableContext
オブジェクトです。クラスがスケジュールされると、スケジュール済みジョブを表す CronTrigger
オブジェクトが作成されます。このオブジェクトには、CronTrigger
API オブジェクトの ID を返す getTriggerId()
メソッドがあります。
サンプルコード
このクラスは、進行中の商談のうち現在の日付までにクローズされているはずのものを照会し、所有者に商談を更新するよう通知する ToDo を各商談に作成します。
実行するクラスはプログラムを使用して、または Apex スケジューラー UI からスケジュールできます。
System.Schedule メソッドの使用
Schedulable
インターフェースを使用してクラスを実装したら、System.schedule()
メソッドを使用してこのクラスを実行します。System.schedule()
メソッドはすべてのスケジュールの基盤としてユーザーのタイムゾーンを使用しますが、システムモードで実行されます。つまり、ユーザーにそのクラスの実行権限があるかどうかにかかわらず、すべてのクラスが実行されます。
System.schedule()
メソッドは、ジョブの名前、ジョブの実行予定日時を表すために使用する CRON 式、Schedulable
インターフェースを実装するクラスのインスタンスという 3 つの引数を取ります。
スケジュールに使用する Cron 式 についての詳細は、「Apex スケジューラー」の「System.Schedule メソッドの使用」を参照してください。
UI からのジョブのスケジュール
- [設定] から、[クイック検索] ボックスに
「Apex」
と入力し、[Apex クラス] を選択します。 - [Apex をスケジュール] をクリックします。
- ジョブ名に
Daily Oppty Reminder
などと入力します。 - Apex クラスの横にあるルックアップボタンをクリックし、検索語に
「*」
と入力して、スケジュール可能なすべてのクラスのリストを取得します。検索結果で、スケジュール済みクラスの名前をクリックします。 毎週
または毎月
の頻度を選択して、必要な頻度を設定します。- 開始日と終了日、適切な開始時刻を選択します。
- [保存] をクリックします。
スケジュール済み Apex のテスト
これまでに説明した他の非同期メソッドと同様に、スケジュール済み Apex を使用する場合は、結果をテストする前にスケジュール済みジョブが終了していることを確認する必要があります。System.schedule()
メソッドの前後に startTest()
と stopTest()
を再度使用して、テストを続行する前に処理の終了を確認します。
留意事項
- スケジュール済み Apex ジョブは一度に 100 件しか設定できず、スケジュール済み Apex の 24 時間あたりの最大実行数も制限されています。詳細は、「リソース」セクションの「実行ガバナと制限」を参照してください。
- クラスをトリガーからスケジュールする場合は、細心の注意を払ってください。制限を超えるスケジュール済みジョブをトリガーで追加しないようにする必要があります。
- 同期 Web サービスコールアウトは、スケジュールされた Apex からは実行できません。コールアウトを実行するには、
@future(callout=true)
のアノテーションを付加したメソッドにコールアウトを配置し、このメソッドをスケジュールされた Apex からコールすることで非同期コールアウトを実行します。ただし、スケジュールされた Apex で一括処理ジョブを実行する場合、一括処理クラスからコールアウトを実行できます。