Création de solutions Outlook déclaratives intermédiaires à l’aide de Business Connectivity Services

Article
09/18/2014

Dernière modification : lundi 22 août 2011

S’applique à : SharePoint Server 2010

Dans cet article
Comparaison des fonctionnalités des solutions Outlook simples et déclaratives
Types de personnalisations pouvant être effectués
Procédure à suivre pour créer une solution Outlook déclarative intermédiaire
Fonctionnement des solutions Outlook déclaratives intermédiaires
Composants d’une solution Outlook déclarative intermédiaire
Approche recommandée pour créer une solution Outlook déclarative
Outils permettant de créer des solutions Outlook déclaratives intermédiaires

Microsoft Business Connectivity Services (BCS) permet aux travailleurs de l’information d’exposer les types de contenu externe (tels que Client, Employé ou Commande) dans Microsoft Outlook 2010 en tant que type d’élément Outlook natif (tel qu’un élément de contact, une tâche, une publication ou un rendez-vous) en déconnectant une liste externe. Une solution de ce type est appelée solution simple, et les solutions simples reposent sur les fonctionnalités natives de Microsoft Office 2010 et de Microsoft SharePoint 2010.

Toutefois, les solutions simples offrent une prise en charge limitée ou nulle de la personnalisation. En outre, Business Connectivity Services ne fournit pas de modèle de programmation extensible pour les solutions simples. Néanmoins, si vous avez besoin de créer des solutions personnalisées dans Outlook, vous pouvez créer une solution Outlook déclarative intermédiaire. Ce type de solution est spécifique à Outlook 2010 dans cette version de Business Connectivity Services.

Comparaison des fonctionnalités des solutions Outlook simples et déclaratives

Le tableau suivant répertorie les fonctionnalités des solutions Outlook simples et déclaratives intermédiaires.

Tableau 1. Solutions Outlook simples ou déclaratives

Fonctionnalité	Solution Outlook simple	Solution Outlook déclarative intermédiaire
Nombre de types de contenu externe dans une solution	Une	Peut en comprendre plusieurs.
Actions et Rubans	Le Ruban et les actions par défaut sont fournis par Business Connectivity Services.	Peut comprendre des Rubans et des actions personnalisées.
Affichage des types de contenu externe liés	Il est impossible d’afficher les informations connexes liées à un type de contenu externe dans un volet Office. Toutefois, notez que si vous définissez une association, Business Connectivity Services fournit un contrôle de sélecteur d’élément externe qui permet aux utilisateurs de sélectionner un élément externe source dans le type de contenu externe de destination.	Permet d’afficher les informations connexes en définissant des volets Office et des Rubans personnalisés.
Personnalisation de l’affichage dans Outlook	Les utilisateurs peuvent personnaliser l’affichage dans Outlook et exporter la définition de l’affichage.	Le développeur peut inclure une définition d’affichage personnalisée dans la solution afin que les données externes apparaissent par défaut dans cet affichage personnalisé pour tous les utilisateurs qui installent cette solution.
Personnalisation des zones de formulaire	Les zones de formulaire par défaut fournies par Business Connectivity Services ne peuvent contenir que des contrôles Outlook. Vous ne pouvez pas les personnaliser afin qu’ils contiennent des parties de données externes pour afficher des données externes dans Outlook.	Permet de créer et de personnaliser des zones de formulaire qui contiennent des parties de données externes pour afficher des données externes dans Outlook.

Types de personnalisations pouvant être effectués

À l’aide d’une solution Outlook déclarative intermédiaire, vous pouvez effectuer les opérations suivantes :

Afficher des parties de données externes natives ou personnalisées dans le volet Office Outlook Vous pouvez définir des volets Office personnalisés et présenter des données externes aux utilisateurs en hébergeant des parties de données externes (celles fournies par Business Connectivity Services ou des parties de données externes personnalisées créées par un développeur) dans un volet Office.
Inclure des Rubans et des actions personnalisés Vous pouvez définir des fichiers de Ruban et des actions personnalisées exposées dans le Ruban ou dans une partie de données externes qui exécutent du code ou lancent un navigateur qui pointe vers une URL spécifiée pouvant accepter des champs Service BDC (Business Data Connectivity) en guise de paramètres. Les actions peuvent être basées sur l’URL ou pointer sur des actions de code créées par un développeur.
Créer une définition d’affichage personnalisée dans Outlook À partir d’éléments Outlook de base, vous pouvez personnaliser l’affichage qui apparaît pour un dossier de données externes. Business Connectivity Services contient une commande qui permet d’enregistrer l’affichage personnalisé sous la forme d’un fichier .ovd (Outlook View Definition), afin qu’il soit disponible pour les utilisateurs qui installent la solution déclarative.
Personnaliser les zones de formulaire Outlook pour présenter des données externes dans Outlook Vous pouvez créer des zones de formulaire Outlook personnalisées destinées à afficher des données externes en concevant de nouvelles zones de formulaire dans Outlook.

Procédure à suivre pour créer une solution Outlook déclarative intermédiaire

Vous créez une solution Outlook déclarative intermédiaire en créant les artefacts suivants : un modèle BDC, un manifeste de solution (OIR.config) une souscription pour chaque type de contenu externe et, éventuellement, un Ruban personnalisé, une ou plusieurs dispositions de volet Office, des zones de formulaire personnalisées et des définitions d’affichage Outlook personnalisées. Ensuite, vous pouvez empaqueter ces artefacts de solution dans un package ClickOnce des Outils de développement Office dans Visual Studio 2010 en utilisant l’Outil d’empaquetage de solution BCS (éventuellement en anglais). Une fois que vous avez empaqueté les artefacts de solution, les utilisateurs peuvent installer le package dans Outlook.

Une autre possibilité consiste à créer le modèle BDC, puis à utiliser l’Outil générateur d’artefact BCS (éventuellement en anglais) pour générer les fichiers d’artefacts en fonction du modèle BDC. Après avoir généré les artefacts, empaquetez la solution dans un package ClickOnce Outils de développement Office dans Visual Studio 2010 à l’aide de l’Outil d’empaquetage de solution BCS (éventuellement en anglais).

Fonctionnement des solutions Outlook déclaratives intermédiaires

Une solution Outlook déclarative intermédiaire tire parti de Business Connectivity Services Client Runtime pour interpréter les artefacts de solution et indique au runtime les données externes à afficher, à partir de quel emplacement les afficher, comment les afficher et la façon dont les utilisateurs peuvent les exploiter. Le cache client Business Connectivity Services sur le client gère les métadonnées et les types de contenu externe mis en cache qui sont dignes d’intérêt pour l’utilisateur. Une solution déclarative utilise le complément OutlookBusiness Connectivity Services natif qui présente les éléments définis dans les artefacts de solution au moment de l’exécution dans Outlook. Cette architecture permet aux utilisateurs expérimentés et aux développeurs de se concentrer sur la satisfaction des besoins de l’entreprise, au lieu de gérer la complexité de l’interaction avec les API Outlook et Business Connectivity Services pour effectuer des tâches courantes et répétitives.

Composants d’une solution Outlook déclarative intermédiaire

Le tableau 2 indique les composants classiques d’une solution Outlook déclarative intermédiaire, le nombre de composants de chaque type autorisés dans une solution et l’opération effectuée par chaque composant.

Tableau 2. Composants d’une solution Outlook déclarative intermédiaire

Composant	Nom du fichier	Nombre autorisé	Description
Modèle BDC	metadata.bdcm ou metadata.xml	Un par solution. Obligatoire.	Définit tous les types de contenu externe et leurs associations.
Fichier de souscription de cache	Subscription.xml, par exemple, CustomerSubscription.xml* et OrderSubscription.xml	Un par type de contenu externe dans la solution. Obligatoire.	Indique comment remplir le cache client Business Connectivity Services.
Fichier de définition d’affichage Outlook	*.ovd	Zéro ou plus.	Définit un affichage personnalisé dans Outlook.
Fichier de stockage de formulaire Outlook	*.ofs	Zéro ou plus.	Fichier de zone de formulaire Outlook.
Manifeste de zone de formulaire	*.manifest.xml	Zéro ou plus, mais obligatoire si une zone de formulaire (*.ofs) est présente.	Fichier de manifeste qui indique à Outlook le fichier de zone de formulaire à charger.
Manifeste de solution	OIR.config	Un par solution. Obligatoire.	Manifeste de solution qui décrit la solution.
Fichier de Ruban	*.xml	Un par solution.	Fichier de Ruban Outlook.
Fichier de disposition	*.xml	Zéro ou plus. Un par volet Office.	Définit les contrôles qui seront exposés dans le volet Office, les types de contenu externe avec lesquels ils doivent être remplis et toute autre propriété personnalisée que le contrôle expose.
Assembly personnalisé	*.dll	Zéro ou plus.	Indique si votre solution référence des composants de code Business Connectivity Services réutilisables, tels que des actions de code personnalisées, des parties de données externes personnalisées ou un gestionnaire de Ruban personnalisé.
Icône	.ico ou un format de fichier graphique, tel que .png ou *.jpg.	Zéro ou plus	Affiché dans l’interface utilisateur Outlook.
Formulaire InfoPath	*.xsn	Zéro ou plus	Permet de présenter des données externes dans des formulaires Microsoft InfoPath.

Approche recommandée pour créer une solution Outlook déclarative

La création d’une solution Outlook déclarative intermédiaire consiste à générer les fichiers d’artefacts de solution requis et à empaqueter les artefacts dans un package ClickOnce. Vous pouvez créer les fichiers d’artefacts de solution à l’aide des approches suivantes :

Méthode à l’aide d’un outil : vous pouvez utiliser l’Outil générateur d’artefact BCS (éventuellement en anglais) pour générer les fichiers d’artefact XML. Cet outil requiert un fichier de modèle BDC, que vous devez avoir créé à l’aide de SharePoint Designer ou d’un éditeur XML.
Méthode manuelle : vous pouvez créer les fichiers d’artefacts XML manuellement à l’aide d’un éditeur XML.

Utilisez l’approche suivante pour créer une solution Outlook déclarative intermédiaire à l’aide de Business Connectivity Services :

Créez un modèle BDC qui définit les types de contenu externe utilisés dans la solution, ainsi que leurs associations, puis enregistrez-le dans un fichier metadata.bdcm (voir Étape 1 : créer le modèle BDC (Metadata.bdcm)). Cette rubrique décrit également un raccourci qui vous permet de créer un modèle BDC pour votre solution sans écrire tout le code XML dès le début.
Créez des souscriptions de cache pour chacun des types de contenu externe utilisés dans la solution à l’aide du modèle fourni dans ce Kit de développement logiciel (SDK), puis enregistrez-les dans des fichiers XML en respectant le format suivant : "<ExternalContentTypeName>Subscription.xml", par exemple, OrderSubscription.xml ou CustomerSubscription.xml. Voir Étape 2 : Créer les abonnements au cache (*Subscription.xml).
À l’aide de l’Outil BCS Artifact Generator (éventuellement en anglais) ou du modèle fourni dans ce Kit de développement logiciel SDK, créez un manifeste de solution (OIR.config) pour fournir les paramètres de solution généraux, les informations sur les dossiers Outlook et les mappages de propriétés. Laissez à Business Connectivity Services le soin de créer automatiquement une zone de formulaire destinée à l’affichage des propriétés qui ne peuvent pas être mappées à une propriété Outlook. Voir Étape 3 : créer le fichier manifeste de la solution (OIR.config).
Empaquetez les artefacts dans un package ClickOnce à l’aide de l’Outil d’empaquetage de solution BCS (éventuellement en anglais). Ensuite, installez le package et testez la solution dans Outlook. Voir Étape 4 : empaqueter et déployer la solution Outlook déclarative.
Si les fonctionnalités de base fonctionnent conformément à vos attentes, étendez la solution avec une ou plusieurs des personnalisations suivantes selon vos besoins :
1. Créez des zones de formulaire Outlook personnalisées (*.ofs). Voir Étape 5 (facultative) : créer la zone de formulaire Outlook (*.ofs) et le manifeste de zone de formulaire (FormRegionManifest.xml).
2. Créez des définitions d’affichage Outlook personnalisées (*.ovd). Voir Étape 6 (facultative) : Créer des définitions d’affichages Outlook personnalisées (*.ovd).
3. Créez des dispositions de volet Office (*.xml). Voir Étape 7 (facultative) : afficher des parties de données externes dans le volet Office Outlook (Layout.xml).
4. Définissez un Ruban et des actions personnalisés (ribbon.xml, OIR.config). Voir Étape 8 (facultative) : définir le Ruban et les actions (Ribbon.xml).
Empaquetez les artefacts, déployez le package dans Outlook et testez de nouveau la solution.

Outils permettant de créer des solutions Outlook déclaratives intermédiaires

Vous pouvez utiliser de nombreux outils pour générer des solutions Outlook déclaratives intermédiaires, notamment SharePoint Designer (pour le modèle BDC) et Outlook (pour les zones de formulaire et les définitions d’affichage personnalisées). Pour créer les fichiers XML nécessaires pour votre solution Outlook déclarative, vous pouvez utiliser n’importe quel éditeur XML. Visual Studio peut fournir IntelliSense, qui peut s’avérer utile lors de la création des fichiers XML. Des exemples et des modèles facilitant la prise en main sont fournis dans le cadre de cette procédure pas à pas. Vous pouvez aussi utiliser l’Outil générateur d’artefact BCS (éventuellement en anglais) pour générer les fichiers d’artefact XML, sauf le modèle BDC, que vous devez avoir créé à l’aide de SharePoint Designer ou d’un éditeur XML.

Vous pouvez utiliser l’Outil d’empaquetage de solution BCS (éventuellement en anglais) pour créer un package ClickOnce pour une solution Outlook déclarative.