Étape 3 : créer le fichier manifeste de la solution (OIR.config)

Article
09/18/2014

Le fichier manifeste de la solution (OIR.config) est le fichier principal utilisé par le BCS Client Runtime pour configurer votre solution déclarative intermédiaire Outlook.

Dernière modification : lundi 22 août 2011

S’applique à : SharePoint Server 2010

Dans le fichier OIR.config, vous décrivez l’interface utilisateur, le comportement et la logique métier associés aux éléments externes d’une solution déclarative Outlook. Par exemple, dans le fichier manifeste de la solution, vous pouvez spécifier que pour un type d’élément Outlook Contact, une interface utilisateur particulière doit être utilisée (par exemple une partie de données externes) et une méthode spécifique du système externe (par exemple UpdateCustomerInstance(ID, NewInstanceValues) ) doit être appelée afin de mettre à jour tout élément modifié dans Outlook.

Le fichier manifeste de la solution commence par définir le type de données Outlook spécifique auquel est mappé le type de contenu externe principal, par exemple Contact ou Tâche. Toutefois, en tant que fichier de contrôle central, il doit faire beaucoup plus que définir le mappage d’entité à Outlook. Il établit des liens vers d’autres fichiers XML, par exemple le fichier de disposition qui permet de définir le volet Office, et le fichier du Ruban ; par conséquent, il définit de manière déclarative les contrôles du Ruban personnalisés requis par la solution. Il spécifie également les actions appelées à partir du Ruban. Par exemple, de nombreuses solutions disposent d’un bouton sur le Ruban pour lancer le volet Office. Le comportement relatif au lancement du volet Office est une action.

Il est recommandé de créer un fichier manifeste de solution de base avec des paramètres minimaux. Une fois la solution de base opérationnelle, étendez-la pour inclure des actions et des dispositions. Dans le fichier manifeste de solution de base, vous pouvez procéder comme suit :

Spécifiez les paramètres de solution généraux, tels que l’identificateur unique (ID) et un nom complet pour la solution.
Pour chaque type de contenu externe qui sera affiché dans un dossier Outlook :
- Définissez chacun des champs du type de contenu externe à exposer en surface dans Outlook et la façon dont ils doivent être mappés aux champs spécifiques à Outlook. Les champs qui ne sont pas des correspondances exactes peuvent également être spécifiés ; toutefois, ils doivent être définis par un type de données Outlook spécifique reconnu par Outlook (par exemple Text, YesNo ou DateTime). Ces champs personnalisés sont créés et exposés en surface dans la zone de formulaire d’Outlook.
- Acceptez les paramètres de zone de formulaire par défaut de sorte que le BCS Client Runtime génère automatiquement une zone de formulaire par défaut. Une fois votre solution de base opérationnelle, vous pouvez l’étendre pour inclure des zones de formulaires personnalisées.
- Spécifiez le nom et autres détails du dossier Outlook qui contiendra les éléments externes.

Conditions requises

Création d’un manifeste de solution

Vous pouvez créer le manifeste de la solution à l’aide de l’outil de génération d’artefact de BCS, ou en utilisant manuellement le modèle fourni dans le SDK SharePoint 2010.

Pour utiliser l’outil de génération d’artefact de BCS afin de créer le fichier manifeste de la solution

Pour créer le fichier manifeste de la solution à partir du modèle BDC, téléchargez, puis exécutez l’outil de génération d’artefact de BCS. Pour plus d’informations, voir les détails relatifs à l’outil de génération d’artefact de BCS (éventuellement en anglais).

Pour utiliser le modèle du manifeste de la solution afin de créer le fichier manifeste de la solution

Recherchez le Modèle : manifeste de solution (Oir.config) fourni dans SDK SharePoint 2010, copiez-le, puis enregistrez-le dans le dossier Solution Artifacts en tant que OIR.config.
Ouvrez le fichier OIR.config pour le modifier dans un éditeur XML. Si vous ouvrez le fichier XML dans Visual Studio, attachez le schéma déclaratif d’OIR.config (SolutionManifestDefinitions.xsd et SolutionManifestDeclarativeExtensions.xsd. Cela vous permettra de disposer de fonctionnalités IntelliSense et vous aidera à créer des entrées valides. Pour plus d’informations, voir la documentation relative à SolutionManifestDefinitions, schéma et SolutionManifestDeclarativeExtensions, schéma.

Remplacez les valeurs marquées avec EnterX dans le code XML par des valeurs valides. L’exemple de code XML suivant illustre l’aspect possible après modification.

<?xml version="1.0" encoding="utf-8"?>
<SolutionDefinition xmlns:Declarative="https://schemas.microsoft.com/office/2009/05/BusinessApplications/Manifest/DeclarativeExtensions" 

xmlns="https://schemas.microsoft.com/office/2009/05/BusinessApplications/Manifest" xmlns:xsl="http://www.w3.org/2001/XMLSchema-instance">
  <SolutionSettings SolutionId="ContosoSalesManager" SolutionDisplayName="Contoso Sales Manager" SolutionVersion="1.0.0.0"/>
  <ContextDefinitionGroups>
    <ContextDefinitionGroup xsl:type="Declarative:DeclarativeContextDefinitionGroup" ItemType="OutlookContact" >
      <ContextDefinition xsl:type="Declarative:DeclarativeContextDefinition" ContentType="OutlookContactCustomer">
        <Entities>
          <Entity Name="Customer" EntityTypeName="Customer" EntityTypeNamespace="AWWSExample" Description="Customer">
            <View Name="PrimaryEntityNameInContext" ViewName="GetCustomerById" Description="GetCustomerById" IsPrimary="true">
              <PromotedProperty Name="CustomerId" ViewInstancePath="CustomerId" OfficeItemPropertyName="CustomerId" ReadOnly="true" />
              <PromotedProperty Name="Title" ViewInstancePath="Title" OfficeItemPropertyName="Title" ReadOnly="false" />
              <PromotedProperty Name="FirstName" ViewInstancePath="FirstName" OfficeItemPropertyName="FirstName" ReadOnly="false" />
              <PromotedProperty Name="MiddleName" ViewInstancePath="MiddleName" OfficeItemPropertyName="MiddleName" ReadOnly="false" />
              <PromotedProperty Name="LastName" ViewInstancePath="LastName" OfficeItemPropertyName="LastName" ReadOnly="false" />
              <PromotedProperty Name="Email1Address" ViewInstancePath="EmailAddress" OfficeItemPropertyName="Email1Address" ReadOnly="false" />
              <PromotedProperty Name="BusinessTelephoneNumber" ViewInstancePath="Phone" OfficeItemPropertyName="BusinessTelephoneNumber" ReadOnly="false" />
              <PromotedProperty Name="ModifiedDate" ViewInstancePath="ModifiedDate" OfficeItemPropertyName="ModifiedDate" ReadOnly="false" />
            </View>
          </Entity>
        </Entities>
        <OfficeItemCustomizations xsl:type="OutlookItemCustomizations" ItemTypeDisplayName="Contoso Customer" MessageClass="IPM.Contact.AWWSCustomer">
          <OfficeItemProperties>
            <OfficeItemProperty Name="CustomerId" PropertyName="CustomerId" PropertyType="OutlookInteger" />
            <OfficeItemProperty Name="Title" PropertyName="Title" PropertyType="OutlookText" />
            <OfficeItemProperty Name="FirstName" PropertyName="FirstName" PropertyType="OutlookText" />
            <OfficeItemProperty Name="MiddleName" PropertyName="MiddleName" PropertyType="OutlookText" />
            <OfficeItemProperty Name="LastName" PropertyName="LastName" PropertyType="OutlookText" />
            <OfficeItemProperty Name="Email1Address" PropertyName="Email1Address" PropertyType="OutlookText" />
            <OfficeItemProperty Name="BusinessTelephoneNumber" PropertyName="BusinessTelephoneNumber" PropertyType="OutlookText" />
            <OfficeItemProperty Name="ModifiedDate" PropertyName="ModifiedDate" PropertyType="OutlookDateTime" />
          </OfficeItemProperties>
          <FormRegions xsl:type="Declarative:DeclarativeFormRegions" AutoGenerate="true"></FormRegions>
          <OutlookFolder Name="ContosoCustomers" FolderDisplayName="Contoso Customers" NativeType="FolderContacts" SubscriptionName="AWWSExampleCustomerSubscription" FolderName="ContosoCustomerFolderID" CanCreate="true" CanUpdate="true" CanDelete="false">
            <Views />
            <Associations />
          </OutlookFolder>
        </OfficeItemCustomizations>
      </ContextDefinition>
    </ContextDefinitionGroup>
  </ContextDefinitionGroups>
</SolutionDefinition>

Enregistrez et fermez le fichier.

Vous venez de créer le fichier OIR.config de base nécessaire à la solution déclarative intermédiaire Outlook.

Étapes suivantes

Étape 4 : empaqueter et déployer la solution Outlook déclarative

Partager via