Un dizionario dati consente agli utenti aziendali di utilizzare informazioni provenienti da origini dati back-end senza conoscere dettagli tecnici sui modelli di dati sottostanti. Un dizionario dati è composto da elementi del dizionario dati (DDE). Questi elementi dati vengono utilizzati per integrare i dati back-end nelle lettere come input da utilizzare nella corrispondenza con i clienti.
Un dizionario dati è una rappresentazione indipendente dei metadati che descrive le strutture di dati sottostanti e i relativi attributi associati. Un dizionario dati viene creato utilizzando il vocabolario aziendale. Può essere mappato a uno o più modelli di dati sottostanti.
Il dizionario dati è costituito da elementi di tre tipi: elementi semplici, compositi e di raccolta. I DDE semplici sono elementi primitivi quali stringhe, numeri, date e valori booleani che contengono informazioni quali il nome di una città. Un DDE composito contiene altri DDE, che possono essere di tipo primitivo, composito o raccolta. Ad esempio, un indirizzo, costituito da un indirizzo stradale, città, provincia, paese e codice postale. Una raccolta è un elenco di DDE semplici o compositi simili. Ad esempio, un cliente con più ubicazioni o diversi indirizzi di fatturazione e spedizione.
Gestione della corrispondenza utilizza i dati back-end, specifici del cliente o del destinatario memorizzati in base alla struttura del dizionario dati per creare corrispondenza destinata a clienti diversi. Ad esempio, è possibile creare un documento con nomi descrittivi, ad esempio "Gentile {First Name}","Sig. {Last Name}".
In genere, gli utenti aziendali non devono conoscere le rappresentazioni di metadati come XSD (XML Schema) e le classi Java. Tuttavia, in genere richiedono l’accesso a tali strutture di dati e attributi per creare soluzioni.
Installare Pacchetto di compatibilità per visualizzare Dizionari dati opzione sul Forms pagina.
Utilizza l’Editor del dizionario dati per creare un dizionario dati oppure puoi caricare un file di schema XSD per creare un dizionario dati basato su questo. Puoi quindi estendere il dizionario dati aggiungendo ulteriori informazioni richieste, inclusi i campi. Indipendentemente da come è stato creato il dizionario dati, il proprietario del processo aziendale non ha bisogno di conoscere i sistemi back-end. Il proprietario del processo aziendale richiede solo la conoscenza degli oggetti del dominio e delle relative definizioni per il processo.
Per più lettere che richiedono elementi simili, puoi creare un dizionario dati comune. Un dizionario dati di grandi dimensioni con un numero elevato di elementi può tuttavia causare problemi di prestazioni quando si utilizza il dizionario dati e si caricano gli elementi, ad esempio in lettere e frammenti di documento. In caso di problemi di prestazioni, provare a creare dizionari dati separati per lettere diverse.
Seleziona Forms > Dizionari dati.
Seleziona Crea dizionario dati.
Nella schermata Proprietà, aggiungi quanto segue:
Titolo: (Facoltativo) Immetti il titolo del dizionario dati. Il titolo non deve necessariamente essere univoco e può contenere caratteri speciali e non inglesi. Alle lettere e agli altri frammenti di documento viene fatto riferimento con il relativo titolo (se disponibile), ad esempio nelle proprietà delle miniature e delle risorse. I dizionari dati sono indicati con i relativi nomi e non con i titoli.
Nome: Nome univoco del dizionario dati. Nel campo Nome è possibile immettere solo caratteri, numeri e trattini in lingua inglese. Il campo Nome viene compilato automaticamente in base al campo Titolo e i caratteri speciali, gli spazi, i numeri e i caratteri non inglesi immessi nel campo Titolo vengono sostituiti da trattini. Anche se il valore nel campo Titolo viene copiato automaticamente nel Nome, è possibile modificarlo.
Descrizione: (facoltativo) descrizione del dizionario dati.
Tag: (Facoltativo) Per creare un tag personalizzato, immetti il valore nel campo di testo e premi Invio. Puoi visualizzare il tag sotto il campo di testo dei tag. Quando salvi questo testo, vengono creati anche i nuovi tag aggiunti.
Proprietà estese: (Facoltativo) Seleziona Aggiungi campo per specificare gli attributi dei metadati per il dizionario dati. Nella colonna Nome proprietà immettere un nome di proprietà univoco. Nella colonna Valore immettere un valore da associare alla proprietà.
(Facoltativo) Per caricare una definizione dello schema XSD per il dizionario dati, nel riquadro Data Dictionary Structure, seleziona Carica schema XML. Individua il file XSD, selezionalo e seleziona Apri. Un dizionario dati viene creato in base allo schema XML caricato. È necessario modificare i nomi visualizzati e le descrizioni degli elementi nel dizionario dati. A questo scopo, seleziona i nomi degli elementi toccandoli e modificane le descrizioni, i nomi visualizzati e altri dettagli nei campi del riquadro a destra.
Per ulteriori informazioni sugli elementi DD calcolati, consulta Elementi dizionario dati calcolati.
Puoi saltare il caricamento del file dello schema e creare il dizionario dati da zero utilizzando l’interfaccia utente di. Per eseguire questa operazione, salta questo passaggio e continua con i passaggi successivi.
Seleziona Avanti.
Nella schermata Aggiungi proprietà, aggiungi gli elementi al dizionario dati. Puoi anche aggiungere/eliminare elementi e modificarne i dettagli, se hai caricato uno schema per ottenere una struttura di base del dizionario dati.
Puoi selezionare i tre punti a destra di un elemento e aggiungere un elemento alla struttura del dizionario dati.
Selezionare Elemento composito, Elemento di raccolta o Elemento primitivo.
Di seguito sono riportate alcune regole per la creazione di un dizionario dati:
Per ulteriori informazioni sugli elementi compositi, di raccolta e primitivi e sull’utilizzo degli elementi del dizionario dati, consulta Mappatura degli elementi del dizionario dati allo schema XML.
Per informazioni sulle convalide nel dizionario dati, vedi Convalide dell’editor del dizionario dati.
(Facoltativo) Dopo aver selezionato un elemento, nella scheda Avanzate puoi aggiungere proprietà (attributi). Puoi anche selezionare Aggiungi campo ed estendere le proprietà di un elemento DD.
(Facoltativo) Per rimuovere un elemento, tocca i tre punti sul lato destro di un elemento e seleziona Elimina.
Se si elimina un elemento composito o di raccolta con nodi figlio, verranno eliminati anche i relativi nodi figlio.
(Facoltativo) Seleziona un elemento nel riquadro Struttura del dizionario dati e nel pannello Elenco campi e variabili. Modifica o aggiungi eventuali attributi obbligatori associati all’elemento.
Seleziona Salva.
Per creare rapidamente uno o più dizionari dati con proprietà ed elementi simili a quelli dei dizionari dati esistenti, è possibile copiarli e incollarli.
Durante la modifica o la visualizzazione di un dizionario dati, è possibile vedere a quali elementi del dizionario dati fanno riferimento testi, condizioni, lettere e comunicazioni interattive.
Per modificare il dizionario dati, effettuare una delle seguenti operazioni:
Oppure seleziona un dizionario dati per visualizzarlo.
Nel dizionario dati, seleziona un elemento semplice per selezionarlo. Gli elementi compositi e di raccolta non dispongono di riferimenti.
Insieme alle proprietà di base e avanzate dell’elemento, viene visualizzato anche Contenuto prestato.
Seleziona Contenuto prestato.
Viene visualizzata la scheda Contenuto prestato con le informazioni seguenti: Testi, Condizioni, Lettere e Comunicazioni interattive. Ognuna di queste intestazioni visualizza anche il numero di riferimenti all’elemento selezionato.
Seleziona un’intestazione per visualizzare il nome delle risorse che fanno riferimento all’elemento.
Per visualizzare il contenuto prestato per un altro elemento, selezionare l'elemento.
Per visualizzare una risorsa che fa riferimento all’elemento, selezionane il nome. Il browser visualizza la risorsa, la lettera o la comunicazione interattiva.
Nella pagina Dizionari di dati, seleziona Seleziona.
Seleziona un dizionario dati per il quale vuoi scaricare i dati di test, quindi fai clic su Scarica dati XML di esempio.
Seleziona OK nel messaggio di avviso. Viene scaricato un file XML.
Aprire il file XML con il Blocco note o un altro editor XML. Il file XML ha la stessa struttura del dizionario dati e delle stringhe segnaposto negli elementi. Sostituire le stringhe segnaposto con i dati con cui si desidera verificare una lettera.
<?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>
In questo esempio, il codice XML crea spazio per tre valori in un elemento di raccolta, ma il numero di valori può essere aumentato o diminuito in base al requisito.
Dopo aver inserito i dati, è possibile utilizzare questo file XML quando si visualizza l'anteprima di una lettera con i dati di test.
Puoi aggiungere questi dati di test con DD (seleziona DD e seleziona Carica dati di test e carica questo file xml). Dopo questa operazione, quando visualizzi l’anteprima della lettera normalmente (non personalizzata), questi dati XML vengono utilizzati nella lettera. Puoi anche selezionare Personalizzato e quindi caricare questo XML.
Gli esempi di codice seguenti mostrano i dettagli di implementazione per il dizionario dati.
<?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 tabella seguente descrive gli attributi comuni associati a un DDE:
Attributo | Tipo | Descrizione |
Nome | Stringa | Obbligatorio. Nome del DDE. Deve essere univoco. |
Riferimento Nome |
Stringa | Obbligatorio. Nome di riferimento univoco per il DDE che consente riferimenti al DDE indipendenti dalle modifiche apportate alla gerarchia o alla struttura del dizionario dati. I moduli di testo sono mappati con questo nome |
displayname | Stringa | Nome descrittivo facoltativo del DDE. |
descrizione | Stringa | Descrizione del DDE. |
elementType | Stringa | Obbligatorio. Il tipo di DDE: STRING, NUMBER, DATE, Boolean, COMPOSITE, COLLECTION. |
elementSubType | Stringa | Il sottotipo per DDE: ENUM. Consentito solo per STRING e NUMBER elementType. |
Chiave | Booleano | Un campo booleano per indicare se un DDE è un elemento chiave. |
Calcolati | Booleano | Campo booleano per indicare se viene calcolato un DDE. Un valore DDE calcolato è una funzione di altri valori DDE. Per impostazione predefinita, sono supportate le espressioni jsp. |
espressione | Stringa | Espressione per il DDE "calcolato". Il servizio di valutazione delle espressioni fornito per impostazione predefinita supporta le espressioni JSP EL. Puoi sostituire il servizio di espressioni con un’implementazione personalizzata. |
valueSet | Elenco | Set di valori consentiti per un DDE di tipo Enum. Ad esempio, il tipo di conto può avere solo valori (Salvataggio, Corrente). |
extendedProperties | Oggetto | Una mappa delle proprietà personalizzate aggiunte al DDE (specifiche dell’interfaccia utente o altre informazioni). |
Obbligatorio | Booleano | Il flag indica che l’origine dei dati dell’istanza corrispondenti al dizionario dati deve contenere il valore di questo particolare DDE. |
Associazione | BindingElement | Associazione XML o Java dell'elemento. |
Un dizionario dati può includere anche elementi calcolati. Un elemento dizionario dati calcolato è sempre associato a un’espressione. Questa espressione viene valutata per ottenere il valore di un elemento del dizionario dati in fase di esecuzione. Un valore DDE calcolato è una funzione di altri valori o valori letterali DDE. Per impostazione predefinita, sono supportate le espressioni EL (JSP Expression Language). Le espressioni EL utilizzano i caratteri ${ } e le espressioni valide possono includere valori letterali, operatori, variabili (riferimenti agli elementi del dizionario dati) e chiamate di funzione. Quando si fa riferimento a un elemento del dizionario dati nell’espressione, viene utilizzato il nome di riferimento del DDE. Il nome di riferimento è univoco per ogni elemento del dizionario dati all’interno di un dizionario dati.
È possibile associare un valore DDE PersonFullName calcolato a un'espressione di concatenazione EL come ${PersonFirstName} ${PersonLastName}.
L’esportazione di un XSD richiede una mappatura dei dati specifica, descritta nella tabella seguente. La colonna DDI indica il tipo di valore DDE disponibile nell'unità DDI.
XSD |
Dizionario dati |
DDI (Instance Value Data Type) |
xs:element of type - Composite Type |
DDE di tipo - COMPOSITE |
java.util.Map |
xs:element dove maxOccurs > 1 |
DDE di tipo - COLLECTION- Accanto al DDE COLLECTION viene creato un nodo DDE che acquisisce informazioni dal nodo COLLECTION padre. Lo stesso viene creato per entrambe le raccolte di tipi di dati semplici/compositi. Ogni volta che si dispone di una COLLECTION del tipo composito, la struttura del dizionario dati acquisisce i campi costitutivi negli elementi figlio del DDE creato per acquisire informazioni sul tipo. - DDE (RACCOLTA) - DDE(COMPOSITE per informazioni sul tipo) - Campo DDE(STRING) 1 - Campo DDE(STRING) 2 |
java.util.List |
Attributo di tipo - xs:id |
DDE di tipo - STRING |
java.lang.String |
xs:attribute /xs:element di tipo - xs:string | DDE di tipo - STRING |
java.lang.String |
xs:attribute /xs:element di tipo - xs: booleano |
DDE di tipo - Booleano |
java.lang.Boolean |
xs:attribute /xs:elemento di tipo - xs:date | DDE di tipo - DATE | java.lang.String |
xs:attribute /xs:element di tipo - xs:integer | DDE di tipo - NUMBER | java.lang.Double |
xs:attribute /xs:element di tipo - xs:long | DDE di tipo - NUMBER | java.lang.Double |
xs:attribute /xs:element di tipo - xs:double | DDE di tipo - NUMBER | java.lang.Double |
Elemento di tipo enum e baseType - xs:string | DDE di type - STRING subtype - ENUM valueSet: i valori consentiti per ENUM |
java.lang.String |
Dopo aver creato un dizionario dati, è possibile scaricarlo come file di dati di esempio XML per inserire voci di testo.
Nella pagina Dizionari di dati, seleziona Seleziona quindi selezionare un dizionario dati.
Seleziona Scarica dati XML di esempio.
Seleziona OK nel messaggio di avviso.
Gestione corrispondenza crea un file XML basato sulla struttura del dizionario dati selezionato e lo scarica nel computer con il nome <data-dictionary-name>-SampleData. Ora è possibile modificare questo file in un editor XML o di testo per effettuare immissioni di dati mentre creazione lettera.
Quando desideri inviare ai clienti la stessa lettera in lingue diverse, puoi localizzare i set di valori nome visualizzato, descrizione ed enum degli elementi del dizionario dati e del dizionario dati.
Nella pagina Dizionari di dati, seleziona Seleziona quindi selezionare un dizionario dati.
Seleziona Scarica dati di localizzazione.
Seleziona OK nell'avviso. Gestione corrispondenza scarica un file zip sul computer con il nome DataDictionary-<ddname>.zip.
Il file ZIP contiene un file con estensione properties. Questo file definisce il dizionario dati scaricato. Il contenuto del file delle proprietà è simile al seguente:
#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 struttura del file delle proprietà definisce una riga per la descrizione e il nome visualizzato per il dizionario dati e per ogni elemento del dizionario dati nel dizionario dati. Inoltre, il file delle proprietà definisce una riga per un valore enum impostato per ciascun elemento del dizionario dati. Come per un dizionario dati, il file delle proprietà corrispondente può avere più definizioni di elementi del dizionario dati. Inoltre, il file può contenere le definizioni per uno o più set di valori enum.
Per aggiornare il file con estensione properties in una lingua diversa, aggiornare il nome visualizzato e i valori della descrizione nel file. Crea più istanze del file per ogni lingua che desideri localizzare in. Sono supportate solo le lingue francese, tedesco, giapponese e inglese.
Salva i diversi file di proprietà aggiornati con i seguenti nomi:
_fr_FR.properties Francese
_de_DE.properties Tedesco
_ja_JA.properties Giapponese
_en_EN.properties Inglese
Archivia il file con estensione properties (o i file per più lingue) in un unico file con estensione zip.
Nella pagina Dizionari di dati, seleziona Altro > Carica dati di localizzazione e seleziona il file zip con i file delle proprietà localizzate.
Per visualizzare le modifiche di localizzazione, modifica le impostazioni internazionali del browser.
Durante la creazione o l’aggiornamento di un dizionario dati, l’Editor del dizionario dati applica le seguenti convalide.
Convalide applicate a livello del dizionario dati
Convalide applicate a livello dell’elemento del dizionario dati.
È possibile creare un dizionario dati da uno schema XML o generarlo utilizzando l’interfaccia utente del dizionario dati. Tutti gli elementi del dizionario dati (DDE) all’interno di un dizionario dati dispongono di un campo di associazione XML per memorizzare l’associazione del DDE a un elemento nello schema XML. L'associazione in ogni DDE è relativa al DDE padre.
Di seguito sono riportati alcuni modelli di esempio ed esempi di codice che mostrano i dettagli di implementazione per il dizionario dati.
Un DDE primitivo rappresenta un campo o un attributo di natura atomica. I DDE primitivi definiti al di fuori dell'ambito di un tipo complesso (DDE composito) o di un elemento ripetuto (DDE di raccolta) possono essere memorizzati in qualsiasi posizione all'interno dello schema XML. La posizione dei dati corrispondenti a un DDE primitivo non dipende dalla mappatura del relativo DDE padre. DDE primitivo utilizza le informazioni di mapping del campo di associazione XML per determinarne il valore e i mapping si traducono in uno dei seguenti elementi:
L’esempio seguente mostra uno schema semplice.
<?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 dizionario dati | Associazione XML predefinita |
---|---|
età | /age |
prezzo | /price |
L'associazione non è supportata per gli elementi compositi. Se viene specificata l'associazione, questa verrà ignorata. Il binding di tutti i DDE figli di tipo primitivo deve essere assoluto. Consentendo la mappatura assoluta per gli elementi figlio di un DDE composito si ottiene una maggiore flessibilità in termini di binding XPath. La mappatura di un DDE composito a un elemento di tipo complesso nello schema XML limita l'ambito dell'associazione per i relativi elementi figlio.
Nell'esempio seguente viene illustrato lo schema di 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 dizionario dati | Associazione XML predefinita |
nota | empty(null) |
a | /note/to |
da | /note/from |
intestazione | /note/header |
corpo | /note/body |
Un elemento di raccolta è mappato solo a un altro elemento di raccolta con cardinalità > 1. I DDE figlio di un insieme DDE dispongono di un'associazione XML relativa (locale) rispetto all'associazione XML padre. Poiché i DDE figlio di un elemento di raccolta devono avere la stessa cardinalità di quella dell'elemento padre, l'associazione relativa è obbligatoria per garantire il vincolo di cardinalità in modo che i DDE figlio non puntino a un elemento schema XML non ripetuto. Nell’esempio seguente, la cardinalità di "TokenID" deve essere uguale a "Tokens", che è il DDE della raccolta principale.
Quando si esegue il mapping di un DDE della raccolta a un elemento dello schema XML:
l'associazione per il DDE corrispondente all'elemento Collection deve essere XPath assoluto
Non fornire alcuna associazione per il DDE che rappresenta il tipo di elemento Collection. Se fornito, il binding verrà ignorato.
L'associazione per tutti i DDE figlio dell'elemento Collection deve essere relativa all'elemento Collection padre.
Lo schema XML riportato di seguito dichiara un elemento con il nome Tokens e l'attributo maxOccurs "unbounded". Pertanto, Tokens è un elemento di raccolta.
<?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>
Il Token.xsd associato a questo esempio è:
<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 dizionario dati | Associazione XML predefinita |
---|---|
Directory principale | empty(null) |
Token | /Root/Tokens |
Composito | empty(null) |
TokenID | TokenID |
TokenText | empty(null) |
TokenHeading | TokenText/TextHeading |
TokenBody | TokenText/TextBody |