L’exécution d’un workflow est souvent dépendante des entrées que les hommes (via une console ou une application Windows Form) ou les programmes (ASP.NET, Web Service, Mainframe, etc) feront dans votre workflow, même après plusieurs jours d’attente. Une activité qui attend des entrées d’une entité extérieure se doit de faire deux choses :
- Notifier qu’elle attend des données (se mettre ‘au repos’)
- Etre notifié quand les données seront mise à disposition.
Et cela, même si l’instance de son workflow est persistée (dans un fichier texte ou une base de données par exemple). Lorsque les données arrivent, le moteur d’exécution (le runtime) doit pouvoir recharger en mémoire l’instance et être capable de continuer l’exécution du workflow au bon endroit.
Comment faire en sorte de pouvoir spécifier au workflow qu’il est en attente d’une donnée et de traiter la donnée une fois celle-ci mise à la disposition de l’instance du workflow ? Comment assurer une communication ‘propre’ à l’intérieur des couches logicielles et de votre architecture ? Il y a plusieurs méthodes, plus ou moins robuste pour le faire, une bonne méthode est néanmoins d’utiliser ce qui fait le fondement de WF : les files de Workflow !
De cette façon, à chaque fois que vous avez besoin de pousser une entrée vers le workflow, telle qu’une chaine de cractères ou tout autre objet (dans notre exemple, une transaction financière), vous ajoutez un élément à l’une ou les piles de l’instance du workflow. La pile se chargera à son tour d’appeler les méthodes abonnées aux évènements pour traiter ces entrées comme stimuli de l’activité. Ce principe nous permet d’utiliser le service WorkflowQueuingService qui s’exécute dans le moteur d’exécution de WF et qui va vous permettre d’ajouter et de nommer des files dans une instance de workflow.
L’autre avantage de cette méthode est le fait de pouvoir ainsi marquer des points d’exécution et des points de persistence dans votre workflow sans que vous ne soyez obligé d’être dans la portée d’une transaction.
Imaginons que nous voulons traiter un workflow simple qui attend le traitement d’une transaction financière par un serveur backend.
Voici la structure d’une transaction attendue comme entrée par le workflow :
public struct Transaction {
public double Amount;
public DateTime Date;
public Guid ID;
public Transaction(Guid id, double amount, DateTime date) {
this.ID = id; this.Amount = amount; this.Date = date;
}
public override string ToString() {
return string.Format(« ID: {0} – Amount: {1} – Date: {2} », ID, Amount, Date);
}
}
Commençons par implémenter une activité possédant une propriété contenant notre transaction :
public partial class WaitProcessedTransaction : System.Workflow.ComponentModel.Activity
{
private Transaction mTransaction;
public Transaction Transaction
{
get { return mTransaction; }
set { mTransaction = value; }
}
…
}
Voici les méthodes de création (méthode d’initialisation de l’activité) et de destruction (méthode de ‘désinitialisation’, comprendre que cette méthode est appelée de façon synchrone lorsque de la transition de l’état de l’activité de Executing vers Closed) de la file de Workflow :
protected override void Initialize(IServiceProvider provider) {
WorkflowQueuingService qService =
(WorkflowQueuingService)provider.GetService(typeof(WorkflowQueuingService));
if (!qService.Exists(this.Name))
qService.CreateWorkflowQueue(this.Name, true);
}
protected override void Uninitialize(IServiceProvider provider) {
WorkflowQueuingService qService = (WorkflowQueuingService)provider.GetService(typeof(WorkflowQueuingService));
if (qService.Exists(this.Name))
qService.DeleteWorkflowQueue(this.Name);
}
}
On peut constater que les files sont nommées, ici par le nom de l’activité.
Nous allons redéfinir la méthode d’exécution de l’activité par la méthode suivante :
protected override ActivityExecutionStatus Execute(ActivityExecutionContext executionContext) {
WorkflowQueuingService qService = executionContext.GetService<WorkflowQueuingService>();
WorkflowQueue queue = qService.GetWorkflowQueue(this.Name);
if (queue.Count > 0){
this.mTransaction = (Transaction)queue.Dequeue();
return ActivityExecutionStatus.Closed;
}
queue.QueueItemAvailable += this.ContinueAt;
return ActivityExecutionStatus.Executing;
}
void ContinueAt(object sender, QueueEventArgs e){
ActivityExecutionContext context = (ActivityExecutionContext)sender;
WorkflowQueuingService qService = context.GetService<WorkflowQueuingService>();
WorkflowQueue queue = qService.GetWorkflowQueue(this.Name);
this.mTransaction = (Transaction)queue.Dequeue();
context.CloseActivity();
}
Dans la méthode d’exécution, nous récupérons le service de file puis nous extrayons l’entrée qui pourrait potentiellement se trouver dans la file. Si la donnée est récupérée de la file, nous spécifions la clôture de l’activité, sinon nous abonnons une méthode à l’évènement qui sera appelée dés qu’une entrée dans la file sera disponible, puis nous laissons le statut de l’activité comme ‘en cours d’exécution’.
Maintenant c’est au tour de l’application de jouer son rôle en fournissant l’entrée dans la file nommée de l’instance du workflow :
// Création d’une instance de workflow et démarrage
WorkflowInstance instance = workflowRuntime.CreateWorkflow(typeof(WorkflowDemo.WorkflowQueueTest));
instance.Start();
…
// On crée une transaction financière et la met dans la file nommée ‘WaitTransactionProcessed’ (qui est le nom de l’activité ciblée) ce qui aura pour effet de réveiller le workflow et d’exécuter la méthode abonnée à l’évènement ‘QueueItemAvailable’ de la file (méthode ‘ContinueAt’)
Transaction t = new Transaction(Guid.NewGuid(), 1000.0, DateTime.Now);
instance.EnqueueItem(« AttendreTraitementTransaction », t, null, null);
…
En utilisant un objet d’une instance de workflow, et cela n’importe où dans l’application hôte, vous allez pouvoir marquer des points d’exécution dans votre workflow grâce aux files et communiquer une ou plusieurs entrées à votre activité pour pouvoir continuer son exécution. Cela est vrai même si celui-ci a été persisté pendant son état de repos.
Dans notre cas, nous parlons d’un workflow qui peut attendre un stimulus d’une entité extérieure sur des périodes plutôt longues, il faut donc s’attendre à se que le workflow soit décharger de la mémoire pour être persisté à un endroit physique. Dans notre cas nous allons le faire persister dans une base SQL Server 2005 (classique en quelque sorte) en utilisant le service SqlWorkflowPersistenceService (voici un lien pour mettre en place tout ce qu’il faut : http://msdn2.microsoft.com/en-us/library/aa349366.aspx).
Note : voici également un excellent schéma des états d’un workflow : http://msdn2.microsoft.com/en-us/library/aa663362.hostingwwf03l%28en-us,msdn.10%29.jpg
Voici les quelques lignes qu’il faut rajouter pour configurer le runtime :
…
string stringConnection = @ »Initial Catalog=WF_Persistence;Data Source=localhost\SQLEXPRESS;User Id=x;Password=x »;
// Création d’une instance du service de persistence Sql Server avec un argument à true pour spécifier de persister une instance de workflow dés que son état passe au repos
SqlWorkflowPersistenceService persistenceService = new SqlWorkflowPersistenceService(
stringConnection, true, TimeSpan.MaxValue, new TimeSpan(0, 1, 0));
workflowRuntime.AddService(persistenceService);
…
Pour mieux comprendre ce qui se passe on rajoute des handle à différents évènements qui afficheront les changements d’état :
workflowRuntime.WorkflowIdled += new EventHandler<WorkflowEventArgs>(workflowRuntime_WorkflowIdled);
workflowRuntime.WorkflowPersisted += new EventHandler<WorkflowEventArgs>(workflowRuntime_WorkflowPersisted);
workflowRuntime.WorkflowLoaded += new EventHandler<WorkflowEventArgs>(workflowRuntime_WorkflowLoaded);
workflowRuntime.WorkflowCompleted += new EventHandler<WorkflowCompletedEventArgs>(workflowRuntime_WorkflowCompleted);
…
void workflowRuntime_WorkflowCompleted(object sender, WorkflowCompletedEventArgs e) { Console.WriteLine(« Workflow completed ! »); }
void workflowRuntime_WorkflowLoaded(object sender, WorkflowEventArgs e){ Console.WriteLine(« Workflow loaded ! »); }
void workflowRuntime_WorkflowPersisted(object sender, WorkflowEventArgs e) { Console.WriteLine(« Workflow persisted ! »); }
void workflowRuntime_WorkflowIdled(object sender, WorkflowEventArgs e) { Console.WriteLine(« Workflow idle ! »); }
…
Imaginons que nous avons un workflow séquentiel contenant notre activité qui attend le traitement d’une transaction lancée en amont d’un workflow, et d’une activité qui affiche un message de confirmation du traitement :
Nous pourrons observer le résultat suivant :
Voici un cas simple d’utilisation du service WorkflowQueuingService. Ce service est à la base de nombreuses activités et reste un moyen élégant et efficace de placer des points d’attente nommés – par le nom de la file – où vos activités peuvent recevoir des données, c’est à dire des endroits logiques dans votre workflow dont l’exécution peut être reprise quand un stimuli spécifique (une données, un évènement, …) arrive, tout en étant capable d’être persisté pendant le temps d’attente.
Le lien MSDN vers le WorkflowQueuingService qui devrait être à la base de beaucoup de vos activités communicant avec l’extérieur (permet de remplacer très élégamment l’activité HandleExternalEvent : http://msdn2.microsoft.com/en-us/library/system.workflow.runtime.workflowqueuingservice.aspx
).attr(« id », « sommaireIndex » + i); 
) !
