Procédure pas à pas : création d'une liste externe dans SharePoint à l'aide de données métiers

Le service de connectivité de données métiers (BDC, Business Data Connectivity) permet à SharePoint d'afficher des données métiers à partir d'applications de serveur principal, de services Web et de bases de données.

Cette procédure pas à pas vous indique comment créer un modèle de service BDC qui retourne des informations sur les contacts dans un exemple de base de données.Elle vous indique ensuite comment créer une liste externe dans SharePoint à l'aide de ce modèle.

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

• Création d'un projet

• Ajout d'une entité au modèle

• Ajout d'une méthode de recherche

• Ajout d'une méthode de recherche spécifique

• Test du projet.

Composants requis

Pour exécuter cette procédure pas à pas, vous devez disposer des composants suivants :

• Éditions prises en charge de Windows et SharePoint.Pour plus d'informations, consultez Configuration requise pour développer des solutions SharePoint.

• Visual Studio Professional, Visual Studio Ultimate ou Visual Studio Premium.

• Accès à l'exemple de base de données AdventureWorks.Pour plus d'informations sur l'installation de la base de données AdventureWorks, consultez Exemples de bases de données SQL Server (page éventuellement en anglais).

Création d'un projet qui contient un modèle BDC

Pour créer un projet contenant un modèle BDC

1. Dans la barre de menus de Visual Studio, choisissez Fichier, Nouveau, Projet.

   La boîte de dialogue Nouveau projet s'affiche.

2. Sous Visual C# ou Visual Basic, développez le nœud SharePoint, puis sélectionnez l'élément 2010 .

3. Dans le volet de Modèles, choisissez Projet SharePoint 2010, nommez le projet AdventureWorksTest, puis choisissez le bouton OK .

   L'Assistant Personnalisation de SharePoint s'affiche.Dans cet Assistant, vous pouvez spécifier le site que vous utiliserez pour déboguer le projet et pour définir le niveau de confiance de la solution.

4. Sélectionnez la case d'option Déployer en tant que solution de batterie pour définir le niveau de confiance.

5. Choisissez le bouton Terminer pour accepter le site SharePoint local par défaut.

6. Dans Explorateur de solutions, sélectionnez le nœud de projet SharePoint.

7. Dans la barre de menus, sélectionnez Projet, Ajouter un nouvel élément.

   La boîte de dialogue Ajouter un nouvel élément s'ouvre.

8. Dans le volet de Modèles, choisissez Modèle de connectivité de données métiers (solution de batterie uniquement), nommez le projet AdventureWorksContacts, puis choisissez le bouton Ajouter .

Ajout de classes d'accès aux données au projet

Pour ajouter des classes d'accès aux données au projet

1. Dans la barre de menus, sélectionnez Outils, Connexion à une base de données.

   La boîte de dialogue Ajouter une connexion s'ouvre.

2. Ajoutez une connexion à l'exemple de base de données SQL Server AdventureWorks.

   Pour plus d'informations, consultez Ajouter une/Modifier la connexion (Microsoft SQL Server).

3. Dans Explorateur de solutions, sélectionnez le nœud de projet.

4. Dans la barre de menus, sélectionnez Projet, Ajouter un nouvel élément.

5. Dans le volet de Modèles installés, sélectionnez le nœud Données .

6. Dans le volet de Modèles, choisissez Classes LINQ to SQL.

7. Dans la zone Nom, spécifiez AdventureWorks, puis choisissez le bouton Ajouter .

   Un fichier .dbml est ajouté au projet, et le concepteur objet/relationnel (concepteur O/R) s'ouvre.

8. Dans la barre de menus, sélectionnez Afficher, Explorateur de serveurs.

9. Dans l'Explorateur de serveurs, développez le nœud qui représente l'exemple de base de données AdventureWorks, puis développez le nœud Tables.

10. Ajoutez la table Contactez (personne) sur le concepteur O/R.

    Une classe d'entité est créée et apparaît dans l'aire de conception.La classe d'entité possède des propriétés qui correspondent aux colonnes dans la table Contact (Personne).

Suppression de l'entité par défaut du modèle BDC

Le projet Modèle de connectivité de données métiers ajoute une entité par défaut nommée Entity1 au modèle.Supprimez cette entité.Vous ajouterez une nouvelle entité par la suite.Lorsque vous démarrez avec un modèle vide, le nombre d'étapes à suivre pour exécuter la procédure pas à pas diminue.

Pour supprimer l'entité par défaut du modèle

1. Dans Explorateur de solutions, développez le nœud BdcModel1, puis ouvrez le fichier de BdcModel1.bdcm.

2. Le fichier de modèle de connectivité de donnés métiers s'ouvre dans le concepteur BDC.

3. Dans le concepteur, ouvrez le menu contextuel pour Entity1, puis choisissez Supprimer.

4. Dans Explorateur de solutions, ouvrez le menu contextuel pour Entity1.vb (en Visual Basic) ou Entity1.cs (en c), puis choisissez Supprimer.

5. Ouvrez le menu contextuel pour Entity1Service.vb (en Visual Basic) ou Entity1Service.cs (en c), puis choisissez Supprimer.

Ajout d'une entité au modèle

Pour ajouter une entité au modèle,Vous pouvez ajouter des entités de Visual Studio Boîte à outils sur le concepteur BDC.

Pour ajouter une entité au modèle

1. Dans la barre de menus, sélectionnez Afficher, Boîte à outils.

2. Sous l'onglet de BusinessDataConnectivityBoîte à outils, ajoutez Entité sur le concepteur BDC.

   La nouvelle entité s'affiche dans le concepteur.Visual Studio ajoute un fichier nommé EntityService.vb (en Visual Basic) ou EntityService.cs (en c) au projet.

3. Dans la barre de menus, sélectionnez Afficher, Propriétés, Fenêtre.

4. Dans la fenêtre Propriétés, définissez la valeur de propriété Nom le contact.

5. Dans le concepteur, ouvrez le menu contextuel pour l'entité, choisissez Ajouter, puis choisissez Identificateur.

   Un nouvel identificateur s'affiche sur l'entité.

6. Dans la fenêtre Propriétés, renommez l'identificateur en ContactID.

7. Dans la liste Nom de type, choisissez System.Int32.

Ajout d'une méthode de recherche spécifique

Pour que le service BDC puisse afficher un contact spécifique, vous devez ajouter une méthode de recherche spécifique.Le service BDC appelle la méthode de recherche spécifique lorsqu'un utilisateur sélectionne un élément dans une liste puis sélectionne le bouton Afficher l'élément sur le ruban.

Vous pouvez ajouter une méthode de recherche spécifique à l'entité Contact à partir de la fenêtre Détails de méthode BDC.Pour retourner une entité spécifique, ajoutez du code à la méthode.

Pour ajouter une méthode de recherche spécifique

1. Dans le concepteur BDC, sélectionnez l'entité Contact .

2. Dans la barre de menus, sélectionnez Afficher, Autres fenêtres, Détails de méthode BDC.

   La fenêtre Détails de méthode BDC s'ouvre.

3. Dans la liste Ajouter une méthode, choisissez Créer une méthode de recherche spécifique.

   Visual Studio ajoute les éléments suivants au modèle.Ces éléments apparaissent dans la fenêtre Détails de méthode BDC.

   • Méthode nommée ReadItem

   • Paramètre d'entrée pour la méthode

   • Paramètre de retour pour la méthode

   • Descripteur de type pour chaque paramètre

   • Instance de méthode pour la méthode

4. Dans la fenêtre Détails de méthode BDC, ouvrez la liste correspondant au descripteur de type Contact, puis choisissez Modifier.

   Explorateur BDC Ouvre et fournit une vue hiérarchique du modèle.

5. Dans la fenêtre Propriétés, ouvrez la liste en regard de la propriété TypeName, sélectionnez l'onglet de Projet actuel, puis choisissez la propriété Contact .

6. Dans Explorateur BDC, ouvrez le menu contextuel Contact, puis choisissez Ajoutez le descripteur de type.

   Un nouveau descripteur de type nommé TypeDescriptor1 apparaît dans Explorateur BDC.

7. Dans la fenêtre Propriétés, définissez la valeur de propriété Nom à ContactID.

8. Ouvrez la liste en regard de la propriété TypeName, puis choisissez Int32.

9. Ouvrez la liste en regard de la propriété Identificateur, puis choisissez ContactID.

10. Répétez l'étape 6 pour créer un descripteur de type pour chacun des champs suivants.

    Nom	Nom de type
    FirstName	System.String
    LastName	System.String
    Phone	System.String
    EmailAddress	System.String
    EmailPromotion	System.Int32
    NameStyle	System.Boolean
    PasswordHash	System.String
    PasswordSalt	System.String

11. Dans le concepteur BDC, sur l'entité Contact, ouvrez la méthode ReadItem .

    Le fichier de code de service Contact s'ouvre dans l'éditeur de code.

12. Dans la classe ContactService, remplacez la méthode ReadItem par le code suivant.Ce code exécute les tâches suivantes :

    • Il récupère un enregistrement à partir de la table Contact de la base de données AdventureWorks.

    • Il retourne une entité Contact au service BDC.

    [!REMARQUE]

    Remplacez la valeur du champ ServerName par le nom de votre serveur.

    Public Shared Function ReadItem(ByVal contactID As Integer) As Contact
        Const ServerName As String = "MySQLServerName"
        Dim dataContext As AdventureWorksDataContext = _
            New AdventureWorksDataContext("Data Source=" & ServerName & _
                ";Initial Catalog=AdventureWorks;Integrated Security=True")
    
        Dim Contact As Contact = _
            (From TempContacts In dataContext.Contacts.AsEnumerable().Take(20) _
            Where TempContacts.ContactID = contactID _
            Select TempContacts).[Single]()
        Return Contact
    End Function
    

    public static Contact ReadItem(int contactID)
    {
        const string ServerName = "MySQLServerName";
        AdventureWorksDataContext dataContext = new AdventureWorksDataContext
              ("Data Source=" + ServerName + ";" +
               "Initial Catalog=AdventureWorks;Integrated Security=True");
    
        Contact Contact =
            (from contacts in dataContext.Contacts.AsEnumerable().Take(20)
             where contacts.ContactID == contactID
             select contacts).Single();
        return Contact;
    }
    

Ajout d'une méthode de recherche

Pour que le service BDC puisse afficher les contacts dans une liste, vous devez ajouter une méthode de recherche.Ajoutez une méthode de recherche à l'entité Contact à partir de la fenêtre Détails de méthode BDC.Pour retourner une collection d'entités au service BDC, ajoutez du code à la méthode.

Pour ajouter une méthode de recherche

1. Dans le concepteur BDC, sélectionnez l'entité Contact .

2. Dans la fenêtre Détails de méthode BDC, réduisez le nœud ReadItem .

3. Dans la liste Ajouter une méthode sous la méthode ReadList, choisissez Créer une méthode de recherche.

   Visual Studio ajoute une méthode, un paramètre de retour et un descripteur de type.

4. Dans le concepteur BDC, sur l'entité Contact, ouvrez la méthode ReadList .

   Le fichier de code du service de contact s'ouvre dans l'éditeur de code.

5. Dans la classe ContactService, remplacez la méthode ReadList par le code suivant.Ce code exécute les tâches suivantes :

   • Il récupère des données à partir de la table Contacts de la base de données AdventureWorks.

   • Il retourne une liste d'entités Contact au service BDC.

   [!REMARQUE]

   Remplacez la valeur du champ ServerName par le nom de votre serveur.

   Public Shared Function ReadList() As IEnumerable(Of Contact)
       Const ServerName As String = "MySQLServerName"
       Dim dataContext As AdventureWorksDataContext = _
           New AdventureWorksDataContext("Data Source=" & ServerName & _
               ";Initial Catalog=AdventureWorks;Integrated Security=True")
   
       Dim Contacts As IEnumerable(Of Contact) = _
           From TempContacts In dataContext.Contacts.Take(20) _
                 Select TempContacts
       Return Contacts
   End Function
   

   public static IEnumerable<Contact> ReadList()
   {
       const string ServerName = "MySQLServerName";
       AdventureWorksDataContext dataContext = new AdventureWorksDataContext
             ("Data Source=" + ServerName + ";" +
              "Initial Catalog=AdventureWorks;Integrated Security=True");
   
       IEnumerable<Contact> Contacts =
           from contacts in dataContext.Contacts.Take(20)
           select contacts;
       return Contacts;
   
   }
   

Test du projet

Lorsque vous exécutez le projet, le site SharePoint s'ouvre et Visual Studio ajoute votre modèle au service de connectivité de données métiers.Vous pouvez créer dans SharePoint une liste externe qui référence l'entité Contact.Les données des contacts figurant dans la base de données AdventureWorks s'affichent dans la liste.

[!REMARQUE]

Vous devrez peut-être modifier vos paramètres de sécurité dans SharePoint avant de pouvoir déboguer votre solution.Pour plus d'informations, consultez Conception d'un modèle de connectivité de données métiers.

Pour tester le projet

1. Choisissez la clé F5 .

   Le site SharePoint s'ouvre.

2. Dans le menu Actions du site, choisissez la commande Autres options .

3. Dans la page Créer, choisissez le modèle Liste externe, puis choisissez le bouton Créer .

4. Nommez la liste personnalisée Contacts.

5. Cliquez sur le bouton Parcourir en regard de le champ Type de contenu externe .

6. Dans la boîte de dialogue Sélecteur de types de contenu externe, sélectionnez l'élément AdventureWorksContacts.BdcModel1.Contact, puis choisissez le bouton Créer .

   SharePoint crée une liste externe qui contient des contacts de l'exemple de base de données AdventureWorks.

7. Pour tester la méthode de recherche spécifique, choisissez un contact dans la liste.

8. Dans le ruban, cliquez sur l'onglet de Éléments, puis sélectionnez la commande Afficher l'élément .

   Les informations de contact que vous avez choisi s'affichent sur un formulaire.

Étapes suivantes

Pour savoir comment concevoir des modèles pour le service BDC dans SharePoint, consultez les rubriques suivantes :

• Comment : ajouter une méthode de création.

• Comment : ajouter une méthode de mise à jour.

• Comment : ajouter une méthode de suppression.

Voir aussi

Concepts

Vue d'ensemble des outils de conception du modèle BDC

Autres ressources

Conception d'un modèle de connectivité de données métiers

Création d'un modèle de connectivité de données métiers

Intégration de données métiers dans SharePoint