Data Dictionary data-dictionary

Select Forms > Data Dictionaries.

Select Create Data Dictionary.

In the Properties screen, add the following:

• Title: (Optional) Enter the title for the data dictionary. Title do not need to be unique and can have special characters and non-english characters. Letters and other document fragments are referred with their title (when available), such as in thumbnails and asset properties. Data dictionaries are referenced with their names and not titles.

• Name: The unique name for the data dictionary. In the Name field, you can enter only English language characters, numbers, and hyphens. The Name field is automatically populated based on the Title field and the special characters, spaces, numbers, and non-English characters entered in the Title field are replaced with hyphens. Although the value in the Title field is automatically copied to the Name, you can edit the value.

• Description: (Optional) Description of the data dictionary.

• Tags: (Optional) To create custom tag, enter value in text field and press Enter. You can see your tag below text field of tags. When you save this text, the newly added tags also get created.

• Extended Properties: (Optional) Select Add Field to specify metadata attributes for your data dictionary. In the Property Name column, enter a unique property name. In the Value column, enter a value to associate with the property.

(Optional) To upload an XSD schema definition for your data dictionary, under the Data Dictionary Structure pane, select Upload XML Schema. Browse to XSD file, select it, and select Open. A Data Dictionary gets created based on the uploaded XML schema. You need to tweak display names and descriptions of the elements in the data dictionary. To do this, select the names of the elements by tapping them and edit their descriptions, display names, and other details in the fields in the right pane.

For more information on Computed DD Elements, see Computed Data Dictionary Elements.

Select Next.

In the Add Properties screen, add the elements to the data dictionary. You can also add/delete elements and edit their details if you have uploaded a schema to get a basic structure of the data dictionary.

You can select the three dots on the right side of an element and add an element to the data dictionary structure.

Select either Composite Element, Collection Element, or Primitive Element.

• A Composite DDE contains other DDEs, which can be of type primitive, composite, or collection. For example, an address, which consists of a street address, city, province, country, and postal code.
• Primitive DDEs are elements such as strings, numbers, dates, and Boolean values that hold information such as a city name.
• A Collection is a list of similar Simple or Composite DDEs. For example, a customer with multiple locations, or different billing and shipping addresses.

Following are some rules for creating a data dictionary:

• Only composite type is allowed as top-level DDE in a data dictionary.
• Name, reference name, and element type are mandatory fields for a data dictionary and DDEs.
• The reference name must be unique.
• A parent DDE (composite) cannot have two children with the same name.
• Enums only contain primitive String types.

For more information on Composite, Collection, and Primitive elements and working with data dictionary elements, see Mapping Data Dictionary Elements to XML Schema.

For information on validations in Data Dictionary, see Data Dictionary Editor validations.

(Optional) After selecting an element, in the Advanced tab you can add properties (attributes). You can also select Add Field and extend the properties of a DD element.

(Optional) You can remove any element by tapping the three dots on the right side of an element and selecting Delete.

(Optional) Select an element in the Data Dictionary Structure pane, and in the Field and Variable List panel. Change, or add any required attributes associated to the element.

Select Save.

Do one of the following to edit the data dictionary:

• Hover over a data dictionary and select Edit.
• Select a data dictionary and then select Edit in the header.
• Hover over a data dictionary and select Select. Then select Edit in the header.

Or select on a data dictionary to view it.

In the data dictionary, select a simple element to select it. Composite and collection elements do not have references.

Along with Basic and Advanced properties of the element, Lent Content also appears.

Select Lent Content.

The Lent Content tab appears with the following: Texts, Conditions, Letters, and Interactive Communications. Each of these headings also displays the number of references to the selected element.

Select a heading to see the name of the assets that refer to the element.

To view lent content for another element, select the element.

To display an asset that refers to the element, select on its name. The browser displays the asset, letter, or Interactive Communication.

On the Data Dictionaries page, select Select.

Select a data dictionary for which you want to download test data and then select Download Sample XML Data.

Select OK in the alert message. An XML file gets downloaded.

Open the XML file with Notepad or another XML editor. The XML file has the same structure as the data dictionary and placeholder strings in the elements. Replace the placeholder strings with the data you want to test a letter with.

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

After making the data entries, you can use this XML file when you are previewing a letter with test data.

You can add this test data with DD (Select DD and select Upload Test Data and upload this xml file)
So after this when you preview letter normally (not custom), then this XML data is used in letter. You can also select Custom and then upload this XML.

In the Data Dictionaries page, select Select and then select a data dictionary to select it.

Select Download Sample XML Data.

Select OK in the alert message.

Correspondence Management creates an XML file based on the selected data dictionary’s structure and downloads it to your computer with the name <data-dictionary-name>-SampleData. Now you can edit this file in an XML or text editor to make data entries while creating a letter.

On the Data Dictionaries page, select Select and then select a data dictionary to select it.

Select Download Localization Data.

Select OK in the alert. Correspondence Management downloads a zip file to your computer with the name DataDictionary-<DDname>.zip.

The Zip file contains a .properties file. This file defines the downloaded data dictionary. The contents of the property file are similar to the following:

#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

The structure of the properties file defines one line each for the description and the display name for the data dictionary and each data dictionary element in the data dictionary. In addition, the properties file defines one line for an enum value set for each data dictionary element. As with a data dictionary, the corresponding properties file can have multiple data dictionary elements definitions. In addition, the file can contain the definitions for one or more enum value sets.

To update the .properties file in a different locale, update the display name and description values in the file. Create more instances of the file for each language you want to localize in. Only French, German, Japanese, and English languages are supported.

Save the different updated properties files with the following names:

_fr_FR.properties French

_de_DE.properties German

_ja_JA.properties Japanese

_en_EN.properties English

Archive the .properties file (or files for multiple locales) into a single .zip file.

In the Data Dictionaries page, select More > Upload Localization Data and select the zip file with localized properties files.

To view the localization changes, change your browser locale.