配接器組態結構描述

發行項
10/14/2023

配接器的設計階段組態中會使用不同類型的結構描述。依據屬性值的可見性和範圍，將會修改及使用不同的結構描述。

處理常式結構描述

來自處理常式的配接器組態適用於全域範圍的配接器及其所有取用者。系統管理員可以在設計階段使用 BizTalk Server 管理主控台，以靜態方式改變處理常式組態，以展開介面卡的接收或傳送處理常式，並顯示指定主機的屬性。

SDK 中包含的範例 FILE 配接器具有一組 XSD 檔案，可以用來設定其接收位置、傳送埠、接收處理常式和傳送處理常式。請修改這些 XSD 檔案，讓您的自訂配接器可以接收需要的組態屬性。在範例 FILE 配接器隨附的檔案中，您必須修改的檔案包括 TransmitHandler.xsd 和 ReceiveHandler.xsd 結構描述檔案。這些檔案會分別設定傳送處理常式和接收處理常式，方法是控制用來在 BizTalk Server 管理主控台中設定處理常式的屬性頁。

請依照您的配接器需求，建立每個端點所需的組態屬性清單。如果所有的組態屬性都是全域屬性，則可能只需修改傳送和接收埠組態。如果您需要為每個傳送埠或接收位置設定配接器屬性，則必須同時修改接收位置和傳送埠組態檔案。

配接器架構會提供結構描述延伸模組和進階組態選項，以支援一般配接器的組態需求。它也提供了不在範例 FILE 配接器隨附之結構描述中的延伸模組。如需配接器架構延伸模組的詳細資訊，請參閱配接器架構組態架構延伸模組。如需進階組態選項的詳細資訊，例如自訂下拉式編輯器和自訂類型轉換器，請參閱配接器的進階設定元件。

本主題結尾的程式碼來自 TransmitHandler.xsd 檔案，而且會產生下列屬性頁。

顯示 [屬性] 索引標籤的螢幕擷取畫面。
TransmitHandler.xsd 檔案建立的傳送處理常式屬性頁

<請注意，在 TransmitHandler.xsd 程式碼中使用 baf：designer > 、 < baf：displayname > 和 < baf：description > 標記，如下所示。這些標記是配接器架構提供的自訂裝飾，可以加快產生這些屬性頁的速度。

如需配接器架構內可用之所有裝飾的清單，請參閱配接器架構組態架構裝飾標記。

請注意，此結構描述只有一個項目，且未包含 URI 項目。

重要

請勿將敏感的顧客資料儲存在預設的配接器結構描述中。基於安全性考量，您只能在部署配接器之後設定使用者名稱及密碼資訊。如此即可確保這些資訊會儲存到企業單一登入 (SSO) 資料庫中。如需 SSO 資料庫的詳細資訊，請參閱使用 SSO。

<?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>

傳送埠和接收位置結構描述

若要為配接器設定連接埠專用的屬性，請修改接收位置和傳送埠組態結構描述。 TransmitLocation.xsd 和 ReceiveLocation.xsd 結構描述檔案會分別設定傳送埠和接收位置。

配接器架構會提供結構描述延伸模組和進階組態選項，以支援一般配接器的組態需求。如需配接器架構延伸模組的詳細資訊，請參閱配接器架構組態架構延伸模組。如需進階組態選項的詳細資訊，例如自訂下拉式編輯器和自訂類型轉換器，請參閱配接器的進階設定元件。

下列程式碼來自 TransmitLocation.xsd 檔案，而且會產生下列屬性頁。

顯示 [靜態傳輸屬性] 對話方塊的影像。
說明範例 FILE 配接器的傳送埠屬性頁

請注意，以下的 TransmitLocation.xsd 檔案中，傳送埠組態包含 < baf：designer > 、 < baf：displayname > 和 < baf：description > 標籤，就像傳送處理常式一樣，它也會使用 < baf：category > 標記。類別標記可以讓您將屬性群組在一起。如果您有多種類別，則類別將可展開及摺疊，而且會顯示成該類別中屬性上方的灰色標頭。如需詳細資訊，請參閱配接器架構架構延伸模組。

此結構描述也包含 URI 欄位。在配接器進行驗證處理期間，當您在傳送埠屬性頁中輸入所有欄位資訊之後，將會顯示一個頁面，並在該頁面上填入這個欄位。

<?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>

共用方式為

配接器組態結構描述

處理常式結構描述

傳送埠和接收位置結構描述

意見反應

其他資源