In this Webinar, two Capella adds-on are presented and demonstrated: - Team for Capella : a tool that allows users to allows users to collaborate on remotely shared models and representations - M2Doc : a tool that automates the production of MS Word™ files from models

1. ©copyright2017Obeo
ThisdocumentisthepropertyofObeoandcannotbetransmittedwithoutpriorwrittenagreement
How to Collaborate and Generate Documents
with Capella?
21 Nov. 2017
Laurent DELAIGUE

2. ©copyright2017Obeo
ThisdocumentisthepropertyofObeoandcannotbetransmittedwithoutpriorwrittenagreement
Requirements
• Interoperate with Req.
Mgt. Tools
• Import/export
Requirements
Document Generation
• Excel Import/export
• Generate HTML reports
• Generate rich
documents
Multi-User Collaboration
How can we efficiently
collaborate on a single
Capella model?
Open-sourced in 2015

3. ©copyright2017Obeo
ThisdocumentisthepropertyofObeoandcannotbetransmittedwithoutpriorwrittenagreement
Requirements
• Interoperate with Req.
Mgt. Tools
• Import/export
Requirements
Document Generation
• Excel Import/export
• Generate HTML reports
• Generate rich
documents
Multi-User Collaboration
How can we efficiently
collaborate on a single
Capella model?
M2Doc
Rich document generation
from Capella models
Team for Capella
Real-time collaborative
editing of Capella models
with fine-grained lock
management
Document Generation
• Excel Import/export
• Generate HTML reports
• Generate rich
documents
Open-sourced in 2015

4. ©copyright2017Obeo
ThisdocumentisthepropertyofObeoandcannotbetransmittedwithoutpriorwrittenagreement
TEAM FOR CAPELLA
Collaborating on Capella Models

5. ©copyright2017Obeo
ThisdocumentisthepropertyofObeoandcannotbetransmittedwithoutpriorwrittenagreement
Team for Capella – Collaborate?
• Why?
– To get rid of file sharing problems
• How?
– Shared repository
– Locks at model element granularity
– Locks and update mechanisms automatic

6. ©copyright2017Obeo
ThisdocumentisthepropertyofObeoandcannotbetransmittedwithoutpriorwrittenagreement
Team for Capella – Scope
• Team for Capella is
– A tool to manage collaboration on Capella models
• Team for Capella is not
– A tool to manage versions and configurations

7. ©copyright2017Obeo
ThisdocumentisthepropertyofObeoandcannotbetransmittedwithoutpriorwrittenagreement
Team for Capella - Principles
v1
v2

8. ©copyright2017Obeo
ThisdocumentisthepropertyofObeoandcannotbetransmittedwithoutpriorwrittenagreement
v1
v2
Team for Capella - Principles
Checkout

9. ©copyright2017Obeo
ThisdocumentisthepropertyofObeoandcannotbetransmittedwithoutpriorwrittenagreement
v1
v2
Team for Capella - Principles

10. ©copyright2017Obeo
ThisdocumentisthepropertyofObeoandcannotbetransmittedwithoutpriorwrittenagreement
v1
v2
Team for Capella - Principles
Checkin

11. ©copyright2017Obeo
ThisdocumentisthepropertyofObeoandcannotbetransmittedwithoutpriorwrittenagreement
v1
v2
Team for Capella - Principles

12. ©copyright2017Obeo
ThisdocumentisthepropertyofObeoandcannotbetransmittedwithoutpriorwrittenagreement
v1
v2
Team for Capella - Principles
Checkinv3

13. ©copyright2017Obeo
ThisdocumentisthepropertyofObeoandcannotbetransmittedwithoutpriorwrittenagreement
v1
v2
Team for Capella - Principles
v3

14. ©copyright2017Obeo
ThisdocumentisthepropertyofObeoandcannotbetransmittedwithoutpriorwrittenagreement
Team for Capella - Principles
Checkout
v1
v2
v3

15. ©copyright2017Obeo
ThisdocumentisthepropertyofObeoandcannotbetransmittedwithoutpriorwrittenagreement
Team for Capella - Principles
v1
v2
v3

16. ©copyright2017Obeo
ThisdocumentisthepropertyofObeoandcannotbetransmittedwithoutpriorwrittenagreement
Team for Capella - Principles
Checkin
v1
v2
v3
v4

17. ©copyright2017Obeo
ThisdocumentisthepropertyofObeoandcannotbetransmittedwithoutpriorwrittenagreement
TEAM FOR CAPELLA − DEMO
Collaborating on Capella Models

18. ©copyright2017Obeo
ThisdocumentisthepropertyofObeoandcannotbetransmittedwithoutpriorwrittenagreement
Team for Capella – Roadmap
• https://www.obeo.fr/en/capella-professional-offer
• Current version: Team for Capella 1.1.2
– Compatible with Capella 1.1.2
• Team for Capella 1.2.0 in January 2018
– Compatible with Capella 1.2
• Each year, at least 1 major and 1 minor release

19. ©copyright2017Obeo
ThisdocumentisthepropertyofObeoandcannotbetransmittedwithoutpriorwrittenagreement
Team for Capella - Keypoints
• Collaboration on a centralized model
stored in a database
• Real-time edition and change propagation
• Fine-grained locking prevents conflicts
• Commercial offer by Obeo
• Not intended to replace
version & configuration management

20. ©copyright2017Obeo
ThisdocumentisthepropertyofObeoandcannotbetransmittedwithoutpriorwrittenagreement
M2DOC
Generating rich Documents

21. ©copyright2017Obeo
ThisdocumentisthepropertyofObeoandcannotbetransmittedwithoutpriorwrittenagreement
M2Doc – What For?
• Written Documents are necessary
– To transmit information to people who will not
use Capella directly
– To fulfil certain obligations
• The Model should be the reference
• Documents can support
– Model Analysis,
– Review preparation,
– Etc.

22. ©copyright2017Obeo
ThisdocumentisthepropertyofObeoandcannotbetransmittedwithoutpriorwrittenagreement
M2Doc History
CASID/DGSIC
(French Department of Defense)
© Alexander W. Galbraith - This image is available from the City of Toronto Archives, listed under the archival citation Fonds 1568, Item 177.

23. ©copyright2017Obeo
ThisdocumentisthepropertyofObeoandcannotbetransmittedwithoutpriorwrittenagreement
M2Doc – Basic Principles
M2Doc
Template
Model
Document

24. ©copyright2017Obeo
ThisdocumentisthepropertyofObeoandcannotbetransmittedwithoutpriorwrittenagreement
Document
M2Doc – Basic Principles
M2Doc
Template
ModelModel
Document
A380
Technical specifications –DDE-H35
Applicable Documents
Lorem ipsum dolor sit amet
Lorem ipsum dolor sit amet
Lorem ipsum
dolor sit amet
lorem ipsum
dolor sit amet
dolorem ipsu
m dolor sit am

25. ©copyright2017Obeo
ThisdocumentisthepropertyofObeoandcannotbetransmittedwithoutpriorwrittenagreement
Document
A380
Technical specifications –DDE-H35
Applicable Documents
Lorem ipsum dolor sit amet
Lorem ipsum dolor sit amet
Lorem ipsum
dolor sit amet
lorem ipsum
dolor sit amet
dolorem ipsu
m dolor sit am
M2Doc – Basic Principles
M2Doc
Template
Model
Template B
Template C
Document B
A380
General Overview –DDE-H35
Applicable Documents
Lorem ipsum dolor sit amet
Document C
A380
Structure Breakdown –DDE-H35
Applicable Documents
ipsum dolor sit amet meae quam

26. ©copyright2017Obeo
ThisdocumentisthepropertyofObeoandcannotbetransmittedwithoutpriorwrittenagreement
M2Doc – Involved Roles
Capella Expert
• Creates and tests
reusable services
• Registers services
Template Author
• Creates M2Doc
templates
• Uses AQL services
• Tests and debugs
templates
End-User
• Produces documents
by running M2Doc
templates
• Enters and maintains
‘user text’ in
generated documents
These are just roles
Can be 1, 2, or 3 persons or teams
depending on complexity, organization, and context
Template Author and Capella Expert can be sub-contracted

27. ©copyright2017Obeo
ThisdocumentisthepropertyofObeoandcannotbetransmittedwithoutpriorwrittenagreement
M2Doc – Added Value
• Ease of use
– Both for the end user and the templatist
• Maintainability
– Powerful and reliable error reporting
• Performance
– Hundreds of pages in seconds
• Can be used in automated workflows

28. ©copyright2017Obeo
ThisdocumentisthepropertyofObeoandcannotbetransmittedwithoutpriorwrittenagreement
M2DOC − DEMO
END-USER PERSPECTIVE
Generating rich Documents

29. ©copyright2017Obeo
ThisdocumentisthepropertyofObeoandcannotbetransmittedwithoutpriorwrittenagreement
Writing Templates
• Plain MS Word™ document (.docx files)
• Use Alt+F9 to activate fields
• Use Ctrl+F9 to insert fields
• M2Doc syntax is very simple

30. ©copyright2017Obeo
ThisdocumentisthepropertyofObeoandcannotbetransmittedwithoutpriorwrittenagreement
{ m:xxx … }

31. ©copyright2017Obeo
ThisdocumentisthepropertyofObeoandcannotbetransmittedwithoutpriorwrittenagreement
Simple query
{ m:actor.name } is an Actor
Aircraft is an Actor

32. ©copyright2017Obeo
ThisdocumentisthepropertyofObeoandcannotbetransmittedwithoutpriorwrittenagreement
Loop
• Function: Play Sound in Cabin
• Function: Provide Navigation
Data
{ m:for function|
actor.allocatedFunctions}
• Function: {m:function.name}
{ m:endfor }

33. ©copyright2017Obeo
ThisdocumentisthepropertyofObeoandcannotbetransmittedwithoutpriorwrittenagreement
Loop
{ m:for func| actor.allocatedFunctions}
{ m:endfor }
Provide Navigation
Data
Summary of Provide navigation Data
Play Sound in Cabin Summary of play sound in cabin
… …
{m:func.name} {m:func.summary}

34. ©copyright2017Obeo
ThisdocumentisthepropertyofObeoandcannotbetransmittedwithoutpriorwrittenagreement
Conditional
{ m:if <some condition> }
…
{ m:else if …}
…
{ m:else }
…
{ m:endif }
Optional

35. ©copyright2017Obeo
ThisdocumentisthepropertyofObeoandcannotbetransmittedwithoutpriorwrittenagreement
User Doc
{m:userdoc <queryID>}
…
{m:enduserdoc}
• Supports Incremental Generation

36. ©copyright2017Obeo
ThisdocumentisthepropertyofObeoandcannotbetransmittedwithoutpriorwrittenagreement
Bookmark and Link
{m:bookmark <queryID>}
…
{m:endbookmark}
{m:link <queryID> <queryText>}

37. ©copyright2017Obeo
ThisdocumentisthepropertyofObeoandcannotbetransmittedwithoutpriorwrittenagreement
Insert Diagrams
Dedicated services are available:
- By diagram name
- By description name
{m:for im
|package.asImageByRepresentationDescript
ionName('Missions Capabilities Blank')}
{im.fit(500,500)}
{m:endfor}

38. ©copyright2017Obeo
ThisdocumentisthepropertyofObeoandcannotbetransmittedwithoutpriorwrittenagreement
Validation
{ m:actor. } is an Actor
{ m:actor. } <---Expression "actor." is invalid:
missing feature access or service call is an
Actor

39. ©copyright2017Obeo
ThisdocumentisthepropertyofObeoandcannotbetransmittedwithoutpriorwrittenagreement
M2DOC − DEMO
TEMPLATIST PERSPECTIVE
Generating rich Documents

40. ©copyright2017Obeo
ThisdocumentisthepropertyofObeoandcannotbetransmittedwithoutpriorwrittenagreement
M2Doc – Roadmap
• Official site: http://www.m2doc.org/
• Open-Source EPL v1.0 license
• Current status: M2Doc v1.0
– Compatible with Capella 1.1.x and Capella 1.2
– Dedicated tutorial at http://www.m2doc.org/capella/
• V1.1.0 in December 2017
– Stabilization of current features
– Improvement of integration with Capella & Obeo Designer
• Next release around March 2018
– Content definition in progress
– Will depend on community’s feedback

41. ©copyright2017Obeo
ThisdocumentisthepropertyofObeoandcannotbetransmittedwithoutpriorwrittenagreement
M2Doc – Keypoints
• Produces MS Word™ documents
from Capella Models (or any model)
• Can include Capella Diagrams & Tables
• Simple Syntax and Ease of Use
• Incremental Generation
• Templates in MS Word ™ directly
• Usable error reporting
• Good performance

42. ©copyright2017Obeo
ThisdocumentisthepropertyofObeoandcannotbetransmittedwithoutpriorwrittenagreement