開発者ガイド

最終更新日時 2024年10月25日

カスタムトリガーの作成方法

オートメーションプロジェクトでトリガーの機能を利用できるようになりました。トリガーは、特定のアクションを発生させるためにマシンのアクティビティで特定のイベントがないか監視します。トリガーは [イベントを監視] フレームワークを使用して設定できますが、このガイドで説明しているようにカスタムトリガーを構築することもできます。

前提条件

カスタムトリガーを作成するには、以下が必要です。

Microsoft Visual Studio
Microsoft .NET Framework v4.6.1 以降

プロジェクトを作成および構成する

Microsoft Visual Studio を開き、新しいプロジェクトを作成することを選択します。 [プロジェクト] 選択ウィンドウが表示されます。
[ クラスライブラリ (.NET Framework)]を選択し、[ 次へ] をクリックします。 [新しいプロジェクトを設定 ] ウィンドウが表示されます。
プロジェクト名、場所、ソリューション名、フレームワークを指定します。 .NET Framework 4.6.1 以降のフレームワークを選択してください。すべてのフィールドに入力したら、[ 作成] をクリックします。新しいプロジェクトが作成され、デザイナーウィンドウが表示されます。
[ツール ] メニューから [ オプション] を選択します。 [オプション] ウィンドウが表示されます。
[NuGet Package Manager] のエントリを展開し、[ Package Sources] を選択します。
新しいパッケージソースを追加し、[ 名前] フィールドに UiPath オフィシャルフィード を入力し、[ ソース ] フィールドに https://pkgs.dev.azure.com/uipath/Public.Feeds/_packaging/UiPath-Official/nuget/v3/index.jsonを入力します。 [ OK] を クリックして、変更を確定し、保存します。
[ ツール ] メニューをクリックし、[ NuGet Package Manager ] のエントリから [ Solution...] の [NuGet パッケージを管理] を選択します。 [ NuGet - ソリューション ] タブが表示されます。
UiPath Platform の参照を検索して選択します。右側のパネルで、参照を追加するプロジェクトを選択して [ インストール] をクリックします。 [ プレリリースを含める ] チェックボックスをオンにして、 UiPath Platform v20.8 以上の参照をインストールしてください。

トリガーコードを記述する

Once the references are added to the project, it's time to write the code, which should look something like this:

using System; 
using System.Activities; 
using System.Threading; 
using UiPath.Platform.Triggers; 
 
public class TimerTrigger : TriggerBase<TimerTriggerArgs> 
{ 
 //it is recommended to use Variable to store fields in order for  
 //activities like Parallel For Each to work correctly 
   private readonly Variable<Timer> _timer = new Variable<Timer>();   
  public InArgument<TimeSpan> Period { get; set; }    
protected override void CacheMetadata(NativeActivityMetadata metadata) 
    { 
        metadata.AddImplementationVariable(_timer); 
        base.CacheMetadata(metadata); 
    }     
  
//in this method you can subscribe to events. It is called when the trigger starts execution 
protected override void StartMonitor(NativeActivityContext context, Action<TimerTriggerArgs> sendTrigger) 
    { 
        var eventIndex = 0; 
        var period = Period.Get(context); 
        _timer.Set(context, new Timer(OnTick, state: null, dueTime: period, period: period)); 
        return;  
void OnTick(object state) => sendTrigger(new TimerTriggerArgs(eventIndex++));    
}     
 
   //this is used for cleanup. It is called when the trigger is Cancelled or Aborted 
   protected override void StopMonitor(ActivityContext context) => _timer.Get(context).Dispose(); 
} 
 
//Each trigger may declare a type that sub-classes TriggerArgs 
//that corresponds to the “args” item in Trigger Scope activity. If no extra info 
//needs to be passed along, TriggerArgs can be used directly 
public class TimerTriggerArgs : TriggerArgs 
{ 
    public int EventIndex { get; } 
 
    public TimerTriggerArgs(int eventIndex) => EventIndex = eventIndex; 
}using System; 
using System.Activities; 
using System.Threading; 
using UiPath.Platform.Triggers; 
 
public class TimerTrigger : TriggerBase<TimerTriggerArgs> 
{ 
 //it is recommended to use Variable to store fields in order for  
 //activities like Parallel For Each to work correctly 
   private readonly Variable<Timer> _timer = new Variable<Timer>();   
  public InArgument<TimeSpan> Period { get; set; }    
protected override void CacheMetadata(NativeActivityMetadata metadata) 
    { 
        metadata.AddImplementationVariable(_timer); 
        base.CacheMetadata(metadata); 
    }     
  
//in this method you can subscribe to events. It is called when the trigger starts execution 
protected override void StartMonitor(NativeActivityContext context, Action<TimerTriggerArgs> sendTrigger) 
    { 
        var eventIndex = 0; 
        var period = Period.Get(context); 
        _timer.Set(context, new Timer(OnTick, state: null, dueTime: period, period: period)); 
        return;  
void OnTick(object state) => sendTrigger(new TimerTriggerArgs(eventIndex++));    
}     
 
   //this is used for cleanup. It is called when the trigger is Cancelled or Aborted 
   protected override void StopMonitor(ActivityContext context) => _timer.Get(context).Dispose(); 
} 
 
//Each trigger may declare a type that sub-classes TriggerArgs 
//that corresponds to the “args” item in Trigger Scope activity. If no extra info 
//needs to be passed along, TriggerArgs can be used directly 
public class TimerTriggerArgs : TriggerArgs 
{ 
    public int EventIndex { get; } 
 
    public TimerTriggerArgs(int eventIndex) => EventIndex = eventIndex; 
}