diff options
Diffstat (limited to 'docs/ui/designer.rst')
| -rw-r--r-- | docs/ui/designer.rst | 416 |
1 files changed, 416 insertions, 0 deletions
diff --git a/docs/ui/designer.rst b/docs/ui/designer.rst new file mode 100644 index 000000000..e964f02fb --- /dev/null +++ b/docs/ui/designer.rst @@ -0,0 +1,416 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. Copyright (C) 2019 IBM. + +CDS Designer UI +=============== + +**Table of Contents** + +- `Getting + Started <file:////pages/viewpage.action%3fpageId=84650427#CDSDesignerGuide-GettingStarted>`__ + +- `What is CDS Designer + UI? <file:////pages/viewpage.action%3fpageId=84650427#CDSDesignerGuide-WhatIsCDS>`__ + +- `What's + new? <file:////pages/viewpage.action%3fpageId=84650427#CDSDesignerGuide-WhatIsNew>`__ + +- `Overview of CDS + Interface <file:////pages/viewpage.action%3fpageId=84650427#CDSDesignerGuide-OverviewOfCDS>`__ + +- `CBA + Packages <file:////pages/viewpage.action%3fpageId=84650427#CDSDesignerGuide-CBAPackages>`__ + + - `Package + list <file:////pages/viewpage.action%3fpageId=84650427#CDSDesignerGuide-PackageList>`__ + + - `Create a CBA + Package <file:////pages/viewpage.action%3fpageId=84650427#CDSDesignerGuide-CreateNewCBAPackage>`__ + + - `User + Flow <file:////pages/viewpage.action%3fpageId=84650427#CDSDesignerGuide-UserFlow>`__ + + - `Create a New + Package <file:////pages/viewpage.action%3fpageId=84650427#CDSDesignerGuide-CreateNewPackage>`__ + + - `MetaData <#CDSDesignerGuide-MetaData>`__ + + - `Template & Mapping <#CDSDesignerGuide-TemplateMapping>`__ + + - `Scripts <#CDSDesignerGuide-Scripts>`__ + + - `Definitions <#CDSDesignerGuide-Definitions>`__ + + - `External System Authentication + Properties <#CDSDesignerGuide-ExternalSystem>`__ + + +Getting Started +--------------- + +This is your CDS Designer UI guide. No matter how experienced you are or +what you want to achieve, it should cover everything you need to know — +from navigating the interface to making the most of different features. + +What is CDS Designer UI? +------------------------ + ++----------------------------------------------+--------------+ +| CDS Designer UI is a framework to automate | | +| the **resolution of resources** for | |image1| | +| **instantiation** and any **config** | | +| provisioning operation, such as day0, day1, | | +| or day2 configuration. | | +| | | +| CDS has both **design-time** and | | +| **run-time** activities; during design time, | | +| **Designer** can **define** what **actions** | | +| are required for a given service, along with | | +| anything comprising the action. The design | | +| produces a `CBA | | +| Package <https://wik | | +| i.onap.org/display/DW/Modeling+Concepts#Mode | | +| lingConcepts-ControllerBlueprintArchive>`__. | | +| Its **content** is driven from a **catalog** | | +| of **reusable data dictionary** and | | +| **component**, delivering a reusable and | | +| simplified **self-service** experience. | | +| | | +| CDS modeling is mainly based on **the TOSCA | | +| standard**, using JSON as a representation. | | ++----------------------------------------------+--------------+ + +.. _section-3: + +What's new? +----------- + ++----------------------+----------------------+----------------------+ +| |image2| | |image3| | |image4| | +| | | | +| Create full CBA | Import old packages | Create sophisticated | +| packages from | for edit and | package workflows in | +| built-in forms | collaboration | a no-code graphical | +| without programming | | designer | +| | | | +| |image5| | |image6| | |image7| | +| | | | +| Customizable CBA | Easily create and | Integration between | +| Package actions | manage lists of data | CDS UI and SDC | +| | via interface (Data | Services | +| | Dictionary, | | +| | controller catalog, | | +| | and config | | +| | management) | | ++----------------------+----------------------+----------------------+ + +Overview of CDS Interface +------------------------- + +Full CDS UI screens are available in +`InVision <https://invis.io/PAUI9GLJH3Q>`__ + +|image8| + +1. **CDS main menu:** Access all CDS module list including Packages, + Data Dictionary, Controller Catalog, etc. + +2. **Profile:** Access user profile information + +3. **Module Title:** See the current module name and the total number of + items in the module list + +4. **Module list:** View all active items in module and tools for search + and filtering + +CBA Packages +------------ + +- .. rubric:: Package List + :name: package-list + +It gives you quick access to all and most recent created/edit packages + +|image9| + +1. **Module Tabs:** Access All, Deployed, Under Construction, or + Archived packages + +2. **Search:** Search for a package by title + +3. **Filter:** Filter packages by package tags + +4. **Package Sort:** Sort packages by recent or alphanumeric (name) or + version + +5. **List Pagination:** navigate between package list pages + +6. **Create Package:** Create a new CBA package + +7. **Import Package:** Import other packages that are created + previously on CDS Editor or Designer or created by other/current + user + +8. **Package box:** It shows a brief detail of the package and gives + access to some actions of the package + +9. **Package name and version** + +10. **More menu:** Access a list of actions including Clone, Archive, + Download, and Delete + +11. **Last modified:** Shows user name and date and time of last + modifications made in the package + +12. **Package Description** + +13. **Collaborators:** See who's collaborating to edit in the package + +14. **Configuration button:** Go directly to package configuration + +15. **Designer Mode:** It indicates package mode (Designer, Scripting, + and Generic scripting) and by clicking on it, it will load to mode + screen + +Create a New CBA Package +------------------------ + +- .. rubric:: User Flow + :name: user-flow + +|image10| + +- .. rubric:: Create a New Package + :name: create-a-new-package + +You can create a new CBA Package by creating a new custom package or by +import package file that is already created before. + +**Create/Import Package** + +You can’t create/import a CBA package that has the same name and version +of an existing package. Packages can be in the same name but in +different version number (ex., Package one v1.0.0 & Package one v1.0.1). + +**Create a New Custom CBA Package** + +From the Packages page, click on the **Create Package** button to +navigate to **Package** **Configuration** + +|image11| + +- .. rubric:: `MetaData <https://wiki.onap.org/display/DW/Modeling+Concepts#Concepts-958933373>`__ + :name: metadata + +In **MetaData Tab,** select Package Mode, enter package Name, Version, +Description and other configurations + +|image12| + +Once you fill all required inputs, you can save this package by click +**Save** button in the Actions menu + +|image13| + +**Package Info Box:** It is in top of configurations tabs and it appears +after you save a package for the first time + +|image14| + +You can continue adding package configuration or go directly to +**Designer Mode** screen from Package infobox + +All changes will be saved when you click on **Save** button + +To close the package configuration and go back to the Package list, +navigate to the top left in breadcrumb and click the **CBA Packages** +link or click on **Packages** link in the Main menu. + +- .. rubric:: `Template & + Mapping <https://wiki.onap.org/display/DW/Modeling+Concepts#Concepts--1256902502>`__ + :name: template-mapping + +You can create as many templates using +`artifact-mapping-resource <https://wiki.onap.org/display/DW/Modeling+Concepts#ModelingConcepts-artifact-mapping-resource>`__ +or/and +`artifact-template-velocity. <https://wiki.onap.org/display/DW/Modeling+Concepts#ModelingConcepts-artifact-template-velocity>`__ + +|image15| + +1. **Template name** + +2. **Template Section:** Where you include template attributes + +3. **Manage Mapping:** Here the automapping process occurs to template + attributes to refer to the data dictionary that will be used to + resolve a particular resource. + +**Template Section** + +|image16| + +1. **Template Type:** Template is defined by one of three templates + (Velocity, Jinja, Kotlin) + +2. **Import Template Attributes/Parameters:** You can add attributes by + Import attribute list file or by + +3. **Insert Template Attributes/Parameters Manually:** You can insert + Attributes manually in the code editor. Code editor validates + attributes according to the pre-selected template type + +**Import Template Attributes** + +|image17| + +After import attributes, you can add/edit/delete attributes in the code +editor. + +|image18| + +**Manage Mapping Section** + +|image19| + +1. **Use current Template Instance:** You can use attributes from + Template section + +2. **Upload Attributes List:** In case you don’t have existing + attributes in Template section or have different attributes, you can + upload attributes list + +Once you select the source of attributes, you get a confirmation of +success fetching. + +|image20| + +Then the Mapped Table appears to show the Resource Dictionary reference. + +|image21| + +When you finish the creation process, you must click on **the Finish +button (1)** to submit the template, or you can clear all data by click +on **the Clear button** **(2).** + +|image22| + +- .. rubric:: `Scripts <https://wiki.onap.org/display/DW/Modeling+Concepts#Concepts--703799064>`__ + :name: scripts + +Allowed file type: Kotlin(kt), Python(py) + +To add script file/s, you have two options: + +1. **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 + **press ENTER** key from the keyboard + +|image23| + +2. **Import File** + +|image24| + +By adding script file/s, you can: + +1. Edit file: You can edit each script file from the code editor + +2. Delete file + +|image25| + +- .. rubric:: `Definitions <https://wiki.onap.org/display/DW/Modeling+Concepts#ModelingConcepts-dataType>`__ + :name: definitions + +Allowed file type: JSON + +To define a data type that represents the **schema** of a specific type +of **data**, you have two options: + +1. ** 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 + **press ENTER** key from the keyboard + +|image26| + +2. **Import File** + +|image27| + +By adding definition file/s, you can: + +1. Edit file: You can edit each definition file from the code editor + +2. Delete file + +|image28| + +- .. rubric:: `External System Authentication + Properties <https://wiki.onap.org/display/DW/Modeling+Concepts#ModelingConcepts-FlexiblePlugIn>`__ + :name: external-system-authentication-properties + +In order to populate the system information within the package, you have +to provide **dsl_definitions** + +|image29| + + +.. |image1| image:: https://wiki.onap.org/download/attachments/84650426/CDS%20Logo.png?version=1&modificationDate=1591034588000&api=v2 + :width: 200pt +.. |image2| image:: https://wiki.onap.org/download/thumbnails/84650426/Feature%201.png?version=1&modificationDate=1591032224000&api=v2 + :width: 50pt +.. |image3| image:: https://wiki.onap.org/download/thumbnails/84650426/Feature%202.png?version=1&modificationDate=1591032225000&api=v2 + :width: 47pt +.. |image4| image:: https://wiki.onap.org/download/thumbnails/84650426/Feature%203.png?version=1&modificationDate=1591032226000&api=v2 + :width: 47pt +.. |image5| image:: https://wiki.onap.org/download/thumbnails/84650426/Feature%204.png?version=1&modificationDate=1591032227000&api=v2 + :width: 60pt +.. |image6| image:: https://wiki.onap.org/download/thumbnails/84650426/Feature%205.png?version=1&modificationDate=1591032227000&api=v2 + :width: 50pt +.. |image7| image:: https://wiki.onap.org/download/thumbnails/84650426/Feature%206.png?version=1&modificationDate=1591032228000&api=v2 + :width: 30pt +.. |image8| image:: https://wiki.onap.org/download/attachments/84650426/Interface.jpg?version=1&modificationDate=1591033366000&api=v2 + :width: 500pt +.. |image9| image:: https://wiki.onap.org/download/attachments/84650426/Package%20List.jpg?version=1&modificationDate=1591033938000&api=v2 + :width: 500pt +.. |image10| image:: https://wiki.onap.org/download/attachments/84650426/Create%20Package%20User%20flow.jpg?version=1&modificationDate=1591034050000&api=v2 + :width: 500pt +.. |image11| image:: https://wiki.onap.org/download/attachments/84650426/Create%20Package.jpg?version=1&modificationDate=1591034193000&api=v2 + :width: 500pt +.. |image12| image:: https://wiki.onap.org/download/attachments/84650426/Package%20Configuration%20-%20MetaData.jpg?version=1&modificationDate=1591034297000&api=v2 + :width: 500pt +.. |image13| image:: https://wiki.onap.org/download/attachments/84650426/Package%20Configuration%20-%20Action%20Menu.jpg?version=1&modificationDate=1591034344000&api=v2 + :width: 500pt +.. |image14| image:: https://wiki.onap.org/download/attachments/84650426/Package%20Configuration%20-%20Info%20Box.jpg?version=1&modificationDate=1591034382000&api=v2 + :width: 500pt +.. |image15| image:: https://wiki.onap.org/download/attachments/84650426/Temp%20%26%20Mapp%201.jpg?version=1&modificationDate=1591638883000&api=v2 + :width: 500pt +.. |image16| image:: https://wiki.onap.org/download/attachments/84650426/Temp%20%26%20Mapp%202.jpg?version=1&modificationDate=1591638960000&api=v2 + :width: 500pt +.. |image17| image:: https://wiki.onap.org/download/attachments/84650426/Temp%20%26%20Mapp%203.jpg?version=1&modificationDate=1591639023000&api=v2 + :width: 500pt +.. |image18| image:: https://wiki.onap.org/download/attachments/84650426/Temp%20%26%20Mapp%206.jpg?version=1&modificationDate=1591639059000&api=v2 + :width: 500pt +.. |image19| image:: https://wiki.onap.org/download/attachments/84650426/Temp%20%26%20Mapp%207.jpg?version=1&modificationDate=1591639152000&api=v2 + :width: 500pt +.. |image20| image:: https://wiki.onap.org/download/attachments/84650426/Temp%20%26%20Mapp%208.jpg?version=1&modificationDate=1591639203000&api=v2 + :width: 500pt +.. |image21| image:: https://wiki.onap.org/download/attachments/84650426/Temp%20%26%20Mapp%209.jpg?version=1&modificationDate=1591639235000&api=v2 + :width: 500pt +.. |image22| image:: https://wiki.onap.org/download/attachments/84650426/Temp%20%26%20Mapp%2011.jpg?version=1&modificationDate=1591639260000&api=v2 + :width: 500pt +.. |image23| image:: https://wiki.onap.org/download/attachments/84650426/Scripts%201.jpg?version=1&modificationDate=1591639325000&api=v2 + :width: 500pt +.. |image24| image:: https://wiki.onap.org/download/attachments/84650426/Scripts%202.jpg?version=1&modificationDate=1591639391000&api=v2 + :width: 500pt +.. |image25| image:: https://wiki.onap.org/download/attachments/84650426/Scripts%203.jpg?version=1&modificationDate=1591639425000&api=v2 + :width: 500pt +.. |image26| image:: https://wiki.onap.org/download/attachments/84650426/Definitions%201.jpg?version=1&modificationDate=1591639459000&api=v2 + :width: 500pt +.. |image27| image:: https://wiki.onap.org/download/attachments/84650426/Definitions%202.jpg?version=1&modificationDate=1591639514000&api=v2 + :width: 500pt +.. |image28| image:: https://wiki.onap.org/download/attachments/84650426/Definitions%203.jpg?version=1&modificationDate=1591639556000&api=v2 + :width: 500pt +.. |image29| image:: https://wiki.onap.org/download/attachments/84650426/External%20system.jpg?version=1&modificationDate=1591639581000&api=v2 + :width: 500pt
\ No newline at end of file |