Diccionario de datos data-dictionary

Introducción introduction

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.

Administración de correspondencia utiliza los datos del back end, del cliente o 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.

Flujo de trabajo del diccionario de datos data-dictionary-workflow

  1. Un autor crea el diccionario de datos al cargar un esquema o desde cero.
  2. El autor crea cartas y comunicaciones interactivas basadas en el diccionario de datos y asociará sus elementos en cartas y comunicaciones interactivas siempre que sea necesario.
  3. Un autor puede descargar un archivo XML de datos de ejemplo, que se basa en el esquema de un diccionario de datos. El autor puede modificar el archivo XML de datos de ejemplo, que puede asociarse como datos de prueba con el diccionario de datos. Lo mismo se utiliza durante la vista previa de la carta.
  4. Mientras previsualiza una carta, un autor elige previsualizar la carta con datos (vista previa personalizada). La carta se abrirá rellenada con los datos proporcionados por el autor. Se abrirá en la interfaz de Crear correspondencia. El agente que previsualiza esta carta puede modificar el contenido, los datos y los archivos adjuntos y puede enviar la carta final. Para obtener más información sobre la creación de cartas, consulte Crear correspondencia.

Requisitos previos prerequisite

Instale el Paquete de compatibilidad para ver la opción Diccionarios de datos en la página de Forms.

Crear un diccionario de datos createdatadictionary

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.

NOTE
Para varias cartas que requieran elementos similares, puede crear un diccionario de datos común. Sin embargo, un diccionario de datos de gran tamaño 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.
  1. Seleccione Forms > Diccionarios de datos.

  2. Seleccione Crear diccionario de datos.

  3. En la pantalla Propiedades, agregue lo siguiente:

    • Título: (Opcional) escriba el título del diccionario de datos. Los títulos no tienen que ser únicos, y pueden contener caracteres especiales y caracteres que no sean de inglés. 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) Seleccione 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.

    Propiedades del diccionario de datos especificadas en alemán

  4. (Opcional) Para cargar una definición de esquema XSD para el diccionario de datos, en el panel Estructura del diccionario de datos, seleccione Cargar esquema XML. Busque el archivo XSD, selecciónelo y seleccione 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.

    note note
    NOTE
    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.
  5. Seleccione Siguiente.

  6. 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 seleccionar los tres puntos del lado derecho de un elemento y agregar un elemento a la estructura del diccionario de datos.

    1_2_createanelement

    Seleccione Elemento compuesto, Elemento de colección o Elemento primitivo.

    • 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.
    • Los DDE primitivos son elementos como cadenas, números, fechas y valores booleanos que contienen información como un nombre de ciudad.
    • 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.

    A continuación se indican algunas reglas para crear un diccionario de datos:

    • Solo se permite el tipo compuesto como DDE de nivel superior en un diccionario de datos.
    • El nombre, el nombre de referencia y el tipo de elemento son campos obligatorios para un diccionario de datos y DDE.
    • El nombre de referencia debe ser único.
    • Un DDE principal (compuesto) no puede tener dos elementos secundarios con el mismo nombre.
    • Enum solo contiene tipos de cadena primitivos.

    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.

    2_addddpropertiesbasic

  7. (Opcional) Después de seleccionar un elemento, en la pestaña Avanzado puede agregar propiedades (atributos). También puede seleccionar Agregar campo y ampliar las propiedades de un elemento DD.

    3_addddpropertiesadvanced

  8. (Opcional) Para quitar cualquier elemento, pulse los tres puntos a la derecha de un elemento y seleccione Eliminar.

    4_deleteelement

    note note
    NOTE
    Al eliminar un elemento compuesto/de colección con nodos secundarios, también se eliminan sus nodos secundarios.
  9. (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.

  10. Seleccione Guardar.

Crear copias de uno o varios diccionarios de datos create-copies-of-one-or-more-data-dictionary

Para crear rápidamente uno o más diccionarios de datos con propiedades y elementos similares a otros existentes, puede copiarlos y pegarlos.

  1. En la lista de diccionarios de datos, seleccione los diccionarios de datos correspondientes. La interfaz de usuario muestra el icono Copiar.
  2. Seleccione Copiar. La interfaz de usuario muestra el icono Pegar.
  3. Seleccione Pegar. Aparecerá el cuadro de diálogo Pegar. El sistema asignará automáticamente nombres y títulos a los nuevos diccionarios de datos.
  4. Si es necesario, edite el Título y el Nombre con los que desea guardar la copia del diccionario de datos.
  5. Seleccione Pegar. Se creará una copia del diccionario de datos. Ahora puede realizar los cambios necesarios en el diccionario de datos recién creado.

Consulte los fragmentos del documento o documentos que hacen referencia a un elemento del diccionario de datos see-the-document-fragments-or-documents-that-refer-to-a-data-dictionary-element

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.

  1. Realice una de las siguientes acciones para editar el diccionario de datos:

    • Pase el ratón sobre un diccionario de datos y seleccione Editar.
    • Seleccione un diccionario de datos y, a continuación, seleccione Editar en el encabezado.
    • Pase el ratón sobre un diccionario de datos y seleccione Seleccionar. A continuación, seleccione Edit en el encabezado.

    O bien, seleccione un diccionario de datos para verlo.

  2. En el diccionario de datos, seleccione 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.

  3. Seleccione 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.

  4. Seleccione un encabezado para ver el nombre de los recursos que hacen referencia al elemento.

    lentcontent

  5. Para ver el contenido prestado de otro elemento, seleccione el elemento.

  6. Para mostrar un recurso que hace referencia al elemento, seleccione en su nombre. El explorador muestra el recurso, la carta o la comunicación interactiva.

Trabajar con datos de prueba working-with-test-data

  1. En la página Diccionarios de datos, seleccione Seleccionar.

  2. Seleccione un diccionario de datos para el que desee descargar datos de prueba y, a continuación, seleccione Descargar datos XML de ejemplo.

  3. Seleccione Aceptar en el mensaje de alerta. Se descargará un archivo XML.

  4. 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.

    code language-xml
    <?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>
    
    note note
    NOTE
    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.
  5. 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 Cargar datos de prueba y cargar este archivo xml)
    Después de esto, cuando previsualiza la carta normalmente (no personalizada), estos datos XML se utilizan en la carta. También puede seleccionar Personalizado y, a continuación, cargar este XML.

Ejemplos samples

Los siguientes ejemplos de código muestran los detalles de implementación del diccionario de datos.

Esquema de ejemplo que se puede cargar en el diccionario de datos sample-schema-that-can-be-uploaded-to-the-data-dictionary

<?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>

Atributos comunes asociados a un DDE common-attributes-associated-with-a-dde

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.

Elementos de diccionario de datos calculados computedddelements

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}.

Asignar tipos de datos entre XSD y el diccionario de datos data-type-mapping-between-xsd-and-data-dictionary-br

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:
se crea un nodo DDE junto al DDE de COLECCIÓN que captura información del nodo COLECCIÓN principal. Lo mismo se crea para ambas colecciones de tipos de datos simples/compuestos. Siempre que tenga una COLECCIÓN del tipo compuesto, el árbol del diccionario de datos capturará los campos constitutivos en los elementos secundarios del DDE creados para capturar información de tipo.
: DDE (COLECCIÓN)
: DDE (COMPUESTO para información de tipo)
: DDE (CADENA) field1
: DDE (CADENA) field2
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

Descargar un archivo de datos de ejemplo desde un diccionario de datos download-a-sample-data-file-from-a-data-dictionary

Una vez creado un diccionario de datos, puede descargarlo como un archivo de datos de ejemplo XML para crear entradas de texto en él.

  1. En la página Diccionarios de datos, seleccione Seleccionar y, a continuación, seleccione un diccionario de datos para seleccionarlo.

  2. Seleccione Descargar datos XML de ejemplo.

  3. Seleccione 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.

Internacionalizar metadatos internationalization-of-meta-data

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.

Localizar un diccionario de datos localize-data-dictionary

  1. En la página Diccionarios de datos, seleccione Seleccionar y, a continuación, seleccione un diccionario de datos para seleccionarlo.

  2. Seleccione Descargar datos de localización.

  3. Seleccione Aceptar en la alerta. Administración de correspondencia descargará un archivo zip a su equipo con el nombre DataDictionary-<DDname>.zip.

  4. 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:

    code language-ini
    #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.

  5. 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.

  6. 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

  7. Archive el archivo .properties (o los archivos para varias configuraciones regionales) en un único archivo .zip.

  8. 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.

  9. Para ver los cambios de localización, cambie la configuración regional del explorador.

Validaciones del diccionario de datos ddvalidations

El editor de diccionarios de datos aplica las siguientes validaciones al crear o actualizar un diccionario de datos.

  • Solo se permite el tipo compuesto como DDE de nivel superior en un diccionario de datos.
  • Los elementos compuestos y de colección no están permitidos a nivel de hoja. Solo se permiten elementos primitivos (cadena, fecha, número, booleano) en el nivel de hoja. Esta validación garantiza que no haya ningún elemento compuesto y de colección sin un DDE secundario.
  • Cuando se carga un archivo XSD para crear un diccionario de datos, el editor de diccionarios de datos solicita un elemento de nivel superior, si existen varios, para crear el diccionario de datos.
  • El nombre es el único parámetro necesario para un diccionario de datos.
  • Un DDE principal (compuesto) no puede tener dos elementos secundarios con el mismo nombre
  • Garantiza que un DDE se marque como calculado, solo si no es un parámetro requerido. No se puede calcular un elemento requerido y no se puede requerir un elemento calculado. Además, el elemento de colección y el elemento compuesto no pueden ser elementos calculados.
  • Garantiza que se marque un DDE como obligatorio, solo cuando no esté calculado. También garantiza que no sea el “collectionElement” el que indica el tipo de Colección (que es el único elemento secundario de un elemento de colección).
  • Las claves vacías o duplicadas no están permitidas en ExtendedProperties para un diccionario de datos o DDE.
  • No utilice los caracteres dos puntos (:) o barra vertical (|) dentro de la clave o del valor de una propiedad extendida. No hay validación para el uso de estos caracteres prohibidos.

Validaciones aplicadas en el nivel del diccionario de datos

  • El nombre del diccionario de datos no debe ser nulo.
  • El nombre del diccionario de datos solo debe contener caracteres alfanuméricos.
  • La lista de elementos secundarios del diccionario de datos no debe ser nula ni estar vacía.
  • El diccionario de datos no debe contener más de un elemento del diccionario de datos de nivel superior.
  • Solo se permite el tipo compuesto como un DDE de nivel superior en un diccionario de datos.

Validaciones que se aplican en el nivel de elemento del diccionario de datos.

  • Todos los nombres de DDE no deben ser nulos y no deben contener espacios.
  • Todos los DDE deben tener un tipo de elemento “no nulo/no nulo”.
  • Todos los nombres de referencia de DDE no deben ser nulos.
  • Todos los nombres de referencia de DDE deben ser únicos.
  • Toda referencia de DDE solo debe contener caracteres alfanuméricos y “_”.
  • Todos los nombres para mostrar DDE solo deben contener caracteres alfanuméricos y “_”.
  • Los elementos compuestos y de colección no están permitidos a nivel de hoja. Solo se permiten elementos primitivos (cadena, fecha, número, booleano) en el nivel de hoja. Esta validación garantiza que no haya ningún elemento compuesto y de colección sin un DDE secundario.
  • Un DDE principal compuesto no debe tener dos elementos secundarios con el mismo nombre.
  • El subtipo ENUM solo se utiliza para los elementos Cadena y Número.
  • Los elementos de colección y compuestos no se pueden calcular.
  • Un DDE no puede ser a la vez calculado y requerido.
  • Los DDE calculados deben contener una expresión válida.
  • Los DDE calculados no deben tener enlaces XML.
  • Un DDE que indica el tipo de un DDE de colección no puede ser calculado ni requerido.
  • Los DDE de subtipo ENUM no deben contener conjuntos de valores nulos o vacíos.
  • El enlace XML de un DDE de colección no debe asignarse a un atributo.
  • La sintaxis de enlace XML debe ser válida, como, por ejemplo, si solo aparece una @, solo se permitirá la @ cuando vaya seguida de un nombre de atributo.

Asignar elementos del diccionario de datos al esquema XML mappingddetoschema

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.

Asignar elementos simples (primitivos) mapping-simple-primitive-elements

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:

  • un atributo
  • un elemento
  • un contexto de texto
  • nada (un DDE ignorado)

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

Asignar elementos compuestos mapping-composite-elements

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

Asignar elementos de colección mapping-collection-elements

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 siguiente esquema XML 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
recommendation-more-help
19ffd973-7af2-44d0-84b5-d547b0dffee2