数据字典

简介

数据字典使商业用户能够使用来自后端数据源的信息，而无需了解其基础数据模型的技术详细信息。 数据字典由数据字典元素(DDE)组成。 您可以使用这些数据元素将后端数据集成到字母中作为输入，以用于客户通信中。

数据字典是描述基础数据结构及其关联属性的元数据的独立表示形式。 使用业务词汇创建数据字典。 它可以映射到一个或多个基础数据模型。

数据字典由三种类型的元素组成：“简单”、“合成”和“集合”元素。 简单DDE是基元元素，如字符串、数字、日期和布尔值，它们包含城市名称等信息。 复合DDE包含其他DDE，它们的类型可以是简单、复合或集合。 例如，一个地址，由街道地址、城市、省、国家和邮政编码组成。 集合是类似简单或复合DDE的列表。 例如，具有多个位置或不同账单和送货地址的客户。

Corresponce Management使用后端、客户、 或根据数据字典的结构存储的收件人特定数据来创建针对不同客户的通信。 例如，可以使用友好名称创建文档，如"尊敬的{First Name}","Mr. {姓氏}".

通常，企业用户不需要掌握元数据表示法(如XSD(XML模式)和Java类)的知识。 但是，要构建解决方案，他们通常需要访问这些数据结构和属性。

数据字典工作流

1. 作者通过上传模式或从头开始创建数据字典。
2. 作者根据数据字典创建字母和交互式通信，并根据需要将字母和交互式通信中的数据字典元素关联起来。
3. 作者可以下载基于数据字典模式的示例数据XML文件。 作者可以修改样本数据XML文件，该文件可以作为测试数据与数据字典相关联。 在字母预览时也会使用相同内容。
4. 在预览字母时，作者选择将字母预览为数据(自定义预览)。 此时将打开该字母，其中预填充了作者提供的数据。 这将在创建对应界面中打开。 正在预览此信函的代理可以修改此信函中的内容、数据和附件，并可提交最终的信函。 有关创建字母的详细信息，请参阅创建通信。

先决条件

安装兼容性包以视图​Forms​页上的​数据字典​选项。

创建数据字典

您可以使用数据字典编辑器创建数据字典，也可以上传XSD模式文件以创建基于该数据字典。 然后，您可以通过添加更多必填信息（包括字段）来扩展数据字典。 无论数据字典是如何创建的，业务流程所有者都不需要有关后端系统的知识。 业务流程所有者只需要对域对象及其定义的知识，才能对其流程进行操作。

1. 选择​Forms > 数据字典。

2. 点按​创建数据字典。

3. 在“属性”屏幕中，添加以下内容：

   • 标题： （可选）输入数据字典的标题。标题不需要唯一，可以有特殊字符和非英文字符。 字母和其他文档片段与其标题（如果可用）一起引用，例如在缩略图和资产属性中。 数据字典引用的是其名称而非标题。

   • 名称： 数据字典的唯一名称。在“名称”字段中，您只能输入英语字符、数字和连字符。 “名称”字段会根据“标题”字段自动填充，在“标题”字段中输入的特殊字符、空格、数字和非英语字符将替换为连字符。 尽管“标题”字段中的值会自动复制到“名称”中，但您可以编辑该值。

   • 描述:（可选）数据字典的说明。

   • 标记： （可选）要创建自定义标记，请在文本字段中输入值，然后按Enter。您可以在标记文本字段下方看到标记。 保存此文本时，还会创建新添加的标记。

   • 扩展属性:（可选）点按 添 加字段以指定数据字典的元数据属性。在“属性名称”列中，输入唯一的属性名称。 在“值”列中，输入要与属性关联的值。

   

4. （可选）要上传数据字典的XSD模式定义，请点按​上传XML模式。 浏览到XSD文件，将其选中，然后点按​打开。 根据上传的XML模式创建数据字典。 您需要调整数据字典中元素的显示名称和说明。 为此，请点按元素名称，然后在右侧窗格的字段中编辑元素的说明、显示名称和其他详细信息。

   有关“计算DD元素”的详细信息，请参阅计算数据字典元素。

   注意

   您可以使用用户界面跳过上传模式文件并从头开始构建数据字典。 为此，请跳过此步骤并继续执行后续步骤。

5. 点按​下一步。

6. 在“添加属性”屏幕中，将元素添加到数据字典。 如果已上传模式以获取数据字典的基本结构，则还可以添加/删除元素并编辑其详细信息。

   您可以点按元素右侧的三个点，并向数据字典结构中添加一个元素。

   

   选择复合元素、集合元素或基元元素。

   • 复合DDE包含其他DDE，它们的类型可以是简单、复合或集合。 例如，一个地址，由街道地址、城市、省、国家和邮政编码组成。
   • 基元DDE是字符串、数字、日期和布尔值等元素，它们包含城市名称等信息。
   • 集合是类似简单或复合DDE的列表。 例如，具有多个位置或不同账单和送货地址的客户。

   以下是创建数据字典的一些规则：

   • 在数据字典中，仅允许将复合类型作为顶级DDE。
   • 名称、引用名称和元素类型是数据字典和DDE的必填字段。
   • 引用名称必须唯一。
   • 父DDE（复合）不能有两个同名的子项。
   • enums仅包含基元字符串类型。

   有关复合、集合和基元元素以及使用数据字典元素的详细信息，请参阅将数据字典元素映射到XML模式。

   有关数据字典中验证的信息，请参阅数据字典编辑器验证。

   

7. （可选）选择元素后，在高级选项卡中，可以添加属性（属性）。 您还可以点按​添加字段​并扩展DD元素的属性。

   

8. （可选）通过点按元素右侧的三个圆点并选择​删除，可删除任何元素。

   

   注意

   删除包含子节点的复合/集合元素也会删除其子节点。

9. （可选）在“数据字典结构”窗格和“字段和变量”列表面板中选择元素。 更改或添加与元素关联的任何必需属性。

10. 点按​保存。

创建一个或多个数据字典的副本

要快速创建一个或多个数据字典，并使用与现有数据字典相似的属性和元素，您可以复制并粘贴它们。

1. 从列表数据字典中，选择适当的数据字典。 UI会显示复制图标。
2. 点按复制。UI会显示粘贴图标。
3. 点按粘贴。 此时将显示“粘贴”对话框。 系统自动将名称和标题分配给新的数据字典。
4. 如果需要，请编辑要用其保存数据字典副本的标题和名称。
5. 点按粘贴。 将创建数据字典的副本。 现在，您可以在新创建的数据字典中进行所需的更改。

请参阅引用Data Dictionary元素的文档片段或文档

在编辑或查看数据字典时，您可以看到数据字典中引用了哪些元素，其中包括文本、条件、字母和交互通信。

1. 执行以下操作之一以编辑数据字典：

   • 将鼠标悬停在数据字典上，然后点按编辑。
   • 选择数据字典，然后点按标题中的编辑。
   • 将鼠标悬停在数据字典上，然后点按选择。 然后点按标题中的编辑。

   或点击数据字典以视图它。

2. 在数据字典中，点按一个简单元素以将其选中。 合成元素和集合元素没有引用。

   除了元素的“基本”和“高级”属性之外，还会显示“借出内容”。

3. 点按借出内容。

   此时将显示“借出的内容”选项卡，其中包含以下内容：文本、条件、信件和交互式通信。 每个标题还显示对所选元素的引用数。

4. 点按标题以查看引用元素的资产名称。

   

5. 要视图为其他元素借出的内容，请点按该元素。

6. 要显示引用元素的资产，请点按其名称。 浏览器会显示资产、信函或交互式通信。

使用测试数据

1. 在“数据字典”页上，点按​选择。

2. 点按要为其下载测试数据的数据字典，然后点按​下载示例XML数据。

3. 点按警报消息中的​确定。 将下载一个XML文件。

4. 使用记事本或其他XML编辑器打开XML文件。 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>
   

   注意

   在此示例中，XML为集合元素的三个值创建空间，但值的数量可以根据要求增加/减少。

5. 创建数据条目后，在预览包含测试数据的字母时，可以使用此XML文件。

   您可以使用DD添加此测试数据（选择DD，然后点按上传测试数据并上传此xml文件）

   因此，在此之后，当您正常预览字母（非自定义）时，此XML数据将用在字母中。 您也可以点按“自定义”，然后上传此XML。

示例

以下代码示例显示数据字典的实施详细信息。

可上载到数据字典的示例模式

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

与DDE关联的常用属性

下表详细列出了与DDE关联的常用属性：

计算数据字典元素

数据字典也可以包括计算元素。 计算数据字典元素始终与表达式关联。 计算此表达式以在运行时获得数据字典元素的值。 计算的DDE值是其他DDE值或文本的函数。 默认情况下，支持JSP表达式语言(EL)表达式。 EL表达式使用${ }字符，有效表达式可以包括文本、运算符、变量（数据字典元素引用）和函数调用。 在表达式中引用数据字典元素时，将使用DDE的引用名称。 引用名称对于数据字典中的每个数据字典元素都是唯一的。

计算的DDE PersonFullName可以与EL连接表达式（如${PersonFirstName} ${PersonLastName}）关联。

XSD与数据字典之间的数据类型映射

导出XSD需要特定的数据映射，下表中详细介绍了该映射。 DDI列指示DDI中可用的DDE值的类型。

从数据字典下载示例数据文件

创建数据字典后，可以将其下载为XML示例数据文件以在其中生成文本条目。

1. 在“数据字典”页中，点按​选择，然后点按数据字典以选择它。

2. 选择​下载示例XML数据。

3. 点按警报消息中的​确定。

   Correspondence Management根据所选数据字典的结构创建XML文件，并将其下载到名为<data-dictionary-name>-SampleData的计算机。 现在，您可以在XML或文本编辑器中编辑此文件，以便在创建字母时进行数据条目。

元数据的国际化

如果要向客户发送同一个不同语言的字母，则可以本地化数据字典和数据字典元素的显示名称、说明和枚举值集。

本地化数据字典

1. 在“数据字典”页上，点按​选择，然后点按数据字典以选择它。

2. 点按​下载本地化数据。

3. 点按警报中的​确定。 Corresponce Management将名为DataDictionary-<Dname>.zip的zip文件下载到您的计算机。

4. Zip文件包含一个.properties文件。 此文件定义下载的数据字典。 属性文件的内容类似于：

   #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
   

   属性文件的结构为每个描述和数据字典以及数据字典中每个数据字典元素的显示名称定义一行。 此外，属性文件为每个数据字典元素的枚举值集定义一行。 与数据字典一样，相应的属性文件可以具有多个数据字典元素定义。 此外，该文件可包含一个或多个枚举值集的定义。

5. 要在其他区域设置中更新.properties文件，请更新文件中的显示名称和说明值。 为要本地化的每种语言创建更多文件实例。 仅支持法语、德语、日语和英语。

6. 使用以下名称保存不同的已更新属性文件：

   _fr_FR.properties法语

   _de_DE.properties德语

   _ja_JA.properties日文

   _en_EN.properties英语

7. 将.properties文件（或多个区域设置的文件）存档到单个.zip文件中。

8. 在“本地化字典”页中，选择​更多 > 上载数据，然后选择包含本地化属性文件的zip文件。

9. 要视图本地化更改，请更改浏览器区域设置。

数据字典验证

在创建或更新数据字典时，数据字典编辑器强制执行以下验证。

• 在数据字典中，仅允许将复合类型作为顶级元素。
• 不允许在叶级别使用复合元素和集合元素。 叶级别只允许使用基元（字符串、日期、数字、布尔）元素。 此验证可确保没有没有子DDE的合成和集合元素。
• 在上传XSD文件以创建数据字典时，数据字典编辑器提示输入顶级元素（如果存在多个元素）以创建数据字典。
• 名称是数据字典的唯一必需参数。
• 父DDE（复合）不能有两个同名的子项
• 确保只有在DDE不是必需参数时，才对其进行标记。 不能计算必需元素，也不能需要计算元素。 此外，集合和合成元素不能是计算元素。
• 确保只有在不计算DDE时才标记为必需。 它还确保它不是表示“集合”类型的“collectionElement”（即集合元素的唯一子项）。
• 数据字典或DDE的extendedProperties中不允许空键或重复键。
• 请勿在扩展属性的键或值中使用冒号(:)或垂直条(|)字符。 使用这些禁止的字符时没有验证。

在数据字典级别应用的验证

• 数据字典名称不能为null。
• 数据字典名称只能包含字母数字字符。
• 数据字典中的子元素列表不得为null或空。
• 数据字典不得包含多个顶级数据字典元素。
• 在数据字典中，仅允许将复合类型作为顶级元素。

在数据字典元素级别应用的验证。

• 所有DDE名称不能为null，也不能包含空格。
• 所有DDE都必须具有“not null/non null”元素类型。
• 所有DDE引用名称不得为null。
• 所有DDE引用名称必须唯一。
• 所有DDE引用只能包含字母数字字符和“_”。
• 所有DDE显示名称只能包含字母数字字符和“_”。
• 不允许在叶级别使用复合元素和集合元素。 叶级别只允许使用基元（字符串、日期、数字、布尔）元素。 此验证可确保没有没有子DDE的合成和集合元素。
• 复合父DDE不能有两个同名的子元素。
• ENUM子类型仅用于字符串和数字元素。
• 无法计算集合和合成元素。
• DDE不能同时计算和要求。
• 计算的DDE必须包含有效的表达式。
• 计算的DDE不能具有XML绑定。
• 不能计算或要求表示集合DDE类型的DDE。
• 子类型ENUM的DDE不得包含空值集或空值集。
• 集合DDE的XML绑定不能映射到属性。
• XML绑定语法必须有效，例如，只显示一个@，只有在后面跟有属性名称时才允许使用@。

将数据字典元素映射到XML模式

您可以从XML模式创建数据字典，也可以使用数据字典用户界面构建它。 数据字典中的所有数据字典元素(DDE)都有一个“XML绑定”字段，用于将DDE绑定存储到XML模式中的元素。 每个DDE中的绑定相对于父DDE。

以下详细信息示例模型和代码示例，它们显示数据字典的实施详细信息。

映射简单（基本）元素

基元DDE表示一个在性质上是原子的字段或属性。 在复杂类型（复合DDE）或重复元素（集合DDE）的范围外定义的基元DDE可以存储在XML模式中的任何位置。 与基元DDE对应的数据的位置不取决于其父DDE的映射。 Primitive DDE使用“XML绑定”字段中的映射信息确定其值，并且映射转换为以下任一内容：

• 属性
• 元素
• 文本上下文
• nothing（忽略的DDE）

以下示例展示了一个简单的模式。

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

映射复合元素

复合元素不支持绑定，如果提供绑定，则忽略它。 所有原始类型的组成子DDE的绑定必须是绝对的。 允许对复合DDE的子元素进行绝对映射在XPath绑定方面提供了更大的灵活性。 将复合DDE映射到XML模式中的复杂类型元素会限制其子元素的绑定范围。

以下示例显示了注释的模式。

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

映射集合元素

集合元素仅映射到基数> 1的其他集合元素。 集合DDE的子DDE具有与其父XML绑定相关的相对（本地）XML绑定。 由于集合元素的子DDE必须与父元素的子DDE具有相同的基数，因此要求相对绑定以确保基数约束，以便子DDE不指向非重复的XML模式元素。 在以下示例中，“TokenID”的基数必须与“Tokens”相同，后者是其父集合DDE。

将集合DDE映射到XML模式元素时：

• 与Collection元素对应的DDE的绑定必须是绝对XPath

• 不为表示Collection元素类型的DDE提供绑定。 如果提供，则将忽略绑定。

• Collection元素的所有子DDE的绑定必须相对于父Collection元素。

下面的XML模式声明一个名为Tokens的元素，并且maxOccurs属性为“unbounded”。 因此，令牌是一个集合元素。

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

与此示例关联的Token.xsd为：

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