Schritt 2: Erstellen von Cacheabonnements (*Subscription.xml)

Artikel
09/18/2014

Eine Cacheabonnementdatei ist eine XML-Datei (*Subscription.xml), die definiert, welche externen Inhaltstypen im BDC-Modell zwischengespeichert werden sollen, welche Abfragen im Modell zum Auffüllen der Daten im Cache verwendet werden sollen, und wie oft externe Elemente im Cache aktualisiert werden sollen.

Letzte Änderung: Montag, 22. August 2011

Gilt für: SharePoint Server 2010

Die Cacheabonnementdatei wird von Microsoft Business Connectivity Services (BCS) während der Bereitstellung einer einfachen Lösung automatisch generiert. Für eine anspruchsvollere deklarative Outlook-Lösung müssen Sie jedoch die Datei Subscription.xml erstellen. Diese Datei hält sich an ein sehr einfaches Schema und ist problemlos zu erstellen. Das SDK macht diesen Vorgang mithilfe einer entsprechenden Vorlage und eines Tools sogar noch einfacher.

In diesem Szenario gibt es zwei externe Inhaltstypen, Customer und Order, für die Sie die beiden Abonnementdateien CustomerSubscription.xml und OrderSubscription.xml erstellen müssen. Hierfür können Sie die Vorlage aus dem SDK und das BCS Artifact Generator Tool verwenden.

Hinweis
Die AdventureWorks-Beispieldatenbank enthält mehr als 2.000 Kunden. Deshalb werden vom Beispielwebdienst nur die ersten 1.000 Kundenzeilen zurückgegeben, damit die auf dem Client eingehende Datenmenge überschaubar und verwaltbar bleibt. Aus diesem Grund werden in diesem Szenario nur die entsprechenden Bestellungen für diese 1.000 Kunden zurückgegeben, und nicht die gesamte Bestellliste. In diesem Beispiel wird eine Abonnementzuordnung definiert, um den Cache mit den entsprechenden Bestellungen der 1.000 Kunden aufzufüllen. Zur Leistungsverbesserung können Sie auch eine BulkAssociationNavigator-Methodeninstanz verwenden.

Die AdventureWorks-Beispieldatenbank enthält mehr als 2.000 Kunden. Deshalb werden vom Beispielwebdienst nur die ersten 1.000 Kundenzeilen zurückgegeben, damit die auf dem Client eingehende Datenmenge überschaubar und verwaltbar bleibt. Aus diesem Grund werden in diesem Szenario nur die entsprechenden Bestellungen für diese 1.000 Kunden zurückgegeben, und nicht die gesamte Bestellliste. In diesem Beispiel wird eine Abonnementzuordnung definiert, um den Cache mit den entsprechenden Bestellungen der 1.000 Kunden aufzufüllen. Zur Leistungsverbesserung können Sie auch eine BulkAssociationNavigator-Methodeninstanz verwenden.

Voraussetzungen

Schritt 1: Erstellen des BDC-Modells ("Metadata.bdcm")

Erstellen von Cacheabonnements

Sie können die Cacheabonnements entweder mit dem BCS Artifact Generator Tool oder manuell mit der Vorlage: "BasicSubscription_Subscription.xml" aus dem SharePoint 2010 SDK erstellen.

So erstellen Sie die Abonnementdateien mithilfe des BCS Artifact Generator Tool

Zum Erstellen der beiden erforderlichen Abonnementdateien basierend auf dem BDC-Modell ( CustomerSubscription.xml und OrderHeaderSubscription.xml) laden Sie das BCS Artifact Generator-Tool herunter und führen es aus. Weitere Informationen finden Sie unter BCS Artifact Generator-Tool.

So erstellen Sie die Abonnementdateien mithilfe der Abonnementbasisvorlage

Suchen Sie die Vorlage: "SubscriptionWithAssociation_Subscription.xml" aus dem SharePoint 2010 SDK, kopieren Sie sie, und speichern Sie sie im Ordner Solution Artifacts unter dem Namen CustomerSubscription.xml.
Öffnen Sie die Datei CustomerSubscription.xml zum Bearbeiten in einem XML-Editor. Wenn Sie die XML-Datei in Microsoft Visual Studio öffnen, fügen Sie das Subscription-Schema an (Subscription.xsd). Auf diese Weise steht IntelliSense-Funktionalität bereit, die verhindert, dass Sie ungültige Einträge erstellen.

Ersetzen Sie die mit EnterX markierten Werte im XML-Code durch gültige Werte. Das folgende XML-Beispiel zeigt, wie die Datei nach der Bearbeitung aussehen könnte.

Hinweis
Hierbei handelt es sich um ein sehr einfaches Abonnement. Sie können komplexere Abonnementdateien erstellen, indem Sie der Datei weitere Elemente und Eigenschaften hinzufügen. Weitere Informationen finden Sie in der Dokumentation zum Subscription-Schema.

<?xml version="1.0" encoding="utf-8" ?> 
<Subscription LobSystemInstanceName="http://contoso/webservice.asmx?wsdl" 
              EntityNamespace="AdventureWorks" EntityName="Customer" 
              Name="CustomerSubscription" View="GetCustomerById" 
              IsCached="true" RefreshIntervalInMinutes="360" 
xmlns="https://schemas.microsoft.com/office/2006/03/BusinessDataCatalog">
  <Queries>
    <Query Name="CustomerQuery" MethodInstanceName="GetCustomers" 
           DefaultDisplayName="Customer Read List" 
           RefreshIntervalInMinutes="180" 
IsCached="true" Enabled="true" /> 
  </Queries>
  <Associations>
    <Association Name="GetOrdersForCustomer" 
                 MethodInstanceName="GetOrdersForCustomer" 
                 TargetSubscriptionName="OrderHeaderSubscription" 
TargetView="GetSalesOrderHeaderById" 
                 LobSystemInstanceName="http://contoso/webservice.asmx?wsdl" 
                 RefreshIntervalInMinutes="60" /> 
  </Associations>
</Subscription>

Speichern und schließen Sie die Datei.
Erstellen Sie das Zielabonnement, mit dem Business-Konnektivitätsdienste (Business Connectivity Services) angewiesen wird, welche Abfrage zum Auffüllen der entsprechenden Bestellungen für jeden Kunden ausgeführt werden soll. Kopieren Sie dazu die Vorlage: "BasicSubscription_Subscription.xml", und speichern Sie sie im Ordner Solution Artifacts unter dem Namen OrderHeaderSubscription.xml.
Öffnen Sie die Datei OrderHeaderSubscription.xml zum Bearbeiten. Wenn Sie die Datei in Visual Studio öffnen, fügen Sie das Subscription-Schema an (Subscription.xsd).

Ersetzen Sie die mit EnterX markierten Werte im XML-Code durch gültige Werte. Der hier für das Abonnement angegebene Name muss mit dem Namen übereinstimmen, der für das TargetSubscriptionName-Attribut in der Datei CustomerSubscription.xml angegeben wurde. Das folgende XML-Beispiel zeigt, wie die Datei nach der Bearbeitung aussehen könnte.

<?xml version="1.0" encoding="utf-8" ?>
<Subscription LobSystemInstanceName="http://contoso/webservice.asmx?wsdl"
              EntityNamespace="AdventureWorks" EntityName="Customer"
              Name="CustomerSubscription" View="GetCustomerById"
              IsCached="true" RefreshIntervalInMinutes="360"
              xmlns="https://schemas.microsoft.com/office/2006/03/BusinessDataCatalog">
  <Queries>
    <Query Name="CustomerQuery" MethodInstanceName="GetCustomers"
           DefaultDisplayName="Customer Read List"
           RefreshIntervalInMinutes="180"
IsCached="true" Enabled="true" />
  </Queries>
  <Associations>
    <Association Name="GetOrdersForCustomer"
                 MethodInstanceName="GetOrdersForCustomer"
                 TargetSubscriptionName="OrderHeaderSubscription"
TargetView="GetSalesOrderHeaderById"
                 LobSystemInstanceName="http://contoso/webservice.asmx?wsdl"
                 RefreshIntervalInMinutes="60" />
  </Associations>
</Subscription>

Speichern Sie die Datei und schließen Sie sie.

Damit haben Sie die Cacheabonnements, die Sie für die anspruchsvollere deklarative Outlook-Lösung benötigen, erfolgreich erstellt.

Weitere Schritte

Schritt 3: Erstellen der Lösungsmanifestdatei ("OIR.config")

Freigeben über