docs/ui/designer.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3 .. Copyright (C) 2019 IBM.
   4
   5 CDS Designer UI
   6 ===============
   7
   8 .. toctree::
   9    :caption: Table of Contents
  10    :maxdepth: 4
  11
  12
  13 Getting Started
  14 ---------------
  15
  16 This is your CDS Designer UI guide. No matter how experienced you are or
  17 what you want to achieve, it should cover everything you need to know —
  18 from navigating the interface to making the most of different features.
  19
  20
  21 What is CDS Designer UI?
  22 ------------------------
  23
  24 +----------------------------------------------+--------------+
  25 | CDS Designer UI is a framework to automate   |              |
  26 | the **resolution of resources** for          |    |image1|  |
  27 | **instantiation** and any **config**         |              |
  28 | provisioning operation, such as day0, day1,  |              |
  29 | or day2 configuration.                       |              |
  30 |                                              |              |
  31 | CDS has both **design-time** and             |              |
  32 | **run-time** activities; during design time, |              |
  33 | **Designer** can **define** what **actions** |              |
  34 | are required for a given service, along with |              |
  35 | anything comprising the action. The design   |              |
  36 | produces a `CBA                              |              |
  37 | Package <https://wik                         |              |
  38 | i.onap.org/display/DW/Modeling+Concepts#Mode |              |
  39 | lingConcepts-ControllerBlueprintArchive>`__. |              |
  40 | Its **content** is driven from a **catalog** |              |
  41 | of **reusable data dictionary** and          |              |
  42 | **component**, delivering a reusable and     |              |
  43 | simplified **self-service** experience.      |              |
  44 |                                              |              |
  45 | CDS modeling is mainly based on **the TOSCA  |              |
  46 | standard**, using JSON as a representation.  |              |
  47 +----------------------------------------------+--------------+
  48
  49
  50 What's new?
  51 -----------
  52
  53 +----------------------+----------------------+----------------------+
  54 | |image2|             | |image3|             | |image4|             |
  55 |                      |                      |                      |
  56 | Create full CBA      | Import old packages  | Create sophisticated |
  57 | packages from        | for edit and         | package workflows in |
  58 | built-in forms       | collaboration        | a no-code graphical  |
  59 | without programming  |                      | designer             |
  60 |                      |                      |                      |
  61 | |image5|             | |image6|             | |image7|             |
  62 |                      |                      |                      |
  63 | Customizable CBA     | Easily create and    | Integration between  |
  64 | Package actions      | manage lists of data | CDS UI and SDC       |
  65 |                      | via interface (Data  | Services             |
  66 |                      | Dictionary,          |                      |
  67 |                      | controller catalog,  |                      |
  68 |                      | and config           |                      |
  69 |                      | management)          |                      |
  70 +----------------------+----------------------+----------------------+
  71
  72
  73 Overview of CDS Interface
  74 -------------------------
  75
  76 Full CDS UI screens are available in
  77 `InVision <https://invis.io/PAUI9GLJH3Q>`__
  78
  79 |image8|
  80
  81 1. **CDS main menu:** Access all CDS module list including Packages,
  82    Data Dictionary, Controller Catalog, etc.
  83
  84 2. **Profile:** Access user profile information
  85
  86 3. **Module Title:** See the current module name and the total number of
  87    items in the module list
  88
  89 4. **Module list:** View all active items in module and tools for search
  90    and filtering
  91
  92
  93 CBA Packages
  94 ------------
  95
  96 Package List
  97 ~~~~~~~~~~~~
  98
  99 It gives you quick access to all and most recent created/edit packages
 100
 101 |image9|
 102
 103 1.  **Module Tabs:** Access All, Deployed, Under Construction, or
 104     Archived packages
 105
 106 2.  **Search:** Search for a package by title
 107
 108 3.  **Filter:** Filter packages by package tags
 109
 110 4.  **Package Sort:** Sort packages by recent or alphanumeric (name) or
 111     version
 112
 113 5.  **List Pagination:** navigate between package list pages
 114
 115 6.  **Create Package:** Create a new CBA package
 116
 117 7.  **Import Package:** Import other packages that are created
 118     previously on CDS Editor or Designer or created by other/current
 119     user
 120
 121 8.  **Package box:** It shows a brief detail of the package and gives
 122     access to some actions of the package
 123
 124 9.  **Package name and version**
 125
 126 10. **More menu:** Access a list of actions including Clone, Archive,
 127     Download, and Delete
 128
 129 11. **Last modified:** Shows user name and date and time of last
 130     modifications made in the package
 131
 132 12. **Package Description**
 133
 134 13. **Collaborators:** See who's collaborating to edit in the package
 135
 136 14. **Configuration button:** Go directly to package configuration
 137
 138 15. **Designer Mode:** It indicates package mode (Designer, Scripting,
 139     and Generic scripting) and by clicking on it, it will load to mode
 140     screen
 141
 142
 143 Create a New CBA Package
 144 ------------------------
 145
 146 User Flow
 147 ~~~~~~~~~
 148
 149 |image10|
 150
 151
 152 Create a New Package
 153 ~~~~~~~~~~~~~~~~~~~~
 154
 155 You can create a new CBA Package by creating a new custom package or by
 156 import package file that is already created before.
 157
 158 **Create/Import Package**
 159
 160 You can’t create/import a CBA package that has the same name and version
 161 of an existing package. Packages can be in the same name but in
 162 different version number (ex., Package one v1.0.0 & Package one v1.0.1).
 163
 164 **Create a New Custom CBA Package**
 165
 166 From the Packages page, click on the **Create Package** button to
 167 navigate to **Package** **Configuration**
 168
 169 |image11|
 170
 171
 172 `MetaData <https://wiki.onap.org/display/DW/Modeling+Concepts#Concepts-958933373>`__
 173 ~~~~~~~~~
 174
 175 In **MetaData Tab,** select Package Mode, enter package Name, Version,
 176 Description and other configurations
 177
 178 |image12|
 179
 180 Once you fill all required inputs, you can save this package by click
 181 **Save** button in the Actions menu
 182
 183 |image13|
 184
 185 **Package Info Box:** It is in top of configurations tabs and it appears
 186 after you save a package for the first time
 187
 188 |image14|
 189
 190 You can continue adding package configuration or go directly to
 191 **Designer Mode** screen from Package infobox
 192
 193 All changes will be saved when you click on **Save** button
 194
 195 To close the package configuration and go back to the Package list,
 196 navigate to the top left in breadcrumb and click the **CBA Packages**
 197 link or click on **Packages** link in the Main menu.
 198
 199
 200 `Template & Mapping <https://wiki.onap.org/display/DW/Modeling+Concepts#Concepts--1256902502>`__
 201 ~~~~~~~~~~~~~~~~~~~
 202
 203 You can create as many templates using
 204 `artifact-mapping-resource <https://wiki.onap.org/display/DW/Modeling+Concepts#ModelingConcepts-artifact-mapping-resource>`__
 205 or/and
 206 `artifact-template-velocity. <https://wiki.onap.org/display/DW/Modeling+Concepts#ModelingConcepts-artifact-template-velocity>`__
 207
 208 |image15|
 209
 210 1. **Template name**
 211
 212 2. **Template Section:** Where you include template attributes
 213
 214 3. **Manage Mapping:** Here the automapping process occurs to template
 215    attributes to refer to the data dictionary that will be used to
 216    resolve a particular resource.
 217
 218 **Template Section**
 219
 220 |image16|
 221
 222 1. **Template Type:** Template is defined by one of three templates
 223    (Velocity, Jinja, Kotlin)
 224
 225 2. **Import Template Attributes/Parameters:** You can add attributes by
 226    Import attribute list file or by
 227
 228 3. **Insert Template Attributes/Parameters Manually:** You can insert
 229    Attributes manually in the code editor. Code editor validates
 230    attributes according to the pre-selected template type
 231
 232 **Import Template Attributes**
 233
 234 |image17|
 235
 236 After import attributes, you can add/edit/delete attributes in the code
 237 editor.
 238
 239 |image18|
 240
 241 **Manage Mapping Section**
 242
 243 |image19|
 244
 245 1. **Use current Template Instance:** You can use attributes from
 246    Template section
 247
 248 2. **Upload Attributes List:** In case you don’t have existing
 249    attributes in Template section or have different attributes, you can
 250    upload attributes list
 251
 252 Once you select the source of attributes, you get a confirmation of
 253 success fetching.
 254
 255 |image20|
 256
 257 Then the Mapped Table appears to show the Resource Dictionary reference.
 258
 259 |image21|
 260
 261 When you finish the creation process, you must click on **the Finish
 262 button (1)** to submit the template, or you can clear all data by click
 263 on **the Clear button** **(2).**
 264
 265 |image22|
 266
 267
 268 `Scripts <https://wiki.onap.org/display/DW/Modeling+Concepts#Concepts--703799064>`__
 269 ~~~~~~~~
 270
 271 Allowed file type: Kotlin(kt), Python(py)
 272
 273 To add script file/s, you have two options:
 274
 275 **Enter file URL:** Script file can be stored in server and you can add this script file by copy and paste file URL in URL input then
 276 **press ENTER** key from the keyboard
 277
 278 |image23|
 279
 280 **Import File**
 281
 282 |image24|
 283
 284 By adding script file/s, you can:
 285
 286 1. Edit file: You can edit each script file from the code editor
 287
 288 2. Delete file
 289
 290 |image25|
 291
 292
 293 `Definitions <https://wiki.onap.org/display/DW/Modeling+Concepts#ModelingConcepts-dataType>`__
 294 ~~~~~~~~~~~~
 295
 296 Allowed file type: JSON
 297
 298 To define a data type that represents the **schema** of a specific type
 299 of **data**, you have two options:
 300
 301 **Enter file URL:**  Definition file can be stored in server and user can add this script file by copy and paste file URL in URL input then
 302 **press ENTER** key from the keyboard
 303
 304 |image26|
 305
 306 **Import File**
 307
 308 |image27|
 309
 310 By adding definition file/s, you can:
 311
 312 1. Edit file: You can edit each definition file from the code editor
 313
 314 2. Delete file
 315
 316 |image28|
 317
 318
 319 `External System Authentication Properties <https://wiki.onap.org/display/DW/Modeling+Concepts#ModelingConcepts-FlexiblePlugIn>`__
 320 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 321
 322 In order to populate the system information within the package, you have
 323 to provide **dsl_definitions**
 324
 325 |image29|
 326
 327
 328 .. |image1| image:: https://wiki.onap.org/download/attachments/84650426/CDS%20Logo.png?version=1&modificationDate=1591034588000&api=v2
 329    :width: 200pt
 330 .. |image2| image:: https://wiki.onap.org/download/thumbnails/84650426/Feature%201.png?version=1&modificationDate=1591032224000&api=v2
 331    :width: 50pt
 332 .. |image3| image:: https://wiki.onap.org/download/thumbnails/84650426/Feature%202.png?version=1&modificationDate=1591032225000&api=v2
 333    :width: 47pt
 334 .. |image4| image:: https://wiki.onap.org/download/thumbnails/84650426/Feature%203.png?version=1&modificationDate=1591032226000&api=v2
 335    :width: 47pt
 336 .. |image5| image:: https://wiki.onap.org/download/thumbnails/84650426/Feature%204.png?version=1&modificationDate=1591032227000&api=v2
 337    :width: 60pt
 338 .. |image6| image:: https://wiki.onap.org/download/thumbnails/84650426/Feature%205.png?version=1&modificationDate=1591032227000&api=v2
 339    :width: 50pt
 340 .. |image7| image:: https://wiki.onap.org/download/thumbnails/84650426/Feature%206.png?version=1&modificationDate=1591032228000&api=v2
 341    :width: 30pt
 342 .. |image8| image:: https://wiki.onap.org/download/attachments/84650426/Interface.jpg?version=1&modificationDate=1591033366000&api=v2
 343    :width: 500pt
 344 .. |image9| image:: https://wiki.onap.org/download/attachments/84650426/Package%20List.jpg?version=1&modificationDate=1591033938000&api=v2
 345    :width: 500pt
 346 .. |image10| image:: https://wiki.onap.org/download/attachments/84650426/Create%20Package%20User%20flow.jpg?version=1&modificationDate=1591034050000&api=v2
 347    :width: 500pt
 348 .. |image11| image:: https://wiki.onap.org/download/attachments/84650426/Create%20Package.jpg?version=1&modificationDate=1591034193000&api=v2
 349    :width: 500pt
 350 .. |image12| image:: https://wiki.onap.org/download/attachments/84650426/Package%20Configuration%20-%20MetaData.jpg?version=1&modificationDate=1591034297000&api=v2
 351    :width: 500pt
 352 .. |image13| image:: https://wiki.onap.org/download/attachments/84650426/Package%20Configuration%20-%20Action%20Menu.jpg?version=1&modificationDate=1591034344000&api=v2
 353    :width: 500pt
 354 .. |image14| image:: https://wiki.onap.org/download/attachments/84650426/Package%20Configuration%20-%20Info%20Box.jpg?version=1&modificationDate=1591034382000&api=v2
 355    :width: 500pt
 356 .. |image15| image:: https://wiki.onap.org/download/attachments/84650426/Temp%20%26%20Mapp%201.jpg?version=1&modificationDate=1591638883000&api=v2
 357    :width: 500pt
 358 .. |image16| image:: https://wiki.onap.org/download/attachments/84650426/Temp%20%26%20Mapp%202.jpg?version=1&modificationDate=1591638960000&api=v2
 359    :width: 500pt
 360 .. |image17| image:: https://wiki.onap.org/download/attachments/84650426/Temp%20%26%20Mapp%203.jpg?version=1&modificationDate=1591639023000&api=v2
 361    :width: 500pt
 362 .. |image18| image:: https://wiki.onap.org/download/attachments/84650426/Temp%20%26%20Mapp%206.jpg?version=1&modificationDate=1591639059000&api=v2
 363    :width: 500pt
 364 .. |image19| image:: https://wiki.onap.org/download/attachments/84650426/Temp%20%26%20Mapp%207.jpg?version=1&modificationDate=1591639152000&api=v2
 365    :width: 500pt
 366 .. |image20| image:: https://wiki.onap.org/download/attachments/84650426/Temp%20%26%20Mapp%208.jpg?version=1&modificationDate=1591639203000&api=v2
 367    :width: 500pt
 368 .. |image21| image:: https://wiki.onap.org/download/attachments/84650426/Temp%20%26%20Mapp%209.jpg?version=1&modificationDate=1591639235000&api=v2
 369    :width: 500pt
 370 .. |image22| image:: https://wiki.onap.org/download/attachments/84650426/Temp%20%26%20Mapp%2011.jpg?version=1&modificationDate=1591639260000&api=v2
 371    :width: 500pt
 372 .. |image23| image:: https://wiki.onap.org/download/attachments/84650426/Scripts%201.jpg?version=1&modificationDate=1591639325000&api=v2
 373    :width: 500pt
 374 .. |image24| image:: https://wiki.onap.org/download/attachments/84650426/Scripts%202.jpg?version=1&modificationDate=1591639391000&api=v2
 375    :width: 500pt
 376 .. |image25| image:: https://wiki.onap.org/download/attachments/84650426/Scripts%203.jpg?version=1&modificationDate=1591639425000&api=v2
 377    :width: 500pt
 378 .. |image26| image:: https://wiki.onap.org/download/attachments/84650426/Definitions%201.jpg?version=1&modificationDate=1591639459000&api=v2
 379    :width: 500pt
 380 .. |image27| image:: https://wiki.onap.org/download/attachments/84650426/Definitions%202.jpg?version=1&modificationDate=1591639514000&api=v2
 381    :width: 500pt
 382 .. |image28| image:: https://wiki.onap.org/download/attachments/84650426/Definitions%203.jpg?version=1&modificationDate=1591639556000&api=v2
 383    :width: 500pt
 384 .. |image29| image:: https://wiki.onap.org/download/attachments/84650426/External%20system.jpg?version=1&modificationDate=1591639581000&api=v2
 385    :width: 500pt