Rilevamento personalizzato
L'esempio CustomTracking illustra come creare un partecipante di rilevamento personalizzato e scrivere il contenuto dei dati di rilevamento nella console. Nell'esempio viene inoltre illustrato come generare oggetti CustomTrackingRecord popolati con dati definiti dall'utente. Il partecipante di rilevamento basato su console filtra gli oggetti TrackingRecord generati dal flusso di lavoro usando un oggetto profilo di rilevamento creato nel codice.
Dettagli dell'esempio
Windows Workflow Foundation fornisce un'infrastruttura di rilevamento per rilevare l'esecuzione di un'istanza del flusso di lavoro. Il runtime di rilevamento implementa un'istanza del flusso di lavoro per generare eventi correlati al ciclo di vita del flusso di lavoro, eventi da attività del flusso di lavoro ed eventi personalizzati. Nella tabella seguente sono indicati in dettaglio i componenti primari dell'infrastruttura di rilevamento.
| Componente | Descrizione |
|---|---|
| Esecuzione del rilevamento | Fornisce l'infrastruttura per la creazione dei record di rilevamento. |
| Partecipanti del rilevamento | Usa i record di rilevamento. .NET Framework 4 viene fornito con un partecipante del rilevamento che scrive record di rilevamento come eventi ETW (Event Trace for Windows). |
| Profilo di rilevamento | Meccanismo di filtro che consente a un partecipante del rilevamento di sottoscrivere un subset dei record di rilevamento creati da un'istanza del flusso di lavoro. |
Nella tabella seguente vengono indicati in dettaglio i record di rilevamento creati dall'esecuzione del flusso di lavoro.
| Record di rilevamento | Descrizione |
|---|---|
| Record di rilevamento dell'istanza del flusso di lavoro. | Descrivono il ciclo di vita dell'istanza del flusso di lavoro. Ad esempio un record di istanza viene creato quando viene avviato o completato il flusso di lavoro. |
| Record di rilevamento dello stato dell'attività. | Illustrano in dettaglio l'esecuzione dell'attività. Questi record indicano lo stato di un'attività del flusso di lavoro, ad esempio quando un'attività viene pianificata, quando viene completata o quando viene generato un errore. |
| Record di ripresa del segnalibro. | Generato quando viene ripreso un segnalibro all'interno di un'istanza del flusso di lavoro. |
| Record di rilevamento personalizzati. | Un autore del flusso di lavoro può creare record di rilevamento personalizzati e generarli all'interno dell'attività personalizzata. |
Il partecipante di rilevamento sottoscrive un subset degli oggetti TrackingRecord generati usando profili di rilevamento. Un profilo di rilevamento contiene query di rilevamento che consentono la sottoscrizione di un particolare tipo di record di rilevamento. I profili di rilevamento possono essere specificati nel codice o nella configurazione.
Partecipante di rilevamento personalizzato
L'API del partecipante di rilevamento consente l'estensione del runtime di rilevamento con un partecipante di rilevamento fornito dall'utente, che può includere la logica personalizzata per gestire gli oggetti TrackingRecord generati dall'esecuzione del flusso di lavoro.
Per scrivere un partecipante di rilevamento l'utente deve implementare TrackingParticipant. In particolare, il metodo Track deve essere implementato dal partecipante personalizzato. Questo metodo viene chiamato quando un oggetto TrackingRecord viene generato dall'esecuzione del flusso di lavoro.
public abstract class TrackingParticipant
{
protected TrackingParticipant();
public virtual TrackingProfile TrackingProfile { get; set; }
public abstract void Track(TrackingRecord record, TimeSpan timeout);
}
Il partecipante di rilevamento completo viene implementato nel file ConsoleTrackingParticipant.cs. L'esempio di codice seguente illustra il metodo Track per il partecipante di rilevamento personalizzato.
protected 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));
}
ActivityStateRecord activityStateRecord = record as ActivityStateRecord;
if (activityStateRecord != null)
{
IDictionary<String, object> variables = activityStateRecord.Variables;
StringBuilder vars = new StringBuilder();
if (variables.Count > 0)
{
vars.AppendLine("\n\tVariables:");
foreach (KeyValuePair<string, object> variable in variables)
{
vars.AppendLine(String.Format(
"\t\tName: {0} Value: {1}", variable.Key, variable.Value));
}
}
Console.WriteLine(String.Format(CultureInfo.InvariantCulture,
" :Activity DisplayName: {0} :ActivityInstanceState: {1} {2}",
activityStateRecord.Activity.Name, activityStateRecord.State,
((variables.Count > 0) ? vars.ToString() : String.Empty)));
}
CustomTrackingRecord customTrackingRecord = record as CustomTrackingRecord;
if ((customTrackingRecord != null) && (customTrackingRecord.Data.Count > 0))
{
...
}
Console.WriteLine();
}
Nell'esempio di codice seguente viene aggiunto il partecipante della console all'oggetto invoker del flusso di lavoro.
ConsoleTrackingParticipant customTrackingParticipant = new ConsoleTrackingParticipant()
{
...
// The tracking profile is set here, refer to Program.CS
...
}
WorkflowInvoker invoker = new WorkflowInvoker(BuildSampleWorkflow());
invoker.Extensions.Add(customTrackingParticipant);
Creazione di record di rilevamento personalizzati
In questo esempio viene inoltre illustrata la possibilità di generare oggetti CustomTrackingRecord da un'attività flusso di lavoro personalizzata:
Gli oggetti CustomTrackingRecord vengono creati e popolati con dati definiti dall'utente che si desidera vengano generati con il record.
CustomTrackingRecord viene generato mediante una chiamata al metodo di rilevamento di ActivityContext.
Nell'esempio seguente viene illustrato come generare oggetti CustomTrackingRecord all'interno di un'attività personalizzata.
// Create the Custom Tracking Record
CustomTrackingRecord customRecord = new CustomTrackingRecord("OrderIn")
{
Data =
{
{"OrderId", 200},
{"OrderDate", "20 Aug 2001"}
}
};
// Emit custom tracking record
context.Track(customRecord);
Per usare questo esempio
In Visual Studio aprire il file della soluzione CustomTrackingSample.sln.
Per compilare la soluzione, premere CTRL+MAIUSC+B.
Per eseguire la soluzione, premere CTRL+F5.
