docs/ONAP Model Spec/im/Common/DynamicParameters.rst


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492

.. Copyright 2020
.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE
.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode

Dynamic Parameters Model
========================

Diagrams
--------

.. image:: DynamicParameters.png

Dynamic Parameters 
~~~~~~~~~~~~~~~~~~~

Classes
-------

DiscreteValueSpec
~~~~~~~~~~~~~~~~~

DiscreteValueSpec represents a specific valid value that a given Parameter can take on.

**Parent class:** ParmSpecValue

Applied stereotypes:

-  OpenModelClass

-  **support: MANDATORY**

-  Preliminary

================== ======== ========= ================================== ================================================
**Attribute Name** **Type** **Mult.** **Stereotypes**                    **Description**
value              String   1         Preliminary                        A discrete value that the Parameter can take on.
                                                                        
                                      OpenModelAttribute                
                                                                        
                                      -  isInvariant: false             
                                                                        
                                      -  valueRange: no range constraint
                                                                        
                                      -  support: MANDATORY             
================== ======== ========= ================================== ================================================

Parameter
~~~~~~~~~

Some parameter that is part of a ParameterGroup. If parameter can only hold certain values, those values are specified via ParameterSpecValue (design time). The actual value is specified via ParameterValue (runtime).

Applied stereotypes:

-  OpenModelClass

-  **support: MANDATORY**

-  Preliminary

================== ============== ========= ================================== ==================================================================================================================================================================================================================================================================================================================
**Attribute Name** **Type**       **Mult.** **Stereotypes**                    **Description**
parameterName      String         1         Preliminary                        Name of parameter.
                                                                              
                                            OpenModelAttribute                
                                                                              
                                            -  isInvariant: false             
                                                                              
                                            -  valueRange: no range constraint
                                                                              
                                            -  support: MANDATORY             
IsInput            Boolean        1         Preliminary                        Boolean that specifices if this parameter is an input parameter.
                                                                              
                                            OpenModelAttribute                
                                                                              
                                            -  isInvariant: false             
                                                                              
                                            -  valueRange: no range constraint
                                                                              
                                            -  support: MANDATORY             
paramvalue         ParameterValue 0..\*     OpenModelAttribute                 Parameter can have some number of runtime ParameterValues. Each ParameterValue is also associated with some OperationalEntity (VnfInstance, ServiceInstance, ...).
                                                                              
                                            -  isInvariant: false             
                                                                              
                                            -  valueRange: no range constraint
                                                                              
                                            -  support: MANDATORY             
isModifiable       Boolean        1         Preliminary                        Bolean that specifices if the value can be modified or changed during the life of this parameter.
                                                                              
                                            OpenModelAttribute                
                                                                              
                                            -  isInvariant: false             
                                                                              
                                            -  valueRange: no range constraint
                                                                              
                                            -  support: MANDATORY             
valueType          String         1         Preliminary                        The type of this parameter (integer, string, ...).
                                                                              
                                            OpenModelAttribute                
                                                                              
                                            -  isInvariant: false             
                                                                              
                                            -  valueRange: no range constraint
                                                                              
                                            -  support: MANDATORY             
unitOfMeasure      String         0..1      Preliminary                        A length, surface, volume, dry measure, liquid measure, money, weight, time, and the like. In general, a determinate quantity or magnitude of the kind designated, taken as a standard of comparison for others of the same kind, in assigning to them numerical values, as 1 foot, 1 yard, 1 mile, 1 square foot.
                                                                              
                                            OpenModelAttribute                
                                                                              
                                            -  isInvariant: false             
                                                                              
                                            -  valueRange: no range constraint
                                                                              
                                            -  support: MANDATORY             
description        String         1         Preliminary                        Description of the parameter.
                                                                              
                                            OpenModelAttribute                
                                                                              
                                            -  isInvariant: false             
                                                                              
                                            -  valueRange: no range constraint
                                                                              
                                            -  support: MANDATORY             
================== ============== ========= ================================== ==================================================================================================================================================================================================================================================================================================================

ParameterGroup
~~~~~~~~~~~~~~

A group of parameters that somehow relate or work together.

Applied stereotypes:

-  OpenModelClass

-  **support: MANDATORY**

-  Preliminary

========================= ========== ========= ================================== ==============================
**Attribute Name**        **Type**   **Mult.** **Stereotypes**                    **Description**
parameterGroupName        String     1         Preliminary                        Name of ParameterGroup
                                                                                 
                                               OpenModelAttribute                
                                                                                 
                                               -  isInvariant: false             
                                                                                 
                                               -  valueRange: no range constraint
                                                                                 
                                               -  support: MANDATORY             
parameterGroupDescription String     1         Preliminary                        Description of ParameterGroup.
                                                                                 
                                               OpenModelAttribute                
                                                                                 
                                               -  isInvariant: false             
                                                                                 
                                               -  valueRange: no range constraint
                                                                                 
                                               -  support: MANDATORY             
parameterGroupId          Identifier 1         Preliminary                        ID of ParameterGroup.
                                                                                 
                                               OpenModelAttribute                
                                                                                 
                                               -  isInvariant: false             
                                                                                 
                                               -  valueRange: no range constraint
                                                                                 
                                               -  support: MANDATORY             
========================= ========== ========= ================================== ==============================

ParameterValue
~~~~~~~~~~~~~~

The actual value of Parameter (runtime).

Applied stereotypes:

-  OpenModelClass

-  **support: MANDATORY**

-  Preliminary

================== ========= ========= ================================== ===========================================================================================================================
**Attribute Name** **Type**  **Mult.** **Stereotypes**                    **Description**
parameter          Parameter 1         OpenModelAttribute                 Runtime ParameterValue is associated with exactly one Parameter. Parameter can have some number of runtime ParameterValues.
                                                                         
                                       -  isInvariant: false             
                                                                         
                                       -  valueRange: no range constraint
                                                                         
                                       -  support: MANDATORY             
value              String    1         Preliminary                        The actual value of Parameter (runtime).
                                                                         
                                       OpenModelAttribute                
                                                                         
                                       -  isInvariant: false             
                                                                         
                                       -  valueRange: no range constraint
                                                                         
                                       -  support: MANDATORY             
================== ========= ========= ================================== ===========================================================================================================================

ParmSpecValue
~~~~~~~~~~~~~

A valid value of parameter (design time). Values can be either a range (RangeValueSpec) or discrete (DiscreteValueSpec).

Applied stereotypes:

-  OpenModelClass

-  **support: MANDATORY**

-  Preliminary

RangeValueSpec
~~~~~~~~~~~~~~

RangeValueSpec is generally expected to be of valueType integer or

RangeValueSpec generally should have a valueType of either integer or real. valueFrom, valueTo, and rangeStep should all be of the same valuetype for some Parameter.

rangeStep should be greater than zero.

valueTo should be greater than valueFrom

**Parent class:** ParmSpecValue

Applied stereotypes:

-  OpenModelClass

-  **support: MANDATORY**

-  Preliminary

================== ======== ========= ================================== ==============================================================================================================================================================================================================================
**Attribute Name** **Type** **Mult.** **Stereotypes**                    **Description**
valueMin           String   1         Preliminary                        The minimum value that a Parameter can take on.
                                                                        
                                      OpenModelAttribute                
                                                                        
                                      -  isInvariant: false             
                                                                        
                                      -  valueRange: no range constraint
                                                                        
                                      -  support: MANDATORY             
valueMax           String   1         Preliminary                        The maximum value that the parameter can take on.
                                                                        
                                      OpenModelAttribute                
                                                                        
                                      -  isInvariant: false             
                                                                        
                                      -  valueRange: no range constraint
                                                                        
                                      -  support: MANDATORY             
rangeStep          String   0..1      Preliminary                        The specification that a range of values increases in steps, such as a range from 0 to 100 in steps of 5 with the resulting permitted values being 0, 5, 10, 15,...100. This complements the valueFrom and valueTo attributes.
                                                                        
                                      OpenModelAttribute                
                                                                        
                                      -  isInvariant: false             
                                                                        
                                      -  valueRange: no range constraint
                                                                        
                                      -  support: MANDATORY             
================== ======== ========= ================================== ==============================================================================================================================================================================================================================

Associations
------------

ParameterGroupHasParameter
~~~~~~~~~~~~~~~~~~~~~~~~~~

A Parameter can be in more than one ParameterGroup, and a ParameterGroup can have some number of Parameters.

Applied stereotypes:

-  Preliminary

================== =========== ========== ========= ============== =============== =====================
**Attribute Name** **Aggreg.** **Navig.** **Mult.** **Type**       **Description** **Stereotypes**
parameter          shared      Not navig. 1..\*     Parameter                      OpenModelAttribute
                                                                                  
                                                                                   -  partOfObjectKey: 0
                                                                                  
                                                                                   -  uniqueSet:
                                                                                  
                                                                                   -  isInvariant: false
                                                                                  
                                                                                   -  unsigned: false
                                                                                  
                                                                                   -  counter: NA
                                                                                  
                                                                                   -  support: MANDATORY
dynamicparameter   none        Not navig. 0..\*     ParameterGroup                 OpenModelAttribute
                                                                                  
                                                                                   -  partOfObjectKey: 0
                                                                                  
                                                                                   -  uniqueSet:
                                                                                  
                                                                                   -  isInvariant: false
                                                                                  
                                                                                   -  unsigned: false
                                                                                  
                                                                                   -  counter: NA
                                                                                  
                                                                                   -  support: MANDATORY
================== =========== ========== ========= ============== =============== =====================

ParameterHasInstanceValue
~~~~~~~~~~~~~~~~~~~~~~~~~

Applied stereotypes:

-  Preliminary

================== =========== ========== ========= ============== ================================================================================================================================================================== =====================
**Attribute Name** **Aggreg.** **Navig.** **Mult.** **Type**       **Description**                                                                                                                                                    **Stereotypes**
paramvalue         composite   Navig.     0..\*     ParameterValue Parameter can have some number of runtime ParameterValues. Each ParameterValue is also associated with some OperationalEntity (VnfInstance, ServiceInstance, ...). OpenModelAttribute
                                                                                                                                                                                                                                     
                                                                                                                                                                                                                                      -  partOfObjectKey: 0
                                                                                                                                                                                                                                     
                                                                                                                                                                                                                                      -  uniqueSet:
                                                                                                                                                                                                                                     
                                                                                                                                                                                                                                      -  isInvariant: false
                                                                                                                                                                                                                                     
                                                                                                                                                                                                                                      -  unsigned: false
                                                                                                                                                                                                                                     
                                                                                                                                                                                                                                      -  counter: NA
                                                                                                                                                                                                                                     
                                                                                                                                                                                                                                      -  support: MANDATORY
parameter          none        Navig.     1         Parameter      Runtime ParameterValue is associated with exactly one Parameter. Parameter can have some number of runtime ParameterValues.                                        OpenModelAttribute
                                                                                                                                                                                                                                     
                                                                                                                                                                                                                                      -  partOfObjectKey: 0
                                                                                                                                                                                                                                     
                                                                                                                                                                                                                                      -  uniqueSet:
                                                                                                                                                                                                                                     
                                                                                                                                                                                                                                      -  isInvariant: false
                                                                                                                                                                                                                                     
                                                                                                                                                                                                                                      -  unsigned: false
                                                                                                                                                                                                                                     
                                                                                                                                                                                                                                      -  counter: NA
                                                                                                                                                                                                                                     
                                                                                                                                                                                                                                      -  support: MANDATORY
================== =========== ========== ========= ============== ================================================================================================================================================================== =====================

OperationalEntityFurtherDefinedByParam
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Applied stereotypes:

-  Preliminary

================== =========== ========== ========= ================= =============== =====================
**Attribute Name** **Aggreg.** **Navig.** **Mult.** **Type**          **Description** **Stereotypes**
dynamicparamvalue  none        Not navig. 0..\*     ParameterValue                    OpenModelAttribute
                                                                                     
                                                                                      -  partOfObjectKey: 0
                                                                                     
                                                                                      -  uniqueSet:
                                                                                     
                                                                                      -  isInvariant: false
                                                                                     
                                                                                      -  unsigned: false
                                                                                     
                                                                                      -  counter: NA
                                                                                     
                                                                                      -  support: MANDATORY
operationalentity  none        Not navig. 1         OperationalEntity                 OpenModelAttribute
                                                                                     
                                                                                      -  partOfObjectKey: 0
                                                                                     
                                                                                      -  uniqueSet:
                                                                                     
                                                                                      -  isInvariant: false
                                                                                     
                                                                                      -  unsigned: false
                                                                                     
                                                                                      -  counter: NA
                                                                                     
                                                                                      -  support: MANDATORY
================== =========== ========== ========= ================= =============== =====================

DesignEntityFurtherDefinedByParmGroup
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Applied stereotypes:

-  Preliminary

================== =========== ========== ========= ============== =============== =====================
**Attribute Name** **Aggreg.** **Navig.** **Mult.** **Type**       **Description** **Stereotypes**
dynamicparameter   none        Not navig. 0..\*     ParameterGroup                 OpenModelAttribute
                                                                                  
                                                                                   -  partOfObjectKey: 0
                                                                                  
                                                                                   -  uniqueSet:
                                                                                  
                                                                                   -  isInvariant: false
                                                                                  
                                                                                   -  unsigned: false
                                                                                  
                                                                                   -  counter: NA
                                                                                  
                                                                                   -  support: MANDATORY
designentity       none        Not navig. 0..\*     DesignEntity                   OpenModelAttribute
                                                                                  
                                                                                   -  partOfObjectKey: 0
                                                                                  
                                                                                   -  uniqueSet:
                                                                                  
                                                                                   -  isInvariant: false
                                                                                  
                                                                                   -  unsigned: false
                                                                                  
                                                                                   -  counter: NA
                                                                                  
                                                                                   -  support: MANDATORY
================== =========== ========== ========= ============== =============== =====================

ParmSpecValueIntantiatedAsDynamicParmValue
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Applied stereotypes:

-  Preliminary

================== =========== ========== ========= ============== =============== =====================
**Attribute Name** **Aggreg.** **Navig.** **Mult.** **Type**       **Description** **Stereotypes**
\_parametervalue   none        Not navig. 0..\*     ParameterValue                 OpenModelAttribute
                                                                                  
                                                                                   -  partOfObjectKey: 0
                                                                                  
                                                                                   -  uniqueSet:
                                                                                  
                                                                                   -  isInvariant: false
                                                                                  
                                                                                   -  unsigned: false
                                                                                  
                                                                                   -  counter: NA
                                                                                  
                                                                                   -  support: MANDATORY
parmspecvalueii    none        Not navig. 0..1      ParmSpecValue                  OpenModelAttribute
                                                                                  
                                                                                   -  partOfObjectKey: 0
                                                                                  
                                                                                   -  uniqueSet:
                                                                                  
                                                                                   -  isInvariant: false
                                                                                  
                                                                                   -  unsigned: false
                                                                                  
                                                                                   -  counter: NA
                                                                                  
                                                                                   -  support: MANDATORY
================== =========== ========== ========= ============== =============== =====================

ParameterEnumeratedBy SpecValue
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Applied stereotypes:

-  Preliminary

================== =========== ========== ========= ============= =============== =====================
**Attribute Name** **Aggreg.** **Navig.** **Mult.** **Type**      **Description** **Stereotypes**
parameter          none        Not navig. 1         Parameter                     OpenModelAttribute
                                                                                 
                                                                                  -  partOfObjectKey: 0
                                                                                 
                                                                                  -  uniqueSet:
                                                                                 
                                                                                  -  isInvariant: false
                                                                                 
                                                                                  -  unsigned: false
                                                                                 
                                                                                  -  counter: NA
                                                                                 
                                                                                  -  support: MANDATORY
parmspecvalueii    composite   Not navig. 0..\*     ParmSpecValue                 OpenModelAttribute
                                                                                 
                                                                                  -  partOfObjectKey: 0
                                                                                 
                                                                                  -  uniqueSet:
                                                                                 
                                                                                  -  isInvariant: false
                                                                                 
                                                                                  -  unsigned: false
                                                                                 
                                                                                  -  counter: NA
                                                                                 
                                                                                  -  support: MANDATORY
================== =========== ========== ========= ============= =============== =====================