Um dicionário de dados permite que os usuários corporativos usem informações de fontes de dados back-end sem conhecer detalhes técnicos sobre seus modelos de dados subjacentes. Um dicionário de dados é composto de elementos de dicionário de dados (DDEs). Esses elementos de dados são usados para integrar dados back-end às letras como entrada para uso em uma correspondência do cliente.
Um dicionário de dados é uma representação independente de metadados que descreve as estruturas de dados subjacentes e seus atributos associados. Um dicionário de dados é criado usando o vocabulário comercial. Ele pode ser mapeado para um ou mais modelos de dados subjacentes.
O dicionário de dados é composto de elementos de três tipos: Elementos simples, compostos e coleção. DDEs simples são elementos primitivos, como sequências de caracteres, números, datas e valores booleanos que contêm informações como um nome de cidade. Um DDE composto contém outros DDEs, que podem ser do tipo primitivo, composto ou coleção. Por exemplo, um endereço, que consiste em um endereço, cidade, província, país e código postal. Uma coleção é uma lista de DDEs simples ou compostos semelhantes. Por exemplo, um cliente com vários locais ou endereços de faturamento e envio diferentes.
O Gerenciamento de correspondência usa os dados back-end, cliente,
ou específicos do recipient armazenados de acordo com a estrutura do dicionário de dados para criar correspondência destinada a clientes diferentes. Por exemplo, um documento pode ser criado com nomes amigáveis, como "Prezado(a) {Nome(a)}","Sr. {Sobrenome}".
Normalmente, os usuários corporativos não exigem conhecimento de representações de metadados, como XSD (schema XML) e classes Java. No entanto, eles geralmente exigem acesso a essas estruturas de dados e atributos para criar soluções.
Instale o Pacote de compatibilidade para visualização da opção Dicionários de dados na página Forms.
Use o Editor de dicionário de dados para criar um dicionário de dados ou faça upload de um arquivo de schema XSD para criar um dicionário de dados baseado nele. Você pode estender o dicionário de dados adicionando mais informações necessárias, incluindo campos. Independentemente de como o dicionário de dados foi criado, o proprietário do processo de negócios não precisa de conhecimento dos sistemas de back-end. O proprietário do processo de negócios só precisa de conhecimento dos objetos do domínio, e suas definições, para o seu processo.
Para várias letras que exigem elementos semelhantes, é possível criar um dicionário de dados comum. Entretanto, um grande dicionário de dados com um grande número de elementos pode causar problemas de desempenho ao usar o dicionário de dados e carregar os elementos, como em letras e fragmentos de documento. Se tiver problemas de desempenho, tente criar dicionários de dados separados para letras diferentes.
Selecione Forms > Dicionários de dados.
Toque em Criar dicionário de dados.
Na tela Propriedades, adicione o seguinte:
Título: (Opcional) Insira o título do dicionário de dados. O título não precisa ser exclusivo e pode ter caracteres especiais e caracteres diferentes do inglês. Letras e outros fragmentos de documento são referenciados com seu título (quando disponíveis), como em miniaturas e propriedades de ativos. Os dicionários de dados são referenciados com seus nomes e não com títulos.
Nome: o nome exclusivo do dicionário de dados. No campo Nome, é possível digitar somente caracteres, números e hífens do idioma inglês. O campo Nome é automaticamente preenchido com base no campo Título e os caracteres especiais, espaços, números e caracteres que não sejam em inglês inseridos no campo Título são substituídos por hífens. Embora o valor no campo Título seja copiado automaticamente para o Nome, é possível editar o valor.
Descrição: (Opcional) Descrição do dicionário de dados.
Tags: (Opcional) Para criar uma tag personalizada, insira o valor no campo de texto e pressione Enter. Você pode ver sua tag abaixo do campo de texto das tags. Quando você salva esse texto, as tags recém-adicionadas também são criadas.
Propriedades estendidas: (Opcional) Toque em Adicionar campo para especificar os atributos de metadados para o dicionário de dados. Na coluna Nome da propriedade, digite um nome de propriedade exclusivo. Na coluna Valor, insira um valor a ser associado à propriedade.
(Opcional) Para carregar uma definição de schema XSD para seu dicionário de dados, no painel Estrutura do dicionário de dados, toque em Carregar Schema XML. Navegue até o arquivo XSD, selecione-o e toque em Abrir. Um Dicionário de dados é criado com base no schema XML carregado. É necessário ajustar os nomes de exibição e as descrições dos elementos no dicionário de dados. Para fazer isso, selecione os nomes dos elementos tocando neles e edite suas descrições, nomes de exibição e outros detalhes nos campos no painel direito.
Para obter mais informações sobre Elementos de dados calculados, consulte Elementos de dicionário de dados calculados.
Você pode ignorar o upload do arquivo de schema e criar o dicionário de dados do zero usando a interface do usuário. Para fazer isso, pule esta etapa e continue com as próximas etapas.
Toque em Next.
Na tela Adicionar propriedades, adicione os elementos ao dicionário de dados. Você também pode adicionar/excluir elementos e editar seus detalhes se tiver carregado um schema para obter uma estrutura básica do dicionário de dados.
Você pode tocar nos três pontos no lado direito de um elemento e adicionar um elemento à estrutura do dicionário de dados.
Selecione Elemento composto, Elemento de coleção ou Elemento primitivo.
Veja a seguir algumas regras para criar um dicionário de dados:
Para obter mais informações sobre elementos Compostos, Coleção e Primitivos e como trabalhar com elementos do dicionário de dados, consulte Mapeamento de elementos do dicionário de dados para o Schema XML.
Para obter informações sobre validações no Dicionário de dados, consulte Validações do Editor de dicionários de dados.
(Opcional) Após selecionar um elemento, na guia Avançado, é possível adicionar propriedades (atributos). Você também pode tocar em Adicionar campo e estender as propriedades de um elemento DD.
(Opcional) Você pode remover qualquer elemento tocando nos três pontos no lado direito de um elemento e selecionando Excluir.
A exclusão de um elemento composto/coleção com nós filhos também exclui os nós filhos.
(Opcional) Selecione um elemento no painel Estrutura do dicionário de dados e no painel Lista Campo e variável. Altere ou adicione quaisquer atributos necessários associados ao elemento.
Toque em Salvar.
Para criar rapidamente um ou mais dicionários de dados com propriedades e elementos semelhantes aos dicionários de dados existentes, é possível copiá-los e colá-los.
Ao editar ou exibir um dicionário de dados, você pode ver quais elementos no dicionário de dados são referenciados em quais Textos, Condições, Cartas e Comunicações interativas.
Execute um dos procedimentos a seguir para editar o dicionário de dados:
Ou toque em um dicionário de dados para visualização-lo.
No dicionário de dados, toque em um elemento simples para selecioná-lo. Os elementos de composição e coleção não têm referências.
Junto com as propriedades Básicas e Avançadas do elemento, o Conteúdo emprestado também é exibido.
Toque em Conteúdo emprestado.
A guia Conteúdo emprestado é exibida com o seguinte: Textos, condições, letras e comunicações interativas. Cada um desses cabeçalhos também exibe o número de referências ao elemento selecionado.
Toque em um cabeçalho para ver o nome dos ativos que se referem ao elemento.
Para visualização de conteúdo emprestado para outro elemento, toque no elemento.
Para exibir um ativo que se refere ao elemento, toque em seu nome. O navegador exibe o ativo, a letra ou a Comunicação interativa.
Na página Dicionários de dados, toque em Selecionar.
Toque em um dicionário de dados para o qual deseja baixar dados de teste e toque em Baixar dados XML de amostra.
Toque em OK na mensagem de alerta. Um arquivo XML é baixado.
Abra o arquivo XML com o Bloco de notas ou outro editor XML. O arquivo XML tem a mesma estrutura que o dicionário de dados e as strings de espaço reservado nos elementos. Substitua as strings de espaço reservado pelos dados com os quais você deseja testar uma letra.
<?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>
Neste exemplo, o XML cria espaço para três valores para um elemento de coleção, mas o número de valores pode ser aumentado/diminuído de acordo com o requisito.
Depois de fazer as entradas de dados, você pode usar esse arquivo XML ao visualizar uma carta com dados de teste.
Você pode adicionar esses dados de teste com DD (selecione DD e toque em Fazer upload de dados de teste e fazer upload desse arquivo xml)
Assim, depois disso, quando você pré-visualização a carta normalmente (não personalizada), esses dados XML são usados em carta. Você também pode tocar em Personalizado e fazer upload desse XML.
As amostras de código a seguir mostram detalhes de implementação do Dicionário de dados.
<?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>
A tabela a seguir detalha os atributos comuns associados a um DDE:
Atributo | Tipo | Descrição |
Nome | Sequência de caracteres | Obrigatório. Nome do DDE. Deve ser único. |
Nome da referência |
Sequência de caracteres | Obrigatório. Nome de referência exclusiva para o DDE, permitindo referências ao DDE que não dependem de alterações na hierarquia ou estrutura do dicionário de dados. Os módulos de texto são mapeados usando esse nome |
display name | Sequência de caracteres | Um nome opcional fácil de usar do DDE. |
descrição | Sequência de caracteres | Descrição do DDE. |
elementType | Sequência de caracteres | Obrigatório. O tipo de DDE: STRING, NUMBER, DATE, Booleano, COMPOSTO, COLEÇÃO. |
elementSubType | Sequência de caracteres | O subtipo para DDE: ENUM. Somente permitido para STRING e NUMBER elementType. |
Chave | Booleano | Um campo Booliano para indicar se um DDE é um elemento chave. |
Computado | Booleano | Um campo Booliano para indicar se um DDE é calculado. Um valor DDE calculado é uma função de outros valores DDE. Por padrão, as expressões jsp são suportadas. |
expressão | Sequência de caracteres | A expressão do DDE "calculado". O serviço de avaliação de expressão fornecido por padrão é compatível com expressões JSP EL. Você pode substituir o serviço de expressão por uma implementação personalizada. |
valueSet | Lista | Um conjunto de valores permitidos para um tipo Enum DDE. Por exemplo, o tipo de conta pode ter apenas valores (Salvar, Atual). |
ExtendedProperties | Objeto | Um mapa de propriedades personalizadas adicionado ao DDE (interface do usuário específica ou qualquer outra informação). |
Obrigatório | Booleano | O sinalizador indica que a fonte de dados de instância correspondente ao dicionário de dados deve conter o valor desse DDE específico. |
Vínculo | BindingElement | O vínculo XML ou Java do elemento. |
Um dicionário de dados também pode incluir elementos calculados. Um elemento de dicionário de dados calculado está sempre associado a uma expressão. Essa expressão é avaliada para obter o valor de um elemento de dicionário de dados em tempo de execução. Um valor DDE calculado é uma função de outros valores DDE ou literais. Por padrão, as expressões de Linguagem de Expressão JSP (EL) são suportadas. As expressões EL usam os caracteres ${ } e expressões válidas podem incluir literais, operadores, variáveis (referências de elementos de dicionário de dados) e chamadas de função. Ao referenciar um elemento de dicionário de dados na expressão, o nome de referência do DDE é usado. O nome de referência é exclusivo para cada elemento do dicionário de dados em um dicionário de dados.
Um DDE PersonFullName calculado pode ser associado a uma expressão de concatenação EL, como ${PersonFirstName} ${PersonLastName}.
A exportação de um XSD requer mapeamento de dados específicos, que é detalhado na tabela a seguir. A coluna DDI indica o tipo do valor DDE, conforme disponível no DDI.
XSD |
Dicionário de dados |
DDI (Tipo de Dados de Valor de Instância) |
xs:elemento do tipo - Tipo composto |
DDE do tipo - COMPOSITE |
java.util.Map |
xs:element onde maxOcorre > 1 |
DDE do tipo - COLLECTION- |
java.util.List |
Atributo do tipo - xs:id |
DDE do tipo - STRING |
java.lang.String |
xs:attribute /xs:elemento do tipo - xs:string |
DDE do tipo - STRING |
java.lang.String |
xs:attribute /xs:elemento do tipo - xs: booleano |
DDE do tipo - Boolean |
java.lang.Boolean |
xs:attribute /xs:elemento do tipo - xs:date | DDE do tipo - DATA | java.lang.String |
xs:attribute /xs:elemento do tipo - xs:integer | DDE do tipo - NUMBER | java.lang.Double |
xs:attribute /xs:elemento do tipo - xs:long | DDE do tipo - NUMBER | java.lang.Double |
xs:attribute /xs:elemento do tipo - xs:duplo | DDE do tipo - NUMBER | java.lang.Double |
Elemento do tipo enum e baseType - xs:string | DDE de type - STRING subtype - ENUM valueSet - os valores permitidos para ENUM |
java.lang.String |
Depois de criar um dicionário de dados, é possível baixá-lo como um arquivo de dados de amostra XML para fazer entradas de texto nele.
Na página Dicionários de dados, toque em Selecionar e em um dicionário de dados para selecioná-lo.
Selecione Baixar dados XML de amostra.
Toque em OK na mensagem de alerta.
O Gerenciamento de correspondência cria um arquivo XML com base na estrutura do dicionário de dados selecionado e o baixa no computador com o nome <data-dictionary-name>-SampleData. Agora você pode editar esse arquivo em um editor de texto ou XML para fazer entradas de dados ao criar uma carta.
Quando quiser enviar a mesma carta em idiomas diferentes para seus clientes, localize o nome de exibição, a descrição e os conjuntos de valores enum do Dicionário de dados e dos Elementos do dicionário de dados.
Na página Dicionários de dados, toque em Selecionar e, em seguida, toque em um dicionário de dados para selecioná-lo.
Toque em Baixar dados de Localização.
Toque em OK no alerta. O Gerenciamento de correspondência baixa um arquivo zip em seu computador com o nome DataDictionary-<Nome>.zip.
O arquivo Zip contém um arquivo .properties. Esse arquivo define o dicionário de dados baixado. O conteúdo do arquivo de propriedade é semelhante ao seguinte:
#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
A estrutura do arquivo de propriedades define uma linha cada para a descrição e o nome de exibição para o dicionário de dados e cada elemento do dicionário de dados no dicionário de dados. Além disso, o arquivo de propriedades define uma linha para um valor enum definido para cada elemento do dicionário de dados. Como ocorre com um dicionário de dados, o arquivo de propriedades correspondente pode ter várias definições de elementos do dicionário de dados. Além disso, o arquivo pode conter as definições de um ou mais conjuntos de valores enum.
Para atualizar o arquivo .properties em uma localidade diferente, atualize o nome de exibição e os valores de descrição no arquivo. Crie mais instâncias do arquivo para cada idioma no qual você deseja localizar. Somente os idiomas francês, alemão, japonês e inglês são suportados.
Salve os diferentes arquivos de propriedades atualizados com os seguintes nomes:
_fr_FR.properties Francês
_de_DE.properties Alemão
_ja_JA.properties Japonês
_en_EN.properties Inglês
Arquive o arquivo .properties (ou arquivos para várias localidades) em um único arquivo .zip.
Na página Dicionários de dados, selecione Mais > Carregar dados de Localização e selecione o arquivo zip com arquivos de propriedades localizados.
Para visualização das alterações de localização, altere a localidade do navegador.
O Editor do dicionário de dados impõe as seguintes validações ao criar ou atualizar um dicionário de dados.
Validações aplicadas no nível do dicionário de dados
Validações que são aplicadas no Nível de elemento do dicionário de dados.
Você pode criar um dicionário de dados a partir de um Schema XML ou criá-lo usando a interface do usuário do Dicionário de dados. Todos os Elementos do dicionário de dados (DDEs) em um dicionário de dados têm um campo Vínculo XML para armazenar o vínculo do DDE a um elemento no schema XML. O vínculo em cada DDE é relativo ao DDE pai.
Os detalhes a seguir mostram exemplos de modelos e exemplos de código que mostram detalhes de implementação do Dicionário de dados.
Um DDE primitivo representa um campo ou atributo que é de natureza atômica. DDEs primitivos definidos fora do escopo de um tipo complexo (DDE composto) ou de um elemento repetitivo (DDE coleção) podem ser armazenados em qualquer local dentro do Schema XML. A localização dos dados correspondentes a um DDE primitivo não depende do mapeamento do DDE pai. O DDE primitivo usa as informações de mapeamento do campo Vínculo XML para determinar seu valor e os mapeamentos são traduzidos em um dos seguintes:
O exemplo a seguir mostra um schema simples.
<?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 do dicionário de dados | Vínculo XML padrão |
---|---|
age | /age |
preço | /preço |
O vínculo não é compatível com elementos Compostos, se o vínculo for fornecido, ele será ignorado. A ligação para todos os DDEs filhos constituintes de tipo primitivo deve ser absoluta. Permitir o mapeamento absoluto de elementos filho de um DDE composto proporciona mais flexibilidade em termos de Vínculo XPath. O mapeamento de um DDE composto para um elemento de tipo complexo no schema XML limita o escopo de vínculo para seus elementos filho.
O exemplo a seguir mostra o schema de uma observação.
<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 do dicionário de dados | Vínculo XML padrão |
nota | empty(null) |
para | /note/to |
de | /note/from |
cabeçalho | /nota/cabeçalho |
corpo | /note/body |
Um elemento de coleção só é mapeado para outro elemento de coleção que tem cardinalidade > 1. Os DDEs filho de uma coleção DDE têm vínculo XML relativo(local) em relação ao vínculo XML do pai. Como os DDEs filhos de um elemento de coleção devem ter a mesma cardinalidade que os pais, a vinculação relativa é obrigatória para garantir a restrição de cardinalidade, de modo que os DDEs filhos não apontem para um elemento de Schema XML não repetitivo. No exemplo abaixo, a cardinalidade de "TokenID" deve ser igual a "Tokens", que é a DDE da coleção pai.
Ao mapear um DDE de coleção para um elemento de Schema XML:
o vínculo para o DDE correspondente ao elemento Collection deve ser o XPath absoluto
Não forneça nenhum vínculo para o DDE que representa o tipo de elemento Collection. Se fornecido, o vínculo será ignorado.
O vínculo para todos os DDEs filhos do elemento Collection deve ser relativo ao elemento Collection pai.
O Schema XML abaixo declara um elemento com o nome Tokens e um atributo maxOccurs de "unbounded". Portanto, Tokens é um elemento de coleção.
<?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>
O Token.xsd associado a esta amostra seria:
<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 do dicionário de dados | Vínculo XML padrão |
---|---|
Raiz | empty(null) |
Tokens | /Raiz/Tokens |
Composto | empty(null) |
TokenID | TokenID |
TokenText | empty(null) |
TokenTitle | TokenText/TextTitle |
TokenBody | TokenText/TextBody |