Adapterkonfigurationsschemas
Bei der Entwurfszeitkonfiguration eines Adapters werden verschiedene Schematypen verwendet. Je nach Sichtbarkeit und Bereich von Eigenschaftswerten werden verschiedene Schemas bearbeitet und verwendet.
Handlerschemas
Die von einem Handler stammende Adapterkonfiguration wird auf den Adapter und all seine Consumer in einem globalen Bereich angewendet. Ein Administrator kann die Handlerkonfiguration zur Entwurfszeit statisch ändern, indem er die BizTalk Server Verwaltungskonsole verwendet, um den Empfangs- oder Sendehandler des Adapters zu erweitern und die Eigenschaften des angegebenen Hosts anzuzeigen.
Der im SDK enthaltene Beispieldateiadapter verfügt über eine Reihe von XSD-Dateien, mit denen der zugehörige Empfangsspeicherort, Sendeport, Empfangshandler und Sendehandler konfiguriert wird. Ändern Sie diese XSD-Dateien so, dass Ihr benutzerdefinierter Adapter die erforderlichen Konfigurationseigenschaften erhält. Bei den zu ändernden Dateien, die dem Beispieldateiadapter beiliegen, handelt es sich um die Schemadateien TransmitHandler.xsd und ReceiveHandler.xsd. Diese Dateien konfigurieren den Sende- bzw. Empfangshandler, indem sie die Eigenschaftenseiten steuern, die zum Konfigurieren der Handler in der BizTalk Server-Verwaltungskonsole verwendet werden.
Erstellen Sie anhand Ihrer Adapteranforderungen eine Liste mit Konfigurationseigenschaften, die für die einzelnen Endpunkte erforderlich sind. Wenn alle Konfigurationseigenschaften global definiert sind, müssen möglicherweise nur die Konfigurationen von Sendeports und Empfangsports geändert werden. Wenn die Adaptereigenschaften für Sendeports oder Empfangsspeicherorte einzeln festgelegt werden sollen, müssen dazu auch die Konfigurationsdateien für Empfangsspeicherorte und Sendeports geändert werden.
Das Adapterframework bietet Schemaerweiterungen und erweiterte Konfigurationsoptionen zur Unterstützung allgemeiner Anforderungen bei der Adapterkonfiguration. Außerdem werden Erweiterungen bereitgestellt, die nicht im Schema des Beispieldateiadapters enthalten sind. Weitere Informationen zu den Adapter Framework-Schemaerweiterungen finden Sie unter Adapter Framework-Konfigurationsschemaerweiterungen. Weitere Informationen zu erweiterten Konfigurationsoptionen wie benutzerdefinierten Dropdown-Editoren und benutzerdefinierten Typkonvertern finden Sie unter Erweiterte Konfigurationskomponenten für Adapter.
Der Code am Ende dieses Themas stammt aus der Datei TransmitHandler.xsd. Er generiert die folgende Eigenschaftenseite.
Mit der Datei 'TransmitHandler.xsd' erstellte Eigenschaftenseite des Sendehandlers
Beachten Sie die Verwendung der <Tags baf:designer>, <baf:displayname> und <baf:description> im TransmitHandler.xsd-Code, der unten gezeigt wird. Dabei handelt es sich um benutzerdefinierte Ergänzungen, die vom Adapterframework bereitgestellt werden, um das Generieren dieser Eigenschaftenseiten zu beschleunigen.
Eine Liste aller verfügbaren Dekorationen für die Verwendung innerhalb des Adapterframeworks finden Sie unter Adapter Framework Configuration Schema Decoration Tags.
Beachten Sie, dass das Schema nur über ein Element verfügt und kein URI-Element enthält.
Wichtig
Speichern Sie keine vertraulichen Kundendaten im Standardadapterschema. Aus Sicherheitsgründen sollten Sie Benutzernamen und Kennwörter erst nach der Bereitstellung eines Adapters konfigurieren. Dadurch wird sichergestellt, dass die Informationen in der Datenbank für Einmaliges Anmelden für Unternehmen (SSO) gespeichert werden. Weitere Informationen zur SSO-Datenbank finden Sie unter Verwenden des einmaligen Anmeldens.
<?xml version="1.0" encoding="utf-16"?>
<xs:schema xmlns:baf="BiztalkAdapterFramework.xsd"
xmlns:b="http://schemas.microsoft.com/BizTalk/2003"
xmlns="http://tempuri.org/XMLSchema1.xsd"
elementFormDefault="qualified" targetNamespace="http://tempuri.org/XMLSchema1.xsd"
id="TransmitHandler" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="Config">
<xs:complexType>
<xs:sequence>
<xs:element default="50" name="sendBatchSize" type="xs:int" >
<xs:annotation>
<xs:appinfo>
<baf:designer>
<baf:displayname _locID="sendBatchSizeName">Batch Size</baf:displayname>
<baf:description _locID="sendBatchSizeDesc">Enter the
maximum number of files to be transmitted per batch</baf:description>
</baf:designer>
</xs:appinfo>
</xs:annotation>
</xs:element>
<xs:element default="4096" name="bufferSize" type="xs:int" >
<xs:annotation>
<xs:appinfo>
<baf:designer>
<baf:displayname _locID="bufferSizeName">Write Buffer Size</baf:displayname>
<baf:description _locID="bufferSizeDesc">Enter the size of
the buffer used to write the file</baf:description>
</baf:designer>
</xs:appinfo>
</xs:annotation>
</xs:element>
<xs:element default="1" name="threadsPerCPU" type="xs:int" >
<xs:annotation>
<xs:appinfo>
<baf:designer>
<baf:displayname _locID="threadsPerCPUName">Threads Per CPU</baf:displayname>
<baf:description _locID="threadsPerCPUDesc">Enter the
number of threads per CPU to execute in the thread pool</baf:description>
</baf:designer>
</xs:appinfo>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:schema>
Schemas für Sendeports und Empfangsspeicherorte
Um für Ihren Adapter portspezifische Eigenschaften festzulegen, ändern Sie die Konfigurationsschemas für Empfangsspeicherort und Sendeport. Mit den Schemadateien TransmitLocation.xsd und ReceiveLocation.xsd wird der Sendeport bzw. der Empfangsspeicherort konfiguriert.
Das Adapterframework bietet Schemaerweiterungen und erweiterte Konfigurationsoptionen zur Unterstützung allgemeiner Anforderungen bei der Adapterkonfiguration. Weitere Informationen zu den Adapter Framework-Schemaerweiterungen finden Sie unter Adapter Framework-Konfigurationsschemaerweiterungen. Weitere Informationen zu erweiterten Konfigurationsoptionen wie benutzerdefinierten Dropdown-Editoren und benutzerdefinierten Typkonvertern finden Sie unter Erweiterte Konfigurationskomponenten für Adapter.
Folgender Code stammt aus der Datei TransmitLocation.xsd und generiert die folgende Eigenschaftenseite.
Darstellung der Eigenschaftenseite des Sendeports für den Beispieldateiadapter
Beachten Sie in der Datei TransmitLocation.xsd unten, dass die Sendeportkonfiguration die <Tags baf:designer>, <baf:displayname> und <baf:description> enthält, genau wie der send-Handler, und sie verwendet auch das <Tag baf:category> . Mit dem Tag category können Eigenschaften gruppiert werden. Wenn Sie über mehr als eine Kategorie verfügen, ist die Kategorie erweiterbar und reduzierbar und wird in grauer Farbe als Überschrift über den Eigenschaften in dieser Kategorie angezeigt. Weitere Informationen finden Sie unter Adapter Framework-Konfigurationsschemaerweiterungen.
Dieses Schema enthält auch ein Feld für den URI. Dieses wird während des Überprüfungsvorgangs durch den Adapter auf der Seite ausgefüllt, die nach der Eingabe aller Feldinformationen auf der Eigenschaftenseite des Sendeports angezeigt wird.
<?xml version="1.0" encoding="utf-16"?>
<xs:schema xmlns:baf="BiztalkAdapterFramework.xsd" xmlns:b="http://schemas.microsoft.com/BizTalk/2003" xmlns="http://tempuri.org/XMLSchema1.xsd" elementFormDefault="qualified" targetNamespace="http://tempuri.org/XMLSchema1.xsd" id="TransmitLocation" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="Config">
<xs:complexType>
<xs:sequence>
<xs:element name="directory" type="xs:string">
<xs:annotation>
<xs:appinfo>
<baf:designer xmlns:baf="BiztalkAdapterFramework.xsd">
<baf:displayname _locID="sendDirectoryName">Directory</baf:displayname>
<baf:description _locID="sendDirectoryDesc">Directory to write the file to</baf:description>
<baf:category _locID="transmitLocationCategory">Transmit Location</baf:category>
</baf:designer>
</xs:appinfo>
</xs:annotation>
</xs:element>
<xs:element default="%MessageID%.xml" name="fileName" type="xs:string">
<xs:annotation>
<xs:appinfo>
<baf:designer xmlns:baf="BiztalkAdapterFramework.xsd">
<baf:displayname _locID="fileNameName">File Name</baf:displayname>
<baf:description _locID="fileNameDesc">The name of the file that will be written</baf:description>
<baf:category _locID="transmitLocationCategory">Transmit Location</baf:category>
</baf:designer>
</xs:appinfo>
</xs:annotation>
</xs:element>
<xs:element default="2" name="fileCopyMode" type="CopyMode">
<xs:annotation>
<xs:appinfo>
<baf:designer xmlns:baf="BiztalkAdapterFramework.xsd">
<baf:displayname _locID="fileCopyModeName">File Mode</baf:displayname>
<baf:category _locID="transmitLocationCategory">Transmit Location</baf:category>
</baf:designer>
</xs:appinfo>
</xs:annotation>
</xs:element>
<xs:element name="uri" type="xs:string">
<xs:annotation>
<xs:appinfo>
<baf:designer xmlns:baf="BiztalkAdapterFramework.xsd">
<baf:browsable show="false" />
</baf:designer>
</xs:appinfo>
</xs:annotation>
</xs:element>
<!-- An example of how an SSO affiliate application would be configured for this endpoint: -->
<!--
<xs:element name="ssoAffiliateApplication" type="baf:SSOList">
<xs:annotation>
<xs:appinfo>
<baf:designer>
<baf:displayname _locID="ssoAffiliateApplicationName">SSO Affiliate</baf:displayname>
<baf:description _locID="ssoAffiliateApplicationDesc">The Single Sign On (SSO) Affiliate Application</baf:description>
<baf:category _locID="ftpCategory">FTP</baf:category>
</baf:designer>
</xs:appinfo>
</xs:annotation>
</xs:element>
-->
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:simpleType name="CopyMode">
<xs:restriction base="xs:int">
<xs:enumeration value="0">
<xs:annotation>
<xs:appinfo>
<baf:designer xmlns:baf="BiztalkAdapterFramework.xsd">
<baf:displayname _locID="appendName">Append</baf:displayname>
</baf:designer>
</xs:appinfo>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="1">
<xs:annotation>
<xs:appinfo>
<baf:designer xmlns:baf="BiztalkAdapterFramework.xsd">
<baf:displayname _locID="createName">Create</baf:displayname>
</baf:designer>
</xs:appinfo>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="2">
<xs:annotation>
<xs:appinfo>
<baf:designer xmlns:baf="BiztalkAdapterFramework.xsd">
<baf:displayname _locID="createNewName">CreateNew</baf:displayname>
</baf:designer>
</xs:appinfo>
</xs:annotation>
</xs:enumeration>
</xs:restriction>
</xs:simpleType>
</xs:schema>
Feedback
Bald verfügbar: Im Laufe des Jahres 2024 werden wir GitHub-Issues stufenweise als Feedbackmechanismus für Inhalte abbauen und durch ein neues Feedbacksystem ersetzen. Weitere Informationen finden Sie unter https://aka.ms/ContentUserFeedback.
Feedback senden und anzeigen für