Procédure pas à pas : création et débogage d'une solution de flux de travail SharePoint

Article
04/28/2010

Mise à jour : novembre 2007

S'applique à
Les informations de cette rubrique s'appliquent uniquement aux projets Visual Studio Tools pour Office et aux versions de Microsoft Office spécifiés. Type de projet Flux de travail SharePoint Version de Microsoft Office SharePoint Server 2007 Pour plus d'informations, consultez Fonctionnalités disponibles par type d'application et de projet.

Les informations de cette rubrique s'appliquent uniquement aux projets Visual Studio Tools pour Office et aux versions de Microsoft Office spécifiés.

Type de projet

Flux de travail SharePoint

Version de Microsoft Office

SharePoint Server 2007

Pour plus d'informations, consultez Fonctionnalités disponibles par type d'application et de projet.

Cette procédure pas à pas montre comment créer un modèle de flux de travail séquentiel de base. Le flux de travail vérifie une propriété d'une bibliothèque de documents afin de déterminer si un document a été révisé. Si le document a été révisé, le flux de travail se termine.

Cette procédure pas à pas illustre les tâches suivantes :

Création d'un projet de flux de travail séquentiel SharePoint 2007.
Création d'une planification de flux de travail.
Gestion d'événements d'activité.

Remarque :
Les boîtes de dialogue et les commandes de menu que vous voyez peuvent différer de celles qui sont décrites dans l'aide selon vos paramètres actifs ou votre édition. Pour modifier vos paramètres, cliquez sur Importation et exportation de paramètres dans le menu Outils. Pour plus d'informations, consultez Paramètres Visual Studio.

Pour plus d'informations sur la création de modèles de flux de travail SharePoint à l'aide de Visual Studio Tools pour Office, consultez Solutions de flux de travail SharePoint.

Composants requis

Vous avez besoin des composants suivants pour exécuter cette procédure pas à pas :

Visual Studio Tools pour Office (composant facultatif de Visual Studio 2008 Professional et Visual Studio Team System).
Microsoft SharePoint Server 2007.
Un site Web SharePoint Server qui porte le titre Centre de documents et dont l'URL est nommée https://localhost/Docs. Si vous avez installé Microsoft Office SharePoint Server 2007 sur un ordinateur unique dans le cadre d'une installation autonome, ce site Web est créé automatiquement lorsque vous complétez l'Assistant Configuration des produits et technologies SharePoint.
Microsoft Office Word 2007 ou Microsoft Office Word 2003.

Visual Studio Tools pour Office est installé par défaut avec les versions répertoriées de Visual Studio. Pour vérifier s'il est installé, consultez Installation de Visual Studio Tools pour Office.

Ajout de propriétés à la bibliothèque de documents SharePoint

Pour suivre l'état de révision de documents dans la bibliothèque de documents, les participants du flux de travail définissent les propriétés État du document, Cessionnaire et Commentaires de révision du document. Définissez ces propriétés dans la bibliothèque de documents.

Pour ajouter des propriétés à la bibliothèque de documents SharePoint

Ouvrez le site Web SharePoint Server 2007 par défaut dans Internet Explorer.

Remarque :
Par défaut, le site SharePoint est à l'adresse https://localhost. Si vous mappez https://localhost à un site Web non-SharePoint, vous ne serez pas en mesure de tester le modèle de flux de travail en suivant les étapes de cette procédure pas à pas.

Cliquez sur l'onglet Centre de documents.
Dans le volet de navigation, cliquez sur Documents.
Dans la page Documents, cliquez sur Paramètres, puis cliquez sur Paramètres de la bibliothèque de documents.
Dans la page Personnaliser documents, sous Colonnes, cliquez sur Créer une colonne.
Nommez la colonne État du document, sélectionnez Choix (menu dans lequel effectuer un choix), spécifiez les trois choix suivants, puis cliquez sur OK :
- Révision nécessaire
- Révision terminée
- Modifications demandées
Créez deux colonnes supplémentaires et nommez-les Cessionnaire et Commentaires de révision. Mettez en forme la colonne Cessionnaire comme une ligne unique de texte, et la colonne Commentaires de révision comme lignes de texte multiples.

Modification de documents sans extraction

Le test du modèle de flux de travail est plus facile lorsque vous pouvez modifier les documents sans devoir les extraire.

Pour modifier des documents sans les extraire

Dans la page Personnaliser documents, sous Paramètres généraux, cliquez sur Paramètres de contrôle de version.
Pour Exiger l'extraction des documents avant de pouvoir les modifier, sélectionnez Non, puis cliquez sur OK.
Fermez Internet Explorer.

Création d'un projet de flux de travail séquentiel SharePoint

Un flux de travail séquentiel est une succession d'étapes qui s'exécutent dans l'ordre jusqu'à la fin de la dernière activité.

Pour créer un projet de flux de travail séquentiel SharePoint

Démarrez Visual Studio.
Ouvrez la boîte de dialogue Nouveau projet, développez le nœud Office sous la langue que vous souhaitez utiliser, puis sélectionnez le nœud 2007.
Dans le volet Modèles, sélectionnez Flux de travail séquentiel SharePoint 2007.
Dans la zone Nom, tapez MySharePointWorkflow. Si votre IDE est défini pour utiliser des paramètres de développement Visual C# ou des paramètres de développement généraux, entrez un emplacement et un nom de solution.
Cliquez sur OK.

L'Assistant Nouveau flux de travail Office SharePoint apparaît.
Dans la page Spécifiez le nom du flux de travail et un site pour le débogage, cliquez sur Suivant pour accepter le nom du flux de travail et le site par défaut.
Dans la page Sélectionnez les listes à utiliser lors du débogage, cliquez sur Suivant pour accepter la bibliothèque de documents, la liste des tâches et l'historique par défaut, et associer automatiquement votre modèle de flux de travail à la bibliothèque de documents.
Dans la page Vous pouvez spécifier les conditions de démarrage du flux de travail, cliquez sur Terminer pour accepter les sélections par défaut.

Création d'une planification de flux de travail.

Les modèles de flux de travail contiennent une ou plusieurs planifications de flux de travail qui contiennent des activités qui représentent des actions à exécuter. Utilisez le Workflow Designer pour réorganiser des activités sur une planification. Pour surveiller l'état de révision d'un document dans la liste Documents, ajoutez deux activités : HandleExternalEventActivity et Microsoft.SharePoint.WorkflowActions.OnWorkflowItemChanged.

Pour créer une planification de flux de travail

Dans l'Explorateur de solutions, double-cliquez sur Workflow1.cs ou Workflow1.vb pour ouvrir la planification de flux de travail dans le concepteur.
Dans le concepteur, cliquez sur l'activité OnWorkflowActivated1 pour la sélectionner.
Dans la fenêtre Propriétés, tapez onWorkflowActivated en regard de la propriété Invoked, puis appuyez sur ENTRÉE.

L'éditeur de code ouvre et une méthode de gestionnaire d'événements nommée onWorkflowActivated est ajoutée au fichier de code Workflow1.
Rouvrez la planification de flux de travail dans le concepteur.
Dans le menu Affichage, cliquez sur Boîte à outils.
Dans l'onglet Windows Workflow v3.0 de la Boîte à outils, faites glisser une activité While sous l'activité onWorkflowActivated1.
Cliquez sur l'activité WhileActivity1 pour la sélectionner.
Dans la fenêtre Propriétés, affectez la valeur Condition de code à Condition.
Développez la propriété Condition et tapez isWorkflowPending en regard de la propriété enfant Condition, puis appuyez sur ENTRÉE.

L'éditeur de code s'ouvre et une méthode nommée isWorkflowPending est ajoutée au fichier de code Workflow1.
Rouvrez la planification de flux de travail dans le concepteur.
Dans l'onglet Flux de travail SharePoint de la Boîte à outils, faites glisser une activité OnWorkflowItemChanged dans l'activité whileActivity1.
Cliquez sur l'activité onWorkflowItemChanged1 pour la sélectionner.
Dans la Fenêtre Propriétés, définissez les propriétés affichées dans le tableau suivant.

Propriété

Valeur

CorrelationToken

workflowToken

Invoked

onWorkflowItemChanged

Propriété	Valeur
CorrelationToken	workflowToken
Invoked	onWorkflowItemChanged

Gestion d'événements d'activité

La dernière étape consiste à vérifier l'état du document à partir de chaque activité. Si le document a été révisé, le flux de travail se termine.

Pour gérer des événements d'activité

Dans l'Explorateur de solutions, cliquez avec le bouton droit sur Workflow1.cs ou Workflow1.vb et sélectionnez Afficher le code.
Ajoutez le champ suivant en haut de la classe Workflow1 : Vous utiliserez ce champ dans une activité pour déterminer si le flux de travail est terminé.
```
Dim workflowPending As Boolean = True
```
```
Boolean workflowPending = true;
```
Ajoutez la méthode suivante à la classe Workflow1. Cette méthode vérifie la valeur de la propriété Document Status de la liste Documents pour déterminer si le document a été révisé. Si la valeur Review Complete est affectée à la propriété Document Status, la méthode checkStatus affecte au champ workflowPending la valeur false pour indiquer que le flux de travail est prêt à se terminer.
```
Private Sub checkStatus()
    If CStr(workflowProperties.Item("Document Status")) = "Review Complete" Then
        workflowPending = False
    End If
End Sub 
```
```
private void checkStatus()
{
    if ((string)workflowProperties.Item["Document Status"] == "Review Complete")
    workflowPending = false;
}
```
Ajoutez le code suivant aux méthodes onWorkflowActivated et onWorkflowItemChanged pour appeler la méthode checkStatus. Lorsque le flux de travail démarre, la méthode onWorkflowActivated appelle la méthode checkStatus pour déterminer si le document a déjà été révisé. S'il n'a pas été révisé, le flux de travail continue. Lorsque le document est enregistré, la méthode onWorkflowItemChanged appelle de nouveau la méthode checkStatus pour déterminer si le document a été révisé. Tant que le champ workflowPending a la valeur true, le flux de travail continue à s'exécuter.
```
Private Sub onWorkflowActivated(ByVal sender As System.Object, ByVal e As System.Workflow.Activities.ExternalDataEventArgs)
    checkStatus()
End Sub

Private Sub onWorkflowItemChanged(ByVal sender As System.Object, ByVal e As System.Workflow.Activities.ExternalDataEventArgs)
    checkStatus()
End Sub
```
```
private void onWorkflowActivated(object sender, ExternalDataEventArgs e)
{
    checkStatus();
}

private void onWorkflowItemChanged(object sender, ExternalDataEventArgs e)
{
    checkStatus();
}
```
Ajoutez le code suivant à la méthode isWorkflowPending pour vérifier l'état de la propriété workflowPending. Chaque fois que le document est enregistré l'activité whileActivity1 appelle la méthode isWorkflowPending. Cette méthode examine la propriété Result de l'objet ConditionalEventArgs pour déterminer si l'activité WhileActivity1 doit continuer ou se terminer. Si la propriété a la valeur true, l'activité continue. Sinon, l'activité se termine, ainsi que le flux de travail.
```
Private Sub isWorkflowPending(ByVal sender As System.Object, ByVal e As System.Workflow.Activities.ConditionalEventArgs)
    e.Result = workflowPending
End Sub
```
```
private void isWorkflowPending(object sender, ConditionalEventArgs e)
{
    e.Result = workflowPending;
}
```

Test du modèle de flux de travail SharePoint

Lorsque vous démarrez le débogueur, Visual Studio Tools pour Office déploie le modèle de flux de travail vers SharePoint Server 2007 et associe le modèle de flux de travail à la liste Documents. Pour tester le flux de travail, démarrez une instance du modèle de flux de travail à partir d'un document de la liste Documents.

Pour tester le modèle de flux de travail SharePoint

Dans l'Explorateur de solutions, cliquez avec le bouton droit sur Workflow1.cs ou Workflow1.vb et cliquez sur Afficher le code.
Définissez un point d'arrêt en regard de la méthode onWorkflowActivated.
Appuyez sur F5.

La page Documents du site SharePoint par défaut s'ouvre.
Dans la page Documents, cliquez sur Nouveau pour créer un document.
Enregistrez le document à l'emplacement par défaut.

Le document s'ajoute à la liste Documents et démarre le flux de travail.
Dans Visual Studio, vérifiez que le débogueur s'arrête au point d'arrêt en regard de la méthode onWorkflowActivated.
Appuyez sur F5 pour continuer l'exécution.
Fermez le document.
Retournez à la page Documents du site Web SharePoint par défaut.
Dans la page Documents, vérifiez que la valeur sous la colonne MySharePointWorkflow est En cours. Cela signifie que le flux de travail est en cours de réalisation et que le document attend d'être révisé.
Dans la page Documents, pointez sur le document, cliquez sur la flèche bas, puis cliquez sur Modifier propriétés.
Affectez à État du document la valeur Révision terminée, puis cliquez sur OK.
Retournez à la page Documents du site Web SharePoint par défaut.
Dans la page Documents, vérifiez que la valeur sous la colonne MySharePointWorkflow est Terminé. Cela signifie que le flux de travail est terminé et que le document a été révisé.

Étapes suivantes

Pour plus d'informations sur la création de modèles de flux de travail, consultez les rubriques suivantes :

Pour plus d'informations sur les activités de flux de travail SharePoint, consultez Vue d'ensemble des activités de flux de travail pour Windows SharePoint Services.
Pour plus d'informations sur les activités Windows Workflow Foundation, consultez l'espace de noms System.Workflow.Activities.

Voir aussi

Share via