1 .. This work is a derivative of https://wiki.onap.org/display/DW/Modeling+Concepts#Concepts-1386016968
2 .. This work is licensed under a Creative Commons Attribution 4.0
3 .. International License. http://creativecommons.org/licenses/by/4.0
4 .. Copyright (C) 2020 Deutsche Telekom AG.
11 A data dictionary **models the how** a specific **resource** can be **resolved**.
13 A resource is a **variable/parameter** in the context of the service.
14 It can be anything, but it should not be confused with SDC or Openstack resources.
16 A data dictionary can have **multiple sources** to handle resolution in different ways.
18 The main goal of data dictionary is to define **re-usable** entity that could be shared.
20 **Creation** of data dictionaries is a **standalone** activity, separated from the blueprint design.
22 As part of modelling a data dictionary entry, the following generic information should be provided:
38 - List of resource source instance (see :ref:`node_type`)
41 - Defines type and description, as nested JSON
44 - Data dictionary name
47 **Bellow are properties that all the resource source can have**
49 The modeling does allow for **data translation** between external capability
50 and CDS for both input and output key mapping.
60 - map of resources required to perform the request/query. The left hand-side is what is used within
61 the query/request, the right hand side refer to a data dictionary instance.
63 * - output-key-mapping
64 - name of the resource to be resolved mapped to the value resolved by the request/query.
67 - | list of data dictionary instances to be resolved prior the resolution of this specific resource.
68 | during run time execution the key dependencies are recursively sorted and resolved
69 in batch processing using the `acyclic graph algorithm
70 <https://en.wikipedia.org/wiki/Directed_acyclic_graph>`_
75 ``vf-module-model-customization-uuid`` and ``vf-module-label`` are two data dictionaries.
76 A SQL table, VF_MODULE_MODEL, exist to correlate them.
78 Here is how input-key-mapping, output-key-mapping and key-dependencies can be used:
84 * - vf-module-label data dictionary
85 * - .. code-block:: json
88 "name" : "vf-module-label",
89 "tags" : "vf-module-label",
90 "updated-by" : "adetalhouet",
92 "description" : "vf-module-label",
97 "type" : "source-primary-db",
100 "query" : "select sdnctl.VF_MODULE_MODEL.vf_module_label as vf_module_label from sdnctl.VF_MODULE_MODEL where sdnctl.VF_MODULE_MODEL.customization_uuid=:customizationid",
101 "input-key-mapping" : {
102 "customizationid" : "vf-module-model-customization-uuid"
104 "output-key-mapping" : {
105 "vf-module-label" : "vf_module_label"
107 "key-dependencies" : [ "vf-module-model-customization-uuid" ]