Estructura del esquema

La estructura básica de un <srcschema> es la siguiente:

<srcSchema>
    <enumeration>
        ...          //definition of enumerations
    </enumeration>
   
    <element>         //definition of the root <element>    (mandatory)

        <compute-string/>  //definition of a compute-string
        <key>
            ...        //definition of keys
        </key>
        <sysFilter>
            ...           //definition of filters
        </sysFilter>
        <attribute>
            ...             //definition of fields
        </attribute>
    
            <element>           //definition of sub-<element> 
                  <attribute>           //(collection, links or XML)
                  ...                         //and additional fields
                  </attribute>
                ...
            </element>
      
    </element> 

        <methods>                 //definition of SOAP methods
            <method>
                ...
            </method>
            ...
    </methods>  
          
</srcSchema>

El documento XML de un esquema de datos debe contener <srcschema> el elemento raíz con los atributos name y namespace para rellenar el nombre del esquema y su área de nombres.

<srcSchema name="schema_name" namespace="namespace">
...
</srcSchema>

Permita utilizar el siguiente contenido XML para ilustrar la estructura de un esquema de datos:

<recipient email="John.doe@aol.com" created="AAAA/DD/MM" gender="1"> 
  <location city="London"/>
</recipient>

Con su esquema de datos correspondiente:

<srcSchema name="recipient" namespace="cus">
  <element name="recipient">
    <attribute name="email"/>
    <attribute name="created"/>
    <attribute name="gender"/>
    <element name="location">
      <attribute name="city"/>
   </element>
  </element>
</srcSchema>

Descripción

El punto de entrada del esquema es el elemento principal. Es fácil de identificar porque tiene el mismo nombre que el esquema y debe ser el elemento secundario del elemento raíz. La descripción del contenido comienza con este elemento.

En nuestro ejemplo, el elemento principal se representa mediante la siguiente línea:

<element name="recipient">

Los elementos <attribute> y <element> que siguen al elemento principal permiten definir las ubicaciones y los nombres de los elementos de datos en la estructura XML.

En nuestro esquema de ejemplo, estos son:

<attribute name="email"/>
<attribute name="created"/>
<attribute name="gender"/>
<element name="location">
  <attribute name="city"/>
</element>

Deben respetarse las siguientes normas:

  • Cada <element> y <attribute> deben identificarse por su nombre a través del atributo name.

    PRECAUCIÓN

    El nombre del elemento debe ser conciso, preferiblemente en inglés, e incluir solo caracteres autorizados de acuerdo con las reglas de nomenclatura XML.

  • Solo los elementos <element> pueden contener <attribute> elementos y <element> elementos en la estructura XML.

  • Un elemento <attribute> debe tener un nombre único dentro de un <element>.

  • Se recomienda el uso de <elements> en cadenas de datos de varias líneas.

Tipos de datos

El tipo de datos se introduce mediante el atributo type en los elementos <attribute> y <element>.

Encontrará una lista detallada en Campaign Classic v7 documentation.

Cuando este atributo no se rellena, string es el tipo de datos predeterminado a menos que el elemento contenga elementos secundarios. Si lo hace, solo se utiliza para estructurar los elementos jerárquicamente (<location> elemento en nuestro ejemplo).

Los esquemas admiten los siguientes tipos de datos:

  • cadena: cadena de caracteres. Ejemplos: un nombre, un pueblo, etc.

    El tamaño se puede especificar mediante el atributo length (opcional, valor predeterminado "255").

  • booleano: Campo booleano. Ejemplo de valores posibles: true/false, 0/1, sí/no, etc.

  • byte, abreviado, largo: enteros (1 byte, 2 bytes, 4 bytes). Ejemplos: edad, número de cuenta, número de puntos, etc.

  • doble: número de coma flotante de precisión doble. Ejemplos: precio, tasa, etc.

  • fecha, fecha y hora: fechas y fechas + horas. Ejemplos: fecha de nacimiento, fecha de compra, etc.

  • datetimenotz: fecha + hora sin datos de zona horaria.

  • timespan: duraciones. Ejemplo: antigüedad.

  • nota: campos de texto largos (varias líneas). Ejemplos: una descripción, un comentario, etc.

  • uuid: campos "identificador único"

    NOTA

    Para contener un campo uuid , se debe agregar la función "newuuid()" y completarla con su valor predeterminado.

Este es un ejemplo de esquema con los tipos introducidos:

<srcSchema name="recipient" namespace="cus">
  <element name="recipient">
    <attribute name="email" type="string" length="80"/>
    <attribute name="created" type="datetime"/>
    <attribute name="gender" type="byte"/>
    <element name="location">
      <attribute name="city" type="string" length="50"/>
   </element>
  </element>
</srcSchema>

Propiedades

Los elementos <elements> y <attributes> del esquema de datos se pueden enriquecer con varias propiedades. Puede rellenar una etiqueta para describir el elemento actual.

Etiquetas y descripciones

  • La propiedad label permite introducir una breve descripción.

    NOTA

    La etiqueta está asociada al idioma actual de la instancia.

    Ejemplo:

    <attribute name="email" type="string" length="80" label="Email"/>
    

    La etiqueta se puede ver desde el formulario de entrada de la consola del cliente de Adobe Campaign:

  • La propiedad desc permite introducir una descripción larga.

    La descripción se puede ver desde el formulario de entrada en la barra de estado de la ventana principal de la consola del cliente de Adobe Campaign.

    NOTA

    La descripción está asociada al idioma actual de la instancia.

    Ejemplo:

    <attribute name="email" type="string" length="80" label="Email" desc="Email of recipient"/>
    

Valores predeterminados

La propiedad default permite definir una expresión que devuelva un valor predeterminado en la creación de contenido.

El valor debe ser una expresión compatible con el lenguaje XPath. Para obtener más información, consulte esta sección.

Ejemplo:

  • Fecha actual: default="GetDate()"

  • Contador: default="'FRM'+CounterValue('myCounter')"

    En este ejemplo, el valor predeterminado se construye utilizando la concatenación de una cadena y llamando a la función CounterValue con un nombre de contador libre. El número devuelto se incrementa en uno en cada inserción.

    NOTA

    En la consola del cliente de Adobe Campaign, el nodo Administration>Counters se utiliza para administrar los contadores.

Para vincular un valor predeterminado a un campo, puede utilizar el <default> or <sqldefault> field. </sqldefault> </default>

<default> : permite rellenar previamente el campo con un valor predeterminado al crear entidades. El valor no es un valor SQL predeterminado.

<sqldefault> : permite tener un valor añadido al crear un campo. Este valor aparece como un resultado SQL. Durante una actualización de esquema, solo los registros nuevos se verán afectados por este valor.

Enumeraciones

Enumeración libre

La propiedad userEnum permite definir una enumeración libre para memorizar y mostrar los valores introducidos mediante este campo. La sintaxis es la siguiente:

userEnum="name of enumeration"

El nombre dado a la enumeración puede elegirse libremente y compartirse con otros campos.

Estos valores se muestran en una lista desplegable del formulario de entrada:

NOTA

En la consola del cliente de Adobe Campaign, el nodo Administration > Enumerations se utiliza para administrar las enumeraciones.

Establezca la enumeración

La propiedad enum permite definir una enumeración fija utilizada cuando se conoce de antemano la lista de valores posibles.

El atributo enum hace referencia a la definición de una clase de enumeración rellenada en el esquema fuera del elemento principal.

Las enumeraciones permiten al usuario seleccionar un valor de una lista desplegable en lugar de introducir el valor en un campo de entrada normal:

Ejemplo de una declaración de enumeración en el esquema de datos:

<enumeration name="gender" basetype="byte" default="0">    
  <value name="unknown" label="Not specified" value="0"/>    
  <value name="male" label="male" value="1"/>   
  <value name="female" label="female" value="2"/>   
</enumeration>

Se declara una enumeración fuera del elemento principal mediante el elemento <enumeration> .

Las propiedades de la enumeración son las siguientes:

  • baseType: tipo de datos asociados a los valores,
  • etiqueta: descripción de la enumeración,
  • nombre: nombre de la enumeración,
  • predeterminado: valor predeterminado de la enumeración.

Los valores de enumeración se declaran en el elemento <value> con los siguientes atributos:

  • nombre: nombre del valor almacenado internamente,
  • etiqueta: etiqueta mostrada a través de la interfaz gráfica.

enumeración dbenum

  • La propiedad dbenum permite definir una enumeración cuyas propiedades son similares a las de la propiedad enum.

    Sin embargo, el atributo name no almacena el valor internamente, sino que almacena un código que permite ampliar las tablas correspondientes sin modificar su esquema.

    Los valores se definen mediante el nodo Administration>Enumerations.

    Esta enumeración se utiliza para especificar la naturaleza de las campañas, por ejemplo.

Ejemplo

A continuación, se muestra un ejemplo de esquema con las propiedades rellenadas:

<srcSchema name="recipient" namespace="cus">
  <enumeration name="gender" basetype="byte">    
    <value name="unknown" label="Not specified" value="0"/>    
    <value name="male" label="male" value="1"/>   
    <value name="female" label="female" value="2"/>   
  </enumeration>

  <element name="recipient">
    <attribute name="email" type="string" length="80" label="Email" desc="Email of recipient"/>
    <attribute name="created" type="datetime" label="Date of creation" default="GetDate()"/>
    <attribute name="gender" type="byte" label="gender" enum="gender"/>
    <element name="location" label="Location">
      <attribute name="city" type="string" length="50" label="City" userEnum="city"/>
   </element>
  </element>
</srcSchema>

Colecciones

Una colección es una lista de elementos con el mismo nombre y el mismo nivel jerárquico.

El atributo unbound con el valor "true" permite rellenar un elemento de colección.

Ejemplo: definición del elemento de <group> colección en el esquema.

<element name="group" unbound="true" label="List of groups">
  <attribute name="label" type="string" label="Label"/>
</element>

Con proyección del contenido XML:

<group label="Group1"/>
<group label="Group2"/>

Referencia con XPath

El lenguaje XPath se utiliza en Adobe Campaign para hacer referencia a un elemento o atributo perteneciente a un esquema de datos.

XPath es una sintaxis que permite localizar un nodo en el árbol de un documento XML.

Los elementos se designan por su nombre y los atributos se designan por el nombre precedido del carácter “@”.

Ejemplo:

  • @email: selecciona el correo electrónico,
  • location/@city: selecciona el atributo "city" en el <location> elemento
  • …/@email: selecciona la dirección de correo electrónico del elemento principal del elemento actual
  • grupo[1]/@label: selecciona el atributo "label" que es el elemento secundario del primer elemento de <group> colección
  • grupo[@label='test1']: selecciona el atributo “label” que es el elemento secundario del <group> elemento y contiene el valor “test1”
NOTA

Se agrega una restricción adicional cuando la ruta cruza un subelemento. En este caso, la siguiente expresión debe colocarse entre corchetes:

  • location/@ cityis no es válido; utilice [location/@city]
  • [@email] y @ emailare equivalentes

También es posible definir expresiones complejas, como las siguientes operaciones aritméticas:

  • @gender+1: añade 1 al contenido del atributo ​genderattribute,
  • @email + '('+@created+')': crea una cadena tomando el valor de la dirección de correo electrónico añadida a la fecha de creación entre paréntesis (para el tipo de cadena, ponga la constante entre comillas).

Se han añadido funciones de alto nivel a las expresiones para enriquecer el potencial de este idioma.

Puede acceder a la lista de funciones disponibles a través de cualquier editor de expresiones de la consola del cliente de Adobe Campaign:

Ejemplo:

  • GetDate(): devuelve la fecha actual
  • Year(@created): devuelve el año de la fecha contenida en el atributo "created".
  • GetEmailDomain(@email): devuelve el dominio de la dirección de correo electrónico.

Creación de una cadena mediante la cadena de cálculo

Una Compute string es una expresión XPath que se utiliza para construir una cadena que representa un registro en una tabla asociada con el esquema. La cadena Compute se utiliza principalmente en la interfaz gráfica para mostrar la etiqueta de un registro seleccionado.

La Compute string se define mediante el elemento <compute-string> debajo del elemento principal del esquema de datos. Un atributo expr contiene una expresión XPath para calcular la visualización.

Ejemplo: cálculo de cadena de la tabla de destinatarios.

<srcSchema name="recipient" namespace="nms">  
  <element name="recipient">
    <compute-string expr="@lastName + ' ' + @firstName +' (' + @email + ')' "/>
    ...
  </element>
</srcSchema>

Resultado de la cadena calculada para un destinatario: Doe John (john.doe@aol.com)

NOTA

Si el esquema no contiene una Compute string, una Compute string se rellena de forma predeterminada con los valores de la clave principal del esquema.

En esta página