AEM 6.4 ha llegado al final de la compatibilidad ampliada y esta documentación ya no se actualiza. Para obtener más información, consulte nuestra períodos de asistencia técnica. Buscar las versiones compatibles here.
Un diccionario de datos permite a los usuarios empresariales utilizar información de fuentes de datos back-end sin conocer detalles técnicos sobre sus modelos de datos subyacentes. Un diccionario de datos está compuesto por elementos de diccionario de datos (DDE). Estos elementos de datos se utilizan para integrar datos del back-end en las cartas como entrada para usarlos en la correspondencia con los clientes.
Un diccionario de datos es una representación independiente de metadatos que describe estructuras de datos subyacentes y sus atributos asociados. Se crea un diccionario de datos con vocabulario empresarial. Se puede asignar a uno o más modelos de datos subyacentes.
El diccionario de datos está formado por elementos de tres tipos: elementos simples, compuestos y de colección. Los DDE simples son elementos primitivos como cadenas, números, fechas y valores booleanos que contienen información como un nombre de ciudad. Un DDE compuesto contiene otros DDE, que pueden ser de tipo primitivo, compuesto o de colección. Por ejemplo, una dirección que consta de una dirección de calle, ciudad, provincia, país y código postal. Una colección es una lista de DDE simples o compuestos similares. Por ejemplo, un cliente con varias ubicaciones o direcciones de facturación y envío distintas.
Correspondence Management utiliza el back-end, el cliente,
o datos específicos del destinatario almacenados según la estructura del diccionario de datos para crear correspondencia destinada a diferentes clientes. Por ejemplo, se puede crear un documento con nombres descriptivos, como “Estimado {Nombre}”, “Sr. {Apellidos}”.
Normalmente, los usuarios empresariales no necesitan conocer las representaciones de metadatos, como las clases XSD (esquema XML) y Java. Sin embargo, por lo general, requieren acceso a estas estructuras y atributos de datos para crear soluciones.
Instale el Paquete de compatibilidad para ver la opción Diccionarios de datos en la página de Forms.
Puede usar el Editor de diccionario de datos para crear un diccionario de datos o para cargar un archivo de esquema XSD para crear un diccionario de datos basado en él. A continuación, puede ampliar el diccionario de datos al agregar más información necesaria, incluidos campos. Independientemente de cómo se haya creado el diccionario de datos, el propietario del proceso empresarial no necesita conocer los sistemas back-end. El propietario del proceso empresarial solo necesita conocer los objetos de dominio y sus definiciones para su proceso.
Para varias cartas que requieran elementos similares, puede crear un diccionario de datos común. Sin embargo, un diccionario de datos grandes con un gran número de elementos puede provocar problemas de rendimiento al utilizarlo y al cargar los elementos, como en cartas y fragmentos de documento. Si tiene problemas de rendimiento, intente crear diccionarios de datos independientes para cartas diferentes.
Seleccione Forms > Diccionarios de datos.
Pulse Crear diccionario de datos.
En la pantalla Propiedades, agregue lo siguiente:
Título: (Opcional) escriba el título del diccionario de datos. El título no tiene que ser único y puede tener caracteres especiales y caracteres que no sean ingleses. A las cartas y otros fragmentos de documento se refieren mediante su título (cuando están disponibles), como en miniaturas y propiedades de recursos. Se hace referencia a los diccionarios de datos con sus nombres y no títulos.
Nombre: nombre exclusivo del diccionario de datos. En el campo Nombre, solo se pueden introducir caracteres, números y guiones en inglés. El campo Nombre se rellena automáticamente en función del campo Título y los caracteres especiales, espacios, números y caracteres que no sean ingleses introducidos en el campo Título se sustituirán por guiones. Aunque el valor del campo Título se copia automáticamente en Nombre, puede editarlo.
Descripción: (Opcional) descripción del diccionario de datos.
Etiquetas: (Opcional) para crear una etiqueta personalizada, escriba un valor en el campo de texto y pulse Entrar. Puede ver la etiqueta debajo del campo de texto de las etiquetas. Al guardar este texto, también se crean las etiquetas que acaba de agregar.
Propiedades extendidas: (Opcional) pulse Agregar campo para especificar atributos de metadatos para el diccionario de datos. En la columna Nombre de propiedad, escriba un nombre de propiedad único. En la columna Valor, escriba un valor para asociarlo a la propiedad.
(Opcional) Para cargar una definición de esquema XSD para el diccionario de datos, en el panel Estructura del diccionario de datos, pulse Cargar esquema XML. Vaya al archivo XSD, selecciónelo y pulse Abrir. Se creará un diccionario de datos en función del esquema XML cargado. Es necesario modificar los nombres para mostrar y las descripciones de los elementos en el diccionario de datos. Para ello, seleccione los nombres de los elementos al pulsarlos y editar sus descripciones, nombres para mostrar y otros detalles en los campos del panel derecho.
Para obtener más información sobre los elementos DD calculados, consulte Elementos del diccionario de datos calculados.
Puede omitir cargar el archivo de esquema y crear el diccionario de datos desde cero mediante la interfaz de usuario. Para ello, omita este paso y continúe con los siguientes.
Pulse Siguiente.
En la pantalla Agregar propiedades, agregue los elementos al diccionario de datos. También puede agregar o eliminar elementos y editar sus detalles si ha cargado un esquema para obtener una estructura básica del diccionario de datos.
Puede pulsar los tres puntos del lado derecho de un elemento y agregar un elemento a la estructura del diccionario de datos.
Seleccione Elemento compuesto, Elemento de colección o Elemento primitivo.
A continuación se indican algunas reglas para crear un diccionario de datos:
Para obtener más información sobre los elementos compuestos, de colección y primitivos y sobre trabajar con elementos de diccionario de datos, consulte Asignar elementos del diccionario de datos al esquema XML.
Para obtener información sobre las validaciones en el diccionario de datos, consulte Validaciones del Editor del diccionario de datos.
(Opcional) Después de seleccionar un elemento, en la pestaña Avanzado puede agregar propiedades (atributos). También puede pulsar Agregar campo y ampliar las propiedades de un elemento DD.
(Opcional) Para quitar cualquier elemento, pulse los tres puntos a la derecha de un elemento y seleccione Eliminar.
Al eliminar un elemento compuesto/de colección con nodos secundarios, también se eliminan sus nodos secundarios.
(Opcional) Seleccione un elemento en el panel Estructura del diccionario de datos y en el panel Lista de campos y variables. Cambie o agregue cualquier atributo necesario asociado al elemento.
Pulse Guardar.
Para crear rápidamente uno o más diccionarios de datos con propiedades y elementos similares a otros existentes, puede copiarlos y pegarlos.
Mientras edita o visualiza un diccionario de datos, puede ver qué elementos del diccionario de datos son referidos en qué textos, condiciones, cartas y comunicaciones interactivas.
Realice una de las siguientes acciones para editar el diccionario de datos:
O pulse un diccionario de datos para verlo.
En el diccionario de datos, pulse un elemento simple para seleccionarlo. Los elementos compuestos y de colección no tienen referencias.
Junto con las propiedades Básicas y Avanzadas del elemento, también aparece Contenido prestado.
Pulse Contenido prestado.
La pestaña Contenido prestado aparecerá con lo siguiente: textos, condiciones, cartas y comunicaciones interactivas. Cada uno de estos encabezados también muestra el número de referencias al elemento seleccionado.
Pulse en un encabezado para ver el nombre de los recursos que hacen referencia al elemento.
Para ver el contenido prestado de otro elemento, pulse el elemento.
Para mostrar un recurso que hace referencia al elemento, pulse su nombre. El explorador muestra el recurso, la carta o la comunicación interactiva.
En la página Diccionarios de datos, pulse Seleccionar.
Pulse un diccionario de datos para el que desee descargar datos de prueba y, a continuación, pulse Descargar datos XML de ejemplo.
Pulse Aceptar en el mensaje de alerta. Se descargará un archivo XML.
Abra el archivo XML con el Bloc de notas u otro editor XML. El archivo XML tiene la misma estructura que el diccionario de datos y las cadenas de marcador de posición de los elementos. Reemplace las cadenas de marcador de posición por los datos con los que desea probar una carta.
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<Company>
<Name>string</Name>
<Type>string</Type>
<HeadOfficeAddress>
<Street>string</Street>
<City>string</City>
<State>string</State>
<Zip>string</Zip>
</HeadOfficeAddress>
<SalesOfficeAddress>
<Street>string</Street>
<City>string</City>
<State>string</State>
<Zip>string</Zip>
</SalesOfficeAddress>
<HeadCount>1.0</HeadCount>
<CEO>
<PersonName>
<FirstName>string</FirstName>
<MiddleName>string</MiddleName>
<LastName>string</LastName>
</PersonName>
<DOB>string</DOB>
<CurrAddress>
<Street>string</Street>
<City>string</City>
<State>string</State>
<Zip>string</Zip>
</CurrAddress>
<DOJ>14-04-1973</DOJ>
<Phone>1.0</Phone>
</CEO>
</Company>
En este ejemplo, XML crea espacio para tres valores en un elemento de colección, pero el número de valores se puede aumentar/reducir según sea necesario.
Después de realizar las entradas de datos, puede utilizar este archivo XML cuando previsualice una carta con datos de prueba.
Puede agregar estos datos de prueba con DD (seleccione DD y pulse Cargar datos de prueba y cargar este archivo xml)
Así que después de esto, cuando obtiene una vista previa de la carta normalmente (no personalizada), estos datos XML se utilizan en la carta. También puede pulsar Personalizado y, a continuación, cargar este XML.
Los siguientes ejemplos de código muestran los detalles de implementación del diccionario de datos.
<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns="DCT" targetNamespace="DCT" xmlns:xs="https://www.w3.org/2001/XMLSchema"
elementFormDefault="qualified" attributeFormDefault="unqualified">
<xs:element name="Company">
<xs:complexType>
<xs:sequence>
<xs:element name="Name" type="xs:string"/>
<xs:element name="Type" type="xs:anySimpleType"/>
<xs:element name="HeadOfficeAddress" type="Address"/>
<xs:element name="SalesOfficeAddress" type="Address" minOccurs="0"/>
<xs:element name="HeadCount" type="xs:integer"/>
<xs:element name="CEO" type="Employee"/>
<xs:element name="Workers" type="Employee" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:complexType name="Employee">
<xs:complexContent>
<xs:extension base="Person">
<xs:sequence>
<xs:element name="CurrAddress" type="Address"/>
<xs:element name="DOJ" type="xs:date"/>
<xs:element name="Phone" type="xs:integer"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="Person">
<xs:sequence>
<xs:element name="PersonName" type="Name"/>
<xs:element name="DOB" type="xs:dateTime"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="Name">
<xs:sequence>
<xs:element name="FirstName" type="xs:string"/>
<xs:element name="MiddleName" type="xs:string"/>
<xs:element name="LastName" type="xs:string"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="Address">
<xs:sequence>
<xs:element name="Street" type="xs:string"/>
<xs:element name="City" type="xs:string"/>
<xs:element name="State" type="xs:string"/>
<xs:element name="Zip" type="xs:string"/>
</xs:sequence>
</xs:complexType>
</xs:schema>
La siguiente tabla detalla los atributos comunes asociados a un DDE:
Atributo | Tipo | Descripción |
Nombre | Cadena | Requerido. Nombre del DDE. Debe ser único. |
Nombre de referencia |
Cadena | Requerido. Nombre de referencia único para el DDE que permite referencias al DDE independientes de los cambios en la jerarquía o estructura del diccionario de datos. Los módulos de texto se asignan con este nombre |
displayname | Cadena | Un nombre opcional descriptivo del DDE. |
description | Cadena | Descripción del DDE. |
elementType | Cadena | Requerido. Tipo de DDE: CADENA, NÚMERO, FECHA, Booleano, COMPUESTO, COLECCIÓN. |
elementSubType | Cadena | El subtipo para DDE: ENUM. Solo se permite para el elementType CADENA y NÚMERO. |
Clave | Booleano | Campo booleano que indica si un DDE es un elemento clave. |
Calculado | Booleano | Campo booleano que indica si se calcula un DDE. Un valor DDE calculado es una función de otros valores DDE. De forma predeterminada, se admiten expresiones jsp. |
expression | Cadena | La expresión para el DDE “calculado”. El servicio de evaluación de expresiones enviado de forma predeterminada admite expresiones JSP EL. Puede reemplazar el servicio de expresiones con una implementación personalizada. |
valueSet | Lista | Conjunto de valores permitidos para un DDE de tipo Enum. Por ejemplo, el tipo de cuenta solo puede tener valores (Guardar, Actual). |
extendedProperties | Objeto | Mapa de propiedades personalizadas agregadas al DDE (interfaz de usuario específica o cualquier otra información). |
Requerido | Booleano | El indicador indica que el origen de los datos de instancia correspondientes al diccionario de datos debe contener el valor de este DDE concreto. |
Enlace | BindingElement | Enlace XML o Java del elemento. |
Un diccionario de datos también puede incluir elementos calculados. Un elemento de diccionario de datos calculado siempre está asociado a una expresión. Esta expresión se evalúa para obtener el valor de un elemento de diccionario de datos durante la ejecución. Un valor DDE calculado es una función de otros valores o literales DDE. De forma predeterminada, son compatibles las expresiones de lenguaje de expresión JSP (EL). Las expresiones EL utilizan los caracteres ${ } y las expresiones válidas pueden incluir literales, operadores, variables (referencias de elementos del diccionario de datos) y llamadas a funciones. Al hacer referencia a un elemento de diccionario de datos en la expresión, se utiliza el nombre de referencia del DDE. El nombre de referencia es único para cada elemento de diccionario de datos dentro de un diccionario de datos.
Se puede asociar un DDE PersonFullName calculado con una expresión de concatenación EL como ${PersonFirstName} ${PersonLastName}.
La exportación de un XSD requiere una asignación de datos específica, que se detalla en la siguiente tabla. La columna DDI indica el tipo de valor del DDE disponible en el DDI.
XSD |
Diccionario de datos |
DDI (Tipo de datos del valor de la instancia) |
xs:element of type - Composite Type |
DDE de tipo: COMPUESTO |
java.util.Map |
xs:element where maxOccurs > 1 |
DDE de tipo: COLECCIÓN: |
java.util.List |
Atributo de tipo: xs:id |
DDE de tipo: CADENA |
java.lang.String |
xs:attribute /xs:element of type - xs:string |
DDE de tipo: CADENA |
java.lang.String |
xs:attribute /xs:element of type - xs: boolean |
DDE de tipo: booleano |
java.lang.Boolean |
xs:attribute /xs:element of type - xs:date | DDE de tipo: FECHA | java.lang.String |
xs:attribute /xs:element of type - xs:integer | DDE de tipo: NÚMERO | java.lang.Double |
xs:attribute /xs:element of type - xs:long | DDE de tipo: NÚMERO | java.lang.Double |
xs:attribute /xs:element of type - xs:double | DDE de tipo: NÚMERO | java.lang.Double |
Elemento de tipo enum y baseType - xs:string | DDE de tipo: CADENA subtipo: ENUM valueSet: los valores permitidos para ENUM |
java.lang.String |
Una vez creado un diccionario de datos, puede descargarlo como un archivo de datos de ejemplo XML para crear entradas de texto en él.
En la página Diccionarios de datos, pulse Seleccionar y, a continuación, pulse un diccionario de datos para seleccionarlo.
Seleccione Descargar datos XML de ejemplo.
Pulse Aceptar en el mensaje de alerta.
Administración de correspondencia creará un archivo XML basado en la estructura del diccionario de datos seleccionado y lo descargará en su equipo con el nombre <data-dictionary-name>-SampleData. Ahora puede editar este archivo en un editor de texto o XML para realizar entradas de datos mientras crea una carta.
Si desea enviar la misma carta en distintos idiomas a sus clientes, puede localizar los conjuntos de nombre para mostrar, la descripción y el valor de enumeración de los elementos del diccionario de datos y del propio diccionario de datos.
En la página Diccionarios de datos, pulse Seleccionar y, a continuación, pulse un diccionario de datos para seleccionarlo.
Pulse Descargar datos de localización.
Pulse Aceptar en la alerta. Administración de correspondencia descargará un archivo zip a su equipo con el nombre DataDictionary-<DDname>.zip.
El archivo zip contiene un archivo .properties. Este archivo define el diccionario de datos descargado. El contenido del archivo de propiedades es similar al siguiente:
#Wed May 20 16:06:23 BST 2015
DataDictionary.EmployeeDD.description=
DataDictionary.EmployeeDD.displayName=EmployeeDataDictionary
DataDictionaryElement.name.description=
DataDictionaryElement.name.displayName=name
DataDictionaryElement.person.description=
DataDictionaryElement.person.displayName=person
La estructura del archivo de propiedades define una línea para la descripción y el nombre para mostrar del diccionario de datos y cada elemento del diccionario de datos. Además, el archivo de propiedades define una línea para un valor de enumeración establecido para cada elemento del diccionario de datos. Al igual que un diccionario de datos, el archivo de propiedades correspondiente puede tener varias definiciones de elementos del diccionario de datos. Además, el archivo puede contener las definiciones de uno o varios conjuntos de valores de enumeración.
Para actualizar el archivo .properties en una configuración regional diferente, actualice los valores del nombre para mostrar y de la descripción en el archivo. Cree más instancias del archivo para cada idioma en el que desee localizarlo. Solo se admiten los idiomas francés, alemán, japonés e inglés.
Guarde los diferentes archivos de propiedades actualizadas con los siguientes nombres:
_fr_FR.properties Francés
_de_DE.properties Alemán
_ja_JA.properties Japonés
_en_EN.properties Inglés
Archive el archivo .properties (o los archivos para varias configuraciones regionales) en un único archivo .zip.
En la página Diccionarios de datos, seleccione Más > Cargar datos de localización y seleccione el archivo zip con archivos de propiedades localizados.
Para ver los cambios de localización, cambie la configuración regional del explorador.
El editor de diccionarios de datos aplica las siguientes validaciones al crear o actualizar un diccionario de datos.
Validaciones aplicadas en el nivel del diccionario de datos
Validaciones que se aplican en el nivel de elemento del diccionario de datos.
Puede crear un diccionario de datos a partir de un esquema XML o crearlo mediante la interfaz de usuario del diccionario de datos. Todos los elementos del diccionario de datos (DDE) de un diccionario de datos tienen un campo de enlace XML para almacenar el enlace del DDE a un elemento del esquema XML. El enlace de cada DDE es relativo al DDE principal.
Los siguientes detalles incluyen ejemplos de modelos y ejemplos de código que muestran detalles de implementación para el diccionario de datos.
Un DDE primitivo representa un campo o atributo que es de naturaleza atómica. Los DDE primitivos definidos fuera del ámbito de un tipo complejo (DDE compuesto) o un elemento repetitivo (DDE de colección) se pueden almacenar en cualquier ubicación dentro del esquema XML. La ubicación de los datos correspondientes a un DDE primitivo no depende de la asignación de su DDE principal. El DDE primitivo utiliza la información de asignación del campo Enlace XML para determinar su valor y las asignaciones se traducen en uno de los siguientes:
El siguiente ejemplo muestra un esquema simple.
<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="https://www.w3.org/2001/XMLSchema">
<xs:element name='age' type='integer'/>
<xs:element name='price' type='decimal'/>
</xs:schema>
Elemento Diccionario de datos | Enlace XML predeterminado |
---|---|
edad | /age |
precio | /price |
El enlace no es compatible con los elementos compuestos; si se proporciona, se ignorará. El enlace para todos los DDE secundarios constituyentes de tipo primitivo debe ser absoluto. Al permitir la asignación absoluta para elementos secundarios de un DDE compuesto, se proporciona más flexibilidad en términos de enlace XPath. La asignación de un DDE compuesto a un elemento de tipo complejo en el esquema XML limita el ámbito de enlace para sus elementos secundarios.
El siguiente ejemplo muestra el esquema de una nota.
<xs:element name="note">
<xs:complexType>
<xs:sequence>
<xs:element name="to" type="xs:string"/>
<xs:element name="from" type="xs:string"/>
<xs:element name="heading" type="xs:string"/>
<xs:element name="body" type="xs:string"/>
</xs:sequence>
</xs:complexType>
</xs:element>
Elemento Diccionario de datos | Enlace XML predeterminado |
nota | vacío (nulo) |
hasta | /note/to |
de | /note/from |
encabezado | /note/heading |
cuerpo | /note/body |
Un elemento de colección solo está asignado a otro elemento de colección que tiene una cardinalidad > 1. Los DDE secundarios de un DDE de colección tienen un enlace XML relativo (local) con respecto al enlace XML principal. Dado que los DDE secundarios de un elemento de colección deben tener la misma cardinalidad que la del elemento principal, el enlace relativo debe garantizar la restricción de la cardinalidad para que los DDE secundarios no apunten a un elemento de esquema XML no repetitivo. En el siguiente ejemplo, la cardinalidad de “TokenID” debe ser la misma que “Tokens”, que es su DDE de recopilación principal.
Al asignar un DDE de colección a un elemento de esquema XML:
el enlace para el DDE correspondiente al elemento Colección debe ser el XPath absoluto
No proporcione ningún enlace para el DDE que represente el tipo de elemento de Colección. Si se proporciona, se ignorará el enlace.
El enlace para todos los DDE secundarios del elemento Colección debe ser relativo al elemento principal.
El esquema XML siguiente declara un elemento con el nombre Tokens y un atributo maxOccurs de "ilimitado". Por lo tanto, Tokens es un elemento de colección.
<?xml version="1.0" encoding="utf-8"?>
<Root>
<Tokens>
<TokenID>string</TokenID>
<TokenText>
<TextHeading>string</TextHeading>
<TextBody>string</TextBody>
</TokenText>
</Tokens>
<Tokens>
<TokenID>string</TokenID>
<TokenText>
<TextHeading>string</TextHeading>
<TextBody>string</TextBody>
</TokenText>
</Tokens>
<Tokens>
<TokenID>string</TokenID>
<TokenText>
<TextHeading>string</TextHeading>
<TextBody>string</TextBody>
</TokenText>
</Tokens>
</Root>
El Token.xsd asociado a este ejemplo sería:
<xs:element name="Root">
<xs:complexType>
<xs:sequence>
<xs:element name="Tokens" type="TokenType" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:complexType name="TokenType">
<xs:sequence>
<xs:element name="TokenID" type="xs:string"/>
<xs:element name="TokenText">
<xs:complexType>
<xs:sequence>
<xs:element name="TextHeading" type="xs:string"/>
<xs:element name="TextBody" type="xs:string"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
Elemento Diccionario de datos | Enlace XML predeterminado |
---|---|
Raíz | vacío (nulo) |
Tokens | /Root/Tokens |
Compuesto | vacío (nulo) |
TokenID | TokenID |
TokenText | vacío (nulo) |
TokenHeading | TokenText/TextHeading |
TokenBody | TokenText/TextBody |