Elemento TemplateTag de un archivo de definición de plantilla
Los archivos de definición de plantilla utilizan el elemento
TemplateTag
y el elemento TemplateDocument
. Se pueden definir varios elementos TemplateTag
para cada mensaje XML de entrada. Cada elemento TemplateTag
debe enlazarse a un elemento TemplateDocument
utilizando el atributo name
. El valor que está asociado con el atributo name
debe coincidir con el valor de un subelemento TemplateTagName dentro de un elemento TemplateDocument que se ha definido dentro del archivo de definición de plantilla.Cada elemento TemplateTag contiene una lista de definiciones de código en el subelemento Tag. El elemento Tag puede contener los cinco atributos siguientes:
XPath
- La vía de acceso del elemento XML, relativa al
StartElement
indicado enTemplateDocument
. El elementoXPath
es la clave para encontrar el nombre de campo de la pareja nombre-valor. Los siguientes ejemplos muestran el valor que puede utilizarse para el atributoXPath
:- E1/E2 - El elemento E2 está anidado dentro del elemento E1.
XPath='Address/ZipCode'
- E1/E2/E3 - El elemento E3 está anidado dentro del elemento E2, que está anidado dentro del elemento E1.
XPath='ContactInfo/Address/ZipCode'
- E3@a1 - El atributo a1 está anidado dentro del elemento E3.
XPath='InvoiceInfo@InvoiceType'
El atributoInvoiceType
puede utilizarse para indicar a qué tipo de factura se aplica el mensaje. - E4[1] - La primera instancia del elemento E4. Pueden haber varias instancias de E4. Por ejemplo, puede utilizar este formato cuando tiene varias líneas de una dirección. Cada línea de la dirección está en un elemento de etiqueta aparte.
- E5[@2="value 2"] - Una instancia del elemento E5, donde el atributo a2 dentro de E5 es igual a
"value 2"
.XPath='InvoiceInfo[@InvoiceType="ShippingInvoice"]
E5[@a1="value1"][@a2="value 2"] - La instancia del elemento E5, donde el atributo a1 de E5 es igual a
'"value1"
y el atributo a2 de E5 es igual a"value 2"
.
- E1/E2 - El elemento E2 está anidado dentro del elemento E1.
XPathType
- El tipo de elemento que está indicado en XPath. Este atributo indica cómo el analizador XML va a procesar el elemento XML. Están soportados los siguientes tipos como valores para el atributo.
- PCDATA
- El elemento o el atributo del elemento contiene datos entrantes sin procesar que se procesan y devuelven en un par nombre-valor. Este tipo es el valor predeterminado de
XPathType
. - EMPTY
- El elemento está vacío o contiene datos que se pueden ignorar. Para este elemento no se devuelve ninguna pareja nombre-valor.
- REPEAT
- El elemento puede tener varias instancias. El
PCDATA
para cada elemento se devuelve en un par nombre-valor. - ATTRIBUTE
- Si el nombre de campo de elemento se determina mediante el valor de un atributo, el tipo de este atributo debe ser
ATTRIBUTE
. - VECTOR
- Una nueva tabla hash se añade al Vector y todos los pares nombre-valor que se genera para los subelementos se colocan en la nueva tabla hash.
- USERDATA
- Indica un elemento definido por el usuario. El elemento tiene un atributo llamado
name
cuyo valor es el nombre de campo. Los datos del elemento se devuelven en una pareja nombre-valor.
- Campo
- El nombre de campo del par nombre-valor que se coloca en
TypedProperty
. El valor para este atributo debe coincidir con el nombre de un parámetro que utiliza el mandato llamado. - FieldType
- El tipo del campo de datos. El tipo de campo puede ser
String
oDate
(formato de fecha ISO 8601). El valor predeterminado esString
. - FieldInfo
- Indica el
TypedProperty
donde se debe colocar el par nombre-valor. El valor predeterminado esData
. Si desea colocar el par nombre-valor en más de unTypedProperty
, debe especificar más de uno de los siguientes valores, separados por una coma:- Data
- El par nombre-valor se coloca en la correlación de propiedades de solicitud del objeto
CommandProperty
que contiene argumentos para el mandato. - Control
- El par nombre-valor se coloca en la correlación de propiedades de ejecución del objeto
CommandProperty
que contiene información de control para el mandato, como por ejemplo USERID o PASSWORD. Estos pares nombre-valor normalmente se utilizan antes de la ejecución lógica de negocio real real, como por ejemplo el control de validación/acceso de usuario. - Mandato
- El par nombre-valor se utiliza para determinar a qué mandato se debe llamar. Las parejas nombre-valor generadas se utilizan en el elemento
CommandMapping
del elementoTemplateDocument
.
Si el elemento XPath
no se encuentra dentro de la plantilla de etiqueta, el XPath en el mensaje XML se utiliza como nombre de campo y el XPathType
es PCDATA
. Se genera un par nombre-valor utilizando XPath
como nombre de campo.
Para ver un ejemplo de cómo se utiliza el elemento TemplateTag
, consulte el archivo sys_template.xml.