Meta Model Documentation

Table of Contents

logo-large

Tutorial Actifsource Tutorial – Meta Model Documentation
Required Time - 20 Minutes
Prerequisites - Actifsource Tutorial – Installing Actifsource
- Actifsource Tutorial – Simple Service
Goal - Learn how to document your own Meta Model
- Generating browsable HTML documentation
Topics covered - Meta Model Documentation Builtin model
Notation ↪ To do
ⓘ Information
• Bold: Terms from actifsource or other technologies and tools
• Bold underlined: actifsource Resources
• Monospaced: User input
• Italics: Important terms in current situation
Disclaimer The authors do not accept any liability arising out of the application or use of any information or equipment described herein. The information contained within this document is by its very nature incomplete. Therefore the authors accept no responsibility for the precise accuracy of the documentation contained herein. It should be used rather as a guide and starting point.
Contact Actifsource AG
Täfernstrasse 37
5405 Baden-Dättwil
Switzerland
www.actifsource.com
Trademark Actifsource is a registered trademark of Actifsource AG in Switzerland, the EU, USA, and China. other names appearing on the site may be trademarks of their respective owners.

Overview

  • Install Graphviz
  • Create your meta model
  • Prepare your project
  • Create the documentation model

Part I Install Graphviz

image2 image2

  • Install the graphviz tool from www.graphviz.org
  • Make sure that graphviz is added to your system path
  • The Actifsource meta model documentation generator is looking for the graphviz executable dot.exe in your system path.

Part II Create your meta model

  • Create a simple meta model as shown in the Actifsource Tutorial Simple Service
  • We recommend to make a new project for this tutorial ch.actifsource.tutorial.metamodel.docu
  • Make sure to use a Class Diagram for the meta model design

Create your meta model

image3 image3

  • Create a simple meta model as shown in the Actifsource Tutorial Simple Service
  • Use a Class Diagram named Design

image4 image4

  • Add proper comments to all classes, relations and attributes

Part III Prepare your project

  • Add a Builtin Dependency to DOCUMENTATION_METAMODEL
  • Add a target folder to generate the documentation

Prepare your project

image5 image5

  • Open the properties of your project
  • Add a Builtin Dependency to DOCUMENTATION_METAMODEL

image6 image6

  • Open the properties of your project
  • Add a new Target Folder docu
  • Add the Build Config Documentation_MetaModel_html to the Target Folder
  • Make sure you have added the Builtin Dependency to DOCUMENTATION_METAMODEL before

Part IV Create the documentation model

  • Instantiate a new resource of type Documentation
  • Add chapters and sub chapters to your documentation

Create the documentation model

image7 image7

  • Select a resource folder
  • Create a new resource of type Documentation using the new resource tool

image8 image8

Create a new resource named Service Documentation of type Documentation

image9 image9

  • Open the resource Service Documentation
  • Add some descriptions where needed
  • Add a new Chapter named Service Design
  • Make sure to refer to your Class Diagram named Design
  • Save your resource

image10 image10

  • Find the generated html documentation in the Target Folder docu

actifsource-point-large