Difference between revisions of "OS.bee Tutorial"

From OS.bee documentation
Jump to: navigation, search
(Use cases)
(OS.bee Tutorial)
Line 4: Line 4:
  
 
'''My1App''' is a personal administration application consisting of a collection of models based on OS.bee Domain Specific Languages. It is generated by Eclipse wizards; the wizards build the Eclipse workspace, provide the basic structure and a number of consistent objects of models.
 
'''My1App''' is a personal administration application consisting of a collection of models based on OS.bee Domain Specific Languages. It is generated by Eclipse wizards; the wizards build the Eclipse workspace, provide the basic structure and a number of consistent objects of models.
 
You can step by step expand the rudimentary person administration (which has only basic configuration) with the user stories described in the storyboard, and then generate an employee administration based on your new person administration.
 
  
 
We use the "2BEE concept":  
 
We use the "2BEE concept":  
# describe the requirements from the point of a fictive user with using storyboard which mentioned above
+
# describe the requirements from the point of a fictive user with using story map
 
# technically implement the requirements of user
 
# technically implement the requirements of user
 +
 +
You can step by step expand the rudimentary person administration (which has only basic configuration) with the user stories described in the story map, and then generate an employee administration based on your new person administration.
 +
  
 
Please notice:
 
Please notice:
Line 15: Line 16:
 
* Each tutorial user stories are independent from each other; you don’t need to totally complete the tutorial in once.
 
* Each tutorial user stories are independent from each other; you don’t need to totally complete the tutorial in once.
  
==Story board==
+
==Tasks==
 
+
===Tasks===
+
  
 
The task for the user of this tutorial is first the administration of personal data and then the main task is the administration of employee data.
 
The task for the user of this tutorial is first the administration of personal data and then the main task is the administration of employee data.
  
===Story map===
+
==Requirement==
[[File:Tutorial_story_map_1.png|800px]]<br>
+
[[File:Tutorial_story_map_2.png|700px]]<br><br>
+
 
+
===Requirement===
+
  
 
'''My1App''' is a personal administration application consisting of a collection of models based on OS.bee Domain Specific Languages. It is generated by Eclipse wizards; the wizards build the Eclipse workspace, provide the basic structure and a number of consistent objects of models.  
 
'''My1App''' is a personal administration application consisting of a collection of models based on OS.bee Domain Specific Languages. It is generated by Eclipse wizards; the wizards build the Eclipse workspace, provide the basic structure and a number of consistent objects of models.  
Line 37: Line 32:
 
[[File:Tutorial_person_view.png]]
 
[[File:Tutorial_person_view.png]]
  
===Use cases===
+
==Use cases==
 
The personal administration should be extended by the following use cases:
 
The personal administration should be extended by the following use cases:
 
* change address  
 
* change address  
Line 54: Line 49:
 
* evaluate employee
 
* evaluate employee
  
===User stories===
 
====Administration of personal data====
 
=====Change the address=====
 
=====search person with full-name=====
 
  
=====Establish current age=====
+
==Story map==
=====Add profile photo=====
+
[[File:Tutorial_story_map_1.png|800px]]<br>
=====Add gender=====
+
[[File:Tutorial_story_map_2.png|700px]]<br><br>
=====Add marital status=====
+
 
 +
==User stories==
 +
===Administration of personal data===
 +
====Change the address====
 +
====search person with full-name====
 +
 
 +
====Establish current age====
 +
====Add profile photo====
 +
====Add gender====
 +
====Add marital status====
  
====Administration of employee data====
+
===Administration of employee data===
=====Create new entity of employee=====
+
====Create new entity of employee====
=====Hire employee=====
+
====Hire employee====
=====Fire employee=====
+
====Fire employee====
=====Increase salary of employee =====
+
====Increase salary of employee ====
  
=====Assign employee=====
+
====Assign employee====
=====Transfer employee=====
+
====Transfer employee====
=====Evaluate employee=====
+
====Evaluate employee====

Revision as of 12:57, 19 July 2018

OS.bee Tutorial

This tutorial will introduce the architecture, technology and functionality of OS.bee using basic OS.bee application My1App.

My1App is a personal administration application consisting of a collection of models based on OS.bee Domain Specific Languages. It is generated by Eclipse wizards; the wizards build the Eclipse workspace, provide the basic structure and a number of consistent objects of models.

We use the "2BEE concept":

  1. describe the requirements from the point of a fictive user with using story map
  2. technically implement the requirements of user

You can step by step expand the rudimentary person administration (which has only basic configuration) with the user stories described in the story map, and then generate an employee administration based on your new person administration.


Please notice:

  • The task solutions described in the tutorial can often be solved either by DSL code or graphic modeling. We will present both solutions if possible. You can use any one of them as you will.
  • Each tutorial user stories are independent from each other; you don’t need to totally complete the tutorial in once.

Tasks

The task for the user of this tutorial is first the administration of personal data and then the main task is the administration of employee data.

Requirement

My1App is a personal administration application consisting of a collection of models based on OS.bee Domain Specific Languages. It is generated by Eclipse wizards; the wizards build the Eclipse workspace, provide the basic structure and a number of consistent objects of models. So before executing the tutorial steps in this tutorial using My1App, the appropriate wizards must be installed. You can find more information about installation in doc of My1App.

My1App has the following basic objects:

  • The superclass BaseID, which has only one attribute identifier (id) as UUID (See UUID). It is the technical key as a basis of identification and it is an obligation for all entities.
  • The entity Person , which inherits the identifier attribute (id) from the superclass BaseID and has additional personal attributes.

The following vertically divided person-view represent the entity Person in My1App, on the left side is the Person-Table and on the right side is the Person-Dialog: Tutorial person view.png

Use cases

The personal administration should be extended by the following use cases:

  • change address
  • search person with full-name
  • establish current age of person
  • add profile picture
  • add gender
  • add marital status

The expected employee administration is described by the following use cases:

  • hire employee
  • fire employee
  • increase salary of employee
  • assign employee
  • transfer employee
  • evaluate employee


Story map

Tutorial story map 1.png
Tutorial story map 2.png

User stories

Administration of personal data

Change the address

search person with full-name

Establish current age

Add profile photo

Add gender

Add marital status

Administration of employee data

Create new entity of employee

Hire employee

Fire employee

Increase salary of employee

Assign employee

Transfer employee

Evaluate employee