資料字典 data-dictionary
簡介 introduction
資料字典可讓商務使用者使用來自後端資料來源的資訊，而不需瞭解其基礎資料模型的技術細節。 資料字典是由資料字典元素(DDE)所組成。 您可以使用這些資料元素將後端資料整合到信函中，作為輸入用於客戶通訊。
資料字典是描述基礎資料結構及其關聯屬性的中繼資料的獨立表示法。 資料字典是使用企業辭彙建立的。 可對應至一或多個基礎資料模型。
資料字典由三種型別的元素組成：簡單、複合和集合元素。 簡單DDE是基本元素，例如字串、數字、日期以及布林值，這些元素會包含城市名稱等資訊。 複合DDE包含其他DDE，其型別可以是基本型別、複合型別或集合型別。 例如，由街道地址、城市、省、國家/地區和郵遞區號組成的地址。 集合是類似的簡單或複合DDE清單。 例如，客戶具有多個地點或不同的帳單和運送地址。
「通訊管理」使用根據資料字典結構儲存的後端、客戶或收件者特定資料，來建立針對不同客戶的通訊。 例如，可以使用易記名稱建立檔案，例如「親愛的{名字}」、「先生」。 「{姓氏}」。
一般來說，業務使用者不需要瞭解中繼資料表示法，例如XSD （XML架構）和Java類別。 但是，它們通常需要存取這些資料結構和屬性才能建置解決方案。
資料字典工作流程 data-dictionary-workflow
- 作者藉由上傳結構描述或從頭開始建立資料字典。
- 作者會根據資料字典建立信函和互動式通訊，並視需要聯結信函和互動式通訊中的資料字典元素。
- 作者可以下載以資料字典的結構描述為基礎的範例資料XML檔案。 作者可以修改範例資料XML檔案，該檔案可以與資料字典關聯為測試資料。 字母預覽期間會使用相同的值。
- 在預覽信件時，作者選擇預覽包含資料的信件（自訂預覽）。 信函會開啟，預先填入作者提供的資料。 這會在建立通訊介面中開啟。 預覽此信函的代理程式可以修改此信函的內容、資料及附件，也可以提交最終信函。 如需建立信件的詳細資訊，請參閱建立信件。
必備條件 prerequisite
安裝相容性套件以檢視 Forms 頁面上的 資料字典 選項。
建立資料字典 createdatadictionary
您可以使用資料字典編輯器來建立資料字典，也可以上傳XSD結構描述檔案來據此建立資料字典。 然後，您可以新增更多必要資訊（包括欄位）以擴充資料字典。 無論資料字典的建立方式為何，業務流程擁有者都不需要後端系統的知識。 業務流程擁有者只需要瞭解領域物件及其定義，就能進行流程。
-
選取 Forms > 資料字典。
-
選取 建立資料字典。
-
在「屬性」畫面中，新增下列內容：
-
標題： （選擇性）輸入資料字典的標題。 標題不需要是唯一的，並且可以有特殊字元和非英文字元。 字母和其他檔案片段是以其標題（可用時）來參照，例如在縮圖和資產屬性中。 參考資料字典的名稱而非標題。
-
名稱： 資料字典的唯一名稱。 在「名稱」欄位中，您只能輸入英文字元、數字和連字型大小。 「名稱」欄位會根據「標題」欄位自動填入，且在「標題」欄位中輸入的特殊字元、空格、數字和非英文字元會取代為連字型大小。 雖然「標題」欄位中的值會自動複製到「名稱」，但您可以編輯值。
-
描述： （選擇性）資料字典的描述。
-
標籤： （選擇性）若要建立自訂標籤，請在文字欄位中輸入值，然後按Enter鍵。 您可以在標籤的文字欄位下方看到您的標籤。 儲存此文字時，也會建立新新增的標籤。
-
延伸屬性： （選擇性）選取 新增欄位 以指定資料字典的中繼資料屬性。 在「屬性名稱」欄中，輸入唯一的屬性名稱。 在「值」欄中，輸入要與屬性關聯的值。
-
-
（選擇性）若要上傳資料字典的XSD結構描述定義，請在[資料字典結構]窗格下選取[上傳XML結構描述]。 瀏覽至XSD檔案，選取該檔案，然後選取 開啟。 系統會根據上傳的XML結構描述建立資料字典。 您需要調整資料字典中元素的顯示名稱和說明。 要執行此操作，請點選元素名稱並編輯其說明、顯示名稱和其他在右窗格欄位中的詳細資訊。
如需有關已計算DD元素的詳細資訊，請參閱已計算的資料字典元素。
note note NOTE 您可以略過上傳結構描述檔案，並使用使用者介面從頭開始建立資料字典。 要執行此操作，請略過此步驟，並繼續後續步驟。 -
選取 「下一步」。
-
在新增屬性畫面中，將元素新增至資料字典。 如果您已上傳結構描述以取得資料字典的基本結構，您也可以新增/刪除元素及編輯其詳細資訊。
您可以選取元素右側的三個點，並將元素新增至資料字典結構。
選取「複合元素」、「收集元素」或「基本元素」。
- 複合DDE包含其他DDE，它們可以是基本型別、複合型別或集合型別。 例如，由街道地址、城市、省、國家/地區和郵遞區號組成的地址。
- 原始DDE是字串、數字、日期和布林值等元素，其中會包含城市名稱等資訊。
- 集合是類似的簡單或複合DDE清單。 例如，客戶具有多個地點或不同的帳單和運送地址。
以下是建立資料字典的部分規則：
- 資料字典中只允許使用複合型別作為頂層DDE。
- 名稱、參考名稱和元素型別是資料字典和DDE的必要欄位。
- 參照名稱必須是唯一的。
- 父DDE （複合）不能有兩個同名的子系。
- 列舉僅包含基本字串型別。
如需有關Composite、Collection和Primitive元素以及使用資料字典元素的詳細資訊，請參閱將資料字典元素對應到XML結構描述。
如需資料字典中驗證的相關資訊，請參閱資料字典編輯器驗證。
-
（選擇性）選取元素後，您可以在進階標籤中新增屬性（屬性）。 您也可以選取 新增欄位 並延伸DD元素的屬性。
-
（選擇性）您可以點選元素右側的三個點並選取 刪除，以移除任何元素。
note note NOTE 刪除具有子節點的複合/收集要素也會刪除其子節點。 -
（選用）在「資料字典結構」窗格及「欄位與變數清單」面板中選取元素。 變更或新增與元素相關聯的任何必要屬性。
-
選取「儲存」。
建立一或多個資料字典的復本 create-copies-of-one-or-more-data-dictionary
若要快速建立包含與現有資料字典類似之屬性和元素的一或多個資料字典，您可以複製並貼上它們。
- 從資料字典清單中，選取適當的資料字典。 UI會顯示「複製」圖示。
- 選取「複製」。 UI會顯示「貼上」圖示。
- 選取「貼上」。 「貼上」對話方塊隨即顯示。 系統會自動指定新資料字典的名稱和標題。
- 如有必要，請編輯您想要用來儲存資料字典副本的「標題」和「名稱」。
- 選取「貼上」。 資料字典的副本隨即建立。 現在，您可以在新建的資料字典中進行所需的變更。
檢視參考資料字典元素的檔案片段或檔案 see-the-document-fragments-or-documents-that-refer-to-a-data-dictionary-element
在編輯或檢視資料字典時，您可以看到資料字典中的哪些元素在文字、條件、字母和互動式通訊中參照。
-
執行下列任一項作業來編輯資料字典：
- 將滑鼠指標暫留在資料字典上，並選取編輯。
- 選取資料字典，然後在標題中選取「編輯」。
- 將滑鼠指標暫留在資料字典上，然後選取選取。 接著，在標題中選取「編輯」 。
或在資料字典上選取以檢視。
-
在資料字典中選取簡單元素加以選取。 複合與集合元素沒有參照。
除了元素的「基本」和「進階」屬性外，「借出內容」也會出現。
-
選取借出內容。
「借出內容」標籤會顯示下列專案：文字、條件、字母及互動式通訊。 每個標題也會顯示所選元素的參照數量。
-
選取標題可檢視參照元素的資產名稱。
-
若要檢視其他元素的借出內容，請選取元素。
-
若要顯示參考元素的資產，請選取其名稱。 瀏覽器會顯示資產、信函或互動式通訊。
使用測試資料 working-with-test-data
-
在[資料字典]頁面上，選取 選取。
-
選取您要下載測試資料的資料字典，然後選取 下載範例XML資料。
-
在警示訊息中選取 確定。 下載XML檔案。
-
使用記事本或其他XML編輯器開啟XML檔案。 XML檔案的結構與資料字典和元素中的預留位置字串相同。 將預留位置字串取代為您要用來測試信函的資料。
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 在此範例中，XML會為收集要素的三個值建立空間，但可以根據需求增加/減少值的數目。 -
輸入資料後，您可以在預覽含有測試資料的信函時，使用此XML檔案。
您可以使用DD新增此測試資料（選取DD並選取「上傳測試資料」並上傳此xml檔案）
因此在這之後，當您正常預覽信函時（非自訂），信函中就會使用此XML資料。 您也可以選取「自訂」，然後上傳此XML。
範例 samples
下列程式碼範例顯示資料字典的實作詳細資料。
可上傳至資料字典的範例結構描述 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>
與DDE相關聯的通用屬性 common-attributes-associated-with-a-dde
下表詳細說明與DDE相關的通用屬性：
計算的資料字典元素 computedddelements
資料字典也可以包含計算元素。 計算的資料字典元素一律與運算式相關聯。 此運算式的評估目的，是在執行階段取得資料字典元素的值。 計算的DDE值是其他DDE值或常值的函式。 預設支援JSP運算式語言(EL)運算式。 EL運算式使用${ }字元，有效的運算式可包含常值、運運算元、變數（資料字典元素參考）和函式呼叫。 在運算式中參考資料字典元素時，會使用DDE的參考名稱。 資料字典中每個資料字典元素的參考名稱都是唯一的。
計算的DDE PersonFullName可以與EL串連運算式相關聯，例如${PersonFirstName} ${PersonLastName}。
XSD與資料字典之間的資料型別對應 data-type-mapping-between-xsd-and-data-dictionary-br
匯出XSD需要特定的資料對應，詳見下表。 DDI資料欄會指出DDI中可用的DDE值型別。
從資料字典下載範例資料檔案 download-a-sample-data-file-from-a-data-dictionary
建立資料字典後，您可以下載為XML範例資料檔案，在其中輸入文字。
-
在[資料字典]頁面中，選取 選取，然後選取資料字典以選取它。
-
選取 下載範例XML資料。
-
在警示訊息中選取 確定。
「通訊管理」會根據選取的資料字典結構建立XML檔案，然後以<data-dictionary-name>-SampleData名稱將其下載到您的電腦。 現在，您可以在建立信件時，以XML或文字編輯器編輯此檔案，以進行資料輸入。
中繼資料的國際化 internationalization-of-meta-data
當您想要以不同語言傳送相同信函給客戶時，可以將資料字典和資料字典元素的顯示名稱、說明和列舉值組當地語系化。
將資料字典本地化 localize-data-dictionary
-
在[資料字典]頁面上，選取 選取，然後選取資料字典以選取它。
-
選取 下載本地化資料。
-
在警示中選取 確定。 「通訊管理」會將名稱為DataDictionary-<DDname>.zip的zip檔案下載到您的電腦。
-
Zip檔案包含.properties檔案。 此檔案會定義下載的資料字典。 屬性檔案的內容類似於以下內容：
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屬性檔案的結構為資料字典的每個說明和顯示名稱定義一行，並在資料字典中定義每個資料字典元素。 此外，屬性檔案會針對每個資料字典元素所設定的列舉值定義一行。 和資料字典一樣，對應的屬性檔案可以有多個資料字典元素定義。 此外，檔案可以包含一或多個列舉值集的定義。
-
若要更新不同地區設定的.properties檔案，請更新檔案的顯示名稱和描述值。 針對您想要本地化的每種語言，建立更多檔案例項。 僅支援法文、德文、日文和英文。
-
使用下列名稱儲存不同的更新屬性檔案：
_fr_FR.properties法文
_de_DE.properties德文
_ja_JA.properties日文
_en_EN.properties英文
-
將.properties檔案（或多個區域設定的檔案）封存至單一.zip檔案。
-
在[資料字典]頁面中，選取 更多 > 上傳本地化資料，然後選取包含本地化屬性檔案的zip檔案。
-
若要檢視本地化變更，請變更您的瀏覽器地區設定。
資料字典驗證 ddvalidations
資料字典編輯器會在建立或更新資料字典時強制進行下列驗證。
- 在資料字典中，只有複合型別才允許做為最上層元素。
- 分葉層次不允許「複合」與「收集」要素。 分葉層級只允許基本元素（字串、日期、數字、布林值）。 此驗證可確保沒有沒有沒有子DDE的複合與收集要素。
- 上傳XSD檔案以建立資料字典時，資料字典編輯器會提示輸入頂層元素（如果存在多個元素）以建立資料字典。
- 名稱是資料字典的唯一必要引數。
- 父DDE （複合）不能有兩個同名的子系
- 確保只有在非必要引數的情況下，才會將DDE標籤為已計算。 無法計算必要的元素，也不需要計算的元素。 此外，集合和複合元素不能是計算元素。
- 確保只有在未計算DDE時，才將其標籤為必要。 它也能確保它不是表示「收集」型態的「collectionElement」（此為收集Element的唯一子系）。
- 資料字典或DDE的extendedProperties中不允許空白索引鍵或重複索引鍵。
- 請勿在延伸屬性的索引鍵或值中使用冒號(：)或垂直列(|)字元。 對於這些禁止使用的字元，沒有任何驗證。
在資料字典層級套用的驗證
- 資料字典名稱不得為空。
- 資料字典名稱僅可包含英數字元。
- 資料字典中的子元素清單不得為Null或空白。
- 資料字典不得包含超過一個頂層資料字典元素。
- 資料字典中只允許將複合型別設為最上層元素。
在資料字典元素層級套用的驗證。
- 所有DDE名稱不可以是Null，也不可以包含空格。
- 所有DDE都必須有「非null/非null」元素型別。
- 所有DDE參考名稱不可以是Null。
- 所有DDE參照名稱必須是唯一的。
- 所有DDE參考只能包含英數字元和「_」。
- 所有DDE顯示名稱只能包含英數字元和「_」。
- 分葉層次不允許「複合」與「收集」要素。 分葉層級只允許基本元素（字串、日期、數字、布林值）。 此驗證可確保沒有沒有沒有子DDE的複合與收集要素。
- 複合父DDE不能有兩個同名的子元素。
- ENUM子型別僅用於String和Number元素。
- 無法計算集合與複合元素。
- DDE不可同時為已計算及必要。
- 計算的DDE必須包含有效的運算式。
- 計算的DDE不可以有XML繫結。
- 無法計算或需要代表Collection DDE型別的DDE。
- 子型別ENUM的DDE不得包含Null或空值集。
- 集合DDE的XML繫結不得對應至屬性。
- XML繫結語法必須有效，例如，只有一個@出現，只有在後面接著屬性名稱時才允許@。
將資料字典元素對應至XML綱要 mappingddetoschema
您可以從「XML綱要」建立資料字典，或是使用「資料字典」使用者介面來建置它。 資料字典內的所有資料字典元素(DDE)都有「XML繫結」欄位，可儲存DDE與XML結構描述中元素的繫結。 每個DDE中的繫結都是相對於父DDE的。
以下詳細資訊範例模型和程式碼範例，顯示資料字典的實作詳細資訊。
對應簡單（基本）元素 mapping-simple-primitive-elements
基本的DDE代表本質上是原子性的欄位或屬性。 在複雜型別（複合DDE）或重複元素（集合DDE）的範圍之外定義的基本DDE，可以儲存在XML Schema內的任何位置。 對應至基本DDE的資料位置不依存於其父DDE的對應。 基本DDE會使用「XML繫結」欄位中的對應資訊來決定其值，且對應會轉換為下列其中一項：
- 屬性
- 元素
- 文字內容
- 無（忽略的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>
對應複合元素 mapping-composite-elements
複合元素不支援繫結，如果提供繫結，則會忽略該繫結。 所有基本型別之組成子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>
對映收集要素 mapping-collection-elements
收集要素僅會對映至基數> 1的其他收集要素。 集合DDE的子DDE具有與其父系的XML繫結相關的相對（本機） XML繫結。 由於集合元素的子DDE必須具有與父元素相同的基數，因此相對繫結必須確保基數限制，以便子DDE不會指向非重複的XML結構描述元素。 在以下範例中，「TokenID」的基數必須與其父集合DDE的「Token」相同。
將集合DDE對應至XML Schema元素時：
-
與Collection元素對應的DDE繫結必須是絕對XPath
-
不提供代表「收集」元素型別之DDE的繫結。 如果提供，則會忽略繫結。
-
「收集」元素之所有子DDE的繫結必須相對於父「收集」元素。
下列XML結構描述會宣告名稱為Tokens且maxOccurs屬性為「unbounded」的元素。 因此，Token是收集元素。
<?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>