Usar esquemas gs-ac-schemas

La estructura física y lógica de los datos que se llevan en la aplicación se describe en XML. Obedece a una gramática específica de Adobe Campaign, denominada esquema.

Un esquema es un documento XML asociado a una tabla de una base de datos. Define la estructura de datos y describe la definición SQL de la tabla:

También describe la estructura XML utilizada para almacenar datos:

Los esquemas permiten definir una entidad en la base de datos. Hay un esquema para cada entidad.

Adobe Campaign emplea esquemas de datos para:

Para comprender mejor las tablas integradas de Campaign y su interacción, consulte esta sección.

Sintaxis de esquemas syntax-of-schemas

El elemento raíz del esquema es <srcschema>. Contiene los subelementos <element> y <attribute>.

El primer subelemento <element> coincide con la raíz de la entidad.

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

Las etiquetas <element> definen los nombres de los elementos de entidad. Las etiquetas <attribute> del esquema definen los nombres de los atributos en las etiquetas <element> a las que se han vinculado.

Identificación de un esquema identification-of-a-schema

Un esquema de datos se identifica con su nombre y área de nombres.

Un área de nombres permite agrupar un conjunto de esquemas por área de interés. Por ejemplo, el área de nombres cus se usa para la configuración específica del cliente (customers).

Áreas de nombres reservadas reserved-namespaces

Algunas áreas de nombres están reservadas para descripciones de las entidades del sistema necesarias para el funcionamiento de la aplicación de Adobe Campaign. El espacio de nombres siguiente no debe usarse para identificar un nuevo esquema, en cualquier combinación de mayúsculas y minúsculas:

La clave de identificación de un esquema es una cadena creada usando el área de nombres y el nombre separados por dos puntos; por ejemplo: nms:recipient.

Creación o ampliación de esquemas de Campaign create-or-extend-schemas

Para añadir un campo u otro elemento a uno de los esquemas de datos principales en Campaign, como la tabla de destinatarios (nms:recipient), debe ampliar ese esquema.

Para obtener más información, consulte Ampliar un esquema.

Para añadir un tipo de datos completamente nuevo que no existe en Adobe Campaign (por ejemplo, una tabla de contratos), puede crear un esquema personalizado directamente.

Para obtener más información, consulte Crear un nuevo esquema.

Una vez creado o ampliado un esquema para trabajar en, la práctica recomendada es definir sus elementos de contenido XML en el mismo orden en que aparecen a continuación.

Enumeraciones enumerations

Las enumeraciones se definen primero, antes del elemento principal del esquema. Permiten mostrar valores en una lista para restringir las opciones que el usuario tiene para un campo determinado.

Ejemplo:

<enumeration basetype="byte" name="exTransactionTypeEnum" default="store">
<value label="Website" name="web" value="0"/>
<value label="Call Center" name="phone" value="1"/>
<value label="In Store" name="store" value="2"/>
</enumeration>

Al definir campos, puede utilizar esta enumeración de esta manera:

<attribute desc="Type of Transaction" label="Transaction Type" name="transactionType"
type="string" enum="exTransactionTypeEnum"/>

Claves keys

Cada tabla debe tener al menos una clave y, a menudo, se establece automáticamente en el elemento principal del esquema utilizando el atributo autopk establecido en true.

Además, en el contexto de una implementación de Enterprise (FDAC), use @autouuid y configúrelo en true.

La clave principal también se puede definir usando el atributo internal.

Ejemplo:

<key name="householdId" internal="true">
  <keyfield xpath="@householdId"/>
</key>

En este ejemplo, en lugar de permitir que el atributo @autopk o @autouuid cree una clave principal predeterminada denominada "id", estamos especificando nuestra propia clave principal "householdId".

Obtenga más información acerca de las claves en esta sección.

Atributos (campos) attributes--fields-

Los atributos permiten definir los campos que conforman el objeto de datos. Puede usar el botón Insert de la barra de herramientas de la edición de esquemas para soltar plantillas de atributos vacías en el XML donde se encuentra el cursor. Obtenga más información en esta sección.

La lista completa de atributos está disponible en la sección de elementos <attribute> de la documentación de Campaign Classic v7. Estos son algunos de los atributos más utilizados: @advanced, @dataPolicy, @default, @desc, @enum, @expr, @label, @length, @name, @notNull, @required, @ref, @xml, @type.

Para obtener más información sobre cada atributo, consulte la descripción del atributo en Documentación de Campaign Classic v7.

Ejemplos examples

Ejemplo de definición de un valor predeterminado:

<attribute name="transactionDate" label="Transaction Date" type="datetime" default="GetDate()"/>

Ejemplo de uso de un atributo común como plantilla para un campo también marcado como obligatorio:

<attribute name="mobile" label="Mobile" template="nms:common:phone" required="true" />

Ejemplo de un campo calculado que está oculto mediante el atributo @advanced:

<attribute name="domain" label="Email domain" desc="Domain of recipient email address" expr="GetEmailDomain([@email])" advanced="true" />

Ejemplo de un campo XML también almacenado en un campo SQL y que tiene un atributo @dataPolicy.

<attribute name="secondaryEmail" label="Secondary email address" length="100" xml="true" sql="true" dataPolicy="email" />

Vínculos links

Los vínculos son algunos de los últimos elementos del elemento principal del esquema. Definen cómo se relacionan entre sí todos los distintos esquemas de la instancia.

Los vínculos se declaran en el esquema que contiene la clave externa de la tabla a la que están vinculados.

Existen tres tipos de cardinalidad: 1-1, 1-N y N-N. Es el tipo 1-N que se utiliza de forma predeterminada.

Ejemplos examples-1

Ejemplo de vínculo 1-N entre la tabla de destinatarios (esquema predeterminado) y una tabla de transacciones personalizadas:

<element label="Recipient" name="lnkRecipient" revLink="lnkTransactions" target="nms:recipient" type="link"/>

Ejemplo de vínculo 1-1 entre un esquema personalizado "Car" (en el área de nombres "cus") y la tabla de destinatarios:

<element label="Car" name="lnkCar" revCardinality="single" revLink="recipient" target="cus:car" type="link"/>

Ejemplo de una unión externa entre la tabla de destinatarios y una tabla de direcciones basada en la dirección de correo electrónico y no en una clave principal:

<element name="emailInfo" label="Email Info" revLink="recipient" target="nms:address" type="link" externalJoin="true">
  <join xpath-dst="@address" xpath-src="@email"/>
</element>

Aquí, "xpath-dst" corresponde a la clave principal del esquema de destino y "xpath-src" corresponde a la clave externa del esquema de origen.

Pista de auditoría audit-trail

Un elemento útil que puede desear incluir en la parte inferior del esquema es un elemento de seguimiento (Pista de auditoría).

Utilice el ejemplo siguiente para incluir campos relacionados con la fecha de creación, el usuario que creó los datos, la fecha y el autor de la última modificación de todos los datos de la tabla:

<element aggregate="xtk:common:auditTrail" name="auditTrail"/>

Actualización de la estructura de la base de datos updating-the-database-structure

Una vez completados y guardados los cambios, cualquier cambio que pueda afectar a la estructura SQL debe aplicarse a la base de datos. Para ello, utilice el asistente de actualización de bases de datos.

Para obtener más información, consulte esta sección.