publishing and reviewing models on the web · 6 vtl template-based reporting •the apache velocity...
TRANSCRIPT
![Page 1: Publishing and reviewing models on the Web · 6 VTL template-based reporting •The Apache Velocity Engine is a free open-source templating engine •Velocity Template Language (VTL)](https://reader034.vdocuments.site/reader034/viewer/2022051606/601671f02854a974663995b6/html5/thumbnails/1.jpg)
Publishing and reviewing models on the Web Dr. Andrius Armonas, MagicDraw Product Manager
![Page 2: Publishing and reviewing models on the Web · 6 VTL template-based reporting •The Apache Velocity Engine is a free open-source templating engine •Velocity Template Language (VTL)](https://reader034.vdocuments.site/reader034/viewer/2022051606/601671f02854a974663995b6/html5/thumbnails/2.jpg)
Presentation agenda
• Introduction: the problem being solved
• Technologies supported by Cameo Systems Modeler
for work product generation • Template-based reports
• Generation of work products directly from the model
• SysML Views&Viewpoints approach for document generation
• SysML Views&Viewpoints approach for web content generation:
• Publishing of models on the web
• Reviewing published models on the web and tracking review progress
• Integrating published models with Wikis
• Customization of appearance and information fidelity of published
models
![Page 3: Publishing and reviewing models on the Web · 6 VTL template-based reporting •The Apache Velocity Engine is a free open-source templating engine •Velocity Template Language (VTL)](https://reader034.vdocuments.site/reader034/viewer/2022051606/601671f02854a974663995b6/html5/thumbnails/3.jpg)
3
Introduction: document-based SE
![Page 4: Publishing and reviewing models on the Web · 6 VTL template-based reporting •The Apache Velocity Engine is a free open-source templating engine •Velocity Template Language (VTL)](https://reader034.vdocuments.site/reader034/viewer/2022051606/601671f02854a974663995b6/html5/thumbnails/4.jpg)
4
Introduction: single source of truth
Model repository
![Page 5: Publishing and reviewing models on the Web · 6 VTL template-based reporting •The Apache Velocity Engine is a free open-source templating engine •Velocity Template Language (VTL)](https://reader034.vdocuments.site/reader034/viewer/2022051606/601671f02854a974663995b6/html5/thumbnails/5.jpg)
Template-based
reports
![Page 6: Publishing and reviewing models on the Web · 6 VTL template-based reporting •The Apache Velocity Engine is a free open-source templating engine •Velocity Template Language (VTL)](https://reader034.vdocuments.site/reader034/viewer/2022051606/601671f02854a974663995b6/html5/thumbnails/6.jpg)
6
VTL template-based reporting
• The Apache Velocity Engine is a free open-source templating engine
• Velocity Template Language (VTL) is a scripting language used by the Velocity Engine
• MagicDraw VTL templates describe the following properties of the document: • Layout
• Style
• Header & footer
• Static texts
• Placeholders for Cameo Systems Modeler / MagicDraw elements
![Page 7: Publishing and reviewing models on the Web · 6 VTL template-based reporting •The Apache Velocity Engine is a free open-source templating engine •Velocity Template Language (VTL)](https://reader034.vdocuments.site/reader034/viewer/2022051606/601671f02854a974663995b6/html5/thumbnails/7.jpg)
7
VTL template-based reporting
Generate Microsoft Word, Excel, PowerPoint, HTML,
Open Office, XML documents or any other
plain text report from the model
MagicDraw
Report Engine
Properties
![Page 8: Publishing and reviewing models on the Web · 6 VTL template-based reporting •The Apache Velocity Engine is a free open-source templating engine •Velocity Template Language (VTL)](https://reader034.vdocuments.site/reader034/viewer/2022051606/601671f02854a974663995b6/html5/thumbnails/8.jpg)
8
VTL template-based reporting
Blocks Description
#forrow ($block in $sorter.sort($Block, “name”)) $report.getIconFor($block) $block.name
$report.getComment($block) #endrow
Blocks Description
Brewer Valve Brewer Valve component BR-458.
Brewing Channel
Brewing Group
Dispersion Screw
Drain Chamber
Drain Valve
Template:
Resulting Word document:
![Page 9: Publishing and reviewing models on the Web · 6 VTL template-based reporting •The Apache Velocity Engine is a free open-source templating engine •Velocity Template Language (VTL)](https://reader034.vdocuments.site/reader034/viewer/2022051606/601671f02854a974663995b6/html5/thumbnails/9.jpg)
9
Web reports
• Web reports 2.0 • Full information from the model is published on the web
• Easily customizable
![Page 10: Publishing and reviewing models on the Web · 6 VTL template-based reporting •The Apache Velocity Engine is a free open-source templating engine •Velocity Template Language (VTL)](https://reader034.vdocuments.site/reader034/viewer/2022051606/601671f02854a974663995b6/html5/thumbnails/10.jpg)
10
MBSE web portal
• Only the most important information from the model is published on the web
• Views on the system from multiple perspectives
• Customizable by No Magic
• http://webreports.nomagic.com
![Page 11: Publishing and reviewing models on the Web · 6 VTL template-based reporting •The Apache Velocity Engine is a free open-source templating engine •Velocity Template Language (VTL)](https://reader034.vdocuments.site/reader034/viewer/2022051606/601671f02854a974663995b6/html5/thumbnails/11.jpg)
11
MBSE web portal: basic commenting
![Page 12: Publishing and reviewing models on the Web · 6 VTL template-based reporting •The Apache Velocity Engine is a free open-source templating engine •Velocity Template Language (VTL)](https://reader034.vdocuments.site/reader034/viewer/2022051606/601671f02854a974663995b6/html5/thumbnails/12.jpg)
12
MBSE web portal: basic commenting
![Page 13: Publishing and reviewing models on the Web · 6 VTL template-based reporting •The Apache Velocity Engine is a free open-source templating engine •Velocity Template Language (VTL)](https://reader034.vdocuments.site/reader034/viewer/2022051606/601671f02854a974663995b6/html5/thumbnails/13.jpg)
13
Report generation machine
Automated generation of reports
Teamwork Server MagicDraw
HTTP Server
Projects
Generated reports /
web portals (nightly)
Content
![Page 14: Publishing and reviewing models on the Web · 6 VTL template-based reporting •The Apache Velocity Engine is a free open-source templating engine •Velocity Template Language (VTL)](https://reader034.vdocuments.site/reader034/viewer/2022051606/601671f02854a974663995b6/html5/thumbnails/14.jpg)
Demo of template-
based reports
![Page 15: Publishing and reviewing models on the Web · 6 VTL template-based reporting •The Apache Velocity Engine is a free open-source templating engine •Velocity Template Language (VTL)](https://reader034.vdocuments.site/reader034/viewer/2022051606/601671f02854a974663995b6/html5/thumbnails/15.jpg)
15
Overview
Technology Target user
group
Templates
supported
Commenting
supported
Customization
can be done by
Customization
technology
VTL
templates for
documents
(Word, Excel,
etc.)
Non-
modelers and
modelers
Yes Yes, basic
support
Customer VTL scripting
Web reports Modelers Yes No Customer VTL scripting
Web Portals Non-
modelers and
modelers
Yes Yes, basic
support
No Magic Java coding
![Page 16: Publishing and reviewing models on the Web · 6 VTL template-based reporting •The Apache Velocity Engine is a free open-source templating engine •Velocity Template Language (VTL)](https://reader034.vdocuments.site/reader034/viewer/2022051606/601671f02854a974663995b6/html5/thumbnails/16.jpg)
SysML
Views&Viewpoints for
document generation
![Page 17: Publishing and reviewing models on the Web · 6 VTL template-based reporting •The Apache Velocity Engine is a free open-source templating engine •Velocity Template Language (VTL)](https://reader034.vdocuments.site/reader034/viewer/2022051606/601671f02854a974663995b6/html5/thumbnails/17.jpg)
17
SysML Views&Viewpoints concept
• Systems specifications are
stored in models in MBSE
• Viewpoints specifies rules how
to represent model in a suitable
way to stakeholders
• The view is a representation of
the system from the
perspective of a viewpoint
• More information: • http://model-based-systems-
engineering.com/2014/10/02/whats-
new-in-sysml-1-4-view-and-viewpoint/
![Page 18: Publishing and reviewing models on the Web · 6 VTL template-based reporting •The Apache Velocity Engine is a free open-source templating engine •Velocity Template Language (VTL)](https://reader034.vdocuments.site/reader034/viewer/2022051606/601671f02854a974663995b6/html5/thumbnails/18.jpg)
18
SysML Views&Viewpoints example
Generated content:
![Page 19: Publishing and reviewing models on the Web · 6 VTL template-based reporting •The Apache Velocity Engine is a free open-source templating engine •Velocity Template Language (VTL)](https://reader034.vdocuments.site/reader034/viewer/2022051606/601671f02854a974663995b6/html5/thumbnails/19.jpg)
19
SysML Views&Viewpoints example
![Page 20: Publishing and reviewing models on the Web · 6 VTL template-based reporting •The Apache Velocity Engine is a free open-source templating engine •Velocity Template Language (VTL)](https://reader034.vdocuments.site/reader034/viewer/2022051606/601671f02854a974663995b6/html5/thumbnails/20.jpg)
Demo of SysML
Views&Viewpoints
![Page 21: Publishing and reviewing models on the Web · 6 VTL template-based reporting •The Apache Velocity Engine is a free open-source templating engine •Velocity Template Language (VTL)](https://reader034.vdocuments.site/reader034/viewer/2022051606/601671f02854a974663995b6/html5/thumbnails/21.jpg)
21
Overview
Technology Target user
group
Templates
supported
Commenting
supported
Customization
can be done by
Customization
technology
VTL
templates for
documents
(Word, Excel,
etc.)
Non-
modelers and
modelers
Yes Yes, basic
support
Customer VTL scripting
Web reports Modelers Yes No Customer VTL scripting
Web Portals Non-
modelers and
modelers
Yes Yes, basic
support
No Magic Java coding
Document
Modeling
plugin /
SysML V&V
Non-
modelers and
modelers
Partially No Customer Modeling
![Page 22: Publishing and reviewing models on the Web · 6 VTL template-based reporting •The Apache Velocity Engine is a free open-source templating engine •Velocity Template Language (VTL)](https://reader034.vdocuments.site/reader034/viewer/2022051606/601671f02854a974663995b6/html5/thumbnails/22.jpg)
SysML
Views&Viewpoints for
web content generation
![Page 23: Publishing and reviewing models on the Web · 6 VTL template-based reporting •The Apache Velocity Engine is a free open-source templating engine •Velocity Template Language (VTL)](https://reader034.vdocuments.site/reader034/viewer/2022051606/601671f02854a974663995b6/html5/thumbnails/23.jpg)
23
Cameo Collaborator (web)
MagicDraw (desktops)
What is Cameo Collaborator?
Content creators
- modelers
Model
reviewers
Model
readers/users
Model editors /
contributors to
models The future
![Page 24: Publishing and reviewing models on the Web · 6 VTL template-based reporting •The Apache Velocity Engine is a free open-source templating engine •Velocity Template Language (VTL)](https://reader034.vdocuments.site/reader034/viewer/2022051606/601671f02854a974663995b6/html5/thumbnails/24.jpg)
24
Use cases
Use cases:
• View & understand content
• Review and provide feedback on content
• Approve content
Types of users:
• Non-modelers (people who were not trained in
MagicDraw nor are equipped with it)
• Modelers
![Page 25: Publishing and reviewing models on the Web · 6 VTL template-based reporting •The Apache Velocity Engine is a free open-source templating engine •Velocity Template Language (VTL)](https://reader034.vdocuments.site/reader034/viewer/2022051606/601671f02854a974663995b6/html5/thumbnails/25.jpg)
25
Supported portals in the final product
• Systems Engineering
• Enterprise Architecture
• Business Architecture
• Software Engineering
• Full model template
![Page 26: Publishing and reviewing models on the Web · 6 VTL template-based reporting •The Apache Velocity Engine is a free open-source templating engine •Velocity Template Language (VTL)](https://reader034.vdocuments.site/reader034/viewer/2022051606/601671f02854a974663995b6/html5/thumbnails/26.jpg)
26
Cameo Collaborator high level
architecture
Cameo Collaborator
Alfresco
+
Extensions created
by No Magic
Publish
model for
review
MagicDraw
Cameo
Collaborator
Publisher
Model
Views &
Viewpoints
model (SysML std.)
Comments
![Page 27: Publishing and reviewing models on the Web · 6 VTL template-based reporting •The Apache Velocity Engine is a free open-source templating engine •Velocity Template Language (VTL)](https://reader034.vdocuments.site/reader034/viewer/2022051606/601671f02854a974663995b6/html5/thumbnails/27.jpg)
27
What is Alfresco?
Alfresco is enterprise-class document management system
• A single repository to manage any kind of electronic file
• Works on-premise and in the cloud
• Simple to use and easy to deploy
• Very extensible
• Has the metamodel underneath that can be customized
• Integrated workflow to manage complex business processes
• Fully-functional Alfresco Community edition available for
free for commercial use, licensed under LGPL v3.0
![Page 28: Publishing and reviewing models on the Web · 6 VTL template-based reporting •The Apache Velocity Engine is a free open-source templating engine •Velocity Template Language (VTL)](https://reader034.vdocuments.site/reader034/viewer/2022051606/601671f02854a974663995b6/html5/thumbnails/28.jpg)
Demo
![Page 29: Publishing and reviewing models on the Web · 6 VTL template-based reporting •The Apache Velocity Engine is a free open-source templating engine •Velocity Template Language (VTL)](https://reader034.vdocuments.site/reader034/viewer/2022051606/601671f02854a974663995b6/html5/thumbnails/29.jpg)
Systems engineer
Manager
Subject matter expert
Demo story
![Page 30: Publishing and reviewing models on the Web · 6 VTL template-based reporting •The Apache Velocity Engine is a free open-source templating engine •Velocity Template Language (VTL)](https://reader034.vdocuments.site/reader034/viewer/2022051606/601671f02854a974663995b6/html5/thumbnails/30.jpg)
Demo story
Systems engineer: publish model
• Publish model to Cameo Collaborator
• Provide reviewers with a link to published model
Subject matter expert (SME), manager: review model
• Log in to Cameo Collaborator
• Make comments for model parts
Systems engineer: react to comments
• Filter unresolved comments
• Navigate to commented places, fix models & resolve comments
![Page 31: Publishing and reviewing models on the Web · 6 VTL template-based reporting •The Apache Velocity Engine is a free open-source templating engine •Velocity Template Language (VTL)](https://reader034.vdocuments.site/reader034/viewer/2022051606/601671f02854a974663995b6/html5/thumbnails/31.jpg)
Demo
• Tracking review progress
• Integrating published models with Wikis
• Customization of appearance and information
fidelity of published models
![Page 32: Publishing and reviewing models on the Web · 6 VTL template-based reporting •The Apache Velocity Engine is a free open-source templating engine •Velocity Template Language (VTL)](https://reader034.vdocuments.site/reader034/viewer/2022051606/601671f02854a974663995b6/html5/thumbnails/32.jpg)
32
Overview
Technology Target user
group
Templates
supported
Commenting
supported
Customization
can be done by
Customization
technology
VTL
templates for
documents
(Word, Excel,
etc.)
Non-
modelers and
modelers
Yes Yes, basic
support
Customer VTL scripting
Web reports Modelers Yes No Customer VTL scripting
Web Portals Non-
modelers and
modelers
Yes Yes, basic
support
No Magic Java coding
Document
Modeling
plugin /
SysML V&V
Non-
modelers and
modelers
Partially No Customer Modeling
Cameo
Collaborator /
SysML V&V
Non-
modelers and
modelers
Yes Yes,
advanced
support
Customer Modeling
![Page 33: Publishing and reviewing models on the Web · 6 VTL template-based reporting •The Apache Velocity Engine is a free open-source templating engine •Velocity Template Language (VTL)](https://reader034.vdocuments.site/reader034/viewer/2022051606/601671f02854a974663995b6/html5/thumbnails/33.jpg)
Thanks!