カスタムタスクの作成

[アーティクル]
05/23/2023

適用対象: SQL Server Azure Data Factory の SSIS 統合ランタイム

カスタムタスクの作成手順は、Integration Services の他のカスタムオブジェクトの作成手順と同様です。

基本クラスを継承する新しいクラスを作成します。タスクの場合、基本クラスは Microsoft.SqlServer.Dts.Runtime.Task です。
クラスに、オブジェクトの種類を識別する属性を適用します。タスクの属性は DtsTaskAttribute です。
基本クラスのメソッドとプロパティの実装をオーバーライドします。タスクでは、Validate メソッドおよび Execute メソッドが対象です。
必要に応じて、カスタムユーザーインターフェイスを開発します。タスクでは、IDtsTaskUI インターフェイスを実装するクラスが必要です。

カスタムタスクの概要

プロジェクトおよびクラスの作成

すべてのマネージドタスクは Microsoft.SqlServer.Dts.Runtime.Task 基本クラスから派生するため、カスタムタスクを作成するには、最初に任意のマネージドプログラミング言語でクラスライブラリプロジェクトを作成し、基本クラスを継承するクラスを作成します。この派生クラスで、基本クラスのメソッドとプロパティをオーバーライドして、カスタム機能を実装します。

同じソリューション内に、もう 1 つのクラスライブラリプロジェクトをカスタムユーザーインターフェイス用に作成します。配置を容易にするため、ユーザーインターフェイス用に別個のアセンブリを使用することをお勧めします。そうすれば、接続マネージャーやそのユーザーインターフェイスの更新や再配置を個別に行うことができます。

どちらのプロジェクトも、アセンブリに署名するよう構成します。アセンブリは、厳密な名前のキーファイルを使用して、ビルド時に生成されます。

DtsTask 属性の適用

作成したクラスに DtsTaskAttribute 属性を適用して、そのクラスがタスクとして識別されるようにします。この属性には、名前、説明、およびタスクの種類など、デザイン時の情報を指定します。

UITypeName プロパティを使用して、タスクをそのカスタムユーザーインターフェイスにリンクします。このプロパティに必要な公開キートークンを取得するには、sn.exe -t を使用して、ユーザーインターフェイスアセンブリへの署名に使用するキーペア (.snk) ファイルから公開キートークンを表示します。

using System;  
using Microsoft.SqlServer.Dts.Runtime;  
namespace Microsoft.SSIS.Samples  
{  
  [DtsTask  
  (  
   DisplayName = "MyTask",  
   IconResource = "MyTask.MyTaskIcon.ico",  
   UITypeName = "My Custom Task," +  
   "Version=1.0.0.0," +  
   "Culture = Neutral," +  
   "PublicKeyToken = 12345abc6789de01",  
   TaskType = "PackageMaintenance",  
   TaskContact = "MyTask; company name; any other information",  
   RequiredProductLevel = DTSProductLevel.None  
   )]  
  public class MyTask : Task  
  {  
    // Your code here.  
  }  
}

Imports System  
Imports Microsoft.SqlServer.Dts.Runtime  
  
<DtsTask(DisplayName:="MyTask", _  
 IconResource:="MyTask.MyTaskIcon.ico", _  
 UITypeName:="My Custom Task," & _  
 "Version=1.0.0.0,Culture=Neutral," & _  
 "PublicKeyToken=12345abc6789de01", _  
 TaskType:="PackageMaintenance", _  
 TaskContact:="MyTask; company name; any other information", _  
 RequiredProductLevel:=DTSProductLevel.None)> _  
Public Class MyTask  
  Inherits Task  
  
  ' Your code here.  
  
End Class 'MyTask