OS.bee documentation - User contributions [en]

Strategy DSL

2017-09-04T17:41:27Z

Cmollik: Created page with "==Introduction== ===ECView=== ECView is an osgi framework that allows you to automatically render form-based user interfaces based on an EMF (Eclipse Modeling Framework)-bas..."

==Introduction==

===ECView===

ECView is an osgi framework that allows you to automatically render form-based user interfaces based on an EMF (Eclipse Modeling Framework)-based UI model. Business data in the form of JPA (Java Persistence Appication Programming Interface) Entities or DTOs (Data Transfer Objects) can be automatically linked to the UI elements. ECView has been designed with extremely careful attention to modularity, extensibility and independence from the Concrete UI technology. It consists of an API (Appication Programming Interface) layer, an EMF model layer, a controller layer and a presenter layer. Exclusively the presenter layer has dependencies to the used UI framework, such as Vaadin. The use of other frameworks requires only the integration of other presenters. The integration of ECView into the system gives us the possibility to provide business forms "out of the box" without code generation or without manual writing of UI code and connect to a database.

===1.2 Vaadin Layout Components===

Vaadin dialog provieds a few Layout Components, we will use some of them in our DSL:

* FormLayout lays the components and their captions out in two columns, with optional indicators for required fields and errors that can be shown for each field.
 [[File:StrategyDSL01.png]] 
* GridLayout container lays components out on a grid consisting of rows and columns.
 [[File:StrategyDSL02.png]] 
* VerticalLayout is ordered layouts for laying components out vertically.
 [[File:StrategyDSL03.png]] 
* HorizontalLayout is ordered layouts for laying components out horizontally.
 [[File:StrategyDSL04.png]] 
* CSSLayout allows strong control over styling of the components contained inside the layout.
 [[File:StrategyDSL05.png]] 

==StrategyDSL==

The StrategyDSL works for Os.bee models; it defines the display strategies of dialog model.

It defines not only the layout strategy, but also the focusing strategy.

User can select the predefined Strategy for the dialog view:
 [[File:StrategyDSL06.png]] 

The main semantic elements of the StrategyDSL are:
* “package” - the root element that contains all the other elements. A model can contain multiple packages.
* “strategy” - define the strategy rules for dialog.
* “targets” - define the strategy details, including layouting strategy, focusing strategy and focusing enhancer.
* “default” - define the default strategy including layouting and focusing.

===Syntax===

====package definition====

► '''Syntax''':
<syntaxhighlight lang="java">
package <package name>
[{
strategy {
targets [{
layoutingStrategy . . .
. . .
focusingStrategy . . .
. . .
focusingEnhancer . . .
. . .
}]

default {
. . .
}
}

}]
</syntaxhighlight>

► '''Example''':
<syntaxhighlight lang="java">
package net.osbee.sample.foodmart.strategies {
strategy {
targets {
layoutingStrategy Form2Columns layout= Form2
layoutingStrategy Form3Colums layout= Form3
layoutingStrategy ^Horizontal layout= Horizontal
layoutingStrategy ^Vertical layout= Vertical
layoutingStrategy ^Grid layout= Grid
layoutingStrategy ^Css layout= Css
focusingStrategy GenAltEnter
ecviewFocusingId= cxAltEnterForward
focus= Forward
keyStrokeDefinition {
keyCode= ENTER modifierKeys {
ALT
}
}
focusingStrategy GenEnter
ecviewFocusingId= cxEnterForward
focus= Forward
keyStrokeDefinition {
keyCode= ENTER
}
focusingStrategy GenTab
ecviewFocusingId= cxEnTabForward
focus= Forward
keyStrokeDefinition {
keyCode= TAB
}
focusingEnhancer GenEnterTab {
GenEnter GenTab
}
}
default {
defaultLayouting= Form2Columns defaultFocusing= GenEnterTab
}
}
}
</syntaxhighlight>

====targets====

Keyword <code>targets</code> is used to define the target strategy and enhancer. There are 3 types of target to be defined, they are '''layoutingStrategy, focusingStrategy''' and '''focusingEnhancer'''. One or more '''layoutingStrategy, focusingStrategy''' and '''focusingEnhancer''' can be defined in the same targets.

► '''Syntax''':
<syntaxhighlight lang="java">
targets [{
layoutingStrategy <layoutingStrategy name>
layout=LayoutingType
. . .

focusingStrategy <focusingStrategy name> ecviewFocusingId= <ecviewFocusingId> focus=FocusingType
[keyStrokeDefinition {
keyCode= <keyCode ID>
[modifierKeys { <modifierKeys ID>. . .}]
}]
. . .

focusingEnhancer <enhancer name> {
<focusingStrategy name>
. . .
}
. . .
}]
</syntaxhighlight>

=====layoutingStrategy=====

For <code>layoutingStrategy</code>, strategy name and layout type must be defined.
* One or more <code>layoutingStrategy</code> can be defined in the same targets.
* <code>LayoutingType can be <code>Horizontal, Vertical, Grid, Form2, Form3 or Css</code>. They are all predefined layouting type.
* 2 java files will be generated for each layouting strategy in folder <code>./src-gen/<package name>/:</code> 
<code><strategy name>+LayoutingStrategy.java</code> 
<code><strategy name>+LayoutingStrategy+Provider.java</code> 

► '''Example''':
<syntaxhighlight lang="java">
targets {
layoutingStrategy GenForm2 layout=Form2
layoutingStrategy GenForm3 layout=Form3
layoutingStrategy GenHorizontal layout=Horizontal
layoutingStrategy GenVertical layout=Vertical
layoutingStrategy GenGrid layout=Grid
layoutingStrategy GenCss layout=Css
. . .
}
</syntaxhighlight>

In this example, 6 '''layoutingStrategy''' are defined in '''targets'''. From the following picture, you could see the place where the defined strategies can be selected.

If you select '''layoutingStrategy''' “GenForm3”, then the dialog will have 3 columns:
 [[File:StrategyDSL07.png]] 
 [[File:StrategyDSL08.png]] 

=====focusingStartegy=====

For '''focusingStrategy''', strategy name, ecview focusing id and focus type must be defined.
* One or more '''focusingStrategy''' can be defined in the same '''targets'''.
* FocusingType can be '''Forward''' or '''Backward'''. They are all predefined focusing type.
* Keyword '''keyStrokeDefinition''' is optional. One '''keyCode''' should be defined here. '''modifierKeys''' is optional. One or more modifier keys id could be defined in the same '''modifierKeys''' part.
* 2 java files will be generated for each focusing strategy in folder <code>./src-gen/<package name>/:</code> 
<code><strategy name> + <focusing type> + FocusingStrategy.java</code> 
<code><strategy name> + <focusing type>+ FocusingStrategy + Provider.java</code>

► '''Example''':
<syntaxhighlight lang="java">
targets {
. . .
focusingStrategy GenAltEnter
ecviewFocusingId= cxAltEnterForward
focus= Forward
keyStrokeDefinition {
keyCode= ENTER modifierKeys {
ALT
}
}
. . .
}
</syntaxhighlight>

In this example, a '''focusingStrategy''' '''''GenAltEnter''''' is defined in '''targets'''.
The ecviewFocusingId must be defined for the ECView. The following code will be generated in
GenAltEnterForwardFocusingStrategyProvider.java file:

<syntaxhighlight lang="java">
@Component(immediate = true, service = IFocusingStrategyProvider.class, property = "ecview.focusing.id=cxAltEnterForward")
@SuppressWarnings("all")
public class GenAltEnterForwardFocusingStrategyProvider implements IFocusingStrategyProvider {
private final static String ID = "cxAltEnterForward";

@Override
public IFocusingStrategy getStrategy() {
return new GenAltEnterForwardFocusingStrategy();
}
}
</syntaxhighlight>

In the '''keyStrokeDefinition''' part, '''keyCode''' is defined as ENTER and the '''modifierKeys''' is ALT.

The following code will be generated in GenAltEnterForwardFocusingStrategy.java file:

<syntaxhighlight lang="java">
@Override
public KeyStrokeDefinition getKeyStrokeDefinition() {
int[] modifierKeys = new int[1];
modifierKeys[0] = ModifierKey.ALT;
KeyStrokeDefinition def = new KeyStrokeDefinition("", KeyCode.ENTER, modifierKeys);
return def;
}
</syntaxhighlight>

=====focusingEnhancer=====

For '''focusingEnhancer''', enhancer name must be defined.
* One or more and predefined focusing strategy name should be listed.
* Only 1 java file will be generated in folder ./src-gen/<package name>/, its name is <enhancer name>+FocusingEnhancer.java.

Following code will be generated in <enhancer name>+FocusingEnhancer.java file:

<syntaxhighlight lang="java">
@Component(property="ecview.focusing.enhancer.id=<enhancerName>FocusingEnhancer")
@SuppressWarnings("all")
public class <enhancer name>FocusingEnhancer implements IFocusingEnhancer {
@Override
public void enhanceFocusing(final YStrategyLayout yLayout) {
yLayout.getFocusingStrategies().clear();
//from here is one loop for every listed focusingStrategy
YDelegatingFocusingStrategy yStgy<number from 1 to n> = YECviewFactory.eINSTANCE.createYDelegatingFocusingStrategy();
yStgy<number from 1 to n>.setDelegateStrategyId("<ecviewFocusingId of focusingStrategy>");
yLayout.getFocusingStrategies().add(yStgy<number from 1 to n>);
//loop end
}
}
</syntaxhighlight>

► '''Example''':
<syntaxhighlight lang="java">
targets {
. . .
focusingEnhancer GenEnterTab {
GenEnter GenTab
}
}
</syntaxhighlight>

====default====

Keyword default is used to define the default strategy.
* There are 2 types of default strategy to be defined, they are '''defaultLayouting''' and '''defaultFocusing'''. You must to define one and only one '''defaultLayouting''' and '''defaultFocusing''' for your strategy.
* For the default part, 3 .java files will be generated, they are DefaultFocusingEnhancer.java, DefaultLayoutingStrategy,java and DefaultLayoutingStrategyProvider.java. All the .java files are generated in folder ./src-gen/<package name>/.

► '''Syntax''':
<syntaxhighlight lang="java">
default {

defaultLayouting=<layoutingStrategy name>

defaultFocusing=<focusingStrategy name>

}
</syntaxhighlight>

► '''Example''':
<syntaxhighlight lang="java">
default {
defaultLayouting=GenForm2 defaultFocusing=GenEnterTab
}
</syntaxhighlight>

In the examples, '''focusingStrategy''' '''''GenEnterTab''''' is defined to be used as '''defaultFocusing''' in Dialog; '''layoutingStrategy''' '''''GenForm2''''' is defined to be used as '''''defaultLayouting''''' in Dialog. Standard strategy is the ''defaultLayouting'' “GenForm2”, which have 2 columns:
 [[File:StrategyDSL09.png]] 
 [[File:StrategyDSL10.png]]

File:StrategyDSL10.png

2017-09-04T17:38:52Z

Cmollik:

File:StrategyDSL09.png

2017-09-04T17:38:46Z

Cmollik:

File:StrategyDSL08.png

2017-09-04T17:38:39Z

Cmollik:

File:StrategyDSL07.png

2017-09-04T17:38:33Z

Cmollik:

File:StrategyDSL06.png

2017-09-04T17:38:25Z

Cmollik:

File:StrategyDSL05.png

2017-09-04T17:38:18Z

Cmollik:

File:StrategyDSL04.png

2017-09-04T17:38:11Z

Cmollik:

File:StrategyDSL03.png

2017-09-04T17:38:05Z

Cmollik:

File:StrategyDSL02.png

2017-09-04T17:37:58Z

Cmollik:

File:StrategyDSL01.png

2017-09-04T17:34:04Z

Cmollik:

OS.bee Software Factory Documentation

2017-09-04T17:33:33Z

Cmollik: /* Menu DSL */

=OS.bee DSL Documentation=
The ''OS.bee Software Factory'' is composed of various domain specific languages (DSLs), which are described in detail on the following pages.

==[[Entity DSL]]==
The [[Entity DSL]] is, beside Datatypes, the basic DSL for the Software Factory. It allows you, through the creation of entity model files, to describe the entity relationship models that will be used to create, read, update and delete content on a persistence level, such as with an SQL database.

==[[DTO DSL]]==
The [[DTO DSL]] handles data transfer objects in order to transfer data between processes. It uses the [[Entity DSL]].

==[[Chart DSL]]==
The [[Chart DSL]] provides Vaadin dCharts.

==[[Cube DSL]]==
The [[Cube DSL]] provides MDX access to Mondrian OLAP Cubes.

==[[Datamart DSL]]==
A datamart is a condensed and more focused version of a data warehouse that reflects the regulations and process specifications of each business unit within an organization. Each datamart is dedicated to a specific business function or region.

==[[Dialog DSL]]==
The [[Dialog DSL]] generates the [https://vaadin.com/home Vaadin] UI

==[[Datainterchange DSL]]==
The [[Datainterchange DSL]] provides import and export functionalities. While all the basic components and interfaces for its usage are defined inside its API package, extended (commercial) features are implemented and based on the [https://www.smooks.org/ Smooks] framework.

==[[Report DSL]]==
The [[Report DSL]] generates the [https://vaadin.com/home Vaadin] UI and the [http://developer.actuate.com/about/ BIRT] report module.

==[[Table DSL ]]==
The [[Table DSL]] generates the [https://vaadin.com/home Vaadin] table UI.

==[[Topology DSL ]]==
The [[Topology DSL]] generates [https://d3js.org/ D3.js], a JavaScript library for manipulating documents based on data, to generate the visualization of topology charts. Data used is [https://github.com/topojson topojson], an extension of [http://geojson.org/ GeoJSON] that encodes topology and the corresponding UI components.

==[[Entitymock DSL]]==
The [[Entitymock DSL]] generates mock data for entity models automatically upon initialization.

==[[Statemachine DSL]]==
The [[Statemachine DSL]] adds behavior to user interfaces. Instances of this DSL interconnect UI instances, FunctionLibrary instances, persistence layers and peripheral devices, and therefore act as controllers in a multiple Model-View-Controller environment. There is no limitation of how many statemachine instances control a single business application.

==[[Authorization DSL]]==

AuthorizationDSL is used to authorize the roles at runtime.

==[[Organization DSL]]==

OrganizationDSL is used to define the organizations and their positions.

==[[Perspective DSL]]==

Os.bee Applications which are generated using the OS.bee software factory have by default a front end based on the E4-UI-Model.

==[[Action DSL]]==

==[[Menu DSL]]==

Menu model is used for the UI menu definition.

==[[Strategy DSL]]==

==[[How to add pictures]]==

=OS.bee-Specific DSL Instances=
The ''OS.bee Software Factory'' provides a few specific DSL instances for different requirements. These are described in detail on the following pages.

==Datatypes==
Several custom datatypes are described in detail in this chapter.
===[[BlobMapping]]===
This datatype allows the use of big data as a blob.

=Other OS.bee-Specific Solutions=
The ''OS.bee Software Factory'' also provides other solutions, which are described in detail on the following pages.

==[[Themes]]==

=OS.bee Third-Party Software Solutions=
OS.bee also uses products of other software vendors (third-party products) that are based on open-source products.

==[[Peripheral Devices]]==

OS.bee Software Factory Documentation

2017-07-26T21:19:35Z

Cmollik: /* Menu DSL */

=OS.bee DSL Documentation=
The ''OS.bee Software Factory'' is composed of various domain specific languages (DSLs), which are described in detail on the following pages.

==[[Entity DSL]]==
The [[Entity DSL]] is, beside Datatypes, the basic DSL for the Software Factory. It allows you, through the creation of entity model files, to describe the entity relationship models that will be used to create, read, update and delete content on a persistence level, such as with an SQL database.

==[[DTO DSL]]==
The [[DTO DSL]] handles data transfer objects in order to transfer data between processes. It uses the [[Entity DSL]].

==[[Chart DSL]]==
The [[Chart DSL]] provides Vaadin dCharts.

==[[Cube DSL]]==
The [[Cube DSL]] provides MDX access to Mondrian OLAP Cubes.

==[[Datamart DSL]]==
A datamart is a condensed and more focused version of a data warehouse that reflects the regulations and process specifications of each business unit within an organization. Each datamart is dedicated to a specific business function or region.

==[[Dialog DSL]]==
The [[Dialog DSL]] generates the [https://vaadin.com/home Vaadin] UI

==[[Report DSL]]==
The [[Report DSL]] generates the [https://vaadin.com/home Vaadin] UI and the [http://developer.actuate.com/about/ BIRT] report module.

==[[Table DSL ]]==
The [[Table DSL]] generates the [https://vaadin.com/home Vaadin] table UI.

==[[Topology DSL ]]==
The [[Topology DSL]] generates [https://d3js.org/ D3.js], a JavaScript library for manipulating documents based on data, to generate the visualization of topology charts. Data used is [https://github.com/topojson topojson], an extension of [http://geojson.org/ GeoJSON] that encodes topology and the corresponding UI components.

==[[Entitymock DSL]]==
The [[Entitymock DSL]] generates mock data for entity models automatically upon initialization.

==[[Statemachine DSL]]==
The [[Statemachine DSL]] adds behavior to user interfaces. Instances of this DSL interconnect UI instances, FunctionLibrary instances, persistence layers and peripheral devices, and therefore act as controllers in a multiple Model-View-Controller environment. There is no limitation of how many statemachine instances control a single business application.

==[[Authorization DSL]]==

AuthorizationDSL is used to authorize the roles at runtime.

==[[Organization DSL]]==

OrganizationDSL is used to define the organizations and their positions.

==[[Perspective DSL]]==

Os.bee Applications which are generated using the OS.bee software factory have by default a front end based on the E4-UI-Model.

==[[Action DSL]]==

==[[Menu DSL]]==

Menu model is used for the UI menu definition.

==[[How to add pictures]]==

=OS.bee-Specific DSL Instances=
The ''OS.bee Software Factory'' provides a few specific DSL instances for different requirements. These are described in detail on the following pages.

==Datatypes==
Several custom datatypes are described in detail in this chapter.
===[[BlobMapping]]===
This datatype allows the use of big data as a blob.

=Other OS.bee-Specific Solutions=
The ''OS.bee Software Factory'' also provides other solutions, which are described in detail on the following pages.

==[[Themes]]==

=OS.bee Third-Party Software Solutions=
OS.bee also uses products of other software vendors (third-party products) that are based on open-source products.

==[[Peripheral Devices]]==

OS.bee Software Factory Documentation

2017-07-26T21:19:07Z

Cmollik: /* Perspective DSL */

=OS.bee DSL Documentation=
The ''OS.bee Software Factory'' is composed of various domain specific languages (DSLs), which are described in detail on the following pages.

==[[Entity DSL]]==
The [[Entity DSL]] is, beside Datatypes, the basic DSL for the Software Factory. It allows you, through the creation of entity model files, to describe the entity relationship models that will be used to create, read, update and delete content on a persistence level, such as with an SQL database.

==[[DTO DSL]]==
The [[DTO DSL]] handles data transfer objects in order to transfer data between processes. It uses the [[Entity DSL]].

==[[Chart DSL]]==
The [[Chart DSL]] provides Vaadin dCharts.

==[[Cube DSL]]==
The [[Cube DSL]] provides MDX access to Mondrian OLAP Cubes.

==[[Datamart DSL]]==
A datamart is a condensed and more focused version of a data warehouse that reflects the regulations and process specifications of each business unit within an organization. Each datamart is dedicated to a specific business function or region.

==[[Dialog DSL]]==
The [[Dialog DSL]] generates the [https://vaadin.com/home Vaadin] UI

==[[Report DSL]]==
The [[Report DSL]] generates the [https://vaadin.com/home Vaadin] UI and the [http://developer.actuate.com/about/ BIRT] report module.

==[[Table DSL ]]==
The [[Table DSL]] generates the [https://vaadin.com/home Vaadin] table UI.

==[[Topology DSL ]]==
The [[Topology DSL]] generates [https://d3js.org/ D3.js], a JavaScript library for manipulating documents based on data, to generate the visualization of topology charts. Data used is [https://github.com/topojson topojson], an extension of [http://geojson.org/ GeoJSON] that encodes topology and the corresponding UI components.

==[[Entitymock DSL]]==
The [[Entitymock DSL]] generates mock data for entity models automatically upon initialization.

==[[Statemachine DSL]]==
The [[Statemachine DSL]] adds behavior to user interfaces. Instances of this DSL interconnect UI instances, FunctionLibrary instances, persistence layers and peripheral devices, and therefore act as controllers in a multiple Model-View-Controller environment. There is no limitation of how many statemachine instances control a single business application.

==[[Authorization DSL]]==

AuthorizationDSL is used to authorize the roles at runtime.

==[[Organization DSL]]==

OrganizationDSL is used to define the organizations and their positions.

==[[Perspective DSL]]==

Os.bee Applications which are generated using the OS.bee software factory have by default a front end based on the E4-UI-Model.

==[[Action DSL]]==

==[[Menu DSL]]==

==[[How to add pictures]]==

=OS.bee-Specific DSL Instances=
The ''OS.bee Software Factory'' provides a few specific DSL instances for different requirements. These are described in detail on the following pages.

==Datatypes==
Several custom datatypes are described in detail in this chapter.
===[[BlobMapping]]===
This datatype allows the use of big data as a blob.

=Other OS.bee-Specific Solutions=
The ''OS.bee Software Factory'' also provides other solutions, which are described in detail on the following pages.

==[[Themes]]==

=OS.bee Third-Party Software Solutions=
OS.bee also uses products of other software vendors (third-party products) that are based on open-source products.

==[[Peripheral Devices]]==

OS.bee Software Factory Documentation

2017-07-26T21:18:42Z

Cmollik: /* Organization DSL */

=OS.bee DSL Documentation=
The ''OS.bee Software Factory'' is composed of various domain specific languages (DSLs), which are described in detail on the following pages.

==[[Entity DSL]]==
The [[Entity DSL]] is, beside Datatypes, the basic DSL for the Software Factory. It allows you, through the creation of entity model files, to describe the entity relationship models that will be used to create, read, update and delete content on a persistence level, such as with an SQL database.

==[[DTO DSL]]==
The [[DTO DSL]] handles data transfer objects in order to transfer data between processes. It uses the [[Entity DSL]].

==[[Chart DSL]]==
The [[Chart DSL]] provides Vaadin dCharts.

==[[Cube DSL]]==
The [[Cube DSL]] provides MDX access to Mondrian OLAP Cubes.

==[[Datamart DSL]]==
A datamart is a condensed and more focused version of a data warehouse that reflects the regulations and process specifications of each business unit within an organization. Each datamart is dedicated to a specific business function or region.

==[[Dialog DSL]]==
The [[Dialog DSL]] generates the [https://vaadin.com/home Vaadin] UI

==[[Report DSL]]==
The [[Report DSL]] generates the [https://vaadin.com/home Vaadin] UI and the [http://developer.actuate.com/about/ BIRT] report module.

==[[Table DSL ]]==
The [[Table DSL]] generates the [https://vaadin.com/home Vaadin] table UI.

==[[Topology DSL ]]==
The [[Topology DSL]] generates [https://d3js.org/ D3.js], a JavaScript library for manipulating documents based on data, to generate the visualization of topology charts. Data used is [https://github.com/topojson topojson], an extension of [http://geojson.org/ GeoJSON] that encodes topology and the corresponding UI components.

==[[Entitymock DSL]]==
The [[Entitymock DSL]] generates mock data for entity models automatically upon initialization.

==[[Statemachine DSL]]==
The [[Statemachine DSL]] adds behavior to user interfaces. Instances of this DSL interconnect UI instances, FunctionLibrary instances, persistence layers and peripheral devices, and therefore act as controllers in a multiple Model-View-Controller environment. There is no limitation of how many statemachine instances control a single business application.

==[[Authorization DSL]]==

AuthorizationDSL is used to authorize the roles at runtime.

==[[Organization DSL]]==

OrganizationDSL is used to define the organizations and their positions.

==[[Perspective DSL]]==

==[[Action DSL]]==

==[[Menu DSL]]==

==[[How to add pictures]]==

=OS.bee-Specific DSL Instances=
The ''OS.bee Software Factory'' provides a few specific DSL instances for different requirements. These are described in detail on the following pages.

==Datatypes==
Several custom datatypes are described in detail in this chapter.
===[[BlobMapping]]===
This datatype allows the use of big data as a blob.

=Other OS.bee-Specific Solutions=
The ''OS.bee Software Factory'' also provides other solutions, which are described in detail on the following pages.

==[[Themes]]==

=OS.bee Third-Party Software Solutions=
OS.bee also uses products of other software vendors (third-party products) that are based on open-source products.

==[[Peripheral Devices]]==

OS.bee Software Factory Documentation

2017-07-26T21:18:25Z

Cmollik: /* Authorization DSL */

=OS.bee DSL Documentation=
The ''OS.bee Software Factory'' is composed of various domain specific languages (DSLs), which are described in detail on the following pages.

==[[Entity DSL]]==
The [[Entity DSL]] is, beside Datatypes, the basic DSL for the Software Factory. It allows you, through the creation of entity model files, to describe the entity relationship models that will be used to create, read, update and delete content on a persistence level, such as with an SQL database.

==[[DTO DSL]]==
The [[DTO DSL]] handles data transfer objects in order to transfer data between processes. It uses the [[Entity DSL]].

==[[Chart DSL]]==
The [[Chart DSL]] provides Vaadin dCharts.

==[[Cube DSL]]==
The [[Cube DSL]] provides MDX access to Mondrian OLAP Cubes.

==[[Datamart DSL]]==
A datamart is a condensed and more focused version of a data warehouse that reflects the regulations and process specifications of each business unit within an organization. Each datamart is dedicated to a specific business function or region.

==[[Dialog DSL]]==
The [[Dialog DSL]] generates the [https://vaadin.com/home Vaadin] UI

==[[Report DSL]]==
The [[Report DSL]] generates the [https://vaadin.com/home Vaadin] UI and the [http://developer.actuate.com/about/ BIRT] report module.

==[[Table DSL ]]==
The [[Table DSL]] generates the [https://vaadin.com/home Vaadin] table UI.

==[[Topology DSL ]]==
The [[Topology DSL]] generates [https://d3js.org/ D3.js], a JavaScript library for manipulating documents based on data, to generate the visualization of topology charts. Data used is [https://github.com/topojson topojson], an extension of [http://geojson.org/ GeoJSON] that encodes topology and the corresponding UI components.

==[[Entitymock DSL]]==
The [[Entitymock DSL]] generates mock data for entity models automatically upon initialization.

==[[Statemachine DSL]]==
The [[Statemachine DSL]] adds behavior to user interfaces. Instances of this DSL interconnect UI instances, FunctionLibrary instances, persistence layers and peripheral devices, and therefore act as controllers in a multiple Model-View-Controller environment. There is no limitation of how many statemachine instances control a single business application.

==[[Authorization DSL]]==

AuthorizationDSL is used to authorize the roles at runtime.

==[[Organization DSL]]==

==[[Perspective DSL]]==

==[[Action DSL]]==

==[[Menu DSL]]==

==[[How to add pictures]]==

=OS.bee-Specific DSL Instances=
The ''OS.bee Software Factory'' provides a few specific DSL instances for different requirements. These are described in detail on the following pages.

==Datatypes==
Several custom datatypes are described in detail in this chapter.
===[[BlobMapping]]===
This datatype allows the use of big data as a blob.

=Other OS.bee-Specific Solutions=
The ''OS.bee Software Factory'' also provides other solutions, which are described in detail on the following pages.

==[[Themes]]==

=OS.bee Third-Party Software Solutions=
OS.bee also uses products of other software vendors (third-party products) that are based on open-source products.

==[[Peripheral Devices]]==

Menu DSL

2017-07-26T21:17:27Z

Cmollik: /* Introduction */

==Introduction==

Menu model is used for the UI menu definition. Entries and the corresponding ui pages of the entries could be defined in this model. Predefined process from blipDSL, perspective from [[Perspective DSL]], table from [[Table DSL]] and dialog from [[Dialog DSL]] can be linked to the main '''''entry''''' or its sub '''''entry'''''.

Here is the menu bar in UI: [[File:MenuDSL_01.png|600px]] 

When you click the '''''entry''''' “Company” under main '''''entry''''' “Menu”, the '''''perspective''''' “Company” will be shown on the web site: [[File:MenuDSL_02.png|600px]] 

By clicking the other main '''''entry''''' “Persons”, the embedded table will be shown directly in menu: [[File:MenuDSL_03.png|600px]] 

==MenuDSL==

The MenuDSL works for Os.bee models, it defines the Menus for dialog.

The main semantic elements of the MenuDSL are:

* “package” - the root element that contains all the other elements. A model can contain multiple packages.

* “entry” - define the menu entry and subentry.

===Syntax===

====package definition====

► '''Syntax''':
<syntaxhighlight lang="java">
package <package name>[{
expandedImage <expandedImage String>
collapsedImage <collapsedImage String>
[accordionSubmenu][width <width String>][designer]

MenuEntry
. . .
}]
</syntaxhighlight>

For each menu package, 2 .java file named <code><project name>+Menu.java</code> and <code><project name> +Menu+ContextFunction.java</code> will be generated in folder <code>./src-gen/<package name>/</code>.

► '''Example''':
<syntaxhighlight lang="java">
package net.osbee.sample.foodmart.menues {

expandedImage "collapse_arrow_16" collapsedImage "expand_arrow_16"
accordionSubmenu width "600px" designer
entry Menu described by "my menu" {. . . }
. . .
}
</syntaxhighlight>

* One or more MenuEntry can be defined in the same package.

* Keyword '''expandedImage''' and '''collapsedImage''' is used to define the menu image when the menu expanded or collapsed. Following code will be generated in <project name>+Menu.java file:

<syntaxhighlight lang="java">
public void setIcon(final Accordion accordion, final boolean open) {
Tab tab = accordion.getTab(selectedMap.get(accordion));
if (tab != null) {
if(open) {
tab.setIcon(themeResourceService.getThemeResource(
<expandedImage String>, ThemeResourceType.ICON));
} else {
tab.setIcon(themeResourceService.getThemeResource(
<collapsedImage String>, ThemeResourceType.ICON));
}
}

}
</syntaxhighlight>

* Keyword '''accordionSubmenu''' is optional; you can use this keyword to define if the submenu is accordion.
* Keyword '''width''' is optional; you can use this keyword to define the width of this menu, default value is 400px. Following code will be generated in <code><project name>+Menu.java</code> file:

<syntaxhighlight lang="java">
accRoot.setWidth(<width String>);
</syntaxhighlight>

* Keyword '''designer''' is optional; you can use this keyword to define if this menu could be modified. Following code will be generated in <code><project name>+Menu.java</code> file:

<syntaxhighlight lang="java">
if (designModeHandler != null && userAccessService.isSuperuser()) {
MenuBar menubar = new MenuBar();
tabRoot.addComponent(menubar);
MenuItem designer = menubar.addItem(designerText, null, null);
MenuItem mode = designer.addItem(designmodeText, null, new MenuBar.Command() {
public void menuSelected(MenuItem selectedItem) {
designModeHandler.execute(selectedItem);
}
});
mode.setCheckable(true);
menuItems.put(designerUndoHandler, designer.addItem(undoText, null, new MenuBar.Command() {
public void menuSelected(MenuItem selectedItem) {
designerUndoHandler.execute(selectedItem);
}
}));
menuItems.put(designerRedoHandler, designer.addItem(redoText, null, new MenuBar.Command() {
public void menuSelected(MenuItem selectedItem) {
designerRedoHandler.execute(selectedItem);
}
}));
designer.addSeparator();
menuItems.put(newPerspectiveHandler, designer.addItem(newText, null, new MenuBar.Command() {
public void menuSelected(MenuItem selectedItem) {
newPerspectiveHandler.execute(selectedItem);
}
}));
menuItems.put(changePerspectiveHandler, designer.addItem(changeText, null, new MenuBar.Command() {
public void menuSelected(MenuItem selectedItem) {
changePerspectiveHandler.execute(selectedItem);
}
}));
menuItems.put(exportPerspectiveHandler, designer.addItem(exportText, null, new MenuBar.Command() {
public void menuSelected(MenuItem selectedItem) {
exportPerspectiveHandler.execute(selectedItem);
}
}));
menuItems.put(downloadPerspectiveHandler, designer.addItem(downloadText, null, new MenuBar.Command() {
public void menuSelected(MenuItem selectedItem) {
downloadPerspectiveHandler.execute(selectedItem);
}
}));
}
</syntaxhighlight>

====menuEntry====

This is the main part of this model. All the menu entry details can be defined here. This part could be reused as subentry under the main entry.

► '''Syntax''':
<syntaxhighlight lang="java">
entry <entry name>
[described by <description String>][image <ImageString>][showBadge]
[
process [blip::Blip] |
perspective [perspective::Perspective] |
table [table::Table] |
dialog [dialog::Dialog] |
userFilter |
keyBinding
]
[{
MenuEntry
. . .

}]
</syntaxhighlight>

* Keyword '''described by''' is optional, it define the description of this entry.

* Keyword '''image''' is optional, it define the image string of this entry.

* Keyword '''showBadge''' is optional, it define if the update badge will be shown for this entry.

* Keyword '''process''' is used to define the predefined process from blipDSL which this entry links to.

* Keyword '''perspective''' is used to define the predefined perspective from [[Perspective DSL]] which this entry links to.

* Keyword '''table''' is used to define the predefined table from [[Table DSL]] which this entry links to.

* Keyword '''dialog''' is used to define the predefined dialog from [[Dialog DSL]] which this entry links to.

* Keyword '''userFilter''' are used to define if the user filter will be shown. Following code will be generated in <project name>+Menu.java file:

<syntaxhighlight lang="java">
if (userAccessService.isSuperuser()) {
VerticalLayout tab+<entry name> = new VerticalLayout();
userFilter.createView(tab+<entry name>);
acc<parent name>.addTab(tab+<entry name>, <entry name>, themeResourceService.getThemeResource(<collapsedImage String >, ThemeResourceType.ICON));
tabs.put(acc<parent name>.getTab(tab+<entry name>), new Pair(<entry name>,<entry description>));
}
</syntaxhighlight>

* Keyword '''keyBinding''' is used to define if the key binding works for this entry.

► '''Example''':
<syntaxhighlight lang="java">
entry Sales {
entry CashRegister image "cashregister" perspective CashRegister
}
entry ProductMaintenance process ProductMaintenance
entry MyTasks table TaskMenu
entry Profile dialog UserAccount
entry UserFilter userFilter
</syntaxhighlight>

In the examples, '''entry''' '''''Sales''''' has a sub'''entry''' named '''''CashRegister''''' with '''image''' icon and links to a predefined '''perspective''' named '''''CashReegister''''' from [[Perspective DSL]]; '''entry''' '''''ProductMaintenance''''' links to a predefined '''process''' named '''''ProductMaintenance''''' from blipDSL; '''entry''' '''''MyTasks''''' links to a predefined '''table''' named '''''TaskMenu''''' from [[Table DSL]]; '''entry''' '''''Profile''''' links to a predefined '''dialog''' named '''''UserAccount''''' from [[Dialog DSL]]; '''entry''' '''''UserFilter''''' is defined to shown the user filter.

== Copyright Notice ==
{{Copyright Notice}}

Menu DSL

2017-07-26T21:15:53Z

Cmollik: /* menuEntry */

==Introduction==

Menu model is used for the UI menu definition. Entries and the corresponding ui pages of the entries could be defined in this model. Predefined process from blipDSL, perspective from perspectiveDSL, table from tableDSL and dialog from [[Dialog DSL]] can be linked to the main '''''entry''''' or its sub '''''entry'''''.

Here is the menu bar in UI: [[File:MenuDSL_01.png|600px]] 

When you click the '''''entry''''' “Company” under main '''''entry''''' “Menu”, the '''''perspective''''' “Company” will be shown on the web site: [[File:MenuDSL_02.png|600px]] 

By clicking the other main '''''entry''''' “Persons”, the embedded table will be shown directly in menu: [[File:MenuDSL_03.png|600px]] 

==MenuDSL==

The MenuDSL works for Os.bee models, it defines the Menus for dialog.

The main semantic elements of the MenuDSL are:

* “package” - the root element that contains all the other elements. A model can contain multiple packages.

* “entry” - define the menu entry and subentry.

===Syntax===

====package definition====

► '''Syntax''':
<syntaxhighlight lang="java">
package <package name>[{
expandedImage <expandedImage String>
collapsedImage <collapsedImage String>
[accordionSubmenu][width <width String>][designer]

MenuEntry
. . .
}]
</syntaxhighlight>

For each menu package, 2 .java file named <code><project name>+Menu.java</code> and <code><project name> +Menu+ContextFunction.java</code> will be generated in folder <code>./src-gen/<package name>/</code>.

► '''Example''':
<syntaxhighlight lang="java">
package net.osbee.sample.foodmart.menues {

expandedImage "collapse_arrow_16" collapsedImage "expand_arrow_16"
accordionSubmenu width "600px" designer
entry Menu described by "my menu" {. . . }
. . .
}
</syntaxhighlight>

* One or more MenuEntry can be defined in the same package.

* Keyword '''expandedImage''' and '''collapsedImage''' is used to define the menu image when the menu expanded or collapsed. Following code will be generated in <project name>+Menu.java file:

<syntaxhighlight lang="java">
public void setIcon(final Accordion accordion, final boolean open) {
Tab tab = accordion.getTab(selectedMap.get(accordion));
if (tab != null) {
if(open) {
tab.setIcon(themeResourceService.getThemeResource(
<expandedImage String>, ThemeResourceType.ICON));
} else {
tab.setIcon(themeResourceService.getThemeResource(
<collapsedImage String>, ThemeResourceType.ICON));
}
}

}
</syntaxhighlight>

* Keyword '''accordionSubmenu''' is optional; you can use this keyword to define if the submenu is accordion.
* Keyword '''width''' is optional; you can use this keyword to define the width of this menu, default value is 400px. Following code will be generated in <code><project name>+Menu.java</code> file:

<syntaxhighlight lang="java">
accRoot.setWidth(<width String>);
</syntaxhighlight>

* Keyword '''designer''' is optional; you can use this keyword to define if this menu could be modified. Following code will be generated in <code><project name>+Menu.java</code> file:

<syntaxhighlight lang="java">
if (designModeHandler != null && userAccessService.isSuperuser()) {
MenuBar menubar = new MenuBar();
tabRoot.addComponent(menubar);
MenuItem designer = menubar.addItem(designerText, null, null);
MenuItem mode = designer.addItem(designmodeText, null, new MenuBar.Command() {
public void menuSelected(MenuItem selectedItem) {
designModeHandler.execute(selectedItem);
}
});
mode.setCheckable(true);
menuItems.put(designerUndoHandler, designer.addItem(undoText, null, new MenuBar.Command() {
public void menuSelected(MenuItem selectedItem) {
designerUndoHandler.execute(selectedItem);
}
}));
menuItems.put(designerRedoHandler, designer.addItem(redoText, null, new MenuBar.Command() {
public void menuSelected(MenuItem selectedItem) {
designerRedoHandler.execute(selectedItem);
}
}));
designer.addSeparator();
menuItems.put(newPerspectiveHandler, designer.addItem(newText, null, new MenuBar.Command() {
public void menuSelected(MenuItem selectedItem) {
newPerspectiveHandler.execute(selectedItem);
}
}));
menuItems.put(changePerspectiveHandler, designer.addItem(changeText, null, new MenuBar.Command() {
public void menuSelected(MenuItem selectedItem) {
changePerspectiveHandler.execute(selectedItem);
}
}));
menuItems.put(exportPerspectiveHandler, designer.addItem(exportText, null, new MenuBar.Command() {
public void menuSelected(MenuItem selectedItem) {
exportPerspectiveHandler.execute(selectedItem);
}
}));
menuItems.put(downloadPerspectiveHandler, designer.addItem(downloadText, null, new MenuBar.Command() {
public void menuSelected(MenuItem selectedItem) {
downloadPerspectiveHandler.execute(selectedItem);
}
}));
}
</syntaxhighlight>

====menuEntry====

This is the main part of this model. All the menu entry details can be defined here. This part could be reused as subentry under the main entry.

► '''Syntax''':
<syntaxhighlight lang="java">
entry <entry name>
[described by <description String>][image <ImageString>][showBadge]
[
process [blip::Blip] |
perspective [perspective::Perspective] |
table [table::Table] |
dialog [dialog::Dialog] |
userFilter |
keyBinding
]
[{
MenuEntry
. . .

}]
</syntaxhighlight>

* Keyword '''described by''' is optional, it define the description of this entry.

* Keyword '''image''' is optional, it define the image string of this entry.

* Keyword '''showBadge''' is optional, it define if the update badge will be shown for this entry.

* Keyword '''process''' is used to define the predefined process from blipDSL which this entry links to.

* Keyword '''perspective''' is used to define the predefined perspective from [[Perspective DSL]] which this entry links to.

* Keyword '''table''' is used to define the predefined table from [[Table DSL]] which this entry links to.

* Keyword '''dialog''' is used to define the predefined dialog from [[Dialog DSL]] which this entry links to.

* Keyword '''userFilter''' are used to define if the user filter will be shown. Following code will be generated in <project name>+Menu.java file:

<syntaxhighlight lang="java">
if (userAccessService.isSuperuser()) {
VerticalLayout tab+<entry name> = new VerticalLayout();
userFilter.createView(tab+<entry name>);
acc<parent name>.addTab(tab+<entry name>, <entry name>, themeResourceService.getThemeResource(<collapsedImage String >, ThemeResourceType.ICON));
tabs.put(acc<parent name>.getTab(tab+<entry name>), new Pair(<entry name>,<entry description>));
}
</syntaxhighlight>

* Keyword '''keyBinding''' is used to define if the key binding works for this entry.

► '''Example''':
<syntaxhighlight lang="java">
entry Sales {
entry CashRegister image "cashregister" perspective CashRegister
}
entry ProductMaintenance process ProductMaintenance
entry MyTasks table TaskMenu
entry Profile dialog UserAccount
entry UserFilter userFilter
</syntaxhighlight>

In the examples, '''entry''' '''''Sales''''' has a sub'''entry''' named '''''CashRegister''''' with '''image''' icon and links to a predefined '''perspective''' named '''''CashReegister''''' from [[Perspective DSL]]; '''entry''' '''''ProductMaintenance''''' links to a predefined '''process''' named '''''ProductMaintenance''''' from blipDSL; '''entry''' '''''MyTasks''''' links to a predefined '''table''' named '''''TaskMenu''''' from [[Table DSL]]; '''entry''' '''''Profile''''' links to a predefined '''dialog''' named '''''UserAccount''''' from [[Dialog DSL]]; '''entry''' '''''UserFilter''''' is defined to shown the user filter.

== Copyright Notice ==
{{Copyright Notice}}

Menu DSL

2017-07-26T21:14:15Z

Cmollik: /* Introduction */

==Introduction==

Menu model is used for the UI menu definition. Entries and the corresponding ui pages of the entries could be defined in this model. Predefined process from blipDSL, perspective from perspectiveDSL, table from tableDSL and dialog from [[Dialog DSL]] can be linked to the main '''''entry''''' or its sub '''''entry'''''.

Here is the menu bar in UI: [[File:MenuDSL_01.png|600px]] 

When you click the '''''entry''''' “Company” under main '''''entry''''' “Menu”, the '''''perspective''''' “Company” will be shown on the web site: [[File:MenuDSL_02.png|600px]] 

By clicking the other main '''''entry''''' “Persons”, the embedded table will be shown directly in menu: [[File:MenuDSL_03.png|600px]] 

==MenuDSL==

The MenuDSL works for Os.bee models, it defines the Menus for dialog.

The main semantic elements of the MenuDSL are:

* “package” - the root element that contains all the other elements. A model can contain multiple packages.

* “entry” - define the menu entry and subentry.

===Syntax===

====package definition====

► '''Syntax''':
<syntaxhighlight lang="java">
package <package name>[{
expandedImage <expandedImage String>
collapsedImage <collapsedImage String>
[accordionSubmenu][width <width String>][designer]

MenuEntry
. . .
}]
</syntaxhighlight>

For each menu package, 2 .java file named <code><project name>+Menu.java</code> and <code><project name> +Menu+ContextFunction.java</code> will be generated in folder <code>./src-gen/<package name>/</code>.

► '''Example''':
<syntaxhighlight lang="java">
package net.osbee.sample.foodmart.menues {

expandedImage "collapse_arrow_16" collapsedImage "expand_arrow_16"
accordionSubmenu width "600px" designer
entry Menu described by "my menu" {. . . }
. . .
}
</syntaxhighlight>

* One or more MenuEntry can be defined in the same package.

* Keyword '''expandedImage''' and '''collapsedImage''' is used to define the menu image when the menu expanded or collapsed. Following code will be generated in <project name>+Menu.java file:

<syntaxhighlight lang="java">
public void setIcon(final Accordion accordion, final boolean open) {
Tab tab = accordion.getTab(selectedMap.get(accordion));
if (tab != null) {
if(open) {
tab.setIcon(themeResourceService.getThemeResource(
<expandedImage String>, ThemeResourceType.ICON));
} else {
tab.setIcon(themeResourceService.getThemeResource(
<collapsedImage String>, ThemeResourceType.ICON));
}
}

}
</syntaxhighlight>

* Keyword '''accordionSubmenu''' is optional; you can use this keyword to define if the submenu is accordion.
* Keyword '''width''' is optional; you can use this keyword to define the width of this menu, default value is 400px. Following code will be generated in <code><project name>+Menu.java</code> file:

<syntaxhighlight lang="java">
accRoot.setWidth(<width String>);
</syntaxhighlight>

* Keyword '''designer''' is optional; you can use this keyword to define if this menu could be modified. Following code will be generated in <code><project name>+Menu.java</code> file:

<syntaxhighlight lang="java">
if (designModeHandler != null && userAccessService.isSuperuser()) {
MenuBar menubar = new MenuBar();
tabRoot.addComponent(menubar);
MenuItem designer = menubar.addItem(designerText, null, null);
MenuItem mode = designer.addItem(designmodeText, null, new MenuBar.Command() {
public void menuSelected(MenuItem selectedItem) {
designModeHandler.execute(selectedItem);
}
});
mode.setCheckable(true);
menuItems.put(designerUndoHandler, designer.addItem(undoText, null, new MenuBar.Command() {
public void menuSelected(MenuItem selectedItem) {
designerUndoHandler.execute(selectedItem);
}
}));
menuItems.put(designerRedoHandler, designer.addItem(redoText, null, new MenuBar.Command() {
public void menuSelected(MenuItem selectedItem) {
designerRedoHandler.execute(selectedItem);
}
}));
designer.addSeparator();
menuItems.put(newPerspectiveHandler, designer.addItem(newText, null, new MenuBar.Command() {
public void menuSelected(MenuItem selectedItem) {
newPerspectiveHandler.execute(selectedItem);
}
}));
menuItems.put(changePerspectiveHandler, designer.addItem(changeText, null, new MenuBar.Command() {
public void menuSelected(MenuItem selectedItem) {
changePerspectiveHandler.execute(selectedItem);
}
}));
menuItems.put(exportPerspectiveHandler, designer.addItem(exportText, null, new MenuBar.Command() {
public void menuSelected(MenuItem selectedItem) {
exportPerspectiveHandler.execute(selectedItem);
}
}));
menuItems.put(downloadPerspectiveHandler, designer.addItem(downloadText, null, new MenuBar.Command() {
public void menuSelected(MenuItem selectedItem) {
downloadPerspectiveHandler.execute(selectedItem);
}
}));
}
</syntaxhighlight>

====menuEntry====

This is the main part of this model. All the menu entry details can be defined here. This part could be reused as subentry under the main entry.

► '''Syntax''':
<syntaxhighlight lang="java">
entry <entry name>
[described by <description String>][image <ImageString>][showBadge]
[
process [blip::Blip] |
perspective [perspective::Perspective] |
table [table::Table] |
dialog [dialog::Dialog] |
userFilter |
keyBinding
]
[{
MenuEntry
. . .

}]
</syntaxhighlight>

* Keyword '''described by''' is optional, it define the description of this entry.

* Keyword '''image''' is optional, it define the image string of this entry.

* Keyword '''showBadge''' is optional, it define if the update badge will be shown for this entry.

* Keyword '''process''' is used to define the predefined process from blipDSL which this entry links to.

* Keyword '''perspective''' is used to define the predefined perspective from perspectiveDSL which this entry links to.

* Keyword '''table''' is used to define the predefined table from tableDSL which this entry links to.

* Keyword '''dialog''' is used to define the predefined dialog from dialogDSL which this entry links to.

* Keyword '''userFilter''' are used to define if the user filter will be shown. Following code will be generated in <project name>+Menu.java file:

<syntaxhighlight lang="java">
if (userAccessService.isSuperuser()) {
VerticalLayout tab+<entry name> = new VerticalLayout();
userFilter.createView(tab+<entry name>);
acc<parent name>.addTab(tab+<entry name>, <entry name>, themeResourceService.getThemeResource(<collapsedImage String >, ThemeResourceType.ICON));
tabs.put(acc<parent name>.getTab(tab+<entry name>), new Pair(<entry name>,<entry description>));
}
</syntaxhighlight>

* Keyword '''keyBinding''' is used to define if the key binding works for this entry.

► '''Example''':
<syntaxhighlight lang="java">
entry Sales {
entry CashRegister image "cashregister" perspective CashRegister
}
entry ProductMaintenance process ProductMaintenance
entry MyTasks table TaskMenu
entry Profile dialog UserAccount
entry UserFilter userFilter
</syntaxhighlight>

In the examples, '''entry''' '''''Sales''''' has a sub'''entry''' named '''''CashRegister''''' with '''image''' icon and links to a predefined '''perspective''' named '''''CashReegister''''' from perspectiveDSL; '''entry''' '''''ProductMaintenance''''' links to a predefined '''process''' named '''''ProductMaintenance''''' from blipDSL; '''entry''' '''''MyTasks''''' links to a predefined '''table''' named '''''TaskMenu''''' from tableDSL; '''entry''' '''''Profile''''' links to a predefined '''dialog''' named '''''UserAccount''''' from dialogDSL; '''entry''' '''''UserFilter''''' is defined to shown the user filter.

== Copyright Notice ==
{{Copyright Notice}}

Action DSL

2017-07-26T21:12:20Z

Cmollik: /* Items&item */

==Introduction==

===CRUD for toolbar===

Editing data is nice but data must be persisted otherwise all effort invested in editing data would be lost. For this reason, OS.bee apps come with a set of create, read, update and delete functionality (CRUD) to manipulate data in a database. OS.bee can be operated with different database products.

====Create====

Create or add new entries.

If you want to create new data entry, please press the “new data” action button, after the action has been executed, a new unique id must be created. [[File:ActionDSL_01.png|600px]] 

====Read====

Read, retrieve, search or view existing entries.

Existed data can be read from the database. If you request existed data to be displayed in the UI, you must either retrieved a unique id to the database so it can select the requested data, or you can search and select one.

In Os.bee web site, for example the perspective of “Persons”, you can click one row from the table on the left, then the detail data will be read from database and shown in the dialog on the right. [[File:ActionDSL_02.png|600px]] 

====Update====

Update or edit existing entries.

After editing your data, please press the “save” button and the data will be saved in the underlying database. [[File:ActionDSL_03.png|600px]] 

====Delete====

Delete, deactivate or remove existing entries.

If you don’t need an existing entry, please select it and press the “delete” button, then this data will be remove from the underlying database.

 [[File:ActionDSL_04.png|600px]] 

==ActionDSl==

The ActionDSL works for Os.bee models, it defines the toolbar actions for task, select workload, dialog, report, chart, workflow, datainterchange, ect..

The main semantic elements of the ActionDSL are:

* “package” - the root element that contains all the other elements. A model can contain multiple packages.

* “toolbar” - define the action details, e.g. toolbar name, description and items…

* “items” – define the items for this action.

* “item” - define the function and action type for the item …

===Syntax===

====package defintion====

► '''Syntax''':
<syntaxhighlight lang="java">
package <package name>[{
toolbar <toolbar name> [described by <description>]
[items { . . .}]
. . .
} ]
</syntaxhighlight>

For each toolbar, one .java file named <code><toolbar name>+Action.java</code> will be generated in folder <code>./src-gen/<package name>/</code>.

* One or more '''toolbars''' can be defined in the same '''package'''.

* Keyword '''descrbied by''' is optional; you can use this keyword to define the description of this toolbar

* One or more '''item''' can be defined in the same '''items''' block.

► '''Example''':
<syntaxhighlight lang="java">
package net.osbee.sample.foodmart.actions {
toolbar StartTask described by "Toolbar for tables showing tasks"
items { . . . }
toolbar Dialog described by "Toolbar for Dialogs" items { . . . }
toolbar HandleTask described by "Toolbar for BPM oriented perspectives"
items { . . . }
toolbar Report described by "Toolbar for reports" items { . . . }
toolbar WorkloadSelect described by "Toolbar for Workload Selects"
items { . . . }
}
</syntaxhighlight>

In this example, 5 '''toolbars''' are defined in the same '''package'''; they are ''StartTask'', ''Dialog'', ''HandleTask'', ''Report'' and ''WorkloadSelect''.

====Items&item====

This is the main part of this model. All the action details can be defined here. For each item, a java file named <code><toolbar name>+<action rule>+Action.java</code> will be generated in folder <code>./src-gen/<package name>/. <action rule></code> is defined in '''ActionType''' and it will be introduced in the next section.

► '''Syntax''':
<syntaxhighlight lang="java">
items {
item <item name> [described by <description>]
[icon <URI string>]
[group <func.FunctionLibraryGroup name>
[canExecute <func.FunctionLibraryFunction name>]
& [executeParameter <func.FunctionLibraryFunction name>]
]
ActionType
[message <msg.MessageItem name |QualifiedName>]
. . .
}]
. . .
} ]
</syntaxhighlight>

* Keyword '''icon''' is optional, it define the identifier for a resource, e.g. icon file

* Keyword '''group''', '''canExecute & executeParameter''' are used to define the predefined function which this item could use from FunctionlibraryDSL.

► '''Example''':
<syntaxhighlight lang="java">
toolbar HandleTask described by "Toolbar for BPM oriented perspectives" items {
item stop icon "task_action_stop" group PerspectiveToolbar
canExecute stopCanExecute executeParameter getTaskId taskAction Stop
. . .
}
</syntaxhighlight>

In this example, the following code will be generated in the java file of '''item''' '''''stop''''':

<syntaxhighlight lang="java">
@CanExecute
public boolean canExecute() {
return net.osbee.sample.foodmart.functionlibraries.PerspectiveToolbar
.stopCanExecute(getContent());
}

@Execute
public void execute(final IEventBroker eventBroker) {
log.debug("action execute called for stop");
String uuid = (String)eclipseContext.get("HandleTask_TOOLBAR_ID");
eventBroker.send(
EventBrokerMsg.ACTION_BUTTON_EXECUTE_PREFIX+ "HandleTaskAction"+uuid,
new EventBrokerMsg(-1,
"Stop",
net.osbee.sample.foodmart.functionlibraries
.PerspectiveToolbar.getTaskId(getContent())
)
);
}
</syntaxhighlight>

* Keyword '''message''' is used to define the action message using predefined message from messageDSL.

► '''Example''':
<syntaxhighlight lang="java">
toolbar Dialog described by "Toolbar for Dialogs" items {
item newItem icon "dsnew" dialogAction New
item saveItem icon "dssave" dialogAction Save message net.osbee.sample.foodmart.messages.FoodMartErrors.DtoService.SaveMsg
item deleteItem icon "dsdelete" dialogAction Delete message net.osbee.sample.foodmart.messages.FoodMartErrors.DtoService.DeleteMsg
item cancelItem icon "dscancel" dialogAction Cancel
}
</syntaxhighlight>

The '''message''' '''''SavMsg''''' and '''''DeleteMsg''''' are defined in messageDSL as following:

<syntaxhighlight lang="java">
package net.osbee.sample.foodmart.messages{
category FoodMartErrors {
group DtoService {
message DeleteMsg{
parameter{
Exception ex
String stackTrace
}
automatic{}
format {
log "%%ex.simpleName%%: Delete not allowed! –
%%stackTrace%%"
show "%%ex.simpleName%% - %%ex.localizedMessage%%
- Delete not allowed!"
}
}
message SaveMsg{
parameter{
Exception ex
String stackTrace
}
automatic{}
format {
log "%%ex.simpleName%%: Save not allowed! –
%%stackTrace%%"
show "%%ex.simpleName%% - %%ex.localizedMessage%%
- Delete not allowed!"
}
}
}
}
}
</syntaxhighlight>

The '''dialog''' '''''Employee''''' uses this '''toolbar''' '''''Dialog''''' in [[Dialog DSL]] as following:

<syntaxhighlight lang="java">
package net.osbee.sample.foodmart.dialogs {
dialog Employee described by "Employee data" autobinding MemployeeDto toolbar Dialog
. . .
}
</syntaxhighlight>

There will be no code generated in the related toolbar java files. But in the EmployeeDialog.java, where this toolbar will be used, the following code generated for the message:

<syntaxhighlight lang="java">
public void showSaveErrorMessage(final Exception ex) {
org.eclipse.osbp.xtext.messagedsl.common.Message errorMsg = net.osbee.sample.foodmart.messages.FoodMartErrorsMessage.DtoService_SaveMsg(ex, ex.getMessage());
Notification.show(errorMsg.getShowMessage());
log.error(errorMsg.getLogMessage());
}

public void showDeleteErrorMessage(final Exception ex) {
org.eclipse.osbp.xtext.messagedsl.common.Message errorMsg = net.osbee.sample.foodmart.messages.FoodMartErrorsMessage.DtoService_DeleteMsg(ex, ex.getMessage());
Notification.show(errorMsg.getShowMessage());
log.error(errorMsg.getLogMessage());
}
</syntaxhighlight>

* '''''ActionType''''' will be introduced in the next section.

====ActionType====

'''ActionType''' sets the type of action for the item.

There are 8 kinds of action types:

=====taskAction=====

'''''taskAction''''' is used to define the action of task for bpm.

► '''Syntax''':
<syntaxhighlight lang="java">
taskAction <taskAction rule>
</syntaxhighlight>

* taskAction rule includes 15 rules, and its <action rule> is the same as the following rule:

<syntaxhighlight lang="java">
Claim, Start, Stop, Release, Suspend, Resume, Skip, Complete, Delegate, Forward, Fail, Register, Remove, Activate, Exit
</syntaxhighlight>

► '''Example''':
<syntaxhighlight lang="java">
toolbar StartTask described by "Toolbar for tables showing tasks" items {
item claim icon "task_action_claim" group TaskToolbar
canExecute claimCanExecute executeParameter getTaskId taskAction Claim
item start icon "task_action_start" group TaskToolbar
canExecute startCanExecute executeParameter getTaskId taskAction Start
item start icon "task_action_resume" group TaskToolbar
canExecute resumeCanExecute executeParameter getTaskId taskAction Resume
}
</syntaxhighlight>

=====selectWorkloadAction=====

'''''selectWorkloadAction''''' is used to define the action of select workload.

► '''Syntax''':
<syntaxhighlight lang="java">
selectWorkloadAction <selectWorkloadAction rule>
</syntaxhighlight>

* selectWorkloadAction rule includes the 2 rules, and its <action rule> is as same as the following rule:<code> RemoveAll, AddAll</code>.

► '''Example''':
<syntaxhighlight lang="java">
toolbar WorkloadSelect described by "Toolbar for Workload Selects" items {
item removeAllWorkloadItems icon "task_status_obsolete" selectWorkloadAction RemoveAll
item addAllSelectedItemsToTheWorkload icon "import" selectWorkloadAction AddAll
}
</syntaxhighlight>

=====dialogAction=====

'''DialogAction''' is used to define the actions for dialog.

► '''Syntax''':
<syntaxhighlight lang="java">
dialogAction <dialogAction rule>
</syntaxhighlight>

* dialogAction rule includes the 4 rules, and its <action rule> is as same as the following rule: <code>New, Save, Delete, Cancel</code>

► '''Example''':
<syntaxhighlight lang="java">
toolbar Dialog described by "Toolbar for Dialogs" items {
item newItem icon "dsnew" dialogAction New
item saveItem icon "dssave" dialogAction Save message net.osbee.sample.foodmart.messages.FoodMartErrors.DtoService.SaveMsg
item deleteItem icon "dsdelete" dialogAction Delete message net.osbee.sample.foodmart.messages.FoodMartErrors.DtoService.DeleteMsg
item cancelItem icon "dscancel" dialogAction Cancel
}
</syntaxhighlight>

* “new” means create a new entry.

* “save” means save the changing.

* “delete” means delete the selected entry.

* “cancel” means ignore the changing.

Here is the dialog view in perspective, in which the 4 buttons do the actions by clicking them: [[File:ActionDSL_05.png|600px]] 

=====reportAction=====

'''''ReportAction''''' is used to define the actions for report.

► '''Syntax''':
<syntaxhighlight lang="java">
reportAction <reportAction rule>
</syntaxhighlight>

* reportAction rule includes the 2 rules: PrintOnServer, Download.

* Its <action rule> is PrintOnServer and ReportDownload.

► '''Example''':
<syntaxhighlight lang="java">
toolbar Report described by "Toolbar for reports" items {
item print icon "print" reportAction Download
item print icon "xml" reportAction PrintOnServer
}
</syntaxhighlight>

=====chartAction=====

'''''chartAction''''' is used to define the actions for chart.

► '''Syntax''':
<syntaxhighlight lang="java">
chartAction Download
</syntaxhighlight>

* Its <action rule> is '''''ChartDownload'''''.

=====workflowAction=====

'''''workflowAction''''' is used to define the actions for workflow.

► '''Syntax''':
<syntaxhighlight lang="java">
workflowAction Start
</syntaxhighlight>

* Its <action rule> is '''''start'''''.

=====genericAction=====

'''''genericAction''''' is used to define the actions for yourself. You can define it as you will.

► '''Syntax''':
<syntaxhighlight lang="java">
genericAction <STRING>
</syntaxhighlight>

* Its <action rule> is '''''the string'''''.

=====datainterchangeAction=====

'''''datainterchangeAction''''' is used to define the actions for data interchange

► '''Syntax''':
<syntaxhighlight lang="java">
datainterchangeAction <datainterchangeAction rule> <data.DataInterchange name>
</syntaxhighlight>

* datainterchangeAction type includes the following types, and its <action rule> is as same as the following rule: '''Import, Export'''.

* The data interchange should be predefined in datainterchangeDSL.

The following code will be generated in the java file of '''item''':

<syntaxhighlight lang="java">
@Execute
public void execute(final IEventBroker eventBroker) {
<datainterchange qualified name> <datainerchange name> = new <datainterchange qualified name>();
<datainerchange name>.setFileURL(<file path URL String>
<datainerchange name>.setPersistenceService(persistenceService);
<datainerchange name>.setDirection(WorkerThreadRunnable.Direction.IMPORT);
<datainerchange name>.setEventBroker(eventBroker);
<datainerchange name>.setEventDispatcher(eventDispatcher);
executorService.execute(<datainerchange name>);
}
</syntaxhighlight>

== Copyright Notice ==
{{Copyright Notice}}

Perspective DSL

2017-07-26T21:10:55Z

Cmollik: /* perspective */

==Introduction==

Os.bee Applications which are generated using the OS.bee software factory have by default a front end based on the E4-UI-Model. [[File:PerspectiveDSL_01.png|600px]] 

As you can recognize on the above graphics the main elements of theE4-Model are:

* Perspective. A perspective is a container for a set of UI graphic elements, like sash, part stack, part, area, etc. Perspectives can be used to store different arrangements of UI graphic elements. Each Workbench window contains one or more perspectives. A perspective defines the initial set and layout of views in the Workbench window. Each perspective provides a set of functionality aimed at accomplishing a specific type of task or works with specific types of resources.

* Sash. A sash is a UI graphic elements container, and it displays all its children at the same time either horizontally or vertically aligned. Default is vertically aligned.

* Part. A Part is a container for a view. Parts are user interface components which allow you to navigate and modify data.

* Part stack. A part stack contains a stack of parts showing the content of one part while displaying only the headers of the other parts.

* View. A view is used to work on a set of data, which might be a hierarchical structure. If data is changed via the view, this change is directly applied to the underlying data structure. A predefined view could be a bpmn(Business Process Model and Notation) view, a chart, a dialog, a grid, an organigram, a report, a select table, a table or a topology in OS.bee.

==Perspective DSL==

The PerspectiveDSL is used to build the ui for Os.bee Application.

You can find instances of these elements in Os.bee Applications as follows: [[File:PerspectiveDSL_02.png|600px]] 

The main semantic elements of the PerspectiveDSL are:

* “package” - the root element that contains all the other elements. A model can contain multiple packages.

* “perspective” - define the perspective details, e.g. perspective name, the description…

* “sashContainer” - define the main element sash container for the perspective.

* “partStack” - define the main element part stack for the perspective.

* “part” - the main element part for the perspective.

* “view” - define the part view of the perspective, it can be report, dialog, table, chart …

===Syntax===

====package definition====

► '''Syntax''':
<syntaxhighlight lang="java">
package <package name> [{
perspective <perspective name> . . .
. . .
}]
</syntaxhighlight>

One or more than one perspective could be defined in the same package.

► '''Example''':
<syntaxhighlight lang="java">
package net.osbee.sample.foodmart.perspectives {
perspective Employee . . .

perspective Supplier . . .

perspective Products . . .

. . .
}
</syntaxhighlight>

In this example <code>perspective</code> Employee, <code>perspective</code> Supplier, <code>perspective</code> Products and also other perspectives are defined in the same <code>package</code>.

====perspective====

This is the main part of this model. All the perspective details can be defined here.

► '''Syntax''':
<syntaxhighlight lang="java">
perspective <perspective name> [described by <description>]
[process <blip.blip name> usertask <blip.BlipUserTask name>]
([iconURI <iconURI>]
&
[accessibility <accessibilityPhrase>]
&
[toolbar <action.ActionToolbar>])
{
PerspectiveElement
. . .
}
</syntaxhighlight>

* Keyword <code>described by</code> is optional; you can use this keyword to define the description of this perspective.

* Keyword <code>process. . . usertask. . . </code> is optional, which define the blip process and blip usertask from predefined blipDSL for this perspective.

* Keyword <code>iconURI</code> is optional, it define the identifier for a resource, e.g. icon file.

* Keyword <code>accessibility</code> is optional, it can be any string; this field is provided as a way to inform accessibility screen readers with extra information. The intent is that the reader should 'say' this phrase as well as what it would normally emit given the widget hierarchy. A screen reader is an essential piece of software for a blind or visually impaired person. Simply put, a screen reader transmits whatever text is displayed on the computer screen into a form that a visually impaired user can process (usually tactile, auditory or a combination of both). While the most basic screen readers will not help blind users navigate a computer, those with additional features can give people with visual impairment much more independence.

* Keyword <code>toolbar</code> is optional, which define the action tool bar from predefined [[Action DSL]]. Graphical control elements are defined, on which on-screen buttons, icons, menus, or other input or output elements are placed.

► '''Example''':
<syntaxhighlight lang="java">
perspective Employee described by "Employee maintenance" iconURI "employee" {
. . .
}

perspective ProductMaintenanceSelect process ProductMaintenance usertask SelectSomeProducts toolbar HandleTask iconURI "information" {
. . .
}
</syntaxhighlight>

In the next sections, the important elements and keywords of perspective will be introduced one by one.

====PerspectiveElement====

Keyword <code>PerspectiveElement</code> is used to define the main elements of the perspective.

The main elements are sash container, part stack and part.

=====sashContainer=====

Keyword <code>sashContainer</code> is used to define the main element sash container of perspective.

A sash container displays all its children at the same time either horizontally or vertically aligned.

► '''Syntax''':
<syntaxhighlight lang="java">
sashContainer <PerspectiveSashContainer ID>
[orientation horizontal|vertical]
&
[selectedElement <PerspectiveElement ID>]
&
[spaceVolume <containerData STRING>]
&
[accessibility <accessibilityPhrase STRING>]
{
PerspectiveElement
. . .
}
</syntaxhighlight>

* Keyword <code>orientation</code> is optional, it can be horizontal or vertical, and default value is vertical.
* Keyword <code>selectedElement</code> is optional; you can select one of the next level perspective element here and which is selected will be shown in the first place.
* Keyword <code>spaceVolume</code> is optional, it redefine the space volume of this sash container in screen. A number will be defined to representing the relative size of this container.
* Keyword <code>accessibility</code> is optional, it can be any string; this field is provided as a way to inform accessibility screen readers with extra information. The intent is that the reader should 'say' this phrase as well as what it would normally emit given the widget hierarchy. A screen reader is an essential piece of software for a blind or visually impaired person. Simply put, a screen reader transmits whatever text is displayed on the computer screen into a form that a visually impaired user can process (usually tactile, auditory or a combination of both). While the most basic screen readers will not help blind users navigate a computer, those with additional features can give people with visual impairment much more independence.

► '''Example''':
<syntaxhighlight lang="java">
perspective Employee described by "Employee maintenance" iconURI "employee" {
sashContainer outer orientation vertical {
sashContainer top orientation horizontal {
. . .
}
sashContainer bottom orientation horizontal {
. . .
}
}
}
</syntaxhighlight>

In this example, in the first place, the <code>sash container</code> '''''outer''''' is defined, in this sash container, 2 second level <code>sash containers</code> are defined as horizontal, they are '''''top''''' and '''''bottom'''''.

=====partStack=====

Keyword <code>partStack</code> is used to define the main element part stack of perspective.

A part stack contains a stack of parts showing the contents of one part while displaying only the headers of the other parts.

► '''Syntax''':
<syntaxhighlight lang="java">
partStack <PerspectivePartStack ID>
[selectedElement <PerspectivePart ID>]
&
[spaceVolume <containerData STRING>]
&
[accessibility <accessibilityPhrase STRING>]
{
PerspectiveElement
. . .
}
</syntaxhighlight>

* Keyword <code>selectedElement</code> is optional; you can select the next level perspective element here and which is selected will be shown in the first place.
* Keyword <code>spaceVolume</code> is optional, it redefine the space volume of this part stack in screen. A number will be defined to representing the relative size of this part stack.
* Keyword <code>accessibility</code> is optional, it can be any string; this field is provided as a way to inform accessibility screen readers with extra information. The intent is that the reader should 'say' this phrase as well as what it would normally emit given the widget hierarchy. A screen reader is an essential piece of software for a blind or visually impaired person. Simply put, a screen reader transmits whatever text is displayed on the computer screen into a form that a visually impaired user can process (usually tactile, auditory or a combination of both). While the most basic screen readers will not help blind users navigate a computer, those with additional features can give people with visual impairment much more independence.

► '''Example''':
<syntaxhighlight lang="java">
perspective Employee described by "Employee maintenance" iconURI "employee" {
sashContainer outer orientation vertical {
sashContainer top orientation horizontal {
. . .
}
sashContainer bottom orientation horizontal {
partStack EmployeeStack spaceVolume "70" {
. . .
}
partStack Payroll spaceVolume "30" {
. . .
}
}
}
}
</syntaxhighlight>

In this example, 2 <code>part stacks</code> are defined under <code>sash container</code> '''''bottom''''', they are '''''EmployeeStack''''' and '''''Payroll'''''. The sizes of them are redefined here, '''''EmployeeStack''''' takes 70% of the screen width and '''''payroll''''' takes the rest 30%.

=====part=====

Keyword part is used to define the main element part of perspective.

► '''Syntax''':
<syntaxhighlight lang="java">
part <PerspectivePart ID>
[described by <description String>]
&
[spaceVolume <containerData STRING>]
&
[accessibility <accessibilityPhrase STRING>]
&
[iconURI <iconURI string>]
&
[view select <table.Table> | table <table.Table>
| chart <chart.Chart> | report <report.Report>
| organigram <organization.Organization>
| topology <topology.Topology>
| dialog <dialog.Dialog> | bpmn | grid <table.Table>
]
&
[isClosable]
</syntaxhighlight>

* Keyword <code>described by</code> is optional; you can use this keyword to define the description of this part.
* Keyword <code>spaceVolume</code> is optional, it redefine the space volume of this part in screen. A number will be defined to representing the relative size of this part.
* Keyword <code>accessibility</code> is optional, it can be any string; this field is provided as a way to inform accessibility screen readers with extra information. The intent is that the reader should 'say' this phrase as well as what it would normally emit given the widget hierarchy. A screen reader is an essential piece of software for a blind or visually impaired person. Simply put, a screen reader transmits whatever text is displayed on the computer screen into a form that a visually impaired user can process (usually tactile, auditory or a combination of both). While the most basic screen readers will not help blind users navigate a computer, those with additional features can give people with visual impairment much more independence.
* Keyword <code>iconURI</code> is optional, it define the identifier for a resource, e.g. icon file
* Keyword <code>view</code> is optional, it defines the predefined view of this part, it can be report, dialog, table, chart, organigram, topology, bpmn.
* Keyword <code>isClosable</code> is optional; it will allow the user to close this part when this keyword is selected.

► '''Example''':
<syntaxhighlight lang="java">
perspective Employee described by "Employee maintenance" iconURI "employee" {
sashContainer outer orientation vertical {
sashContainer top orientation horizontal {
part Orga spaceVolume "40" view organigram FoodMart
part Employees spaceVolume "20" view table Employees
part EmployeeDialog spaceVolume "40" view dialog Employee
}
. . .
}
}
</syntaxhighlight>

In this example, 3 <code>parts</code> are defined under <code>sash container</code> '''''top''''', they are '''''Orga''''', '''''Employees''''' and '''''EmployeeDialog'''''. The sizes of them are redefined here, '''''Orga''''' and '''''EmployeeDialog''''' take each 40% of the screen width and '''''Employees''''' takes the remaining 20%. The view of '''''Orga''''' is the predefined <code>organigram</code> '''''FoodMart'''''; the view of '''''Employees''''' is the predefined <code>table</code> '''''Employee'''''; and the view of '''''EmployeeDialog''''' is the predefined <code>dialog</code> '''''Employee'''''.

== Copyright Notice ==
{{Copyright Notice}}

Organization DSL

2017-07-26T21:09:05Z

Cmollik: /* position= */

==Introduction==

OrganizationDSL is used to define the organizations and their positions. The roles which are defined in [[Authorization DSL]] could be assigned to the positions here.

==OrganizationDSL==

The OrganizationDSL is working at runtime. It used to define the organizations, their positions and assign the roles to them. There will be no exported file generated after editing the model. Each user should have its own position, and the roles defined in [[Authorization DSL]] could be assigned to the positions. The authorization of user will be done according to the authorization rules of roles at runtime.

The main semantic elements of the OrganizationDSL are:

* “package” - the root element that contains all the other elements. A model can contain multiple packages.

* “organization” - define organization and its positions in the fact, e.g. president, VP, manager. . .

* “superiorPos” - define which position is the superior position of the current position.

* “position” - define the position details, including superior position and role.

* “role” - assign the roles which are defined in [[Authorization DSL]] to the positions.

===Syntax===

====package definition====

► '''Syntax''':
<syntaxhighlight lang="java">
package <package name> {
organization <organization name> . . . [{...}]
...
}
</syntaxhighlight>

The package definition of OrganizationDSL is just like most of the DSL models, you just need to define the package name and in eclipse like other java project press ctrl+shift+o, all necessary models or java classes will be imported automatically. After that, you can define the organizations and positions. One or more organizations can be defined in the same package.

► '''Example''':
<syntaxhighlight lang="java">
package org.eclipse.osbp.foodmart.authorizations {
import org.eclipse.osbp.foodmart.authorizations.*
. . .
organization FoodMart . . . {. . .}
. . .
}
</syntaxhighlight>

====organization====

This is the main part of this model. Either position or sub-organization could be defined in the main organization.

► '''Syntax''':
<syntaxhighlight lang="java">
organization <mainOrganization name 1> Title <organization title 1> [{
position <mainPosition name> {. . .}
[position <position name> superiorPos <superiorPosition name 1> {. . .}]
. . .
[organization <organization name 2> Title <organization title 2>
superiorPos <superiorPosition name 2> [{ . . . }]]
. . .
}]
</syntaxhighlight>

► '''Example''':
<syntaxhighlight lang="java">
organization FoodMart Title "Organization" {
position President {. . .}
position VP_Country_Manager superiorPos President {. . .}
. . .
organization Store_Manager_Org Title "Stores" superiorPos VP_Country_Manager {. . .}
. . .
}
</syntaxhighlight>

In this example, main <code>organization</code> '''''FoodMart''''' with <code>title</code> “Organization” is defined. Many positions and organizations can be defined in this main organization. The main <code>position</code> of this organization is '''''President'''''; another <code>position</code> '''''VP_Country_Manager''''' uses this main position as its superior position. A sub organization '''''Store_Manager_Org''''' with <code>title</code> “Stores” is also defined in this main organization, which uses '''''VP_Country_Manager''''' as its superior position.

=====position======

You can define the position and its role here.

► '''Syntax''':
<syntaxhighlight lang="java">
position <position name> [superiorPos <position name>] {
[role <role name>]
. . .
}
</syntaxhighlight>

* If the position is not a main position of an organization, its superior position must be defined.

* Superior position must be defined before it is used.

* One position can be defined without role, and also can be defined with one or more roles.

* All roles must be defined in [[Authorization DSL]].

► '''Example''':
<syntaxhighlight lang="java">
organization Store_Manager_Org Title "Stores" superiorPos VP_Country_Manager {
position Store_Manager {
role Sales
}

position Store_Shift_Supervisor superiorPos Store_Manager {
role Sales
}

position Store_Temporary_Checker superiorPos Store_Shift_Supervisor {
}
. . .
}
</syntaxhighlight>

In this example, the <code>position</code> '''''Store_Manager''''' is the main position of the sub <code>organization</code> '''''Store_Manager_Org''''', so it is defined without a superior position; its superior position is defined by the definition of <code>organization</code> '''''Store_Manager_Org''''', which means, <code>position</code> '''''VP_Country_Manager''''' is the superior position of <code>position</code> '''''Store_Manager'''''. Another <code>position</code> '''''Store_Shift_Supervisor''''' is also defined in this organization, and <code>position</code> '''''Store_Manager''''' is its superior position. <code>role</code> '''''Sales''''' is assigned to both of the position. The third <code>position</code> '''''Store_Temporary_Checker''''' is under <code>position</code> '''''Store_Shift_Supervisor''''', it is defined without a role.

=====organization . . . superiorPos . . .=====

The sub organization could be defined in this part.

► '''Syntax''':
<syntaxhighlight lang="java">
organization <organization name 1> Title <organization title 1>
superiorPos <superiorPosition name 1> [{
position <mainPosition name> {. . .}
position <position name> superiorPos <superiorPosition name 2> {. . .}
. . .
[organization <organization name 2> Title <organization title 2>
superiorPos <superiorPosition name 3> [{ . . . }]]
. . .

}]
</syntaxhighlight>

* Sub organization must be defined with a superior position.

* Otherwise, the syntax of sub organization is totally as same as main organization.

► '''Example''':
<syntaxhighlight lang="java">
organization Store_Manager_Org Title "Stores" superiorPos VP_Country_Manager {
position Store_Manager {
role Sales
}

position Store_Assistant_Manager superiorPos Store_Manager {
role Sales
}
. . .
organization Store_Temporary_Stocker_Org Title "Stocker" superiorPos Store_Assistant_Manager {
position Store_Temporary_Stocker {
role Sales
}

position Store_Permanent_Butcher
superiorPos Store_Temporary_Stocker {
role Sales
}
}
}
</syntaxhighlight>

We use the same example, sub <code>organization</code> '''''Store_Manager_Org''''': <code>position</code> '''''Store_Assistant_Manager''''' is defined under main <code>position</code> '''''Store_Manager'''''. A new <code>organization</code> '''''Store_Temporary_Stocker_Org''''' is defined under <code>position</code> '''''Store_Assistant_Manager'''''; it has 2 <code>position</code>: main <code>position</code> is '''''Store_Temporary_Stocker''''', which default has the same superior <code>position</code> as this organization, in this case, it is '''''Store_Assistant_Manager'''''; another <code>position</code> is '''''Store_Permanent_Butcher''''' and its superior <code>position</code> is '''''Store_Temporary_Stocker'''''; <code>role</code> '''''Sales''''' is assigned to both of the position.

The whole organigram can be shown in os.bee applications like the following picture:

 [[File:OrganizationDSL_01.png|600px]] 

== Copyright Notice ==
{{Copyright Notice}}

Organization DSL

2017-07-26T21:08:30Z

Cmollik: /* OrganizationDSL */

==Introduction==

OrganizationDSL is used to define the organizations and their positions. The roles which are defined in [[Authorization DSL]] could be assigned to the positions here.

==OrganizationDSL==

The OrganizationDSL is working at runtime. It used to define the organizations, their positions and assign the roles to them. There will be no exported file generated after editing the model. Each user should have its own position, and the roles defined in [[Authorization DSL]] could be assigned to the positions. The authorization of user will be done according to the authorization rules of roles at runtime.

The main semantic elements of the OrganizationDSL are:

* “package” - the root element that contains all the other elements. A model can contain multiple packages.

* “organization” - define organization and its positions in the fact, e.g. president, VP, manager. . .

* “superiorPos” - define which position is the superior position of the current position.

* “position” - define the position details, including superior position and role.

* “role” - assign the roles which are defined in [[Authorization DSL]] to the positions.

===Syntax===

====package definition====

► '''Syntax''':
<syntaxhighlight lang="java">
package <package name> {
organization <organization name> . . . [{...}]
...
}
</syntaxhighlight>

The package definition of OrganizationDSL is just like most of the DSL models, you just need to define the package name and in eclipse like other java project press ctrl+shift+o, all necessary models or java classes will be imported automatically. After that, you can define the organizations and positions. One or more organizations can be defined in the same package.

► '''Example''':
<syntaxhighlight lang="java">
package org.eclipse.osbp.foodmart.authorizations {
import org.eclipse.osbp.foodmart.authorizations.*
. . .
organization FoodMart . . . {. . .}
. . .
}
</syntaxhighlight>

====organization====

This is the main part of this model. Either position or sub-organization could be defined in the main organization.

► '''Syntax''':
<syntaxhighlight lang="java">
organization <mainOrganization name 1> Title <organization title 1> [{
position <mainPosition name> {. . .}
[position <position name> superiorPos <superiorPosition name 1> {. . .}]
. . .
[organization <organization name 2> Title <organization title 2>
superiorPos <superiorPosition name 2> [{ . . . }]]
. . .
}]
</syntaxhighlight>

► '''Example''':
<syntaxhighlight lang="java">
organization FoodMart Title "Organization" {
position President {. . .}
position VP_Country_Manager superiorPos President {. . .}
. . .
organization Store_Manager_Org Title "Stores" superiorPos VP_Country_Manager {. . .}
. . .
}
</syntaxhighlight>

In this example, main <code>organization</code> '''''FoodMart''''' with <code>title</code> “Organization” is defined. Many positions and organizations can be defined in this main organization. The main <code>position</code> of this organization is '''''President'''''; another <code>position</code> '''''VP_Country_Manager''''' uses this main position as its superior position. A sub organization '''''Store_Manager_Org''''' with <code>title</code> “Stores” is also defined in this main organization, which uses '''''VP_Country_Manager''''' as its superior position.

=====position======

You can define the position and its role here.

► '''Syntax''':
<syntaxhighlight lang="java">
position <position name> [superiorPos <position name>] {
[role <role name>]
. . .
}
</syntaxhighlight>

* If the position is not a main position of an organization, its superior position must be defined.

* Superior position must be defined before it is used.

* One position can be defined without role, and also can be defined with one or more roles.

* All roles must be defined in AuthorizationDSL.

► '''Example''':
<syntaxhighlight lang="java">
organization Store_Manager_Org Title "Stores" superiorPos VP_Country_Manager {
position Store_Manager {
role Sales
}

position Store_Shift_Supervisor superiorPos Store_Manager {
role Sales
}

position Store_Temporary_Checker superiorPos Store_Shift_Supervisor {
}
. . .
}
</syntaxhighlight>

In this example, the <code>position</code> '''''Store_Manager''''' is the main position of the sub <code>organization</code> '''''Store_Manager_Org''''', so it is defined without a superior position; its superior position is defined by the definition of <code>organization</code> '''''Store_Manager_Org''''', which means, <code>position</code> '''''VP_Country_Manager''''' is the superior position of <code>position</code> '''''Store_Manager'''''. Another <code>position</code> '''''Store_Shift_Supervisor''''' is also defined in this organization, and <code>position</code> '''''Store_Manager''''' is its superior position. <code>role</code> '''''Sales''''' is assigned to both of the position. The third <code>position</code> '''''Store_Temporary_Checker''''' is under <code>position</code> '''''Store_Shift_Supervisor''''', it is defined without a role.

=====organization . . . superiorPos . . .=====

The sub organization could be defined in this part.

► '''Syntax''':
<syntaxhighlight lang="java">
organization <organization name 1> Title <organization title 1>
superiorPos <superiorPosition name 1> [{
position <mainPosition name> {. . .}
position <position name> superiorPos <superiorPosition name 2> {. . .}
. . .
[organization <organization name 2> Title <organization title 2>
superiorPos <superiorPosition name 3> [{ . . . }]]
. . .

}]
</syntaxhighlight>

* Sub organization must be defined with a superior position.

* Otherwise, the syntax of sub organization is totally as same as main organization.

► '''Example''':
<syntaxhighlight lang="java">
organization Store_Manager_Org Title "Stores" superiorPos VP_Country_Manager {
position Store_Manager {
role Sales
}

position Store_Assistant_Manager superiorPos Store_Manager {
role Sales
}
. . .
organization Store_Temporary_Stocker_Org Title "Stocker" superiorPos Store_Assistant_Manager {
position Store_Temporary_Stocker {
role Sales
}

position Store_Permanent_Butcher
superiorPos Store_Temporary_Stocker {
role Sales
}
}
}
</syntaxhighlight>

We use the same example, sub <code>organization</code> '''''Store_Manager_Org''''': <code>position</code> '''''Store_Assistant_Manager''''' is defined under main <code>position</code> '''''Store_Manager'''''. A new <code>organization</code> '''''Store_Temporary_Stocker_Org''''' is defined under <code>position</code> '''''Store_Assistant_Manager'''''; it has 2 <code>position</code>: main <code>position</code> is '''''Store_Temporary_Stocker''''', which default has the same superior <code>position</code> as this organization, in this case, it is '''''Store_Assistant_Manager'''''; another <code>position</code> is '''''Store_Permanent_Butcher''''' and its superior <code>position</code> is '''''Store_Temporary_Stocker'''''; <code>role</code> '''''Sales''''' is assigned to both of the position.

The whole organigram can be shown in os.bee applications like the following picture:

 [[File:OrganizationDSL_01.png|600px]] 

== Copyright Notice ==
{{Copyright Notice}}

Organization DSL

2017-07-26T21:08:01Z

Cmollik: /* Introduction */

==Introduction==

OrganizationDSL is used to define the organizations and their positions. The roles which are defined in [[Authorization DSL]] could be assigned to the positions here.

==OrganizationDSL==

The OrganizationDSL is working at runtime. It used to define the organizations, their positions and assign the roles to them. There will be no exported file generated after editing the model. Each user should have its own position, and the roles defined in AuthorizationDSL could be assigned to the positions. The authorization of user will be done according to the authorization rules of roles at runtime.

The main semantic elements of the OrganizationDSL are:

* “package” - the root element that contains all the other elements. A model can contain multiple packages.

* “organization” - define organization and its positions in the fact, e.g. president, VP, manager. . .

* “superiorPos” - define which position is the superior position of the current position.

* “position” - define the position details, including superior position and role.

* “role” - assign the roles which are defined in AuthorizationDSL to the positions.

===Syntax===

====package definition====

► '''Syntax''':
<syntaxhighlight lang="java">
package <package name> {
organization <organization name> . . . [{...}]
...
}
</syntaxhighlight>

The package definition of OrganizationDSL is just like most of the DSL models, you just need to define the package name and in eclipse like other java project press ctrl+shift+o, all necessary models or java classes will be imported automatically. After that, you can define the organizations and positions. One or more organizations can be defined in the same package.

► '''Example''':
<syntaxhighlight lang="java">
package org.eclipse.osbp.foodmart.authorizations {
import org.eclipse.osbp.foodmart.authorizations.*
. . .
organization FoodMart . . . {. . .}
. . .
}
</syntaxhighlight>

====organization====

This is the main part of this model. Either position or sub-organization could be defined in the main organization.

► '''Syntax''':
<syntaxhighlight lang="java">
organization <mainOrganization name 1> Title <organization title 1> [{
position <mainPosition name> {. . .}
[position <position name> superiorPos <superiorPosition name 1> {. . .}]
. . .
[organization <organization name 2> Title <organization title 2>
superiorPos <superiorPosition name 2> [{ . . . }]]
. . .
}]
</syntaxhighlight>

► '''Example''':
<syntaxhighlight lang="java">
organization FoodMart Title "Organization" {
position President {. . .}
position VP_Country_Manager superiorPos President {. . .}
. . .
organization Store_Manager_Org Title "Stores" superiorPos VP_Country_Manager {. . .}
. . .
}
</syntaxhighlight>

In this example, main <code>organization</code> '''''FoodMart''''' with <code>title</code> “Organization” is defined. Many positions and organizations can be defined in this main organization. The main <code>position</code> of this organization is '''''President'''''; another <code>position</code> '''''VP_Country_Manager''''' uses this main position as its superior position. A sub organization '''''Store_Manager_Org''''' with <code>title</code> “Stores” is also defined in this main organization, which uses '''''VP_Country_Manager''''' as its superior position.

=====position======

You can define the position and its role here.

► '''Syntax''':
<syntaxhighlight lang="java">
position <position name> [superiorPos <position name>] {
[role <role name>]
. . .
}
</syntaxhighlight>

* If the position is not a main position of an organization, its superior position must be defined.

* Superior position must be defined before it is used.

* One position can be defined without role, and also can be defined with one or more roles.

* All roles must be defined in AuthorizationDSL.

► '''Example''':
<syntaxhighlight lang="java">
organization Store_Manager_Org Title "Stores" superiorPos VP_Country_Manager {
position Store_Manager {
role Sales
}

position Store_Shift_Supervisor superiorPos Store_Manager {
role Sales
}

position Store_Temporary_Checker superiorPos Store_Shift_Supervisor {
}
. . .
}
</syntaxhighlight>

In this example, the <code>position</code> '''''Store_Manager''''' is the main position of the sub <code>organization</code> '''''Store_Manager_Org''''', so it is defined without a superior position; its superior position is defined by the definition of <code>organization</code> '''''Store_Manager_Org''''', which means, <code>position</code> '''''VP_Country_Manager''''' is the superior position of <code>position</code> '''''Store_Manager'''''. Another <code>position</code> '''''Store_Shift_Supervisor''''' is also defined in this organization, and <code>position</code> '''''Store_Manager''''' is its superior position. <code>role</code> '''''Sales''''' is assigned to both of the position. The third <code>position</code> '''''Store_Temporary_Checker''''' is under <code>position</code> '''''Store_Shift_Supervisor''''', it is defined without a role.

=====organization . . . superiorPos . . .=====

The sub organization could be defined in this part.

► '''Syntax''':
<syntaxhighlight lang="java">
organization <organization name 1> Title <organization title 1>
superiorPos <superiorPosition name 1> [{
position <mainPosition name> {. . .}
position <position name> superiorPos <superiorPosition name 2> {. . .}
. . .
[organization <organization name 2> Title <organization title 2>
superiorPos <superiorPosition name 3> [{ . . . }]]
. . .

}]
</syntaxhighlight>

* Sub organization must be defined with a superior position.

* Otherwise, the syntax of sub organization is totally as same as main organization.

► '''Example''':
<syntaxhighlight lang="java">
organization Store_Manager_Org Title "Stores" superiorPos VP_Country_Manager {
position Store_Manager {
role Sales
}

position Store_Assistant_Manager superiorPos Store_Manager {
role Sales
}
. . .
organization Store_Temporary_Stocker_Org Title "Stocker" superiorPos Store_Assistant_Manager {
position Store_Temporary_Stocker {
role Sales
}

position Store_Permanent_Butcher
superiorPos Store_Temporary_Stocker {
role Sales
}
}
}
</syntaxhighlight>

We use the same example, sub <code>organization</code> '''''Store_Manager_Org''''': <code>position</code> '''''Store_Assistant_Manager''''' is defined under main <code>position</code> '''''Store_Manager'''''. A new <code>organization</code> '''''Store_Temporary_Stocker_Org''''' is defined under <code>position</code> '''''Store_Assistant_Manager'''''; it has 2 <code>position</code>: main <code>position</code> is '''''Store_Temporary_Stocker''''', which default has the same superior <code>position</code> as this organization, in this case, it is '''''Store_Assistant_Manager'''''; another <code>position</code> is '''''Store_Permanent_Butcher''''' and its superior <code>position</code> is '''''Store_Temporary_Stocker'''''; <code>role</code> '''''Sales''''' is assigned to both of the position.

The whole organigram can be shown in os.bee applications like the following picture:

 [[File:OrganizationDSL_01.png|600px]] 

== Copyright Notice ==
{{Copyright Notice}}

Authorization DSL

2017-07-26T21:06:05Z

Cmollik: /* AuthorizationDSL */

==Introduction==

AuthorizationDSL is used to authorize the roles at runtime. For example, when the sales and logistics check the same entity of article, the sales do not need to know how many cases per pallet for an article, so it should be invisible in vision of the sales; the logistics do not need to know how much costs the article, so in vision of the logistics, the price should not be displayed.

==AuthorizationDSL==

The AuthorizationDSL is working at runtime. It's used to define the roles and authorize them. Visibility processor at runtime calculates the authorization of e.g. invisible or editable for the roles; Blips are working for the bpm process at runtime, e.g. starting the user task.

There will be no exported file generated after editing the model. The authorization rules will be store in a hash map at runtime. Each user should have its own position, and the role will be assigned to the positions in [[Organization DSL]], which is also working at runtime.

The authorization at runtime will be done according to the rules which we defined in AuthorizationDSL.

The main semantic elements of the AuthorizationDSL are:

* “package” - the root element that contains all the other elements. A model can contain multiple packages.

* “role” - define the role in the fact, e.g. sales, logistics…It contains further elements such as entity and process.

* "entity” - define which entity should be authorized, and how to authorize it for the roles, the entity is defined in [[Entity DSL]] model.

* “attribute” - define the authorization of the entity attributes for the roles.
* “relation” - define the authorization of the referenced entity for the roles.

* “process - define which process is startable and if the user task of this process is executable for the roles. The process is defined in BlipDSL model.

* “usertask” - define which user task is executable for the roles.

===Syntax===

====package definition====

► '''Syntax''':
<syntaxhighlight lang="java">
package <package name> {
role <role name> {...}
...
}
</syntaxhighlight>

The package definition of AuthorizationDSL is just like most of the DSL models, you just need to define the package name and in eclipse like other java project press ctrl+shift+o, all necessary models or java classes will be imported automatically. After that, you can define the roles and their authorization rules. One or more roles can be defined in the same package.

► '''Example''':
<syntaxhighlight lang="java">
package org.eclipse.osbp.foodmart.authorizations {
import org.eclipse.osbp.foodmart.entities.*
import org.eclipse.osbp.foodmart.blips.*
. . .
role Sales {. . .}
. . .
}
</syntaxhighlight>

====role====

This is the main part of this model. Either entity or process could be authorized in this part.

► '''Syntax''':
<syntaxhighlight lang="java">
role <role name> {
entity <entity name> ... [{ ... }]
...
process <blip name>{ ... }
...
}
</syntaxhighlight>

► '''Example''':
<syntaxhighlight lang="java">
role Sales {
entity Mproduct_class any
entity Memployee any {. . .}
process ProductMaintenance {. . .}
. . .
}
</syntaxhighlight>

In this example, the authorization rule for <code>role</code> '''''Sales''''' will be defined. The rules are using to <code>entity</code> '''''Mproduct_class''''', <code>entity</code> '''''Memployee''''' and <code>process</code> '''''ProductMaintenance'''''.

=====entity=====

You can define the authorization rule for the whole entity or for one or more attribute/reference of this entity.

► '''Syntax''':
<syntaxhighlight lang="java">
entity <entity name> RoleEnum [{
attribute <entityAttribute name> invisible|disabled|noneditable
relation <entityReference name> invisible|disabled|noneditable
...
}]
</syntaxhighlight>

* RoleEnum is including any, creatable, readable, updatable and deletable. It is defined for the whole entity. any means allowed all. Otherwise, only the operation which is listed is allowed, they are creatable, readable, updatable and deletable; it can be one or more operations listed at the same time.

* Entity attribute and reference could be authorized as invisible, disabled and noneditable. Only the operation which is listed is allowed, it can be one or more operations listed at the same time.

► '''Example''':
<syntaxhighlight lang="java">
entity Mproduct_class any

entity Memployee any {
attribute first_name invisible
relation position noneditable
}
</syntaxhighlight>
The following picture is a dialog of <code>entity</code> '''''Memployee''''', you could see for the <code>role</code> '''''sales''''', the attribute '''''first_name''''' is not shown, only '''''full_name''''' and '''''last_name''''' is shown; the reference '''''position''''' is not editable. [[File:AuthorizationDSL_01.png|600px]] 

=====process=====
The process and the user task in this process could be authorized in this part.

► '''Syntax''':
<syntaxhighlight lang="java">
process <blip name>{
[is startable]
[all usertasks executable]
usertask <blipUserTask name | userTask name> executable
...
}
</syntaxhighlight>

* <code>is startable</code> means: this process is allowed to be started.
* <code>all usertasks executable</code> means: all user tasks of this process are allowed to be executed.
* If not all the user tasks are allowed to be executed, you can define here which user task is allowed to be executed using keyword <code>usertask … executable</code>.

► '''Example''':
<syntaxhighlight lang="java">
process ProductMaintenance {
is startable
all usertasks executable
}
</syntaxhighlight>

== Copyright Notice ==
{{Copyright Notice}}

Authorization DSL

2017-07-26T21:04:48Z

Cmollik: /* AuthorizationDSL */

==Introduction==

AuthorizationDSL is used to authorize the roles at runtime. For example, when the sales and logistics check the same entity of article, the sales do not need to know how many cases per pallet for an article, so it should be invisible in vision of the sales; the logistics do not need to know how much costs the article, so in vision of the logistics, the price should not be displayed.

==AuthorizationDSL==

The AuthorizationDSL is working at runtime. It's used to define the roles and authorize them. Visibility processor at runtime calculates the authorization of e.g. invisible or editable for the roles; Blips are working for the bpm process at runtime, e.g. starting the user task.

There will be no exported file generated after editing the model. The authorization rules will be store in a hash map at runtime. Each user should have its own position, and the role will be assigned to the positions in OrganizationDSL, which is also working at runtime.

The authorization at runtime will be done according to the rules which we defined in AuthorizationDSL.

The main semantic elements of the AuthorizationDSL are:

* “package” - the root element that contains all the other elements. A model can contain multiple packages.

* “role” - define the role in the fact, e.g. sales, logistics…It contains further elements such as entity and process.

* "entity” - define which entity should be authorized, and how to authorize it for the roles, the entity is defined in [[Entity DSL]] model.

* “attribute” - define the authorization of the entity attributes for the roles.
* “relation” - define the authorization of the referenced entity for the roles.

* “process - define which process is startable and if the user task of this process is executable for the roles. The process is defined in BlipDSL model.

* “usertask” - define which user task is executable for the roles.

===Syntax===

====package definition====

► '''Syntax''':
<syntaxhighlight lang="java">
package <package name> {
role <role name> {...}
...
}
</syntaxhighlight>

The package definition of AuthorizationDSL is just like most of the DSL models, you just need to define the package name and in eclipse like other java project press ctrl+shift+o, all necessary models or java classes will be imported automatically. After that, you can define the roles and their authorization rules. One or more roles can be defined in the same package.

► '''Example''':
<syntaxhighlight lang="java">
package org.eclipse.osbp.foodmart.authorizations {
import org.eclipse.osbp.foodmart.entities.*
import org.eclipse.osbp.foodmart.blips.*
. . .
role Sales {. . .}
. . .
}
</syntaxhighlight>

====role====

This is the main part of this model. Either entity or process could be authorized in this part.

► '''Syntax''':
<syntaxhighlight lang="java">
role <role name> {
entity <entity name> ... [{ ... }]
...
process <blip name>{ ... }
...
}
</syntaxhighlight>

► '''Example''':
<syntaxhighlight lang="java">
role Sales {
entity Mproduct_class any
entity Memployee any {. . .}
process ProductMaintenance {. . .}
. . .
}
</syntaxhighlight>

In this example, the authorization rule for <code>role</code> '''''Sales''''' will be defined. The rules are using to <code>entity</code> '''''Mproduct_class''''', <code>entity</code> '''''Memployee''''' and <code>process</code> '''''ProductMaintenance'''''.

=====entity=====

You can define the authorization rule for the whole entity or for one or more attribute/reference of this entity.

► '''Syntax''':
<syntaxhighlight lang="java">
entity <entity name> RoleEnum [{
attribute <entityAttribute name> invisible|disabled|noneditable
relation <entityReference name> invisible|disabled|noneditable
...
}]
</syntaxhighlight>

* RoleEnum is including any, creatable, readable, updatable and deletable. It is defined for the whole entity. any means allowed all. Otherwise, only the operation which is listed is allowed, they are creatable, readable, updatable and deletable; it can be one or more operations listed at the same time.

* Entity attribute and reference could be authorized as invisible, disabled and noneditable. Only the operation which is listed is allowed, it can be one or more operations listed at the same time.

► '''Example''':
<syntaxhighlight lang="java">
entity Mproduct_class any

entity Memployee any {
attribute first_name invisible
relation position noneditable
}
</syntaxhighlight>
The following picture is a dialog of <code>entity</code> '''''Memployee''''', you could see for the <code>role</code> '''''sales''''', the attribute '''''first_name''''' is not shown, only '''''full_name''''' and '''''last_name''''' is shown; the reference '''''position''''' is not editable. [[File:AuthorizationDSL_01.png|600px]] 

=====process=====
The process and the user task in this process could be authorized in this part.

► '''Syntax''':
<syntaxhighlight lang="java">
process <blip name>{
[is startable]
[all usertasks executable]
usertask <blipUserTask name | userTask name> executable
...
}
</syntaxhighlight>

* <code>is startable</code> means: this process is allowed to be started.
* <code>all usertasks executable</code> means: all user tasks of this process are allowed to be executed.
* If not all the user tasks are allowed to be executed, you can define here which user task is allowed to be executed using keyword <code>usertask … executable</code>.

► '''Example''':
<syntaxhighlight lang="java">
process ProductMaintenance {
is startable
all usertasks executable
}
</syntaxhighlight>

== Copyright Notice ==
{{Copyright Notice}}

OS.bee Software Factory Documentation

2017-07-26T21:00:55Z

Cmollik: /* OS.bee DSL Documentation */

=OS.bee DSL Documentation=
The ''OS.bee Software Factory'' is composed of various domain specific languages (DSLs), which are described in detail on the following pages.

==[[Entity DSL]]==
The [[Entity DSL]] is, beside Datatypes, the basic DSL for the Software Factory. It allows you, through the creation of entity model files, to describe the entity relationship models that will be used to create, read, update and delete content on a persistence level, such as with an SQL database.

==[[DTO DSL]]==
The [[DTO DSL]] handles data transfer objects in order to transfer data between processes. It uses the [[Entity DSL]].

==[[Chart DSL]]==
The [[Chart DSL]] provides Vaadin dCharts.

==[[Cube DSL]]==
The [[Cube DSL]] provides MDX access to Mondrian OLAP Cubes.

==[[Datamart DSL]]==
A datamart is a condensed and more focused version of a data warehouse that reflects the regulations and process specifications of each business unit within an organization. Each datamart is dedicated to a specific business function or region.

==[[Dialog DSL]]==
The [[Dialog DSL]] generates the [https://vaadin.com/home Vaadin] UI

==[[Report DSL]]==
The [[Report DSL]] generates the [https://vaadin.com/home Vaadin] UI and the [http://developer.actuate.com/about/ BIRT] report module.

==[[Table DSL ]]==
The [[Table DSL]] generates the [https://vaadin.com/home Vaadin] table UI.

==[[Topology DSL ]]==
The [[Topology DSL]] generates [https://d3js.org/ D3.js], a JavaScript library for manipulating documents based on data, to generate the visualization of topology charts. Data used is [https://github.com/topojson topojson], an extension of [http://geojson.org/ GeoJSON] that encodes topology and the corresponding UI components.

==[[Entitymock DSL]]==
The [[Entitymock DSL]] generates mock data for entity models automatically upon initialization.

==[[Statemachine DSL]]==
The [[Statemachine DSL]] adds behavior to user interfaces. Instances of this DSL interconnect UI instances, FunctionLibrary instances, persistence layers and peripheral devices, and therefore act as controllers in a multiple Model-View-Controller environment. There is no limitation of how many statemachine instances control a single business application.

==[[Authorization DSL]]==

==[[Organization DSL]]==

==[[Perspective DSL]]==

==[[Action DSL]]==

==[[Menu DSL]]==

==[[How to add pictures]]==

=OS.bee-Specific DSL Instances=
The ''OS.bee Software Factory'' provides a few specific DSL instances for different requirements. These are described in detail on the following pages.

==Datatypes==
Several custom datatypes are described in detail in this chapter.
===[[BlobMapping]]===
This datatype allows the use of big data as a blob.

=Other OS.bee-Specific Solutions=
The ''OS.bee Software Factory'' also provides other solutions, which are described in detail on the following pages.

==[[Themes]]==

=OS.bee Third-Party Software Solutions=
OS.bee also uses products of other software vendors (third-party products) that are based on open-source products.

==[[Peripheral Devices]]==

Datamart DSL

2017-07-26T20:50:39Z

Cmollik: /* condensed */

== Datamart DSL ==

A data mart is a condensed and more focused version of a data warehouse, that reflects the regulations and process specifications of each business unit within an organization. Each data mart is dedicated to a specific business function or region.

'''Datamart DSL''' generates for each datamart a java file, in which the SQL query for entities, or MDX query for Cubes, or task client connection for BPM are defined.

The main semantic elements of the Datamart DSL are:
*'''package''' - The root element that contains all the other elements. A model can contain multiple packages.
*'''import''' declarations - Used to import external models or even Java classes.
*'''datamart''' - Defines which data warehouse and which entity/cube/BPM the datamart will use. It contains further elements such as navigation, properties, conditions for entity, derive, axis, slicer for cube and columns, conditions for BPM.
*'''navigation''' - Used to define joins of entities as “one-to-many” or “many-to-one”.
*'''one to many … to … / many to one … to …''' - Used to define joins of entities in an MDX query.
*'''properties''' - Used to define the properties of an entity.
*'''property''' - Used to define columns and axes for an entity.
*'''conditions''' - Used to define conditions for entities and BPMs.
*'''condition''' - Used to define a "Where"-clause for an entity query or conditions for BPM.
*'''derive … from …''' - Used to define a derived measure of a cube query.
*'''measure''' - Used in cubes to specify members of a special dimension or a quantity to measure, for example, unit sales of a product, or the cost price of inventory items.
*'''derived''' - Used for cubes for derived measures defined in the same datamart, instead of the keyword “measure”.
*'''axis''' - Used for cubes to define the members of the axis, which can be measures, derived measures, or an aggregation or function of a hierarchy.
*'''hierarchy''' - Used for cubes to define a set of members organized in a structure for convenient analysis. For example, the store hierarchy consists of the store name, city, state, and nation. The hierarchy allows you to form intermediate sub-totals: the sub-total for a state is the sum of the sub-totals of all of the cities in that state, each of which is the sum of the sub-totals of the stores in that city.
*'''slicer''' - Used for cubes to define the "Where"-clause in a cube query.
*'''columns''' - Used for BPMs to define one or more columns.
*'''column''' - Used for BPMs to define which BPM column is used in a datamart.

===Datamart definition===

► '''Syntax''':
<syntaxhighlight lang="java">
datamart <datamart name> [described by <discription>]
from <schema name> persistenceUnit <persistence unit name>
using entity/cube/task <entity/cube/task name> [<task mode> <mode name> for task] [nonempty values for cube] {
...
}
</syntaxhighlight>

'''Notes:'''
* This generates a ''<datamart name>Datamart.java'' file, in which a java class named <code><datamart name>Datamart</code> is defined. In this class (which is extended from java class <code>ACubeDatamart</code> or <code>AEntityDatamart</code>), the database connection, the querying of entities and cubes and the task-client connection of tasks are defined.
* <task name> can be <code>BusinessAdministrator</code>, <code>PotentialOwner</code>, <code>Recipient</code>, <code>TaskInitiator</code>, <code>TaskStakeholder</code> or <code>ExcludedOwner</code>.
* <task mode> can be <code>locale</code> (String), <code>host</code> (String) or <code>port</code> (Integer).'''

► '''Example''':
<syntaxhighlight lang="java">
datamart EmployeeSalary
from CCNGDEFAULT persistenceUnit "foodmart"
using entity Memployee {. . .}

datamart SalesByState described by "cube based profit review"
from CCNGDEFAULT persistenceUnit "foodmart"
using cube Sales nonempty values {. . .}

datamart TaskDetails described by "Task details"
from BPM persistenceUnit "drools"
using task BusinessAdministrator locale "de-DE" {. . .}

</syntaxhighlight>

===entity===

► '''Syntax''':
<syntaxhighlight lang="java">
datamart <datamart name> . . . using entity <entity A name> (tracking){
[navigation {. . .}]
[properties {. . .}]
[conditions {. . .}]
[filler rows <INTminRow> to <INTmaxRow>{. . .}]
}
</syntaxhighlight>

====navigation====
Using the <code>many to one</code> or <code>one to many</code> clause creates a JOIN of entities in a query.

======many to one … to entity …======
► '''Syntax''':
<syntaxhighlight lang="java">
entity <entity A name> {
navigation {
many to one <entity A name>.<entity B reference in entity A> to entity <entity B name> {
[navigation {. . . }]
[properties {. . . }]
[conditions {. . . }]
}
}
. . .
}
</syntaxhighlight>

► '''Example''':
<syntaxhighlight lang="java">
datamart EmployeeSalary from CCNGDEFAULT persistenceUnit "foodmart" using entity Memployee {
navigation {
many to one Memployee.position to entity Mposition {
properties {
property position_title on axis rows
property max_scale on axis columns
property min_scale on axis columns
}
conditions {
condition property pay_type = filtered
}
}
}
. . .
}

</syntaxhighlight>

The following Java code is generated:

<syntaxhighlight lang="java">
private String statement =
"select Mposition.MAX_SCALE as \"max_scale\",
Mposition.MIN_SCALE as \"min_scale\",
Mposition.POSITION_TITLE as \"position_title\"
. . .
from CCNG.MEMPLOYEE Memployee
left join CCNG.MPOSITION Mposition on(Mposition.id=Memployee.position_id)
where (Mposition.pay_type = $Mposition.pay_type$)
. . .";

private HashMap<Integer, ArrayList<String>> axisMap = new HashMap<Integer,ArrayList<String>>() {{
put(0,new ArrayList<String>() {{
. . .
add("max_scale");
add("min_scale");
}});
put(1,new ArrayList<String>() {{
. . .
add("position_title");
}});
}};

</syntaxhighlight>

======one to many … to entity …======
► '''Syntax''':
<syntaxhighlight lang="java">
entity <entity A name> {
navigation {
one to many <entity A name>.<entity B reference in entity A> to entity <entity B name> {
[navigation {. . . }]
[properties {. . . }]
[conditions {. . . }]
}
}
. . .
}
</syntaxhighlight>

► '''Example''':
<syntaxhighlight lang="java">
datamart SalesByDistrict described by "entity based aggregation of store sales and store cost"
from CCNGDEFAULT persistenceUnit "foodmart"
using entity Mregion
{
navigation {
one to many Mstore.region to entity Mstore {
navigation {
one to many Msales_fact_1998.store to entity Msales_fact_1998 {
properties {
property store_sales aggregate summation on axis columns
property store_cost aggregate summation on axis columns
}
}
}
}
}
. . .
}
</syntaxhighlight>

The following Java code is generated:

<syntaxhighlight lang="java">
private String statement =
"select SUM(Msales_fact_1998.STORE_SALES) as \"store_sales\",
SUM(Msales_fact_1998.STORE_COST) as \"store_cost\"
. . .
from CCNG.MREGION Mregion
left join CCNG.MSTORE Mstore on(Mstore.region_id=Mregion.id)
left join CCNG.MSALES_FACT_1998 Msales_fact_1998 on(Msales_fact_1998.store_id=Mstore.id)
where . . . group by . . .";

private final HashMap<String, String> filterMap = new HashMap<String,String>()
{{
put("$Mregion.id$","&");
put("$Mstore.id$","&");
put("$Msales_fact_1998.id$","&");
. . .
}};

</syntaxhighlight>

====properties====

One or more properties are defined here, each using the <code>property</code> keyword and specifying which kind of aggregation of the property will be queried on which axis.

► '''Syntax''':
<syntaxhighlight lang="java">
properties {
property <entity A property> [aggregate <sql aggregation>]
[on axis <axis name>] [scale <scale group number>]
. . .
}
</syntaxhighlight>

'''Notes:'''
*<sql aggregation> can be average, summation or count.
*<axis name> can be ''columns'' or ''rows''.
*<scale group number> is in the range ''group1''-''group9''.

=====on axis ''rows''/''columns''=====

► '''Example''':
<syntaxhighlight lang="java">
property sales_region on axis rows
property store_sales _nm on axis columns
</syntaxhighlight>

The following Java code is generated:

<syntaxhighlight lang="java">
private HashMap<Integer, ArrayList<String>> axisMap = new HashMap<Integer,ArrayList<String>>() {{
put(0,new ArrayList<String>() {{
add("store_sales");
. . .
}});
put(1,new ArrayList<String>() {{
add("sales_region");
. . .
}});
}};
</syntaxhighlight>

=====aggregate=====

<sql aggregation> can be:
*'''average''' - SQL Avg() function, returns the average of (a subset of) all values in a specified column
*'''summation''' - SQL Sum() function, returns the sum of (a subset of) all values in a specified column.
*'''count''' - SQL Count() function, returns the total number of (a subset of) values in a specified column.

► '''Example''':
<syntaxhighlight lang="java">
property store_sales aggregate summation
</syntaxhighlight>

The following Java code is generated:

<syntaxhighlight lang="java">
private String statement =
"select SUM(Msales_fact_1998.STORE_SALES) as \"store_sales\", . . .
from . . . left join . . . on(. . .) group by . . . ";
</syntaxhighlight>

=====scale=====

Used to define different groups of scale values (<code>group1</code>-<code>group9</code>) for diagrams and tables.

► '''Example''':
<syntaxhighlight lang="java">
property store_sales scale group1
</syntaxhighlight>

====conditions====

► '''Syntax''':
<syntaxhighlight lang="java">
conditions {
condition
[<operator>]
Number
/STRING
/(filtered [optional])|selected
/property <entity A property> [aggregate <sql aggregation>]
/entitycolumn <entity C>.<entity C Property>
/column <task column>
[<operator>
Number
/STRING
/(filtered [optional])|selected
/property <entity A property> [aggregate <sql aggregation>]
/entitycolumn <entity D>.<entity D Property>
/column <task column>
]
}
</syntaxhighlight>

'''Notes:'''
*<operator> can be <code>()</code>, <code>=</code>, <code><</code>, <code>></code>, <code><=</code>, <code>>=</code>, <code>like</code>, <code>and</code> or <code>or</code>.
*<task column> can be <code>Name</code>, <code>Priority</code>, <code>Status</code>, <code>Subject</code>, <code>Description</code>, <code>ExpirationTime</code>, <code>CreatedOn</code>, <code>CreatedBy</code>, <code>ActivationTime</code>, <code>ActualOwner</code>, <code>TaskId</code>, <code>ProcessId</code>, <code>ProcessInstanceId</code> or <code>ProcessSessionId</code>.

=====selected=====

The specified column will be selectable in the GUI.

► '''Example''':
<syntaxhighlight lang="java">
condition property gtin_cd = selected
</syntaxhighlight>

The following Java code is generated:

<syntaxhighlight lang="java">
private String statement =
". . .
where (gtin.gtin_cd in (§gtin.gtin_cd§))
. . .";
private final HashMap<String, String> filterMap = new HashMap<String,String>()
{{
. . .
put("§gtin.gtin_cd§","select distinct GTIN_CD as \"gtin_cd\" from pod.GTIN");
}};
</syntaxhighlight>

=====filtered=====

The specified column will be filterable in the GUI.
<code>optional</code> means this specified column can be chosen for being filtered or not.

► '''Example 1''':
<syntaxhighlight lang="java">
condition property pay_type = filtered
</syntaxhighlight>

The following Java code is generated:

<syntaxhighlight lang="java">
private String statement =
". . .
where (Mposition.pay_type = $Mposition.pay_type$)
. . .";
private final HashMap<String, String> filterMap = new HashMap<String,String>()
{{
. . .
put("$Mposition.pay_type$","select distinct PAY_TYPE as \"pay_type\" from CCNG.MPOSITION");
}};
</syntaxhighlight>

► '''Example 2''':
<syntaxhighlight lang="java">
condition property education_level = filtered optional
</syntaxhighlight>

The following Java code is generated:

<syntaxhighlight lang="java">
private String statement =
". . .
where (($Memployee.education_level$='*' or Memployee.education_level = $Memployee.education_level$))
. . .";
private final HashMap<String, String> filterMap = new HashMap<String,String>() {{
. . .
put("$Memployee.education_level$","select '*' from dual union select distinct EDUCATION_LEVEL as \"education_level\" from CCNG.MEMPLOYEE");
}};
</syntaxhighlight>

=====filler rows ''mm'' to ''nn''=====

► '''Syntax''':
<syntaxhighlight lang="java">
filler rows <INTminRow> to <INTmaxRow>{
[fill <entity property> with
filler-address city
| filler-address postalcode
| filler-date future <INT> years
| filler-date past <INT> years
| filler-date range <+-INTby> up to and including <+-INTey> years
| filler-person full name
| filler-person first name
| filler-person last name
| filler-person email
| filler-person phone
| filler-person gender male as <STRINGmt> female as <STRINGft>
| filler-signed-double range
[ <+- Double> | <entity property>]
up to and including
[ <+- Double > | <entity property>]
with <INT> decimals
round to < Double >
| filler-signed-double random (<+-Double >)
| filler-signed-integer range
[ <+-INT> | <entity property>]
up to and including
[ <+-INT> | <entity property>]
round to <INT>
| filler-signed-integer random ( <+-INT> )
| filler-text random ( <STRING> )
| filler-text paragraps [<INT>]
| filler-text sentences [<INT>]
| filler-text words [<INT>]
| filler-unsigned-double range
[ < Double > | <entity property>]
up to and including
[ < Double > | <entity property>]
with <INT> decimals
round to < Double >
| filler-unsigned-double random ( < Double > )
| filler-unsigned-integer range
[ <INT> | <entity property>]
up to and including
[ <INT> | <entity property>]
round to <INT>
| filler-unsigned-integer random ( <INT> )
]
}

</syntaxhighlight>

===cube===

Use the keyword <code>cube</code> to define the data source cube of a FROM clause in an MDX query.

► '''Syntax''':
<syntaxhighlight lang="java">
datamart <datamart name> . . . using cube <cube name> [nonempty values] {
[derive <derived measure name> from
[<derive operator>]
Number
/Cube Measure
/Cube Derived Measure
/Cube Member Tuple
/Cube Aggregation
[<derive operator>]
[Number
/Cube Measure
/Cube Derived Measure
/Cube Member Tuple
/Cube Aggregation]
]
[axis <axis name> {
Cube Hierarchy
/Cube Measure
/Cube Derived Measure
/Cube Set Aggregation
}]
[slicer
Cube Hierarchy
/Cube Measure
/Cube Derived Measure
/Cube Set Aggregation
]
}
</syntaxhighlight>

====Keywords====

=====nonempty values=====

See the sections [[#NonEmpty() function]] and [[#NonEmptyCrossjoin() function]] later in this document.

► '''Syntax''':
<syntaxhighlight lang="java">
datamart <datamart name> [described by <description>]
from <schema name> persistenceUnit <persistence unit name>
using cube <cube name>
nonempty values
{
...
}
</syntaxhighlight>

The following Java code is generated:

<syntaxhighlight lang="java">
private String statement =
"select
Non Empty{ . . . } on columns,
NonEmptyCrossjoin(. . .) on rows
from
. . .";
</syntaxhighlight>

=====derive … from=====

Creates a Calculate Member.

► '''Syntax''':
<syntaxhighlight lang="java">
derive <derived measure name> from
[<derive operator>]
Number
/Cube Measure
/Cube Derived Measure
/Cube Member Tuple
/Cube Aggregation
[<derive operator>]
[Number
/Cube Measure
/Cube Derived Measure
/Cube Member Tuple
/Cube Aggregation]
</syntaxhighlight>

'''Notes:'''
*<code><derive operator></code> can be <code>+</code>, <code>-</code>, <code>*</code>, <code>/</code> or <code>()</code>.

► '''Example 1''':
<syntaxhighlight lang="java">
derive SumSales from measure SaleNumber * measure unitPrice
</syntaxhighlight>

The following Java code is generated:

<syntaxhighlight lang="java">
private String statement =
"with member [Measures].[SumSales] as '[Measures].[SaleNumber]*[Measures].[unitPrice]'
. . .";
</syntaxhighlight>

► '''Example 2''':
<syntaxhighlight lang="java">
derive MediaTotal from hierarchy PromotionMedia condensed over measure UnitSales
</syntaxhighlight>

The following Java code is generated:

<syntaxhighlight lang="java">
private String statement =
"with member [Measures].[MediaTotal] as '([Measures].[UnitSales],[PromotionMedia].[All Media])'
. . .";
</syntaxhighlight>

=====axis=====

Use the keyword <code>axis</code> to define the query axes of a SELECT clause in an MDX query.

► '''Syntax''':
<syntaxhighlight lang="java">
axis <axis name> {
Cube Hierarchy
/Cube Measure
/Cube Derived Measure
/Cube Set Aggregation
}
</syntaxhighlight>

'''Notes:'''
*<code><axis name></code> can be <code>columns</code>, <code>rows</code>, <code>pages</code>, <code>chapters</code> or <code>sections</code>.

► '''Example''':
<syntaxhighlight lang="java">
axis columns {
hierarchy PromotionMedia level MediaType detailed ordered by derived MediaPerc descending
derived MediaPerc
}
</syntaxhighlight>

The following Java code is generated:

<syntaxhighlight lang="java">
private String statement =
"select CrossJoin(Order([PromotionMedia].[MediaType].Members,[Measures].[MediaPerc],Desc),[Measures].[MediaPerc]) on columns
. . .";
</syntaxhighlight>
 

=====slicer=====

Use the keyword <code>slicer</code> to define the slicer axis of a WHERE clause in an MDX query.

► '''Syntax''':
<syntaxhighlight lang="java">
slicer
Cube Hierarchy
/Cube Measure
/Cube Derived Measure
/Cube Set Aggregation

</syntaxhighlight>

► '''Example''':
<syntaxhighlight lang="java">
</syntaxhighlight>

The following Java code is generated:

<syntaxhighlight lang="java">
private String statement =
". . .
where
. . .";
</syntaxhighlight>
 

====Definitions====

=====Cube Measure=====

<syntaxhighlight lang="java">
measure <cube measure> [scale <scale group number>]
</syntaxhighlight>

'''Notes:'''
*<code><scale group number></code> can have the values <code>group1</code>-<code>group9</code>, permitting different scales values for diagrams and tables.
 

=====Cube Derived Measure=====

<syntaxhighlight lang="java">
derived <derived measure name defined in this datamart>
[scale <scale group number>]

</syntaxhighlight>

'''Notes:'''
*<code><scale group number></code> can have the values <code>group1</code>-<code>group9</code>, permitting different scales values for diagrams and tables.
 

=====Cube Hierarchy=====

<syntaxhighlight lang="java">
hierarchy <hierarchy name>
[default]
[condensed]
[exploded]
[level <level name>
[filtered|selected]
]
[detailed
[except <level name>]
[ordered by
[Cube Measure
/Cube Derived Measure
]
[descending]
]
]
</syntaxhighlight>
 

======default======

'''Returns:''' <code>.DefaultMember</code> of hierarchy, if defaultMember of hierarchy ''is'' defined in [[Cube DSL]].

► '''Example:'''
<syntaxhighlight lang="java">
dimension PromotionMedia {
hierarchy hasAll allMemberName="All Media" defaultMember="All Media"{
. . .
}
}
</syntaxhighlight>

Then, we use the keyword <code>default</code> for a hierarchy in datamartDSL, e.g.:

<syntaxhighlight lang="java">
derive MediaTotal from hierarchy PromotionMedia default over measure UnitSales
</syntaxhighlight>

The following Java code is generated:

<syntaxhighlight lang="java">
private String statement =
"with member [Measures].[MediaTotal] as '([Measures].[UnitSales],[PromotionMedia].Defaultmember)
. . .";
</syntaxhighlight>

'''Returns:''' <code>.Members</code> of hierarchy, if defaultMember of hierarchy ''is not'' defined in [[Cube DSL]].

► '''Example:'''
<syntaxhighlight lang="java">
slicer hierarchy Warehouse default
</syntaxhighlight>

Then, we use the keyword <code>default</code> for a hierarchy in datamartDSL, e.g.:

<syntaxhighlight lang="java">
derive MediaTotal from hierarchy PromotionMedia default over measure UnitSales
</syntaxhighlight>

The following Java code is generated:

<syntaxhighlight lang="java">
private String statement =
"select . . .
from . . .
where ([Warehouse].Members)";

</syntaxhighlight>
 

======condensed======

'''Returns:''' <code>allMemberName</code> of hierarchy, if <code>allMemberName</code> of hierarchy defined in [[Cube DSL]].

► '''Example:'''
<syntaxhighlight lang="java">
dimension PromotionMedia {
hierarchy hasAll allMemberName="All Media" {
. . .
}
}
</syntaxhighlight>

Then, we use the keyword <code>condensed</code> for a hierarchy in datamartDSL, e.g.:

<syntaxhighlight lang="java">
derive MediaTotal from hierarchy PromotionMedia condensed over measure UnitSales
</syntaxhighlight>

The following Java code is generated:

<syntaxhighlight lang="java">
private String statement =
"with member [Measures].[MediaTotal] as '([Measures].[UnitSales],[PromotionMedia].[All Media])'
. . .";
</syntaxhighlight>

'''Returns:''' <code>.DefaultMember</code> of hierarchy, if defaultMember of hierarchy defined in [[Cube DSL]].

► '''Example:'''
<syntaxhighlight lang="java">
dimension PromotionMedia {
hierarchy hasAll defaultMember="All Media"{
. . .
}
}
</syntaxhighlight>

Then, we use the keyword <code>condensed</code> for a hierarchy in datamartDSL, e.g.:

<syntaxhighlight lang="java">
derive MediaTotal from hierarchy PromotionMedia condensed over measure UnitSales
</syntaxhighlight>

The following Java code is generated:

<syntaxhighlight lang="java">
private String statement =
"with member [Measures].[MediaTotal] as '([Measures].[UnitSales],[PromotionMedia].Defaultmember)
. . .";
</syntaxhighlight>

'''Returns:''' <code>.Members</code> of hierarchy if nothing is additionally defined for hierarchy in [[Cube DSL]].

► '''Example:'''
<syntaxhighlight lang="java">
slicer hierarchy Warehouse condensed
</syntaxhighlight>

The following Java code is generated:

<syntaxhighlight lang="java">
private String statement =
"select . . .
from . . .
where ([Warehouse].Members)";
</syntaxhighlight>
 

======exploded======

'''Returns:''' <code>.AllMembers</code> of hierarchy.

► '''Example:'''
<syntaxhighlight lang="java">
derive MediaTotal from hierarchy PromotionMedia exploded over measure UnitSales
</syntaxhighlight>

Then, we use the keyword <code>condensed</code> for a hierarchy in datamartDSL, e.g.:

<syntaxhighlight lang="java">
derive MediaTotal from hierarchy PromotionMedia condensed over measure UnitSales
</syntaxhighlight>

The following Java code is generated:

<syntaxhighlight lang="java">
private String statement =
"with member [Measures].[MediaTotal] as '([Measures].[UnitSales],[PromotionMedia].AllMembers)'
. . .";

</syntaxhighlight>
 

======level ... filtered======

The specified level can be filtered in the GUI.

► '''Example:''' in axis
<syntaxhighlight lang="java">
Datamart . . . {
. . .
axis rows {
hierarchy TheTime level Month filtered
hierarchy Store level StoreState selected
}
. . .
}

</syntaxhighlight>

The following Java code is generated:

<syntaxhighlight lang="java">
private String statement =
". . .
Select . . .
Crossjoin($[TheTime].[Month]$,§[Store].[StoreState]§) on rows
. . .";
private final HashMap<String, String> filterMap = new HashMap<String,String>() {{
put("$[TheTime].[Month]$","select {} on columns,[TheTime].[Month].members on rows from Sales");
. . . }};
</syntaxhighlight>

► '''Example:''' in slicer
<syntaxhighlight lang="java">
Datamart . . . {
. . .
slicer hierarchy TheTime level Quarter filtered
slicer hierarchy StoreType level StoreType selected
}

</syntaxhighlight>

The following Java code is generated:

<syntaxhighlight lang="java">
private String statement =
"select . . .
from . . .
where (?[TheTime].[Quarter]?,![StoreType].[StoreType]!)";
private final HashMap<String, String> filterMap = new HashMap<String,String>() {{
. . .
put("?[TheTime].[Quarter]?","select {} on columns,[TheTime].[Quarter].members on rows from Warehouse");
. . .
}};
</syntaxhighlight>
 

======level ... selected======

The specified level can be selected in the GUI.

► '''Example:''' in axis
<syntaxhighlight lang="java">
Datamart . . . {
. . .
axis rows {
hierarchy TheTime level Month filtered
hierarchy Store level StoreState selected
}
. . .
}

</syntaxhighlight>

The following Java code is generated:

<syntaxhighlight lang="java">
private String statement =
". . .
Select . . .
Crossjoin($[TheTime].[Month]$,§[Store].[StoreState]§) on rows
. . .";
private final HashMap<String, String> filterMap = new HashMap<String,String>()
{{
. . .
put("§[Store].[StoreState]§","select {} on columns,[Store].[StoreState].members on rows from Sales"); }};
</syntaxhighlight>

► '''Example:''' in slicer
<syntaxhighlight lang="java">
Datamart . . . {
. . .
slicer hierarchy TheTime level Quarter filtered
slicer hierarchy StoreType level StoreType selected
}
</syntaxhighlight>

The following Java code is generated:

<syntaxhighlight lang="java">
private String statement =
"select . . .
from . . .
where (?[TheTime].[Quarter]?,![StoreType].[StoreType]!)";
private final HashMap<String, String> filterMap = new HashMap<String,String>() {{
. . .
put("![StoreType].[StoreType]!","select {} on columns,[StoreType].[StoreType].members on rows from Warehouse");
}};
</syntaxhighlight>
 

======detailed======

► '''Returns:''' <code>.Members</code> of level.

► '''Example:'''
<syntaxhighlight lang="java">
axis pages {
hierarchy StoreType level StoreType detailed
}

</syntaxhighlight>

The following Java code is generated:

<syntaxhighlight lang="java">
private String statement =
"Select [StoreType].[StoreType].Members on pages
. . .";
</syntaxhighlight>

► '''Returns:''' <code>.Children</code> of level, if the keyword <code>filtered</code> or <code>selected</code> appears before the keyword <code>detailed</code>.

► '''Example:'''
<syntaxhighlight lang="java">
axis rows {
hierarchy TheTime level Month filtered detailed
hierarchy Store level StoreState selected detailed
}
</syntaxhighlight>

The following Java code is generated:

<syntaxhighlight lang="java">
private String statement =
". . .
Select . . .
Crossjoin($[TheTime].[Month]$.Children,§[Store].[StoreState]§.Children)
on rows
. . .";
</syntaxhighlight>
 

======except======

See the section [[#Except() function]] later in this document.

► '''Example:'''
<syntaxhighlight lang="java">
hierarchy TheTime level Month detailed except Quarter
</syntaxhighlight>

The following Java code is generated:

<syntaxhighlight lang="java">
private String statement =
". . .Except([TheTime].[Month].Members,{%[TheTime].[Quarter]%})
. . .";

</syntaxhighlight>
 

======order by ... (descending)======

See the section [[#Order() function]] later in this document.

► '''Example:'''
<syntaxhighlight lang="java">
hierarchy PromotionMedia level MediaType detailed ordered by derived MediaPerc descending
</syntaxhighlight>

The following Java code is generated:

<syntaxhighlight lang="java">
private String statement =
". . .
Order([PromotionMedia].[MediaType].Members,[Measures].[MediaPerc],Desc)
. . .";
</syntaxhighlight>
 

=====Cube Member Tuple=====

► '''Syntax:'''
<syntaxhighlight lang="java">
[<function name> / <parameter function name> (INT)
of ]
Cube Hierarchy
over
Cube Measure

</syntaxhighlight>

<code><function name></code> can be:
* '''previous''' - see the section [[#.PrevMember function]] later in this document.
* '''next''' - see the section [[#.NextMember function]] later in this document.
* '''first''' - see the section [[#.FirstChild function]] later in this document.
* '''last''' - see the section [[#.LastChild function]] later in this document.

<code><parameter function name></code> can be:
* '''lag''' - see the section [[#.Lag() function]] later in this document.
* '''lead''' - see the section [[#.Lead() function]] later in this document.

► '''Example:'''
<syntaxhighlight lang="java">
derive PrevPeriod from lag(01) of hierarchy TheTime over measure StoreSales
</syntaxhighlight>

The following Java code is generated:

<syntaxhighlight lang="java">
private String statement =
"with member [Measures].[PrevPeriod] as '([Measures].[StoreSales],[TheTime].LAG(1))'
. . .";
</syntaxhighlight>
 

=====Cube Set Tuple=====

► '''Syntax:'''
<syntaxhighlight lang="java">
<set function name> / <set parameter function name> (INT)
of
Cube Hierarchy
</syntaxhighlight>

<code><set function name></code> can be:
*'''year-to-date''' - See the section [[#YTD() function]] later in this document.
*'''periods''' - See the section [[#PeriodsToDate() function]] later in this document.

<code><set parameter function name></code> can be:
*'''tail''' - See the section [[#Tail() function]] later in this document.
*'''head''' - See the section [[#Head() function]] later in this document.

► '''Example:'''
<syntaxhighlight lang="java">
derive SumSCount from summation of periods of hierarchy TheTime level Year
filtered over measure SalesCount
</syntaxhighlight>

The following Java code is generated:

<syntaxhighlight lang="java">
private String statement =
"with member [Measures].[SumSCount] as
'SUM(PERIODSTODATE($[TheTime].[Year]$),[Measures].[SalesCount])'
. . .";
</syntaxhighlight>
 

=====Cube Aggregation=====

► '''Syntax:'''
<syntaxhighlight lang="java">
<aggregation name>
of
Cube Set Tuple
/Cube Hierarchy
over
Cube Measure
</syntaxhighlight>

<code><aggregation name></code> can be:
*'''average''' - See the section [[#Avg() function]] later in this document.
*'''summation''' - See the section [[#Sum() function]] later in this document.
*'''aggregate''' - See the section [[#Aggregate() function]] later in this document.
*'''deviation''' - See the section [[#StdDev() function]] later in this document.

► '''Example:'''
<syntaxhighlight lang="java">
derive SumSCount from summation of periods of hierarchy TheTime level Year
filtered over measure SalesCount
</syntaxhighlight>

The following Java code is generated:

<syntaxhighlight lang="java">
private String statement = "with member [Measures].[SumSCount] as
'SUM(PERIODSTODATE($[TheTime].[Year]$),[Measures].[SalesCount])' . . .";

</syntaxhighlight>

=====Cube Set Aggregation=====

► '''Syntax:'''
<syntaxhighlight lang="java">
<set aggregation name> (INT)
of
Cube Set Tuple
/Cube Hierarchy
over
Cube Measure
</syntaxhighlight>

<code><set aggregation name></code> can be:
*'''topcount''' - See the section [[#TopCount() function]] later in this document.
*'''topsummation''' - See the section [[#TopSum() function]] later in this document.
*'''toppercentage''' - See the section [[#TopPercent() function]] later in this document.
*'''bottomcount''' - See the section [[#BottomCount() function]] later in this document.
*'''bottomsummation''' - See the section [[#BottomSum() function]] later in this document.
*'''bottompercentage''' - See the section [[#BottomPercent() function]] later in this document.

► '''Example:'''
<syntaxhighlight lang="java">
topcount (10) of hierarchy Product level ProductCategory over measure StoreSales
</syntaxhighlight>

The following Java code is generated:

<syntaxhighlight lang="java">
private String statement =
". . .
TOPCOUNT([Product].[ProductCategory].Members,10,[Measures].[StoreSales])
. . .";
</syntaxhighlight>

===Task===

► '''Syntax:'''
<syntaxhighlight lang="java">
datamart <datamart name> . . . using task <task name> ([host <STRhost>] [port <INTport>]) locale <STRlocale> {
[columns {. . .}]
[conditions {. . .}]
}
</syntaxhighlight>

'''Notes:'''
*Task name is including BusinessAdministrator, PotentialOwner, Recipient, TaskInitiator, TaskStakeholder and ExcludedOwner.
*Default value of host is 127.0.0.1 and default port is 9123.
*The BPM process uses Jboss JBPM version 5.4.

====columns====

one or more “column” are defined here.

► '''Syntax:'''
<syntaxhighlight lang="java">
columns {
column <task column>
. . .
}
</syntaxhighlight>

<code><Task Column</code> can be Name, Priority, Status, Subject, Description, ExpirationTime, CreatedOn, CreatedBy, ActivationTime, ActualOwner, TaskId, ProcessId, ProcessInstanceId and ProcessSessionId.

► '''Example:'''
<syntaxhighlight lang="java">
column Status
</syntaxhighlight>

The following Java code is generated:

<syntaxhighlight lang="java">
private HashMap<Integer, ArrayList<String>> axisMap = new HashMap<Integer,ArrayList<String>>() {{
put(0,new ArrayList<String>() {{
add("Status");
. . .
}});
}};

</syntaxhighlight>

== The Basics ==

=== MDX (MultiDimensional eXpressions) ===

MDX is a query language for OLAP databases, much like SQL is a query language for relational databases. It is also a calculation language, with syntax similar to spreadsheet formulas.

MDX has several elements that are used by, or influence, most statements:

*'''Identifiers''' - Identifiers are the names of objects such as cubes, dimensions, members or measures, e.g. <code>[Time]</code>, <code>[Measures]</code>.
*'''Data types''' - Define the types of data that are contained by cells, member properties and cell properties. (For details see the section [[#Data types]] later in this document.)
*'''Expressions (MDX)''' - An expression is a combination of identifiers, values and operators. You can use an expression as part of the data to be retrieved by a query, or as a search condition to look for data that meets a set of criteria. Expressions include functions that return as a single value a set expression, e.g., <code>[Measures].[Discount Amount] * 1.5</code>.
*'''Operators''' - Operators are syntax elements that work with one or more simple MDX expressions to make more complex MDX expressions, e.g., <code>+</code>, <code>-</code>, <code>*</code>, <code>/</code>, <code><</code>, <code>></code>, <code>AND</code> and <code>OR</code>.
*'''Functions''' - Functions are syntax elements that take zero, one or more input values and return a scalar value or an object, e.g., <code>.Dimension</code>, <code>.Level</code> , <code>IsEmpty()</code>,<code>Order()</code>, <code>.CurrentMember</code> etc.
*'''Comments''' - Comments are pieces of text that are inserted into MDX statements or scripts to explain the purpose of the statement. MDX supports <code>//</code>, <code>--</code> and <code>/* ... */</code> as commenting characters.
*'''Reserved keywords''' - Reserved keywords are words that are reserved for the use of MDX and should not be used for object names used in MDX statements, e.g., <code>SELECT</code>, <code>WHERE</code> etc.

====Data types====

There are six primary data types in MDX:

{| class="wikitable" border="0" cellspacing="0" cellpadding="5"
! width="250px" | Type !! width="750px" | Description
|-
|scalar||Scalar is either a number or a string. It can be specified as a literal, e.g., <code>number 5</code> or <code>string "OLAP"</code>, or it can be returned by an MDX function, e.g., <code>Aggregate()</code>, <code>.UniqueName</code>, <code>.Value</code> etc.
|-
|Dimension / Hierarchy||Dimension is a dimension of a cube. A dimension is a primary organizer of measure and attribute information in a cube. MDX does not know of, nor does it assume, any dependencies between dimensions - they are assumed to be mutually independent. A dimension will contain some members organized in some hierarchy or hierarchies, each in turn containing levels. It can be specified by its unique name, e.g., <code>[Time]</code> or it can be returned by an MDX function, e.g., <code>.Dimension</code>. Hierarchy is a dimension hierarchy of a cube. It can be specified by its unique name, e.g., <code>[Time].[Fiscal]</code> or it can be returned by an MDX function, e.g., <code>.Hierarchy</code>. Hierarchies are contained within Dimensions.
|-
|Level||Level is a level in a dimension hierarchy. It can be specified by its unique name, e.g., <code>[Time].[Fiscal].[Month]</code> or it can be returned by an MDX function, e.g., <code>.Level</code>.
|-
|Member||Member is a member in a dimension hierarchy. It can be specified by its unique name, e.g., <code>[Time].[Fiscal].[Month].[August 2014]</code> or its qualified name, e.g., <code>[Time].[Calendar].[2014].[Q3].[August 2014]</code>, or it can be returned by an MDX function, e.g., <code>.PrevMember</code>, <code>.Parent</code>, <code>.FirstChild</code> etc. Note that all members are specific to a hierarchy. If the same product is a member of two different hierarchies (<code>[Product].[ByManufacturer]</code> and <code>[Product].[ByCategory]</code>), then there will be two different members visible that may need to be coordinated in sets and tuples.
|-
|Tuple||Tuple is an ordered collection of one or more members of different dimensions. Tuples can be specified by enumerating the members, e.g., (<code>[Time].[Fiscal].[Month].[August]</code>, <code>[Measures].[Sales]</code>) or returned by an MDX function, e.g., <code>.Item()</code>.
|-
|Set||Set is an ordered collection of tuples with the same dimensionality, or hierarchality in the case of Microsoft's implementation. It can be specified by enumerating the tuples, e.g., <code>{([Measures].[Sales], [Time].[Fiscal].[2014]), ([Measures].[Sales], [Time].[Fiscal].[2014])}</code> or returned by an MDX function or operator, e.g., <code>Crossjoin()</code>, <code>Filter()</code>, <code>Order()</code>, <code>Descendants()</code> etc.
|-
|other data types||Member properties are equivalent to attributes in the data warehouse sense. They can be retrieved by name in a query through an axis PROPERTIES clause of a query. The scalar data value of a member property for some member can be accessed in an expression through MDX, either by naming the property (e.g., <code>[Product].CurrentMember.[Sales Price]</code>) or by using a special access function (e.g., <code>[Product].CurrentMember.Properties("Sales Price")</code>). In limited contexts, MDX allows other data types as well - for example Array can be used inside the <code>SetToArray()</code> function to specify an array that is not processed by MDX but passed to a user-defined function in an ActiveX library. Objects of other data types are represented as scalar strings indicating the object names, such as measure group name in Microsoft's <code>MeasureGroupMeasures()</code> function or KPI(Key Performance Indicator) name in, for example, Microsoft's <code>KPIValue()</code> or <code>KPIGoal()</code> functions.
|}

====Basic Syntax of an MDX query====

► '''Syntax''':
<syntaxhighlight lang="SQL">
-- One of the three ways to write comments
SELECT {set 0} on COLUMNS, /* block comment */
{set 1} on ROWS // line comment
...
{set n} on AXIS(n)
FROM [cube]
WHERE (tuple) // called "slicer dimension"
</syntaxhighlight>

'''Note:''' Key differences between MDX and SQL
*“Cube in, Cube out” for MDX.
*Set notation needs to be used after <code>SELECT</code>.
*The <code>FROM</code> clause can name only one cube.
*The <code>WHERE</code> clause describes the slicer axis (i.e., all the axes that are not query axes) and is filtered by its default members.

====Examples====

=====A typical query=====

► '''Example''':
<syntaxhighlight lang="SQL">
SELECT {[Time].[Calendar].[Year].[2013],
[Time].[Calendar].[Year].[2014]} ON COLUMNS,
{[Store].[Store Name].MEMBERS} ON ROWS
FROM [Sales]
WHERE ([Measures].[Store Sales])
</syntaxhighlight>

=====.MEMBERS and .CHILDREN functions=====

► '''Syntax''':
<syntaxhighlight lang="SQL">
Hierarchy.Members
Level.Members
...
Member.Children
</syntaxhighlight>

'''Notes:'''
* <code>.Members</code> returns the set of members in a dimension, level, or hierarchy.
* <code>.Children</code> returns the set of children of a specified member.

► '''Example''':
<syntaxhighlight lang="SQL">
SELECT {[Time].[Calendar].[Year].[2014].CHILDREN} ON COLUMNS,
{[Store].[Store City].MEMBERS} ON ROWS
FROM [Sales]
WHERE ([Measures].[Store Sales])
</syntaxhighlight>

=====Calculate Member=====

► '''Syntax''':
<syntaxhighlight lang="SQL">
WITH MEMBER parent1.name1 AS ’expression1’
MEMBER parent2.name2 AS ’expression2’
</syntaxhighlight>

'''Notes:'''
* If a calculated member is only required for a single MDX query, you can define that calculated member by using the <code>WITH</code> keyword. A calculated member that is created by using the <code>WITH</code> keyword no longer exists after the query has finished running.

► '''Example 1''':
<syntaxhighlight lang="SQL">
WITH MEMBER [Time].[Calendar].[Year].[2014].[H1] AS
’[Time].[Calendar].[Year].[2014].[Q1] + [Time].[Calendar].[Year].[2014].[Q2]’
MEMBER [Time].[Calendar].[Year].[2014].[H2] AS
’[Time].[Calendar].[Year].[2014].[Q3] + [Time].[Calendar].[Year].[2014].[Q4]’
SELECT {[Time].[Calendar].[Year].[2014].[H1],
[Time].[Calendar].[Year].[2014].[H2]} ON COLUMNS
[Store].[Store Name].MEMBERS ON ROWS
FROM [Sales]
WHERE ([Measures].[Profit])
</syntaxhighlight>

► '''Example 2''': define and use new measures
<syntaxhighlight lang="SQL">
WITH MEMBER [Measures].[ProfitPercent] AS
’([Measures].[Store Sales] – [Measures].[Store Cost]) / ([Measures].[Store Cost])’
SELECT [Time].[Calendar].[Year].[2014].CHILDREN ON COLUMNS,
[Store].[Store Name].MEMBERS ON ROWS
FROM [Sales]
WHERE ([Measures].[ProfitPercent])
</syntaxhighlight>

=====Slicer Dimension=====

► '''Example''': slice on the [Product] dimension
<syntaxhighlight lang="SQL">
SELECT {[Time].[Calendar].[Year].[2014].CHILDREN} ON COLUMNS,
{[Store].[Store City].MEMBERS} ON ROWS
FROM [Sales]
WHERE ([Product].[Product Family].[Drink],
[Measures].[Store Sales])
</syntaxhighlight>

=====Filter() function=====

► '''Syntax''':
<syntaxhighlight lang="SQL">
FILTER(set, logical expression )</syntaxhighlight>

'''Notes:'''
* Returns the set that results from filtering a specified set based on a search condition.

► '''Example''': if we are only interested in stores whose 2014 unit sales exceed 1000
<syntaxhighlight lang="SQL">
SELECT {[Time].[Calendar].[Year].[2014].CHILDREN} ON COLUMNS,
FILTER( {[Store].[Store City].MEMBERS},
([Measures].[Unit Sales], [Time].[Calendar].[Year].[2014]) > 1000 ) ON ROWS
FROM [Sales]
WHERE ([Measures].[Store Sales])
</syntaxhighlight>

=====Order() function=====

► '''Syntax''':
<syntaxhighlight lang="SQL">
ORDER(set, numeric/string expression, [, ASC | DESC | BASC | BDESC]
</syntaxhighlight>

'''Notes:'''
* Arranges members of a specified set, optionally preserving or breaking the hierarchy.

► '''Example 1''': list all measures for each city in decreasing order of their sales count
<syntaxhighlight lang="SQL">
SELECT [Measures].MEMBERS ON COLUMNS,
ORDER(
[Store].[Store City].MEMBERS,
[Measures].[Sales Count],
BDESC
) ON ROWS
FROM [Sales]
</syntaxhighlight>

► '''Example 2''': if we are only interested in stores whose name is between “Berlin” and “Heidelberg”
<syntaxhighlight lang="SQL">
SELECT [Measures].MEMBERS ON COLUMNS,
ORDER(
{[Store].[Store City].[Berlin]:[Heidelberg]},
[Store].CURRENTMEMBER.Name,
BASC
) ON ROWS
FROM [Sales]

</syntaxhighlight>

=====Lag() function=====

► '''Syntax''':
<syntaxhighlight lang="SQL">
Member.LAG(index)
</syntaxhighlight>

'''Notes:'''
* Returns the member that is a specified number of positions before a specified member on the member's level.
* <code>.Lag(1)</code> is equivalent to the <code>.PrevMember</code> function.
* <code>.Lag(-1)</code> is equivalent to the <code>.NextMember</code> function.

► '''Example''': list all measures for December, 2014
<syntaxhighlight lang="SQL">
SELECT [Measures].MEMBERS ON COLUMNS,
[Time].[Fiscal].[Month].[February 2015].LAG(2) ON ROWS
FROM [Sales]
</syntaxhighlight>

=====Lead() function=====

► '''Syntax''':
<syntaxhighlight lang="SQL">
Member.LEAD(index)
</syntaxhighlight>

'''Notes:'''
* Returns the member that is a specified number of positions following a specified member at the member's level.
* <code>.Lead(n)</code> is equivalent to the <code>.Lag(-n)</code> function.

► '''Example''': list all measures for December, 2014
<syntaxhighlight lang="SQL">
SELECT [Measures].MEMBERS ON COLUMNS,
[Time].[Fiscal].[Month].[February 2015].LEAD(-2) ON ROWS
FROM [Sales]
</syntaxhighlight>

=====PrevMember function=====

► '''Syntax''':
<syntaxhighlight lang="SQL">
Member.PREVMEMBER
</syntaxhighlight>

'''Notes:'''
* Returns the previous member in the level that contains a specified member.

► '''Example''': list all measures for January, 2014
<syntaxhighlight lang="SQL">
SELECT [Measures].MEMBERS ON COLUMNS,
[Time].[Fiscal].[Month].[February 2015].PREVMEMBER ON ROWS
FROM [Sales]
</syntaxhighlight>

=====NextMember function=====

► '''Syntax''':
<syntaxhighlight lang="SQL">
Member.NEXTMEMBER
</syntaxhighlight>

'''Notes:'''
* Returns the next member in the level that contains a specified member.

► '''Example''': list all measures for March, 2015
<syntaxhighlight lang="SQL">
SELECT [Measures].MEMBERS ON COLUMNS,
[Time].[Fiscal].[Month].[February 2015].NEXTMEMBER ON ROWS
FROM [Sales]
</syntaxhighlight>

=====FirstChild function=====

► '''Syntax''':
<syntaxhighlight lang="SQL">
Member.FIRSTCHILD
</syntaxhighlight>

'''Notes:'''
* Returns the first child of a specified member.
* Leaf members have no children and therefore no first child.

► '''Example''': list all measures for the first quarter of 2015, which is the first child of year 2015
<syntaxhighlight lang="SQL">
SELECT [Measures].MEMBERS ON COLUMNS,
[Time].[Calendar].[Year].[2015].FIRSTCHILD ON ROWS
FROM [Sales]
</syntaxhighlight>

=====LastChild function=====

► '''Syntax''':
<syntaxhighlight lang="SQL">
Member.LASTCHILD
</syntaxhighlight>

'''Notes:'''
* Returns the last child of a specified member.
* Leaf members have no children and therefore no last child.

► '''Example''': list all measures for March, 2015, which is the last child of the first quarter of the year 2015
<syntaxhighlight lang="SQL">
SELECT [Measures].MEMBERS ON COLUMNS,
[Time].[Calendar].[Quarter].[Q1 2015].LASTCHILD ON ROWS
FROM [Sales]
</syntaxhighlight>

=====Head() function=====

► '''Syntax''':
<syntaxhighlight lang="SQL">
HEAD(set [ ,count ] )
</syntaxhighlight>

'''Notes:'''
* Returns the first specified number of elements of a set.

► '''Example''': show the profit of top-5 cities in terms of sales count
<syntaxhighlight lang="SQL">
SELECT [Measures].[Profit] ON COLUMNS,
HEAD( ORDER( {[Store].[Store City].MEMBERS},
[Measures].[Sales Count],
BDESC
),
5
) ON ROWS
FROM [Sales]
</syntaxhighlight>

=====Tail() function=====

► '''Syntax''':
<syntaxhighlight lang="SQL">
TAIL(set [ ,count ] )
</syntaxhighlight>

'''Notes:'''
* Returns the last specified number of elements of a set.

► '''Example''': show the profit of bottom-5 cities in terms of sales count
<syntaxhighlight lang="SQL">
SELECT [Measures].[Profit] ON COLUMNS,
TAIL( ORDER( {[Store].[Store City].MEMBERS},
[Measures].[Sales Count],
BDESC
),
5
) ON ROWS
FROM [Sales]
</syntaxhighlight>

=====TopCount() function=====

► '''Syntax''':
<syntaxhighlight lang="SQL">
TOPCOUNT(set, count [ ,numeric expression ] )
</syntaxhighlight>

'''Notes:'''
* Sorts a set in descending order and returns the specified number of elements with the highest values.
* The numeric expression is used to evaluate the tuple values. If a numeric expression is not specified, the function returns the set of members in their natural order, without any sorting, behaving like the <code>Head()</code> function.

► '''Example''': show the profit of top-5 cities in terms of sales count
<syntaxhighlight lang="SQL">
SELECT [Measures].[Profit] ON COLUMNS,
TOPCOUNT( [Store].[Store City].MEMBERS,
5,
[Measures].[Sales Count]
) ON ROWS
FROM [Sales]
</syntaxhighlight>

=====BottomCount() function=====

► '''Syntax''':
<syntaxhighlight lang="SQL">
BOTTOMCOUNT(set, count [ ,numeric expression ] )
</syntaxhighlight>

'''Notes:'''
* Sorts a set in ascending order and returns the specified number of elements with the lowest values.
* The numeric expression is used to evaluate the tuple values. If a numeric expression is not specified, the function returns the set of members in their natural order, without any sorting, behaving like the <code>Tail()</code> function.

► '''Example''': show the profit of bottom-5 cities in terms of sales count
<syntaxhighlight lang="SQL">
SELECT [Measures].[Profit] ON COLUMNS,
BOTTOMCOUNT( [Store].[Store City].MEMBERS,
5,
[Measures].[Sales Count]
) ON ROWS
FROM [Sales]
</syntaxhighlight>

=====TopPercent() function=====

► '''Syntax''':
<syntaxhighlight lang="SQL">
TOPPERCENT(set, percentage, numeric expression)
</syntaxhighlight>

'''Notes:'''
* Sorts a set in descending order and then returns the set of tuples with the highest values whose cumulative total is equal to or greater than a specified percentage of the total of all values.
* Percentage must be a positive value between 0 and 100.

► '''Example''': show the best profit and cities that make up the top 10% of sales count
<syntaxhighlight lang="SQL">
SELECT [Measures].[Profit] ON COLUMNS,
TOPPERCENT( [Store].[Store City].MEMBERS,
10,
[Measures].[Sales Count]
) ON ROWS
FROM [Sales]
</syntaxhighlight>

=====BottomPercent() function=====

► '''Syntax''':
<syntaxhighlight lang="SQL">
BOTTOMPERCENT(set, percentage, numeric expression)
</syntaxhighlight>

'''Notes:'''
* Sorts a set in ascending order and then returns the set of tuples with the lowest values whose cumulative total is equal to or greater than a specified percentage of the total of all values.
* Percentage must be a positive value between 0 and 100.

► '''Example''': show the worst profit and cities that make the bottom 10% of sales count
<syntaxhighlight lang="SQL">
SELECT [Measures].[Profit] ON COLUMNS,
BOTTOMPERCENT( [Store].[Store City].MEMBERS,
10,
[Measures].[Sales Count]
) ON ROWS
FROM [Sales]
</syntaxhighlight>

=====TopSum() function=====

► '''Syntax''':
<syntaxhighlight lang="SQL">
TOPSUM(set, value, numeric expression)
</syntaxhighlight>

'''Notes:'''
* Sorts a set and returns the topmost set of elements whose cumulative total is at least a specified value.

► '''Example''': show the smallest set whose cumulative total using the profit measure is at least the sum of 50000, beginning with the members of this set with the highest sales count values
<syntaxhighlight lang="SQL">
SELECT [Measures].[Profit] ON COLUMNS,
TOPSUM ( [Store].[Store City].MEMBERS,
50000,
[Measures].[Sales Count]
) ON ROWS
FROM [Sales]
</syntaxhighlight>

=====BottomSum() function=====

► '''Syntax''':
<syntaxhighlight lang="SQL">
BOTTOMSUM(set, value, numeric expression)
</syntaxhighlight>

'''Notes:'''
* Sorts a set and returns the bottommost set of elements whose sum is equal to or less than a specified value.

► '''Example''': show the smallest set whose cumulative total using the profit measure is at least the sum of 50000, beginning with the members of this set with the smallest number of sales count
<syntaxhighlight lang="SQL">
SELECT [Measures].[Profit] ON COLUMNS,
BOTTOMSUM( [Store].[Store City].MEMBERS,
50000,
[Measures].[Sales Count]
) ON ROWS
FROM [Sales]
</syntaxhighlight>

=====Aggregate() function=====

► '''Syntax''':
<syntaxhighlight lang="SQL">
AGGREGATE(set [, numeric expression])
</syntaxhighlight>

'''Notes:'''
* Returns a number that is calculated by aggregating over the cells returned by the set expression.
* If a numeric expression ''is not'' provided, this function aggregates each measure within the current query context by using the default aggregation operator that is specified for each measure.
* If a numeric expression ''is'' provided, this function first evaluates, and then sums, the numeric expression for each cell in the specified set.

► '''Example''': aggregate profit for all the calendar months
<syntaxhighlight lang="SQL">
WITH MEMBER [Time].[Calendar].[All sales] AS
AGGREGATE([Time].[Calendar].[Month].MEMBERS, [Measures].[Amount])
SELECT [Time].[Calendar].[All sales] ON COLUMNS,
[Store].[Store City].MEMBERS ON ROWS
FROM [Sales]
WHERE [Measures].[Profit]

</syntaxhighlight>

=====Avg() function=====

► '''Syntax''':
<syntaxhighlight lang="SQL">
AVG(set [, numeric expression])
</syntaxhighlight>

'''Notes:'''
* Evaluates a set and returns the average of the non-empty values of the cells in the set, averaged over the measures in the set or over a specified measure.

► '''Example''': show the average profit for each calendar year
<syntaxhighlight lang="SQL">
WITH MEMBER [Measures].[Avg Profit] AS
AVG( [Time].[Calendar].[Month].MEMBERS, Measures.[Profit])
SELECT
Measures.[Avg Profit] ON COLUMNS,
[Time].[Calendar].[Year].MEMBERS ON ROWS
FROM [Sales]

</syntaxhighlight>

=====Sum() function=====

► '''Syntax''':
<syntaxhighlight lang="SQL">
SUM(set [, numeric expression])
</syntaxhighlight>

'''Notes:'''
* Shows the sum of all values of the cells in the set.

► '''Example''': show the total profit for the calendar years 2013 and 2014 (the sum of the 2013 and 2014 profit values for all members of the <code>[Product].[Category]</code> hierarchy)

<syntaxhighlight lang="SQL">
WITH MEMBER [Measures].[Sum Profit] AS
SUM( { [Time].[Calendar].[Year].[2013],
[Time].[Calendar].[Year].[2014] }
, [Measures].[Profit]
)
SELECT [Measures].[Sum Profit] ON COLUMNS,
[Product].[Category].Members ON ROWS
FROM [Sales]

</syntaxhighlight>

=====StdDev() function=====

► '''Syntax''':
<syntaxhighlight lang="SQL">
STDDEV(set [, numeric expression])
</syntaxhighlight>

'''Notes:'''
* Returns the sample standard deviation of a numeric expression evaluated over a set, using the unbiased population formula (dividing by n-1).

► '''Example''': show the standard deviation of the profit values, evaluated over the first 3 months of calendar year 2014, using the unbiased population formula
<syntaxhighlight lang="SQL">
WITH MEMBER [Measures].[Stddev Profit] AS
STDDEV( { [Time].[Calendar].[Month].[January 2014],
[Time].[Calendar].[Month].[February 2014],
[Time].[Calendar].[Month].[March 2014]}
, [Measures].[Profit]
)

</syntaxhighlight>

=====PeriodsToDate() function=====

► '''Syntax''':
<syntaxhighlight lang="SQL">
PERIODSTODATE([level [, member]])
</syntaxhighlight>

'''Notes:'''
* Returns a set of sibling members from the same level as a given member, starting with the first sibling and ending with the given member, as constrained by a specified level in the Time dimension.
* If the <code>member</code> expression is missing, then the level <code>hierarchy.CurrentMember</code> will be used.
* If the <code>level</code> expression is missing, then the parent level of the <code>[Time].CurrentMember</code> in the default time dimension of the cube will be used.

► '''Example''': aggregate profit for the first 8 calendar months of the year 2014
<syntaxhighlight lang="SQL">
WITH MEMBER [Time].[Calendar].[first8Months2014] AS
AGGREGATE (
PERIODSTODATE( [Time].[Calendar].[Year],
[Time].[Calendar].[Month].[August 2014],
)
)
SELECT [Time].[Calendar].[All sales] ON COLUMNS,
[Store].[Store City].MEMBERS ON ROWS
FROM [Sales]
WHERE [Measures].[Profit]
</syntaxhighlight>

=====YTD() function=====

► '''Syntax''':
<syntaxhighlight lang="SQL">
YTD([member])
</syntaxhighlight>

'''Notes:'''
* Returns a set of sibling members from the same level as a given member, starting with the first sibling and ending with the given member, as constrained by the Year level in the Time dimension.
* <code>Ytd(member)</code> is equivalent to <code>PeriodsToDate(Year level, member)</code>.
* If no ''member'' is defined, then <code>[Time].currentMember</code> is used.
* This function does not work when the Type property is set to <code>FiscalYears</code>.

► '''Example''': aggregate profit for the first 8 calendar months of the year 2014
<syntaxhighlight lang="SQL">
WITH MEMBER [Time].[Calendar].[first8Months2014] AS
AGGREGATE (
YTD( [Time].[Calendar].[Month].[August 2014] )
)
SELECT [Time].[Calendar].[All sales] ON COLUMNS,
[Store].[Store City].MEMBERS ON ROWS
FROM [Sales]
WHERE [Measures].[Profit]
</syntaxhighlight>

=====CrossJoin() function=====

► '''Syntax''':
<syntaxhighlight lang="SQL">
CROSSJOIN(set1, set2)
</syntaxhighlight>

'''Notes:'''
* Returns the cross product of one or more sets.

► '''Example''': the query axis (ROWS) is the combination of 2 cube dimensions
<syntaxhighlight lang="SQL">
SELECT [Time].[Calendar].[Year].[2014].CHILDREN ON COLUMNS,
CROSSJOIN( [Store].[Store State].MEMBERS,
[Product].[Product Family].MEMBERS
) ON ROWS
FROM [Sales]
WHERE ([Measures].[Profit])
</syntaxhighlight>

=====NonEmpty() function=====

► '''Syntax''':
<syntaxhighlight lang="SQL">
NONEMPTY(set1 [,set2])
</syntaxhighlight>

'''Notes:'''
* Returns the set of non-empty tuples from a specified set, based on the cross product of the specified set with a second set.

► '''Example''':
<syntaxhighlight lang="SQL">
SELECT [Time].[Calendar].[Year].[2014].CHILDREN ON COLUMNS,
NONEMPTY(
CROSSJOIN( [Store].[Store State].MEMBERS,
[Product].[Product Family].MEMBERS
)
) ON ROWS
FROM [Sales]
WHERE ([Measures].[Profit])
</syntaxhighlight>

=====NonEmptyCrossJoin() function=====

► '''Syntax''':
<syntaxhighlight lang="SQL">
NONEMPTYCROSSJOIN(set1 [,set2, . . .][, count])
</syntaxhighlight>

'''Notes:'''
* Returns a set that contains the cross product of one or more sets, excluding empty tuples and tuples without associated fact table data.
* If <code>count</code> is not specified, the function cross-joins all specified sets and excludes empty members from the result set.
* If a number of sets is specified, the function cross joins the numbers of sets specified, starting with the first specified set.

► '''Example''':
<syntaxhighlight lang="SQL">
SELECT [Time].[Calendar].[Year].[2014].CHILDREN ON COLUMNS,
NONEMPTYCROSSJOIN( [Store].[Store State].MEMBERS,
[Product].[Product Family].MEMBERS
) ON ROWS
FROM [Sales]
WHERE ([Measures].[Profit])
</syntaxhighlight>

=====Except() function=====

► '''Syntax''':
<syntaxhighlight lang="SQL">
EXCEPT(set1 ,set2 [, ALL])
</syntaxhighlight>

'''Notes:'''
* Evaluates two sets and removes those tuples in the first set that also exist in the second set; ensuing duplicates are optionally removed.
* If <code>ALL</code> is specified, the function retains duplicates found in the first set; duplicates found in the second set will still be removed. The members are returned in the order they appear in the first set.

► '''Example''':
<syntaxhighlight lang="SQL">
SELECT [Time].[Calendar].[Month].CHILDREN ON COLUMNS,
EXCEPT( [Product].[Product Categories].[All].Children ,
{[Product].[Product Categories].[Components]}
) ON ROWS
FROM [Sales]
WHERE ([Measures].[Profit])
</syntaxhighlight>

=== Jboss JBPM 5.4 ===

jBPM is a flexible Business Process Management (BPM) suite. It allows you to model, execute and monitor business processes, throughout their life cycle.

jBPM focuses on executable business processes, which are business processes that contain enough detail so that they can actually be executed on a BPM engine. Executable business processes bridge the gap between business users and developers as they are higher-level and use domain-specific concepts that are understood by business users but can also be executed directly.

To interact with the process engine (for example, to start a process), you need to set up a session. This session is used to communicate with the process engine. A session needs to have a reference to a knowledge base, which in turn contains a reference to all the relevant process definitions. This knowledge base is used to look up the process definitions whenever necessary. To create a session, you first need to create a knowledge base, load all the necessary process definitions (this can be from various sources, such as classpath, file system or process repository) and then instantiate a session.

For example, imagine you are writing an application to process sales orders. You could then define one or more process definitions that define how the order should be processed. When starting up your application, you first need to create a knowledge base that contains those process definitions. You can then create a session based on this knowledge base so that, whenever a new sales order comes in, a new process instance is started for that sales order. That process instance contains the state of the process for that specific sales request.

The jBPM project has a clear separation between the API the users should be interacting with and the actual implementation classes. The public API exposes most of the features we believe "normal" users can safely use and should remain rather stable across releases. Expert users can still access internal classes but should be aware that they should know what they are doing and that the internal API might still change in the future.

As explained above, the jBPM API should thus be used to create a knowledge base that contains your process definitions, and to create a session to start new process instances, signal existing ones, register listeners, etc.

You can find more information at http://docs.jboss.org/jbpm/v5.4/userguide/
== Copyright Notice ==

{{Copyright Notice}}

Datamart DSL

2017-07-26T20:49:13Z

Cmollik: /* default */

== Datamart DSL ==

A data mart is a condensed and more focused version of a data warehouse, that reflects the regulations and process specifications of each business unit within an organization. Each data mart is dedicated to a specific business function or region.

'''Datamart DSL''' generates for each datamart a java file, in which the SQL query for entities, or MDX query for Cubes, or task client connection for BPM are defined.

The main semantic elements of the Datamart DSL are:
*'''package''' - The root element that contains all the other elements. A model can contain multiple packages.
*'''import''' declarations - Used to import external models or even Java classes.
*'''datamart''' - Defines which data warehouse and which entity/cube/BPM the datamart will use. It contains further elements such as navigation, properties, conditions for entity, derive, axis, slicer for cube and columns, conditions for BPM.
*'''navigation''' - Used to define joins of entities as “one-to-many” or “many-to-one”.
*'''one to many … to … / many to one … to …''' - Used to define joins of entities in an MDX query.
*'''properties''' - Used to define the properties of an entity.
*'''property''' - Used to define columns and axes for an entity.
*'''conditions''' - Used to define conditions for entities and BPMs.
*'''condition''' - Used to define a "Where"-clause for an entity query or conditions for BPM.
*'''derive … from …''' - Used to define a derived measure of a cube query.
*'''measure''' - Used in cubes to specify members of a special dimension or a quantity to measure, for example, unit sales of a product, or the cost price of inventory items.
*'''derived''' - Used for cubes for derived measures defined in the same datamart, instead of the keyword “measure”.
*'''axis''' - Used for cubes to define the members of the axis, which can be measures, derived measures, or an aggregation or function of a hierarchy.
*'''hierarchy''' - Used for cubes to define a set of members organized in a structure for convenient analysis. For example, the store hierarchy consists of the store name, city, state, and nation. The hierarchy allows you to form intermediate sub-totals: the sub-total for a state is the sum of the sub-totals of all of the cities in that state, each of which is the sum of the sub-totals of the stores in that city.
*'''slicer''' - Used for cubes to define the "Where"-clause in a cube query.
*'''columns''' - Used for BPMs to define one or more columns.
*'''column''' - Used for BPMs to define which BPM column is used in a datamart.

===Datamart definition===

► '''Syntax''':
<syntaxhighlight lang="java">
datamart <datamart name> [described by <discription>]
from <schema name> persistenceUnit <persistence unit name>
using entity/cube/task <entity/cube/task name> [<task mode> <mode name> for task] [nonempty values for cube] {
...
}
</syntaxhighlight>

'''Notes:'''
* This generates a ''<datamart name>Datamart.java'' file, in which a java class named <code><datamart name>Datamart</code> is defined. In this class (which is extended from java class <code>ACubeDatamart</code> or <code>AEntityDatamart</code>), the database connection, the querying of entities and cubes and the task-client connection of tasks are defined.
* <task name> can be <code>BusinessAdministrator</code>, <code>PotentialOwner</code>, <code>Recipient</code>, <code>TaskInitiator</code>, <code>TaskStakeholder</code> or <code>ExcludedOwner</code>.
* <task mode> can be <code>locale</code> (String), <code>host</code> (String) or <code>port</code> (Integer).'''

► '''Example''':
<syntaxhighlight lang="java">
datamart EmployeeSalary
from CCNGDEFAULT persistenceUnit "foodmart"
using entity Memployee {. . .}

datamart SalesByState described by "cube based profit review"
from CCNGDEFAULT persistenceUnit "foodmart"
using cube Sales nonempty values {. . .}

datamart TaskDetails described by "Task details"
from BPM persistenceUnit "drools"
using task BusinessAdministrator locale "de-DE" {. . .}

</syntaxhighlight>

===entity===

► '''Syntax''':
<syntaxhighlight lang="java">
datamart <datamart name> . . . using entity <entity A name> (tracking){
[navigation {. . .}]
[properties {. . .}]
[conditions {. . .}]
[filler rows <INTminRow> to <INTmaxRow>{. . .}]
}
</syntaxhighlight>

====navigation====
Using the <code>many to one</code> or <code>one to many</code> clause creates a JOIN of entities in a query.

======many to one … to entity …======
► '''Syntax''':
<syntaxhighlight lang="java">
entity <entity A name> {
navigation {
many to one <entity A name>.<entity B reference in entity A> to entity <entity B name> {
[navigation {. . . }]
[properties {. . . }]
[conditions {. . . }]
}
}
. . .
}
</syntaxhighlight>

► '''Example''':
<syntaxhighlight lang="java">
datamart EmployeeSalary from CCNGDEFAULT persistenceUnit "foodmart" using entity Memployee {
navigation {
many to one Memployee.position to entity Mposition {
properties {
property position_title on axis rows
property max_scale on axis columns
property min_scale on axis columns
}
conditions {
condition property pay_type = filtered
}
}
}
. . .
}

</syntaxhighlight>

The following Java code is generated:

<syntaxhighlight lang="java">
private String statement =
"select Mposition.MAX_SCALE as \"max_scale\",
Mposition.MIN_SCALE as \"min_scale\",
Mposition.POSITION_TITLE as \"position_title\"
. . .
from CCNG.MEMPLOYEE Memployee
left join CCNG.MPOSITION Mposition on(Mposition.id=Memployee.position_id)
where (Mposition.pay_type = $Mposition.pay_type$)
. . .";

private HashMap<Integer, ArrayList<String>> axisMap = new HashMap<Integer,ArrayList<String>>() {{
put(0,new ArrayList<String>() {{
. . .
add("max_scale");
add("min_scale");
}});
put(1,new ArrayList<String>() {{
. . .
add("position_title");
}});
}};

</syntaxhighlight>

======one to many … to entity …======
► '''Syntax''':
<syntaxhighlight lang="java">
entity <entity A name> {
navigation {
one to many <entity A name>.<entity B reference in entity A> to entity <entity B name> {
[navigation {. . . }]
[properties {. . . }]
[conditions {. . . }]
}
}
. . .
}
</syntaxhighlight>

► '''Example''':
<syntaxhighlight lang="java">
datamart SalesByDistrict described by "entity based aggregation of store sales and store cost"
from CCNGDEFAULT persistenceUnit "foodmart"
using entity Mregion
{
navigation {
one to many Mstore.region to entity Mstore {
navigation {
one to many Msales_fact_1998.store to entity Msales_fact_1998 {
properties {
property store_sales aggregate summation on axis columns
property store_cost aggregate summation on axis columns
}
}
}
}
}
. . .
}
</syntaxhighlight>

The following Java code is generated:

<syntaxhighlight lang="java">
private String statement =
"select SUM(Msales_fact_1998.STORE_SALES) as \"store_sales\",
SUM(Msales_fact_1998.STORE_COST) as \"store_cost\"
. . .
from CCNG.MREGION Mregion
left join CCNG.MSTORE Mstore on(Mstore.region_id=Mregion.id)
left join CCNG.MSALES_FACT_1998 Msales_fact_1998 on(Msales_fact_1998.store_id=Mstore.id)
where . . . group by . . .";

private final HashMap<String, String> filterMap = new HashMap<String,String>()
{{
put("$Mregion.id$","&");
put("$Mstore.id$","&");
put("$Msales_fact_1998.id$","&");
. . .
}};

</syntaxhighlight>

====properties====

One or more properties are defined here, each using the <code>property</code> keyword and specifying which kind of aggregation of the property will be queried on which axis.

► '''Syntax''':
<syntaxhighlight lang="java">
properties {
property <entity A property> [aggregate <sql aggregation>]
[on axis <axis name>] [scale <scale group number>]
. . .
}
</syntaxhighlight>

'''Notes:'''
*<sql aggregation> can be average, summation or count.
*<axis name> can be ''columns'' or ''rows''.
*<scale group number> is in the range ''group1''-''group9''.

=====on axis ''rows''/''columns''=====

► '''Example''':
<syntaxhighlight lang="java">
property sales_region on axis rows
property store_sales _nm on axis columns
</syntaxhighlight>

The following Java code is generated:

<syntaxhighlight lang="java">
private HashMap<Integer, ArrayList<String>> axisMap = new HashMap<Integer,ArrayList<String>>() {{
put(0,new ArrayList<String>() {{
add("store_sales");
. . .
}});
put(1,new ArrayList<String>() {{
add("sales_region");
. . .
}});
}};
</syntaxhighlight>

=====aggregate=====

<sql aggregation> can be:
*'''average''' - SQL Avg() function, returns the average of (a subset of) all values in a specified column
*'''summation''' - SQL Sum() function, returns the sum of (a subset of) all values in a specified column.
*'''count''' - SQL Count() function, returns the total number of (a subset of) values in a specified column.

► '''Example''':
<syntaxhighlight lang="java">
property store_sales aggregate summation
</syntaxhighlight>

The following Java code is generated:

<syntaxhighlight lang="java">
private String statement =
"select SUM(Msales_fact_1998.STORE_SALES) as \"store_sales\", . . .
from . . . left join . . . on(. . .) group by . . . ";
</syntaxhighlight>

=====scale=====

Used to define different groups of scale values (<code>group1</code>-<code>group9</code>) for diagrams and tables.

► '''Example''':
<syntaxhighlight lang="java">
property store_sales scale group1
</syntaxhighlight>

====conditions====

► '''Syntax''':
<syntaxhighlight lang="java">
conditions {
condition
[<operator>]
Number
/STRING
/(filtered [optional])|selected
/property <entity A property> [aggregate <sql aggregation>]
/entitycolumn <entity C>.<entity C Property>
/column <task column>
[<operator>
Number
/STRING
/(filtered [optional])|selected
/property <entity A property> [aggregate <sql aggregation>]
/entitycolumn <entity D>.<entity D Property>
/column <task column>
]
}
</syntaxhighlight>

'''Notes:'''
*<operator> can be <code>()</code>, <code>=</code>, <code><</code>, <code>></code>, <code><=</code>, <code>>=</code>, <code>like</code>, <code>and</code> or <code>or</code>.
*<task column> can be <code>Name</code>, <code>Priority</code>, <code>Status</code>, <code>Subject</code>, <code>Description</code>, <code>ExpirationTime</code>, <code>CreatedOn</code>, <code>CreatedBy</code>, <code>ActivationTime</code>, <code>ActualOwner</code>, <code>TaskId</code>, <code>ProcessId</code>, <code>ProcessInstanceId</code> or <code>ProcessSessionId</code>.

=====selected=====

The specified column will be selectable in the GUI.

► '''Example''':
<syntaxhighlight lang="java">
condition property gtin_cd = selected
</syntaxhighlight>

The following Java code is generated:

<syntaxhighlight lang="java">
private String statement =
". . .
where (gtin.gtin_cd in (§gtin.gtin_cd§))
. . .";
private final HashMap<String, String> filterMap = new HashMap<String,String>()
{{
. . .
put("§gtin.gtin_cd§","select distinct GTIN_CD as \"gtin_cd\" from pod.GTIN");
}};
</syntaxhighlight>

=====filtered=====

The specified column will be filterable in the GUI.
<code>optional</code> means this specified column can be chosen for being filtered or not.

► '''Example 1''':
<syntaxhighlight lang="java">
condition property pay_type = filtered
</syntaxhighlight>

The following Java code is generated:

<syntaxhighlight lang="java">
private String statement =
". . .
where (Mposition.pay_type = $Mposition.pay_type$)
. . .";
private final HashMap<String, String> filterMap = new HashMap<String,String>()
{{
. . .
put("$Mposition.pay_type$","select distinct PAY_TYPE as \"pay_type\" from CCNG.MPOSITION");
}};
</syntaxhighlight>

► '''Example 2''':
<syntaxhighlight lang="java">
condition property education_level = filtered optional
</syntaxhighlight>

The following Java code is generated:

<syntaxhighlight lang="java">
private String statement =
". . .
where (($Memployee.education_level$='*' or Memployee.education_level = $Memployee.education_level$))
. . .";
private final HashMap<String, String> filterMap = new HashMap<String,String>() {{
. . .
put("$Memployee.education_level$","select '*' from dual union select distinct EDUCATION_LEVEL as \"education_level\" from CCNG.MEMPLOYEE");
}};
</syntaxhighlight>

=====filler rows ''mm'' to ''nn''=====

► '''Syntax''':
<syntaxhighlight lang="java">
filler rows <INTminRow> to <INTmaxRow>{
[fill <entity property> with
filler-address city
| filler-address postalcode
| filler-date future <INT> years
| filler-date past <INT> years
| filler-date range <+-INTby> up to and including <+-INTey> years
| filler-person full name
| filler-person first name
| filler-person last name
| filler-person email
| filler-person phone
| filler-person gender male as <STRINGmt> female as <STRINGft>
| filler-signed-double range
[ <+- Double> | <entity property>]
up to and including
[ <+- Double > | <entity property>]
with <INT> decimals
round to < Double >
| filler-signed-double random (<+-Double >)
| filler-signed-integer range
[ <+-INT> | <entity property>]
up to and including
[ <+-INT> | <entity property>]
round to <INT>
| filler-signed-integer random ( <+-INT> )
| filler-text random ( <STRING> )
| filler-text paragraps [<INT>]
| filler-text sentences [<INT>]
| filler-text words [<INT>]
| filler-unsigned-double range
[ < Double > | <entity property>]
up to and including
[ < Double > | <entity property>]
with <INT> decimals
round to < Double >
| filler-unsigned-double random ( < Double > )
| filler-unsigned-integer range
[ <INT> | <entity property>]
up to and including
[ <INT> | <entity property>]
round to <INT>
| filler-unsigned-integer random ( <INT> )
]
}

</syntaxhighlight>

===cube===

Use the keyword <code>cube</code> to define the data source cube of a FROM clause in an MDX query.

► '''Syntax''':
<syntaxhighlight lang="java">
datamart <datamart name> . . . using cube <cube name> [nonempty values] {
[derive <derived measure name> from
[<derive operator>]
Number
/Cube Measure
/Cube Derived Measure
/Cube Member Tuple
/Cube Aggregation
[<derive operator>]
[Number
/Cube Measure
/Cube Derived Measure
/Cube Member Tuple
/Cube Aggregation]
]
[axis <axis name> {
Cube Hierarchy
/Cube Measure
/Cube Derived Measure
/Cube Set Aggregation
}]
[slicer
Cube Hierarchy
/Cube Measure
/Cube Derived Measure
/Cube Set Aggregation
]
}
</syntaxhighlight>

====Keywords====

=====nonempty values=====

See the sections [[#NonEmpty() function]] and [[#NonEmptyCrossjoin() function]] later in this document.

► '''Syntax''':
<syntaxhighlight lang="java">
datamart <datamart name> [described by <description>]
from <schema name> persistenceUnit <persistence unit name>
using cube <cube name>
nonempty values
{
...
}
</syntaxhighlight>

The following Java code is generated:

<syntaxhighlight lang="java">
private String statement =
"select
Non Empty{ . . . } on columns,
NonEmptyCrossjoin(. . .) on rows
from
. . .";
</syntaxhighlight>

=====derive … from=====

Creates a Calculate Member.

► '''Syntax''':
<syntaxhighlight lang="java">
derive <derived measure name> from
[<derive operator>]
Number
/Cube Measure
/Cube Derived Measure
/Cube Member Tuple
/Cube Aggregation
[<derive operator>]
[Number
/Cube Measure
/Cube Derived Measure
/Cube Member Tuple
/Cube Aggregation]
</syntaxhighlight>

'''Notes:'''
*<code><derive operator></code> can be <code>+</code>, <code>-</code>, <code>*</code>, <code>/</code> or <code>()</code>.

► '''Example 1''':
<syntaxhighlight lang="java">
derive SumSales from measure SaleNumber * measure unitPrice
</syntaxhighlight>

The following Java code is generated:

<syntaxhighlight lang="java">
private String statement =
"with member [Measures].[SumSales] as '[Measures].[SaleNumber]*[Measures].[unitPrice]'
. . .";
</syntaxhighlight>

► '''Example 2''':
<syntaxhighlight lang="java">
derive MediaTotal from hierarchy PromotionMedia condensed over measure UnitSales
</syntaxhighlight>

The following Java code is generated:

<syntaxhighlight lang="java">
private String statement =
"with member [Measures].[MediaTotal] as '([Measures].[UnitSales],[PromotionMedia].[All Media])'
. . .";
</syntaxhighlight>

=====axis=====

Use the keyword <code>axis</code> to define the query axes of a SELECT clause in an MDX query.

► '''Syntax''':
<syntaxhighlight lang="java">
axis <axis name> {
Cube Hierarchy
/Cube Measure
/Cube Derived Measure
/Cube Set Aggregation
}
</syntaxhighlight>

'''Notes:'''
*<code><axis name></code> can be <code>columns</code>, <code>rows</code>, <code>pages</code>, <code>chapters</code> or <code>sections</code>.

► '''Example''':
<syntaxhighlight lang="java">
axis columns {
hierarchy PromotionMedia level MediaType detailed ordered by derived MediaPerc descending
derived MediaPerc
}
</syntaxhighlight>

The following Java code is generated:

<syntaxhighlight lang="java">
private String statement =
"select CrossJoin(Order([PromotionMedia].[MediaType].Members,[Measures].[MediaPerc],Desc),[Measures].[MediaPerc]) on columns
. . .";
</syntaxhighlight>
 

=====slicer=====

Use the keyword <code>slicer</code> to define the slicer axis of a WHERE clause in an MDX query.

► '''Syntax''':
<syntaxhighlight lang="java">
slicer
Cube Hierarchy
/Cube Measure
/Cube Derived Measure
/Cube Set Aggregation

</syntaxhighlight>

► '''Example''':
<syntaxhighlight lang="java">
</syntaxhighlight>

The following Java code is generated:

<syntaxhighlight lang="java">
private String statement =
". . .
where
. . .";
</syntaxhighlight>
 

====Definitions====

=====Cube Measure=====

<syntaxhighlight lang="java">
measure <cube measure> [scale <scale group number>]
</syntaxhighlight>

'''Notes:'''
*<code><scale group number></code> can have the values <code>group1</code>-<code>group9</code>, permitting different scales values for diagrams and tables.
 

=====Cube Derived Measure=====

<syntaxhighlight lang="java">
derived <derived measure name defined in this datamart>
[scale <scale group number>]

</syntaxhighlight>

'''Notes:'''
*<code><scale group number></code> can have the values <code>group1</code>-<code>group9</code>, permitting different scales values for diagrams and tables.
 

=====Cube Hierarchy=====

<syntaxhighlight lang="java">
hierarchy <hierarchy name>
[default]
[condensed]
[exploded]
[level <level name>
[filtered|selected]
]
[detailed
[except <level name>]
[ordered by
[Cube Measure
/Cube Derived Measure
]
[descending]
]
]
</syntaxhighlight>
 

======default======

'''Returns:''' <code>.DefaultMember</code> of hierarchy, if defaultMember of hierarchy ''is'' defined in [[Cube DSL]].

► '''Example:'''
<syntaxhighlight lang="java">
dimension PromotionMedia {
hierarchy hasAll allMemberName="All Media" defaultMember="All Media"{
. . .
}
}
</syntaxhighlight>

Then, we use the keyword <code>default</code> for a hierarchy in datamartDSL, e.g.:

<syntaxhighlight lang="java">
derive MediaTotal from hierarchy PromotionMedia default over measure UnitSales
</syntaxhighlight>

The following Java code is generated:

<syntaxhighlight lang="java">
private String statement =
"with member [Measures].[MediaTotal] as '([Measures].[UnitSales],[PromotionMedia].Defaultmember)
. . .";
</syntaxhighlight>

'''Returns:''' <code>.Members</code> of hierarchy, if defaultMember of hierarchy ''is not'' defined in [[Cube DSL]].

► '''Example:'''
<syntaxhighlight lang="java">
slicer hierarchy Warehouse default
</syntaxhighlight>

Then, we use the keyword <code>default</code> for a hierarchy in datamartDSL, e.g.:

<syntaxhighlight lang="java">
derive MediaTotal from hierarchy PromotionMedia default over measure UnitSales
</syntaxhighlight>

The following Java code is generated:

<syntaxhighlight lang="java">
private String statement =
"select . . .
from . . .
where ([Warehouse].Members)";

</syntaxhighlight>
 

======condensed======

'''Returns:''' <code>allMemberName</code> of hierarchy, if <code>allMemberName</code> of hierarchy defined in cubeDSL.

► '''Example:'''
<syntaxhighlight lang="java">
dimension PromotionMedia {
hierarchy hasAll allMemberName="All Media" {
. . .
}
}
</syntaxhighlight>

Then, we use the keyword <code>condensed</code> for a hierarchy in datamartDSL, e.g.:

<syntaxhighlight lang="java">
derive MediaTotal from hierarchy PromotionMedia condensed over measure UnitSales
</syntaxhighlight>

The following Java code is generated:

<syntaxhighlight lang="java">
private String statement =
"with member [Measures].[MediaTotal] as '([Measures].[UnitSales],[PromotionMedia].[All Media])'
. . .";
</syntaxhighlight>

'''Returns:''' <code>.DefaultMember</code> of hierarchy, if defaultMember of hierarchy defined in cubeDSL.

► '''Example:'''
<syntaxhighlight lang="java">
dimension PromotionMedia {
hierarchy hasAll defaultMember="All Media"{
. . .
}
}
</syntaxhighlight>

Then, we use the keyword <code>condensed</code> for a hierarchy in datamartDSL, e.g.:

<syntaxhighlight lang="java">
derive MediaTotal from hierarchy PromotionMedia condensed over measure UnitSales
</syntaxhighlight>

The following Java code is generated:

<syntaxhighlight lang="java">
private String statement =
"with member [Measures].[MediaTotal] as '([Measures].[UnitSales],[PromotionMedia].Defaultmember)
. . .";
</syntaxhighlight>

'''Returns:''' <code>.Members</code> of hierarchy if nothing is additionally defined for hierarchy in cubeDSL.

► '''Example:'''
<syntaxhighlight lang="java">
slicer hierarchy Warehouse condensed
</syntaxhighlight>

The following Java code is generated:

<syntaxhighlight lang="java">
private String statement =
"select . . .
from . . .
where ([Warehouse].Members)";
</syntaxhighlight>
 

======exploded======

'''Returns:''' <code>.AllMembers</code> of hierarchy.

► '''Example:'''
<syntaxhighlight lang="java">
derive MediaTotal from hierarchy PromotionMedia exploded over measure UnitSales
</syntaxhighlight>

Then, we use the keyword <code>condensed</code> for a hierarchy in datamartDSL, e.g.:

<syntaxhighlight lang="java">
derive MediaTotal from hierarchy PromotionMedia condensed over measure UnitSales
</syntaxhighlight>

The following Java code is generated:

<syntaxhighlight lang="java">
private String statement =
"with member [Measures].[MediaTotal] as '([Measures].[UnitSales],[PromotionMedia].AllMembers)'
. . .";

</syntaxhighlight>
 

======level ... filtered======

The specified level can be filtered in the GUI.

► '''Example:''' in axis
<syntaxhighlight lang="java">
Datamart . . . {
. . .
axis rows {
hierarchy TheTime level Month filtered
hierarchy Store level StoreState selected
}
. . .
}

</syntaxhighlight>

The following Java code is generated:

<syntaxhighlight lang="java">
private String statement =
". . .
Select . . .
Crossjoin($[TheTime].[Month]$,§[Store].[StoreState]§) on rows
. . .";
private final HashMap<String, String> filterMap = new HashMap<String,String>() {{
put("$[TheTime].[Month]$","select {} on columns,[TheTime].[Month].members on rows from Sales");
. . . }};
</syntaxhighlight>

► '''Example:''' in slicer
<syntaxhighlight lang="java">
Datamart . . . {
. . .
slicer hierarchy TheTime level Quarter filtered
slicer hierarchy StoreType level StoreType selected
}

</syntaxhighlight>

The following Java code is generated:

<syntaxhighlight lang="java">
private String statement =
"select . . .
from . . .
where (?[TheTime].[Quarter]?,![StoreType].[StoreType]!)";
private final HashMap<String, String> filterMap = new HashMap<String,String>() {{
. . .
put("?[TheTime].[Quarter]?","select {} on columns,[TheTime].[Quarter].members on rows from Warehouse");
. . .
}};
</syntaxhighlight>
 

======level ... selected======

The specified level can be selected in the GUI.

► '''Example:''' in axis
<syntaxhighlight lang="java">
Datamart . . . {
. . .
axis rows {
hierarchy TheTime level Month filtered
hierarchy Store level StoreState selected
}
. . .
}

</syntaxhighlight>

The following Java code is generated:

<syntaxhighlight lang="java">
private String statement =
". . .
Select . . .
Crossjoin($[TheTime].[Month]$,§[Store].[StoreState]§) on rows
. . .";
private final HashMap<String, String> filterMap = new HashMap<String,String>()
{{
. . .
put("§[Store].[StoreState]§","select {} on columns,[Store].[StoreState].members on rows from Sales"); }};
</syntaxhighlight>

► '''Example:''' in slicer
<syntaxhighlight lang="java">
Datamart . . . {
. . .
slicer hierarchy TheTime level Quarter filtered
slicer hierarchy StoreType level StoreType selected
}
</syntaxhighlight>

The following Java code is generated:

<syntaxhighlight lang="java">
private String statement =
"select . . .
from . . .
where (?[TheTime].[Quarter]?,![StoreType].[StoreType]!)";
private final HashMap<String, String> filterMap = new HashMap<String,String>() {{
. . .
put("![StoreType].[StoreType]!","select {} on columns,[StoreType].[StoreType].members on rows from Warehouse");
}};
</syntaxhighlight>
 

======detailed======

► '''Returns:''' <code>.Members</code> of level.

► '''Example:'''
<syntaxhighlight lang="java">
axis pages {
hierarchy StoreType level StoreType detailed
}

</syntaxhighlight>

The following Java code is generated:

<syntaxhighlight lang="java">
private String statement =
"Select [StoreType].[StoreType].Members on pages
. . .";
</syntaxhighlight>

► '''Returns:''' <code>.Children</code> of level, if the keyword <code>filtered</code> or <code>selected</code> appears before the keyword <code>detailed</code>.

► '''Example:'''
<syntaxhighlight lang="java">
axis rows {
hierarchy TheTime level Month filtered detailed
hierarchy Store level StoreState selected detailed
}
</syntaxhighlight>

The following Java code is generated:

<syntaxhighlight lang="java">
private String statement =
". . .
Select . . .
Crossjoin($[TheTime].[Month]$.Children,§[Store].[StoreState]§.Children)
on rows
. . .";
</syntaxhighlight>
 

======except======

See the section [[#Except() function]] later in this document.

► '''Example:'''
<syntaxhighlight lang="java">
hierarchy TheTime level Month detailed except Quarter
</syntaxhighlight>

The following Java code is generated:

<syntaxhighlight lang="java">
private String statement =
". . .Except([TheTime].[Month].Members,{%[TheTime].[Quarter]%})
. . .";

</syntaxhighlight>
 

======order by ... (descending)======

See the section [[#Order() function]] later in this document.

► '''Example:'''
<syntaxhighlight lang="java">
hierarchy PromotionMedia level MediaType detailed ordered by derived MediaPerc descending
</syntaxhighlight>

The following Java code is generated:

<syntaxhighlight lang="java">
private String statement =
". . .
Order([PromotionMedia].[MediaType].Members,[Measures].[MediaPerc],Desc)
. . .";
</syntaxhighlight>
 

=====Cube Member Tuple=====

► '''Syntax:'''
<syntaxhighlight lang="java">
[<function name> / <parameter function name> (INT)
of ]
Cube Hierarchy
over
Cube Measure

</syntaxhighlight>

<code><function name></code> can be:
* '''previous''' - see the section [[#.PrevMember function]] later in this document.
* '''next''' - see the section [[#.NextMember function]] later in this document.
* '''first''' - see the section [[#.FirstChild function]] later in this document.
* '''last''' - see the section [[#.LastChild function]] later in this document.

<code><parameter function name></code> can be:
* '''lag''' - see the section [[#.Lag() function]] later in this document.
* '''lead''' - see the section [[#.Lead() function]] later in this document.

► '''Example:'''
<syntaxhighlight lang="java">
derive PrevPeriod from lag(01) of hierarchy TheTime over measure StoreSales
</syntaxhighlight>

The following Java code is generated:

<syntaxhighlight lang="java">
private String statement =
"with member [Measures].[PrevPeriod] as '([Measures].[StoreSales],[TheTime].LAG(1))'
. . .";
</syntaxhighlight>
 

=====Cube Set Tuple=====

► '''Syntax:'''
<syntaxhighlight lang="java">
<set function name> / <set parameter function name> (INT)
of
Cube Hierarchy
</syntaxhighlight>

<code><set function name></code> can be:
*'''year-to-date''' - See the section [[#YTD() function]] later in this document.
*'''periods''' - See the section [[#PeriodsToDate() function]] later in this document.

<code><set parameter function name></code> can be:
*'''tail''' - See the section [[#Tail() function]] later in this document.
*'''head''' - See the section [[#Head() function]] later in this document.

► '''Example:'''
<syntaxhighlight lang="java">
derive SumSCount from summation of periods of hierarchy TheTime level Year
filtered over measure SalesCount
</syntaxhighlight>

The following Java code is generated:

<syntaxhighlight lang="java">
private String statement =
"with member [Measures].[SumSCount] as
'SUM(PERIODSTODATE($[TheTime].[Year]$),[Measures].[SalesCount])'
. . .";
</syntaxhighlight>
 

=====Cube Aggregation=====

► '''Syntax:'''
<syntaxhighlight lang="java">
<aggregation name>
of
Cube Set Tuple
/Cube Hierarchy
over
Cube Measure
</syntaxhighlight>

<code><aggregation name></code> can be:
*'''average''' - See the section [[#Avg() function]] later in this document.
*'''summation''' - See the section [[#Sum() function]] later in this document.
*'''aggregate''' - See the section [[#Aggregate() function]] later in this document.
*'''deviation''' - See the section [[#StdDev() function]] later in this document.

► '''Example:'''
<syntaxhighlight lang="java">
derive SumSCount from summation of periods of hierarchy TheTime level Year
filtered over measure SalesCount
</syntaxhighlight>

The following Java code is generated:

<syntaxhighlight lang="java">
private String statement = "with member [Measures].[SumSCount] as
'SUM(PERIODSTODATE($[TheTime].[Year]$),[Measures].[SalesCount])' . . .";

</syntaxhighlight>

=====Cube Set Aggregation=====

► '''Syntax:'''
<syntaxhighlight lang="java">
<set aggregation name> (INT)
of
Cube Set Tuple
/Cube Hierarchy
over
Cube Measure
</syntaxhighlight>

<code><set aggregation name></code> can be:
*'''topcount''' - See the section [[#TopCount() function]] later in this document.
*'''topsummation''' - See the section [[#TopSum() function]] later in this document.
*'''toppercentage''' - See the section [[#TopPercent() function]] later in this document.
*'''bottomcount''' - See the section [[#BottomCount() function]] later in this document.
*'''bottomsummation''' - See the section [[#BottomSum() function]] later in this document.
*'''bottompercentage''' - See the section [[#BottomPercent() function]] later in this document.

► '''Example:'''
<syntaxhighlight lang="java">
topcount (10) of hierarchy Product level ProductCategory over measure StoreSales
</syntaxhighlight>

The following Java code is generated:

<syntaxhighlight lang="java">
private String statement =
". . .
TOPCOUNT([Product].[ProductCategory].Members,10,[Measures].[StoreSales])
. . .";
</syntaxhighlight>

===Task===

► '''Syntax:'''
<syntaxhighlight lang="java">
datamart <datamart name> . . . using task <task name> ([host <STRhost>] [port <INTport>]) locale <STRlocale> {
[columns {. . .}]
[conditions {. . .}]
}
</syntaxhighlight>

'''Notes:'''
*Task name is including BusinessAdministrator, PotentialOwner, Recipient, TaskInitiator, TaskStakeholder and ExcludedOwner.
*Default value of host is 127.0.0.1 and default port is 9123.
*The BPM process uses Jboss JBPM version 5.4.

====columns====

one or more “column” are defined here.

► '''Syntax:'''
<syntaxhighlight lang="java">
columns {
column <task column>
. . .
}
</syntaxhighlight>

<code><Task Column</code> can be Name, Priority, Status, Subject, Description, ExpirationTime, CreatedOn, CreatedBy, ActivationTime, ActualOwner, TaskId, ProcessId, ProcessInstanceId and ProcessSessionId.

► '''Example:'''
<syntaxhighlight lang="java">
column Status
</syntaxhighlight>

The following Java code is generated:

<syntaxhighlight lang="java">
private HashMap<Integer, ArrayList<String>> axisMap = new HashMap<Integer,ArrayList<String>>() {{
put(0,new ArrayList<String>() {{
add("Status");
. . .
}});
}};

</syntaxhighlight>

== The Basics ==

=== MDX (MultiDimensional eXpressions) ===

MDX is a query language for OLAP databases, much like SQL is a query language for relational databases. It is also a calculation language, with syntax similar to spreadsheet formulas.

MDX has several elements that are used by, or influence, most statements:

*'''Identifiers''' - Identifiers are the names of objects such as cubes, dimensions, members or measures, e.g. <code>[Time]</code>, <code>[Measures]</code>.
*'''Data types''' - Define the types of data that are contained by cells, member properties and cell properties. (For details see the section [[#Data types]] later in this document.)
*'''Expressions (MDX)''' - An expression is a combination of identifiers, values and operators. You can use an expression as part of the data to be retrieved by a query, or as a search condition to look for data that meets a set of criteria. Expressions include functions that return as a single value a set expression, e.g., <code>[Measures].[Discount Amount] * 1.5</code>.
*'''Operators''' - Operators are syntax elements that work with one or more simple MDX expressions to make more complex MDX expressions, e.g., <code>+</code>, <code>-</code>, <code>*</code>, <code>/</code>, <code><</code>, <code>></code>, <code>AND</code> and <code>OR</code>.
*'''Functions''' - Functions are syntax elements that take zero, one or more input values and return a scalar value or an object, e.g., <code>.Dimension</code>, <code>.Level</code> , <code>IsEmpty()</code>,<code>Order()</code>, <code>.CurrentMember</code> etc.
*'''Comments''' - Comments are pieces of text that are inserted into MDX statements or scripts to explain the purpose of the statement. MDX supports <code>//</code>, <code>--</code> and <code>/* ... */</code> as commenting characters.
*'''Reserved keywords''' - Reserved keywords are words that are reserved for the use of MDX and should not be used for object names used in MDX statements, e.g., <code>SELECT</code>, <code>WHERE</code> etc.

====Data types====

There are six primary data types in MDX:

{| class="wikitable" border="0" cellspacing="0" cellpadding="5"
! width="250px" | Type !! width="750px" | Description
|-
|scalar||Scalar is either a number or a string. It can be specified as a literal, e.g., <code>number 5</code> or <code>string "OLAP"</code>, or it can be returned by an MDX function, e.g., <code>Aggregate()</code>, <code>.UniqueName</code>, <code>.Value</code> etc.
|-
|Dimension / Hierarchy||Dimension is a dimension of a cube. A dimension is a primary organizer of measure and attribute information in a cube. MDX does not know of, nor does it assume, any dependencies between dimensions - they are assumed to be mutually independent. A dimension will contain some members organized in some hierarchy or hierarchies, each in turn containing levels. It can be specified by its unique name, e.g., <code>[Time]</code> or it can be returned by an MDX function, e.g., <code>.Dimension</code>. Hierarchy is a dimension hierarchy of a cube. It can be specified by its unique name, e.g., <code>[Time].[Fiscal]</code> or it can be returned by an MDX function, e.g., <code>.Hierarchy</code>. Hierarchies are contained within Dimensions.
|-
|Level||Level is a level in a dimension hierarchy. It can be specified by its unique name, e.g., <code>[Time].[Fiscal].[Month]</code> or it can be returned by an MDX function, e.g., <code>.Level</code>.
|-
|Member||Member is a member in a dimension hierarchy. It can be specified by its unique name, e.g., <code>[Time].[Fiscal].[Month].[August 2014]</code> or its qualified name, e.g., <code>[Time].[Calendar].[2014].[Q3].[August 2014]</code>, or it can be returned by an MDX function, e.g., <code>.PrevMember</code>, <code>.Parent</code>, <code>.FirstChild</code> etc. Note that all members are specific to a hierarchy. If the same product is a member of two different hierarchies (<code>[Product].[ByManufacturer]</code> and <code>[Product].[ByCategory]</code>), then there will be two different members visible that may need to be coordinated in sets and tuples.
|-
|Tuple||Tuple is an ordered collection of one or more members of different dimensions. Tuples can be specified by enumerating the members, e.g., (<code>[Time].[Fiscal].[Month].[August]</code>, <code>[Measures].[Sales]</code>) or returned by an MDX function, e.g., <code>.Item()</code>.
|-
|Set||Set is an ordered collection of tuples with the same dimensionality, or hierarchality in the case of Microsoft's implementation. It can be specified by enumerating the tuples, e.g., <code>{([Measures].[Sales], [Time].[Fiscal].[2014]), ([Measures].[Sales], [Time].[Fiscal].[2014])}</code> or returned by an MDX function or operator, e.g., <code>Crossjoin()</code>, <code>Filter()</code>, <code>Order()</code>, <code>Descendants()</code> etc.
|-
|other data types||Member properties are equivalent to attributes in the data warehouse sense. They can be retrieved by name in a query through an axis PROPERTIES clause of a query. The scalar data value of a member property for some member can be accessed in an expression through MDX, either by naming the property (e.g., <code>[Product].CurrentMember.[Sales Price]</code>) or by using a special access function (e.g., <code>[Product].CurrentMember.Properties("Sales Price")</code>). In limited contexts, MDX allows other data types as well - for example Array can be used inside the <code>SetToArray()</code> function to specify an array that is not processed by MDX but passed to a user-defined function in an ActiveX library. Objects of other data types are represented as scalar strings indicating the object names, such as measure group name in Microsoft's <code>MeasureGroupMeasures()</code> function or KPI(Key Performance Indicator) name in, for example, Microsoft's <code>KPIValue()</code> or <code>KPIGoal()</code> functions.
|}

====Basic Syntax of an MDX query====

► '''Syntax''':
<syntaxhighlight lang="SQL">
-- One of the three ways to write comments
SELECT {set 0} on COLUMNS, /* block comment */
{set 1} on ROWS // line comment
...
{set n} on AXIS(n)
FROM [cube]
WHERE (tuple) // called "slicer dimension"
</syntaxhighlight>

'''Note:''' Key differences between MDX and SQL
*“Cube in, Cube out” for MDX.
*Set notation needs to be used after <code>SELECT</code>.
*The <code>FROM</code> clause can name only one cube.
*The <code>WHERE</code> clause describes the slicer axis (i.e., all the axes that are not query axes) and is filtered by its default members.

====Examples====

=====A typical query=====

► '''Example''':
<syntaxhighlight lang="SQL">
SELECT {[Time].[Calendar].[Year].[2013],
[Time].[Calendar].[Year].[2014]} ON COLUMNS,
{[Store].[Store Name].MEMBERS} ON ROWS
FROM [Sales]
WHERE ([Measures].[Store Sales])
</syntaxhighlight>

=====.MEMBERS and .CHILDREN functions=====

► '''Syntax''':
<syntaxhighlight lang="SQL">
Hierarchy.Members
Level.Members
...
Member.Children
</syntaxhighlight>

'''Notes:'''
* <code>.Members</code> returns the set of members in a dimension, level, or hierarchy.
* <code>.Children</code> returns the set of children of a specified member.

► '''Example''':
<syntaxhighlight lang="SQL">
SELECT {[Time].[Calendar].[Year].[2014].CHILDREN} ON COLUMNS,
{[Store].[Store City].MEMBERS} ON ROWS
FROM [Sales]
WHERE ([Measures].[Store Sales])
</syntaxhighlight>

=====Calculate Member=====

► '''Syntax''':
<syntaxhighlight lang="SQL">
WITH MEMBER parent1.name1 AS ’expression1’
MEMBER parent2.name2 AS ’expression2’
</syntaxhighlight>

'''Notes:'''
* If a calculated member is only required for a single MDX query, you can define that calculated member by using the <code>WITH</code> keyword. A calculated member that is created by using the <code>WITH</code> keyword no longer exists after the query has finished running.

► '''Example 1''':
<syntaxhighlight lang="SQL">
WITH MEMBER [Time].[Calendar].[Year].[2014].[H1] AS
’[Time].[Calendar].[Year].[2014].[Q1] + [Time].[Calendar].[Year].[2014].[Q2]’
MEMBER [Time].[Calendar].[Year].[2014].[H2] AS
’[Time].[Calendar].[Year].[2014].[Q3] + [Time].[Calendar].[Year].[2014].[Q4]’
SELECT {[Time].[Calendar].[Year].[2014].[H1],
[Time].[Calendar].[Year].[2014].[H2]} ON COLUMNS
[Store].[Store Name].MEMBERS ON ROWS
FROM [Sales]
WHERE ([Measures].[Profit])
</syntaxhighlight>

► '''Example 2''': define and use new measures
<syntaxhighlight lang="SQL">
WITH MEMBER [Measures].[ProfitPercent] AS
’([Measures].[Store Sales] – [Measures].[Store Cost]) / ([Measures].[Store Cost])’
SELECT [Time].[Calendar].[Year].[2014].CHILDREN ON COLUMNS,
[Store].[Store Name].MEMBERS ON ROWS
FROM [Sales]
WHERE ([Measures].[ProfitPercent])
</syntaxhighlight>

=====Slicer Dimension=====

► '''Example''': slice on the [Product] dimension
<syntaxhighlight lang="SQL">
SELECT {[Time].[Calendar].[Year].[2014].CHILDREN} ON COLUMNS,
{[Store].[Store City].MEMBERS} ON ROWS
FROM [Sales]
WHERE ([Product].[Product Family].[Drink],
[Measures].[Store Sales])
</syntaxhighlight>

=====Filter() function=====

► '''Syntax''':
<syntaxhighlight lang="SQL">
FILTER(set, logical expression )</syntaxhighlight>

'''Notes:'''
* Returns the set that results from filtering a specified set based on a search condition.

► '''Example''': if we are only interested in stores whose 2014 unit sales exceed 1000
<syntaxhighlight lang="SQL">
SELECT {[Time].[Calendar].[Year].[2014].CHILDREN} ON COLUMNS,
FILTER( {[Store].[Store City].MEMBERS},
([Measures].[Unit Sales], [Time].[Calendar].[Year].[2014]) > 1000 ) ON ROWS
FROM [Sales]
WHERE ([Measures].[Store Sales])
</syntaxhighlight>

=====Order() function=====

► '''Syntax''':
<syntaxhighlight lang="SQL">
ORDER(set, numeric/string expression, [, ASC | DESC | BASC | BDESC]
</syntaxhighlight>

'''Notes:'''
* Arranges members of a specified set, optionally preserving or breaking the hierarchy.

► '''Example 1''': list all measures for each city in decreasing order of their sales count
<syntaxhighlight lang="SQL">
SELECT [Measures].MEMBERS ON COLUMNS,
ORDER(
[Store].[Store City].MEMBERS,
[Measures].[Sales Count],
BDESC
) ON ROWS
FROM [Sales]
</syntaxhighlight>

► '''Example 2''': if we are only interested in stores whose name is between “Berlin” and “Heidelberg”
<syntaxhighlight lang="SQL">
SELECT [Measures].MEMBERS ON COLUMNS,
ORDER(
{[Store].[Store City].[Berlin]:[Heidelberg]},
[Store].CURRENTMEMBER.Name,
BASC
) ON ROWS
FROM [Sales]

</syntaxhighlight>

=====Lag() function=====

► '''Syntax''':
<syntaxhighlight lang="SQL">
Member.LAG(index)
</syntaxhighlight>

'''Notes:'''
* Returns the member that is a specified number of positions before a specified member on the member's level.
* <code>.Lag(1)</code> is equivalent to the <code>.PrevMember</code> function.
* <code>.Lag(-1)</code> is equivalent to the <code>.NextMember</code> function.

► '''Example''': list all measures for December, 2014
<syntaxhighlight lang="SQL">
SELECT [Measures].MEMBERS ON COLUMNS,
[Time].[Fiscal].[Month].[February 2015].LAG(2) ON ROWS
FROM [Sales]
</syntaxhighlight>

=====Lead() function=====

► '''Syntax''':
<syntaxhighlight lang="SQL">
Member.LEAD(index)
</syntaxhighlight>

'''Notes:'''
* Returns the member that is a specified number of positions following a specified member at the member's level.
* <code>.Lead(n)</code> is equivalent to the <code>.Lag(-n)</code> function.

► '''Example''': list all measures for December, 2014
<syntaxhighlight lang="SQL">
SELECT [Measures].MEMBERS ON COLUMNS,
[Time].[Fiscal].[Month].[February 2015].LEAD(-2) ON ROWS
FROM [Sales]
</syntaxhighlight>

=====PrevMember function=====

► '''Syntax''':
<syntaxhighlight lang="SQL">
Member.PREVMEMBER
</syntaxhighlight>

'''Notes:'''
* Returns the previous member in the level that contains a specified member.

► '''Example''': list all measures for January, 2014
<syntaxhighlight lang="SQL">
SELECT [Measures].MEMBERS ON COLUMNS,
[Time].[Fiscal].[Month].[February 2015].PREVMEMBER ON ROWS
FROM [Sales]
</syntaxhighlight>

=====NextMember function=====

► '''Syntax''':
<syntaxhighlight lang="SQL">
Member.NEXTMEMBER
</syntaxhighlight>

'''Notes:'''
* Returns the next member in the level that contains a specified member.

► '''Example''': list all measures for March, 2015
<syntaxhighlight lang="SQL">
SELECT [Measures].MEMBERS ON COLUMNS,
[Time].[Fiscal].[Month].[February 2015].NEXTMEMBER ON ROWS
FROM [Sales]
</syntaxhighlight>

=====FirstChild function=====

► '''Syntax''':
<syntaxhighlight lang="SQL">
Member.FIRSTCHILD
</syntaxhighlight>

'''Notes:'''
* Returns the first child of a specified member.
* Leaf members have no children and therefore no first child.

► '''Example''': list all measures for the first quarter of 2015, which is the first child of year 2015
<syntaxhighlight lang="SQL">
SELECT [Measures].MEMBERS ON COLUMNS,
[Time].[Calendar].[Year].[2015].FIRSTCHILD ON ROWS
FROM [Sales]
</syntaxhighlight>

=====LastChild function=====

► '''Syntax''':
<syntaxhighlight lang="SQL">
Member.LASTCHILD
</syntaxhighlight>

'''Notes:'''
* Returns the last child of a specified member.
* Leaf members have no children and therefore no last child.

► '''Example''': list all measures for March, 2015, which is the last child of the first quarter of the year 2015
<syntaxhighlight lang="SQL">
SELECT [Measures].MEMBERS ON COLUMNS,
[Time].[Calendar].[Quarter].[Q1 2015].LASTCHILD ON ROWS
FROM [Sales]
</syntaxhighlight>

=====Head() function=====

► '''Syntax''':
<syntaxhighlight lang="SQL">
HEAD(set [ ,count ] )
</syntaxhighlight>

'''Notes:'''
* Returns the first specified number of elements of a set.

► '''Example''': show the profit of top-5 cities in terms of sales count
<syntaxhighlight lang="SQL">
SELECT [Measures].[Profit] ON COLUMNS,
HEAD( ORDER( {[Store].[Store City].MEMBERS},
[Measures].[Sales Count],
BDESC
),
5
) ON ROWS
FROM [Sales]
</syntaxhighlight>

=====Tail() function=====

► '''Syntax''':
<syntaxhighlight lang="SQL">
TAIL(set [ ,count ] )
</syntaxhighlight>

'''Notes:'''
* Returns the last specified number of elements of a set.

► '''Example''': show the profit of bottom-5 cities in terms of sales count
<syntaxhighlight lang="SQL">
SELECT [Measures].[Profit] ON COLUMNS,
TAIL( ORDER( {[Store].[Store City].MEMBERS},
[Measures].[Sales Count],
BDESC
),
5
) ON ROWS
FROM [Sales]
</syntaxhighlight>

=====TopCount() function=====

► '''Syntax''':
<syntaxhighlight lang="SQL">
TOPCOUNT(set, count [ ,numeric expression ] )
</syntaxhighlight>

'''Notes:'''
* Sorts a set in descending order and returns the specified number of elements with the highest values.
* The numeric expression is used to evaluate the tuple values. If a numeric expression is not specified, the function returns the set of members in their natural order, without any sorting, behaving like the <code>Head()</code> function.

► '''Example''': show the profit of top-5 cities in terms of sales count
<syntaxhighlight lang="SQL">
SELECT [Measures].[Profit] ON COLUMNS,
TOPCOUNT( [Store].[Store City].MEMBERS,
5,
[Measures].[Sales Count]
) ON ROWS
FROM [Sales]
</syntaxhighlight>

=====BottomCount() function=====

► '''Syntax''':
<syntaxhighlight lang="SQL">
BOTTOMCOUNT(set, count [ ,numeric expression ] )
</syntaxhighlight>

'''Notes:'''
* Sorts a set in ascending order and returns the specified number of elements with the lowest values.
* The numeric expression is used to evaluate the tuple values. If a numeric expression is not specified, the function returns the set of members in their natural order, without any sorting, behaving like the <code>Tail()</code> function.

► '''Example''': show the profit of bottom-5 cities in terms of sales count
<syntaxhighlight lang="SQL">
SELECT [Measures].[Profit] ON COLUMNS,
BOTTOMCOUNT( [Store].[Store City].MEMBERS,
5,
[Measures].[Sales Count]
) ON ROWS
FROM [Sales]
</syntaxhighlight>

=====TopPercent() function=====

► '''Syntax''':
<syntaxhighlight lang="SQL">
TOPPERCENT(set, percentage, numeric expression)
</syntaxhighlight>

'''Notes:'''
* Sorts a set in descending order and then returns the set of tuples with the highest values whose cumulative total is equal to or greater than a specified percentage of the total of all values.
* Percentage must be a positive value between 0 and 100.

► '''Example''': show the best profit and cities that make up the top 10% of sales count
<syntaxhighlight lang="SQL">
SELECT [Measures].[Profit] ON COLUMNS,
TOPPERCENT( [Store].[Store City].MEMBERS,
10,
[Measures].[Sales Count]
) ON ROWS
FROM [Sales]
</syntaxhighlight>

=====BottomPercent() function=====

► '''Syntax''':
<syntaxhighlight lang="SQL">
BOTTOMPERCENT(set, percentage, numeric expression)
</syntaxhighlight>

'''Notes:'''
* Sorts a set in ascending order and then returns the set of tuples with the lowest values whose cumulative total is equal to or greater than a specified percentage of the total of all values.
* Percentage must be a positive value between 0 and 100.

► '''Example''': show the worst profit and cities that make the bottom 10% of sales count
<syntaxhighlight lang="SQL">
SELECT [Measures].[Profit] ON COLUMNS,
BOTTOMPERCENT( [Store].[Store City].MEMBERS,
10,
[Measures].[Sales Count]
) ON ROWS
FROM [Sales]
</syntaxhighlight>

=====TopSum() function=====

► '''Syntax''':
<syntaxhighlight lang="SQL">
TOPSUM(set, value, numeric expression)
</syntaxhighlight>

'''Notes:'''
* Sorts a set and returns the topmost set of elements whose cumulative total is at least a specified value.

► '''Example''': show the smallest set whose cumulative total using the profit measure is at least the sum of 50000, beginning with the members of this set with the highest sales count values
<syntaxhighlight lang="SQL">
SELECT [Measures].[Profit] ON COLUMNS,
TOPSUM ( [Store].[Store City].MEMBERS,
50000,
[Measures].[Sales Count]
) ON ROWS
FROM [Sales]
</syntaxhighlight>

=====BottomSum() function=====

► '''Syntax''':
<syntaxhighlight lang="SQL">
BOTTOMSUM(set, value, numeric expression)
</syntaxhighlight>

'''Notes:'''
* Sorts a set and returns the bottommost set of elements whose sum is equal to or less than a specified value.

► '''Example''': show the smallest set whose cumulative total using the profit measure is at least the sum of 50000, beginning with the members of this set with the smallest number of sales count
<syntaxhighlight lang="SQL">
SELECT [Measures].[Profit] ON COLUMNS,
BOTTOMSUM( [Store].[Store City].MEMBERS,
50000,
[Measures].[Sales Count]
) ON ROWS
FROM [Sales]
</syntaxhighlight>

=====Aggregate() function=====

► '''Syntax''':
<syntaxhighlight lang="SQL">
AGGREGATE(set [, numeric expression])
</syntaxhighlight>

'''Notes:'''
* Returns a number that is calculated by aggregating over the cells returned by the set expression.
* If a numeric expression ''is not'' provided, this function aggregates each measure within the current query context by using the default aggregation operator that is specified for each measure.
* If a numeric expression ''is'' provided, this function first evaluates, and then sums, the numeric expression for each cell in the specified set.

► '''Example''': aggregate profit for all the calendar months
<syntaxhighlight lang="SQL">
WITH MEMBER [Time].[Calendar].[All sales] AS
AGGREGATE([Time].[Calendar].[Month].MEMBERS, [Measures].[Amount])
SELECT [Time].[Calendar].[All sales] ON COLUMNS,
[Store].[Store City].MEMBERS ON ROWS
FROM [Sales]
WHERE [Measures].[Profit]

</syntaxhighlight>

=====Avg() function=====

► '''Syntax''':
<syntaxhighlight lang="SQL">
AVG(set [, numeric expression])
</syntaxhighlight>

'''Notes:'''
* Evaluates a set and returns the average of the non-empty values of the cells in the set, averaged over the measures in the set or over a specified measure.

► '''Example''': show the average profit for each calendar year
<syntaxhighlight lang="SQL">
WITH MEMBER [Measures].[Avg Profit] AS
AVG( [Time].[Calendar].[Month].MEMBERS, Measures.[Profit])
SELECT
Measures.[Avg Profit] ON COLUMNS,
[Time].[Calendar].[Year].MEMBERS ON ROWS
FROM [Sales]

</syntaxhighlight>

=====Sum() function=====

► '''Syntax''':
<syntaxhighlight lang="SQL">
SUM(set [, numeric expression])
</syntaxhighlight>

'''Notes:'''
* Shows the sum of all values of the cells in the set.

► '''Example''': show the total profit for the calendar years 2013 and 2014 (the sum of the 2013 and 2014 profit values for all members of the <code>[Product].[Category]</code> hierarchy)

<syntaxhighlight lang="SQL">
WITH MEMBER [Measures].[Sum Profit] AS
SUM( { [Time].[Calendar].[Year].[2013],
[Time].[Calendar].[Year].[2014] }
, [Measures].[Profit]
)
SELECT [Measures].[Sum Profit] ON COLUMNS,
[Product].[Category].Members ON ROWS
FROM [Sales]

</syntaxhighlight>

=====StdDev() function=====

► '''Syntax''':
<syntaxhighlight lang="SQL">
STDDEV(set [, numeric expression])
</syntaxhighlight>

'''Notes:'''
* Returns the sample standard deviation of a numeric expression evaluated over a set, using the unbiased population formula (dividing by n-1).

► '''Example''': show the standard deviation of the profit values, evaluated over the first 3 months of calendar year 2014, using the unbiased population formula
<syntaxhighlight lang="SQL">
WITH MEMBER [Measures].[Stddev Profit] AS
STDDEV( { [Time].[Calendar].[Month].[January 2014],
[Time].[Calendar].[Month].[February 2014],
[Time].[Calendar].[Month].[March 2014]}
, [Measures].[Profit]
)

</syntaxhighlight>

=====PeriodsToDate() function=====

► '''Syntax''':
<syntaxhighlight lang="SQL">
PERIODSTODATE([level [, member]])
</syntaxhighlight>

'''Notes:'''
* Returns a set of sibling members from the same level as a given member, starting with the first sibling and ending with the given member, as constrained by a specified level in the Time dimension.
* If the <code>member</code> expression is missing, then the level <code>hierarchy.CurrentMember</code> will be used.
* If the <code>level</code> expression is missing, then the parent level of the <code>[Time].CurrentMember</code> in the default time dimension of the cube will be used.

► '''Example''': aggregate profit for the first 8 calendar months of the year 2014
<syntaxhighlight lang="SQL">
WITH MEMBER [Time].[Calendar].[first8Months2014] AS
AGGREGATE (
PERIODSTODATE( [Time].[Calendar].[Year],
[Time].[Calendar].[Month].[August 2014],
)
)
SELECT [Time].[Calendar].[All sales] ON COLUMNS,
[Store].[Store City].MEMBERS ON ROWS
FROM [Sales]
WHERE [Measures].[Profit]
</syntaxhighlight>

=====YTD() function=====

► '''Syntax''':
<syntaxhighlight lang="SQL">
YTD([member])
</syntaxhighlight>

'''Notes:'''
* Returns a set of sibling members from the same level as a given member, starting with the first sibling and ending with the given member, as constrained by the Year level in the Time dimension.
* <code>Ytd(member)</code> is equivalent to <code>PeriodsToDate(Year level, member)</code>.
* If no ''member'' is defined, then <code>[Time].currentMember</code> is used.
* This function does not work when the Type property is set to <code>FiscalYears</code>.

► '''Example''': aggregate profit for the first 8 calendar months of the year 2014
<syntaxhighlight lang="SQL">
WITH MEMBER [Time].[Calendar].[first8Months2014] AS
AGGREGATE (
YTD( [Time].[Calendar].[Month].[August 2014] )
)
SELECT [Time].[Calendar].[All sales] ON COLUMNS,
[Store].[Store City].MEMBERS ON ROWS
FROM [Sales]
WHERE [Measures].[Profit]
</syntaxhighlight>

=====CrossJoin() function=====

► '''Syntax''':
<syntaxhighlight lang="SQL">
CROSSJOIN(set1, set2)
</syntaxhighlight>

'''Notes:'''
* Returns the cross product of one or more sets.

► '''Example''': the query axis (ROWS) is the combination of 2 cube dimensions
<syntaxhighlight lang="SQL">
SELECT [Time].[Calendar].[Year].[2014].CHILDREN ON COLUMNS,
CROSSJOIN( [Store].[Store State].MEMBERS,
[Product].[Product Family].MEMBERS
) ON ROWS
FROM [Sales]
WHERE ([Measures].[Profit])
</syntaxhighlight>

=====NonEmpty() function=====

► '''Syntax''':
<syntaxhighlight lang="SQL">
NONEMPTY(set1 [,set2])
</syntaxhighlight>

'''Notes:'''
* Returns the set of non-empty tuples from a specified set, based on the cross product of the specified set with a second set.

► '''Example''':
<syntaxhighlight lang="SQL">
SELECT [Time].[Calendar].[Year].[2014].CHILDREN ON COLUMNS,
NONEMPTY(
CROSSJOIN( [Store].[Store State].MEMBERS,
[Product].[Product Family].MEMBERS
)
) ON ROWS
FROM [Sales]
WHERE ([Measures].[Profit])
</syntaxhighlight>

=====NonEmptyCrossJoin() function=====

► '''Syntax''':
<syntaxhighlight lang="SQL">
NONEMPTYCROSSJOIN(set1 [,set2, . . .][, count])
</syntaxhighlight>

'''Notes:'''
* Returns a set that contains the cross product of one or more sets, excluding empty tuples and tuples without associated fact table data.
* If <code>count</code> is not specified, the function cross-joins all specified sets and excludes empty members from the result set.
* If a number of sets is specified, the function cross joins the numbers of sets specified, starting with the first specified set.

► '''Example''':
<syntaxhighlight lang="SQL">
SELECT [Time].[Calendar].[Year].[2014].CHILDREN ON COLUMNS,
NONEMPTYCROSSJOIN( [Store].[Store State].MEMBERS,
[Product].[Product Family].MEMBERS
) ON ROWS
FROM [Sales]
WHERE ([Measures].[Profit])
</syntaxhighlight>

=====Except() function=====

► '''Syntax''':
<syntaxhighlight lang="SQL">
EXCEPT(set1 ,set2 [, ALL])
</syntaxhighlight>

'''Notes:'''
* Evaluates two sets and removes those tuples in the first set that also exist in the second set; ensuing duplicates are optionally removed.
* If <code>ALL</code> is specified, the function retains duplicates found in the first set; duplicates found in the second set will still be removed. The members are returned in the order they appear in the first set.

► '''Example''':
<syntaxhighlight lang="SQL">
SELECT [Time].[Calendar].[Month].CHILDREN ON COLUMNS,
EXCEPT( [Product].[Product Categories].[All].Children ,
{[Product].[Product Categories].[Components]}
) ON ROWS
FROM [Sales]
WHERE ([Measures].[Profit])
</syntaxhighlight>

=== Jboss JBPM 5.4 ===

jBPM is a flexible Business Process Management (BPM) suite. It allows you to model, execute and monitor business processes, throughout their life cycle.

jBPM focuses on executable business processes, which are business processes that contain enough detail so that they can actually be executed on a BPM engine. Executable business processes bridge the gap between business users and developers as they are higher-level and use domain-specific concepts that are understood by business users but can also be executed directly.

To interact with the process engine (for example, to start a process), you need to set up a session. This session is used to communicate with the process engine. A session needs to have a reference to a knowledge base, which in turn contains a reference to all the relevant process definitions. This knowledge base is used to look up the process definitions whenever necessary. To create a session, you first need to create a knowledge base, load all the necessary process definitions (this can be from various sources, such as classpath, file system or process repository) and then instantiate a session.

For example, imagine you are writing an application to process sales orders. You could then define one or more process definitions that define how the order should be processed. When starting up your application, you first need to create a knowledge base that contains those process definitions. You can then create a session based on this knowledge base so that, whenever a new sales order comes in, a new process instance is started for that sales order. That process instance contains the state of the process for that specific sales request.

The jBPM project has a clear separation between the API the users should be interacting with and the actual implementation classes. The public API exposes most of the features we believe "normal" users can safely use and should remain rather stable across releases. Expert users can still access internal classes but should be aware that they should know what they are doing and that the internal API might still change in the future.

As explained above, the jBPM API should thus be used to create a knowledge base that contains your process definitions, and to create a session to start new process instances, signal existing ones, register listeners, etc.

You can find more information at http://docs.jboss.org/jbpm/v5.4/userguide/
== Copyright Notice ==

{{Copyright Notice}}

Menu DSL

2017-07-25T19:26:47Z

Cmollik: Created page with "==Introduction== Menu model is used for the UI menu definition. Entries and the corresponding ui pages of the entries could be defined in this model. Predefined process from..."

==Introduction==

Menu model is used for the UI menu definition. Entries and the corresponding ui pages of the entries could be defined in this model. Predefined process from blipDSL, perspective from perspectiveDSL, table from tableDSL and dialog from dialogDSL can be linked to the main '''''entry''''' or its sub '''''entry'''''.

Here is the menu bar in UI: [[File:MenuDSL_01.png|600px]] 

When you click the '''''entry''''' “Company” under main '''''entry''''' “Menu”, the '''''perspective''''' “Company” will be shown on the web site: [[File:MenuDSL_02.png|600px]] 

By clicking the other main '''''entry''''' “Persons”, the embedded table will be shown directly in menu: [[File:MenuDSL_03.png|600px]] 

==MenuDSL==

The MenuDSL works for Os.bee models, it defines the Menus for dialog.

The main semantic elements of the MenuDSL are:

* “package” - the root element that contains all the other elements. A model can contain multiple packages.

* “entry” - define the menu entry and subentry.

===Syntax===

====package definition====

► '''Syntax''':
<syntaxhighlight lang="java">
package <package name>[{
expandedImage <expandedImage String>
collapsedImage <collapsedImage String>
[accordionSubmenu][width <width String>][designer]

MenuEntry
. . .
}]
</syntaxhighlight>

For each menu package, 2 .java file named <code><project name>+Menu.java</code> and <code><project name> +Menu+ContextFunction.java</code> will be generated in folder <code>./src-gen/<package name>/</code>.

► '''Example''':
<syntaxhighlight lang="java">
package net.osbee.sample.foodmart.menues {

expandedImage "collapse_arrow_16" collapsedImage "expand_arrow_16"
accordionSubmenu width "600px" designer
entry Menu described by "my menu" {. . . }
. . .
}
</syntaxhighlight>

* One or more MenuEntry can be defined in the same package.

* Keyword '''expandedImage''' and '''collapsedImage''' is used to define the menu image when the menu expanded or collapsed. Following code will be generated in <project name>+Menu.java file:

<syntaxhighlight lang="java">
public void setIcon(final Accordion accordion, final boolean open) {
Tab tab = accordion.getTab(selectedMap.get(accordion));
if (tab != null) {
if(open) {
tab.setIcon(themeResourceService.getThemeResource(
<expandedImage String>, ThemeResourceType.ICON));
} else {
tab.setIcon(themeResourceService.getThemeResource(
<collapsedImage String>, ThemeResourceType.ICON));
}
}

}
</syntaxhighlight>

* Keyword '''accordionSubmenu''' is optional; you can use this keyword to define if the submenu is accordion.
* Keyword '''width''' is optional; you can use this keyword to define the width of this menu, default value is 400px. Following code will be generated in <code><project name>+Menu.java</code> file:

<syntaxhighlight lang="java">
accRoot.setWidth(<width String>);
</syntaxhighlight>

* Keyword '''designer''' is optional; you can use this keyword to define if this menu could be modified. Following code will be generated in <code><project name>+Menu.java</code> file:

<syntaxhighlight lang="java">
if (designModeHandler != null && userAccessService.isSuperuser()) {
MenuBar menubar = new MenuBar();
tabRoot.addComponent(menubar);
MenuItem designer = menubar.addItem(designerText, null, null);
MenuItem mode = designer.addItem(designmodeText, null, new MenuBar.Command() {
public void menuSelected(MenuItem selectedItem) {
designModeHandler.execute(selectedItem);
}
});
mode.setCheckable(true);
menuItems.put(designerUndoHandler, designer.addItem(undoText, null, new MenuBar.Command() {
public void menuSelected(MenuItem selectedItem) {
designerUndoHandler.execute(selectedItem);
}
}));
menuItems.put(designerRedoHandler, designer.addItem(redoText, null, new MenuBar.Command() {
public void menuSelected(MenuItem selectedItem) {
designerRedoHandler.execute(selectedItem);
}
}));
designer.addSeparator();
menuItems.put(newPerspectiveHandler, designer.addItem(newText, null, new MenuBar.Command() {
public void menuSelected(MenuItem selectedItem) {
newPerspectiveHandler.execute(selectedItem);
}
}));
menuItems.put(changePerspectiveHandler, designer.addItem(changeText, null, new MenuBar.Command() {
public void menuSelected(MenuItem selectedItem) {
changePerspectiveHandler.execute(selectedItem);
}
}));
menuItems.put(exportPerspectiveHandler, designer.addItem(exportText, null, new MenuBar.Command() {
public void menuSelected(MenuItem selectedItem) {
exportPerspectiveHandler.execute(selectedItem);
}
}));
menuItems.put(downloadPerspectiveHandler, designer.addItem(downloadText, null, new MenuBar.Command() {
public void menuSelected(MenuItem selectedItem) {
downloadPerspectiveHandler.execute(selectedItem);
}
}));
}
</syntaxhighlight>

====menuEntry====

This is the main part of this model. All the menu entry details can be defined here. This part could be reused as subentry under the main entry.

► '''Syntax''':
<syntaxhighlight lang="java">
entry <entry name>
[described by <description String>][image <ImageString>][showBadge]
[
process [blip::Blip] |
perspective [perspective::Perspective] |
table [table::Table] |
dialog [dialog::Dialog] |
userFilter |
keyBinding
]
[{
MenuEntry
. . .

}]
</syntaxhighlight>

* Keyword '''described by''' is optional, it define the description of this entry.

* Keyword '''image''' is optional, it define the image string of this entry.

* Keyword '''showBadge''' is optional, it define if the update badge will be shown for this entry.

* Keyword '''process''' is used to define the predefined process from blipDSL which this entry links to.

* Keyword '''perspective''' is used to define the predefined perspective from perspectiveDSL which this entry links to.

* Keyword '''table''' is used to define the predefined table from tableDSL which this entry links to.

* Keyword '''dialog''' is used to define the predefined dialog from dialogDSL which this entry links to.

* Keyword '''userFilter''' are used to define if the user filter will be shown. Following code will be generated in <project name>+Menu.java file:

<syntaxhighlight lang="java">
if (userAccessService.isSuperuser()) {
VerticalLayout tab+<entry name> = new VerticalLayout();
userFilter.createView(tab+<entry name>);
acc<parent name>.addTab(tab+<entry name>, <entry name>, themeResourceService.getThemeResource(<collapsedImage String >, ThemeResourceType.ICON));
tabs.put(acc<parent name>.getTab(tab+<entry name>), new Pair(<entry name>,<entry description>));
}
</syntaxhighlight>

* Keyword '''keyBinding''' is used to define if the key binding works for this entry.

► '''Example''':
<syntaxhighlight lang="java">
entry Sales {
entry CashRegister image "cashregister" perspective CashRegister
}
entry ProductMaintenance process ProductMaintenance
entry MyTasks table TaskMenu
entry Profile dialog UserAccount
entry UserFilter userFilter
</syntaxhighlight>

In the examples, '''entry''' '''''Sales''''' has a sub'''entry''' named '''''CashRegister''''' with '''image''' icon and links to a predefined '''perspective''' named '''''CashReegister''''' from perspectiveDSL; '''entry''' '''''ProductMaintenance''''' links to a predefined '''process''' named '''''ProductMaintenance''''' from blipDSL; '''entry''' '''''MyTasks''''' links to a predefined '''table''' named '''''TaskMenu''''' from tableDSL; '''entry''' '''''Profile''''' links to a predefined '''dialog''' named '''''UserAccount''''' from dialogDSL; '''entry''' '''''UserFilter''''' is defined to shown the user filter.

== Copyright Notice ==
{{Copyright Notice}}

File:MenuDSL 03.png

2017-07-25T19:26:23Z

Cmollik:

File:MenuDSL 02.png

2017-07-25T19:25:24Z

Cmollik: Cmollik uploaded a new version of File:MenuDSL 02.png

File:MenuDSL 02.png

2017-07-25T19:23:45Z

Cmollik:

File:MenuDSL 01.png

2017-07-25T19:23:29Z

Cmollik:

OS.bee Software Factory Documentation

2017-07-25T18:57:14Z

Cmollik: /* OS.bee DSL Documentation */

=OS.bee DSL Documentation=
The ''OS.bee Software Factory'' is composed of various domain specific languages (DSLs), which are described in detail on the following pages.

==[[Entity DSL]]==
The [[Entity DSL]] is, beside Datatypes, the basic DSL for the Software Factory. It allows you, through the creation of entity model files, to describe the entity relationship models that will be used to create, read, update and delete content on a persistence level, such as with an SQL database.

==[[DTO DSL]]==
The [[DTO DSL]] handles data transfer objects in order to transfer data between processes. It uses the [[Entity DSL]].

==[[Chart DSL]]==
The [[Chart DSL]] provides Vaadin dCharts.

==[[Cube DSL]]==
The [[Cube DSL]] provides MDX access to Mondrian OLAP Cubes.

==[[Datamart DSL]]==
A datamart is a condensed and more focused version of a data warehouse that reflects the regulations and process specifications of each business unit within an organization. Each datamart is dedicated to a specific business function or region.

==[[Dialog DSL]]==
The [[Dialog DSL]] generates the [https://vaadin.com/home Vaadin] UI

==[[Report DSL]]==
The [[Report DSL]] generates the [https://vaadin.com/home Vaadin] UI and the [http://developer.actuate.com/about/ BIRT] report module.

==[[Table DSL ]]==
The [[Table DSL]] generates the [https://vaadin.com/home Vaadin] table UI.

==[[Topology DSL ]]==
The [[Topology DSL]] generates [https://d3js.org/ D3.js], a JavaScript library for manipulating documents based on data, to generate the visualization of topology charts. Data used is [https://github.com/topojson topojson], an extension of [http://geojson.org/ GeoJSON] that encodes topology and the corresponding UI components.

==[[Entitymock DSL]]==
The [[Entitymock DSL]] generates mock data for entity models automatically upon initialization.

==[[Statemachine DSL]]==
The [[Statemachine DSL]] adds behavior to user interfaces. Instances of this DSL interconnect UI instances, FunctionLibrary instances, persistence layers and peripheral devices, and therefore act as controllers in a multiple Model-View-Controller environment. There is no limitation of how many statemachine instances control a single business application.

==[[Authorization DSL]]==

==[[Organization DSL]]==

==[[Topology DSL]]==

==[[Perspective DSL]]==

==[[Action DSL]]==

==[[Menu DSL]]==

==[[How to add pictures]]==

=OS.bee-Specific DSL Instances=
The ''OS.bee Software Factory'' provides a few specific DSL instances for different requirements. These are described in detail on the following pages.

==Datatypes==
Several custom datatypes are described in detail in this chapter.
===[[BlobMapping]]===
This datatype allows the use of big data as a blob.

=Other OS.bee-Specific Solutions=
The ''OS.bee Software Factory'' also provides other solutions, which are described in detail on the following pages.

==[[Themes]]==

=OS.bee Third-Party Software Solutions=
OS.bee also uses products of other software vendors (third-party products) that are based on open-source products.

==[[Peripheral Devices]]==

Action DSL

2017-07-25T14:47:04Z

Cmollik: /* ActionDSl */

==Introduction==

===CRUD for toolbar===

Editing data is nice but data must be persisted otherwise all effort invested in editing data would be lost. For this reason, OS.bee apps come with a set of create, read, update and delete functionality (CRUD) to manipulate data in a database. OS.bee can be operated with different database products.

====Create====

Create or add new entries.

If you want to create new data entry, please press the “new data” action button, after the action has been executed, a new unique id must be created. [[File:ActionDSL_01.png|600px]] 

====Read====

Read, retrieve, search or view existing entries.

Existed data can be read from the database. If you request existed data to be displayed in the UI, you must either retrieved a unique id to the database so it can select the requested data, or you can search and select one.

In Os.bee web site, for example the perspective of “Persons”, you can click one row from the table on the left, then the detail data will be read from database and shown in the dialog on the right. [[File:ActionDSL_02.png|600px]] 

====Update====

Update or edit existing entries.

After editing your data, please press the “save” button and the data will be saved in the underlying database. [[File:ActionDSL_03.png|600px]] 

====Delete====

Delete, deactivate or remove existing entries.

If you don’t need an existing entry, please select it and press the “delete” button, then this data will be remove from the underlying database.

 [[File:ActionDSL_04.png|600px]] 

==ActionDSl==

The ActionDSL works for Os.bee models, it defines the toolbar actions for task, select workload, dialog, report, chart, workflow, datainterchange, ect..

The main semantic elements of the ActionDSL are:

* “package” - the root element that contains all the other elements. A model can contain multiple packages.

* “toolbar” - define the action details, e.g. toolbar name, description and items…

* “items” – define the items for this action.

* “item” - define the function and action type for the item …

===Syntax===

====package defintion====

► '''Syntax''':
<syntaxhighlight lang="java">
package <package name>[{
toolbar <toolbar name> [described by <description>]
[items { . . .}]
. . .
} ]
</syntaxhighlight>

For each toolbar, one .java file named <code><toolbar name>+Action.java</code> will be generated in folder <code>./src-gen/<package name>/</code>.

* One or more '''toolbars''' can be defined in the same '''package'''.

* Keyword '''descrbied by''' is optional; you can use this keyword to define the description of this toolbar

* One or more '''item''' can be defined in the same '''items''' block.

► '''Example''':
<syntaxhighlight lang="java">
package net.osbee.sample.foodmart.actions {
toolbar StartTask described by "Toolbar for tables showing tasks"
items { . . . }
toolbar Dialog described by "Toolbar for Dialogs" items { . . . }
toolbar HandleTask described by "Toolbar for BPM oriented perspectives"
items { . . . }
toolbar Report described by "Toolbar for reports" items { . . . }
toolbar WorkloadSelect described by "Toolbar for Workload Selects"
items { . . . }
}
</syntaxhighlight>

In this example, 5 '''toolbars''' are defined in the same '''package'''; they are ''StartTask'', ''Dialog'', ''HandleTask'', ''Report'' and ''WorkloadSelect''.

====Items&item====

This is the main part of this model. All the action details can be defined here. For each item, a java file named <code><toolbar name>+<action rule>+Action.java</code> will be generated in folder <code>./src-gen/<package name>/. <action rule></code> is defined in '''ActionType''' and it will be introduced in the next section.

► '''Syntax''':
<syntaxhighlight lang="java">
items {
item <item name> [described by <description>]
[icon <URI string>]
[group <func.FunctionLibraryGroup name>
[canExecute <func.FunctionLibraryFunction name>]
& [executeParameter <func.FunctionLibraryFunction name>]
]
ActionType
[message <msg.MessageItem name |QualifiedName>]
. . .
}]
. . .
} ]
</syntaxhighlight>

* Keyword '''icon''' is optional, it define the identifier for a resource, e.g. icon file

* Keyword '''group''', '''canExecute & executeParameter''' are used to define the predefined function which this item could use from FunctionlibraryDSL.

► '''Example''':
<syntaxhighlight lang="java">
toolbar HandleTask described by "Toolbar for BPM oriented perspectives" items {
item stop icon "task_action_stop" group PerspectiveToolbar
canExecute stopCanExecute executeParameter getTaskId taskAction Stop
. . .
}
</syntaxhighlight>

In this example, the following code will be generated in the java file of '''item''' '''''stop''''':

<syntaxhighlight lang="java">
@CanExecute
public boolean canExecute() {
return net.osbee.sample.foodmart.functionlibraries.PerspectiveToolbar
.stopCanExecute(getContent());
}

@Execute
public void execute(final IEventBroker eventBroker) {
log.debug("action execute called for stop");
String uuid = (String)eclipseContext.get("HandleTask_TOOLBAR_ID");
eventBroker.send(
EventBrokerMsg.ACTION_BUTTON_EXECUTE_PREFIX+ "HandleTaskAction"+uuid,
new EventBrokerMsg(-1,
"Stop",
net.osbee.sample.foodmart.functionlibraries
.PerspectiveToolbar.getTaskId(getContent())
)
);
}
</syntaxhighlight>

* Keyword '''message''' is used to define the action message using predefined message from messageDSL.

► '''Example''':
<syntaxhighlight lang="java">
toolbar Dialog described by "Toolbar for Dialogs" items {
item newItem icon "dsnew" dialogAction New
item saveItem icon "dssave" dialogAction Save message net.osbee.sample.foodmart.messages.FoodMartErrors.DtoService.SaveMsg
item deleteItem icon "dsdelete" dialogAction Delete message net.osbee.sample.foodmart.messages.FoodMartErrors.DtoService.DeleteMsg
item cancelItem icon "dscancel" dialogAction Cancel
}
</syntaxhighlight>

The '''message''' '''''SavMsg''''' and '''''DeleteMsg''''' are defined in messageDSL as following:

<syntaxhighlight lang="java">
package net.osbee.sample.foodmart.messages{
category FoodMartErrors {
group DtoService {
message DeleteMsg{
parameter{
Exception ex
String stackTrace
}
automatic{}
format {
log "%%ex.simpleName%%: Delete not allowed! –
%%stackTrace%%"
show "%%ex.simpleName%% - %%ex.localizedMessage%%
- Delete not allowed!"
}
}
message SaveMsg{
parameter{
Exception ex
String stackTrace
}
automatic{}
format {
log "%%ex.simpleName%%: Save not allowed! –
%%stackTrace%%"
show "%%ex.simpleName%% - %%ex.localizedMessage%%
- Delete not allowed!"
}
}
}
}
}
</syntaxhighlight>

The '''dialog''' '''''Employee''''' uses this '''toolbar''' '''''Dialog''''' in dialogDSL as following:

<syntaxhighlight lang="java">
package net.osbee.sample.foodmart.dialogs {
dialog Employee described by "Employee data" autobinding MemployeeDto toolbar Dialog
. . .
}
</syntaxhighlight>

There will be no code generated in the related toolbar java files. But in the EmployeeDialog.java, where this toolbar will be used, the following code generated for the message:

<syntaxhighlight lang="java">
public void showSaveErrorMessage(final Exception ex) {
org.eclipse.osbp.xtext.messagedsl.common.Message errorMsg = net.osbee.sample.foodmart.messages.FoodMartErrorsMessage.DtoService_SaveMsg(ex, ex.getMessage());
Notification.show(errorMsg.getShowMessage());
log.error(errorMsg.getLogMessage());
}

public void showDeleteErrorMessage(final Exception ex) {
org.eclipse.osbp.xtext.messagedsl.common.Message errorMsg = net.osbee.sample.foodmart.messages.FoodMartErrorsMessage.DtoService_DeleteMsg(ex, ex.getMessage());
Notification.show(errorMsg.getShowMessage());
log.error(errorMsg.getLogMessage());
}
</syntaxhighlight>

* '''''ActionType''''' will be introduced in the next section.

====ActionType====

'''ActionType''' sets the type of action for the item.

There are 8 kinds of action types:

=====taskAction=====

'''''taskAction''''' is used to define the action of task for bpm.

► '''Syntax''':
<syntaxhighlight lang="java">
taskAction <taskAction rule>
</syntaxhighlight>

* taskAction rule includes 15 rules, and its <action rule> is the same as the following rule:

<syntaxhighlight lang="java">
Claim, Start, Stop, Release, Suspend, Resume, Skip, Complete, Delegate, Forward, Fail, Register, Remove, Activate, Exit
</syntaxhighlight>

► '''Example''':
<syntaxhighlight lang="java">
toolbar StartTask described by "Toolbar for tables showing tasks" items {
item claim icon "task_action_claim" group TaskToolbar
canExecute claimCanExecute executeParameter getTaskId taskAction Claim
item start icon "task_action_start" group TaskToolbar
canExecute startCanExecute executeParameter getTaskId taskAction Start
item start icon "task_action_resume" group TaskToolbar
canExecute resumeCanExecute executeParameter getTaskId taskAction Resume
}
</syntaxhighlight>

=====selectWorkloadAction=====

'''''selectWorkloadAction''''' is used to define the action of select workload.

► '''Syntax''':
<syntaxhighlight lang="java">
selectWorkloadAction <selectWorkloadAction rule>
</syntaxhighlight>

* selectWorkloadAction rule includes the 2 rules, and its <action rule> is as same as the following rule:<code> RemoveAll, AddAll</code>.

► '''Example''':
<syntaxhighlight lang="java">
toolbar WorkloadSelect described by "Toolbar for Workload Selects" items {
item removeAllWorkloadItems icon "task_status_obsolete" selectWorkloadAction RemoveAll
item addAllSelectedItemsToTheWorkload icon "import" selectWorkloadAction AddAll
}
</syntaxhighlight>

=====dialogAction=====

'''DialogAction''' is used to define the actions for dialog.

► '''Syntax''':
<syntaxhighlight lang="java">
dialogAction <dialogAction rule>
</syntaxhighlight>

* dialogAction rule includes the 4 rules, and its <action rule> is as same as the following rule: <code>New, Save, Delete, Cancel</code>

► '''Example''':
<syntaxhighlight lang="java">
toolbar Dialog described by "Toolbar for Dialogs" items {
item newItem icon "dsnew" dialogAction New
item saveItem icon "dssave" dialogAction Save message net.osbee.sample.foodmart.messages.FoodMartErrors.DtoService.SaveMsg
item deleteItem icon "dsdelete" dialogAction Delete message net.osbee.sample.foodmart.messages.FoodMartErrors.DtoService.DeleteMsg
item cancelItem icon "dscancel" dialogAction Cancel
}
</syntaxhighlight>

* “new” means create a new entry.

* “save” means save the changing.

* “delete” means delete the selected entry.

* “cancel” means ignore the changing.

Here is the dialog view in perspective, in which the 4 buttons do the actions by clicking them: [[File:ActionDSL_05.png|600px]] 

=====reportAction=====

'''''ReportAction''''' is used to define the actions for report.

► '''Syntax''':
<syntaxhighlight lang="java">
reportAction <reportAction rule>
</syntaxhighlight>

* reportAction rule includes the 2 rules: PrintOnServer, Download.

* Its <action rule> is PrintOnServer and ReportDownload.

► '''Example''':
<syntaxhighlight lang="java">
toolbar Report described by "Toolbar for reports" items {
item print icon "print" reportAction Download
item print icon "xml" reportAction PrintOnServer
}
</syntaxhighlight>

=====chartAction=====

'''''chartAction''''' is used to define the actions for chart.

► '''Syntax''':
<syntaxhighlight lang="java">
chartAction Download
</syntaxhighlight>

* Its <action rule> is '''''ChartDownload'''''.

=====workflowAction=====

'''''workflowAction''''' is used to define the actions for workflow.

► '''Syntax''':
<syntaxhighlight lang="java">
workflowAction Start
</syntaxhighlight>

* Its <action rule> is '''''start'''''.

=====genericAction=====

'''''genericAction''''' is used to define the actions for yourself. You can define it as you will.

► '''Syntax''':
<syntaxhighlight lang="java">
genericAction <STRING>
</syntaxhighlight>

* Its <action rule> is '''''the string'''''.

=====datainterchangeAction=====

'''''datainterchangeAction''''' is used to define the actions for data interchange

► '''Syntax''':
<syntaxhighlight lang="java">
datainterchangeAction <datainterchangeAction rule> <data.DataInterchange name>
</syntaxhighlight>

* datainterchangeAction type includes the following types, and its <action rule> is as same as the following rule: '''Import, Export'''.

* The data interchange should be predefined in datainterchangeDSL.

The following code will be generated in the java file of '''item''':

<syntaxhighlight lang="java">
@Execute
public void execute(final IEventBroker eventBroker) {
<datainterchange qualified name> <datainerchange name> = new <datainterchange qualified name>();
<datainerchange name>.setFileURL(<file path URL String>
<datainerchange name>.setPersistenceService(persistenceService);
<datainerchange name>.setDirection(WorkerThreadRunnable.Direction.IMPORT);
<datainerchange name>.setEventBroker(eventBroker);
<datainerchange name>.setEventDispatcher(eventDispatcher);
executorService.execute(<datainerchange name>);
}
</syntaxhighlight>

== Copyright Notice ==
{{Copyright Notice}}

Action DSL

2017-07-25T14:46:13Z

Cmollik: Created page with "==Introduction== ===CRUD for toolbar=== Editing data is nice but data must be persisted otherwise all effort invested in editing data would be lost. For this reason, OS.bee..."

==Introduction==

===CRUD for toolbar===

Editing data is nice but data must be persisted otherwise all effort invested in editing data would be lost. For this reason, OS.bee apps come with a set of create, read, update and delete functionality (CRUD) to manipulate data in a database. OS.bee can be operated with different database products.

====Create====

Create or add new entries.

If you want to create new data entry, please press the “new data” action button, after the action has been executed, a new unique id must be created. [[File:ActionDSL_01.png|600px]] 

====Read====

Read, retrieve, search or view existing entries.

Existed data can be read from the database. If you request existed data to be displayed in the UI, you must either retrieved a unique id to the database so it can select the requested data, or you can search and select one.

In Os.bee web site, for example the perspective of “Persons”, you can click one row from the table on the left, then the detail data will be read from database and shown in the dialog on the right. [[File:ActionDSL_02.png|600px]] 

====Update====

Update or edit existing entries.

After editing your data, please press the “save” button and the data will be saved in the underlying database. [[File:ActionDSL_03.png|600px]] 

====Delete====

Delete, deactivate or remove existing entries.

If you don’t need an existing entry, please select it and press the “delete” button, then this data will be remove from the underlying database.

 [[File:ActionDSL_04.png|600px]] 

==ActionDSl==

The actionDSL works for Os.bee models, it defines the toolbar actions for task, select workload, dialog, report, chart, workflow, datainterchange, ect..

The main semantic elements of the ActionDSL are:

* “package” - the root element that contains all the other elements. A model can contain multiple packages.

* “toolbar” - define the action details, e.g. toolbar name, description and items…

* “items” – define the items for this action.

* “item” - define the function and action type for the item …

===Syntax===

====package defintion====

► '''Syntax''':
<syntaxhighlight lang="java">
package <package name>[{
toolbar <toolbar name> [described by <description>]
[items { . . .}]
. . .
} ]
</syntaxhighlight>

For each toolbar, one .java file named <code><toolbar name>+Action.java</code> will be generated in folder <code>./src-gen/<package name>/</code>.

* One or more '''toolbars''' can be defined in the same '''package'''.

* Keyword '''descrbied by''' is optional; you can use this keyword to define the description of this toolbar

* One or more '''item''' can be defined in the same '''items''' block.

► '''Example''':
<syntaxhighlight lang="java">
package net.osbee.sample.foodmart.actions {
toolbar StartTask described by "Toolbar for tables showing tasks"
items { . . . }
toolbar Dialog described by "Toolbar for Dialogs" items { . . . }
toolbar HandleTask described by "Toolbar for BPM oriented perspectives"
items { . . . }
toolbar Report described by "Toolbar for reports" items { . . . }
toolbar WorkloadSelect described by "Toolbar for Workload Selects"
items { . . . }
}
</syntaxhighlight>

In this example, 5 '''toolbars''' are defined in the same '''package'''; they are ''StartTask'', ''Dialog'', ''HandleTask'', ''Report'' and ''WorkloadSelect''.

====Items&item====

This is the main part of this model. All the action details can be defined here. For each item, a java file named <code><toolbar name>+<action rule>+Action.java</code> will be generated in folder <code>./src-gen/<package name>/. <action rule></code> is defined in '''ActionType''' and it will be introduced in the next section.

► '''Syntax''':
<syntaxhighlight lang="java">
items {
item <item name> [described by <description>]
[icon <URI string>]
[group <func.FunctionLibraryGroup name>
[canExecute <func.FunctionLibraryFunction name>]
& [executeParameter <func.FunctionLibraryFunction name>]
]
ActionType
[message <msg.MessageItem name |QualifiedName>]
. . .
}]
. . .
} ]
</syntaxhighlight>

* Keyword '''icon''' is optional, it define the identifier for a resource, e.g. icon file

* Keyword '''group''', '''canExecute & executeParameter''' are used to define the predefined function which this item could use from FunctionlibraryDSL.

► '''Example''':
<syntaxhighlight lang="java">
toolbar HandleTask described by "Toolbar for BPM oriented perspectives" items {
item stop icon "task_action_stop" group PerspectiveToolbar
canExecute stopCanExecute executeParameter getTaskId taskAction Stop
. . .
}
</syntaxhighlight>

In this example, the following code will be generated in the java file of '''item''' '''''stop''''':

<syntaxhighlight lang="java">
@CanExecute
public boolean canExecute() {
return net.osbee.sample.foodmart.functionlibraries.PerspectiveToolbar
.stopCanExecute(getContent());
}

@Execute
public void execute(final IEventBroker eventBroker) {
log.debug("action execute called for stop");
String uuid = (String)eclipseContext.get("HandleTask_TOOLBAR_ID");
eventBroker.send(
EventBrokerMsg.ACTION_BUTTON_EXECUTE_PREFIX+ "HandleTaskAction"+uuid,
new EventBrokerMsg(-1,
"Stop",
net.osbee.sample.foodmart.functionlibraries
.PerspectiveToolbar.getTaskId(getContent())
)
);
}
</syntaxhighlight>

* Keyword '''message''' is used to define the action message using predefined message from messageDSL.

► '''Example''':
<syntaxhighlight lang="java">
toolbar Dialog described by "Toolbar for Dialogs" items {
item newItem icon "dsnew" dialogAction New
item saveItem icon "dssave" dialogAction Save message net.osbee.sample.foodmart.messages.FoodMartErrors.DtoService.SaveMsg
item deleteItem icon "dsdelete" dialogAction Delete message net.osbee.sample.foodmart.messages.FoodMartErrors.DtoService.DeleteMsg
item cancelItem icon "dscancel" dialogAction Cancel
}
</syntaxhighlight>

The '''message''' '''''SavMsg''''' and '''''DeleteMsg''''' are defined in messageDSL as following:

<syntaxhighlight lang="java">
package net.osbee.sample.foodmart.messages{
category FoodMartErrors {
group DtoService {
message DeleteMsg{
parameter{
Exception ex
String stackTrace
}
automatic{}
format {
log "%%ex.simpleName%%: Delete not allowed! –
%%stackTrace%%"
show "%%ex.simpleName%% - %%ex.localizedMessage%%
- Delete not allowed!"
}
}
message SaveMsg{
parameter{
Exception ex
String stackTrace
}
automatic{}
format {
log "%%ex.simpleName%%: Save not allowed! –
%%stackTrace%%"
show "%%ex.simpleName%% - %%ex.localizedMessage%%
- Delete not allowed!"
}
}
}
}
}
</syntaxhighlight>

The '''dialog''' '''''Employee''''' uses this '''toolbar''' '''''Dialog''''' in dialogDSL as following:

<syntaxhighlight lang="java">
package net.osbee.sample.foodmart.dialogs {
dialog Employee described by "Employee data" autobinding MemployeeDto toolbar Dialog
. . .
}
</syntaxhighlight>

There will be no code generated in the related toolbar java files. But in the EmployeeDialog.java, where this toolbar will be used, the following code generated for the message:

<syntaxhighlight lang="java">
public void showSaveErrorMessage(final Exception ex) {
org.eclipse.osbp.xtext.messagedsl.common.Message errorMsg = net.osbee.sample.foodmart.messages.FoodMartErrorsMessage.DtoService_SaveMsg(ex, ex.getMessage());
Notification.show(errorMsg.getShowMessage());
log.error(errorMsg.getLogMessage());
}

public void showDeleteErrorMessage(final Exception ex) {
org.eclipse.osbp.xtext.messagedsl.common.Message errorMsg = net.osbee.sample.foodmart.messages.FoodMartErrorsMessage.DtoService_DeleteMsg(ex, ex.getMessage());
Notification.show(errorMsg.getShowMessage());
log.error(errorMsg.getLogMessage());
}
</syntaxhighlight>

* '''''ActionType''''' will be introduced in the next section.

====ActionType====

'''ActionType''' sets the type of action for the item.

There are 8 kinds of action types:

=====taskAction=====

'''''taskAction''''' is used to define the action of task for bpm.

► '''Syntax''':
<syntaxhighlight lang="java">
taskAction <taskAction rule>
</syntaxhighlight>

* taskAction rule includes 15 rules, and its <action rule> is the same as the following rule:

<syntaxhighlight lang="java">
Claim, Start, Stop, Release, Suspend, Resume, Skip, Complete, Delegate, Forward, Fail, Register, Remove, Activate, Exit
</syntaxhighlight>

► '''Example''':
<syntaxhighlight lang="java">
toolbar StartTask described by "Toolbar for tables showing tasks" items {
item claim icon "task_action_claim" group TaskToolbar
canExecute claimCanExecute executeParameter getTaskId taskAction Claim
item start icon "task_action_start" group TaskToolbar
canExecute startCanExecute executeParameter getTaskId taskAction Start
item start icon "task_action_resume" group TaskToolbar
canExecute resumeCanExecute executeParameter getTaskId taskAction Resume
}
</syntaxhighlight>

=====selectWorkloadAction=====

'''''selectWorkloadAction''''' is used to define the action of select workload.

► '''Syntax''':
<syntaxhighlight lang="java">
selectWorkloadAction <selectWorkloadAction rule>
</syntaxhighlight>

* selectWorkloadAction rule includes the 2 rules, and its <action rule> is as same as the following rule:<code> RemoveAll, AddAll</code>.

► '''Example''':
<syntaxhighlight lang="java">
toolbar WorkloadSelect described by "Toolbar for Workload Selects" items {
item removeAllWorkloadItems icon "task_status_obsolete" selectWorkloadAction RemoveAll
item addAllSelectedItemsToTheWorkload icon "import" selectWorkloadAction AddAll
}
</syntaxhighlight>

=====dialogAction=====

'''DialogAction''' is used to define the actions for dialog.

► '''Syntax''':
<syntaxhighlight lang="java">
dialogAction <dialogAction rule>
</syntaxhighlight>

* dialogAction rule includes the 4 rules, and its <action rule> is as same as the following rule: <code>New, Save, Delete, Cancel</code>

► '''Example''':
<syntaxhighlight lang="java">
toolbar Dialog described by "Toolbar for Dialogs" items {
item newItem icon "dsnew" dialogAction New
item saveItem icon "dssave" dialogAction Save message net.osbee.sample.foodmart.messages.FoodMartErrors.DtoService.SaveMsg
item deleteItem icon "dsdelete" dialogAction Delete message net.osbee.sample.foodmart.messages.FoodMartErrors.DtoService.DeleteMsg
item cancelItem icon "dscancel" dialogAction Cancel
}
</syntaxhighlight>

* “new” means create a new entry.

* “save” means save the changing.

* “delete” means delete the selected entry.

* “cancel” means ignore the changing.

Here is the dialog view in perspective, in which the 4 buttons do the actions by clicking them: [[File:ActionDSL_05.png|600px]] 

=====reportAction=====

'''''ReportAction''''' is used to define the actions for report.

► '''Syntax''':
<syntaxhighlight lang="java">
reportAction <reportAction rule>
</syntaxhighlight>

* reportAction rule includes the 2 rules: PrintOnServer, Download.

* Its <action rule> is PrintOnServer and ReportDownload.

► '''Example''':
<syntaxhighlight lang="java">
toolbar Report described by "Toolbar for reports" items {
item print icon "print" reportAction Download
item print icon "xml" reportAction PrintOnServer
}
</syntaxhighlight>

=====chartAction=====

'''''chartAction''''' is used to define the actions for chart.

► '''Syntax''':
<syntaxhighlight lang="java">
chartAction Download
</syntaxhighlight>

* Its <action rule> is '''''ChartDownload'''''.

=====workflowAction=====

'''''workflowAction''''' is used to define the actions for workflow.

► '''Syntax''':
<syntaxhighlight lang="java">
workflowAction Start
</syntaxhighlight>

* Its <action rule> is '''''start'''''.

=====genericAction=====

'''''genericAction''''' is used to define the actions for yourself. You can define it as you will.

► '''Syntax''':
<syntaxhighlight lang="java">
genericAction <STRING>
</syntaxhighlight>

* Its <action rule> is '''''the string'''''.

=====datainterchangeAction=====

'''''datainterchangeAction''''' is used to define the actions for data interchange

► '''Syntax''':
<syntaxhighlight lang="java">
datainterchangeAction <datainterchangeAction rule> <data.DataInterchange name>
</syntaxhighlight>

* datainterchangeAction type includes the following types, and its <action rule> is as same as the following rule: '''Import, Export'''.

* The data interchange should be predefined in datainterchangeDSL.

The following code will be generated in the java file of '''item''':

<syntaxhighlight lang="java">
@Execute
public void execute(final IEventBroker eventBroker) {
<datainterchange qualified name> <datainerchange name> = new <datainterchange qualified name>();
<datainerchange name>.setFileURL(<file path URL String>
<datainerchange name>.setPersistenceService(persistenceService);
<datainerchange name>.setDirection(WorkerThreadRunnable.Direction.IMPORT);
<datainerchange name>.setEventBroker(eventBroker);
<datainerchange name>.setEventDispatcher(eventDispatcher);
executorService.execute(<datainerchange name>);
}
</syntaxhighlight>

== Copyright Notice ==
{{Copyright Notice}}

File:ActionDSL 05.png

2017-07-25T12:39:18Z

Cmollik:

File:ActionDSL 04.png

2017-07-25T12:39:12Z

Cmollik:

File:ActionDSL 03.png

2017-07-25T12:39:04Z

Cmollik:

File:ActionDSL 02.png

2017-07-25T12:36:06Z

Cmollik:

File:ActionDSL 01.png

2017-07-25T12:34:03Z

Cmollik:

OS.bee Software Factory Documentation

2017-07-25T12:15:54Z

Cmollik: /* OS.bee DSL Documentation */

=OS.bee DSL Documentation=
The ''OS.bee Software Factory'' is composed of various domain specific languages (DSLs), which are described in detail on the following pages.

==[[Entity DSL]]==
The [[Entity DSL]] is, beside Datatypes, the basic DSL for the Software Factory. It allows you, through the creation of entity model files, to describe the entity relationship models that will be used to create, read, update and delete content on a persistence level, such as with an SQL database.

==[[DTO DSL]]==
The [[DTO DSL]] handles data transfer objects in order to transfer data between processes. It uses the [[Entity DSL]].

==[[Chart DSL]]==
The [[Chart DSL]] provides Vaadin dCharts.

==[[Cube DSL]]==
The [[Cube DSL]] provides MDX access to Mondrian OLAP Cubes.

==[[Datamart DSL]]==
A datamart is a condensed and more focused version of a data warehouse that reflects the regulations and process specifications of each business unit within an organization. Each datamart is dedicated to a specific business function or region.

==[[Dialog DSL]]==
The [[Dialog DSL]] generates the [https://vaadin.com/home Vaadin] UI

==[[Report DSL]]==
The [[Report DSL]] generates the [https://vaadin.com/home Vaadin] UI and the [http://developer.actuate.com/about/ BIRT] report module.

==[[Table DSL ]]==
The [[Table DSL]] generates the [https://vaadin.com/home Vaadin] table UI.

==[[Topology DSL ]]==
The [[Topology DSL]] generates [https://d3js.org/ D3.js], a JavaScript library for manipulating documents based on data, to generate the visualization of topology charts. Data used is [https://github.com/topojson topojson], an extension of [http://geojson.org/ GeoJSON] that encodes topology and the corresponding UI components.

==[[Entitymock DSL]]==
The [[Entitymock DSL]] generates mock data for entity models automatically upon initialization.

==[[Statemachine DSL]]==
The [[Statemachine DSL]] adds behavior to user interfaces. Instances of this DSL interconnect UI instances, FunctionLibrary instances, persistence layers and peripheral devices, and therefore act as controllers in a multiple Model-View-Controller environment. There is no limitation of how many statemachine instances control a single business application.

==[[Authorization DSL]]==

==[[Organization DSL]]==

==[[Topology DSL]]==

==[[Perspective DSL]]==

==[[Action DSL]]==

==[[How to add pictures]]==

=OS.bee-Specific DSL Instances=
The ''OS.bee Software Factory'' provides a few specific DSL instances for different requirements. These are described in detail on the following pages.

==Datatypes==
Several custom datatypes are described in detail in this chapter.
===[[BlobMapping]]===
This datatype allows the use of big data as a blob.

=Other OS.bee-Specific Solutions=
The ''OS.bee Software Factory'' also provides other solutions, which are described in detail on the following pages.

==[[Themes]]==

=OS.bee Third-Party Software Solutions=
OS.bee also uses products of other software vendors (third-party products) that are based on open-source products.

==[[Peripheral Devices]]==

DTO DSL

2017-07-05T08:32:49Z

Cmollik: /* DTO */

==Purpose==

The DTO DSL facilitates the creation and handling of data transfer objects (DTOs) in order to transfer data between processes. Communication between processes is usually done by calls to remote interfaces and services, where each call is a computationally expensive and time-consuming operation. The use of DTOs that aggregate data that would have been transferred separately reduces the number of calls that are necessary, thus speeding up the data-transfer operation. Furthermore, DTOs are decoupled from the JPA, thus eliminating burdensome dependencies.

Using the DTO DSL, it is easy to create DTOs and the mapper classes that link them to the respective persistence entities. Property-change support is automatically included, in order to have current data without direct dependencies on the persistence layer.

==Overview==

The main semantic elements of the DTO DSL are the following:
* '''package''' - The root element that contains all the other elements. A model can contain multiple packages.
* '''import''' declarations - Used to import other DTO models or the entity model files that are covered by the DTOs.
* '''datatype''' declarations - A way to define datatypes that can be used (only within the package - private scope).
* '''DTO''' - The model of a DTO that wraps an entity. It contains further elements such as properties and references. Appropriate mapper methods can be specified.
* '''property''' - A reference to an enum, a Java class or a “simple datatype" (as defined in the datatype declaration). Can be inherited from the wrapped entity and offers multiplicity.
* '''reference''' - A reference to another DTO. Can be inherited from the wrapped entity and offers multiplicity.
* '''operation''' - Similar to Java methods. The Xbase expression language can be used to write high-level code.
* '''comment''' - Can be added to all elements.

► Note: In order to make use of the DTO DSL, one has to make sure that the OSBP builder is executed after the Xtext builder.

==DTO model files==

DTO models are described in <code>.dtos</code> files. These files describe the DTO model and are the basis for the code generation. DTO models may be split over several <code>.dtos</code> files containing packages in the same namespace.

A <code>.dtos</code> file may contain several packages with DTOs.

===package===
<blockquote>
Packages are the root element of the DTO DSL grammar. Everything is contained in a <code>package</code>; imports, datatypes, DTOs and enums have to be defined within the package. One document can contain multiple packages with unique names.

The elements a package can contain are DTOs and enums. Additionally, a package allows <code>import</code> statements and the declaration of datatypes.
[[File:Dto-01.png|right|frame|''Figure 1 - DTO model file - a package is the topmost element and contains other items.'']]

► '''Syntax:'''

<syntaxhighlight lang="java">
package name {
import importStatement;
datatype datatypeDefinition;
DTOs
}
</syntaxhighlight>

</blockquote>

===import===
<blockquote>
In order to wrap entities into DTOs, the DTO DSL has to reference entities defined in entity model files. Furthermore, it is possible to reference DTOs in other packages. The <code>import</code> statement is a way to address these elements without having to use their fully qualified name.

Import statements allow the use of the '*' wildcard.

► '''Syntax:'''

<syntaxhighlight lang="java">
package name {
import importStatement;
datatype datatypeDefinition;
DTOs
}
</syntaxhighlight>
[[File:Dto-02.png|center|frame|''Figure 2 - Items contained in another package can be accessed and handled if the package is imported.'']]

</blockquote>

===datatype===
<blockquote>
The DTO DSL allows the definition of datatypes. These are translated by the inferrer into their standard Java presentation. The behavior of the generator can be controlled by the datatype definitions.
There are three types of datatype definitions:

;jvmTypes: Datatype definitons that map types to jvmTypes take the basic syntax of <code>datatype <name> jvmType <type> as primitive;</code> Specifying datatypes in this manner uses an appropriate wrapper class in the generated Java code. Adding the keywords <code>as primitive</code> enforces the use of primitive datatypes where applicable: <code>datatype foo jvmType Integer</code> compiles to an <code>Integer</code> whereas <code>datatype foo jvmType Integer as primitive</code> results in <code>int</code>.

;dateTypes: The datatypes for handling temporal information can be defined by the following statement: <code>datatype <name> datetype date|time|timestamp;</code> Datatypes that have been defined in this manner can be used as property variables in DTOs.

;blobs: Binary blobs can be handled by defining a datatype with the <code>as blob</code> keyword. The Java implementation of such a blob is a byte array. <code>datatype <name> as blob;</code>

After <code>import</code> statements and <code>datatype</code> definitions, the content of the .dtos file is made up of DTO definitions.
</blockquote>

==DTO==

Data Transfer Objects ('''DTOs''') are the most complex elements in the DTO DSL. A DTO wraps an '''entity''' defined in the [[Entity DSL]] together with its properties and references into a single object used for communication purposes.

DTOs are defined by name, properties, references and wrapper methods. A DTO normally does not implement business logic.

For each DTO that is defined in a package, the DTO DSL automatically generates a Java DTO class and a corresponding mapper class that handles data transfer and conversion between DTO and entity.

► '''Syntax:'''

<syntaxhighlight lang="java">
abstract dto <name> extends <parentDto> wraps <entityName> {
dtoFeatures
}
</syntaxhighlight>

[[File:dto-03.png|center|frame|''Figure 3 - The defined DTO is translated to a Java class and an appropriate mapper class.'']]

===extends===
<blockquote>
<code>extends</code> marks a DTO that is derived from another DTO. That means that the properties and references of the parent DTO are inherited.

[[File:dto-04.png|center|frame|''Figure 4 - The <code>extends</code> keyword causes a Java subclass to be created for the DTO.'']]

</blockquote>

===wraps===
<blockquote>
<code>wraps</code> indicates the entity that is handled by the DTO. The entity has to be imported from the entity model file into the DTO package (for importing several entities, the use of the '*' wildcard may be advisable).

[[File:dto-05.png|center|frame|''Figure 4 - The <code>wraps</code> keyword links the DTO to its respective entity. Thus, properties and references of the entity are made available in the DTO (and can be accessed there via content assist).'']]
</blockquote>

==Enums==

Enums are an abstraction of the Java enum. They compile to <code>enum</code> classes and can be used as properties in DTOs.

[[File:dto-06.png|center|frame|''Figure 6 - Defining enums allows using them as variables in DTOs.'']]

==Properties==

Properties of DTOs are references to datatypes or enums. They can be regarded as variables and are defined by a keyword followed by a datatype (Java type or datatype defined in the datatype section) and a name.

Properties can be determined with the following keywords:

===var===
<blockquote>
The basic property. Defines a variable that can be used within the DTO. Appropriate getters and setters are created.

[[File:dto-07.png|center|frame|''Figure 7 - Variables can be defined using the <code>var</code> keyword.'']]
</blockquote>

===id===
<blockquote>
{{deprecated}}

Defines a field in the DTO for mapping an <code>id</code> property (used as a primary key in the persistence layer). This keyword is deprecated. If no <code>id</code> is given, a warning is shown. Caution: ID autogeneration causes problems, since the value is not set before the entity is persisted to the database, which can cause problems.

'''It is advised to use the <code>uuid</code> keyword instead.'''

[[File:dto-08.png|center|frame|''Figure 8 - Using the <code>id</code> property, "id" is defined as a unique key.'']]
</blockquote>

===uuid===
<blockquote>
Creates a field for the mapping of Universally Unique IDs as primary keys. UUIDs must be strings.

[[File:dto-09.png|center|frame|''Figure 9 - By using the <code>uuid</code> keyword, reliably unique IDs can be used as primary keys and mapped to a DTO.'']]
</blockquote>

===version===
<blockquote>
Defines a field for mapping a version property used by the JPA Compiler.

[[File:dto-10.png|center|frame|''Figure 10 - A version property can be mapped into a DTO by using the <code>version</code> keyword.'']]
</blockquote>

===transient===
<blockquote>
Marks the property as <code>transient</code>. Transient properties are not mapped from the DTO to the entity and are thus not persisted. Getter and setter methods are created.

[[File:dto-11.png|center|frame|''Figure 11 - The <code>transient</code> keyword allows properties to be excluded from the mapping.'']]
</blockquote>

===derived===
<blockquote>
Marks the property as being derived from other values. The logic used in the derivation process may be specified using Xbase. Derived properties are not persisted, and only a getter is created.

[[File:dto-12.png|center|frame|''Figure 12 - The <code>derived</code> keyword marks properties that are based on other values and are computed at runtime. The calculation logic is translated to Java. Derived properties are excluded from the mapping.'']]
</blockquote>

==References==

The DTO DSL tracks relationships between DTOs by using the concept of references. Where appropriate, reverse references can be created using the <code>opposite</code> property.

References are defined by the <code>ref</code> keyword, a type and a name. The exact type of reference can be specified as follows:

*'''multiplicity and nullability''': The DTO DSL supports the specification of multiplicities in square brackets appended to the type:
**<code>[1]</code> defines a non-nullable, one-to-one relationship.
**<code>[0..1]</code> defines a nullable, one-to-one relationship (this is the default behavior).
**<code>[1..*]</code> defines a non-nullable, one-to-many relationship. An <code>opposite</code> reference is required.
**<code>[0..*]</code>, or simply <code>[*]</code>, defines a nullable, one-to-many relationship. An <code>opposite</code> reference is required.
*'''opposite reference''': In the [[Entity DSL]], lifecycle references between entities need the specification of an <code>opposite</code> reference in order to navigate back to the original object after following the reference. The DTO DSL includes a mechanism to map such references using the <code>opposite</code> keyword.
*'''cascade''': The cascade specifier controls the behavior of the database on delete operations. If <code>cascade</code> is specified, dependent records are also deleted. In the DTO DSL, these cascading references can be mapped to DTOs by the same keyword.

[[File:dto-13.png|center|frame|''Figure 13 - An example of two DTOs referencing each other. The second DTO maps a cascading, non-nullable, one-to-many reference.'']]

==Inherited Features==

Inherited properties and references are the core of the DTO DSL. They provide the mechanism for mapping entities and their features to the respective DTOs and their features.

There are two types of inherited features: inherited properties and inherited references.

Inherited features are defined by the <code>inherit</code> keyword followed by the feature type and the name of the feature in the entity. After that, the DTO to which a referenced entity or an embedded bean is mapped may be specified using the <code>mapto</code> keyword.
Finally, custom mapper directives may be specified (see [[#Custom Mappers|Custom Mappers]]).
*'''inherit var''': used for mapping entity properties to DTO properties
*'''inherit ref''': used for mapping entity references to DTO references
*'''mapto''': defines the DTO the feature should be mapped to. In the case of inherit var, this keyword is used to point to a DTO that maps a bean from the entity model file. In the case of inherit ref, a DTO must be specified that the reference points to.

► Syntax:
<syntaxhighlight lang="java">
inherit var|ref entityFeature mapto dtoName {customMapper} ;
</syntaxhighlight>

[[File:dto-14.png|center|frame|''Figure 14 - The <code>inherit</code> var keyword is used to map entity properties to DTO properties. Content assist is available. The <code>mapto</code> keyword specifies which DTO an embedded bean is mapped to.'']]

 

[[File:dto-15.png|center|frame|''Figure 15 - The <code>inherit ref</code> keywords allow for mapping entity references to DTO references. Content assist is available, and multiplicities and opposite references are automatically carried over from the entity model file. The <code>mapto</code> keyword indicates the DTO that serves as the other end of the reference.'']]

==Custom Mappers==

The DTO DSL provides a mechanism for creating custom mappers between DTOs and entities. These can be defined after the declaration of a property or reference, and they control the information exchange for the respective feature.

In order to create a custom mapper, the <code>toDTO</code> and <code>fromDTO</code> keywords are used, followed by the mapper definition in curly braces. <code>toDTO</code> controls the flow of information from entity to DTO, <code>fromDTO</code> vice versa. Within the curly braces, the special words <code>in</code> and <code>out</code> may be used to reference the source and destination of the mapping.

► Syntax:

<syntaxhighlight lang="java">
inherit var|ref <entityFeature> mapto <dtoName> {
toDto {
XbaseDirectives
}
fromDto {
XbaseDirectives
}
}
</syntaxhighlight>

[[File:dto-16.png|center|frame|''Figure 16 - The <code>toDto</code> section creates a custom mapping from entity to DTO: First, a local variable <code>ArrayList</code> is created, then an InfoDetail with a disclaimer is added to each entry. The <code>in</code> keyword is used to reference the entity for the iteration.'']]

==Operations==

The DTO DSL supports the declaration of operations that can be performed within the DTOs. These operations are based on Xbase and offer a huge set of semantic features, extending the featureset of Java. Xbase additionally offers features like closures. When using operations, bear in mind that it is not good practice to implement business logic within DTOs. Operations can be declared by the <code>def</code> keyword followed by braces containing the inline operation.

► Syntax:

<syntaxhighlight lang="java">
def returnType operationName() {
XbaseDirectives
}
</syntaxhighlight>

[[File:dto-17.png|center|frame|''Figure 17 - The <code>def</code> keyword allows the inlining of custom methods in the DTO DSL code. These methods are translated into the appropriate Java methods.'']]

==Comments==

Comments can be added anywhere in a .dtos text file and are copied over into the generated Java code. Comments are enclosed in <code>/* ... */</code>.

[[File:dto-18.png|center|frame|''Figure 18 - The comments added in the DTO DSL are transformed into Java-style comments in the generated code.'']]

Comments before the <code>package</code> keyword are copied over to all generated Java classes - this is the place for copyright notices.

[[File:dto-19.png|center|frame|''Figure 19 - A comment before the <code>package</code> keyword ends up in all generated Java classes (DTO and mapper classes).'']]
==Copyright Notice==

{{Copyright Notice}}

OS.bee Software Factory Installation Neon

2017-07-05T07:59:49Z

Cmollik:

== Installation of the Software Factory ==

=== Before you start ===

==== ''Java'' Version ====

To be able to use the ''OS.bee Software Factory'', you need to have the right ''Java'' version installed.

On 64-bit ''Windows'' systems, this is '''Java JDK 8 64bit''' [http://www.oracle.com/technetwork/java/javase/downloads/index-jsp-138363.html#javasejdk Java SE Downloads]. If you have ''Java'' installed, there is generally a ''Java'' icon on the control panel which will enable you to find out the current version.

==== ''Eclipse'' Version ====

To be able to use the ''OS.bee Software Factory'', you need to have the correct ''Eclipse Neon'' version installed.
You can use [https://www.eclipse.org/downloads/download.php?file=/technology/epp/downloads/release/neon/3/eclipse-dsl-neon-3-win32-x86_64.zip&mirror_id=1190 Eclipse Neon 3 DSL Developers].
Download and extract it to a folder location of your choosing. On ''Windows'', we recommend '''C:\'''. This results in the installation folder '''C:\eclipse'''. This will be the assumed ''Eclipse'' installation folder for the rest of this document.

To be able to launch ''Eclipse'' easily, create a shortcut on the computer's desktop to the program '''C:\eclipse\eclipse.exe'''. Be sure to add the parameter <code>-data /path/to/your/workspace</code> to the shortcut's invocation of ''Eclipse'' in order to start in the correct workspace in the future. Otherwise, you will be prompted to specify a workspace each time you start ''Eclipse''. 

Make the following change to the '''eclipse.ini''' file found in the '''C:\eclipse''' folder:
<blockquote>
-Xmx4096m
</blockquote>

This line allocates extra memory for ''Eclipse'' to use.

A resulting '''eclipse.ini''' file for a ''Windows'' installation might look like this: 
<existing lines above>
-Xms128m
-Xmx4096m

==== OS.bee P2 Repository ====

'''At the moment, the installation is only possible if you have access to the internal network. Use this --> [http://ccngiw2.compex.de/downloads/p2/osbee/neon/latest/ link] directly in Eclipse.'''

=== Installation of the ''OS.bee Software Factory'' ===

# Start the new ''Eclipse'' installation and select or define a workspace. It is important that each ''Eclipse'' installation is assigned to its own workspace. [[File:Workspace1.png|600px]] 
# Go to the menu bar and select '''Help''' -> '''Install New Software...'''. [[File:NeonOsbeeInstall01.png|600px]] 
# Get the link to the repository from the [http://www.osbee.org/free-download/ download page], activate the checkbox if you agree to our '''Terms of Service and Use''' and if you '''are not a consumer'''. Click on one of the then activated buttons, copy the link and paste it into the field labeled '''Work with:'''. Then press '''Enter''' to make ''Eclipse'' load the content of the repository. [[File:OSbeeInstall05.PNG|600px]] 
# Open the '''OS.bee Software Factory''' group, select the '''OS.bee Software Factory''' and click on '''Next'''. [[File:NeonOsbeeInstall02.png|600px]] 
# If during installation you encounter this, just hit '''Next'''. [[File:NeonOsbeeInstall99.png|600px]] 
# In the installation dialog, confirm the software to be installed by clicking on '''Next'''. [[File:NeonOsbeeInstall03.png|600px]] 
# Accept the terms of the license aggreement after reading them carefully, and then confirm the dialog by clicking on '''Finish'''. [[File:NeonOsbeeInstall04.png|600px]] 
# The installation will now begin. This may take a while, depending on your Internet connection speed. [[File:NeonOsbeeInstall05.png|600px]] 
# After the software has been downloaded, confirm the "Security Warning" dialog by clicking on '''OK'''. [[File:InstallUnsignedCodeWarning.png|600px]] 
# You will then be prompted to '''restart''' ''Eclipse''. Please do so. [[File:NeonOsbeeInstall06.png|600px]] 

=== Set the Target Platform for the ''OS.bee Software Factory''===

# Check if the workspace you are using is the one you selected above when first opening ''Eclipse''. If not, open the right one. 
# Set the target platform here: '''Menu''' -> '''Window''' -> '''Preferences''' -> '''Plug-in Development''' -> '''Target Platform'''. 
# Click on '''Add...''' to add a new target definition. [[File:NeonOsbeeInstall07.png|600px]] 
# Select "Default: ..." and click on '''Next'''. [[File:NeonOsbeeInstall08.png|600px]] 
# Click on '''Add...''' to add content, select "Software Site" and click on '''Next'''. [[File:NeonOsbeeInstall09.png|600px]] 
# Use the same URL previously saved to the clipboard for the Software Site. 
# Open the group '''OS.bee Softwarefactory''', select '''OS.bee Softwarefactory Targetplatform (DON'T INSTALL...)''', '''uncheck''' the '''Include required software''' checkbox and click on '''Finish'''. [[File:NeonOsbeeInstall10.png|600px]] 
# Change to register '''Content''' 
#* Enter '''x.a''' in the filter and deactivate the following bundles in the resulting target definition: <code>javax.annotation version 1.2 javax.annotation.source version 1.2</code> [[File:NeonOsbeeInstall11.png|600px]] 
#* Enter '''guava''' in the filter and deactivate the following bundle in the resulting target definition: <code>com.google.guava version 21.0</code> [[File:NeonOsbeeInstall17.png|600px]] 
#* Enter '''antlr''' in the filter and deactivate the following bundle in the resulting target definition: <code>org.antlr.runtime version 4.3</code> and click on finish. [[File:NeonOsbeeInstall18.png|600px]] 
# '''Do not forget to activate your newly created target definition! ''' [[File:NeonOsbeeInstall12.png|600px]] 
# Restart Eclipse. You can use Menu -> File -> Restart to do so. 

=== Set preferences in Eclipse ===
==== Git settings ====
Be sure to uncheck the automatic git-ignore for derived files, else generated files will not be checked in:
 [[File:Git-Preferences.png|600px]] 

==== DS Annotations ====
# It is neccessary to activate the generation of descriptors based on DS Annotations 
# Go to Window / Preferences in your Eclipse IDE 
# Activate the "Generate descriptors from annotaded sources" [[File:NeonOsbeeInstall13.png|600px]] 
# Go to Window / Preferences in your Eclipse IDE, filter for "java" and go to '''Installed JREs''' and click on '''Search...''' [[File:NeonOsbeeInstall14.png|600px]] 

==== JDK Settings ====
# Locate your JDK (On Windows it's usually under <code>C:\Program FIles\Java\...</code>) and hit '''OK''' [[File:NeonOsbeeInstall15.png|600px]] 
# Select the newly added JDK and hit '''Apply''', then '''OK''' [[File:NeonOsbeeInstall16.png|600px]] 

==== Maven Settings ====

'''For developers only!'''

Maven requires some settings in a file called <code>settings.xml</code>. The file is usually expected by Eclipse to be located in the .m2 directory in the Users home directory.

# You can start with the following content of the settings.xml (don't forget to replace the '''xxxx''' with the appropriate repo names):<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="UTF-8"?>

<settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0 http://maven.apache.org/xsd/settings-1.0.0.xsd">

<localRepository>c:/maven/.m2/repository</localRepository>

<mirrors>



<mirror>
<id>Apache Mirror</id>
<mirrorOf>apache-nexus-snapshots</mirrorOf>
<url>http://www-eu.apache.org/dist/</url>
</mirror>

</mirrors>


<profiles>

<profile>
<id>osbp-dev</id>
<activation>
<activeByDefault>true</activeByDefault>
</activation>
<properties>
<osbp.build.ignore.license>false</osbp.build.ignore.license>
<osbp.build.verbose.license>true</osbp.build.verbose.license>

<osbp.skip.javadoc>false</osbp.skip.javadoc>
<osbp.javadoc.failOnError>false</osbp.javadoc.failOnError>

<osbp.skip.test>true</osbp.skip.test>

<osbp.build.branch>latest</osbp.build.branch>
<osbp.developer.home>C:${file.separator}osbee${file.separator}downloads${file.separator}</osbp.developer.home>

<osbee.build.ignore.license>false</osbee.build.ignore.license>
<osbee.build.verbose.license>true</osbee.build.verbose.license>

<osbee.developer.home>${osbp.developer.home}</osbee.developer.home>
<osbee.build.branch>${osbp.build.branch}</osbee.build.branch>

<distribution.server.baseurl>http://my.own.nexus.local</distribution.server.baseurl>

<distribution.repository.release.url>${distribution.server.baseurl}:8086/nexus/content/repositories/developer-releases/</distribution.repository.release.url>

<distribution.repository.snapshot.url>${distribution.server.baseurl}:8086/nexus/content/repositories/developer-snapshots/</distribution.repository.snapshot.url>
<osbp.p2>http://download.osbee.org/downloads/p2/osbp/neon/xxxx</osbp.p2>
<org.osbee.p2>http://download.osbee.org/downloads/p2/osbee/neon/xxxx</org.osbee.p2>
<net.osbee.p2>http://download.osbee.org/downloads/p2/osbee/neon/xxxx</net.osbee.p2>

<osbee.helpdesk.product.download.folder>${osbp.developer.home}products${file.separator}helpdesk</osbee.helpdesk.product.download.folder>

</properties>

<pluginRepositories>
<pluginRepository>
<id>compex-nexus-release</id>
<name>Compex Nexus Release</name>
<url>http://download.osbee.org:8086/nexus/content/repositories/osbp-master-clean-releases/
</url>
<releases>
<enabled>true</enabled>
</releases>
<snapshots>
<enabled>false</enabled>
</snapshots>
</pluginRepository>
<pluginRepository>
<id>compex-snapshots</id>
<name>Compex Snapshots</name>
<url>http://download.osbee.org:8086/nexus/content/repositories/osbp-master-clean-snapshots/
</url>
<releases>
<enabled>false</enabled>
</releases>
<snapshots>
<updatePolicy>always</updatePolicy>
<enabled>true</enabled>
</snapshots>
</pluginRepository>
</pluginRepositories>

<repositories>
<repository>
<id>compex-nexus-snapshots</id>
<name>Compex Nexus Snapshots</name>
<url>http://download.osbee.org:8086/nexus/content/repositories/osbp-master-clean-snapshots/
</url>
<releases>
<enabled>false</enabled>
</releases>
<snapshots>
<updatePolicy>always</updatePolicy>
<enabled>true</enabled>
</snapshots>
</repository>
<repository>
<id>compex-nexus-release</id>
<name>Compex Nexus Release</name>
<url>http://download.osbee.org:8086/nexus/content/repositories/osbp-master-clean-releases/
</url>
<releases>
<enabled>true</enabled>
</releases>
<snapshots>
<enabled>true</enabled>
</snapshots>
</repository>

<repository>
<id>Compex Internal P2 OSbee</id>

<url>http://download.osbee.org/downloads/p2/osbee/neon/xxxxx
</url>
<layout>p2</layout>
</repository>
</repositories>
</profile>
</profiles>

</settings></syntaxhighlight>
# go to the Eclipse preferences / Maven / User Settings and enter the path to the settings.xml in the '''User settings''' section.

You can now continue with [[OS.bee Software Factory Samples]]

== General information ==
=== Copyright Notice ===
{{Copyright Notice}}

=== License information ===

{{License information}}

My first app

2017-07-05T07:52:14Z

Cmollik: /* How to generate My1App */

== General information ==

=== Abstract===

''My1App'' is an OSBP application created purely from models, based on the OS.bee Software Factory.

If you want to have a basis on which you can explore OS.bee, this is a good starting point. You can try to modify models and see the resulting changes. The models show everything from persistence up to the UI and demonstrate a lot of the stunning features and simplicity of MDSD (Model-Driven Software Development) with OS.bee.

In this introduction, you will find the system requirements for running the app, the steps needed to generate the app, how to start the app and tips for configuring the app.

=== License information ===

{{License information}}

=== Requirements ===

Please install the '''OS.bee Software Factory''' first.
Instructions for the installation can be found [http://download.osbee.org/documentation/index.php/OS.bee_Software_Factory_Installation here].

== How to generate ''My1App'' ==
 
''My1App'' is generated from within ''Eclipse''. 

# In Project Explorer, right click the mouse, then select '''New''' -> '''Other...'''. [[File:MyFirstAppNeon01.png|600px]] 
# Expand the entry '''OSBP Projects''', select '''My1App''' and then click on '''Next'''. [[File:MyFirstAppNeon02.png]] 
# The general configuration window for ''My1App'' will then be displayed. [[File:MyFirstAppNeon03.png]] 
#* Click on '''Next'''. 
# The '''JNDI Data Source''' can be set up on this page. Click '''Next''' when done. 
#* The default value is '''h2memory''', which saves all data in memory. 
#* If you want to use a different JNDI Data Source, e.g., ''MySQL'' or ''Oracle'', you can change it later. [[File:MyFirstAppNeon04.png]] 
# Setup for the mock-data generation. Click on '''Next'''. [[File:MyFirstAppNeon05.png]] 
# Choose the location where you would like to save the files of ''My1App'' 
#* You can use the default location: [[File:MyFirstAppNeon06.png]] 
#* Or you can specify your own folder by unchecking the checkbox: [[File:MyFirstAppNeon07.png]] 
#* Click on '''Next''' when done. 
# The XMS Memory is usually ¼ of total physical memory, but you can change it if you want. The desktop link which will be used later to start the application can also be found here. [[File:MyFirstAppNeon08.png]] 
#* Click on '''Finish''' to start the application generation step. [[File:MyFirstAppNeon09.png]] 
# When the window disappears, you can see in Project Explorer that all projects of ''My1App'' have been generated. [[File:MyFirstAppNeon10.png]] 
#* Please note that up until this point, the application has not yet been completely generated. Typically, the workspace is still being built (see the bottom right corner of the window). Wait until this process has completed. [[File:MyFirstAppNeon11.png]] 
# When the <code>Building Workspace</code> message disappears, the generation of ''My1App'' is complete. Project Explorer should now look like this: [[File:MyFirstAppNeon12.png]] 

== How to start ''My1App'' ==
 
* Now we are ready to start ''My1App''.
 
* If you want to change any settings before starting the application, please see: [[#How_to_configure_My1App|How to configure ''My1App'']].
 
=== Launch Eclipse Application ===
 
# Open the file '''my1app.product''' contained in the '''org.osbp.my1app.product''' project. [[File:StartMy1App01.png|600px]] 
# First, the product definition should be validated. Please click the button at the top right. [[File:StartMy1App02.png|600px]] 
# If no problems were detected, click on '''OK'''. Otherwise, fix any problems first. [[File:StartMy1App03.png]] 
# Now, click on '''Launch an Eclipse application''' to start ''My1App''. [[File:StartMy1App04.png|600px]] 
# While the application is being launched, open the '''Console''' view to monitor the progress. One of the last lines displayed should end with the phrase <code>TRIGGER DONE...</code>. [[File:StartMy1App05.png|600px]] 

=== Starting ''My1App'' in a Browser ===
 
To start ''My1App'', point your browser to this address: <code>http://localhost:8081/my1app</code> 

# Login 
## The login screen is displayed first. [[File:StartMy1App06.png|600px]] 
## Enter the user name and password, e.g., Admin, Admin, then click on '''Login''' to continue. [[File:StartMy1App07.png|600px]] 
# Welcome screen 
#* The welcome screen is now displayed. [[File:StartMy1App08.png|600px]] 
# Menu list 
#* At the top left of the window, just beside <code>Admin</code>, is the '''MENU''' button. Click it to pop open the menu. 
#* There are two main menus: '''Menu''' and '''Persons'''. [[File:StartMy1App09.png|600px]] 
## '''Menu''' 
##* There are two submenus under '''Menu''': 
##*# '''Persons''': [[File:StartMy1App10.png|600px]] 
##*# '''User administration''': [[File:StartMy1App11.png|600px]] 
# Tab list 
#* At the top right of the window, there are some tabs. By clicking on them, you can easily switch between pages. 

== How to configure ''My1App'' ==
 
Note that this part is optional, since ''My1App'' can always be started without additional configuration. If you want to change the default settings however, please continue reading. 
*All configuration is performed within ''Eclipse''.
 
=== Select '''OSBP Application Project''' ===
 
* The first step of the configuration is to change the '''Product Configuration''' from <code>workspace</code> to <code>org.osbp.my1app.product</code> in '''Preferences''' -> '''OSBP Application Configuration'''. Please note that this entry is not saved. You must repeat this step each time you wish to configure ''My1App''. Or, you can access the '''Preferences''' for <code>org.osbp.my1app.product</code> by right-clicking <code>org.osbp.my1app.product</code> and selecting '''Properties''' [[File:ConfigureMy1App01.png|600px]] 

* The '''Desktop Url Path''' is: <code>http://localhost:8081/my1app</code> [[File:ConfigureMy1App02.png|600px]] 

=== Detail Configuration ===
 
No configuration is necessary for ''My1App'' to run. However, if you wish to change anything, you can. 
Click on the '>' symbol next to '''OSBP Application Configuration''' to expand the tree. 

# Configure '''Authentication'''. [[File:ConfigureMy1App03.png|600px]] 
# Configure '''Bpm Engine'''. [[File:ConfigureMy1App04.png|600px]] 
# Configure '''Controls'''. [[File:ConfigureMy1App05.png|600px]] 
# Configure '''Data Sources'''. 
#* All data sources can be set up here. [[File:ConfigureMy1App06.png|600px]] 
#* If you want to use other data sources, please configure them first. Click <code>+</code> to expand the tree, and then enter all necessary information, e.g. '''Server Name''', '''Server Port''', '''Database Name''' etc. [[File:ConfigureMy1App07.png|600px]] 
# Configure '''Email'''. [[File:ConfigureMy1App08.png|600px]] 
# Configure '''External Data Sources'''. [[File:ConfigureMy1App09.png|600px]] 
# Configure '''Localization'''. [[File:ConfigureMy1App10.png|600px]] 
# Configure '''PersistenceUnits'''. 
#* All details about '''Persistence Units''' can be changed here. [[File:ConfigureMy1App11.png|600px]] 
#* Click <code>+</code> to expand the tree. You can then change the '''JNDI Data Source''', '''DDL Generation''' etc. [[File:ConfigureMy1App12.png|600px]] [[File:ConfigureMy1App13.png|600px]] 
# Configure '''Project Wizard'''. [[File:ConfigureMy1App14.png|600px]] 
# Configure '''Service Communication'''. [[File:ConfigureMy1App15.png|600px]] 
# Configure '''Verify Dependencies'''. 
#* If you see all green points, it means ''My1App'' is ready to start without any dependency errors. If you see any red points, you must fix the errors before starting the app. [[File:ConfigureMy1App16.png|600px]] 

== Copyright Notice ==
{{Copyright Notice}}

My first app

2017-07-05T07:50:57Z

Cmollik: /* Abstract */

== General information ==

=== Abstract===

''My1App'' is an OSBP application created purely from models, based on the OS.bee Software Factory.

If you want to have a basis on which you can explore OS.bee, this is a good starting point. You can try to modify models and see the resulting changes. The models show everything from persistence up to the UI and demonstrate a lot of the stunning features and simplicity of MDSD (Model-Driven Software Development) with OS.bee.

In this introduction, you will find the system requirements for running the app, the steps needed to generate the app, how to start the app and tips for configuring the app.

=== License information ===

{{License information}}

=== Requirements ===

Please install the '''OS.bee Software Factory''' first.
Instructions for the installation can be found [http://download.osbee.org/documentation/index.php/OS.bee_Software_Factory_Installation here].

== How to generate ''My1App'' ==
 
''My First Application'' is generated from within ''Eclipse''. 

# In Project Explorer, right click the mouse, then select '''New''' -> '''Other...'''. [[File:MyFirstAppNeon01.png|600px]] 
# Expand the entry '''OSBP Projects''', select '''My1App''' and then click on '''Next'''. [[File:MyFirstAppNeon02.png]] 
# The general configuration window for ''My1App'' will then be displayed. [[File:MyFirstAppNeon03.png]] 
#* Click on '''Next'''. 
# The '''JNDI Data Source''' can be set up on this page. Click '''Next''' when done. 
#* The default value is '''h2memory''', which saves all data in memory. 
#* If you want to use a different JNDI Data Source, e.g., ''MySQL'' or ''Oracle'', you can change it later. [[File:MyFirstAppNeon04.png]] 
# Setup for the mock-data generation. Click on '''Next'''. [[File:MyFirstAppNeon05.png]] 
# Choose the location where you would like to save the files of ''My1App'' 
#* You can use the default location: [[File:MyFirstAppNeon06.png]] 
#* Or you can specify your own folder by unchecking the checkbox: [[File:MyFirstAppNeon07.png]] 
#* Click on '''Next''' when done. 
# The XMS Memory is usually ¼ of total physical memory, but you can change it if you want. The desktop link which will be used later to start the application can also be found here. [[File:MyFirstAppNeon08.png]] 
#* Click on '''Finish''' to start the application generation step. [[File:MyFirstAppNeon09.png]] 
# When the window disappears, you can see in Project Explorer that all projects of ''My1App'' have been generated. [[File:MyFirstAppNeon10.png]] 
#* Please note that up until this point, the application has not yet been completely generated. Typically, the workspace is still being built (see the bottom right corner of the window). Wait until this process has completed. [[File:MyFirstAppNeon11.png]] 
# When the <code>Building Workspace</code> message disappears, the generation of ''My1App'' is complete. Project Explorer should now look like this: [[File:MyFirstAppNeon12.png]] 

== How to start ''My1App'' ==
 
* Now we are ready to start ''My1App''.
 
* If you want to change any settings before starting the application, please see: [[#How_to_configure_My1App|How to configure ''My1App'']].
 
=== Launch Eclipse Application ===
 
# Open the file '''my1app.product''' contained in the '''org.osbp.my1app.product''' project. [[File:StartMy1App01.png|600px]] 
# First, the product definition should be validated. Please click the button at the top right. [[File:StartMy1App02.png|600px]] 
# If no problems were detected, click on '''OK'''. Otherwise, fix any problems first. [[File:StartMy1App03.png]] 
# Now, click on '''Launch an Eclipse application''' to start ''My1App''. [[File:StartMy1App04.png|600px]] 
# While the application is being launched, open the '''Console''' view to monitor the progress. One of the last lines displayed should end with the phrase <code>TRIGGER DONE...</code>. [[File:StartMy1App05.png|600px]] 

=== Starting ''My1App'' in a Browser ===
 
To start ''My1App'', point your browser to this address: <code>http://localhost:8081/my1app</code> 

# Login 
## The login screen is displayed first. [[File:StartMy1App06.png|600px]] 
## Enter the user name and password, e.g., Admin, Admin, then click on '''Login''' to continue. [[File:StartMy1App07.png|600px]] 
# Welcome screen 
#* The welcome screen is now displayed. [[File:StartMy1App08.png|600px]] 
# Menu list 
#* At the top left of the window, just beside <code>Admin</code>, is the '''MENU''' button. Click it to pop open the menu. 
#* There are two main menus: '''Menu''' and '''Persons'''. [[File:StartMy1App09.png|600px]] 
## '''Menu''' 
##* There are two submenus under '''Menu''': 
##*# '''Persons''': [[File:StartMy1App10.png|600px]] 
##*# '''User administration''': [[File:StartMy1App11.png|600px]] 
# Tab list 
#* At the top right of the window, there are some tabs. By clicking on them, you can easily switch between pages. 

== How to configure ''My1App'' ==
 
Note that this part is optional, since ''My1App'' can always be started without additional configuration. If you want to change the default settings however, please continue reading. 
*All configuration is performed within ''Eclipse''.
 
=== Select '''OSBP Application Project''' ===
 
* The first step of the configuration is to change the '''Product Configuration''' from <code>workspace</code> to <code>org.osbp.my1app.product</code> in '''Preferences''' -> '''OSBP Application Configuration'''. Please note that this entry is not saved. You must repeat this step each time you wish to configure ''My1App''. Or, you can access the '''Preferences''' for <code>org.osbp.my1app.product</code> by right-clicking <code>org.osbp.my1app.product</code> and selecting '''Properties''' [[File:ConfigureMy1App01.png|600px]] 

* The '''Desktop Url Path''' is: <code>http://localhost:8081/my1app</code> [[File:ConfigureMy1App02.png|600px]] 

=== Detail Configuration ===
 
No configuration is necessary for ''My1App'' to run. However, if you wish to change anything, you can. 
Click on the '>' symbol next to '''OSBP Application Configuration''' to expand the tree. 

# Configure '''Authentication'''. [[File:ConfigureMy1App03.png|600px]] 
# Configure '''Bpm Engine'''. [[File:ConfigureMy1App04.png|600px]] 
# Configure '''Controls'''. [[File:ConfigureMy1App05.png|600px]] 
# Configure '''Data Sources'''. 
#* All data sources can be set up here. [[File:ConfigureMy1App06.png|600px]] 
#* If you want to use other data sources, please configure them first. Click <code>+</code> to expand the tree, and then enter all necessary information, e.g. '''Server Name''', '''Server Port''', '''Database Name''' etc. [[File:ConfigureMy1App07.png|600px]] 
# Configure '''Email'''. [[File:ConfigureMy1App08.png|600px]] 
# Configure '''External Data Sources'''. [[File:ConfigureMy1App09.png|600px]] 
# Configure '''Localization'''. [[File:ConfigureMy1App10.png|600px]] 
# Configure '''PersistenceUnits'''. 
#* All details about '''Persistence Units''' can be changed here. [[File:ConfigureMy1App11.png|600px]] 
#* Click <code>+</code> to expand the tree. You can then change the '''JNDI Data Source''', '''DDL Generation''' etc. [[File:ConfigureMy1App12.png|600px]] [[File:ConfigureMy1App13.png|600px]] 
# Configure '''Project Wizard'''. [[File:ConfigureMy1App14.png|600px]] 
# Configure '''Service Communication'''. [[File:ConfigureMy1App15.png|600px]] 
# Configure '''Verify Dependencies'''. 
#* If you see all green points, it means ''My1App'' is ready to start without any dependency errors. If you see any red points, you must fix the errors before starting the app. [[File:ConfigureMy1App16.png|600px]] 

== Copyright Notice ==
{{Copyright Notice}}

OS.bee Software Factory Installation Neon

2017-07-05T07:46:18Z

Cmollik: /* Installation of the Software Factory */

== General information ==
=== Copyright Notice ===
{{Copyright Notice}}

=== License information ===

{{License information}}

== Installation of the Software Factory ==

=== Before you start ===

==== ''Java'' Version ====

To be able to use the ''OS.bee Software Factory'', you need to have the right ''Java'' version installed.

On 64-bit ''Windows'' systems, this is '''Java JDK 8 64bit''' [http://www.oracle.com/technetwork/java/javase/downloads/index-jsp-138363.html#javasejdk Java SE Downloads]. If you have ''Java'' installed, there is generally a ''Java'' icon on the control panel which will enable you to find out the current version.

==== ''Eclipse'' Version ====

To be able to use the ''OS.bee Software Factory'', you need to have the correct ''Eclipse Neon'' version installed.
You can use [https://www.eclipse.org/downloads/download.php?file=/technology/epp/downloads/release/neon/3/eclipse-dsl-neon-3-win32-x86_64.zip&mirror_id=1190 Eclipse Neon 3 DSL Developers].
Download and extract it to a folder location of your choosing. On ''Windows'', we recommend '''C:\'''. This results in the installation folder '''C:\eclipse'''. This will be the assumed ''Eclipse'' installation folder for the rest of this document.

To be able to launch ''Eclipse'' easily, create a shortcut on the computer's desktop to the program '''C:\eclipse\eclipse.exe'''. Be sure to add the parameter <code>-data /path/to/your/workspace</code> to the shortcut's invocation of ''Eclipse'' in order to start in the correct workspace in the future. Otherwise, you will be prompted to specify a workspace each time you start ''Eclipse''. 

Make the following change to the '''eclipse.ini''' file found in the '''C:\eclipse''' folder:
<blockquote>
-Xmx4096m
</blockquote>

This line allocates extra memory for ''Eclipse'' to use.

A resulting '''eclipse.ini''' file for a ''Windows'' installation might look like this: 
<existing lines above>
-Xms128m
-Xmx4096m

==== OS.bee P2 Repository ====

'''At the moment, the installation is only possible if you have access to the internal network. Use this --> [http://ccngiw2.compex.de/downloads/p2/osbee/neon/latest/ link] directly in Eclipse.'''

=== Installation of the ''OS.bee Software Factory'' ===

# Start the new ''Eclipse'' installation and select or define a workspace. It is important that each ''Eclipse'' installation is assigned to its own workspace. [[File:Workspace1.png|600px]] 
# Go to the menu bar and select '''Help''' -> '''Install New Software...'''. [[File:NeonOsbeeInstall01.png|600px]] 
# Get the link to the repository from the [http://www.osbee.org/free-download/ download page], activate the checkbox if you agree to our '''Terms of Service and Use''' and if you '''are not a consumer'''. Click on one of the then activated buttons, copy the link and paste it into the field labeled '''Work with:'''. Then press '''Enter''' to make ''Eclipse'' load the content of the repository. [[File:OSbeeInstall05.PNG|600px]] 
# Open the '''OS.bee Software Factory''' group, select the '''OS.bee Software Factory''' and click on '''Next'''. [[File:NeonOsbeeInstall02.png|600px]] 
# If during installation you encounter this, just hit '''Next'''. [[File:NeonOsbeeInstall99.png|600px]] 
# In the installation dialog, confirm the software to be installed by clicking on '''Next'''. [[File:NeonOsbeeInstall03.png|600px]] 
# Accept the terms of the license aggreement after reading them carefully, and then confirm the dialog by clicking on '''Finish'''. [[File:NeonOsbeeInstall04.png|600px]] 
# The installation will now begin. This may take a while, depending on your Internet connection speed. [[File:NeonOsbeeInstall05.png|600px]] 
# After the software has been downloaded, confirm the "Security Warning" dialog by clicking on '''OK'''. [[File:InstallUnsignedCodeWarning.png|600px]] 
# You will then be prompted to '''restart''' ''Eclipse''. Please do so. [[File:NeonOsbeeInstall06.png|600px]] 

=== Set the Target Platform for the ''OS.bee Software Factory''===

# Check if the workspace you are using is the one you selected above when first opening ''Eclipse''. If not, open the right one. 
# Set the target platform here: '''Menu''' -> '''Window''' -> '''Preferences''' -> '''Plug-in Development''' -> '''Target Platform'''. 
# Click on '''Add...''' to add a new target definition. [[File:NeonOsbeeInstall07.png|600px]] 
# Select "Default: ..." and click on '''Next'''. [[File:NeonOsbeeInstall08.png|600px]] 
# Click on '''Add...''' to add content, select "Software Site" and click on '''Next'''. [[File:NeonOsbeeInstall09.png|600px]] 
# Use the same URL previously saved to the clipboard for the Software Site. 
# Open the group '''OS.bee Softwarefactory''', select '''OS.bee Softwarefactory Targetplatform (DON'T INSTALL...)''', '''uncheck''' the '''Include required software''' checkbox and click on '''Finish'''. [[File:NeonOsbeeInstall10.png|600px]] 
# Change to register '''Content''' 
#* Enter '''x.a''' in the filter and deactivate the following bundles in the resulting target definition: <code>javax.annotation version 1.2 javax.annotation.source version 1.2</code> [[File:NeonOsbeeInstall11.png|600px]] 
#* Enter '''guava''' in the filter and deactivate the following bundle in the resulting target definition: <code>com.google.guava version 21.0</code> [[File:NeonOsbeeInstall17.png|600px]] 
#* Enter '''antlr''' in the filter and deactivate the following bundle in the resulting target definition: <code>org.antlr.runtime version 4.3</code> and click on finish. [[File:NeonOsbeeInstall18.png|600px]] 
# '''Do not forget to activate your newly created target definition! ''' [[File:NeonOsbeeInstall12.png|600px]] 
# Restart Eclipse. You can use Menu -> File -> Restart to do so. 

=== Set preferences in Eclipse ===
==== Git settings ====
Be sure to uncheck the automatic git-ignore for derived files, else generated files will not be checked in:
 [[File:Git-Preferences.png|600px]] 

==== DS Annotations ====
# It is neccessary to activate the generation of descriptors based on DS Annotations 
# Go to Window / Preferences in your Eclipse IDE 
# Activate the "Generate descriptors from annotaded sources" [[File:NeonOsbeeInstall13.png|600px]] 
# Go to Window / Preferences in your Eclipse IDE, filter for "java" and go to '''Installed JREs''' and click on '''Search...''' [[File:NeonOsbeeInstall14.png|600px]] 

==== JDK Settings ====
# Locate your JDK (On Windows it's usually under <code>C:\Program FIles\Java\...</code>) and hit '''OK''' [[File:NeonOsbeeInstall15.png|600px]] 
# Select the newly added JDK and hit '''Apply''', then '''OK''' [[File:NeonOsbeeInstall16.png|600px]] 

==== Maven Settings ====

'''For developers only!'''

Maven requires some settings in a file called <code>settings.xml</code>. The file is usually expected by Eclipse to be located in the .m2 directory in the Users home directory.

# You can start with the following content of the settings.xml (don't forget to replace the '''xxxx''' with the appropriate repo names):<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="UTF-8"?>

<settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0 http://maven.apache.org/xsd/settings-1.0.0.xsd">

<localRepository>c:/maven/.m2/repository</localRepository>

<mirrors>



<mirror>
<id>Apache Mirror</id>
<mirrorOf>apache-nexus-snapshots</mirrorOf>
<url>http://www-eu.apache.org/dist/</url>
</mirror>

</mirrors>


<profiles>

<profile>
<id>osbp-dev</id>
<activation>
<activeByDefault>true</activeByDefault>
</activation>
<properties>
<osbp.build.ignore.license>false</osbp.build.ignore.license>
<osbp.build.verbose.license>true</osbp.build.verbose.license>

<osbp.skip.javadoc>false</osbp.skip.javadoc>
<osbp.javadoc.failOnError>false</osbp.javadoc.failOnError>

<osbp.skip.test>true</osbp.skip.test>

<osbp.build.branch>latest</osbp.build.branch>
<osbp.developer.home>C:${file.separator}osbee${file.separator}downloads${file.separator}</osbp.developer.home>

<osbee.build.ignore.license>false</osbee.build.ignore.license>
<osbee.build.verbose.license>true</osbee.build.verbose.license>

<osbee.developer.home>${osbp.developer.home}</osbee.developer.home>
<osbee.build.branch>${osbp.build.branch}</osbee.build.branch>

<distribution.server.baseurl>http://my.own.nexus.local</distribution.server.baseurl>

<distribution.repository.release.url>${distribution.server.baseurl}:8086/nexus/content/repositories/developer-releases/</distribution.repository.release.url>

<distribution.repository.snapshot.url>${distribution.server.baseurl}:8086/nexus/content/repositories/developer-snapshots/</distribution.repository.snapshot.url>
<osbp.p2>http://download.osbee.org/downloads/p2/osbp/neon/xxxx</osbp.p2>
<org.osbee.p2>http://download.osbee.org/downloads/p2/osbee/neon/xxxx</org.osbee.p2>
<net.osbee.p2>http://download.osbee.org/downloads/p2/osbee/neon/xxxx</net.osbee.p2>

<osbee.helpdesk.product.download.folder>${osbp.developer.home}products${file.separator}helpdesk</osbee.helpdesk.product.download.folder>

</properties>

<pluginRepositories>
<pluginRepository>
<id>compex-nexus-release</id>
<name>Compex Nexus Release</name>
<url>http://download.osbee.org:8086/nexus/content/repositories/osbp-master-clean-releases/
</url>
<releases>
<enabled>true</enabled>
</releases>
<snapshots>
<enabled>false</enabled>
</snapshots>
</pluginRepository>
<pluginRepository>
<id>compex-snapshots</id>
<name>Compex Snapshots</name>
<url>http://download.osbee.org:8086/nexus/content/repositories/osbp-master-clean-snapshots/
</url>
<releases>
<enabled>false</enabled>
</releases>
<snapshots>
<updatePolicy>always</updatePolicy>
<enabled>true</enabled>
</snapshots>
</pluginRepository>
</pluginRepositories>

<repositories>
<repository>
<id>compex-nexus-snapshots</id>
<name>Compex Nexus Snapshots</name>
<url>http://download.osbee.org:8086/nexus/content/repositories/osbp-master-clean-snapshots/
</url>
<releases>
<enabled>false</enabled>
</releases>
<snapshots>
<updatePolicy>always</updatePolicy>
<enabled>true</enabled>
</snapshots>
</repository>
<repository>
<id>compex-nexus-release</id>
<name>Compex Nexus Release</name>
<url>http://download.osbee.org:8086/nexus/content/repositories/osbp-master-clean-releases/
</url>
<releases>
<enabled>true</enabled>
</releases>
<snapshots>
<enabled>true</enabled>
</snapshots>
</repository>

<repository>
<id>Compex Internal P2 OSbee</id>

<url>http://download.osbee.org/downloads/p2/osbee/neon/xxxxx
</url>
<layout>p2</layout>
</repository>
</repositories>
</profile>
</profiles>

</settings></syntaxhighlight>
# go to the Eclipse preferences / Maven / User Settings and enter the path to the settings.xml in the '''User settings''' section.

You can now continue with [[OS.bee Software Factory Samples]]

File:StartMy1App09.png

2017-07-03T15:30:30Z

Cmollik: Cmollik uploaded a new version of File:StartMy1App09.png

My first app

2017-07-03T15:29:27Z

Cmollik: /* Starting My1App in a Browser */

== General information ==

=== Abstract===

''My First Application'' is an OSBP application created purely from models, based on the OS.bee Software Factory.

If you want to have a basis on which you can explore OS.bee, this is a good starting point. You can try to modify models and see the resulting changes. The models show everything from persistence up to the UI and demonstrate a lot of the stunning features and simplicity of MDSD (Model-Driven Software Development) with OS.bee.

In this introduction, you will find the system requirements for running the app, the steps needed to generate the app, how to start the app and tips for configuring the app.

=== License information ===

{{License information}}

=== Requirements ===

Please install the '''OS.bee Software Factory''' first.
Instructions for the installation can be found [http://download.osbee.org/documentation/index.php/OS.bee_Software_Factory_Installation here].

== How to generate ''My1App'' ==
 
''My First Application'' is generated from within ''Eclipse''. 

# In Project Explorer, right click the mouse, then select '''New''' -> '''Other...'''. [[File:MyFirstAppNeon01.png|600px]] 
# Expand the entry '''OSBP Projects''', select '''My1App''' and then click on '''Next'''. [[File:MyFirstAppNeon02.png]] 
# The general configuration window for ''My1App'' will then be displayed. [[File:MyFirstAppNeon03.png]] 
#* Click on '''Next'''. 
# The '''JNDI Data Source''' can be set up on this page. Click '''Next''' when done. 
#* The default value is '''h2memory''', which saves all data in memory. 
#* If you want to use a different JNDI Data Source, e.g., ''MySQL'' or ''Oracle'', you can change it later. [[File:MyFirstAppNeon04.png]] 
# Setup for the mock-data generation. Click on '''Next'''. [[File:MyFirstAppNeon05.png]] 
# Choose the location where you would like to save the files of ''My1App'' 
#* You can use the default location: [[File:MyFirstAppNeon06.png]] 
#* Or you can specify your own folder by unchecking the checkbox: [[File:MyFirstAppNeon07.png]] 
#* Click on '''Next''' when done. 
# The XMS Memory is usually ¼ of total physical memory, but you can change it if you want. The desktop link which will be used later to start the application can also be found here. [[File:MyFirstAppNeon08.png]] 
#* Click on '''Finish''' to start the application generation step. [[File:MyFirstAppNeon09.png]] 
# When the window disappears, you can see in Project Explorer that all projects of ''My1App'' have been generated. [[File:MyFirstAppNeon10.png]] 
#* Please note that up until this point, the application has not yet been completely generated. Typically, the workspace is still being built (see the bottom right corner of the window). Wait until this process has completed. [[File:MyFirstAppNeon11.png]] 
# When the <code>Building Workspace</code> message disappears, the generation of ''My1App'' is complete. Project Explorer should now look like this: [[File:MyFirstAppNeon12.png]] 

== How to start ''My1App'' ==
 
* Now we are ready to start ''My1App''.
 
* If you want to change any settings before starting the application, please see: [[#How_to_configure_My1App|How to configure ''My1App'']].
 
=== Launch Eclipse Application ===
 
# Open the file '''my1app.product''' contained in the '''org.osbp.my1app.product''' project. [[File:StartMy1App01.png|600px]] 
# First, the product definition should be validated. Please click the button at the top right. [[File:StartMy1App02.png|600px]] 
# If no problems were detected, click on '''OK'''. Otherwise, fix any problems first. [[File:StartMy1App03.png]] 
# Now, click on '''Launch an Eclipse application''' to start ''My1App''. [[File:StartMy1App04.png|600px]] 
# While the application is being launched, open the '''Console''' view to monitor the progress. One of the last lines displayed should end with the phrase <code>TRIGGER DONE...</code>. [[File:StartMy1App05.png|600px]] 

=== Starting ''My1App'' in a Browser ===
 
To start ''My1App'', point your browser to this address: <code>http://localhost:8081/my1app</code> 

# Login 
## The login screen is displayed first. [[File:StartMy1App06.png|600px]] 
## Enter the user name and password, e.g., Admin, Admin, then click on '''Login''' to continue. [[File:StartMy1App07.png|600px]] 
# Welcome screen 
#* The welcome screen is now displayed. [[File:StartMy1App08.png|600px]] 
# Menu list 
#* At the top left of the window, just beside <code>Admin</code>, is the '''MENU''' button. Click it to pop open the menu. 
#* There are two main menus: '''Menu''' and '''Persons'''. [[File:StartMy1App09.png|600px]] 
## '''Menu''' 
##* There are two submenus under '''Menu''': 
##*# '''Persons''': [[File:StartMy1App10.png|600px]] 
##*# '''User administration''': [[File:StartMy1App11.png|600px]] 
# Tab list 
#* At the top right of the window, there are some tabs. By clicking on them, you can easily switch between pages. 

== How to configure ''My1App'' ==
 
Note that this part is optional, since ''My1App'' can always be started without additional configuration. If you want to change the default settings however, please continue reading. 
*All configuration is performed within ''Eclipse''.
 
=== Select '''OSBP Application Project''' ===
 
* The first step of the configuration is to change the '''Product Configuration''' from <code>workspace</code> to <code>org.osbp.my1app.product</code> in '''Preferences''' -> '''OSBP Application Configuration'''. Please note that this entry is not saved. You must repeat this step each time you wish to configure ''My1App''. Or, you can access the '''Preferences''' for <code>org.osbp.my1app.product</code> by right-clicking <code>org.osbp.my1app.product</code> and selecting '''Properties''' [[File:ConfigureMy1App01.png|600px]] 

* The '''Desktop Url Path''' is: <code>http://localhost:8081/my1app</code> [[File:ConfigureMy1App02.png|600px]] 

=== Detail Configuration ===
 
No configuration is necessary for ''My1App'' to run. However, if you wish to change anything, you can. 
Click on the '>' symbol next to '''OSBP Application Configuration''' to expand the tree. 

# Configure '''Authentication'''. [[File:ConfigureMy1App03.png|600px]] 
# Configure '''Bpm Engine'''. [[File:ConfigureMy1App04.png|600px]] 
# Configure '''Controls'''. [[File:ConfigureMy1App05.png|600px]] 
# Configure '''Data Sources'''. 
#* All data sources can be set up here. [[File:ConfigureMy1App06.png|600px]] 
#* If you want to use other data sources, please configure them first. Click <code>+</code> to expand the tree, and then enter all necessary information, e.g. '''Server Name''', '''Server Port''', '''Database Name''' etc. [[File:ConfigureMy1App07.png|600px]] 
# Configure '''Email'''. [[File:ConfigureMy1App08.png|600px]] 
# Configure '''External Data Sources'''. [[File:ConfigureMy1App09.png|600px]] 
# Configure '''Localization'''. [[File:ConfigureMy1App10.png|600px]] 
# Configure '''PersistenceUnits'''. 
#* All details about '''Persistence Units''' can be changed here. [[File:ConfigureMy1App11.png|600px]] 
#* Click <code>+</code> to expand the tree. You can then change the '''JNDI Data Source''', '''DDL Generation''' etc. [[File:ConfigureMy1App12.png|600px]] [[File:ConfigureMy1App13.png|600px]] 
# Configure '''Project Wizard'''. [[File:ConfigureMy1App14.png|600px]] 
# Configure '''Service Communication'''. [[File:ConfigureMy1App15.png|600px]] 
# Configure '''Verify Dependencies'''. 
#* If you see all green points, it means ''My1App'' is ready to start without any dependency errors. If you see any red points, you must fix the errors before starting the app. [[File:ConfigureMy1App16.png|600px]] 

== Copyright Notice ==
{{Copyright Notice}}