d8d35189abfd3bd29039c57b7a60c743b0960753
[ccsdk/cds.git] / docs / modelingconcepts / template.rst
1 .. This work is a derivative of https://wiki.onap.org/display/DW/Modeling+Concepts#Concepts-1256902502
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.
5
6 .. _template:
7
8 Template
9 -----------
10
11 A template is an **artifact**, and uses artifact-mapping-resource (see :ref:`artifact_type` -> Mapping) 
12 and artifact-template-velocity (see :ref:`artifact_type` -> Velocity).
13
14 A template is **parameterized** and each parameter must be defined in a corresponding **mapping file**.
15
16 In order to know which mapping correlates to which template, the file name must start with an ``artifact-prefix``, 
17 serving as identifier to the overall template + mapping.
18
19 The **requirement** is as follows:
20
21 ``${artifact-prefix}-template``
22
23 ``${artifact-prefix}-mapping``