Ejemplos de esquemas de configuración personalizada para adaptadores
En esta sección se proporcionan los siguientes ejemplos sobre cómo personalizar esquemas de configuración para adaptadores:
En el ejemplo 1 se muestra un archivo de esquema XSD personalizado completo que representa una página de propiedades del adaptador mediante las extensiones baf:designer y baf:description.
En el ejemplo 2 también se usan las extensiones baf:designer y baf:description para mostrar cómo crear una ventana de valor de propiedad personalizada para la propiedad BatchSize que solo acepta valores entre 1 y 99, ambos incluidos.
En el ejemplo 3 se muestra cómo limitar baf:Password a 8 caracteres. De forma predeterminada, se permiten 22 caracteres.
En el ejemplo 4 se muestra cómo implementar restricciones de coincidencia de patrones en valores de propiedad porque no se admiten patrones XSD.
Ejemplo 1
Este ejemplo muestra un esquema XSD personalizado completo. Representa una página de propiedades del adaptador con las extensiones baf:designer y baf:description.
<?xml version="1.0" encoding="utf-8" ?>
<xs:schema targetNamespace="http://tempuri.org/XMLSchema.xsd"
elementFormDefault="qualified" xmlns="http://tempuri.org/XMLSchema.xsd"
xmlns:baf="BiztalkAdapterFramework.xsd"
xmlns:xs="http://www.w3.org/2001/XMLSchema"
xmlns:msdata="urn:schemas-microsoft-com:xml-msdata">
<xs:import namespace="BiztalkAdapterFramework.xsd" />
<xs:element name="Send">
<xs:complexType>
<xs:sequence>
<xs:element name="directory" type="xs:string" />
<xs:annotation>
<xs:appinfo>
<baf:designer>
<baf:description>Enter the directory that will receive sent files..
</baf:description>
</baf:designer>
</xs:appinfo>
</xs:annotation>
</xs:element>
<xs:element name="fileName" type="" />
<xs:element name="sendBatchSize" type="xs:int" />
<xs:element name="fileCopyMode" type="CopyMode" />
<xs:element name="uri" type="xs:string" >
<xs:annotation>
<xs:appinfo>
<baf:designer>
<baf:browsable show="false" />
</baf:designer>
</xs:appinfo>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:simpleType name="CopyMode">
<xs:restriction base="xs:string">
<xs:enumeration value="Append">
<xs:annotation>
<xs:documentation>= 0</xs:documentation>
</xs:annotation>
<xs:enumeration value="Create">
<xs:annotation>
<xs:documentation>= 1</xs:documentation>
</xs:annotation>
<xs:enumeration value="CreateNew">
<xs:annotation>
<xs:documentation>= 2</xs:documentation>
</xs:annotation>
</xs:enumeration>
</xs:restriction>
</xs:simpleType>
</xs:schema>
Ejemplo 2
En este ejemplo se usan las extensiones baf:designer y baf:description para mostrar cómo crear una ventana de valor de propiedad personalizada para la propiedad BatchSize que solo acepta valores entre 1 y 99, ambos incluidos.
<xs:element name="BatchSize">
<xs:simpleType>
<xs:annotation>
<xs:appinfo>
<baf:designer>
<baf:displayname>Batch Size</baf:displayname>
<baf:description>Enter the batch size (1-99)</baf:description>
</baf:designer>
</xs:appinfo>
</xs:annotation>
<xs:restriction base="xs:int">
<xs:minInclusive value="1" />
<xs:maxInclusive value="99" />
</xs:restriction>
</xs:simpleType>
</xs:element>
Ejemplo 3
Este ejemplo muestra cómo se limita baf:Password a 8 caracteres. De forma predeterminada, se permiten 22 caracteres.
<xs:element name="AdapterPassword">
<xs:simpleType>
<xs:annotation>
<xs:appinfo>
<baf:designer>
<baf:displayname>Adapter Password</baf:displayname>
<baf:description>Enter the password (up to 8 characters)</baf:description>
<baf:editor assembly="%BTSROOT%\\Developer Tools\\Microsoft.BizTalk.Adapter.Framework.dll">Microsoft.BizTalk.Adapter.Framework.ComponentModel.PasswordUITypeEditor</baf:editor>
<baf:converter assembly="%BTSROOT%\\Developer Tools\\Microsoft.BizTalk.Adapter.Framework.dll">Microsoft.BizTalk.Adapter.Framework.ComponentModel.PasswordTypeConverter</baf:converter>
</baf:designer>
</xs:appinfo>
</xs:annotation>
<xs:restriction base="xs:string">
<xs:maxLength value="8" />
</xs:restriction>
</xs:simpleType>
</xs:element>
Ejemplo 4
Este ejemplo muestra cómo se implementan restricciones de coincidencia de patrones en los valores de propiedad porque los patrones de XSD no son compatibles.
Los campos como ClientIdentifier siempre son una cadena numérica de tres caracteres. De este modo, un valor de propiedad 10 no es válido mientras que 010 sí lo es. El siguiente fragmento de esquema de configuración define una propiedad ClientIdentifier . La clase ClientIdentifierConverter , implementada en el ensamblado del adaptador, implementa la coincidencia de patrones. En este caso, el convertidor de tipos personalizado restringe los valores a una cadena de tres dígitos exactamente (del 000 al 999). En el esquema de configuración, asegúrese de que el nodo baf:converter tiene el ensamblado y escriba el conjunto de nombre completo de forma correcta. Si el usuario intenta escribir un valor que no es válido, aparecerá un mensaje de excepción cuando se produzca un error de validación en la página de propiedades.
Puede usar el código siguiente en los esquemas de configuración de la página de propiedades del adaptador.
<xs:element name="ClientIdentifier" type="xs:string">
<xs:annotation>
<xs:appinfo>
<baf:designer>
<baf:displayname>Adapter Client</baf:displayname>
<baf:description>Enter the Adapter Client (3 digit string)</baf:description>
<baf:converter assembly="%BTSROOT%\\Developer Tools\\Microsoft.BizTalk.TestAdapter.dll">Microsoft.BizTalk.TestAdapter.ClientIdentifierConverter</baf:converter>
</baf:designer>
</xs:appinfo>
</xs:annotation>
</xs:element>
Puede colocar el código siguiente en su ensamblado de adaptador.
using System;
using System.ComponentModel;
using System.Globalization;
using System.Text.RegularExpressions;
namespace Microsoft.BizTalk.TestAdapter
{
/// <summary>
/// Summary description for ClientIdentifierConverter.
/// </summary>
public class ClientIdentifierConverter : System.ComponentModel.StringConverter
{
private void Validate(string value)
{
Regex regex = new Regex(@"^\d{3}$"); // ^=begin, \d=digit, {3}=exactly 3 occurrences, $=end
Match match = regex.Match((string)value);
if (!match.Success)
{
throw new ApplicationException("Value does not match pattern \"" + regex.ToString() + "\".");
}
}
public override object ConvertFrom(ITypeDescriptorContext context, CultureInfo culture, object value)
{
if (value is string)
{
this.Validate((string)value);
}
return base.ConvertFrom(context, culture, value);
}
public override object ConvertTo(ITypeDescriptorContext context, CultureInfo culture, object value, Type destinationType)
{
if (typeof(string) == destinationType && value is string)
{
this.Validate((string)value);
}
return base.ConvertTo(context, culture, value, destinationType);
}
}
}
Consulte también
Extensiones de esquema de configuración del marco de trabajo de adaptadores