カスタム追跡

このトピックの内容は、Windows Workflow Foundation 4 に該当します。

このサンプルでは、カスタムの追跡参加要素を作成し、追跡データをコンソールに出力する方法を示します。また、ユーザー定義データが設定された CustomTrackingRecord オブジェクトを出力する方法も示します。コンソール ベースの追跡参加要素は、コードで作成された追跡プロファイル オブジェクトを使用して、ワークフローで出力された TrackingRecord オブジェクトをフィルター処理します。

サンプルの詳細

Windows Workflow Foundation (WF) には、ワークフロー インスタンスの実行を追跡できる追跡インフラストラクチャが用意されています。追跡ランタイムは、ワークフロー ライフサイクルに関連するイベント、ワークフロー アクティビティのイベント、およびカスタム追跡イベントを出力するワークフロー インスタンスを実装しています。次の表で、追跡インフラストラクチャの主要コンポーネントの詳細を説明します。

次の表で、ワークフロー ランタイムが出力する追跡レコードの詳細を説明します。

追跡参加要素は、追跡プロファイルを使用して、出力された TrackingRecord オブジェクトのサブセットをサブスクライブします。追跡プロファイルには、特定の追跡レコード タイプをサブスクライブするための追跡クエリが含まれています。追跡プロファイルは、コードで指定したり、構成で指定したりすることができます。

カスタムの追跡参加要素

追跡参加要素 API では、ワークフロー ランタイムが出力する TrackingRecord オブジェクトを処理するためのカスタム ロジックを含めることが可能なユーザー指定の追跡参加要素を使用して、追跡ランタイムを拡張できます。

追跡参加要素を書き込むには、ユーザーは TrackingParticipant を実装する必要があります。具体的には、カスタム参加要素で Track メソッドを実装する必要があります。このメソッドは、ワークフロー ランタイムによって TrackingRecord が出力されるときに呼び出されます。

public abstract class TrackingParticipant
    {
        protected TrackingParticipant();

        public virtual TrackingProfile TrackingProfile { get; set; }
        public abstract void Track(TrackingRecord record, TimeSpan timeout);
    }
}

完全な追跡参加要素は ConsoleTrackingParticipant.cs ファイルで実装します。次のコード例は、カスタム追跡参加要素の Track メソッドです。

public override void Track(TrackingRecord record, TimeSpan timeout)
        {
            ...

            WorkflowInstanceRecord workflowInstanceRecord = record as WorkflowInstanceRecord;
            if (workflowInstanceRecord != null)
            {
                Console.WriteLine(String.Format(CultureInfo.InvariantCulture,
                    " Workflow InstanceID: {0} Workflow instance state: {1}",
                    record.InstanceId, workflowInstanceRecord.State));
            }

            ActivityStateTrackingRecord activityStateTrackingRecord = record as ActivityTrackingRecord;
            if (activityStateTrackingRecord != null)
            {
                ...
                 Console.WriteLine(String.Format(CultureInfo.InvariantCulture,
                    " :Activity DisplayName: {0} :ActivityInstanceState: {1} {2}",
                       activityStateTrackingRecord.Name, activityStateTrackingRecord.State,
                    ((variables.Count > 0) ? vars.ToString() : String.Empty)));
            }

            CustomTrackingRecord customTrackingRecord = record as CustomTrackingRecord;

            if ((customTrackingRecord != null) && (customTrackingRecord.Data.Count > 0))
            {
                ...
            }
            
        }

次のコード例では、ワークフロー インスタンスにコンソール参加要素を追加します。

ConsoleTrackingParticipant customTrackingParticipant = new ConsoleTrackingParticipant()
            {
              ...
             // The tracking profile is set here, refer to Program.CS
            ...
            }
WorkflowInstance wfInstance = new WorkflowInstance(BuildSampleWorkflow());
wfInstance.Extensions.Add(customTrackingParticipant);

カスタム追跡レコードの出力

このサンプルでは、カスタム ワークフロー アクティビティから CustomTrackingRecord オブジェクトを出力する機能も示します。

• CustomTrackingRecord オブジェクトは、レコードと一緒に出力する必要があるユーザー定義データを使用して作成および設定します。

• CustomTrackingRecord を出力するには、ActivityContext の追跡メソッドを呼び出します。

次の例では、カスタム アクティビティ内で CustomTrackingRecord オブジェクトを出力する方法を示します。

// Create the Custom Tracking Record
CustomTrackingRecord customRecord = new CustomTrackingRecord("OrderIn")
                {
                    Data = 
                            {
                                {"OrderId", 200},
                                {"OrderDate", "20 Aug 2001"}
                            }
                };

// Emit custom tracking record
context.Track(customRecord);

このサンプルを使用するには

1. Visual Studio 2010 を使用して、CustomTrackingSample.sln ソリューション ファイルを開きます。

2. ソリューションをビルドするには、F6 キーを押します。

3. ソリューションを実行するには、Ctrl キーを押しながら F5 キーを押します。

注 :
サンプルは、既にコンピューターにインストールされている場合があります。続行する前に、次の (既定の) ディレクトリを確認してください。 <InstallDrive>:\WF_WCF_Samples このディレクトリが存在しない場合は、「.NET Framework 4 向けの Windows Communication Foundation (WCF) および Windows Workflow Foundation (WF) のサンプル」にアクセスして、Windows Communication Foundation (WCF) および WF のサンプルをすべてダウンロードしてください。このサンプルは、次のディレクトリに格納されます。 <InstallDrive>:\WF_WCF_Samples\WF\Basic\Tracking\CustomTracking