カスタム Functoid の開発

[アーティクル]
07/21/2023

BizTalk Server には、さまざまな種類の操作をサポートする多くの Functoid が用意されていますが、あらかじめ用意されている Functoid ではなく、別のアプローチが必要になる場合もあります。カスタム Functoid を使用すると、BizTalk Server のマッピング環境内で、さらに多くの種類の操作を実行できるようになります。各カスタム Functoid は、 Microsoft.BizTalk.BaseFunctoids から派生したクラスを使用して.NET アセンブリとして展開されます。 1 つのアセンブリには複数のカスタム Functoid を含めることができます。

次のシナリオでは、カスタム Functoid の使用を検討してください。

固有のレガシ API からのみアクセス可能なデータを使用している文字コードフィールドに対し、特殊な検証規則および変換規則を適用する場合。
カスタムのビジネスロジックとキー管理を使用して、フィールドを暗号化または暗号化解除する必要がある場合。
別のアプリケーションで使用するために、メッセージの一部からハッシュコードを生成する必要がある場合。
会計部門からの要求で、各部署に送信するメッセージに、製品の種類ごとの総売上に関する概要情報を含める必要がある場合。
関連する複数の手順を結合したり、別のアプローチを使用したり、新しいクラスライブラリを使用することによって、複雑なマップを単純化する場合。
1 つのスクリプト Functoid 内で、複数のマップが同一のスクリプトコードを使用する場合。
操作が失敗したときにイベントログに書き込む必要がある場合。

カスタム Functoid は、インラインコードを使用してソリューションに直接統合することも、グローバルアセンブリキャッシュに展開されたクラスライブラリ内のメソッドを参照することによって間接的に統合することもできます。どちらの種類の統合も BizTalk.BaseFunctoid クラスに依存し、同じ一連の一般的な手順に従います。

任意の .NET 言語を使用して新しいクラスライブラリプロジェクトを作成します。
厳密名ユーティリティ sn.exe を使用してキーファイルを作成し、プロジェクトに割り当てます。
Microsoft.BizTalk.BaseFunctoids.dll への参照を追加します。このアセンブリには、 BaseFunctoid 基本クラスが含まれています。
リソースファイルを作成してプロジェクトに追加し、 Functoid 名、ツールヒント、および説明用の文字列リソースを追加します。マップデザイナーパレットの Functoid を表す 16 x 16 ピクセルの画像リソースを追加します。
BaseFunctoid から派生し、コンストラクターで基本的なパラメーターを確立し、Functoid メソッドと任意のサポートメソッドを記述して、Functoid クラスを実装します。アセンブリには複数のカスタム Functoid を含めることができます。
アセンブリを展開し、ツールボックスパレットから新しい Functoid を使用できることを確認します。「Visual Studio ツールボックスでのカスタム Functoid の追加と削除」を参照してください。

次に、Floor Functoid の例を示します。

/// <summary>  
/// Floor Functoid - finds the floor of input  
/// </summary>  
public class FloorFunctoid : BaseFunctoid  
{  
    public FloorFunctoid()  
        : base()  
    {  
        this.ID = 11001;  
        SetupResourceAssembly("MultipleFunctoids.Resource", Assembly.GetExecutingAssembly());  
  
        SetName("NAME_FLOOR");  
        SetDescription("DESCRIPTION_FLOOR");  
        SetTooltip("DESCRIPTION_FLOOR");  
        SetBitmap("IMAGE_FLOOR");  
  
        SetExternalFunctionName(GetType().Assembly.FullName, " MultipleFunctoids.FloorFunctoid", "MathFloor");  
        this.RequiredGlobalHelperFunctions = InlineGlobalHelperFunction.IsNumeric;  
  
        AddScriptTypeSupport(ScriptType.CSharp);  
        SetMinParams(1);  
        SetMaxParams(1);  
  
        this.Category = FunctoidCategory.Math;  
        this.OutputConnectionType = ConnectionType.AllExceptRecord;  
        AddInputConnectionType(ConnectionType.AllExceptRecord);  
        this.HasSideEffects = false;  
    }  
  
    /// <summary>  
    /// To create the C# function  
    /// </summary>  
    /// <param name="scriptType">Script type</param>  
    /// <param name="numParams">Number of parameters</param>  
    /// <param name="functionNumber">Functoid number</param>  
    /// <returns>C# script</returns>  
    protected override string GetInlineScriptBuffer(ScriptType scriptType, int numParams, int functionNumber)  
    {  
        if (ScriptType.CSharp == scriptType)  
        {  
            StringBuilder builder = new StringBuilder();  
  
            builder.Append("public string MathFloor(string input)\n");  
            builder.Append("{\n");  
            builder.Append("  if(string.IsNullOrEmpty(input))\n");  
            builder.Append("    return string.Empty;\n");  
            builder.Append("double d = 0.0;\n");  
            builder.Append("if (IsNumeric(input, ref d))\n");  
            builder.Append("    return Math.Floor(d).ToString(System.Globalization.CultureInfo.InvariantCulture);\n");  
            builder.Append("else\n");  
            builder.Append("    return string.Empty;\n");  
            builder.Append("}\n");  
  
            return builder.ToString();  
        }  
        else  
        {  
            return string.Empty;  
        }  
    }  
}

このサンプルコードを C# プロジェクトの一部として使用する間、"アセンブリ名" は "MultipleFunctoids" に設定する必要があります。 C# プロジェクト (このコードを含む) には Resource.resx ファイルをインクルードしてください。

SetName("NAME_FLOOR");  
SetDescription("DESCRIPTION_FLOOR");  
SetTooltip("DESCRIPTION_FLOOR");  
SetBitmap("IMAGE_FLOOR");

上記のコードで、"NAME_FLOOR"、"DESCRIPTION_FLOOR"、"DESCRIPTION_FLOOR" の各値は Resource.resx ファイルに埋め込まれたリソース文字列の "キー"です。また、"IMAGE_FLOOR" は Resource.resx ファイルに埋め込まれた画像の名前です。この画像は Functoid のアイコンとして機能します。

適切なリソースキーを指定しないか SetName メソッドを削除した場合、名前のないカスタム Functoid が作成されますが、これはお勧めできません。 SetDescription メソッドと SetTooltip メソッドについても同様です。常にこれらのメソッドを適切に使用し、望ましくない操作は避けてください。ただし、Functoid アイコンとして使用するのに適した画像がない場合は、SetBitmap メソッドをスキップすることができます。そのような場合、既定のアイコンがカスタム Functoid により使用されますが、これは問題ありません (複数の Functoid にアイコンがない場合を除く)。

カスタム Functoid を作成する方法の詳細については、「Custom Functoid (BizTalk Server Sample)」を参照してください。

重要

一部の Functoid ID は標準/組み込みマッパー Functoid 用に予約されています。通常、標準のマッパー Functoid では、1 から 10000 までの ID が使用されます。カスタム Functoid の作成時に、10000 未満の Functoid ID は使用しないでください。

このセクションの内容

このセクションには、次のトピックが含まれています。

参照

Functoid を使用した複雑なマッピングの作成

カスタム Functoid の開発

このセクションの内容

参照

フィードバック

フィードバック

その他のリソース