OS.bee documentation - User contributions [en]

Datainterchange DSL

2019-05-08T07:30:46Z

Riegel:

==Purpose==

The Data Interchange DSL (datainterchange for short) is made for defining data exchange models that can be used to import data from various formats (CSV, XML, EDI, etc.), map the data to entities, store them into database, or export them back into other formats.

You only need to define the ''relationship'' between the file and the bean, not the import / export process themselves. Once defined, these models can be used in e.g. action DSL to define actions which, when triggered, execute the actual import / export process, which are generated automatically by the OSBP based on the model.

==Overview==

As shown on the figure below, the [DSL Inferrer] will generate various views and In/Export component according to model described by datainterchange DSL (and action DSL, in the case of ActionButtons). The action buttons, when clicked, will trigger their corresponding In/Export processes by putting [http://download.osbee.org/downloads/javadoc/osbee-master-clean/org.eclipse.osbp.xtext.datainterchange.feature/apidocs/ WorkerThread (Runnable)] jobs into the executor job pool within the TriggerView (prefixed with datainterchang name), buttons (and toolbar / menus containing them) are further included in the perspective.

[[File:Datainterchange.png|600px|center|frame|''Figure 1: - Data Interchange Structure.'']]

==Data Interchange Model File==

Datainterchange DSL model files end with the <code>.data</code> extension. Data Interchange models may be split into several <code>.data</code> files, as long as they have the same package declaration.

In the following we will dive deeper into the description and the usage of Datainterchange related and reserved keywords.

===import===
In the import section are all entities to be found - as full qualified names – that are currently used in the DSL.

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

import ns net.osbee.sample.foodmart.entities.Mstore
import ns net.osbee.sample.foodmart.entities.Mwarehouse
import ns net.osbee.sample.foodmart.entities.Mregion

</syntaxhighlight>

Note that <code>ns</code> is a mandatory keyword (stands for "namespace") that comes after import for distinguishing the OS.bee internal namespaces and Java library namespaces. Wildcards are not supported, all names should be imported separately. Note that the import section will be imported/added automatically if they are used in the package, so you don't have to manually manage this section.

===package===

Datainterchange DSL model files must start with a package declaration. Packages are the root element of the DSL and should be defined as <code><ApplicationName>.datainterchange</code>.

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

Data Interchange models may be split into several .data files, as long as they have the same package declaration, the interchanges will be available under this package name.

===title===
With the keyword title you can give a name to the corresponding TriggerView dialog inside your application. For example, the definition of the same datainterchanges package from above with title "Data Interchange Example":

► '''Example''':
<syntaxhighlight lang="java">package net.osbee.sample.foodmart.datainterchanges title "Data Interchange Example" {}</syntaxhighlight>

This title will be translated based on locale.

You can get more details about the TriggerView in the section below.

===interchange===
The <code>interchange</code> keyword defines interchange units for entities in the package, it should be in the form of:

► '''Example''':
<syntaxhighlight lang="java">
interchange <InterchangeUnitName> [describedBy <description>] <EntityManagerMode> file <FileType> [<FileDetails>] beans {
...
}
</syntaxhighlight>

Where <code>InterchangeUnitName</code> being the name of the interchange unit; <code>describedBy</code> (optional) can be used to provide a short description string. <code>EntityManagerMode</code> being how the file should be handled (see section "persist, merge, remove" below), and after <code>file</code> keyword, you should specify the type of the source / target data file you would like to import from or export to, then the file path, and other details depends on the type.

The following example specifies an interchange that reads a CSV file under the specified path (note the forward slash as the path separator), delimited by semicolon, skip one line (the header), and treat the content as encoded in UTF-8:

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

interchange CurrencyNames persist file
CSV "C:/data/ISOCurrencyCode20170101.csv" delimiter ";" skipLines 1 encoding "UTF-8"
beans {
...
}
</syntaxhighlight>

The <code>beans</code> keyword comes after all the file specification and starts a block of entity definitions, which will be covered in section "entity".

===describedBy===
With this keyword you can the optional description of an interchange unit as shown below.

► '''Example''':
<syntaxhighlight lang="java">
interchange Currencies describedBy "european central bank currency exchange rates based on euro" persist ... { ... }
</syntaxhighlight>

===vectorName===
With the optional keyword <code>vectorName</code> followed by a string value you are able to define the name of the root element of both XML configuration files needed by Smooks. Please note that it also means that the first (root-)element of an XML-File you would have exported (file filled with real data) via the application will have the same name.

► '''Example''':
<syntaxhighlight lang="java">
interchange Stores remove vectorName "stores" elementSize 83 file ... { ... }
</syntaxhighlight>

You can view the result of this sample of code like shown below on figure[[#Figure3|''3'']].

===persist, merge, remove===
These keywords define the purpose of the datainterchange unit and has a similar meaning as in the JPA's EntityManager class. Basically, <code>persist</code> will insert the data records into database, <code>merge</code> will update existing data record, or insert new one if necessary, <code>remove</code> will remove the record if it could be found in database.

► '''Example 1''': (persist)
<syntaxhighlight lang="java">
interchange EDIOrders describedBy "Orders" persist file
XML "C:/data/orders.xml"
beans {
...
}
</syntaxhighlight>

► '''Example 2''': (merge)
<syntaxhighlight lang="java">
interchange Stores merge file
XML "C:/data/stores.xml"
beans {
...
}
</syntaxhighlight>

► '''Example 3''': (remove)
<syntaxhighlight lang="java">
interchange Storesremove remove file
XML "C:/data/stores_remove.xml"
beans {
...
}
</syntaxhighlight>

===file===
With the keyword file you are able to set the file format of the files you intent to process with you interchange unit.

► '''Syntax''':
<syntaxhighlight lang="java">interchange <SampleInterchangeUnitName> <EntityManagerMode> file <FileNameFormat> {}</syntaxhighlight>

The current supported file formats are CSV, EDI and XML followed by the name of the file you want to process, given its full path location in the system.
► '''Example 1''':<syntaxhighlight lang="java">interchange SampleInterchangeUnit1 merge file CSV "C:/temp/testFile.csv" {}</syntaxhighlight>
► '''Example 2''':<syntaxhighlight lang="java">interchange SampleInterchangeUnit2 persist file XML "C:/temp/testFile.xml" {}</syntaxhighlight>
► '''Example 3''':<syntaxhighlight lang="java">interchange SampleInterchangeUnit3 merge file EDI "C:/temp/testFile.edi" {}</syntaxhighlight>

After choosing the file format you can either give the file name as a String value in a double quote "..." as shown here above, or press Ctrl+Space to get via the content assist the option of opening a File Chooser/Picker to specify the file you want to work with.

[[File:FileChooser.jpg|center|frame|''Figure 2: File Chooser'']]

Please note that you can also change the path(?) of the file to process on runtime by selecting a new file.

===mapByAttribute===

The <code>mapByAttribute</code> keyword is an XML-specific keyword that turns on the automatic attribute mapping. When enabled, datainterchange will detect if the value being mapped is from an attribute. For example, the 'USD' value in the following XML file comes from the attribute 'currency' of the element 'Cube':

► '''Example''':
<syntaxhighlight lang="xml">
<Cube currency='USD' rate='1.3759'/>
</syntaxhighlight>

while in the following XML file, the same value is encapsulated in the element 'currency':

► '''Example''':
<syntaxhighlight lang="xml">

<Cube>
<currency>USD</currency>
<rate>1.3759</rate>
</Cube>
</syntaxhighlight>

When <code>mapByAttribute</code> is present, datainterchange will automatically decide that a query in the form like <code>'/Cube/currency'</code> will also catch the value from attribute. Without it, the query will have to put a <code>'@'</code> symbol in front of the attribute name, i.e. <code>'/Cube/@currency'</code>.

===elementSize===
With the keyword <code>elementSize</code> followed by an integer, the user can set the estimated average size of the elements in bytes. Since the underlying API cannot know the size of an element before it is processed, this value can be supplied as a guide value to be used for estimating the import / output progress based on how much bytes have been processed.

► '''Example''':
<syntaxhighlight lang="java">
interchange EDIOrders describedBy "edi orders" persist elementSize 50 file EDI "C:/data/orders.edi" beans {
...
}
</syntaxhighlight>

Defines an average estimated element size of 50 bytes.

===delimiter===

The <code>delimiter</code> is a CSV format-specific keyword, which defines the character to use in the CSV file to set the delimiter/separation character between different values. Default value is "," (comma).

► '''Example''':
<syntaxhighlight lang="java">
interchange CurrencyNames persist file
CSV "C:/data/ISOCurrencyCodes081507.csv" delimiter ";" ... {
...
}
</syntaxhighlight>

will set the delimiter of the CSV file to ";".

===skipLines===
This is a CSV format-specific keyword. Using <code>skipLines</code> followed by an integer, the user can specify the number of lines to be skipped from the beginning in the processing of the selected file, this can be used to skip headers.

► '''Example''':
<syntaxhighlight lang="java">
interchange CurrencyNames persist file CSV "C:/data/ISOCurrencyCodes081507.csv" ... skipLines 1 encoding "UTF-8" {
...
}
</syntaxhighlight>

will skip the first line of the CSV file.

===report===

If a '''datainterchange''' unit is defined with the <code>report</code> keyword, a report will be generated for data conversions. The report file is generated by Smooks, lies under <code>/smooks</code> output directory of the datainterchange bundle, and has a name in the form like <code><DataInterChangeName>-input.xml</code> for input processes, and <code><DataInterChangeName>-output.xml</code> for output processes. '''Note: turn on report will have an impact performance.'''

===indent===

The <code>indent</code> is a CSV-format specified keyword which adds indentation character data to the generated event stream. This simply makes the generated event stream easier to read in its serialized form and generally should only be used in testing.

===quoteCharacter===

The <code>quoteCharacter</code> is a CSV format-specific keyword, which defines the character to use in the CSV file to identify values.

===encoding===
With the keyword '''enconding''' followed by the encoding name as a string value you are able to specify the valid encoding of the file content.

► '''Example 1''':<syntaxhighlight lang="java">interchange SampleInterchangeUnitName merge elementSize 50 file CSV "C:/temp/testFile.csv" delimiter ";" skipLines 1 encoding "UTF-8"{}</syntaxhighlight>
► '''Example 2''':<syntaxhighlight lang="java">interchange SampleInterchangeUnitName remove elementSize 50 file CSV "C:/temp/testFile.csv" delimiter ";" skipLines 1 encoding "GB18030"{}</syntaxhighlight>
► '''Example 3''':<syntaxhighlight lang="java">interchange SampleInterchangeUnitName persistelementSize 50 file CSV "C:/temp/testFile.csv" delimiter ";" skipLines 1 encoding "ISO-2022-JP"{}</syntaxhighlight>

===mappingModel===

The <code>mappingModel</code> keyword is an EDI-specific keyword which can be used to specify an EDI to XML mapping model in XML format for Smooks.

===validate===

The <code>validate</code> keyword is an EDI-specific keyword that...

===beans===

The keyword <code>beans</code> starts the series of entities. The name "bean" comes from the internal entities called JavaBean, which act as data containers.

===entity===

With the <code>entity</code> keyword followed by a fully qualified name, the user can specify the mapping between a source data file and a data-containing entity. The behavior of the mapping can be further fine-tuned with the keywords discussed below. While these keywords can theoretically be combined all together and create very complicated behavior, they are normally used in a simple and straight forward way.

The general form of <code>entity</code> keywords is:

► '''Syntax''':
<syntaxhighlight>
entity <ID>
[nodeName <node-name>]
[createOn <element-map>]
[marker <property-name>]
[expression '{' <expressions> '}']
[lookup '{' <lookup-rules> '}']
[format '{' <formats> '}']
[mapping '{' <mappings> '}']
[keys '{' <lookup-keys> '}']
;
</syntaxhighlight>

The order of the keywords is fixed, i.e. they are all optional, but must appear in the given order.

====nodeName====

With the optional keyword <code>nodeName</code> followed by a string you can specify the name (alias) of corresponding elements inside an (XML) input/output configuration file. This name is used to identify entities within an XML file using the [http://freemarker.org/docs/pgui_datamodel.html NodeModel of Freemarker] instead of using the standard Java Object Model name. For example:

► '''Example''':
<syntaxhighlight lang="java">
interchange Stores remove vectorName "stores" elementSize 83 file XML "C:/.../net.osbee.sample.foodmart/net.osbee.sample.foodmart.datainterchange/smooks-resources/stores.xml" beans {
entity Mregion nodeName "region"
entity Mstore nodeName "store"
entity Mwarehouse nodeName "warehouse"
}
</syntaxhighlight>

The result from this example code is the generation of Smooks configuration files, in which the structure of the output data file (order of elements) will be the same as declared inside the beans {...} expression block. The alias you have specified after the keyword will be used as element (entity) name inside the XML files.

<div id="Figure3"> [[File:FreeMarkerNodeModelStoreInEx.png|600px|thumb|center|''Figure 3: Store-import.xml and Store-export.xml with NodeModel'']] </div>

The use of this keyword gives you the flexibility of naming entities using aliases in order to match any third part system description. By omitting the definition of both aliases ''region'' and ''warehouse'' like shown below, we obtain slightly divergent but very different contents than the ones from above.

► '''Example''':
<syntaxhighlight lang="java">
interchange Stores remove vectorName "stores" elementSize 83 file XML "C:/.../net.osbee.sample.foodmart/net.osbee.sample.foodmart.datainterchange/smooks-resources/stores.xml" beans {
entity Mregion
entity Mstore nodeName "store"
entity Mwarehouse
}
</syntaxhighlight>

[[File:FreeMarkerJavaObjectModelStoreInEx.png|600px|thumb|center|''Figure 4: Store-import.xml (normal) and Store-export.xml (normal) with Java Object Model Name'']]

Please note that the declaration order of each node names matters.

====createOn====

The <code>createOn</code> keyword followed by a string specifies on which input element should an entity to be created. For example:

► '''Example''':
<syntaxhighlight lang="java">
entity Mcurrency createOn "/Envelope/Cube/Cube/Cube" ... {
...
}

</syntaxhighlight>

will create an <code>Mcurrency</code> entity when encountering <code>/Envelope/Cube/Cube</code> in the source data file.

====marker====

With <code>marker</code> keyword optionally followed by a property-name, the user can set the data to be imported to have an additional property under the given name whose value set to 1, while updating the existing data to have this property having value 0. This could be useful to identify the most recent import of some periodically updated data. For example:

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

entity McurrencyStream createOn "/Envelope/Cube" marker latest expression {
...
}
</syntaxhighlight>

will make the entity <code>McurrencyStream</code> to have a property "<code>latest</code>", which is to be set to 1 for the most recently imported data.

====expression====

With an <code>expression { ... }</code> block, the user can define expressions that assign certain value to an entity property. These expressions are of two types, the first one is:

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

assign <id> with <value> as <type>

</syntaxhighlight>

this will assign the property <code>id</code> with the value of <code>value</code>, in type of <code>type</code>. The <code>value</code> may be one of the following:

* <code>NowDate</code>: the date of now (the time point of action)
* <code>StartDate</code>: the date when the process started
* <code>UniversallyUniqueIdentifier</code>: an UUID

and <code>type</code> may be one of the following:

* <code>Date</code>: the value of NowDate or StartDate will be in date format
* <code>Milliseconds</code>: the value of NowDate or StartDate will be in millisecond
* <code>Nanoseconds</code>: the value of NowDate or StartDate will be in nanosconds
* <code>Random</code>: the value of UUID will be random
* <code>ExecuteContext</code>: the value of UUID will be unique for the execute context

Note that the <code>Random</code> and <code>ExecuteContext</code> should be only combined with <code>UniversallyUniqueIdentifier</code>, while the other types should be only combined with <code>NowDate</code> or <code>StartDate</code>.

► '''Example''':
<syntaxhighlight lang="java">
entity McurrencyStream createOn "/Envelope/Cube" marker latest expression {
assign importDate with NowDate as Date
}
</syntaxhighlight>

will assign the <code>importDate</code> as the current date in <code>Date</code> format.

The other type of expression has the form:

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

copy <target-property> from <entity-name> property <from-property>

</syntaxhighlight>

which will copy the value of <code>from-property</code> from the <code>entity-name</code> to <code>target-property</code>.

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

entity Mcurrency createOn "/Envelope/Cube/Cube/Cube" expression {
copy currencyDate from McurrencyDay property ratingDate
}

</syntaxhighlight>

will copy the value of <code>ratingDate</code> from <code>McurrencyDay</code> entity to <code>currencyDate</code>.

====lookup====
<div id="lookup">
With a <code>lookup</code> { ... } block, the user can define a set of '''lookup-rules''' to identify complex data within our persistence layer (DB or In-Memory...). This makes sense when the data in a source file can't be clearly identified by an attribute (id), but moreover when the set data it contains is persisted over several entities.

► '''Syntax''':
<syntaxhighlight lang="java">
lookup {
[<lookup-rules>]*
}
</syntaxhighlight>

Lookup-rule expression:
<syntaxhighlight>
lookup-rule:
'for' .. 'on' .. 'createOn' .. 'with' .. 'cacheSize' .. 'mapTo' .. ['allowNoResult' | 'allowNoResult' | 'markerPath']
</syntaxhighlight>

► '''Example''':
<syntaxhighlight lang="java">
interchange Currencies describedBy "european central bank currency exchange rates based on euro" persist elementSize 50 file
XML "C:/git/development/net.osbee.sample.foodmart/net.osbee.sample.foodmart.datainterchange/smooks-resources/eurofxref-hist-90d.xml"

mapByAttribute beans {
entity McurrencyStream createOn "/Envelope/Cube" marker latest expression {
assign importDate with NowDate as Date
}
entity McurrencyDay createOn "/Envelope/Cube/Cube" format {
for ratingDate coding "yyyy-MM-dd"
}
mapping {
map ratingDate to "time"
}
entity Mcurrency createOn "/Envelope/Cube/Cube/Cube" expression {
copy currencyDate from McurrencyDay property ratingDate
}
lookup {
for currency_name on McurrencyName createOn "/Envelope/Cube/Cube/Cube" with isoCode cacheSize 300 mapTo "currency" allowNoResult
markerPath {
markerEntity McurrencyNameStream markedBy latest
}
}
mapping {
map conversion_ratio to "rate"
}

}

</syntaxhighlight>

</div>

We will provide you in upcoming releases with more information about so called '''locator''' instances, which are generated in the background on the basis of the '''lookups''' you would have defined, in order to query persisted data. This will give you more insights about how the Datainterchange DSL really works at the lower level.

====format====

With a <code>format { ... }</code> block, the user can define the format of the entity property being converted. A <code>format</code> block can have more than one format definitions, in the following format:

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

format {
for <property> coding <format-string> [locale <locale-string>]
...
}

</syntaxhighlight>

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

entity McurrencyDay createOn "/Envelope/Cube/Cube" format {
for ratingDate coding "yyyy-MM-dd"
}

</syntaxhighlight>

will convert the <code>"/Envelope/Cube/Cube"</code> data to <code>ratingDate</code> property of <code>McurrencyDay</code> in format <code>"yyyy-MM-dd"</code>, where

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

entity EDIOrderHeader createOn "/Order/header" format {
for hdrDate coding "EEE MMM dd HH:mm:ss zzz yyyy" locale "en_US"
}

</syntaxhighlight>

will format the <code>hdrDate</code> in format <code>"EEE MMM dd HH:mm:ss zzz yyyy"</code> with English locale, i.e. the month and weekday names will be in English.

====expose====

With a <code>expose { ... }</code> block, when and only when exporting an entity, the user can expose properties of its referenced entity. A <code>expose</code> block can have more than one expose definitions, in the following syntax format:

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

expose {
ref <EntityReference>
on <EntityAttribute>
| subExpose
...
}

</syntaxhighlight>

'''subExpose''' has the same syntax format as '''expose''', which is:

<syntaxhighlight lang="java">

expose {
ref <EntityReference>
on <EntityAttribute>
| subExpose
...
}

</syntaxhighlight>

► '''Example''':

Entities are defined as following:

<syntaxhighlight lang="java">

entity CashSlip {
...
var boolean payed
ref cascade CashPosition[ * ]positions opposite slip
ref Mcustomer customer opposite slips }

</syntaxhighlight>

<syntaxhighlight lang="java">

entity Mcustomer extends BaseID {
...
var long account_num
var String name
ref Mregion region opposite customers
ref Msales_fact[ * ]sales opposite customer }

</syntaxhighlight>

In datainterchange DSL, when exporting entity "'''CashSlip'''", the user can use "'''expose'''" keyword to export the "'''account_num'''" property of "'''Mcustomer'''" referenced here as "'''customer'''".
And sub-reference of the reference can also be exported. In the following example, the "'''region'''" reference (of entity "'''Mregion'''") in "'''Mcustomer'''" has a property "'''sales_city'''", it is also exported.

<syntaxhighlight lang="java">

interchange CashSlip describedBy "CashSlip" merge vectorName "cashslip" file XML "C:/MC/cashdata.xml" encoding "UTF-8"
path {
entity CashSlip

expose {
customer on account_num
customer expose {
region on sales_city
}
}
}

</syntaxhighlight>

In the generated Smooks config XML, the section will look like this:
<syntaxhighlight lang="java">

<account_num>${(CashSlip.customer.account_num)!}</account_num>

</syntaxhighlight>

And the sub-expose part looks like this:
<syntaxhighlight lang="java">

<sales_city>${(CashSlip.customer.region.sales_city)!}</sales_city>

</syntaxhighlight>

* This recursive-export can go as many levels as the user want.

====mapping====
With a <code>mapping { ... }</code> block, the user can easily '''map''' (or rather '''match''') attributes of the data model to values from external source files.

► '''Syntax''':
<syntaxhighlight lang="java">
mapping {
[map <entity-attribute> to <Data>]*
[mapBlob <entity-attribute> to <Data> [extension <blob-file-extension] [path <blob-path>] mimeType <mine-type> ]*
}
</syntaxhighlight>

► '''Example''':
<syntaxhighlight lang="java">
mapping{
map conversion_ratio to "rate"
mapBlob currency_icon to "currency_icon" extension "png" path "C:/data/currency_images" mimeType png
}
</syntaxhighlight>

The first map of the above example will map the attribute conversion_ratio of the entity to field "rate".
The second mapBlob does a bit more work, it will:

* generate full file paths by combining the path, the file names specified by "currency_icon" field, and the extension,
* upload the files into database with the given mimeType, and
* assign the UUID of the blob to property currency_icon of the entity.

Please note that the only valid attributes here are the members of the corresponding entity, which the user has chosen prior defining the <code>mapping</code> block itself.

====keys====
With a <code>keys</code> { ... } block, the user can define a set of '''keys''' to identify data within our persistence layer (DB or In-Memory...).
This makes sence when the data in a source file can't be clearly identified by an attribute (id). Therefore a set of attributes (keys) can be defined and then be used as identification parameter set by a [[#lookup|''lookups'']] instance in order to query our data pool and identify data using several criteria.

► '''Syntax''':
<syntaxhighlight lang="java">
keys {
[key <entity-attribute>]*
}
</syntaxhighlight>

Assuming you try to update the address data of an employee from an entity named Employee, but you happen not to have his/her personal id. By setting a <code>keys</code> { ... } block, like shown here below, you allow the Datainterchange unit to look into the database after employee's data based on the key set inside this block, rather than using a personal id, which might have been here unique and more than enough to find the employee right away.

► '''Example''':
<syntaxhighlight lang="java">
keys {
key last_name
key first_name
key age
}
</syntaxhighlight>

Please note that the only valid attributes here are members of the corresponding entity, that you would have chosen prior defining the <code>keys</code> block itself.

==TriggerView==
A TriggerView will be automatically generated by the DataInterchange DSL as soon as you define an interchange unit inside the model file and save it.

You can see on the right side of the figure shown below, the definition of 10 interchange units within the Datainterchange model file (blue rectangles); and on the right side of the figure you can see, how the TriggerView looks like (green rectangle), when it is embedded inside an application page in its entirety.

[[File:TriggerView.png|600px|center|''Figure 5: Datainterchange TriggerView Definition and Application Views''|thumbnail|600px]]

To achieve this result you need to do two simple steps. You need first to either integrate the TriggerView into an existing perspective or create a new perspective and then integrate the view into it, like shown below.

► '''Example 1''':
<syntaxhighlight lang="java">
import ns net.osbee.sample.foodmart.datainterchanges
...

package net.osbee.sample.foodmart.perspectives {

perspective Currencies iconURI "employee" {
sashContainer c1 orientation horizontal {
part imex view dataInterchange datainterchanges spaceVolume "20"
...
}
}
}
</syntaxhighlight>

The most important thing in this example is to notice the use of the keyword '''view''' followed by the keyword '''dataInterchange''' and the name ''datainterchanges'' referring to the package, in which all datainterchange unit definitions have to be found.

The second step would be to create a menu entry for you to be able to access the newly created or altered perspective in the application via the menu bar, like shown in the following example.

► '''Example 2''':
<syntaxhighlight lang="java">
import ns net.osbee.sample.foodmart.perspectives.Currencies
...

package net.osbee.sample.foodmart.menues {
...
entry Menu describedBy "my menu" {
entry Perspectives {
entry MasterData {
entry Company image "company" perspective Company
entry Employees image "employee" perspective Employee
entry Products image "products" perspective Products
entry CashRegisterData image "editor_area" perspective CashMasterDataRegister

entry Currencies image "products" perspective Currencies

entry People image "task_action_delegate" perspective PeopleMock

}
...
... }
}

}
</syntaxhighlight>

[[File:TriggerViewMenuSelection.png|600px|center|''Figure 6: Datainterchange TriggerView Menu Selection''|thumbnail|600px]]

The figure above shows the same menu structure defined in the example 2 and results in showing the application with the TriggerView, as you can see on the left side of the figure 5. You can get and review more information on how to create menu entries and perspectives in both [[Menu DSL]] and [[Perspective DSL]] documentation pages.

Among all the components that are generated for the use of each interchange unit functions are action buttons, you would find inside toolbars in some dialogs. Usually you have to define them by yourself in the corresponding DSL files. This step is not needed here, since it has already been generated for this particular view.

[[File:TriggerViewActionButtons.png|600px|center|''Figure 7: Action Buttons for datainterchange unit functions''|thumbnail|600px]]

Please note that it is '''not mandatory''' to display all available functionalities through the use of the TriggerView like shown here above. It is customary to only use parts of the generated Datainterchange components (e.g. action buttons) where you see them fit; for instance in order to only use each interchange unit functionalities (import and/or export) in separated and dedicated views (dialogs). Therefore, we also recommend you to have a look at the [[Action DSL]] documentation page in order to understand how to create your own toolbars, and so forth creating the buttons using import or export functions of any datainterchange unit you would have created.

==Smooks Configuration and Settings File==
'''Please note that whenever a model is saved''', the '''Datainterchange DSL''' will do three things '''automatically''':

* generate Java classes,
* generate Smooks configuration files for both import and export functions, and
* generate a config file to modify the import and export paths on runtime.

===Smooks Configuration File===

The OS.bee implementation of Data Interchange interface is based on Smooks. Smooks is a Java framework for processing XML and non XML data (CSV, EDI, Java etc) by mapping data to JavaBeans, which can later be persisted, enriched (merge with existing data from other source), or converted and exported into other formats.

Smooks relies on a proper configuration file for the import / export processes. These configuration files are generated by the Datainterchange DSL automatically. Here is a brief introduction of how the generated Smooks configuration files work.

When a data import / export Smooks instance is initiated, it will be supplied with the generated config file. This file defines the actions to be performed upon certain events during the SAX parsing process. Here is an example:
<syntaxhighlight lang="xml" line='line'>
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<smooks-resource-list xmlns="http://www.milyn.org/xsd/smooks-1.1.xsd" xmlns:csv="http://www.milyn.org/xsd/smooks/csv-1.2.xsd" xmlns:dao="http://www.milyn.org/xsd/smooks/persistence-1.2.xsd" xmlns:jb="http://www.milyn.org/xsd/smooks/javabean-1.2.xsd">
<jb:bean beanId="McurrencyNameStream" class="net.osbee.sample.foodmart.entities.McurrencyNameStream" createOnElement="/csv-set">
<jb:expression property="importDate">PTIME.nowDate</jb:expression>
<jb:wiring beanIdRef="McurrencyName" setterMethod="addToCurrencyNames"/>
</jb:bean>
<jb:bean beanId="McurrencyName" class="net.osbee.sample.foodmart.entities.McurrencyName" createOnElement="/csv-set/csv-record">
<jb:value data="/csv-set/csv-record/isoCode" decoder="String" property="isoCode"/>
<jb:value data="/csv-set/csv-record/name" decoder="String" property="name"/>
<jb:value data="/csv-set/csv-record/countries" decoder="String" property="countries"/>
</jb:bean>
<csv:reader fields="isoCode,name,countries" indent="false" separator=";" skipLines="1"/>
<params>
<param name="stream.filter.type">SAX</param>
<param name="inputType">input.csv</param>
<param name="smooks.visitors.sort">false</param>
<param name="input.csv" type="input.type.actived">C:/git/net.osbee.sample.foodmart/net.osbee.sample.foodmart.datainterchange/smooks-resources/ISOCurrencyCodes081507.csv</param>
</params>
</smooks-resource-list>
</syntaxhighlight>

Further informations on the Smoooks framework are available and can be reviewed in its [http://www.smooks.org/guide documentation] you will find on the [http://www.smooks.org/index official website].

===Path Config File===

The file is interpreted using the Properties xml im- and export method and looks like this:

<syntaxhighlight lang="java">

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE properties SYSTEM "http://java.sun.com/dtd/properties.dtd">
<properties>
<comment>dataInterchange file URLs</comment>
<entry key="EmployeesDepartment-import">C:/myimports/employeesdepartment.xml</entry>
<entry key="EmployeesDepartment-export">C:/myexports/employeesdepartment.xml</entry>
</properties>

</syntaxhighlight>

By default this file is named like the title in the Data Interchange package and extended by "Config" and has the extension "xml":

<code>package net.osbee.sample.foodmart.datainterchanges title "DataInterchange" {}</code>

leads to the filename:

<code>DataInterchangeConfig.xml</code>

and is stored platform independently in the current user's home directory under the subdirectory ".osbee".

An administrator must receive this configuration file with the application, modify it and place it somewhere on the application server. The path to this configuration file must be supplied in the product's preferences (<code>org.eclipse.osbp.production.prefs</code>):

<code>datainterchange/datainterchangeConfiguration=c\:\\DataInterchangeConfig.xml</code>

The path value obviously depends on the operating system you are developing.

===Further Reading===

There is a lot of information to be found in the internet that describe the formal structure of the smooks configuration in any case. A very good one can be found at [https://access.redhat.com/documentation/en-us/red_hat_jboss_fuse/6.3/html-single/smooks_development_guide/index RedHat].

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

OS.bee Customer Display

2019-03-12T08:18:41Z

Riegel: /* Customer Display */

== Customer Display ==

The Statemachine DSL (Finite State-Machine) covers the synchronization of external (slave) browsers to a main (master) browser connected to an OS.bee server. The requirement was mainly inspired by the need of a customer display for the OS.bee application OS.pos. In this context it was required to display data for the customer on a secondary display.

Multiple displays can be connected to a master just by using a pattern on the address line of the slave-browser:

<code> http://''server_host-name''/osbpdisplay/#''host-name_of_the_master''?display=''DialogName''Display (as defined in Dialog DSL)&locale=''language tag of locale''</code>

► example: http://dv999.compex.de:8081/osbpdisplay/#dv999.compex.de?display=CashSlipDisplay&locale=de-DE

DisplayName must be followed by the postfix Display as the class is generated like this to be seprarate from other dialogs.
Language tags specify a language locale with its country component, like "de-DE", "de-AT", "en-US", "en-EN". The country component is necessary to decide the currency symbol and other country specific formats.

=== Important prerequisite ===
In order to use external displays you must add the bundle ''org.eclipse.osbp.display'' to your product's launch configuration and set auto-start to true.

[[File:display_autostart.png|800px]]

=== Technical changes in DSL model ===

==== changes in dto ====
* New '''dto''' "'''CustomerDisplayDto'''":
*:<syntaxhighlight lang="java">
dto CustomerDisplayDto {
var double totalAmount
var boolean left
var String message
var boolean right
var BlobMapping image
ref CashSlipDto slip
}
</syntaxhighlight>
** '''totalAmount''' : total amount of all cash position.
** '''left''' & '''right''' : boolean value, define if this part will be shown on display.
** '''image''' : any image which will be shown on th display
** '''slip''' : reference the cash slip dto.

==== changes in UI====
* New '''UI''':
*:<syntaxhighlight lang="java">
display Customer {
rootType CustomerDisplayDto
datasource main:CustomerDisplayDto
datasource img:BlobConverter
horizontalLayout {
verticalLayout left {
textfield(i18n noCaption readonly) message
table(i18n noCaption) slip {
scrollToBottom
type CashPositionDto
columns {
column quantity
column product.sku
column product.product_name
column price
column amount
}
sort {
column now asc
}
}
align fill-left
form(styles "os-cash-total") {
decimalField(precision= 2 readonly) totalAmount
}
bind [this.message].value <-- img.input
bind [this.slip].collection <-- main.slip.positions
bind [this.totalAmount].value <-- main.totalAmount
}
verticalLayout right {
image info
bind img.input <-- main.^image
bind [this.info].resource <-- img.output
}
bind [this.left].visible <-- main.left
bind [this.right].visible <-- main.right
}
}
</syntaxhighlight>
** In this '''display''' "'''customer'''", we define in the 2 parts(left part & right part), if they will be shown and what will be shown in UI.

==== changes in Functionlibrary ====
* New lines in '''operation''' "'''initImages'''" & '''operation''' "'''conputeTotal'''" :
*:<syntaxhighlight lang="java">
operation initImages(IStateMachine stateMachine, Object [] params) {
. . .
stateMachine.set("CustomerDisplayImage", cashregister.store.company.companyImage)
. . .
}
</syntaxhighlight>
** In operation "'''initImages'''", the image of customerDisplay could be set.
*:<syntaxhighlight lang="java">
operation computeTotal(IStateMachine stateMachine) {
. . .
stateMachine.set("CustomerDisplayTotalAmount", amount);
. . .
}
</syntaxhighlight>
** In operation "'''computeTotal'''", the total amount of CustomerDisplay could be calculated and set.

==== changes in Statemachine ====
Some new keywords are introduced for this new functionality:
:* <syntaxhighlight lang="java"> display <DisplayName> using <DTOName> </syntaxhighlight>
:* <syntaxhighlight lang="java"> dto <DTOAlias> type <DTOName> attach <DisplayName> </syntaxhighlight>
:* <syntaxhighlight lang="java"> displayText text "some text" @<DisplayName> to <DTOAttribute> </syntaxhighlight>

The references of a DTO that is attached to a display are always synchronized across all connected displays. Single fields must be synchronized by '''displayText'''.

:► e.g.:
:*<syntaxhighlight lang="java">
display CustomerDisplay using CustomerDisplayDto
</syntaxhighlight>
:*<syntaxhighlight lang="java">
dto cashslip type CashSlipDto attach CustomerDisplay
</syntaxhighlight>
:*<syntaxhighlight lang="java">
displayText text "locked" @CustomerDisplay to message
</syntaxhighlight>
:► The referenced DTO must be the rootType of the Display definition in the ui model.

Now I will show the changes in statmachine:
# New '''events''' "'''dataProvider DataControl'''":
#:<syntaxhighlight lang="java">
dataProvider DataControl {
. . .
dto cashslip type CashSlipDto attach CustomerDisplay
dto customerDisplay type CustomerDisplayDto
. . .
}
</syntaxhighlight>
# New '''events''' "'''peripheral PeripheralControl'''":
#:<syntaxhighlight lang="java">
peripheral PeripheralControl {
. . .
display CustomerDisplay using CustomerDisplay
. . .
}
</syntaxhighlight>
# Setting for customerDisplay, in '''state''' "'''IDLE'''":
#:<syntaxhighlight lang="java">
trigger onStartUp
actions transition LOCKED{
. . .
displayText false @CustomerDisplay to ^left
displayText true @CustomerDisplay to ^right
. . .
}
</syntaxhighlight>
# Setting for customerDisplay, in '''state''' "'''LOCKED'''":
#:<syntaxhighlight lang="java">
trigger onOk
actions transition ATTENTIVE{
. . .
displayText true @CustomerDisplay to ^left
displayText false @CustomerDisplay to ^right
. . .
}
</syntaxhighlight>

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

OS.bee Software Factory Unique Selling Propositions

2019-01-29T08:02:41Z

Riegel: /* Why using OS.bee? */

= What is OS.bee about? =

OS.bee is a low-code model-driven software-factory, using over 20 Domain Specific Languages (DSL) to generate large-scale business web-applications. Each DSL contains a grammar for a required application-layer. A DSL hides complexity from successors, thereby enabling parallel modelling of domain requirements by multiple designers as they don’t need to know the domain logic they build upon. A model created with a DSL creates executable code, structured data and configuration settings or is interpreted by a renderer during runtime. The language of each DSL uses a grammar that makes the created model easy to understand and forms a requirement specification on its layer. The overall hierarchy can be browsed through at any time and gives a good understanding of the whole application in nearly natural English language. A DSL can also be studied by its syntactical graph. The creation of a model is a guided process through the syntax graph where the designer benefits from content assistance, code completion, quick fix, syntax colorizing, outline, formatting and validation. Many DSLs define metadata to be used by subsequent DSL to increase the leverage of definitions at a basic level. All element names defined by a DSL are automatically extracted to localization files for translation to open foreign markets for the resulting application. The ratio between the generated lines of code versus the numbers of lines in a model is about 8-10. Development speed improves by a similar factor. Dependencies between models reveal inconsistencies immediately while modifying and prevent generating code until these are resolved. Therefore turnaround cycles are short, errors are easy to discover and prototypes materialize in a very short time. Some DSL generate against famous open-source frameworks like EclipseLink, Smooks, Mondrian, Vaadin or jBPM thus enabling non-developers to use complex frameworks without deeper knowledge of their API. OS.bee inherits the features of the embedded frameworks and makes them easy to exploit for specialists of a domain not necessarily being software developer.

= Why using OS.bee? =
* You need a lot of unexpensive workstations for your employees to work with OS.bee applications.
* Work has to be done from everywhere, worldwide, in any language.
* Deployment of new versions shall be simple and be done at a single point to keep IT-costs at a minimum.
* Downtimes for updates or sandbox trials are undesired.
* You want to scale your applications effortless as you do with your business in means of functionality and security.
* You want a hierachically consistent and validated application any time, no matter what was just modified.
* You dislike vendor lock-in.
* Investments in software should be long-term decisions.
* You know that software never is a stand-alone solution, instead it must deeply integrate with existing solutions, machines and protocols.
* The Internet of Things is not just a verbal formula to you, you ought to use it.
* You know best about your business and want to be enabled to implement that knowledge by yourself into the application.
* You want that continuous improvement for applications shall be unexpensive.
* Open Source software is an advantage to you, not a risk.
* The software architecture should fulfill all state of the art design patterns and conform to object oriented design principles in order to be open to changes.
* It should be possible to hire software specialists all over the world needing a minimum of training on your software if it becomes necessary.
* Fast solutions to your business problems is your biggest concern.
* The software you use shall be fault tolerant and self-controlling.
* The business processes implemented in your software shall use standardized notations and be automatic, cooperative, save and easy to learn and modify.
* You know that enforcing business rules in your company is a success factor.
* On the other hand, your employees must feel comfortable with the software they use.
* It is quite clear to you that mature capabilities in all departments of your company can only be achieved through measurement and analysis and agile change management for business processs.
* If you need support, you can get it anytime. 24/7 by experts, from a forum, by examples and videos.

= DSL Modeling =

== Persistence ==

Persistence refers to object and process characteristics that continue to exist even after the process that created it ceases or the machine it is running on is powered off. When an object or state is created and needs to be persistent, it is saved in a non-volatile storage location, like a hard drive, versus a temporary file or volatile random access memory.

=== Data-type ===

A data type is a classification that specifies which type of value a variable has and what type of mathematical, relational or logical operations can be applied to it without causing an error. Data types also hold metadata for higher-level DSLs so they can apply additional functionality to a field using this data type.

* Primitive Types (int, double, etc.)
* Object Types (String, Date, etc.)
* Blob
** Store and retrieve any document or image type in binary form
* Auto-sizing Images
** Additionally stores images of definable size to experience better performance while rendering
* Formatted types
** Dates and times in any localized form
** Dates and times in any format (time only, date only, short and long forms, custom pattern, etc.)
** Currencies in any localized form
* Validated types with adjustable severity message
** Date in past/future
** Not null
** Not duplicate
** Range values
** Min/max length
* Slider types
** Min/max values
* Masked types
** Number, Hexadecimal, Capitalized
** Input pattern (e.g. Phone Numbers (###) ###-####)
** Password
* Suggestion types
** While typing some characters, a sorted list of suggestions pops up for selection
* Programmable Converters
** Text-to-Image
** Number-to-Text/Image
** Value-to-CSS Style
** Units of measurement
* Rich text editor using HTML markups
* Text area

=== Entity ===

An entity (-type) is a model of metadata for a single unique object in the real world. For example a person, organization, object type, or concept about which information is stored. Together with its attributes (or properties) it describes information that is being mastered. An entity typically corresponds to one or several related tables in database. An attribute is a characteristic or trait of an entity that describes the entity, for example, the Person entity type has the Date of Birth attribute.

* Simple Entity
* Mapped super-classes
** Complement attributes in every entity using this
* Inheritance
** Specialized classes for special purpose
* References and their opposites
* References with constraints
* Embeddable beans
* Number generators UUID or ID
* Separated persistence-units capable of using multiple databases simultaneously
* All multiplicities (0..1, 0..n,1..1,1..n,*)
* Indexes unique and non-unique
* Validated uniqueness
* Domain-key annotation for lookups
* Methods for calculated attributes
* Lifecycle controlled method invoking (by PostLoad, PrePersist, etc.)
* Affected changes listeners
* Localizable Enumerations with images
* Creation and last modification information
* Transient data
* Synthetic attributes built by lifecycle methods either transient or persistent
* Historicized data
* Temporal data
* Versioned data
* Definable Runtime data filter
* Programmable Validators
* Nested Filter attributions over multiple references
* Abstraction of database vendor specific implementations

=== Data transfer object (DTO) ===

A DTO is an object that carries data between processes. DTOs are simple objects that do not contain any business logic but may contain serialization and deserialization mechanisms for transferring data.

* Independent nested data container
* Automatically generated for entities
* Automatically mapped by entity data
* Editable sub- or supersets for entities
* Transient data container
* Nested objects automatically synchronized
* Nested properties access through dot expressions
* Used for services, processes, functions and renderers
* Dirty state aware
* Access restrictions on DTO and property granularity controlled by security layer

=== DTO Service ===

A DTO service abstracts and encapsulates all access to the data source. It manages the connection with the data source to obtain and store data and implements the access mechanism required to work with the data source. The data source could be a persistent store like an RDBMS, or a business service accessed via REST or SOAP.

* Data storage and retrieval suitable for DTO
* Nested Transactions and Lock-modes
* Global transactions
* Object Oriented Query engine
* Low level Java Persistence Query Language method declarations (e.g. getTotal(), getAverage(), …)
* Injectable and declarative service
* Used for services, processes, functions and renderers
* Session scoped Entity Manager
* Thread safe persistence-unit bound Entity Manager Factory

=== Data-Interchange ===

Data Interchange is the endpoint-to-endpoint exchange of business documents in a standard electronic format between business partners or computer systems.

* Smooks and FreeMarker implementation
* Nested entity import- and export-paths
* Localized formatters on data
* Supports encoding
* XML and CSV formats
* All EDI messages
* Automatically set export- and import markers for database
* Filtered exports
* Bulk insert/update
* Progress bar
* Generated import and export dashboard
* Generated lookup queries to embed relational data
* Merge or persist external data
* Import images of different mime-types into blobs via filename pattern
* Usage of expressions
* Free attribute mappings

=== Signal ===

Signal processes events coming from file-systems. If a file that matches a given filename pattern is created, modified or deleted then an event is received and the modelled actions will be called. Signal also emits events for recurring things like a certain weekday and time is reached and executes the modelled actions.

* File watcher for all file activities working on all operating systems
* Free filename pattern to watch for

* Trigger Data-Interchange
* Definable export or import job-chain
* Synchronously or asynchronously execution (depending on import relationship)
* Quartz implementation for scheduled Data-Interchange export-jobs

=== Entity-Mock ===

Mock objects are simulated objects that mimic the behavior of real objects in controlled ways. A programmer typically creates a mock object to test the behavior of some other object, in much the same way that a car designer uses a crash test dummy to simulate the dynamic behavior of a human in vehicle impacts.

* Generates fake data looking realistic

* Mapping of roles to positions and multi-positions

* Rule-based data composition (e.g. email address)
* Rule-based attribute generators for every data-type from data composition, or
** Randomly
** Ranges
** Picks from a given list
** Dates in the past with offset and limit (for birthdays)
** Dates in the future with offset and limit
* Composes objects from rule-based attribute generators (e.g. a person, a company, etc.)
* Composes object-trees from composed objects
* Creates relationships between objects using a given probability
* Creates mass data (e.g. sales data)
* Imports fixed data via Data-Interchange and embeds it
* Used mainly for quick-setup applications using a H2 database
* Exposes mock data services to be executed before any login-attempt
* Persists into all supported database products
* Can be executed at every server-start or once

== Business intelligence ==

Business Intelligence (BI) refers to technologies, applications and practices for the collection, integration, analysis, and presentation of business information. The purpose of Business Intelligence is to support better business decision making. Essentially, Business Intelligence systems are data-driven Decision Support Systems (DSS). Business Intelligence is sometimes used interchangeably with briefing books, report and query tools and executive information systems.

=== Cube ===

A cube is a method of storing data in a multidimensional form, generally for reporting purposes. In cubes, data (measures) are categorized by dimensions. Cubes are pre-summarized across dimensions to drastically improve query time over relational databases. The query language used to interact and perform tasks with cubes is multidimensional expressions (MDX).

* Mondrian OLAP for MDX queries implementation
* Cubes, dimensions, hierarchies, levels, members, and measures
* Defines a multi-dimensional database
* Contains a logical model, and a mapping of this model onto the physical entity model

=== DataMart ===

A data mart is a subject-oriented archive that stores data and uses the retrieved set of information to assist and support the requirements involved within a particular business function or department. Data marts improve end-user response time by allowing users to have access to the specific type of data they need to view most often by providing the data in a way that supports the collective view of a group of users.

* Common layer for data-warehouse queries
* Simplification of any kind of query against all available data sources
* Tailored queries and aggregates for different interest-groups
* Definition of complex multidimensional expressions (MDX) with a simple grammar
* Sophisticated analytic functions easy to use
* Online analytical processing built in
* Access to runtime data of the Business Process management engine
* Multi-purpose results for processes, reports, score cards and charts
* Definable navigation trees (join-paths)
* Definable single- and multi-selection filters on any leaf of the query tree
* Access restrictions on entity and attribute granularity controlled by security layer

=== Function-Library ===

A function-library is a collection of non-volatile resources used by other DSLs. It is a collection of implementations of behavior, written in Xbase, which has a well-defined interface by which the behavior is invoked. Library code is organized in such a way that it can be used by multiple programs that have no connection to each other, in other words it is completely independent of the calling logic.

* Xbase implementation
* UOMo implementation
* Creates operational objects and methods
* Grouped by application field
** Converter for model-presentation conversions
*** Value to image
*** Value to value
*** Value to style (background color, text color, font-style, etc.)
*** Value to unit of measurement based value
*** Between measurement systems and unit of measurement families
** State-Machine
*** Operations
*** Functions
*** Guards
*** Full access to state-machine controls
** Toolbar Action
*** Can execute validation (enable/disable operation)
*** Execute any operation
** Validation on DTO
** Business logic implementation for BPM
*** Functions callable in system tasks
*** Ratings for gateways
*** Tests for gateways
** Calculations e.g. for
*** Currencies
*** Lengths
*** Areas
** Posting operations
* Exposes injectable and declarative service
* Store and retrieve data from DTO
* Full access to all JVM objects

=== State-Machine ===

A finite-state machine (FSM) is a mathematical model of computation. It is an abstract machine that can be in exactly one of a finite number of states at any given time. The FSM can change from one state to another in response to an event. The change from one state to another is called a transition. An FSM is defined by a list of its states, its initial state, and the conditions for each transition. These conditions are called guards as they guard the transition from unwanted invocation.

* Implementation of business behavior
* Defines states and their transitions
* Transitions are triggered by events
* Transitions are guarded by functions from Function-Library
* Actions to be executed before and after transitioning from Function-Library
* Has things to control
** Database objects (DTO)
** Database filters
** Visibility or enabling of
*** Buttons (UI)
*** Layouts (UI)
*** Other components (UI)
** Peripheral devices (interfaces JavaPOS)
*** Printers
*** Line displays
*** Cash drawers
*** Payment terminals
*** Signature pads
** Slave browsers (external displays, etc.)
* Receives events from
** Buttons clicked
** UI selections
** Peripherals (printer out of paper, etc.)
** Schedulers

=== BLiP (Business Logic implementation Platform) ===

BLiP focuses on improving corporate performance by managing business processes (BPM), business rules and business logic (Function-Library).  It is a disciplined approach to identify, design, execute, document, measure, monitor, and control both automated and non-automated business processes to achieve consistent, targeted results aligned with an organization’s strategic goals. BPM involves the deliberate and collaborative definition, improvement, innovation, and management of end-to-end business processes that drive business results, create value, and enable an organization to meet its business objectives with more agility. BPM enables an enterprise to align its business processes to its business strategy, leading to effective overall company performance through improvements of specific work activities either within a specific department, across the enterprise, or between organizations.

* Implements jBPM
* Integrates a BPMN editor at design-time
* Connects tasks of BPM to business logic of Function-Library
* Controls sequence-flow through business logic of Function-Library
* Stores and retrieves process save-points
* Logs all process activities of system and user
* Exposes BPM data and events to UI elements
* Stores and retrieves workload data using DTO

== Presentation ==

The presentation layer ensures that the communications that pass through it are in the appropriate form for the recipient application. It is responsible for the delivery and formatting of information to the application layer for further processing or display. It relieves the application layer of concern regarding syntactical differences in data representation within the end-user systems.

=== Table ===

A table is a data structure that organizes information into rows and columns. It can be used to both store and display data in a structured format.

* Editable cells
* Scorecard elements
** Rule-based colorizing of cell background and textcolor
** Mixed in rule-based icons
** Rule-based styling of cells
** Rule-based tooltips
* Data from DataMart or DTO
* Pivot presentation
* Multidimensional presentation on nested tab-sheets
* Filtering, sorting, swapping and hiding of columns
* Stores swapping and hiding per user
* 3 different row numbering modes
* Row selection synchronizes other views in scope

=== Chart ===

A chart is a diagram, picture, or graph which is intended to make information easier to understand. It is a symbolic representation of information according to some visualization technique.

* Multiple data series with selectable colorizing
* Series switchable from legend
* Bar, line, pie, donut, bubble and gauge presentation
* Animated, stacked, shaded and xy-swapped charts
* Zoom and trend-line function
* Tooltips for series and data points with absolute value
* Selectable positioning relative to cursor for tooltips
* Selectable legend placement
* Collapsible tree presentation on hierarchical data
* Date axes with customizable formatting
* Up to 9 individually scalable Y axes
* Rotated axis text
* Category rendering either linear, logarithmic, timeline or as pyramid
* Downloadable SVG image

=== Report ===

A document containing information organized in a graphic or tabular form, prepared on ad hoc, periodic, recurring, regular, or as required basis. Reports may refer to specific periods, events, occurrences, or subjects, and are presented in printed form.

* Actuate Birt implementation
* Definition of reusable layout metadata
** All units of measurement for layouts
** Definition of fonts and colors
** Definition of formatters for
*** Currencies
*** Date and time
** Page sizes (A4, A5, etc.)
** Orientations (Landscape, portrait)
** Margins
** Paddings
** Alignments
* Output as HTML or PDF
* Ability to reference multiple DataMarts for header, footer and details
* Rendering of blob-images
* External CSS usable
* Defines grids and cells
* Direct printing to preselected output medias per user or per location and report
* Rule-based visibility of cells
* Aggregates for grouping
* Rule-based page break
* Rule-based colorizing and styling
* URL-based or embedded images
* Auto-texts (page number etc.)

=== Topology ===

Topology is designed for representing simple geographical features, along with their non-spatial attributes. It includes geo-json points (addresses and locations), line strings (streets, highways and boundaries), polygons (countries, provinces, tracts of land), and multi-part collections of these types.

* D3 implementation
* Render predefined maps of U.S.A., Germany, Spain… the World
* Select states, countries, regions or cities to synchronize other views in scope
* Render geo-json data from blobs to show boundaries of plots of land, buildings or floor plans

=== UI ===

The user interface (UI) is the space where interactions between humans and OS.bee occur. The goal of this interaction is to allow effective operation and control of the machine from the human end, whilst the machine simultaneously feeds back information that aids the operators' decision-making process.

* Models interactive views
* Connects to data-sources of any kind (DTO, Bean, JVM object, etc.)
* Nests different kinds of layouts to a complex surface (horizontal, vertical, form, grid)
* Adds components to layouts (buttons, text-fields, tables, images, etc.)
* Binds components to properties of data-sources
* Rule-based visibility processor
* Navigation widgets for small geometry mobile devices

=== Dialog ===

The dialog is a composite UI which is composed by either an automatically generated UI or a UI created with means of the UI DSL and actions that are available through a toolbar. It also can be combined with an instance of State-Machine DSL if a sophisticated control over the visibility of components and a definable usage-sequence is needed.

* Renders interactive views
* Either references a predefined UI model or a model inferred from a DTO
* Links the view to a toolbar
* Renders different modes
** Normal, to be used inside perspectives
** Embedded, to be used inside menues
** Stateful, inside perspectives, and controlled by a state-machine
** Mobile, to be used on small geometry mobile devices with navigation widgets
* Renders in 1 to N columns of components
* Groups components by using entity metadata
* Renders owning relationships as combo-boxes
* Renders member relationships as tables on tab-sheets
* Implements blob up- and downloading

=== Perspective ===

A perspective is a visual container for a set of views (parts). These parts exist wholly within the perspective and are not shared. A perspective is also like a page within a book. It exists within a window along with any number of other perspectives and, like a page within a book, only one perspective is visible at any time.

* Based on the Eclipse 4 application model
* Presents a 360° view on the task to the user
* Divides the usable screen area in resizable containers
* Nests windows, perspective-stacks, perspectives, containers, part-stacks and parts containing views, and toolbars
* Stores and retrieves resized areas for each user
* Supports drag and drop
* Event dispatching system to synchronize data, actions, focus and more between views
* References all types of views (dialogs, tables, charts, reports …) to set up a dashboard
* Modifiable layout at runtime using the designer mode for permitted users
* Connects to user tasks of BPM

=== Action ===

A toolbar is a set of icons or buttons that are part of a software program's interface or an open window. A toolbar item is an object type that associates a command with a toolbar. This association places an icon on the toolbar in a specific location relative to the other toolbar icons on that toolbar. A command is linked to a specific action and can have a keyboard shortcut specification.

* Links action-buttons
** To business logic of Function-Library to be executed
*** Synchronously
*** Asynchronously as background process
** To Data-Interchange import- or export tasks
** To BPM start events
** To actions to trigger
*** Save, delete, download, print etc.
*** Advance focus to next or previous part
* Links action-buttons to business logic of Function-Library to be
** Enabled
** Disabled depending on data context
* Defines commands to control the application and trigger actions
* Assigns keyboard short-cuts to commands
* Connects to Message for fail or success messages about executed actions

=== Menu ===

A menu is a list of options or commands presented to the user of OS.bee. A menu appears as a tree structure if the popup button besides the user-image is pressed. It is the user-specific point of entry into the OS.bee system. The user menu contains only those items that are needed to perform daily tasks.

* Combines Perspectives, BPM start events, embedded dialogs and tables, configuration settings and other informative screens to a tree-organized menu
* Pops up anytime it is needed, and consumes no space on the screen

=== Message ===

Messages can be defined to improve the user experience as guidance through complex user interactions with the system. For security and monitoring reasons they can be logged.

* Defines messages to notify a user about events and usage violations
* Can be tracked by log entries
* Placeholders for parametrizing messages
* Can have a severity

== Security ==

Security's mission is to protect the companies and their assets (know-how, company data, personal and customer data and personal data, etc.) from hackers, crackers and robbers, and economic damage caused by breaches of confidentiality, manipulation, hardware failure and availability prevent the systems.

=== Authorization ===

Authorization is a security mechanism to determine access levels and user privileges related to system resources including files, services, data and application features. This is the process of granting or denying access to a resource which allows the user access to various resources based on the user's identity.

* Role-based authorization system
* Grant access to entities, beans and DTO
* Grant access to CRUD operations (create, read, update, delete)
* Grant access to modification of relationships (link, unlink references)
* Vetoes per attribute for visibility, editability and enabling
* Grant access to start a process
* Grant access working on a user task

=== Organization ===

An organization is an entity comprising multiple people, such as an institution or an association that has a collective goal and is linked to an external environment. Its design specifies how goals are subdivided and reflected in subdivisions of the organization. An organization can be visualized in an organigram.

* Hierarchies of positions, multi-positions, and sub-organizations
* Maps roles to positions
* Definition of levels of collaboration if sharing the same roles
* Derives an organigram of each hierarchy to be rendered at runtime

= Services =

== Authentication ==

Authentication is a process that ensures and confirms a user’s identity. To do so, a user needs to provide some sort of proof of identity that the system understands and trust. There are multiple ways (realms) to do this:

* Security specific data access object, software component that talks to a backend data source.
* If you have usernames and password in LDAP, then you would have an LDAP Realm that would communicate with LDAP.
* Active Directory
* Kerberos

More features:* Remember-me
* Forgot password
* Protection against brute-force attacks
* MD5 salted and encrypted passwords
* Protection against debugging
* First commissioning support
* Session management
* Simple Single Sign-On (SSO)
* AES 128 encrypted cookie support

== Persistence ==

Persistence service enabling small data-sources as well as large-scale installations:* XA data-source support for distributed transactions
* Built in global transaction manager
* JNDI Service
* Built in support for local databases
* Supports database providers from Application Server implementations like WebSphere or WebLogic Server
* Provides JDBC and catalog data for Mondrian
* Supports all compatible databases to EclipseLink like:
** Oracle
** Oracle JDBC
** MySQL
** PostgreSQL
** Derby
** DB2
** DB2 (mainframe)
** Microsoft SQL Server
** Sybase
** Informix
** SQL Anywhere
** HSQL
** SAP HANA
** H2
** Firebird
** Microsoft Access
** Attunity
** Cloudscape
** DBase
** PointBase
** TimesTen
** Symfoware
** MaxDB

== Translation ==

There is a centralized translation service in OS.bee. It collects all property files from models created by a DSL and supplies all internal translations that the Software Factory needs. The number of supported languages is unlimited; however the internal translations deployed for the moment are limited to English, French, and German. More languages can be ordered. In case a translation key occurs multiple times, the “best” translation for this key is automatically selected. The “best” translation is evaluated by the maximum Levinshtein distance from the translation key.

== Metadata ==

OS.bee holds all model-data at runtime so that all programs can reference them. Renderers that do not need code will interpret these model to do their work. So even in the Function-Library it is possible to take the current modeling into account.

== Theme Resources and CSS ==

As usual for web-frontend applications, cascaded style sheets describe the look and feel. Custom CSS can be loaded from outside, or any modification can be made once the appropriate bundle is downloaded. CSS is compiled from a SCCS template with a pre-processor. The advantage of using SCSS is that you can use variables and therefore create different looks with just a hand-full of variables. OS.bee comes with 3 different theme variants that can be selected in the user profile. Resources like images, html pages and icons are available per theme and thus adjustable to the used color scheme.

OS.bee Software Factory Unique Selling Propositions

2019-01-29T07:53:29Z

Riegel:

= What is OS.bee about? =

OS.bee is a low-code model-driven software-factory, using over 20 Domain Specific Languages (DSL) to generate large-scale business web-applications. Each DSL contains a grammar for a required application-layer. A DSL hides complexity from successors, thereby enabling parallel modelling of domain requirements by multiple designers as they don’t need to know the domain logic they build upon. A model created with a DSL creates executable code, structured data and configuration settings or is interpreted by a renderer during runtime. The language of each DSL uses a grammar that makes the created model easy to understand and forms a requirement specification on its layer. The overall hierarchy can be browsed through at any time and gives a good understanding of the whole application in nearly natural English language. A DSL can also be studied by its syntactical graph. The creation of a model is a guided process through the syntax graph where the designer benefits from content assistance, code completion, quick fix, syntax colorizing, outline, formatting and validation. Many DSLs define metadata to be used by subsequent DSL to increase the leverage of definitions at a basic level. All element names defined by a DSL are automatically extracted to localization files for translation to open foreign markets for the resulting application. The ratio between the generated lines of code versus the numbers of lines in a model is about 8-10. Development speed improves by a similar factor. Dependencies between models reveal inconsistencies immediately while modifying and prevent generating code until these are resolved. Therefore turnaround cycles are short, errors are easy to discover and prototypes materialize in a very short time. Some DSL generate against famous open-source frameworks like EclipseLink, Smooks, Mondrian, Vaadin or jBPM thus enabling non-developers to use complex frameworks without deeper knowledge of their API. OS.bee inherits the features of the embedded frameworks and makes them easy to exploit for specialists of a domain not necessarily being software developer.

= Why using OS.bee? =
* You need a lot of unexpensive workstations for your employees.
* Work has to be done from everywhere, worldwide, in any language.
* Deployment of new versions shall be simple and be done at a single point to keep IT-costs at a minimum.
* Downtimes for updates or sandbox trials are undesired.
* You want to scale your software effortless as you do with your business in means of functionality and security.
* You want a hierachically consistent and validated application any time, no matter what was just modified.
* You dislike vendor lock-in.
* Investments in software should be long-term decisions.
* You know that software never is a stand-alone solution, instead it must deeply integrate with existing solutions, machines and protocols.
* The Internet of Things is not just a verbal formula to you, you ought to use it.
* You know best about your business and want to be enabled to implement that knowledge by yourself in your software.
* You want that continuous improvement for applications shall be unexpensive.
* Open Source software is an advantage to you, not a risk.
* The software architecture should fulfill all state of the art design patterns and conform to object oriented design principles in order to be open to changes.
* It should be possible to hire software specialists all over the world needing a minimum of training on your software if it becomes necessary.
* Fast solutions to your business problems is your biggest concern.
* The software you use shall be fault tolerant and self-controlling.
* The business processes implemented in your software shall use standardized notations and be automatic, cooperative, save and easy to learn and modify.
* You know that enforcing business rules in your company is a success factor.
* On the other hand, your employees must feel comfortable with the software they use.
* It is quite clear to you that mature capabilities in all departments of your company can only be achieved through measurement and analysis and agile change management for business processs.
* If you need support, you can get it anytime. 24/7 by experts, from a forum, by examples and videos.

= DSL Modeling =

== Persistence ==

Persistence refers to object and process characteristics that continue to exist even after the process that created it ceases or the machine it is running on is powered off. When an object or state is created and needs to be persistent, it is saved in a non-volatile storage location, like a hard drive, versus a temporary file or volatile random access memory.

=== Data-type ===

A data type is a classification that specifies which type of value a variable has and what type of mathematical, relational or logical operations can be applied to it without causing an error. Data types also hold metadata for higher-level DSLs so they can apply additional functionality to a field using this data type.

* Primitive Types (int, double, etc.)
* Object Types (String, Date, etc.)
* Blob
** Store and retrieve any document or image type in binary form
* Auto-sizing Images
** Additionally stores images of definable size to experience better performance while rendering
* Formatted types
** Dates and times in any localized form
** Dates and times in any format (time only, date only, short and long forms, custom pattern, etc.)
** Currencies in any localized form
* Validated types with adjustable severity message
** Date in past/future
** Not null
** Not duplicate
** Range values
** Min/max length
* Slider types
** Min/max values
* Masked types
** Number, Hexadecimal, Capitalized
** Input pattern (e.g. Phone Numbers (###) ###-####)
** Password
* Suggestion types
** While typing some characters, a sorted list of suggestions pops up for selection
* Programmable Converters
** Text-to-Image
** Number-to-Text/Image
** Value-to-CSS Style
** Units of measurement
* Rich text editor using HTML markups
* Text area

=== Entity ===

An entity (-type) is a model of metadata for a single unique object in the real world. For example a person, organization, object type, or concept about which information is stored. Together with its attributes (or properties) it describes information that is being mastered. An entity typically corresponds to one or several related tables in database. An attribute is a characteristic or trait of an entity that describes the entity, for example, the Person entity type has the Date of Birth attribute.

* Simple Entity
* Mapped super-classes
** Complement attributes in every entity using this
* Inheritance
** Specialized classes for special purpose
* References and their opposites
* References with constraints
* Embeddable beans
* Number generators UUID or ID
* Separated persistence-units capable of using multiple databases simultaneously
* All multiplicities (0..1, 0..n,1..1,1..n,*)
* Indexes unique and non-unique
* Validated uniqueness
* Domain-key annotation for lookups
* Methods for calculated attributes
* Lifecycle controlled method invoking (by PostLoad, PrePersist, etc.)
* Affected changes listeners
* Localizable Enumerations with images
* Creation and last modification information
* Transient data
* Synthetic attributes built by lifecycle methods either transient or persistent
* Historicized data
* Temporal data
* Versioned data
* Definable Runtime data filter
* Programmable Validators
* Nested Filter attributions over multiple references
* Abstraction of database vendor specific implementations

=== Data transfer object (DTO) ===

A DTO is an object that carries data between processes. DTOs are simple objects that do not contain any business logic but may contain serialization and deserialization mechanisms for transferring data.

* Independent nested data container
* Automatically generated for entities
* Automatically mapped by entity data
* Editable sub- or supersets for entities
* Transient data container
* Nested objects automatically synchronized
* Nested properties access through dot expressions
* Used for services, processes, functions and renderers
* Dirty state aware
* Access restrictions on DTO and property granularity controlled by security layer

=== DTO Service ===

A DTO service abstracts and encapsulates all access to the data source. It manages the connection with the data source to obtain and store data and implements the access mechanism required to work with the data source. The data source could be a persistent store like an RDBMS, or a business service accessed via REST or SOAP.

* Data storage and retrieval suitable for DTO
* Nested Transactions and Lock-modes
* Global transactions
* Object Oriented Query engine
* Low level Java Persistence Query Language method declarations (e.g. getTotal(), getAverage(), …)
* Injectable and declarative service
* Used for services, processes, functions and renderers
* Session scoped Entity Manager
* Thread safe persistence-unit bound Entity Manager Factory

=== Data-Interchange ===

Data Interchange is the endpoint-to-endpoint exchange of business documents in a standard electronic format between business partners or computer systems.

* Smooks and FreeMarker implementation
* Nested entity import- and export-paths
* Localized formatters on data
* Supports encoding
* XML and CSV formats
* All EDI messages
* Automatically set export- and import markers for database
* Filtered exports
* Bulk insert/update
* Progress bar
* Generated import and export dashboard
* Generated lookup queries to embed relational data
* Merge or persist external data
* Import images of different mime-types into blobs via filename pattern
* Usage of expressions
* Free attribute mappings

=== Signal ===

Signal processes events coming from file-systems. If a file that matches a given filename pattern is created, modified or deleted then an event is received and the modelled actions will be called. Signal also emits events for recurring things like a certain weekday and time is reached and executes the modelled actions.

* File watcher for all file activities working on all operating systems
* Free filename pattern to watch for

* Trigger Data-Interchange
* Definable export or import job-chain
* Synchronously or asynchronously execution (depending on import relationship)
* Quartz implementation for scheduled Data-Interchange export-jobs

=== Entity-Mock ===

Mock objects are simulated objects that mimic the behavior of real objects in controlled ways. A programmer typically creates a mock object to test the behavior of some other object, in much the same way that a car designer uses a crash test dummy to simulate the dynamic behavior of a human in vehicle impacts.

* Generates fake data looking realistic

* Mapping of roles to positions and multi-positions

* Rule-based data composition (e.g. email address)
* Rule-based attribute generators for every data-type from data composition, or
** Randomly
** Ranges
** Picks from a given list
** Dates in the past with offset and limit (for birthdays)
** Dates in the future with offset and limit
* Composes objects from rule-based attribute generators (e.g. a person, a company, etc.)
* Composes object-trees from composed objects
* Creates relationships between objects using a given probability
* Creates mass data (e.g. sales data)
* Imports fixed data via Data-Interchange and embeds it
* Used mainly for quick-setup applications using a H2 database
* Exposes mock data services to be executed before any login-attempt
* Persists into all supported database products
* Can be executed at every server-start or once

== Business intelligence ==

Business Intelligence (BI) refers to technologies, applications and practices for the collection, integration, analysis, and presentation of business information. The purpose of Business Intelligence is to support better business decision making. Essentially, Business Intelligence systems are data-driven Decision Support Systems (DSS). Business Intelligence is sometimes used interchangeably with briefing books, report and query tools and executive information systems.

=== Cube ===

A cube is a method of storing data in a multidimensional form, generally for reporting purposes. In cubes, data (measures) are categorized by dimensions. Cubes are pre-summarized across dimensions to drastically improve query time over relational databases. The query language used to interact and perform tasks with cubes is multidimensional expressions (MDX).

* Mondrian OLAP for MDX queries implementation
* Cubes, dimensions, hierarchies, levels, members, and measures
* Defines a multi-dimensional database
* Contains a logical model, and a mapping of this model onto the physical entity model

=== DataMart ===

A data mart is a subject-oriented archive that stores data and uses the retrieved set of information to assist and support the requirements involved within a particular business function or department. Data marts improve end-user response time by allowing users to have access to the specific type of data they need to view most often by providing the data in a way that supports the collective view of a group of users.

* Common layer for data-warehouse queries
* Simplification of any kind of query against all available data sources
* Tailored queries and aggregates for different interest-groups
* Definition of complex multidimensional expressions (MDX) with a simple grammar
* Sophisticated analytic functions easy to use
* Online analytical processing built in
* Access to runtime data of the Business Process management engine
* Multi-purpose results for processes, reports, score cards and charts
* Definable navigation trees (join-paths)
* Definable single- and multi-selection filters on any leaf of the query tree
* Access restrictions on entity and attribute granularity controlled by security layer

=== Function-Library ===

A function-library is a collection of non-volatile resources used by other DSLs. It is a collection of implementations of behavior, written in Xbase, which has a well-defined interface by which the behavior is invoked. Library code is organized in such a way that it can be used by multiple programs that have no connection to each other, in other words it is completely independent of the calling logic.

* Xbase implementation
* UOMo implementation
* Creates operational objects and methods
* Grouped by application field
** Converter for model-presentation conversions
*** Value to image
*** Value to value
*** Value to style (background color, text color, font-style, etc.)
*** Value to unit of measurement based value
*** Between measurement systems and unit of measurement families
** State-Machine
*** Operations
*** Functions
*** Guards
*** Full access to state-machine controls
** Toolbar Action
*** Can execute validation (enable/disable operation)
*** Execute any operation
** Validation on DTO
** Business logic implementation for BPM
*** Functions callable in system tasks
*** Ratings for gateways
*** Tests for gateways
** Calculations e.g. for
*** Currencies
*** Lengths
*** Areas
** Posting operations
* Exposes injectable and declarative service
* Store and retrieve data from DTO
* Full access to all JVM objects

=== State-Machine ===

A finite-state machine (FSM) is a mathematical model of computation. It is an abstract machine that can be in exactly one of a finite number of states at any given time. The FSM can change from one state to another in response to an event. The change from one state to another is called a transition. An FSM is defined by a list of its states, its initial state, and the conditions for each transition. These conditions are called guards as they guard the transition from unwanted invocation.

* Implementation of business behavior
* Defines states and their transitions
* Transitions are triggered by events
* Transitions are guarded by functions from Function-Library
* Actions to be executed before and after transitioning from Function-Library
* Has things to control
** Database objects (DTO)
** Database filters
** Visibility or enabling of
*** Buttons (UI)
*** Layouts (UI)
*** Other components (UI)
** Peripheral devices (interfaces JavaPOS)
*** Printers
*** Line displays
*** Cash drawers
*** Payment terminals
*** Signature pads
** Slave browsers (external displays, etc.)
* Receives events from
** Buttons clicked
** UI selections
** Peripherals (printer out of paper, etc.)
** Schedulers

=== BLiP (Business Logic implementation Platform) ===

BLiP focuses on improving corporate performance by managing business processes (BPM), business rules and business logic (Function-Library).  It is a disciplined approach to identify, design, execute, document, measure, monitor, and control both automated and non-automated business processes to achieve consistent, targeted results aligned with an organization’s strategic goals. BPM involves the deliberate and collaborative definition, improvement, innovation, and management of end-to-end business processes that drive business results, create value, and enable an organization to meet its business objectives with more agility. BPM enables an enterprise to align its business processes to its business strategy, leading to effective overall company performance through improvements of specific work activities either within a specific department, across the enterprise, or between organizations.

* Implements jBPM
* Integrates a BPMN editor at design-time
* Connects tasks of BPM to business logic of Function-Library
* Controls sequence-flow through business logic of Function-Library
* Stores and retrieves process save-points
* Logs all process activities of system and user
* Exposes BPM data and events to UI elements
* Stores and retrieves workload data using DTO

== Presentation ==

The presentation layer ensures that the communications that pass through it are in the appropriate form for the recipient application. It is responsible for the delivery and formatting of information to the application layer for further processing or display. It relieves the application layer of concern regarding syntactical differences in data representation within the end-user systems.

=== Table ===

A table is a data structure that organizes information into rows and columns. It can be used to both store and display data in a structured format.

* Editable cells
* Scorecard elements
** Rule-based colorizing of cell background and textcolor
** Mixed in rule-based icons
** Rule-based styling of cells
** Rule-based tooltips
* Data from DataMart or DTO
* Pivot presentation
* Multidimensional presentation on nested tab-sheets
* Filtering, sorting, swapping and hiding of columns
* Stores swapping and hiding per user
* 3 different row numbering modes
* Row selection synchronizes other views in scope

=== Chart ===

A chart is a diagram, picture, or graph which is intended to make information easier to understand. It is a symbolic representation of information according to some visualization technique.

* Multiple data series with selectable colorizing
* Series switchable from legend
* Bar, line, pie, donut, bubble and gauge presentation
* Animated, stacked, shaded and xy-swapped charts
* Zoom and trend-line function
* Tooltips for series and data points with absolute value
* Selectable positioning relative to cursor for tooltips
* Selectable legend placement
* Collapsible tree presentation on hierarchical data
* Date axes with customizable formatting
* Up to 9 individually scalable Y axes
* Rotated axis text
* Category rendering either linear, logarithmic, timeline or as pyramid
* Downloadable SVG image

=== Report ===

A document containing information organized in a graphic or tabular form, prepared on ad hoc, periodic, recurring, regular, or as required basis. Reports may refer to specific periods, events, occurrences, or subjects, and are presented in printed form.

* Actuate Birt implementation
* Definition of reusable layout metadata
** All units of measurement for layouts
** Definition of fonts and colors
** Definition of formatters for
*** Currencies
*** Date and time
** Page sizes (A4, A5, etc.)
** Orientations (Landscape, portrait)
** Margins
** Paddings
** Alignments
* Output as HTML or PDF
* Ability to reference multiple DataMarts for header, footer and details
* Rendering of blob-images
* External CSS usable
* Defines grids and cells
* Direct printing to preselected output medias per user or per location and report
* Rule-based visibility of cells
* Aggregates for grouping
* Rule-based page break
* Rule-based colorizing and styling
* URL-based or embedded images
* Auto-texts (page number etc.)

=== Topology ===

Topology is designed for representing simple geographical features, along with their non-spatial attributes. It includes geo-json points (addresses and locations), line strings (streets, highways and boundaries), polygons (countries, provinces, tracts of land), and multi-part collections of these types.

* D3 implementation
* Render predefined maps of U.S.A., Germany, Spain… the World
* Select states, countries, regions or cities to synchronize other views in scope
* Render geo-json data from blobs to show boundaries of plots of land, buildings or floor plans

=== UI ===

The user interface (UI) is the space where interactions between humans and OS.bee occur. The goal of this interaction is to allow effective operation and control of the machine from the human end, whilst the machine simultaneously feeds back information that aids the operators' decision-making process.

* Models interactive views
* Connects to data-sources of any kind (DTO, Bean, JVM object, etc.)
* Nests different kinds of layouts to a complex surface (horizontal, vertical, form, grid)
* Adds components to layouts (buttons, text-fields, tables, images, etc.)
* Binds components to properties of data-sources
* Rule-based visibility processor
* Navigation widgets for small geometry mobile devices

=== Dialog ===

The dialog is a composite UI which is composed by either an automatically generated UI or a UI created with means of the UI DSL and actions that are available through a toolbar. It also can be combined with an instance of State-Machine DSL if a sophisticated control over the visibility of components and a definable usage-sequence is needed.

* Renders interactive views
* Either references a predefined UI model or a model inferred from a DTO
* Links the view to a toolbar
* Renders different modes
** Normal, to be used inside perspectives
** Embedded, to be used inside menues
** Stateful, inside perspectives, and controlled by a state-machine
** Mobile, to be used on small geometry mobile devices with navigation widgets
* Renders in 1 to N columns of components
* Groups components by using entity metadata
* Renders owning relationships as combo-boxes
* Renders member relationships as tables on tab-sheets
* Implements blob up- and downloading

=== Perspective ===

A perspective is a visual container for a set of views (parts). These parts exist wholly within the perspective and are not shared. A perspective is also like a page within a book. It exists within a window along with any number of other perspectives and, like a page within a book, only one perspective is visible at any time.

* Based on the Eclipse 4 application model
* Presents a 360° view on the task to the user
* Divides the usable screen area in resizable containers
* Nests windows, perspective-stacks, perspectives, containers, part-stacks and parts containing views, and toolbars
* Stores and retrieves resized areas for each user
* Supports drag and drop
* Event dispatching system to synchronize data, actions, focus and more between views
* References all types of views (dialogs, tables, charts, reports …) to set up a dashboard
* Modifiable layout at runtime using the designer mode for permitted users
* Connects to user tasks of BPM

=== Action ===

A toolbar is a set of icons or buttons that are part of a software program's interface or an open window. A toolbar item is an object type that associates a command with a toolbar. This association places an icon on the toolbar in a specific location relative to the other toolbar icons on that toolbar. A command is linked to a specific action and can have a keyboard shortcut specification.

* Links action-buttons
** To business logic of Function-Library to be executed
*** Synchronously
*** Asynchronously as background process
** To Data-Interchange import- or export tasks
** To BPM start events
** To actions to trigger
*** Save, delete, download, print etc.
*** Advance focus to next or previous part
* Links action-buttons to business logic of Function-Library to be
** Enabled
** Disabled depending on data context
* Defines commands to control the application and trigger actions
* Assigns keyboard short-cuts to commands
* Connects to Message for fail or success messages about executed actions

=== Menu ===

A menu is a list of options or commands presented to the user of OS.bee. A menu appears as a tree structure if the popup button besides the user-image is pressed. It is the user-specific point of entry into the OS.bee system. The user menu contains only those items that are needed to perform daily tasks.

* Combines Perspectives, BPM start events, embedded dialogs and tables, configuration settings and other informative screens to a tree-organized menu
* Pops up anytime it is needed, and consumes no space on the screen

=== Message ===

Messages can be defined to improve the user experience as guidance through complex user interactions with the system. For security and monitoring reasons they can be logged.

* Defines messages to notify a user about events and usage violations
* Can be tracked by log entries
* Placeholders for parametrizing messages
* Can have a severity

== Security ==

Security's mission is to protect the companies and their assets (know-how, company data, personal and customer data and personal data, etc.) from hackers, crackers and robbers, and economic damage caused by breaches of confidentiality, manipulation, hardware failure and availability prevent the systems.

=== Authorization ===

Authorization is a security mechanism to determine access levels and user privileges related to system resources including files, services, data and application features. This is the process of granting or denying access to a resource which allows the user access to various resources based on the user's identity.

* Role-based authorization system
* Grant access to entities, beans and DTO
* Grant access to CRUD operations (create, read, update, delete)
* Grant access to modification of relationships (link, unlink references)
* Vetoes per attribute for visibility, editability and enabling
* Grant access to start a process
* Grant access working on a user task

=== Organization ===

An organization is an entity comprising multiple people, such as an institution or an association that has a collective goal and is linked to an external environment. Its design specifies how goals are subdivided and reflected in subdivisions of the organization. An organization can be visualized in an organigram.

* Hierarchies of positions, multi-positions, and sub-organizations
* Maps roles to positions
* Definition of levels of collaboration if sharing the same roles
* Derives an organigram of each hierarchy to be rendered at runtime

= Services =

== Authentication ==

Authentication is a process that ensures and confirms a user’s identity. To do so, a user needs to provide some sort of proof of identity that the system understands and trust. There are multiple ways (realms) to do this:

* Security specific data access object, software component that talks to a backend data source.
* If you have usernames and password in LDAP, then you would have an LDAP Realm that would communicate with LDAP.
* Active Directory
* Kerberos

More features:* Remember-me
* Forgot password
* Protection against brute-force attacks
* MD5 salted and encrypted passwords
* Protection against debugging
* First commissioning support
* Session management
* Simple Single Sign-On (SSO)
* AES 128 encrypted cookie support

== Persistence ==

Persistence service enabling small data-sources as well as large-scale installations:* XA data-source support for distributed transactions
* Built in global transaction manager
* JNDI Service
* Built in support for local databases
* Supports database providers from Application Server implementations like WebSphere or WebLogic Server
* Provides JDBC and catalog data for Mondrian
* Supports all compatible databases to EclipseLink like:
** Oracle
** Oracle JDBC
** MySQL
** PostgreSQL
** Derby
** DB2
** DB2 (mainframe)
** Microsoft SQL Server
** Sybase
** Informix
** SQL Anywhere
** HSQL
** SAP HANA
** H2
** Firebird
** Microsoft Access
** Attunity
** Cloudscape
** DBase
** PointBase
** TimesTen
** Symfoware
** MaxDB

== Translation ==

There is a centralized translation service in OS.bee. It collects all property files from models created by a DSL and supplies all internal translations that the Software Factory needs. The number of supported languages is unlimited; however the internal translations deployed for the moment are limited to English, French, and German. More languages can be ordered. In case a translation key occurs multiple times, the “best” translation for this key is automatically selected. The “best” translation is evaluated by the maximum Levinshtein distance from the translation key.

== Metadata ==

OS.bee holds all model-data at runtime so that all programs can reference them. Renderers that do not need code will interpret these model to do their work. So even in the Function-Library it is possible to take the current modeling into account.

== Theme Resources and CSS ==

As usual for web-frontend applications, cascaded style sheets describe the look and feel. Custom CSS can be loaded from outside, or any modification can be made once the appropriate bundle is downloaded. CSS is compiled from a SCCS template with a pre-processor. The advantage of using SCSS is that you can use variables and therefore create different looks with just a hand-full of variables. OS.bee comes with 3 different theme variants that can be selected in the user profile. Resources like images, html pages and icons are available per theme and thus adjustable to the used color scheme.

OS.bee Software Factory Unique Selling Propositions

2019-01-28T12:24:34Z

Riegel:

= Abstract =

OS.bee is a low-code model-driven software-factory, using over 20 Domain Specific Languages (DSL) to generate large-scale business web-applications. Each DSL contains a grammar for a required application-layer. A DSL hides complexity from successors, thereby enabling parallel modelling of domain requirements by multiple designers as they don’t need to know the domain logic they build upon. A model created with a DSL creates executable code, structured data and configuration settings or is interpreted by a renderer during runtime. The language of each DSL uses a grammar that makes the created model easy to understand and forms a requirement specification on its layer. The overall hierarchy can be browsed through at any time and gives a good understanding of the whole application in nearly natural English language. A DSL can also be studied by its syntactical graph. The creation of a model is a guided process through the syntax graph where the designer benefits from content assistance, code completion, quick fix, syntax colorizing, outline, formatting and validation. Many DSLs define metadata to be used by subsequent DSL to increase the leverage of definitions at a basic level. All element names defined by a DSL are automatically extracted to localization files for translation to open foreign markets for the resulting application. The ratio between the generated lines of code versus the numbers of lines in a model is about 8-10. Development speed improves by a similar factor. Dependencies between models reveal inconsistencies immediately while modifying and prevent generating code until these are resolved. Therefore turnaround cycles are short, errors are easy to discover and prototypes materialize in a very short time. Some DSL generate against famous open-source frameworks like EclipseLink, Smooks, Mondrian, Vaadin or jBPM thus enabling non-developers to use complex frameworks without deeper knowledge of their API. OS.bee inherits the features of the embedded frameworks and makes them easy to exploit for specialists of a domain not necessarily being software developer.

= Why OS.bee? =
== If most of these points apply to you, you should chose OS.bee ==
* You need to have a lot of cheap workstations for your employees.
* Work has to be done from everywhere, worldwide, in any language.
* Deployment of new versions shall be simple and be done at a single point to keep IT-costs at a minimum.
* Downtimes for updates or sandbox trials are undesired.
* You want to scale your software effortless as you do with your business in means of functionality and security.
* The software architecture should fulfill all state of the art design patterns and conform to object oriented design principles.
* You want a hierachically consistent and validated software architecure any time, no matter what was modified.
* You dislike vendor lock-in.
* Investments in software should be long-term decisions.
* You know best about your business and want to implement that knowledge by yourself in your software.
* You want that continuous improvement for software shall be cheap.
* Open Source is an advantage to you, not a challenge.
* It should be possible to hire software specialists all over the world needing a minimum of training on your software if it becomes necessary.
* Fast solutions to your business problems is your biggest concern.
* The software you use shall be fault tolerant and self-controlling.
* The business processes implemented in your software shall use standardized notations and be automatic, cooperative, save and easy to learn and modify.
* You know that enforcing business rules in your company is a success factor.
* If you need support, you can get it anytime. 24/7 by experts, from a forum, by examples and videos.

= DSL Modeling =

== Persistence ==

Persistence refers to object and process characteristics that continue to exist even after the process that created it ceases or the machine it is running on is powered off. When an object or state is created and needs to be persistent, it is saved in a non-volatile storage location, like a hard drive, versus a temporary file or volatile random access memory.

=== Data-type ===

A data type is a classification that specifies which type of value a variable has and what type of mathematical, relational or logical operations can be applied to it without causing an error. Data types also hold metadata for higher-level DSLs so they can apply additional functionality to a field using this data type.

* Primitive Types (int, double, etc.)
* Object Types (String, Date, etc.)
* Blob
** Store and retrieve any document or image type in binary form
* Auto-sizing Images
** Additionally stores images of definable size to experience better performance while rendering
* Formatted types
** Dates and times in any localized form
** Dates and times in any format (time only, date only, short and long forms, custom pattern, etc.)
** Currencies in any localized form
* Validated types with adjustable severity message
** Date in past/future
** Not null
** Not duplicate
** Range values
** Min/max length
* Slider types
** Min/max values
* Masked types
** Number, Hexadecimal, Capitalized
** Input pattern (e.g. Phone Numbers (###) ###-####)
** Password
* Suggestion types
** While typing some characters, a sorted list of suggestions pops up for selection
* Programmable Converters
** Text-to-Image
** Number-to-Text/Image
** Value-to-CSS Style
** Units of measurement
* Rich text editor using HTML markups
* Text area

=== Entity ===

An entity (-type) is a model of metadata for a single unique object in the real world. For example a person, organization, object type, or concept about which information is stored. Together with its attributes (or properties) it describes information that is being mastered. An entity typically corresponds to one or several related tables in database. An attribute is a characteristic or trait of an entity that describes the entity, for example, the Person entity type has the Date of Birth attribute.

* Simple Entity
* Mapped super-classes
** Complement attributes in every entity using this
* Inheritance
** Specialized classes for special purpose
* References and their opposites
* References with constraints
* Embeddable beans
* Number generators UUID or ID
* Separated persistence-units capable of using multiple databases simultaneously
* All multiplicities (0..1, 0..n,1..1,1..n,*)
* Indexes unique and non-unique
* Validated uniqueness
* Domain-key annotation for lookups
* Methods for calculated attributes
* Lifecycle controlled method invoking (by PostLoad, PrePersist, etc.)
* Affected changes listeners
* Localizable Enumerations with images
* Creation and last modification information
* Transient data
* Synthetic attributes built by lifecycle methods either transient or persistent
* Historicized data
* Temporal data
* Versioned data
* Definable Runtime data filter
* Programmable Validators
* Nested Filter attributions over multiple references
* Abstraction of database vendor specific implementations

=== Data transfer object (DTO) ===

A DTO is an object that carries data between processes. DTOs are simple objects that do not contain any business logic but may contain serialization and deserialization mechanisms for transferring data.

* Independent nested data container
* Automatically generated for entities
* Automatically mapped by entity data
* Editable sub- or supersets for entities
* Transient data container
* Nested objects automatically synchronized
* Nested properties access through dot expressions
* Used for services, processes, functions and renderers
* Dirty state aware
* Access restrictions on DTO and property granularity controlled by security layer

=== DTO Service ===

A DTO service abstracts and encapsulates all access to the data source. It manages the connection with the data source to obtain and store data and implements the access mechanism required to work with the data source. The data source could be a persistent store like an RDBMS, or a business service accessed via REST or SOAP.

* Data storage and retrieval suitable for DTO
* Nested Transactions and Lock-modes
* Global transactions
* Object Oriented Query engine
* Low level Java Persistence Query Language method declarations (e.g. getTotal(), getAverage(), …)
* Injectable and declarative service
* Used for services, processes, functions and renderers
* Session scoped Entity Manager
* Thread safe persistence-unit bound Entity Manager Factory

=== Data-Interchange ===

Data Interchange is the endpoint-to-endpoint exchange of business documents in a standard electronic format between business partners or computer systems.

* Smooks and FreeMarker implementation
* Nested entity import- and export-paths
* Localized formatters on data
* Supports encoding
* XML and CSV formats
* All EDI messages
* Automatically set export- and import markers for database
* Filtered exports
* Bulk insert/update
* Progress bar
* Generated import and export dashboard
* Generated lookup queries to embed relational data
* Merge or persist external data
* Import images of different mime-types into blobs via filename pattern
* Usage of expressions
* Free attribute mappings

=== Signal ===

Signal processes events coming from file-systems. If a file that matches a given filename pattern is created, modified or deleted then an event is received and the modelled actions will be called. Signal also emits events for recurring things like a certain weekday and time is reached and executes the modelled actions.

* File watcher for all file activities working on all operating systems
* Free filename pattern to watch for

* Trigger Data-Interchange
* Definable export or import job-chain
* Synchronously or asynchronously execution (depending on import relationship)
* Quartz implementation for scheduled Data-Interchange export-jobs

=== Entity-Mock ===

Mock objects are simulated objects that mimic the behavior of real objects in controlled ways. A programmer typically creates a mock object to test the behavior of some other object, in much the same way that a car designer uses a crash test dummy to simulate the dynamic behavior of a human in vehicle impacts.

* Generates fake data looking realistic

* Mapping of roles to positions and multi-positions

* Rule-based data composition (e.g. email address)
* Rule-based attribute generators for every data-type from data composition, or
** Randomly
** Ranges
** Picks from a given list
** Dates in the past with offset and limit (for birthdays)
** Dates in the future with offset and limit
* Composes objects from rule-based attribute generators (e.g. a person, a company, etc.)
* Composes object-trees from composed objects
* Creates relationships between objects using a given probability
* Creates mass data (e.g. sales data)
* Imports fixed data via Data-Interchange and embeds it
* Used mainly for quick-setup applications using a H2 database
* Exposes mock data services to be executed before any login-attempt
* Persists into all supported database products
* Can be executed at every server-start or once

== Business intelligence ==

Business Intelligence (BI) refers to technologies, applications and practices for the collection, integration, analysis, and presentation of business information. The purpose of Business Intelligence is to support better business decision making. Essentially, Business Intelligence systems are data-driven Decision Support Systems (DSS). Business Intelligence is sometimes used interchangeably with briefing books, report and query tools and executive information systems.

=== Cube ===

A cube is a method of storing data in a multidimensional form, generally for reporting purposes. In cubes, data (measures) are categorized by dimensions. Cubes are pre-summarized across dimensions to drastically improve query time over relational databases. The query language used to interact and perform tasks with cubes is multidimensional expressions (MDX).

* Mondrian OLAP for MDX queries implementation
* Cubes, dimensions, hierarchies, levels, members, and measures
* Defines a multi-dimensional database
* Contains a logical model, and a mapping of this model onto the physical entity model

=== DataMart ===

A data mart is a subject-oriented archive that stores data and uses the retrieved set of information to assist and support the requirements involved within a particular business function or department. Data marts improve end-user response time by allowing users to have access to the specific type of data they need to view most often by providing the data in a way that supports the collective view of a group of users.

* Common layer for data-warehouse queries
* Simplification of any kind of query against all available data sources
* Tailored queries and aggregates for different interest-groups
* Definition of complex multidimensional expressions (MDX) with a simple grammar
* Sophisticated analytic functions easy to use
* Online analytical processing built in
* Access to runtime data of the Business Process management engine
* Multi-purpose results for processes, reports, score cards and charts
* Definable navigation trees (join-paths)
* Definable single- and multi-selection filters on any leaf of the query tree
* Access restrictions on entity and attribute granularity controlled by security layer

=== Function-Library ===

A function-library is a collection of non-volatile resources used by other DSLs. It is a collection of implementations of behavior, written in Xbase, which has a well-defined interface by which the behavior is invoked. Library code is organized in such a way that it can be used by multiple programs that have no connection to each other, in other words it is completely independent of the calling logic.

* Xbase implementation
* UOMo implementation
* Creates operational objects and methods
* Grouped by application field
** Converter for model-presentation conversions
*** Value to image
*** Value to value
*** Value to style (background color, text color, font-style, etc.)
*** Value to unit of measurement based value
*** Between measurement systems and unit of measurement families
** State-Machine
*** Operations
*** Functions
*** Guards
*** Full access to state-machine controls
** Toolbar Action
*** Can execute validation (enable/disable operation)
*** Execute any operation
** Validation on DTO
** Business logic implementation for BPM
*** Functions callable in system tasks
*** Ratings for gateways
*** Tests for gateways
** Calculations e.g. for
*** Currencies
*** Lengths
*** Areas
** Posting operations
* Exposes injectable and declarative service
* Store and retrieve data from DTO
* Full access to all JVM objects

=== State-Machine ===

A finite-state machine (FSM) is a mathematical model of computation. It is an abstract machine that can be in exactly one of a finite number of states at any given time. The FSM can change from one state to another in response to an event. The change from one state to another is called a transition. An FSM is defined by a list of its states, its initial state, and the conditions for each transition. These conditions are called guards as they guard the transition from unwanted invocation.

* Implementation of business behavior
* Defines states and their transitions
* Transitions are triggered by events
* Transitions are guarded by functions from Function-Library
* Actions to be executed before and after transitioning from Function-Library
* Has things to control
** Database objects (DTO)
** Database filters
** Visibility or enabling of
*** Buttons (UI)
*** Layouts (UI)
*** Other components (UI)
** Peripheral devices (interfaces JavaPOS)
*** Printers
*** Line displays
*** Cash drawers
*** Payment terminals
*** Signature pads
** Slave browsers (external displays, etc.)
* Receives events from
** Buttons clicked
** UI selections
** Peripherals (printer out of paper, etc.)
** Schedulers

=== BLiP (Business Logic implementation Platform) ===

BLiP focuses on improving corporate performance by managing business processes (BPM), business rules and business logic (Function-Library).  It is a disciplined approach to identify, design, execute, document, measure, monitor, and control both automated and non-automated business processes to achieve consistent, targeted results aligned with an organization’s strategic goals. BPM involves the deliberate and collaborative definition, improvement, innovation, and management of end-to-end business processes that drive business results, create value, and enable an organization to meet its business objectives with more agility. BPM enables an enterprise to align its business processes to its business strategy, leading to effective overall company performance through improvements of specific work activities either within a specific department, across the enterprise, or between organizations.

* Implements jBPM
* Integrates a BPMN editor at design-time
* Connects tasks of BPM to business logic of Function-Library
* Controls sequence-flow through business logic of Function-Library
* Stores and retrieves process save-points
* Logs all process activities of system and user
* Exposes BPM data and events to UI elements
* Stores and retrieves workload data using DTO

== Presentation ==

The presentation layer ensures that the communications that pass through it are in the appropriate form for the recipient application. It is responsible for the delivery and formatting of information to the application layer for further processing or display. It relieves the application layer of concern regarding syntactical differences in data representation within the end-user systems.

=== Table ===

A table is a data structure that organizes information into rows and columns. It can be used to both store and display data in a structured format.

* Editable cells
* Scorecard elements
** Rule-based colorizing of cell background and textcolor
** Mixed in rule-based icons
** Rule-based styling of cells
** Rule-based tooltips
* Data from DataMart or DTO
* Pivot presentation
* Multidimensional presentation on nested tab-sheets
* Filtering, sorting, swapping and hiding of columns
* Stores swapping and hiding per user
* 3 different row numbering modes
* Row selection synchronizes other views in scope

=== Chart ===

A chart is a diagram, picture, or graph which is intended to make information easier to understand. It is a symbolic representation of information according to some visualization technique.

* Multiple data series with selectable colorizing
* Series switchable from legend
* Bar, line, pie, donut, bubble and gauge presentation
* Animated, stacked, shaded and xy-swapped charts
* Zoom and trend-line function
* Tooltips for series and data points with absolute value
* Selectable positioning relative to cursor for tooltips
* Selectable legend placement
* Collapsible tree presentation on hierarchical data
* Date axes with customizable formatting
* Up to 9 individually scalable Y axes
* Rotated axis text
* Category rendering either linear, logarithmic, timeline or as pyramid
* Downloadable SVG image

=== Report ===

A document containing information organized in a graphic or tabular form, prepared on ad hoc, periodic, recurring, regular, or as required basis. Reports may refer to specific periods, events, occurrences, or subjects, and are presented in printed form.

* Actuate Birt implementation
* Definition of reusable layout metadata
** All units of measurement for layouts
** Definition of fonts and colors
** Definition of formatters for
*** Currencies
*** Date and time
** Page sizes (A4, A5, etc.)
** Orientations (Landscape, portrait)
** Margins
** Paddings
** Alignments
* Output as HTML or PDF
* Ability to reference multiple DataMarts for header, footer and details
* Rendering of blob-images
* External CSS usable
* Defines grids and cells
* Direct printing to preselected output medias per user or per location and report
* Rule-based visibility of cells
* Aggregates for grouping
* Rule-based page break
* Rule-based colorizing and styling
* URL-based or embedded images
* Auto-texts (page number etc.)

=== Topology ===

Topology is designed for representing simple geographical features, along with their non-spatial attributes. It includes geo-json points (addresses and locations), line strings (streets, highways and boundaries), polygons (countries, provinces, tracts of land), and multi-part collections of these types.

* D3 implementation
* Render predefined maps of U.S.A., Germany, Spain… the World
* Select states, countries, regions or cities to synchronize other views in scope
* Render geo-json data from blobs to show boundaries of plots of land, buildings or floor plans

=== UI ===

The user interface (UI) is the space where interactions between humans and OS.bee occur. The goal of this interaction is to allow effective operation and control of the machine from the human end, whilst the machine simultaneously feeds back information that aids the operators' decision-making process.

* Models interactive views
* Connects to data-sources of any kind (DTO, Bean, JVM object, etc.)
* Nests different kinds of layouts to a complex surface (horizontal, vertical, form, grid)
* Adds components to layouts (buttons, text-fields, tables, images, etc.)
* Binds components to properties of data-sources
* Rule-based visibility processor
* Navigation widgets for small geometry mobile devices

=== Dialog ===

The dialog is a composite UI which is composed by either an automatically generated UI or a UI created with means of the UI DSL and actions that are available through a toolbar. It also can be combined with an instance of State-Machine DSL if a sophisticated control over the visibility of components and a definable usage-sequence is needed.

* Renders interactive views
* Either references a predefined UI model or a model inferred from a DTO
* Links the view to a toolbar
* Renders different modes
** Normal, to be used inside perspectives
** Embedded, to be used inside menues
** Stateful, inside perspectives, and controlled by a state-machine
** Mobile, to be used on small geometry mobile devices with navigation widgets
* Renders in 1 to N columns of components
* Groups components by using entity metadata
* Renders owning relationships as combo-boxes
* Renders member relationships as tables on tab-sheets
* Implements blob up- and downloading

=== Perspective ===

A perspective is a visual container for a set of views (parts). These parts exist wholly within the perspective and are not shared. A perspective is also like a page within a book. It exists within a window along with any number of other perspectives and, like a page within a book, only one perspective is visible at any time.

* Based on the Eclipse 4 application model
* Presents a 360° view on the task to the user
* Divides the usable screen area in resizable containers
* Nests windows, perspective-stacks, perspectives, containers, part-stacks and parts containing views, and toolbars
* Stores and retrieves resized areas for each user
* Supports drag and drop
* Event dispatching system to synchronize data, actions, focus and more between views
* References all types of views (dialogs, tables, charts, reports …) to set up a dashboard
* Modifiable layout at runtime using the designer mode for permitted users
* Connects to user tasks of BPM

=== Action ===

A toolbar is a set of icons or buttons that are part of a software program's interface or an open window. A toolbar item is an object type that associates a command with a toolbar. This association places an icon on the toolbar in a specific location relative to the other toolbar icons on that toolbar. A command is linked to a specific action and can have a keyboard shortcut specification.

* Links action-buttons
** To business logic of Function-Library to be executed
*** Synchronously
*** Asynchronously as background process
** To Data-Interchange import- or export tasks
** To BPM start events
** To actions to trigger
*** Save, delete, download, print etc.
*** Advance focus to next or previous part
* Links action-buttons to business logic of Function-Library to be
** Enabled
** Disabled depending on data context
* Defines commands to control the application and trigger actions
* Assigns keyboard short-cuts to commands
* Connects to Message for fail or success messages about executed actions

=== Menu ===

A menu is a list of options or commands presented to the user of OS.bee. A menu appears as a tree structure if the popup button besides the user-image is pressed. It is the user-specific point of entry into the OS.bee system. The user menu contains only those items that are needed to perform daily tasks.

* Combines Perspectives, BPM start events, embedded dialogs and tables, configuration settings and other informative screens to a tree-organized menu
* Pops up anytime it is needed, and consumes no space on the screen

=== Message ===

Messages can be defined to improve the user experience as guidance through complex user interactions with the system. For security and monitoring reasons they can be logged.

* Defines messages to notify a user about events and usage violations
* Can be tracked by log entries
* Placeholders for parametrizing messages
* Can have a severity

== Security ==

Security's mission is to protect the companies and their assets (know-how, company data, personal and customer data and personal data, etc.) from hackers, crackers and robbers, and economic damage caused by breaches of confidentiality, manipulation, hardware failure and availability prevent the systems.

=== Authorization ===

Authorization is a security mechanism to determine access levels and user privileges related to system resources including files, services, data and application features. This is the process of granting or denying access to a resource which allows the user access to various resources based on the user's identity.

* Role-based authorization system
* Grant access to entities, beans and DTO
* Grant access to CRUD operations (create, read, update, delete)
* Grant access to modification of relationships (link, unlink references)
* Vetoes per attribute for visibility, editability and enabling
* Grant access to start a process
* Grant access working on a user task

=== Organization ===

An organization is an entity comprising multiple people, such as an institution or an association that has a collective goal and is linked to an external environment. Its design specifies how goals are subdivided and reflected in subdivisions of the organization. An organization can be visualized in an organigram.

* Hierarchies of positions, multi-positions, and sub-organizations
* Maps roles to positions
* Definition of levels of collaboration if sharing the same roles
* Derives an organigram of each hierarchy to be rendered at runtime

= Services =

== Authentication ==

Authentication is a process that ensures and confirms a user’s identity. To do so, a user needs to provide some sort of proof of identity that the system understands and trust. There are multiple ways (realms) to do this:

* Security specific data access object, software component that talks to a backend data source.
* If you have usernames and password in LDAP, then you would have an LDAP Realm that would communicate with LDAP.
* Active Directory
* Kerberos

More features:* Remember-me
* Forgot password
* Protection against brute-force attacks
* MD5 salted and encrypted passwords
* Protection against debugging
* First commissioning support
* Session management
* Simple Single Sign-On (SSO)
* AES 128 encrypted cookie support

== Persistence ==

Persistence service enabling small data-sources as well as large-scale installations:* XA data-source support for distributed transactions
* Built in global transaction manager
* JNDI Service
* Built in support for local databases
* Supports database providers from Application Server implementations like WebSphere or WebLogic Server
* Provides JDBC and catalog data for Mondrian
* Supports all compatible databases to EclipseLink like:
** Oracle
** Oracle JDBC
** MySQL
** PostgreSQL
** Derby
** DB2
** DB2 (mainframe)
** Microsoft SQL Server
** Sybase
** Informix
** SQL Anywhere
** HSQL
** SAP HANA
** H2
** Firebird
** Microsoft Access
** Attunity
** Cloudscape
** DBase
** PointBase
** TimesTen
** Symfoware
** MaxDB

== Translation ==

There is a centralized translation service in OS.bee. It collects all property files from models created by a DSL and supplies all internal translations that the Software Factory needs. The number of supported languages is unlimited; however the internal translations deployed for the moment are limited to English, French, and German. More languages can be ordered. In case a translation key occurs multiple times, the “best” translation for this key is automatically selected. The “best” translation is evaluated by the maximum Levinshtein distance from the translation key.

== Metadata ==

OS.bee holds all model-data at runtime so that all programs can reference them. Renderers that do not need code will interpret these model to do their work. So even in the Function-Library it is possible to take the current modeling into account.

== Theme Resources and CSS ==

As usual for web-frontend applications, cascaded style sheets describe the look and feel. Custom CSS can be loaded from outside, or any modification can be made once the appropriate bundle is downloaded. CSS is compiled from a SCCS template with a pre-processor. The advantage of using SCSS is that you can use variables and therefore create different looks with just a hand-full of variables. OS.bee comes with 3 different theme variants that can be selected in the user profile. Resources like images, html pages and icons are available per theme and thus adjustable to the used color scheme.

OS.bee Customer Display

2018-10-23T07:17:20Z

Riegel: /* Customer Display */

== Customer Display ==

The latest version of the Statemachine DSL (Finite State-Machine) covers the synchronization of external (slave) browsers to a main (master) browser connected to an OS.bee server. The requirement was mainly inspired by the need of a customer display for the OS.bee POS application OS.pos. In this context it is required parts of the main screen's data which is shared on the slave browser working as a display.

Multiple displays can be connected to a master just by using a pattern on the address line of the slave-browser:

<code> http://{server_host-name}/osbpdisplay/#{host-name_of_the_master}§{DisplayName_as_defined_in_the_ui_model} </code>

► example: http://dv999.compex.de:8081/osbpdisplay/#dv888.compex.de§CustomerDisplay

* '''''http://dv999.compex.de:8081/osbp''''': this part as same as the address in main display, including server host-name and port number.
* '''''display/''''': this part is the slave name, you can attach one or more slaves on the same master.
* '''''#dv888.compex.de-''''': this part is master machine.
* '''''CustomerDisplay''''': this part is the display name which is used by this slave, and it is as same as the display name which is defined in the UI model.

=== Important prerequisite ===
In order to use external displays you must add the bundle ''org.eclipse.osbp.display'' to your product's launch configuration and set auto-start to true.

[[File:display_autostart.png|800px]]

=== Technical changes in DSL model ===

==== changes in dto ====
* New '''dto''' "'''CustomerDisplayDto'''":
*:<syntaxhighlight lang="java">
dto CustomerDisplayDto {
var double totalAmount
var boolean left
var String message
var boolean right
var BlobMapping image
ref CashSlipDto slip
}
</syntaxhighlight>
** '''totalAmount''' : total amount of all cash position.
** '''left''' & '''right''' : boolean value, define if this part will be shown on display.
** '''image''' : any image which will be shown on th display
** '''slip''' : reference the cash slip dto.

==== changes in UI====
* New '''UI''':
*:<syntaxhighlight lang="java">
display Customer {
rootType CustomerDisplayDto
datasource main:CustomerDisplayDto
datasource img:BlobConverter
horizontalLayout {
verticalLayout left {
textfield(i18n noCaption readonly) message
table(i18n noCaption) slip {
scrollToBottom
type CashPositionDto
columns {
column quantity
column product.sku
column product.product_name
column price
column amount
}
sort {
column now asc
}
}
align fill-left
form(styles "os-cash-total") {
decimalField(precision= 2 readonly) totalAmount
}
bind [this.message].value <-- img.input
bind [this.slip].collection <-- main.slip.positions
bind [this.totalAmount].value <-- main.totalAmount
}
verticalLayout right {
image info
bind img.input <-- main.^image
bind [this.info].resource <-- img.output
}
bind [this.left].visible <-- main.left
bind [this.right].visible <-- main.right
}
}
</syntaxhighlight>
** In this '''display''' "'''customer'''", we define in the 2 parts(left part & right part), if they will be shown and what will be shown in UI.

==== changes in Functionlibrary ====
* New lines in '''operation''' "'''initImages'''" & '''operation''' "'''conputeTotal'''" :
*:<syntaxhighlight lang="java">
operation initImages(IStateMachine stateMachine, Object [] params) {
. . .
stateMachine.set("CustomerDisplayImage", cashregister.store.company.companyImage)
. . .
}
</syntaxhighlight>
** In operation "'''initImages'''", the image of customerDisplay could be set.
*:<syntaxhighlight lang="java">
operation computeTotal(IStateMachine stateMachine) {
. . .
stateMachine.set("CustomerDisplayTotalAmount", amount);
. . .
}
</syntaxhighlight>
** In operation "'''computeTotal'''", the total amount of CustomerDisplay could be calculated and set.

==== changes in Statemachine ====
Some new keywords are introduced for this new functionality:
:* <syntaxhighlight lang="java"> display <DisplayName> using <DTOName> </syntaxhighlight>
:* <syntaxhighlight lang="java"> dto <DTOAlias> type <DTOName> attach <DisplayName> </syntaxhighlight>
:* <syntaxhighlight lang="java"> displayText text "some text" @<DisplayName> to <DTOAttribute> </syntaxhighlight>

The references of a DTO that is attached to a display are always synchronized across all connected displays. Single fields must be synchronized by '''displayText'''.

:► e.g.:
:*<syntaxhighlight lang="java">
display CustomerDisplay using CustomerDisplayDto
</syntaxhighlight>
:*<syntaxhighlight lang="java">
dto cashslip type CashSlipDto attach CustomerDisplay
</syntaxhighlight>
:*<syntaxhighlight lang="java">
displayText text "locked" @CustomerDisplay to message
</syntaxhighlight>
:► The referenced DTO must be the rootType of the Display definition in the ui model.

Now I will show the changes in statmachine:
# New '''events''' "'''dataProvider DataControl'''":
#:<syntaxhighlight lang="java">
dataProvider DataControl {
. . .
dto cashslip type CashSlipDto attach CustomerDisplay
dto customerDisplay type CustomerDisplayDto
. . .
}
</syntaxhighlight>
# New '''events''' "'''peripheral PeripheralControl'''":
#:<syntaxhighlight lang="java">
peripheral PeripheralControl {
. . .
display CustomerDisplay using CustomerDisplay
. . .
}
</syntaxhighlight>
# Setting for customerDisplay, in '''state''' "'''IDLE'''":
#:<syntaxhighlight lang="java">
trigger onStartUp
actions transition LOCKED{
. . .
displayText false @CustomerDisplay to ^left
displayText true @CustomerDisplay to ^right
. . .
}
</syntaxhighlight>
# Setting for customerDisplay, in '''state''' "'''LOCKED'''":
#:<syntaxhighlight lang="java">
trigger onOk
actions transition ATTENTIVE{
. . .
displayText true @CustomerDisplay to ^left
displayText false @CustomerDisplay to ^right
. . .
}
</syntaxhighlight>

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

OS.bee Software Factory Unique Selling Propositions

2018-10-23T07:12:46Z

Riegel: /* Persistence */

= Abstract =

OS.bee is a low-code model-driven software-factory, using over 20 Domain Specific Languages (DSL) to generate large-scale business web-applications. Each DSL contains a grammar for a required application-layer. A DSL hides complexity from successors, thereby enabling parallel modelling of domain requirements by multiple designers as they don’t need to know the domain logic they build upon. A model created with a DSL creates executable code, structured data and configuration settings or is interpreted by a renderer during runtime. The language of each DSL uses a grammar that makes the created model easy to understand and forms a requirement specification on its layer. The overall hierarchy can be browsed through at any time and gives a good understanding of the whole application in nearly natural English language. A DSL can also be studied by its syntactical graph. The creation of a model is a guided process through the syntax graph where the designer benefits from content assistance, code completion, quick fix, syntax colorizing, outline, formatting and validation. Many DSLs define metadata to be used by subsequent DSL to increase the leverage of definitions at a basic level. All element names defined by a DSL are automatically extracted to localization files for translation to open foreign markets for the resulting application. The ratio between the generated lines of code versus the numbers of lines in a model is 8 on average. Development speed improves by a similar factor. Dependencies between models reveal inconsistencies immediately while modifying and prevent generating code until these are resolved. Therefore turnaround cycles are short, errors are easy to discover and prototypes materialize in a very short time. Some DSL generate against famous open-source frameworks like EclipseLink, Smooks, Mondrian, Vaadin or jBPM thus enabling non-developers to use complex frameworks without deeper knowledge of their API. OS.bee inherits the features of the embedded frameworks and makes them easy to exploit for specialists of a domain not necessarily being software developer.

= DSL Modeling =

== Persistence ==

Persistence refers to object and process characteristics that continue to exist even after the process that created it ceases or the machine it is running on is powered off. When an object or state is created and needs to be persistent, it is saved in a non-volatile storage location, like a hard drive, versus a temporary file or volatile random access memory.

=== Data-type ===

A data type is a classification that specifies which type of value a variable has and what type of mathematical, relational or logical operations can be applied to it without causing an error. Data types also hold metadata for higher-level DSLs so they can apply additional functionality to a field using this data type.

* Primitive Types (int, double, etc.)
* Object Types (String, Date, etc.)
* Blob
** Store and retrieve any document or image type in binary form
* Auto-sizing Images
** Additionally stores images of definable size to experience better performance while rendering
* Formatted types
** Dates and times in any localized form
** Dates and times in any format (time only, date only, short and long forms, custom pattern, etc.)
** Currencies in any localized form
* Validated types with adjustable severity message
** Date in past/future
** Not null
** Not duplicate
** Range values
** Min/max length
* Slider types
** Min/max values
* Masked types
** Number, Hexadecimal, Capitalized
** Input pattern (e.g. Phone Numbers (###) ###-####)
** Password
* Suggestion types
** While typing some characters, a sorted list of suggestions pops up for selection
* Programmable Converters
** Text-to-Image
** Number-to-Text/Image
** Value-to-CSS Style
** Units of measurement
* Rich text editor using HTML markups
* Text area

=== Entity ===

An entity (-type) is a model of metadata for a single unique object in the real world. For example a person, organization, object type, or concept about which information is stored. Together with its attributes (or properties) it describes information that is being mastered. An entity typically corresponds to one or several related tables in database. An attribute is a characteristic or trait of an entity that describes the entity, for example, the Person entity type has the Date of Birth attribute.

* Simple Entity
* Mapped super-classes
** Complement attributes in every entity using this
* Inheritance
** Specialized classes for special purpose
* References and their opposites
* References with constraints
* Embeddable beans
* Number generators UUID or ID
* Separated persistence-units capable of using multiple databases simultaneously
* All multiplicities (0..1, 0..n,1..1,1..n,*)
* Indexes unique and non-unique
* Validated uniqueness
* Domain-key annotation for lookups
* Methods for calculated attributes
* Lifecycle controlled method invoking (by PostLoad, PrePersist, etc.)
* Affected changes listeners
* Localizable Enumerations with images
* Creation and last modification information
* Transient data
* Synthetic attributes built by lifecycle methods either transient or persistent
* Historicized data
* Temporal data
* Versioned data
* Definable Runtime data filter
* Programmable Validators
* Nested Filter attributions over multiple references
* Abstraction of database vendor specific implementations

=== Data transfer object (DTO) ===

A DTO is an object that carries data between processes. DTOs are simple objects that do not contain any business logic but may contain serialization and deserialization mechanisms for transferring data.

* Independent nested data container
* Automatically generated for entities
* Automatically mapped by entity data
* Editable sub- or supersets for entities
* Transient data container
* Nested objects automatically synchronized
* Nested properties access through dot expressions
* Used for services, processes, functions and renderers
* Dirty state aware
* Access restrictions on DTO and property granularity controlled by security layer

=== DTO Service ===

A DTO service abstracts and encapsulates all access to the data source. It manages the connection with the data source to obtain and store data and implements the access mechanism required to work with the data source. The data source could be a persistent store like an RDBMS, or a business service accessed via REST or SOAP.

* Data storage and retrieval suitable for DTO
* Nested Transactions and Lock-modes
* Global transactions
* Object Oriented Query engine
* Low level Java Persistence Query Language method declarations (e.g. getTotal(), getAverage(), …)
* Injectable and declarative service
* Used for services, processes, functions and renderers
* Session scoped Entity Manager
* Thread safe persistence-unit bound Entity Manager Factory

=== Data-Interchange ===

Data Interchange is the endpoint-to-endpoint exchange of business documents in a standard electronic format between business partners or computer systems.

* Smooks and FreeMarker implementation
* Nested entity import- and export-paths
* Localized formatters on data
* Supports encoding
* XML and CSV formats
* All EDI messages
* Automatically set export- and import markers for database
* Filtered exports
* Bulk insert/update
* Progress bar
* Generated import and export dashboard
* Generated lookup queries to embed relational data
* Merge or persist external data
* Import images of different mime-types into blobs via filename pattern
* Usage of expressions
* Free attribute mappings

=== Signal ===

Signal processes events coming from file-systems. If a file that matches a given filename pattern is created, modified or deleted then an event is received and the modelled actions will be called. Signal also emits events for recurring things like a certain weekday and time is reached and executes the modelled actions.

* File watcher for all file activities working on all operating systems
* Free filename pattern to watch for

* Trigger Data-Interchange
* Definable export or import job-chain
* Synchronously or asynchronously execution (depending on import relationship)
* Quartz implementation for scheduled Data-Interchange export-jobs

=== Entity-Mock ===

Mock objects are simulated objects that mimic the behavior of real objects in controlled ways. A programmer typically creates a mock object to test the behavior of some other object, in much the same way that a car designer uses a crash test dummy to simulate the dynamic behavior of a human in vehicle impacts.

* Generates fake data looking realistic

* Mapping of roles to positions and multi-positions

* Rule-based data composition (e.g. email address)
* Rule-based attribute generators for every data-type from data composition, or
** Randomly
** Ranges
** Picks from a given list
** Dates in the past with offset and limit (for birthdays)
** Dates in the future with offset and limit
* Composes objects from rule-based attribute generators (e.g. a person, a company, etc.)
* Composes object-trees from composed objects
* Creates relationships between objects using a given probability
* Creates mass data (e.g. sales data)
* Imports fixed data via Data-Interchange and embeds it
* Used mainly for quick-setup applications using a H2 database
* Exposes mock data services to be executed before any login-attempt
* Persists into all supported database products
* Can be executed at every server-start or once

== Business intelligence ==

Business Intelligence (BI) refers to technologies, applications and practices for the collection, integration, analysis, and presentation of business information. The purpose of Business Intelligence is to support better business decision making. Essentially, Business Intelligence systems are data-driven Decision Support Systems (DSS). Business Intelligence is sometimes used interchangeably with briefing books, report and query tools and executive information systems.

=== Cube ===

A cube is a method of storing data in a multidimensional form, generally for reporting purposes. In cubes, data (measures) are categorized by dimensions. Cubes are pre-summarized across dimensions to drastically improve query time over relational databases. The query language used to interact and perform tasks with cubes is multidimensional expressions (MDX).

* Mondrian OLAP for MDX queries implementation
* Cubes, dimensions, hierarchies, levels, members, and measures
* Defines a multi-dimensional database
* Contains a logical model, and a mapping of this model onto the physical entity model

=== DataMart ===

A data mart is a subject-oriented archive that stores data and uses the retrieved set of information to assist and support the requirements involved within a particular business function or department. Data marts improve end-user response time by allowing users to have access to the specific type of data they need to view most often by providing the data in a way that supports the collective view of a group of users.

* Common layer for data-warehouse queries
* Simplification of any kind of query against all available data sources
* Tailored queries and aggregates for different interest-groups
* Definition of complex multidimensional expressions (MDX) with a simple grammar
* Sophisticated analytic functions easy to use
* Online analytical processing built in
* Access to runtime data of the Business Process management engine
* Multi-purpose results for processes, reports, score cards and charts
* Definable navigation trees (join-paths)
* Definable single- and multi-selection filters on any leaf of the query tree
* Access restrictions on entity and attribute granularity controlled by security layer

=== Function-Library ===

A function-library is a collection of non-volatile resources used by other DSLs. It is a collection of implementations of behavior, written in Xbase, which has a well-defined interface by which the behavior is invoked. Library code is organized in such a way that it can be used by multiple programs that have no connection to each other, in other words it is completely independent of the calling logic.

* Xbase implementation
* UOMo implementation
* Creates operational objects and methods
* Grouped by application field
** Converter for model-presentation conversions
*** Value to image
*** Value to value
*** Value to style (background color, text color, font-style, etc.)
*** Value to unit of measurement based value
*** Between measurement systems and unit of measurement families
** State-Machine
*** Operations
*** Functions
*** Guards
*** Full access to state-machine controls
** Toolbar Action
*** Can execute validation (enable/disable operation)
*** Execute any operation
** Validation on DTO
** Business logic implementation for BPM
*** Functions callable in system tasks
*** Ratings for gateways
*** Tests for gateways
** Calculations e.g. for
*** Currencies
*** Lengths
*** Areas
** Posting operations
* Exposes injectable and declarative service
* Store and retrieve data from DTO
* Full access to all JVM objects

=== State-Machine ===

A finite-state machine (FSM) is a mathematical model of computation. It is an abstract machine that can be in exactly one of a finite number of states at any given time. The FSM can change from one state to another in response to an event. The change from one state to another is called a transition. An FSM is defined by a list of its states, its initial state, and the conditions for each transition. These conditions are called guards as they guard the transition from unwanted invocation.

* Implementation of business behavior
* Defines states and their transitions
* Transitions are triggered by events
* Transitions are guarded by functions from Function-Library
* Actions to be executed before and after transitioning from Function-Library
* Has things to control
** Database objects (DTO)
** Database filters
** Visibility or enabling of
*** Buttons (UI)
*** Layouts (UI)
*** Other components (UI)
** Peripheral devices (interfaces JavaPOS)
*** Printers
*** Line displays
*** Cash drawers
*** Payment terminals
*** Signature pads
** Slave browsers (external displays, etc.)
* Receives events from
** Buttons clicked
** UI selections
** Peripherals (printer out of paper, etc.)
** Schedulers

=== BLiP (Business Logic implementation Platform) ===

BLiP focuses on improving corporate performance by managing business processes (BPM), business rules and business logic (Function-Library).  It is a disciplined approach to identify, design, execute, document, measure, monitor, and control both automated and non-automated business processes to achieve consistent, targeted results aligned with an organization’s strategic goals. BPM involves the deliberate and collaborative definition, improvement, innovation, and management of end-to-end business processes that drive business results, create value, and enable an organization to meet its business objectives with more agility. BPM enables an enterprise to align its business processes to its business strategy, leading to effective overall company performance through improvements of specific work activities either within a specific department, across the enterprise, or between organizations.

* Implements jBPM
* Integrates a BPMN editor at design-time
* Connects tasks of BPM to business logic of Function-Library
* Controls sequence-flow through business logic of Function-Library
* Stores and retrieves process save-points
* Logs all process activities of system and user
* Exposes BPM data and events to UI elements
* Stores and retrieves workload data using DTO

== Presentation ==

The presentation layer ensures that the communications that pass through it are in the appropriate form for the recipient application. It is responsible for the delivery and formatting of information to the application layer for further processing or display. It relieves the application layer of concern regarding syntactical differences in data representation within the end-user systems.

=== Table ===

A table is a data structure that organizes information into rows and columns. It can be used to both store and display data in a structured format.

* Editable cells
* Scorecard elements
** Rule-based colorizing of cell background and textcolor
** Mixed in rule-based icons
** Rule-based styling of cells
** Rule-based tooltips
* Data from DataMart or DTO
* Pivot presentation
* Multidimensional presentation on nested tab-sheets
* Filtering, sorting, swapping and hiding of columns
* Stores swapping and hiding per user
* 3 different row numbering modes
* Row selection synchronizes other views in scope

=== Chart ===

A chart is a diagram, picture, or graph which is intended to make information easier to understand. It is a symbolic representation of information according to some visualization technique.

* Multiple data series with selectable colorizing
* Series switchable from legend
* Bar, line, pie, donut, bubble and gauge presentation
* Animated, stacked, shaded and xy-swapped charts
* Zoom and trend-line function
* Tooltips for series and data points with absolute value
* Selectable positioning relative to cursor for tooltips
* Selectable legend placement
* Collapsible tree presentation on hierarchical data
* Date axes with customizable formatting
* Up to 9 individually scalable Y axes
* Rotated axis text
* Category rendering either linear, logarithmic, timeline or as pyramid
* Downloadable SVG image

=== Report ===

A document containing information organized in a graphic or tabular form, prepared on ad hoc, periodic, recurring, regular, or as required basis. Reports may refer to specific periods, events, occurrences, or subjects, and are presented in printed form.

* Actuate Birt implementation
* Definition of reusable layout metadata
** All units of measurement for layouts
** Definition of fonts and colors
** Definition of formatters for
*** Currencies
*** Date and time
** Page sizes (A4, A5, etc.)
** Orientations (Landscape, portrait)
** Margins
** Paddings
** Alignments
* Output as HTML or PDF
* Ability to reference multiple DataMarts for header, footer and details
* Rendering of blob-images
* External CSS usable
* Defines grids and cells
* Direct printing to preselected output medias per user or per location and report
* Rule-based visibility of cells
* Aggregates for grouping
* Rule-based page break
* Rule-based colorizing and styling
* URL-based or embedded images
* Auto-texts (page number etc.)

=== Topology ===

Topology is designed for representing simple geographical features, along with their non-spatial attributes. It includes geo-json points (addresses and locations), line strings (streets, highways and boundaries), polygons (countries, provinces, tracts of land), and multi-part collections of these types.

* D3 implementation
* Render predefined maps of U.S.A., Germany, Spain… the World
* Select states, countries, regions or cities to synchronize other views in scope
* Render geo-json data from blobs to show boundaries of plots of land, buildings or floor plans

=== UI ===

The user interface (UI) is the space where interactions between humans and OS.bee occur. The goal of this interaction is to allow effective operation and control of the machine from the human end, whilst the machine simultaneously feeds back information that aids the operators' decision-making process.

* Models interactive views
* Connects to data-sources of any kind (DTO, Bean, JVM object, etc.)
* Nests different kinds of layouts to a complex surface (horizontal, vertical, form, grid)
* Adds components to layouts (buttons, text-fields, tables, images, etc.)
* Binds components to properties of data-sources
* Rule-based visibility processor
* Navigation widgets for small geometry mobile devices

=== Dialog ===

The dialog is a composite UI which is composed by either an automatically generated UI or a UI created with means of the UI DSL and actions that are available through a toolbar. It also can be combined with an instance of State-Machine DSL if a sophisticated control over the visibility of components and a definable usage-sequence is needed.

* Renders interactive views
* Either references a predefined UI model or a model inferred from a DTO
* Links the view to a toolbar
* Renders different modes
** Normal, to be used inside perspectives
** Embedded, to be used inside menues
** Stateful, inside perspectives, and controlled by a state-machine
** Mobile, to be used on small geometry mobile devices with navigation widgets
* Renders in 1 to N columns of components
* Groups components by using entity metadata
* Renders owning relationships as combo-boxes
* Renders member relationships as tables on tab-sheets
* Implements blob up- and downloading

=== Perspective ===

A perspective is a visual container for a set of views (parts). These parts exist wholly within the perspective and are not shared. A perspective is also like a page within a book. It exists within a window along with any number of other perspectives and, like a page within a book, only one perspective is visible at any time.

* Based on the Eclipse 4 application model
* Presents a 360° view on the task to the user
* Divides the usable screen area in resizable containers
* Nests windows, perspective-stacks, perspectives, containers, part-stacks and parts containing views, and toolbars
* Stores and retrieves resized areas for each user
* Supports drag and drop
* Event dispatching system to synchronize data, actions, focus and more between views
* References all types of views (dialogs, tables, charts, reports …) to set up a dashboard
* Modifiable layout at runtime using the designer mode for permitted users
* Connects to user tasks of BPM

=== Action ===

A toolbar is a set of icons or buttons that are part of a software program's interface or an open window. A toolbar item is an object type that associates a command with a toolbar. This association places an icon on the toolbar in a specific location relative to the other toolbar icons on that toolbar. A command is linked to a specific action and can have a keyboard shortcut specification.

* Links action-buttons
** To business logic of Function-Library to be executed
*** Synchronously
*** Asynchronously as background process
** To Data-Interchange import- or export tasks
** To BPM start events
** To actions to trigger
*** Save, delete, download, print etc.
*** Advance focus to next or previous part
* Links action-buttons to business logic of Function-Library to be
** Enabled
** Disabled depending on data context
* Defines commands to control the application and trigger actions
* Assigns keyboard short-cuts to commands
* Connects to Message for fail or success messages about executed actions

=== Menu ===

A menu is a list of options or commands presented to the user of OS.bee. A menu appears as a tree structure if the popup button besides the user-image is pressed. It is the user-specific point of entry into the OS.bee system. The user menu contains only those items that are needed to perform daily tasks.

* Combines Perspectives, BPM start events, embedded dialogs and tables, configuration settings and other informative screens to a tree-organized menu
* Pops up anytime it is needed, and consumes no space on the screen

=== Message ===

Messages can be defined to improve the user experience as guidance through complex user interactions with the system. For security and monitoring reasons they can be logged.

* Defines messages to notify a user about events and usage violations
* Can be tracked by log entries
* Placeholders for parametrizing messages
* Can have a severity

== Security ==

Security's mission is to protect the companies and their assets (know-how, company data, personal and customer data and personal data, etc.) from hackers, crackers and robbers, and economic damage caused by breaches of confidentiality, manipulation, hardware failure and availability prevent the systems.

=== Authorization ===

Authorization is a security mechanism to determine access levels and user privileges related to system resources including files, services, data and application features. This is the process of granting or denying access to a resource which allows the user access to various resources based on the user's identity.

* Role-based authorization system
* Grant access to entities, beans and DTO
* Grant access to CRUD operations (create, read, update, delete)
* Grant access to modification of relationships (link, unlink references)
* Vetoes per attribute for visibility, editability and enabling
* Grant access to start a process
* Grant access working on a user task

=== Organization ===

An organization is an entity comprising multiple people, such as an institution or an association that has a collective goal and is linked to an external environment. Its design specifies how goals are subdivided and reflected in subdivisions of the organization. An organization can be visualized in an organigram.

* Hierarchies of positions, multi-positions, and sub-organizations
* Maps roles to positions
* Definition of levels of collaboration if sharing the same roles
* Derives an organigram of each hierarchy to be rendered at runtime

= Services =

== Authentication ==

Authentication is a process that ensures and confirms a user’s identity. To do so, a user needs to provide some sort of proof of identity that the system understands and trust. There are multiple ways (realms) to do this:

* Security specific data access object, software component that talks to a backend data source.
* If you have usernames and password in LDAP, then you would have an LDAP Realm that would communicate with LDAP.
* Active Directory
* Kerberos

More features:* Remember-me
* Forgot password
* Protection against brute-force attacks
* MD5 salted and encrypted passwords
* Protection against debugging
* First commissioning support
* Session management
* Simple Single Sign-On (SSO)
* AES 128 encrypted cookie support

== Persistence ==

Persistence service enabling small data-sources as well as large-scale installations:* XA data-source support for distributed transactions
* Built in global transaction manager
* JNDI Service
* Built in support for local databases
* Supports database providers from Application Server implementations like WebSphere or WebLogic Server
* Provides JDBC and catalog data for Mondrian
* Supports all compatible databases to EclipseLink like:
** Oracle
** Oracle JDBC
** MySQL
** PostgreSQL
** Derby
** DB2
** DB2 (mainframe)
** Microsoft SQL Server
** Sybase
** Informix
** SQL Anywhere
** HSQL
** SAP HANA
** H2
** Firebird
** Microsoft Access
** Attunity
** Cloudscape
** DBase
** PointBase
** TimesTen
** Symfoware
** MaxDB

== Translation ==

There is a centralized translation service in OS.bee. It collects all property files from models created by a DSL and supplies all internal translations that the Software Factory needs. The number of supported languages is unlimited; however the internal translations deployed for the moment are limited to English, French, and German. More languages can be ordered. In case a translation key occurs multiple times, the “best” translation for this key is automatically selected. The “best” translation is evaluated by the maximum Levinshtein distance from the translation key.

== Metadata ==

OS.bee holds all model-data at runtime so that all programs can reference them. Renderers that do not need code will interpret these model to do their work. So even in the Function-Library it is possible to take the current modeling into account.

== Theme Resources and CSS ==

As usual for web-frontend applications, cascaded style sheets describe the look and feel. Custom CSS can be loaded from outside, or any modification can be made once the appropriate bundle is downloaded. CSS is compiled from a SCCS template with a pre-processor. The advantage of using SCSS is that you can use variables and therefore create different looks with just a hand-full of variables. OS.bee comes with 3 different theme variants that can be selected in the user profile. Resources like images, html pages and icons are available per theme and thus adjustable to the used color scheme.

OS.bee peripherals for JavaPOS

2018-09-26T12:41:30Z

Riegel:

== OS.bee peripherals for JavaPOS ==

OS.bee integrates the framework JavaPOS [http://www.javapos.com/]. Purpose of this framework is to abstract peripheral units like printers, displays, dispenser from their physical properties and to present an application interface to Java applications. For each unit it is necessary to define its abstract properties and communication protocol. Each vendor of pripheral units for POS systems comes with his own configuration tool. But all of them end up with a xml file describing all peripheral units available to a single OS.bee application server. The name of this configuration file is not important. For the moment it is not possible to mix units of different vendors in a single file as they put their physical hardware information inside the file while using their individal setup program. OS.bee can only use a single xml file at a time. The path must be entered in OS.bee preferences of IDE using Window->Preferences->OSBP Application Configuration. Don't forget to select the right product to be configured.

[[File:JavaPOS_Preferences.png]]

=== Epson Peripheral Units ===

==== Installation prerequisites ====

First download the following zip and unpack it in a suitable directory.
[[http://download.osbee.org/downloads/drivers/epson/EPSON_JavaPOS_ADK_1143.zip Epson Windows Driver and Setup Download]]
From the directory EPSON_JavaPOS_ADK_1143 start the executable EPSON_JavaPOS_1.14.3.exe and follow the instructions of the program.

If you follow the default settings of the installer, you end up with a directory structure epson/JavaPOS/SetupPOS. Here you start SetupPOS.bat as Administrator. For every peripheral unit you want to connect to OS.bee you must add an entry according to the requirements noted in the respective vendor's documentation. This program creates a xml file. The name is not important, but must be entered in the preferences in OS.bee under "External Data" (see section above).

Here is a sample xml file for a typical Epson configuration:
[[http://download.osbee.org/downloads/drivers/epson/pos.xml Epson Sample Configuration Download]]

==== Integration in OS.bee ====

How to use the Epson peripheral devices is described in [[Peripheral_Devices]]

=== WACOM Signature pad ===

OS.bee Software Factory supports the use of [http://www.wacom.com/en-gb/enterprise/business-solutions/hardware/signature-pads signature pads] from Wacom.

==== Installation prequistits ====

Supported OS: '''Windows'''

You have to install the driver for the signature pad on the machine you want to run the OS.bee application.

[[http://download.osbee.org/downloads/drivers/wacom/Wacom-STU-Driver-5.2.1.0.exe Windows Driver Installer Download]]

[[http://download.osbee.org/downloads/drivers/wacom/Wacom-STU-SDK-2.8.0.msi Windows SDK Installer Download]]

[[http://download.osbee.org/downloads/drivers/wacom/Wacom-STU-SDK2.8.0.tar.bz2 Lunix SDK Installer Download]]

Make a new path entry in your computer's enivronment variables and add a path element for the Wacom SDK java directory according to your processor architecture. As an example: '''C:\Program Files (x86)\Wacom STU SDK\Java\jar\x64'''

==== Integration in OS.bee ====

How to use the signature pad for the payment process is described in [[OS.bee_Signature_Pad]].

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

OS.bee Signature Pad

2018-09-26T12:30:42Z

Riegel:

== Signature Pad ==

'''Using signature pad for payment process is a new cash payment method.'''

=== Basic Functionalities ===

Basic functionalities of display on signature pad are:
* Show the advertising slide images on signature pad one after another according to de slide delay predefined in Company( in our example, for company FoodMart, the slide delay is defined as 2000, which means 2 seconds).
* When the customer signature is required, the display image on the signature pad will switch to the signing image, additional 3 buttons will be shown under the signing image: done, cancle and delete.(these labels could be translated with I18n)

==== Functionalities after signing ====
The following image is the signing image in our example.

[[File:signing_image.jpeg|600px]]

* Customer signs, and then select “'''done'''”, the signature of customer will be saved as a blob-mapping data, saving as thousands of points with x,y, pressure... the display of signature pad switch to the advertising slide images.
* Customer signs, and then select “'''cancle'''”, the signature process will be broken, switch to the advertising slide images.
* Customer signs, and then select “'''clear'''”, the signature will be deleted, and waiting for the next action of customer.

=== Technical changes in DSL model ===

==== changes in entity ====

# New '''entity''' '''AdvertisingSlide''' :
#:<syntaxhighlight lang="java">
entity AdvertisingSlide extends BaseUUID {
persistenceUnit "businessdata"
domainKey String slide
var Date showFrom properties( key="Date" value="Minute")
var Date showUntil properties(key="Date" value="Minute")
var BlobMapping image
ref Company company opposite slides
}
</syntaxhighlight>
#* '''slide''': name of this slide.
#* '''ShowFrom''' and '''showUntil''': valid date interval for this slide.
#* '''Image''': save this slide as a blobmapping data.
#* '''Company''': which company using this slide.
# New properties and references in '''entity''' '''Company''':
#:<syntaxhighlight lang="java">
entity Company extends BaseUUID {
. . .
var BlobMapping signingImage
var int slideDelay properties(key="Slider" value="1000:10000")
ref AdvertisingSlide[*] slides opposite company properties( key = "Table" value = "" )
. . .
}
</syntaxhighlight>
#* '''signingImage''': save the signing image as a blobmapping data. signingImage is the image which will be displayed on signature pad when customer signes.
#* '''slideDelay''': define the time delay for changing advertising slide image, unit is ms, and this value should be between 1000 and 10000, which means the delay should be between 1 second and 10 seconds.
#* '''Slides''': define a set of advertisingSlides for this company. These advertising slide images will be displayed one after another on the signature pad when no actions on it.
# A new '''Cash Payment Method''' "'''signaturePad'''": If the customer selects this payment way, the signature pad will be active.
# New '''entity''' '''CashPaymentPenData''' :
#:<syntaxhighlight lang="java">
entity CashPaymentPenData extends BaseUUID {
persistenceUnit "businessdata"
var int rdy
var int sw
var int pressure
var int x
var int y
ref CashPayment payment opposite penData
}
</syntaxhighlight>
#* The signature image will be saved as a '''CashPaymentPenData'''. All this relevant data value is generated from WACOM(mark of signature pad) software. The important values are pressure amount and cursor coordinates x and y. They will be saved save as a blob-mapping data, which including thousands of points with all the important values.
# Some new properties and references are defined in '''entity''' '''CashPayment''':
#:<syntaxhighlight lang="java">
entity CashPayment extends BaseUUID {
. . .
var BlobMapping signatureBitmap
ref cascade CashPaymentPenData[*] penData opposite payment
}
</syntaxhighlight>

==== changes in statemachine ====
# New '''payment method''' "'''payment signing'''"
#: It is defined as a new '''statemachine event''' "'''onMethod7'''".
#: A new '''peripheral''' is defined in statemachine for it:
#:<syntaxhighlight lang="java">
peripheral PeripheralControl {
. . .
signaturePad SignaturePad
}
</syntaxhighlight>
#: A new '''button''' is defined for it in '''paypad''' of statemachine:
#:<syntaxhighlight lang="java">
keypad PaymentPad event trigger {
. . .
button method7 image "" event onMethod7
}
</syntaxhighlight>
# New '''keypad''' "'''PluPad'''"
#:<syntaxhighlight lang="java">
keypad PluPad event identity from 1 until 6 named "plu"
</syntaxhighlight>
# Changes in statemachine '''state''' "'''IDLE'''":
#:<syntaxhighlight lang="java">
trigger onStartUp
actions transition LOCKED{
. . .
closeSignaturePad @SignaturePad
. . .
}
</syntaxhighlight>
# Changes in statemachine '''state''' "'''LOCKED'''":
#:<syntaxhighlight lang="java">
trigger onOk
actions transition ATTENTIVE{
. . .
operation loadPLU()
operation loadPaymentMethods()
store "false" with paymentterminal.open
paymentOpen host dto cashregister.payment_ip port dto cashregister.payment_port @VeriFone
labelSignaturePad okLabel "done" clearLabel "clear" cancelLabel "cancel" @SignaturePad
store "false" with signaturepad.open
openSignaturePad @SignaturePad
. . .
}
</syntaxhighlight>
# Changes in statemachine '''state''' "'''ATTENTIVE'''", new '''trigger''' "'''onSignaturePadOpen'''" for signaturePad:
#:<syntaxhighlight lang="java">
trigger onSignaturePadOpen
actions {
store "true" with signaturepad.open
operation initImages()
idleSignaturePad @SignaturePad
}
</syntaxhighlight>
# Changes in statemachine '''state''' "'''PAYMENT'''":
#:<syntaxhighlight lang="java">
trigger onBack
actions transition ATTENTIVE {
idleSignaturePad @SignaturePad
. . .
}
</syntaxhighlight
#:<syntaxhighlight lang="java">
trigger onMethod1 onMethod2 onMethod3 onMethod4 onMethod5 onMethod6 onMethod7
actions {
. . .
transition SIGNATURE_AUTHORIZATION guard useSignaturePad {
visible signaturePadDisplay
invisible money
invisible method
invisible functions
store event with paymentMethod.last
captureSignaturePad @SignaturePad
}
idleSignaturePad @SignaturePad
. . .
}
</syntaxhighlight>
# In statemachine new '''state''' "'''SIGNATURE_AUTHORIZATION'''":
#:<syntaxhighlight lang="java">
state SIGNATURE_AUTHORIZATION {
triggers {
trigger onSignatureOk
actions transition PAYMENT {
idleSignaturePad @SignaturePad
operation dopayment(retrieve from paymentMethod.last)
operation computePayed()
set "0" @paymentGiven
clearDevice LineDisplay
lineDisplayTextAt translate "total" row 0 column 0 @LineDisplay
lineDisplayTextAt translate "remain" row 0 column 10 @LineDisplay
lineDisplayTextAt function getPaymentTotal() row 1 column 0 @LineDisplay
lineDisplayTextAt function getPaymentRemain() row 1 column 10 @LineDisplay
invisible paymentTerminalDisplay
invisible signaturePadDisplay
visible money
visible method
visible functions
operation givenChanged()
transition PRINT_SLIP guard isPayed {
invisible total
invisible logout
invisible PaymentPad
invisible paymentFields
invisible functions
invisible numbers
invisible plu
invisible money
invisible method
invisible filterToggle
visible receipt
visible printreceipt
visible noreceipt
visible paymentFields
clearDevice LineDisplay
lineDisplayTextAt translate "total" row 0 column 0 @LineDisplay
lineDisplayTextAt translate "change" row 0 column 10 @LineDisplay
lineDisplayTextAt function getPaymentTotal() row 1 column 0 @LineDisplay
lineDisplayTextAt function getPaymentChange() row 1 column 10 @LineDisplay
transition OPEN_DRAWER guard mustOpenDrawer {
openDrawer CashDrawer
}
}
}
trigger onSignatureCancel
actions transition PAYMENT {
idleSignaturePad @SignaturePad
invisible signaturePadDisplay
visible money
visible method
visible functions
operation givenChanged()
}
}
}
</syntaxhighlight>

==== changes in functionlibrary ====

# New '''guard function''' "'''useSignaturePad'''" in functionlibrary DSL :
#:<syntaxhighlight lang="java">
guard useSignaturePad(IStateMachine stateMachine) {
var slip = stateMachine.get("cashslip") as CashSlipDto
stateMachine.set("signaturePadDisplayResolution" , 5)
stateMachine.set("signaturePadDisplay", slip.register.store.company.signingImage)
var paymentMethodDto = stateMachine.getStorage(stateMachine.getLastTrigger(), "dto") as CashPaymentMethodDto
var isopen = "true".equals(stateMachine.getStorage("signaturepad", "open") as String)
return paymentMethodDto.signaturePad && isopen
}
</syntaxhighlight>
# New '''operation''' "'''initImages'''" in functionlibrary DSL:
#:<syntaxhighlight lang="java">
operation initImages(IStateMachine stateMachine, Object [] params) {
var cashregister = stateMachine.get("cashregister") as CashRegisterDto
if(cashregister === null) {return false}
stateMachine.set("CustomerDisplayImage", cashregister.store.company.companyImage)
stateMachine.set("signatureSlideDelay", cashregister.store.company.slideDelay)
stateMachine.set("signatureCaptureImage", cashregister.store.company.signingImage)
for(slide:cashregister.store.company.slides) {
stateMachine.set("signatureAddSlide", slide.image)
}
return true
}
</syntaxhighlight>
# New method in '''operation''' "'''dopayment()'''" for save the signature image:
#:<syntaxhighlight lang="java">
var spIsOpen = "true".equals(stateMachine.getStorage("signaturepad", "open") as String)
if(spIsOpen && paymentMethodDto.signaturePad) {
var signatureBlob = stateMachine.get("SignatureBlob") as String
paymentPosition.signatureBitmap = signatureBlob
stateMachine.set("signaturePadDisplay", signatureBlob)
var data = stateMachine.get("PenData") as List<PenData>
'''Bold text''' if(data !== null) {
for(pData:data) {
var penDataDto = new CashPaymentPenDataDto
penDataDto.rdy = pData.rdy
penDataDto.sw = pData.sw
penDataDto.pressure = pData.pressure
penDataDto.x = pData.x
penDataDto.y = pData.y
paymentPosition.addToPenData(penDataDto)
}
}
}
</syntaxhighlight>

===Maintenance with OS.bee App===

►In '''menu--> Master data-->Company''', the detail of '''entity''' "'''Company'''" can be set:
[[File:menu_company.png|center]]

You could see 4 block on this page, and the two upper block is important for us to maintenance the master data of company.
[[File:page_company_4parts.png|1200px|center]]
* The upper left block show the main elements of company.
** The first tab is "'''Company'''", you can choose the company name and set slide signing image and slide delay for this company here.
*: [[File:tab_Company.png|600px|center]]
*: If you do not see the magnifier search icon after company name field, please click it to change.
*: ►With the magnifier search icon, you will get the whole suggestion company name in the insert field after you insert only the first letter of the company name.
*: [[File:tab_Company_search.png|600px|center]]
** The third tab "'''Slides'''" shows all advertising slides, and if you click one of them, the detail of this advertising slide (entity AdvertisingSlides) will be shown on the third tab “Slides” of the upper right block.
*: [[File:tab_Slides_dialog_Slides.png|600px|center]]
*: You can see all the advertising slides for the company in this tab "'''Slides'''".
*: [[File:tab_Slides.png|600px|center]]
*: You can maintenance detail of the selected advertising slide in the dialog "'''Slides'''".
*: [[File:dialog_Slides.png|600px|center]]

►In '''menu--> Master data-->Cash register data''', you can maintenance the details about payment method:
[[File:menu_cash_register_data.png|center]]

You could see 5 parts on this page.
[[File:page_cash_register_data_5parts.png|600px|center]]
* You can select one of the store in the ''upper left table'', e.g.: store 1. Then the detail of this store will be shown in the first tab “'''Mstore'''” of the ''upper middle block''. You could edit it here in this dialog.
*: [[File:tab_Mstore.png|600px|center]]
** Select the 4th tab “'''Registers'''” of the ''upper middle block'', the detail of all registers for the selected store will be shown in this table.
*: [[File:tab_Registers.png|600px|center]]
*: Select one of the registers and the detail of this register will be shown in the first tab “'''Cash register dialog'''” of the ''upper right block''. You can create new register and edit it in this dialog.
*:►Pay attention: your IP should be register before you use the signature pad .
*: [[File:tab_cash_register_dialog.png|600px|center]]
*: You can see all the cash payment methods for the store in the ''bottom left block''.
*: [[File:table_Cash_payment_method.png|600px|center]]
*: You can maintenance detail of the selected cash payment method in the ''bottom right block''.
*: [[File:dialog_Cash_payment_method.png|600px|center]]

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

OS.bee Customer Display

2018-09-11T08:36:30Z

Riegel:

== Customer Display ==

The latest version of the Statemachine DSL (Finite State-Machine) covers the synchronization of external (slave) browsers to a main (master) browser connected to an OS.bee server. The requirement was mainly inspired by the need of a customer display for the OS.bee POS application OS.pos. In this context it is required parts of the main screen's data which is shared on the slave browser working as a display.

Multiple displays can be connected to a master just by using a pattern on the address line of the slave-browser:

<code> http://{server_host-name}/osbpdisplay/#{host-name_of_the_master}-{DisplayName_as_defined_in_the_ui_model} </code>

► example: http://dv999.compex.de:8081/osbpdisplay/#dv888.compex.de-CustomerDisplay

* '''''http://dv999.compex.de:8081/osbp''''': this part as same as the address in main display, including server host-name and port number.
* '''''display/''''': this part is the slave name, you can attach one or more slaves on the same master.
* '''''#dv888.compex.de-''''': this part is master machine.
* '''''CustomerDisplay''''': this part is the display name which is used by this slave, and it is as same as the display name which is defined in the UI model.

=== Important prerequisite ===
In order to use external displays you must add the bundle ''org.eclipse.osbp.display'' to your product's launch configuration and set auto-start to true.

[[File:display_autostart.png|800px]]

=== Technical changes in DSL model ===

==== changes in dto ====
* New '''dto''' "'''CustomerDisplayDto'''":
*:<syntaxhighlight lang="java">
dto CustomerDisplayDto {
var double totalAmount
var boolean left
var String message
var boolean right
var BlobMapping image
ref CashSlipDto slip
}
</syntaxhighlight>
** '''totalAmount''' : total amount of all cash position.
** '''left''' & '''right''' : boolean value, define if this part will be shown on display.
** '''image''' : any image which will be shown on th display
** '''slip''' : reference the cash slip dto.

==== changes in UI====
* New '''UI''':
*:<syntaxhighlight lang="java">
display Customer {
rootType CustomerDisplayDto
datasource main:CustomerDisplayDto
datasource img:BlobConverter
horizontalLayout {
verticalLayout left {
textfield(i18n noCaption readonly) message
table(i18n noCaption) slip {
scrollToBottom
type CashPositionDto
columns {
column quantity
column product.sku
column product.product_name
column price
column amount
}
sort {
column now asc
}
}
align fill-left
form(styles "os-cash-total") {
decimalField(precision= 2 readonly) totalAmount
}
bind [this.message].value <-- img.input
bind [this.slip].collection <-- main.slip.positions
bind [this.totalAmount].value <-- main.totalAmount
}
verticalLayout right {
image info
bind img.input <-- main.^image
bind [this.info].resource <-- img.output
}
bind [this.left].visible <-- main.left
bind [this.right].visible <-- main.right
}
}
</syntaxhighlight>
** In this '''display''' "'''customer'''", we define in the 2 parts(left part & right part), if they will be shown and what will be shown in UI.

==== changes in Functionlibrary ====
* New lines in '''operation''' "'''initImages'''" & '''operation''' "'''conputeTotal'''" :
*:<syntaxhighlight lang="java">
operation initImages(IStateMachine stateMachine, Object [] params) {
. . .
stateMachine.set("CustomerDisplayImage", cashregister.store.company.companyImage)
. . .
}
</syntaxhighlight>
** In operation "'''initImages'''", the image of customerDisplay could be set.
*:<syntaxhighlight lang="java">
operation computeTotal(IStateMachine stateMachine) {
. . .
stateMachine.set("CustomerDisplayTotalAmount", amount);
. . .
}
</syntaxhighlight>
** In operation "'''computeTotal'''", the total amount of CustomerDisplay could be calculated and set.

==== changes in Statemachine ====
Some new keywords are introduced for this new functionality:
:* <syntaxhighlight lang="java"> display <DisplayName> using <DTOName> </syntaxhighlight>
:* <syntaxhighlight lang="java"> dto <DTOAlias> type <DTOName> attach <DisplayName> </syntaxhighlight>
:* <syntaxhighlight lang="java"> displayText text "some text" @<DisplayName> to <DTOAttribute> </syntaxhighlight>

The references of a DTO that is attached to a display are always synchronized across all connected displays. Single fields must be synchronized by '''displayText'''.

:► e.g.:
:*<syntaxhighlight lang="java">
display CustomerDisplay using CustomerDisplayDto
</syntaxhighlight>
:*<syntaxhighlight lang="java">
dto cashslip type CashSlipDto attach CustomerDisplay
</syntaxhighlight>
:*<syntaxhighlight lang="java">
displayText text "locked" @CustomerDisplay to message
</syntaxhighlight>
:► The referenced DTO must be the rootType of the Display definition in the ui model.

Now I will show the changes in statmachine:
# New '''events''' "'''dataProvider DataControl'''":
#:<syntaxhighlight lang="java">
dataProvider DataControl {
. . .
dto cashslip type CashSlipDto attach CustomerDisplay
dto customerDisplay type CustomerDisplayDto
. . .
}
</syntaxhighlight>
# New '''events''' "'''peripheral PeripheralControl'''":
#:<syntaxhighlight lang="java">
peripheral PeripheralControl {
. . .
display CustomerDisplay using CustomerDisplay
. . .
}
</syntaxhighlight>
# Setting for customerDisplay, in '''state''' "'''IDLE'''":
#:<syntaxhighlight lang="java">
trigger onStartUp
actions transition LOCKED{
. . .
displayText false @CustomerDisplay to ^left
displayText true @CustomerDisplay to ^right
. . .
}
</syntaxhighlight>
# Setting for customerDisplay, in '''state''' "'''LOCKED'''":
#:<syntaxhighlight lang="java">
trigger onOk
actions transition ATTENTIVE{
. . .
displayText true @CustomerDisplay to ^left
displayText false @CustomerDisplay to ^right
. . .
}
</syntaxhighlight>

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

File:Display autostart.png

2018-09-11T08:35:45Z

Riegel:

OS.bee Customer Display

2018-09-11T08:35:19Z

Riegel: /* Important prerequisite */

== Customer Display ==

The latest version of the Statemachine DSL (Finite State-Machine) covers the synchronization of external (slave) browsers to a main (master) browser connected to an OS.bee server. The requirement was mainly inspired by the need of a customer display for the OS.bee POS application OS.pos. In this context it is required parts of the main screen's data which is shared on the slave browser working as a display.

Multiple displays can be connected to a master just by using a pattern on the address line of the slave-browser:

<code> http://{server_host-name}/osbpdisplay/#{host-name_of_the_master}-{DisplayName_as_defined_in_the_ui_model} </code>

► example: http://dv999.compex.de:8081/osbpdisplay/#dv888.compex.de-CustomerDisplay

* '''''http://dv999.compex.de:8081/osbp''''': this part as same as the address in main display, including server host-name and port number.
* '''''display/''''': this part is the slave name, you can attach one or more slaves on the same master.
* '''''#dv888.compex.de-''''': this part is master machine.
* '''''CustomerDisplay''''': this part is the display name which is used by this slave, and it is as same as the display name which is defined in the UI model.

=== Important prerequisite ===
In order to use external displays you must add the bundle ''org.eclipse.osbp.display'' to your product's launch configuration and set auto-start to true.
[[File:display_autostart.png|600px]]

=== Technical changes in DSL model ===

==== changes in dto ====
* New '''dto''' "'''CustomerDisplayDto'''":
*:<syntaxhighlight lang="java">
dto CustomerDisplayDto {
var double totalAmount
var boolean left
var String message
var boolean right
var BlobMapping image
ref CashSlipDto slip
}
</syntaxhighlight>
** '''totalAmount''' : total amount of all cash position.
** '''left''' & '''right''' : boolean value, define if this part will be shown on display.
** '''image''' : any image which will be shown on th display
** '''slip''' : reference the cash slip dto.

==== changes in UI====
* New '''UI''':
*:<syntaxhighlight lang="java">
display Customer {
rootType CustomerDisplayDto
datasource main:CustomerDisplayDto
datasource img:BlobConverter
horizontalLayout {
verticalLayout left {
textfield(i18n noCaption readonly) message
table(i18n noCaption) slip {
scrollToBottom
type CashPositionDto
columns {
column quantity
column product.sku
column product.product_name
column price
column amount
}
sort {
column now asc
}
}
align fill-left
form(styles "os-cash-total") {
decimalField(precision= 2 readonly) totalAmount
}
bind [this.message].value <-- img.input
bind [this.slip].collection <-- main.slip.positions
bind [this.totalAmount].value <-- main.totalAmount
}
verticalLayout right {
image info
bind img.input <-- main.^image
bind [this.info].resource <-- img.output
}
bind [this.left].visible <-- main.left
bind [this.right].visible <-- main.right
}
}
</syntaxhighlight>
** In this '''display''' "'''customer'''", we define in the 2 parts(left part & right part), if they will be shown and what will be shown in UI.

==== changes in Functionlibrary ====
* New lines in '''operation''' "'''initImages'''" & '''operation''' "'''conputeTotal'''" :
*:<syntaxhighlight lang="java">
operation initImages(IStateMachine stateMachine, Object [] params) {
. . .
stateMachine.set("CustomerDisplayImage", cashregister.store.company.companyImage)
. . .
}
</syntaxhighlight>
** In operation "'''initImages'''", the image of customerDisplay could be set.
*:<syntaxhighlight lang="java">
operation computeTotal(IStateMachine stateMachine) {
. . .
stateMachine.set("CustomerDisplayTotalAmount", amount);
. . .
}
</syntaxhighlight>
** In operation "'''computeTotal'''", the total amount of CustomerDisplay could be calculated and set.

==== changes in Statemachine ====
Some new keywords are introduced for this new functionality:
:* <syntaxhighlight lang="java"> display <DisplayName> using <DTOName> </syntaxhighlight>
:* <syntaxhighlight lang="java"> dto <DTOAlias> type <DTOName> attach <DisplayName> </syntaxhighlight>
:* <syntaxhighlight lang="java"> displayText text "some text" @<DisplayName> to <DTOAttribute> </syntaxhighlight>

The references of a DTO that is attached to a display are always synchronized across all connected displays. Single fields must be synchronized by '''displayText'''.

:► e.g.:
:*<syntaxhighlight lang="java">
display CustomerDisplay using CustomerDisplayDto
</syntaxhighlight>
:*<syntaxhighlight lang="java">
dto cashslip type CashSlipDto attach CustomerDisplay
</syntaxhighlight>
:*<syntaxhighlight lang="java">
displayText text "locked" @CustomerDisplay to message
</syntaxhighlight>
:► The referenced DTO must be the rootType of the Display definition in the ui model.

Now I will show the changes in statmachine:
# New '''events''' "'''dataProvider DataControl'''":
#:<syntaxhighlight lang="java">
dataProvider DataControl {
. . .
dto cashslip type CashSlipDto attach CustomerDisplay
dto customerDisplay type CustomerDisplayDto
. . .
}
</syntaxhighlight>
# New '''events''' "'''peripheral PeripheralControl'''":
#:<syntaxhighlight lang="java">
peripheral PeripheralControl {
. . .
display CustomerDisplay using CustomerDisplay
. . .
}
</syntaxhighlight>
# Setting for customerDisplay, in '''state''' "'''IDLE'''":
#:<syntaxhighlight lang="java">
trigger onStartUp
actions transition LOCKED{
. . .
displayText false @CustomerDisplay to ^left
displayText true @CustomerDisplay to ^right
. . .
}
</syntaxhighlight>
# Setting for customerDisplay, in '''state''' "'''LOCKED'''":
#:<syntaxhighlight lang="java">
trigger onOk
actions transition ATTENTIVE{
. . .
displayText true @CustomerDisplay to ^left
displayText false @CustomerDisplay to ^right
. . .
}
</syntaxhighlight>

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

OS.bee Customer Display

2018-09-11T08:34:10Z

Riegel:

== Customer Display ==

The latest version of the Statemachine DSL (Finite State-Machine) covers the synchronization of external (slave) browsers to a main (master) browser connected to an OS.bee server. The requirement was mainly inspired by the need of a customer display for the OS.bee POS application OS.pos. In this context it is required parts of the main screen's data which is shared on the slave browser working as a display.

Multiple displays can be connected to a master just by using a pattern on the address line of the slave-browser:

<code> http://{server_host-name}/osbpdisplay/#{host-name_of_the_master}-{DisplayName_as_defined_in_the_ui_model} </code>

► example: http://dv999.compex.de:8081/osbpdisplay/#dv888.compex.de-CustomerDisplay

* '''''http://dv999.compex.de:8081/osbp''''': this part as same as the address in main display, including server host-name and port number.
* '''''display/''''': this part is the slave name, you can attach one or more slaves on the same master.
* '''''#dv888.compex.de-''''': this part is master machine.
* '''''CustomerDisplay''''': this part is the display name which is used by this slave, and it is as same as the display name which is defined in the UI model.

=== Important prerequisite ===
In order to use external displays you must add the bundle ''org.eclipse.osbp.display'' to your product's launch configuration and set auto-start to true.
[[File:display_autostart.jpg]]

=== Technical changes in DSL model ===

==== changes in dto ====
* New '''dto''' "'''CustomerDisplayDto'''":
*:<syntaxhighlight lang="java">
dto CustomerDisplayDto {
var double totalAmount
var boolean left
var String message
var boolean right
var BlobMapping image
ref CashSlipDto slip
}
</syntaxhighlight>
** '''totalAmount''' : total amount of all cash position.
** '''left''' & '''right''' : boolean value, define if this part will be shown on display.
** '''image''' : any image which will be shown on th display
** '''slip''' : reference the cash slip dto.

==== changes in UI====
* New '''UI''':
*:<syntaxhighlight lang="java">
display Customer {
rootType CustomerDisplayDto
datasource main:CustomerDisplayDto
datasource img:BlobConverter
horizontalLayout {
verticalLayout left {
textfield(i18n noCaption readonly) message
table(i18n noCaption) slip {
scrollToBottom
type CashPositionDto
columns {
column quantity
column product.sku
column product.product_name
column price
column amount
}
sort {
column now asc
}
}
align fill-left
form(styles "os-cash-total") {
decimalField(precision= 2 readonly) totalAmount
}
bind [this.message].value <-- img.input
bind [this.slip].collection <-- main.slip.positions
bind [this.totalAmount].value <-- main.totalAmount
}
verticalLayout right {
image info
bind img.input <-- main.^image
bind [this.info].resource <-- img.output
}
bind [this.left].visible <-- main.left
bind [this.right].visible <-- main.right
}
}
</syntaxhighlight>
** In this '''display''' "'''customer'''", we define in the 2 parts(left part & right part), if they will be shown and what will be shown in UI.

==== changes in Functionlibrary ====
* New lines in '''operation''' "'''initImages'''" & '''operation''' "'''conputeTotal'''" :
*:<syntaxhighlight lang="java">
operation initImages(IStateMachine stateMachine, Object [] params) {
. . .
stateMachine.set("CustomerDisplayImage", cashregister.store.company.companyImage)
. . .
}
</syntaxhighlight>
** In operation "'''initImages'''", the image of customerDisplay could be set.
*:<syntaxhighlight lang="java">
operation computeTotal(IStateMachine stateMachine) {
. . .
stateMachine.set("CustomerDisplayTotalAmount", amount);
. . .
}
</syntaxhighlight>
** In operation "'''computeTotal'''", the total amount of CustomerDisplay could be calculated and set.

==== changes in Statemachine ====
Some new keywords are introduced for this new functionality:
:* <syntaxhighlight lang="java"> display <DisplayName> using <DTOName> </syntaxhighlight>
:* <syntaxhighlight lang="java"> dto <DTOAlias> type <DTOName> attach <DisplayName> </syntaxhighlight>
:* <syntaxhighlight lang="java"> displayText text "some text" @<DisplayName> to <DTOAttribute> </syntaxhighlight>

The references of a DTO that is attached to a display are always synchronized across all connected displays. Single fields must be synchronized by '''displayText'''.

:► e.g.:
:*<syntaxhighlight lang="java">
display CustomerDisplay using CustomerDisplayDto
</syntaxhighlight>
:*<syntaxhighlight lang="java">
dto cashslip type CashSlipDto attach CustomerDisplay
</syntaxhighlight>
:*<syntaxhighlight lang="java">
displayText text "locked" @CustomerDisplay to message
</syntaxhighlight>
:► The referenced DTO must be the rootType of the Display definition in the ui model.

Now I will show the changes in statmachine:
# New '''events''' "'''dataProvider DataControl'''":
#:<syntaxhighlight lang="java">
dataProvider DataControl {
. . .
dto cashslip type CashSlipDto attach CustomerDisplay
dto customerDisplay type CustomerDisplayDto
. . .
}
</syntaxhighlight>
# New '''events''' "'''peripheral PeripheralControl'''":
#:<syntaxhighlight lang="java">
peripheral PeripheralControl {
. . .
display CustomerDisplay using CustomerDisplay
. . .
}
</syntaxhighlight>
# Setting for customerDisplay, in '''state''' "'''IDLE'''":
#:<syntaxhighlight lang="java">
trigger onStartUp
actions transition LOCKED{
. . .
displayText false @CustomerDisplay to ^left
displayText true @CustomerDisplay to ^right
. . .
}
</syntaxhighlight>
# Setting for customerDisplay, in '''state''' "'''LOCKED'''":
#:<syntaxhighlight lang="java">
trigger onOk
actions transition ATTENTIVE{
. . .
displayText true @CustomerDisplay to ^left
displayText false @CustomerDisplay to ^right
. . .
}
</syntaxhighlight>

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

OS.bee Software Factory Unique Selling Propositions

2018-07-03T08:42:14Z

Riegel:

= Abstract =

OS.bee is a low-code model-driven software-factory, using over 20 Domain Specific Languages (DSL) to generate large-scale business web-applications. Each DSL contains a grammar for a required application-layer. A DSL hides complexity from successors, thereby enabling parallel modelling of domain requirements by multiple designers as they don’t need to know the domain logic they build upon. A model created with a DSL creates executable code, structured data and configuration settings or is interpreted by a renderer during runtime. The language of each DSL uses a grammar that makes the created model easy to understand and forms a requirement specification on its layer. The overall hierarchy can be browsed through at any time and gives a good understanding of the whole application in nearly natural English language. A DSL can also be studied by its syntactical graph. The creation of a model is a guided process through the syntax graph where the designer benefits from content assistance, code completion, quick fix, syntax colorizing, outline, formatting and validation. Many DSLs define metadata to be used by subsequent DSL to increase the leverage of definitions at a basic level. All element names defined by a DSL are automatically extracted to localization files for translation to open foreign markets for the resulting application. The ratio between the generated lines of code versus the numbers of lines in a model is 8 on average. Development speed improves by a similar factor. Dependencies between models reveal inconsistencies immediately while modifying and prevent generating code until these are resolved. Therefore turnaround cycles are short, errors are easy to discover and prototypes materialize in a very short time. Some DSL generate against famous open-source frameworks like EclipseLink, Smooks, Mondrian, Vaadin or jBPM thus enabling non-developers to use complex frameworks without deeper knowledge of their API. OS.bee inherits the features of the embedded frameworks and makes them easy to exploit for specialists of a domain not necessarily being software developer.

= DSL Modeling =

== Persistence ==

Persistence refers to object and process characteristics that continue to exist even after the process that created it ceases or the machine it is running on is powered off. When an object or state is created and needs to be persistent, it is saved in a non-volatile storage location, like a hard drive, versus a temporary file or volatile random access memory.

=== Data-type ===

A data type is a classification that specifies which type of value a variable has and what type of mathematical, relational or logical operations can be applied to it without causing an error. Data types also hold metadata for higher-level DSLs so they can apply additional functionality to a field using this data type.

* Primitive Types (int, double, etc.)
* Object Types (String, Date, etc.)
* Blob
** Store and retrieve any document or image type in binary form
* Auto-sizing Images
** Additionally stores images of definable size to experience better performance while rendering
* Formatted types
** Dates and times in any localized form
** Dates and times in any format (time only, date only, short and long forms, custom pattern, etc.)
** Currencies in any localized form
* Validated types with adjustable severity message
** Date in past/future
** Not null
** Not duplicate
** Range values
** Min/max length
* Slider types
** Min/max values
* Masked types
** Number, Hexadecimal, Capitalized
** Input pattern (e.g. Phone Numbers (###) ###-####)
** Password
* Suggestion types
** While typing some characters, a sorted list of suggestions pops up for selection
* Programmable Converters
** Text-to-Image
** Number-to-Text/Image
** Value-to-CSS Style
** Units of measurement
* Rich text editor using HTML markups
* Text area

=== Entity ===

An entity (-type) is a model of metadata for a single unique object in the real world. For example a person, organization, object type, or concept about which information is stored. Together with its attributes (or properties) it describes information that is being mastered. An entity typically corresponds to one or several related tables in database. An attribute is a characteristic or trait of an entity that describes the entity, for example, the Person entity type has the Date of Birth attribute.

* Simple Entity
* Mapped super-classes
** Complement attributes in every entity using this
* Inheritance
** Specialized classes for special purpose
* References and their opposites
* References with constraints
* Embeddable beans
* Number generators UUID or ID
* Separated persistence-units capable of using multiple databases simultaneously
* All multiplicities (0..1, 0..n,1..1,1..n,*)
* Indexes unique and non-unique
* Validated uniqueness
* Domain-key annotation for lookups
* Methods for calculated attributes
* Lifecycle controlled method invoking (by PostLoad, PrePersist, etc.)
* Affected changes listeners
* Localizable Enumerations with images
* Creation and last modification information
* Transient data
* Synthetic attributes built by lifecycle methods either transient or persistent
* Historicized data
* Temporal data
* Versioned data
* Definable Runtime data filter
* Programmable Validators
* Nested Filter attributions over multiple references
* Abstraction of database vendor specific implementations

=== Data transfer object (DTO) ===

A DTO is an object that carries data between processes. DTOs are simple objects that do not contain any business logic but may contain serialization and deserialization mechanisms for transferring data.

* Independent nested data container
* Automatically generated for entities
* Automatically mapped by entity data
* Editable sub- or supersets for entities
* Transient data container
* Nested objects automatically synchronized
* Nested properties access through dot expressions
* Used for services, processes, functions and renderers
* Dirty state aware
* Access restrictions on DTO and property granularity controlled by security layer

=== DTO Service ===

A DTO service abstracts and encapsulates all access to the data source. It manages the connection with the data source to obtain and store data and implements the access mechanism required to work with the data source. The data source could be a persistent store like an RDBMS, or a business service accessed via REST or SOAP.

* Data storage and retrieval suitable for DTO
* Nested Transactions and Lock-modes
* Global transactions
* Object Oriented Query engine
* Low level Java Persistence Query Language method declarations (e.g. getTotal(), getAverage(), …)
* Injectable and declarative service
* Used for services, processes, functions and renderers
* Session scoped Entity Manager
* Thread safe persistence-unit bound Entity Manager Factory

=== Data-Interchange ===

Data Interchange is the endpoint-to-endpoint exchange of business documents in a standard electronic format between business partners or computer systems.

* Smooks and FreeMarker implementation
* Nested entity import- and export-paths
* Localized formatters on data
* Supports encoding
* XML and CSV formats
* All EDI messages
* Automatically set export- and import markers for database
* Filtered exports
* Bulk insert/update
* Progress bar
* Generated import and export dashboard
* Generated lookup queries to embed relational data
* Merge or persist external data
* Import images of different mime-types into blobs via filename pattern
* Usage of expressions
* Free attribute mappings

=== Signal ===

Signal processes events coming from file-systems. If a file that matches a given filename pattern is created, modified or deleted then an event is received and the modelled actions will be called. Signal also emits events for recurring things like a certain weekday and time is reached and executes the modelled actions.

* File watcher for all file activities working on all operating systems
* Free filename pattern to watch for

* Trigger Data-Interchange
* Definable export or import job-chain
* Synchronously or asynchronously execution (depending on import relationship)
* Quartz implementation for scheduled Data-Interchange export-jobs

=== Entity-Mock ===

Mock objects are simulated objects that mimic the behavior of real objects in controlled ways. A programmer typically creates a mock object to test the behavior of some other object, in much the same way that a car designer uses a crash test dummy to simulate the dynamic behavior of a human in vehicle impacts.

* Generates fake data looking realistic

* Mapping of roles to positions and multi-positions

* Rule-based data composition (e.g. email address)
* Rule-based attribute generators for every data-type from data composition, or
** Randomly
** Ranges
** Picks from a given list
** Dates in the past with offset and limit (for birthdays)
** Dates in the future with offset and limit
* Composes objects from rule-based attribute generators (e.g. a person, a company, etc.)
* Composes object-trees from composed objects
* Creates relationships between objects using a given probability
* Creates mass data (e.g. sales data)
* Imports fixed data via Data-Interchange and embeds it
* Used mainly for quick-setup applications using a H2 database
* Exposes mock data services to be executed before any login-attempt
* Persists into all supported database products
* Can be executed at every server-start or once

== Business intelligence ==

Business Intelligence (BI) refers to technologies, applications and practices for the collection, integration, analysis, and presentation of business information. The purpose of Business Intelligence is to support better business decision making. Essentially, Business Intelligence systems are data-driven Decision Support Systems (DSS). Business Intelligence is sometimes used interchangeably with briefing books, report and query tools and executive information systems.

=== Cube ===

A cube is a method of storing data in a multidimensional form, generally for reporting purposes. In cubes, data (measures) are categorized by dimensions. Cubes are pre-summarized across dimensions to drastically improve query time over relational databases. The query language used to interact and perform tasks with cubes is multidimensional expressions (MDX).

* Mondrian OLAP for MDX queries implementation
* Cubes, dimensions, hierarchies, levels, members, and measures
* Defines a multi-dimensional database
* Contains a logical model, and a mapping of this model onto the physical entity model

=== DataMart ===

A data mart is a subject-oriented archive that stores data and uses the retrieved set of information to assist and support the requirements involved within a particular business function or department. Data marts improve end-user response time by allowing users to have access to the specific type of data they need to view most often by providing the data in a way that supports the collective view of a group of users.

* Common layer for data-warehouse queries
* Simplification of any kind of query against all available data sources
* Tailored queries and aggregates for different interest-groups
* Definition of complex multidimensional expressions (MDX) with a simple grammar
* Sophisticated analytic functions easy to use
* Online analytical processing built in
* Access to runtime data of the Business Process management engine
* Multi-purpose results for processes, reports, score cards and charts
* Definable navigation trees (join-paths)
* Definable single- and multi-selection filters on any leaf of the query tree
* Access restrictions on entity and attribute granularity controlled by security layer

=== Function-Library ===

A function-library is a collection of non-volatile resources used by other DSLs. It is a collection of implementations of behavior, written in Xbase, which has a well-defined interface by which the behavior is invoked. Library code is organized in such a way that it can be used by multiple programs that have no connection to each other, in other words it is completely independent of the calling logic.

* Xbase implementation
* UOMo implementation
* Creates operational objects and methods
* Grouped by application field
** Converter for model-presentation conversions
*** Value to image
*** Value to value
*** Value to style (background color, text color, font-style, etc.)
*** Value to unit of measurement based value
*** Between measurement systems and unit of measurement families
** State-Machine
*** Operations
*** Functions
*** Guards
*** Full access to state-machine controls
** Toolbar Action
*** Can execute validation (enable/disable operation)
*** Execute any operation
** Validation on DTO
** Business logic implementation for BPM
*** Functions callable in system tasks
*** Ratings for gateways
*** Tests for gateways
** Calculations e.g. for
*** Currencies
*** Lengths
*** Areas
** Posting operations
* Exposes injectable and declarative service
* Store and retrieve data from DTO
* Full access to all JVM objects

=== State-Machine ===

A finite-state machine (FSM) is a mathematical model of computation. It is an abstract machine that can be in exactly one of a finite number of states at any given time. The FSM can change from one state to another in response to an event. The change from one state to another is called a transition. An FSM is defined by a list of its states, its initial state, and the conditions for each transition. These conditions are called guards as they guard the transition from unwanted invocation.

* Implementation of business behavior
* Defines states and their transitions
* Transitions are triggered by events
* Transitions are guarded by functions from Function-Library
* Actions to be executed before and after transitioning from Function-Library
* Has things to control
** Database objects (DTO)
** Database filters
** Visibility or enabling of
*** Buttons (UI)
*** Layouts (UI)
*** Other components (UI)
** Peripheral devices (interfaces JavaPOS)
*** Printers
*** Line displays
*** Cash drawers
*** Payment terminals
*** Signature pads
** Slave browsers (external displays, etc.)
* Receives events from
** Buttons clicked
** UI selections
** Peripherals (printer out of paper, etc.)
** Schedulers

=== BLiP (Business Logic implementation Platform) ===

BLiP focuses on improving corporate performance by managing business processes (BPM), business rules and business logic (Function-Library).  It is a disciplined approach to identify, design, execute, document, measure, monitor, and control both automated and non-automated business processes to achieve consistent, targeted results aligned with an organization’s strategic goals. BPM involves the deliberate and collaborative definition, improvement, innovation, and management of end-to-end business processes that drive business results, create value, and enable an organization to meet its business objectives with more agility. BPM enables an enterprise to align its business processes to its business strategy, leading to effective overall company performance through improvements of specific work activities either within a specific department, across the enterprise, or between organizations.

* Implements jBPM
* Integrates a BPMN editor at design-time
* Connects tasks of BPM to business logic of Function-Library
* Controls sequence-flow through business logic of Function-Library
* Stores and retrieves process save-points
* Logs all process activities of system and user
* Exposes BPM data and events to UI elements
* Stores and retrieves workload data using DTO

== Presentation ==

The presentation layer ensures that the communications that pass through it are in the appropriate form for the recipient application. It is responsible for the delivery and formatting of information to the application layer for further processing or display. It relieves the application layer of concern regarding syntactical differences in data representation within the end-user systems.

=== Table ===

A table is a data structure that organizes information into rows and columns. It can be used to both store and display data in a structured format.

* Editable cells
* Scorecard elements
** Rule-based colorizing of cell background and textcolor
** Mixed in rule-based icons
** Rule-based styling of cells
** Rule-based tooltips
* Data from DataMart or DTO
* Pivot presentation
* Multidimensional presentation on nested tab-sheets
* Filtering, sorting, swapping and hiding of columns
* Stores swapping and hiding per user
* 3 different row numbering modes
* Row selection synchronizes other views in scope

=== Chart ===

A chart is a diagram, picture, or graph which is intended to make information easier to understand. It is a symbolic representation of information according to some visualization technique.

* Multiple data series with selectable colorizing
* Series switchable from legend
* Bar, line, pie, donut, bubble and gauge presentation
* Animated, stacked, shaded and xy-swapped charts
* Zoom and trend-line function
* Tooltips for series and data points with absolute value
* Selectable positioning relative to cursor for tooltips
* Selectable legend placement
* Collapsible tree presentation on hierarchical data
* Date axes with customizable formatting
* Up to 9 individually scalable Y axes
* Rotated axis text
* Category rendering either linear, logarithmic, timeline or as pyramid
* Downloadable SVG image

=== Report ===

A document containing information organized in a graphic or tabular form, prepared on ad hoc, periodic, recurring, regular, or as required basis. Reports may refer to specific periods, events, occurrences, or subjects, and are presented in printed form.

* Actuate Birt implementation
* Definition of reusable layout metadata
** All units of measurement for layouts
** Definition of fonts and colors
** Definition of formatters for
*** Currencies
*** Date and time
** Page sizes (A4, A5, etc.)
** Orientations (Landscape, portrait)
** Margins
** Paddings
** Alignments
* Output as HTML or PDF
* Ability to reference multiple DataMarts for header, footer and details
* Rendering of blob-images
* External CSS usable
* Defines grids and cells
* Direct printing to preselected output medias per user or per location and report
* Rule-based visibility of cells
* Aggregates for grouping
* Rule-based page break
* Rule-based colorizing and styling
* URL-based or embedded images
* Auto-texts (page number etc.)

=== Topology ===

Topology is designed for representing simple geographical features, along with their non-spatial attributes. It includes geo-json points (addresses and locations), line strings (streets, highways and boundaries), polygons (countries, provinces, tracts of land), and multi-part collections of these types.

* D3 implementation
* Render predefined maps of U.S.A., Germany, Spain… the World
* Select states, countries, regions or cities to synchronize other views in scope
* Render geo-json data from blobs to show boundaries of plots of land, buildings or floor plans

=== UI ===

The user interface (UI) is the space where interactions between humans and OS.bee occur. The goal of this interaction is to allow effective operation and control of the machine from the human end, whilst the machine simultaneously feeds back information that aids the operators' decision-making process.

* Models interactive views
* Connects to data-sources of any kind (DTO, Bean, JVM object, etc.)
* Nests different kinds of layouts to a complex surface (horizontal, vertical, form, grid)
* Adds components to layouts (buttons, text-fields, tables, images, etc.)
* Binds components to properties of data-sources
* Rule-based visibility processor
* Navigation widgets for small geometry mobile devices

=== Dialog ===

The dialog is a composite UI which is composed by either an automatically generated UI or a UI created with means of the UI DSL and actions that are available through a toolbar. It also can be combined with an instance of State-Machine DSL if a sophisticated control over the visibility of components and a definable usage-sequence is needed.

* Renders interactive views
* Either references a predefined UI model or a model inferred from a DTO
* Links the view to a toolbar
* Renders different modes
** Normal, to be used inside perspectives
** Embedded, to be used inside menues
** Stateful, inside perspectives, and controlled by a state-machine
** Mobile, to be used on small geometry mobile devices with navigation widgets
* Renders in 1 to N columns of components
* Groups components by using entity metadata
* Renders owning relationships as combo-boxes
* Renders member relationships as tables on tab-sheets
* Implements blob up- and downloading

=== Perspective ===

A perspective is a visual container for a set of views (parts). These parts exist wholly within the perspective and are not shared. A perspective is also like a page within a book. It exists within a window along with any number of other perspectives and, like a page within a book, only one perspective is visible at any time.

* Based on the Eclipse 4 application model
* Presents a 360° view on the task to the user
* Divides the usable screen area in resizable containers
* Nests windows, perspective-stacks, perspectives, containers, part-stacks and parts containing views, and toolbars
* Stores and retrieves resized areas for each user
* Supports drag and drop
* Event dispatching system to synchronize data, actions, focus and more between views
* References all types of views (dialogs, tables, charts, reports …) to set up a dashboard
* Modifiable layout at runtime using the designer mode for permitted users
* Connects to user tasks of BPM

=== Action ===

A toolbar is a set of icons or buttons that are part of a software program's interface or an open window. A toolbar item is an object type that associates a command with a toolbar. This association places an icon on the toolbar in a specific location relative to the other toolbar icons on that toolbar. A command is linked to a specific action and can have a keyboard shortcut specification.

* Links action-buttons
** To business logic of Function-Library to be executed
*** Synchronously
*** Asynchronously as background process
** To Data-Interchange import- or export tasks
** To BPM start events
** To actions to trigger
*** Save, delete, download, print etc.
*** Advance focus to next or previous part
* Links action-buttons to business logic of Function-Library to be
** Enabled
** Disabled depending on data context
* Defines commands to control the application and trigger actions
* Assigns keyboard short-cuts to commands
* Connects to Message for fail or success messages about executed actions

=== Menu ===

A menu is a list of options or commands presented to the user of OS.bee. A menu appears as a tree structure if the popup button besides the user-image is pressed. It is the user-specific point of entry into the OS.bee system. The user menu contains only those items that are needed to perform daily tasks.

* Combines Perspectives, BPM start events, embedded dialogs and tables, configuration settings and other informative screens to a tree-organized menu
* Pops up anytime it is needed, and consumes no space on the screen

=== Message ===

Messages can be defined to improve the user experience as guidance through complex user interactions with the system. For security and monitoring reasons they can be logged.

* Defines messages to notify a user about events and usage violations
* Can be tracked by log entries
* Placeholders for parametrizing messages
* Can have a severity

== Security ==

Security's mission is to protect the companies and their assets (know-how, company data, personal and customer data and personal data, etc.) from hackers, crackers and robbers, and economic damage caused by breaches of confidentiality, manipulation, hardware failure and availability prevent the systems.

=== Authorization ===

Authorization is a security mechanism to determine access levels and user privileges related to system resources including files, services, data and application features. This is the process of granting or denying access to a resource which allows the user access to various resources based on the user's identity.

* Role-based authorization system
* Grant access to entities, beans and DTO
* Grant access to CRUD operations (create, read, update, delete)
* Grant access to modification of relationships (link, unlink references)
* Vetoes per attribute for visibility, editability and enabling
* Grant access to start a process
* Grant access working on a user task

=== Organization ===

An organization is an entity comprising multiple people, such as an institution or an association that has a collective goal and is linked to an external environment. Its design specifies how goals are subdivided and reflected in subdivisions of the organization. An organization can be visualized in an organigram.

* Hierarchies of positions, multi-positions, and sub-organizations
* Maps roles to positions
* Definition of levels of collaboration if sharing the same roles
* Derives an organigram of each hierarchy to be rendered at runtime

= Services =

== Authentication ==

Authentication is a process that ensures and confirms a user’s identity. To do so, a user needs to provide some sort of proof of identity that the system understands and trust. There are multiple ways (realms) to do this:

* Security specific data access object, software component that talks to a backend data source.
* If you have usernames and password in LDAP, then you would have an LDAP Realm that would communicate with LDAP.
* Active Directory
* Kerberos

More features:* Remember-me
* Forgot password
* Protection against brute-force attacks
* MD5 salted and encrypted passwords
* Protection against debugging
* First commissioning support
* Session management
* Simple Single Sign-On (SSO)
* AES 128 encrypted cookie support

== Persistence ==

Persistence service enabling small data-sources as well as large-scale installations:* XA data-source support for distributed transactions
* Built in global transaction manager
* JNDI Service
* Built in support for local databases
* Supports database providers from Application Server implementations like WebSphere or WebLogic Server
* Provides JDBC and catalog data for Mondrian
* Supports all compatible databases to EclipseLink like:
** Oracle
** Oracle JDBC (8, 9, 10, 11)
** MySQL
** PostgreSQL
** Derby
** DB2
** DB2 (mainframe)
** Microsoft SQL Server
** Sybase
** Informix
** SQL Anywhere
** HSQL
** SAP HANA
** H2
** Firebird
** Microsoft Access
** Attunity
** Cloudscape
** DBase
** PointBase
** TimesTen
** Symfoware
** MaxDB

== Translation ==

There is a centralized translation service in OS.bee. It collects all property files from models created by a DSL and supplies all internal translations that the Software Factory needs. The number of supported languages is unlimited; however the internal translations deployed for the moment are limited to English, French, and German. More languages can be ordered. In case a translation key occurs multiple times, the “best” translation for this key is automatically selected. The “best” translation is evaluated by the maximum Levinshtein distance from the translation key.

== Metadata ==

OS.bee holds all model-data at runtime so that all programs can reference them. Renderers that do not need code will interpret these model to do their work. So even in the Function-Library it is possible to take the current modeling into account.

== Theme Resources and CSS ==

As usual for web-frontend applications, cascaded style sheets describe the look and feel. Custom CSS can be loaded from outside, or any modification can be made once the appropriate bundle is downloaded. CSS is compiled from a SCCS template with a pre-processor. The advantage of using SCSS is that you can use variables and therefore create different looks with just a hand-full of variables. OS.bee comes with 3 different theme variants that can be selected in the user profile. Resources like images, html pages and icons are available per theme and thus adjustable to the used color scheme.

OS.bee Software Factory Unique Selling Propositions

2018-06-29T13:13:56Z

Riegel:

OS.bee Features

= Abstract =

OS.bee is a low-code model-driven software-factory, using over 20 Domain Specific Languages (DSL) to generate large-scale business web-applications. Each DSL contains a grammar for a required application-layer. A DSL hides complexity from successors, thereby enabling parallel modelling of domain requirements by multiple designers as they don’t need to know the domain logic they build upon. A model created with a DSL creates executable code, structured data and configuration settings or is interpreted by a renderer during runtime. The language of each DSL uses a grammar that makes the created model easy to understand and forms a requirement specification on its layer. The overall hierarchy can be browsed through at any time and gives a good understanding of the whole application in nearly natural English language. A DSL can also be studied by its syntactical graph. The creation of a model is a guided process through the syntax graph where the designer benefits from content assistance, code completion, quick fix, syntax colorizing, outline, formatting and validation. Many DSLs define metadata to be used by subsequent DSL to increase the leverage of definitions at a basic level. All element names defined by a DSL are automatically extracted to localization files for translation to open foreign markets for the resulting application. The ratio between the generated lines of code versus the numbers of lines in a model is 8 on average. Development speed improves by a similar factor. Dependencies between models reveal inconsistencies immediately while modifying and prevent generating code until these are resolved. Therefore turnaround cycles are short, errors are easy to discover and prototypes materialize in a very short time. Some DSL generate against famous open-source frameworks like EclipseLink, Smooks, Mondrian, Vaadin or jBPM thus enabling non-developers to use complex frameworks without deeper knowledge of their API. OS.bee inherits the features of the embedded frameworks and makes them easy to exploit for specialists of a domain not necessarily being software developer.

= DSL Modeling =

== Persistence ==

Persistence refers to object and process characteristics that continue to exist even after the process that created it ceases or the machine it is running on is powered off. When an object or state is created and needs to be persistent, it is saved in a non-volatile storage location, like a hard drive, versus a temporary file or volatile random access memory.

=== Data-type ===

A data type is a classification that specifies which type of value a variable has and what type of mathematical, relational or logical operations can be applied to it without causing an error. Data types also hold metadata for higher-level DSLs so they can apply additional functionality to a field using this data type.

* Primitive Types (int, double, etc.)
* Object Types (String, Date, etc.)
* Blob
** Store and retrieve any document or image type in binary form
* Auto-sizing Images
** Additionally stores images of definable size to experience better performance while rendering
* Formatted types
** Dates and times in any localized form
** Dates and times in any format (time only, date only, short and long forms, custom pattern, etc.)
** Currencies in any localized form
* Validated types with adjustable severity message
** Date in past/future
** Not null
** Not duplicate
** Range values
** Min/max length
* Slider types
** Min/max values
* Masked types
** Number, Hexadecimal, Capitalized
** Input pattern (e.g. Phone Numbers (###) ###-####)
** Password
* Suggestion types
** While typing some characters, a sorted list of suggestions pops up for selection
* Programmable Converters
** Text-to-Image
** Number-to-Text/Image
** Value-to-CSS Style
** Units of measurement
* Rich text editor using HTML markups
* Text area

=== Entity ===

An entity (-type) is a model of metadata for a single unique object in the real world. For example a person, organization, object type, or concept about which information is stored. Together with its attributes (or properties) it describes information that is being mastered. An entity typically corresponds to one or several related tables in database. An attribute is a characteristic or trait of an entity that describes the entity, for example, the Person entity type has the Date of Birth attribute.

* Simple Entity
* Mapped super-classes
** Complement attributes in every entity using this
* Inheritance
** Specialized classes for special purpose
* References and their opposites
* References with constraints
* Embeddable beans
* Number generators UUID or ID
* Separated persistence-units capable of using multiple databases simultaneously
* All multiplicities (0..1, 0..n,1..1,1..n,*)
* Indexes unique and non-unique
* Validated uniqueness
* Domain-key annotation for lookups
* Methods for calculated attributes
* Lifecycle controlled method invoking (by PostLoad, PrePersist, etc.)
* Affected changes listeners
* Localizable Enumerations with images
* Creation and last modification information
* Transient data
* Synthetic attributes built by lifecycle methods either transient or persistent
* Historicized data
* Temporal data
* Versioned data
* Definable Runtime data filter
* Programmable Validators
* Nested Filter attributions over multiple references
* Abstraction of database vendor specific implementations

=== Data transfer object (DTO) ===

A DTO is an object that carries data between processes. DTOs are simple objects that do not contain any business logic but may contain serialization and deserialization mechanisms for transferring data.

* Independent nested data container
* Automatically generated for entities
* Automatically mapped by entity data
* Editable sub- or supersets for entities
* Transient data container
* Nested objects automatically synchronized
* Nested properties access through dot expressions
* Used for services, processes, functions and renderers
* Dirty state aware
* Access restrictions on DTO and property granularity controlled by security layer

=== DTO Service ===

A DTO service abstracts and encapsulates all access to the data source. It manages the connection with the data source to obtain and store data and implements the access mechanism required to work with the data source. The data source could be a persistent store like an RDBMS, or a business service accessed via REST or SOAP.

* Data storage and retrieval suitable for DTO
* Nested Transactions and Lock-modes
* Global transactions
* Object Oriented Query engine
* Low level Java Persistence Query Language method declarations (e.g. getTotal(), getAverage(), …)
* Injectable and declarative service
* Used for services, processes, functions and renderers
* Session scoped Entity Manager
* Thread safe persistence-unit bound Entity Manager Factory

=== Data-Interchange ===

Data Interchange is the endpoint-to-endpoint exchange of business documents in a standard electronic format between business partners or computer systems.

* Smooks and FreeMarker implementation
* Nested entity import- and export-paths
* Localized formatters on data
* Supports encoding
* XML and CSV formats
* All EDI messages
* Automatically set export- and import markers for database
* Filtered exports
* Bulk insert/update
* Progress bar
* Generated import and export dashboard
* Generated lookup queries to embed relational data
* Merge or persist external data
* Import images of different mime-types into blobs via filename pattern
* Usage of expressions
* Free attribute mappings

=== Signal ===

Signal processes events coming from file-systems. If a file that matches a given filename pattern is created, modified or deleted then an event is received and the modelled actions will be called. Signal also emits events for recurring things like a certain weekday and time is reached and executes the modelled actions.

* File watcher for all file activities working on all operating systems
* Free filename pattern to watch for

* Trigger Data-Interchange
* Definable export or import job-chain
* Synchronously or asynchronously execution (depending on import relationship)
* Quartz implementation for scheduled Data-Interchange export-jobs

=== Entity-Mock ===

* Generates fake data looking realistic

* Mapping of roles to positions and multi-positions

* Rule-based data composition (e.g. email address)
* Rule-based attribute generators for every data-type from data composition, or
** Randomly
** Ranges
** Picks from a given list
** Dates in the past with offset and limit (for birthdays)
** Dates in the future with offset and limit
* Composes objects from rule-based attribute generators (e.g. a person, a company, etc.)
* Composes object-trees from composed objects
* Creates relationships between objects using a given probability
* Creates mass data (e.g. sales data)
* Imports fixed data via Data-Interchange and embeds it
* Used mainly for quick-setup applications using a H2 database
* Exposes mock data services to be executed before any login-attempt
* Persists into all supported database products
* Can be executed at every server-start or once

== Business intelligence ==

Business Intelligence (BI) refers to technologies, applications and practices for the collection, integration, analysis, and presentation of business information. The purpose of Business Intelligence is to support better business decision making. Essentially, Business Intelligence systems are data-driven Decision Support Systems (DSS). Business Intelligence is sometimes used interchangeably with briefing books, report and query tools and executive information systems.

=== Cube ===

A cube is a method of storing data in a multidimensional form, generally for reporting purposes. In cubes, data (measures) are categorized by dimensions. Cubes are pre-summarized across dimensions to drastically improve query time over relational databases. The query language used to interact and perform tasks with cubes is multidimensional expressions (MDX).

* Mondrian OLAP for MDX queries implementation
* Cubes, dimensions, hierarchies, levels, members, and measures
* Defines a multi-dimensional database
* Contains a logical model, and a mapping of this model onto the physical entity model

=== DataMart ===

A data mart is a subject-oriented archive that stores data and uses the retrieved set of information to assist and support the requirements involved within a particular business function or department. Data marts improve end-user response time by allowing users to have access to the specific type of data they need to view most often by providing the data in a way that supports the collective view of a group of users.

* Common layer for data-warehouse queries
* Simplification of any kind of query against all available data sources
* Tailored queries and aggregates for different interest-groups
* Definition of complex multidimensional expressions (MDX) with a simple grammar
* Sophisticated analytic functions easy to use
* Online analytical processing built in
* Access to runtime data of the Business Process management engine
* Multi-purpose results for processes, reports, score cards and charts
* Definable navigation trees (join-paths)
* Definable single- and multi-selection filters on any leaf of the query tree
* Access restrictions on entity and attribute granularity controlled by security layer

=== Function-Library ===

* Xbase implementation
* UOMo implementation
* Creates operational objects and methods
* Grouped by application field
** Converter for model-presentation conversions
*** Value to image
*** Value to value
*** Value to style (background color, text color, font-style, etc.)
*** Value to unit of measurement based value
*** Between measurement systems and unit of measurement families
** State-Machine
*** Operations
*** Functions
*** Guards
*** Full access to state-machine controls
** Toolbar Action
*** Can execute validation (enable/disable operation)
*** Execute any operation
** Validation on DTO
** Business logic implementation for BPM
*** Functions callable in system tasks
*** Ratings for gateways
*** Tests for gateways
** Calculations e.g. for
*** Currencies
*** Lengths
*** Areas
** Posting operations
* Exposes injectable and declarative service
* Store and retrieve data from DTO
* Full access to all JVM objects

=== State-Machine ===

* Implementation of business behavior
* Defines states and their transitions
* Transitions are triggered by events
* Transitions are guarded by functions from Function-Library
* Actions to be executed before and after transitioning from Function-Library
* Has things to control
** Database objects (DTO)
** Database filters
** Visibility or enabling of
*** Buttons (UI)
*** Layouts (UI)
*** Other components (UI)
** Peripheral devices (interfaces JavaPOS)
*** Printers
*** Line displays
*** Cash drawers
*** Payment terminals
*** Signature pads
** Slave browsers (external displays, etc.)
* Receives events from
** Buttons clicked
** UI selections
** Peripherals (printer out of paper, etc.)
** Schedulers

=== BLiP (Business Logic implementation Platform) ===

* Implements jBPM
* Integrates a BPMN editor at design-time
* Connects tasks of BPM to business logic of Function-Library
* Controls sequence-flow through business logic of Function-Library
* Stores and retrieves process save-points
* Logs all process activities of system and user
* Exposes BPM data and events to UI elements
* Stores and retrieves workload data using DTO

== Presentation ==

The presentation layer ensures that the communications that pass through it are in the appropriate form for the recipient application. It is responsible for the delivery and formatting of information to the application layer for further processing or display. It relieves the application layer of concern regarding syntactical differences in data representation within the end-user systems.

=== Table ===

A table is a data structure that organizes information into rows and columns. It can be used to both store and display data in a structured format.

* Editable cells
* Scorecard elements
** Rule-based colorizing of cell background and textcolor
** Mixed in rule-based icons
** Rule-based styling of cells
** Rule-based tooltips
* Data from DataMart or DTO
* Pivot presentation
* Multidimensional presentation on nested tab-sheets
* Filtering, sorting, swapping and hiding of columns
* Stores swapping and hiding per user
* 3 different row numbering modes
* Row selection synchronizes other views in scope

=== Chart ===

A chart is a diagram, picture, or graph which is intended to make information easier to understand. It is a symbolic representation of information according to some visualization technique.

* Multiple data series with selectable colorizing
* Series switchable from legend
* Bar, line, pie, donut, bubble and gauge presentation
* Animated, stacked, shaded and xy-swapped charts
* Zoom and trend-line function
* Tooltips for series and data points with absolute value
* Selectable positioning relative to cursor for tooltips
* Selectable legend placement
* Collapsible tree presentation on hierarchical data
* Date axes with customizable formatting
* Up to 9 individually scalable Y axes
* Rotated axis text
* Category rendering either linear, logarithmic, timeline or as pyramid
* Downloadable SVG image

=== Report ===

A document containing information organized in a graphic or tabular form, prepared on ad hoc, periodic, recurring, regular, or as required basis. Reports may refer to specific periods, events, occurrences, or subjects, and are presented in printed form.

* Actuate Birt implementation
* Definition of reusable layout metadata
** All units of measurement for layouts
** Definition of fonts and colors
** Definition of formatters for
*** Currencies
*** Date and time
** Page sizes (A4, A5, etc.)
** Orientations (Landscape, portrait)
** Margins
** Paddings
** Alignments
* Output as HTML or PDF
* Ability to reference multiple DataMarts for header, footer and details
* Rendering of blob-images
* External CSS usable
* Defines grids and cells
* Direct printing to preselected output medias per user or per location and report
* Rule-based visibility of cells
* Aggregates for grouping
* Rule-based page break
* Rule-based colorizing and styling
* URL-based or embedded images
* Auto-texts (page number etc.)

=== Topology ===

Topology is designed for representing simple geographical features, along with their non-spatial attributes. It includes geo-json points (addresses and locations), line strings (streets, highways and boundaries), polygons (countries, provinces, tracts of land), and multi-part collections of these types.

* D3 implementation
* Render predefined maps of U.S.A., Germany, Spain… the World
* Select states, countries, regions or cities to synchronize other views in scope
* Render geo-json data from blobs to show boundaries of plots of land, buildings or floor plans

=== UI ===

* Models interactive views
* Connects to data-sources of any kind (DTO, Bean, JVM object, etc.)
* Nests different kinds of layouts to a complex surface (horizontal, vertical, form, grid)
* Adds components to layouts (buttons, text-fields, tables, images, etc.)
* Binds components to properties of data-sources
* Rule-based visibility processor
* Navigation widgets for small geometry mobile devices

=== Dialog ===

* Renders interactive views
* Either references a predefined UI model or a model inferred from a DTO
* Links the view to a toolbar
* Renders different modes
** Normal, to be used inside perspectives
** Embedded, to be used inside menues
** Stateful, inside perspectives, and controlled by a state-machine
** Mobile, to be used on small geometry mobile devices with navigation widgets
* Renders in 1 to N columns of components
* Groups components by using entity metadata
* Renders owning relationships as combo-boxes
* Renders member relationships as tables on tab-sheets
* Implements blob up- and downloading

=== Perspective ===

* Based on the Eclipse 4 application model
* Presents a 360° view on the task to the user
* Divides the usable screen area in resizable containers
* Nests windows, perspective-stacks, perspectives, containers, part-stacks and parts containing views, and toolbars
* Stores and retrieves resized areas for each user
* Supports drag and drop
* Event dispatching system to synchronize data, actions, focus and more between views
* References all types of views (dialogs, tables, charts, reports …) to set up a dashboard
* Modifiable layout at runtime using the designer mode for permitted users
* Connects to user tasks of BPM

=== Action ===

* Links action-buttons
** To business logic of Function-Library to be executed
*** Synchronously
*** Asynchronously as background process
** To Data-Interchange import- or export tasks
** To BPM start events
** To actions to trigger
*** Save, delete, download, print etc.
*** Advance focus to next or previous part
* Links action-buttons to business logic of Function-Library to be
** Enabled
** Disabled depending on data context
* Defines commands to control the application and trigger actions
* Assigns keyboard short-cuts to commands
* Connects to Message for fail or success messages about executed actions

=== Menu ===

* Combines Perspectives, BPM start events, embedded dialogs and tables, configuration settings and other informative screens to a tree-organized menu
* Pops up anytime it is needed, and consumes no space on the screen

=== Message ===

* Defines messages to notify a user about events and usage violations
* Can be tracked by log entries
* Placeholders for parametrizing messages
* Can have a severity

== Security ==

=== Authorization ===

* Role-based authorization system
* Grant access to entities, beans and DTO
* Grant access to CRUD operations (create, read, update, delete)
* Grant access to modification of relationships (link, unlink references)
* Vetoes per attribute for visibility, editability and enabling
* Grant access to start a process
* Grant access working on a user task

=== Organization ===

* Hierarchies of positions, multi-positions, and sub-organizations
* Maps roles to positions
* Definition of levels of collaboration if sharing the same roles
* Derives an organigram of each hierarchy to be rendered at runtime

= Services =

== Authentication ==

== Persistence ==

== Translation ==

== Metadata ==

== Theme Resources ==

OS.bee Software Factory Unique Selling Propositions

2018-06-29T06:50:40Z

Riegel: Created page with "== Abstract == OS.bee is a low-code model-driven software-factory, using over 20 Domain Specific Languages (DSL) to generate large-scale business web-applications. Each DSL c..."

== Abstract ==

OS.bee is a low-code model-driven software-factory, using over 20 Domain Specific Languages (DSL) to generate large-scale business web-applications. Each DSL contains a grammar for a required application-layer. A DSL hides complexity from successors, thereby enabling parallel modelling of domain requirements by multiple designers as they don’t need to know the domain logic they build upon. A model created with a DSL creates executable code, structured data and configuration settings or is interpreted by a renderer during runtime. The language of each DSL uses a grammar that makes the created model easy to understand and forms a requirement specification on its layer. The overall hierarchy can be browsed through at any time and gives a good understanding of the whole application in nearly natural English language. A DSL can also be studied by its syntactical graph. The creation of a model is a guided process through the syntax graph where the designer benefits from content assistance, code completion, quick fix, syntax colorizing, outline, formatting and validation. Many DSLs define metadata to be used by subsequent DSL to increase the leverage of definitions at a basic level. All element names defined by a DSL are automatically extracted to localization files for translation to open foreign markets for the resulting application. The ratio between the generated lines of code versus the numbers of lines in a model is 8 on average. Development speed improves by a similar factor. Dependencies between models reveal inconsistencies immediately while modifying and prevent generating code until these are resolved. Therefore turnaround cycles are short, errors are easy to discover and prototypes materialize in a very short time. Some DSL generate against famous open-source frameworks like EclipseLink, Smooks, Mondrian, Vaadin or jBPM thus enabling non-developers to use complex frameworks without deeper knowledge of their API. OS.bee inherits the features of the embedded frameworks and makes them easy to exploit for specialists of a domain not necessarily being software developer.

== Modeling ==

=== Data-type (type system layer) ===
*Primitive Types (int, double, etc.)
*Object Types (String, Date, etc.)
*Blob
Store and retrieve any document or image type in binary form
*Auto-sizing Images
Additionally stores images of definable size to experience better performance while rendering
*Formatted types
Dates and times in any localized form
Dates and times in any format (time only, date only, short and long forms, custom pattern, etc.)
Currencies in any localized form
*Validated types with adjustable severity message
Date in past/future
Not null
Not duplicate
Range values
Min/max length
*Slider types
Min/max values
*Masked types
Number, Hexadecimal, Capitalized
Input pattern (e.g. Phone Numbers (###) ###-####)
*Password
*Suggestion types
While typing some characters, a sorted list of suggestions pops up for selection
*Programmable Converters
Text-to-Image
Number-to-Text/Image
Value-to-CSS Style
Units of measurement
*Rich text editor using HTML markups
*Text area

=== Entity (Object relational mapper layer) ===

Main Page

2018-06-29T06:39:55Z

Riegel:

Welcome to the OS.bee Software Factory documentation Wiki.

Here you can find public availabe documentation around the OS.bee Software Factory and the Eclipse Open Standard Business Platform (OSBP).

==OS.bee==

[[OS.bee Software Factory Unique Selling Propositions]]

[[OS.bee Software Factory Installation Neon]]

[[OS.bee Software Factory Samples]]

[[OS.bee Software Factory Documentation]]

[[OS.bee Software Factory Release Notes]]

[[OS.bee Addons Documentation]]

[[OS.bee Apps Documentation]]

[[OS.bee API Documentation]]

[[OS.bee Documentation for Designer]]

[[OS.bee used licenses]]

----

Consult the [//meta.wikimedia.org/wiki/Help:Contents User's Guide] for information on using the wiki software.

== Getting started ==
* [//www.mediawiki.org/wiki/Special:MyLanguage/Manual:Configuration_settings Configuration settings list]
* [//www.mediawiki.org/wiki/Special:MyLanguage/Manual:FAQ MediaWiki FAQ]
* [https://lists.wikimedia.org/mailman/listinfo/mediawiki-announce MediaWiki release mailing list]
* [//www.mediawiki.org/wiki/Special:MyLanguage/Localisation#Translation_resources Localise MediaWiki for your language]

OS.bee peripherals for JavaPOS

2018-05-04T09:56:07Z

Riegel:

== OS.bee peripherals for JavaPOS ==

OS.bee integrates the framework JavaPOS [http://www.javapos.com/]. Purpose of this framework is to abstract peripheral units like printers, displays, dispenser from their physical properties and to present an application interface to Java applications. For each unit it is necessary to define its abstract properties and communication protocol. Each vendor of pripheral units for POS systems comes with his own configuration tool. But all of them end up with a xml file describing all peripheral units available to a single OS.bee application server. The name of this configuration file is not important. For the moment it is not possible to mix units of different vendors in a single file as they put their physical hardware information inside the file while using their individal setup program. OS.bee can only use a single xml file at a time. The path must be entered in OS.bee preferences of IDE using Window->Preferences->OSBP Application Configuration. Don't forget to select the right product to be configured.

[[File:JavaPOS_Preferences.png]]

=== Epson Peripheral Units ===

First download the following zip and unpack it in a suitable directory.
[[http://download.osbee.org/downloads/drivers/epson/EPSON_JavaPOS_ADK_1143.zip Epson Windows Driver and Setup Download]]
From the directory EPSON_JavaPOS_ADK_1143 start the executable EPSON_JavaPOS_1.14.3.exe and follow the instructions of the program.

If you follow the default settings of the installer, you end up with a directory structure epson/JavaPOS/SetupPOS. Here you start SetupPOS.bat as Administrator. For every peripheral unit you want to connect to OS.bee you must add an entry according to the requirements noted in the respective vendor's documentation. This program creates a xml file. The name is not important, but must be entered in the preferences in OS.bee under "External Data" (see section above).

Here is a sample xml file for a typical Epson configuration:
[[http://download.osbee.org/downloads/drivers/epson/pos.xml Epson Sample Configuration Download]]

=== WACOM Signature pad ===

OS.bee Software Factory supports the use of [http://www.wacom.com/en-gb/enterprise/business-solutions/hardware/signature-pads signature pads] from Wacom.

==== Installation prequistits ====

Supported OS: '''Windows'''

You have to install the driver for the signature pad on the machine you want to run the OS.bee application.

[[http://download.osbee.org/downloads/drivers/wacom/Wacom-STU-Driver-5.2.1.0.exe Windows Driver Installer Download]]

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

File:JavaPOS Preferences.png

2018-05-04T08:42:11Z

Riegel:

OS.bee Documentation for Designer

2018-03-28T07:00:27Z

Riegel: /* OS.bee Documentation for Designer */

=OS.bee Documentation for Designer=
Here are frequently asked questions from designers which are not mentioned by other Documentation. In this Page, you could find the answer to your question.

==Get Started==

===Pitfalls with new Eclipse installations===
Be aware that when installing a new Eclipse environment to look at the preferences for DS Annotations and check the box "Generate descriptors from annotated sources" as OS.bee makes heavy use of automatically generated component descriptors in the OSGI-INF directory. It is unchecked by default for incomprehensible reasons.

[[File:ds_annotations.png|center|frame|]]

Don't forget to set your target platform correctly as described in the [http://download.osbee.org/documentation/index.php/OS.bee_Software_Factory_Installation_Neon#Set_the_Target_Platform_for_the_OS.bee_Software_Factory installation guide].

===Eclipse Installation / Installation SWF / New Project from GIT===

Question:

Using Eclispe Neon, execution of Installation Software-Factory as described in the Installation notes, Connect to a GIT Archiv, After Building Workspace the application is not valid (see Screen-Shot)
Try to clean the Project was not successful.

[[File:xx.png|center|frame|''Figure x: xxx'']]

Answer:

The version of the installed Software Factory and the version needed for the project do not match.

Please install the appropriate Software Factory version.

===cvs2app - question regarding ENUM types===

Question:

cvs2app is mentioned in the documentation "App up in 5 minutes" and gives the possibility to create one app directly out of the csv file.
One of the first steps is to create an entity, which is generated based on the information on the first line (which contains the column names).
In consequence I have 2 questions regarding ENUMS:

* Is it possible to create an entity ENUM out the csv - FILE?

* Is it possible to use an existing ENUM entity during the creation of the app?

For example:

in the entity there is already a definition:
<syntaxhighlight lang="java">
enum type_ps {
PROCESS_DESCRIPTION, ORGANISATIONAL
}
</syntaxhighlight>

and the csvfile looks as follows:
<syntaxhighlight lang="java">
ticket_type_number;ticket_type_description;ticket_type_ps_type
1;CRS handling;PROCESS_DESCRIPTION
2;Administrative;ORGANISATIONAL
3;Delivery package;ORGANISATIONAL
4;Software behaviour;PROCESS_DESCRIPTION
</syntaxhighlight>

Answer:

Yes it is possible. When using the latest version (from feb 2018), it is possible to supply various meta-information to each column. One meta-info is the hint to the application builder that this column is meant to be a ENUM. By default it wouldn't be possible to guess that fact.

===Launch Application from Eclipse (very slow)===

Question:

When starting the Application from within the Eclipse it took very long time until the application is up.
Are there some settings to be controlled?

Answer:

If you experience very slow performance with Eclipse itself as well as the application you launch from Eclipse it might be a good idea to check the virus scanner you have installed.
Some virus scanners check all the files inside the Eclipse installation directory, the Eclipse workspace and the GIT repository which might lead to extreme slow performance.
Ask your Administrator how to avoid this.

===Structure of the documentation page===

In the [http://download.osbee.org/documentation/index.php/OS.bee_Software_Factory_Documentation OS.bee Software Factory Documentation] page, there are 3 Headlines used to structure the page:
1.) OS.bee DSL Documentation
2.) Other OS.bee-Specific Solutions
3.) OS.bee Third-Party Software Solutions

At the end of Chapter one there are some helpful hints to work with eclipse. To start with Eclipse and the SWF these hints could be very useful.
One more hint:
to Use STRG-Shift-O to organize the import inside the DSL.

==Modeling==

==Core Dev==

==Apps==

Perspective DSL

2018-02-26T16:12:15Z

Riegel: /* part */

==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 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> | 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.
* 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}}

Perspective DSL

2018-02-26T16:11:32Z

Riegel: /* part */

==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 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> | 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}}

Perspective DSL

2018-02-26T16:11:08Z

Riegel: /* Introduction */

==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 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}}

Eclipse 4 Application Model

2017-10-19T09:20:44Z

Riegel: /* Description */

==Description==
OS.bee acts like an Eclipse 4 application, therefore the foundation is the E4 application model.
[[File:E4ApplicationModel.png|center|frame|''Figure 1: E4 application model.'']]
OS.bee is not a RCP application but renders on browsers as a web application using the [https://vaadin.com/ Vaadin framework]. To achieve this, a bridging framework works between the E4 application model and Vaadin. The framework is called [http://semanticsoft.github.io/vaaclipse/ Vaaclipse].
[[File:E4browser.png|center|frame|''Figure 2: OS.bee E4 application model in a browser.'']]
The presented "Foodmart" example is based on [https://mondrian.pentaho.com/documentation/installation.php Pentaho's Mondrian] scheme and data. The data of the chart is generated by a cube created with the [[Cube DSL|''Cube DSL Model'']]

Eclipse 4 Application Model

2017-10-19T09:18:09Z

Riegel: /* Description */

==Description==
OS.bee acts like an Eclipse 4 application, therefore the foundation is the E4 application model.
[[File:E4ApplicationModel.png|center|frame|''Figure 1: E4 application model.'']]
OS.bee is not a RCP application but renders on browsers as a web application using the [https://vaadin.com/ Vaadin framework]. To achieve this, a bridging framework works between the E4 application model and Vaadin. The framework is called [http://semanticsoft.github.io/vaaclipse/ Vaaclipse].
[[File:E4browser.png|center|frame|''Figure 2: OS.bee E4 application model in a browser.'']]
The shown "Foodmart" example is based on [https://mondrian.pentaho.com/documentation/installation.php Pentaho's Mondrian] scheme and data.

Eclipse 4 Application Model

2017-10-19T09:14:19Z

Riegel: /* Description */

Eclipse 4 Application Model

2017-10-19T09:13:43Z

Riegel: /* Description */

==Description==
OS.bee acts like an Eclipse 4 application, therefore the foundation is the E4 application model.
[[File:E4ApplicationModel.png|center|frame|''Figure 1: E4 application model.'']]
OS.bee is not a RCP application but renders on browsers as a web application using the [https://vaadin.com/ Vaadin framework]. To achieve this a bridging framework works between the E4 application model and Vaadin. The framework is called [http://semanticsoft.github.io/vaaclipse/ Vaaclipse].
[[File:E4browser.png|center|frame|''Figure 2: OS.bee E4 application model in a browser.'']]

Eclipse 4 Application Model

2017-10-19T08:31:40Z

Riegel: /* Purpose */

==Description==
OS.bee acts like an Eclipse 4 application, the foundation is therefore the E4 application model.
[[File:E4ApplicationModel.png|center|frame|''Figure 1: E4 application model.'']]
OS.bee is not a RCP application but renders on browsers as a web application using the [https://vaadin.com/ Vaadin framework]. To achieve this a bridging framework works between the E4 application model and Vaadin. The framework is called [http://semanticsoft.github.io/vaaclipse/ Vaaclipse].
[[File:E4browser.png|center|frame|''Figure 2: OS.bee E4 application model in a browser.'']]

File:E4browser.png

2017-10-19T08:30:22Z

Riegel:

Eclipse 4 Application Model

2017-10-19T08:29:22Z

Riegel:

==Purpose==
OS.bee acts like an Eclipse 4 application, the foundation is therefore the E4 application model.
[[File:E4ApplicationModel.png|center|frame|''Figure 1: E4 application model.'']]
OS.bee is not a RCP application but renders on browsers as a web application using the [https://vaadin.com/ Vaadin framework]. To achieve this a bridging framework works between the E4 application model and Vaadin. The framework is called [http://semanticsoft.github.io/vaaclipse/ Vaaclipse].
[[File:E4browser.png|center|frame|''Figure 2: OS.bee E4 application model in a browser.'']]

Eclipse 4 Application Model

2017-10-19T07:53:55Z

Riegel: /* Purpose */

Eclipse 4 Application Model

2017-10-19T07:42:36Z

Riegel:

==Purpose==
OS.bee acts like an Eclipse 4 application, the foundation is therefore the E4 application model.
[[File:E4ApplicationModel.png|center|frame|''Figure 1: E4 application model.'']]
OS.bee is not a RCP application but renders on browsers as a web application using the Vaadin framework. To achieve this a bridging framework works between the E4 application model and Vaadin. The framework is called Vaaclipse.

Eclipse 4 Application Model

2017-10-19T07:41:55Z

Riegel:

==Purpose==
Like every Eclipse 4 application, the foundation is the application model.
[[File:E4ApplicationModel.png|center|frame|''Figure 1: E4 application model.'']]
OS.bee is not a RCP application but renders on browsers as a web application using the Vaadin framework. To achieve this a bridging framework works between the E4 application model and Vaadin. The framework is called Vaaclipse.

File:E4ApplicationModel.png

2017-10-19T07:41:38Z

Riegel:

Eclipse 4 Application Model

2017-10-19T07:38:42Z

Riegel: Created page with "==Purpose== Like every Eclipse 4 application, the foundation is the application model. ''Figure 1: E4 application model.'' OS.bee..."

==Purpose==
Like every Eclipse 4 application, the foundation is the application model.
[[File:E4ApplicationModel.pdf|center|frame|''Figure 1: E4 application model.'']]
OS.bee is not a RCP application but renders on browsers as a web application using the Vaadin framework. To achieve this a bridging framework works between the E4 application model and Vaadin. The framework is called Vaaclipse.

OS.bee Software Factory Documentation

2017-10-19T07:30:05Z

Riegel:

=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.

==[[Datatype DSL]]==
The [[Datatype DSL]] is, beside the Entity DSL, one of the most basic DSL for the Software Factory. It provides you with the most common used basic (atomic) datatypes by mapping them. It also allows you to define new simple and complex datatypes. As mentioned above the creation of entities via the [[Entity DSL]] is pivotal in order to create applications with the OSBP Software Factory. Therefore the Datatype DSL is in that manner a central milestone.

Several custom datatypes will also be described in detail in this chapter.

==[[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.

==[[UI DSL ]]==
The UI DSL describes the user interface of an OS.bee application.

==[[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]]==

The Action DSL defines actions that change the OS.bee data models for tasks, select workloads, dialogs, reports, charts, workflows, datainterchange, user interface and functions.

==[[Message DSL]]==

The Message DSL centralizes the contents and definitions of all possible output messages, that will be shown inside the application and make them available to other DSL models, such as the [[Action DSL]].

==[[Menu DSL]]==

Menu model is used for the UI menu definition.

==[[Strategy DSL]]==

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

==[[Eclipse 4 Application Model]]==

All UI elements use the E4 model and embed into the E4 service environment.

=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-10-19T07:29:40Z

Riegel:

=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.

==[[Datatype DSL]]==
The [[Datatype DSL]] is, beside the Entity DSL, one of the most basic DSL for the Software Factory. It provides you with the most common used basic (atomic) datatypes by mapping them. It also allows you to define new simple and complex datatypes. As mentioned above the creation of entities via the [[Entity DSL]] is pivotal in order to create applications with the OSBP Software Factory. Therefore the Datatype DSL is in that manner a central milestone.

Several custom datatypes will also be described in detail in this chapter.

==[[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.

==[[UI DSL ]]==
The UI DSL describes the user interface of an OS.bee application.

==[[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]]==

The Action DSL defines actions that change the OS.bee data models for tasks, select workloads, dialogs, reports, charts, workflows, datainterchange, user interface and functions.

==[[Message DSL]]==

The Message DSL centralizes the contents and definitions of all possible output messages, that will be shown inside the application and make them available to other DSL models, such as the [[Action DSL]].

==[[Menu DSL]]==

Menu model is used for the UI menu definition.

==[[Strategy DSL]]==

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

==[[Eclipse 4 Application Model]]

All UI elements use the E4 model and embed into the E4 service environment.

=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-10-19T07:02:33Z

Riegel:

=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.

==[[Datatype DSL]]==
The [[Datatype DSL]] is, beside the Entity DSL, one of the most basic DSL for the Software Factory. It provides you with the most common used basic (atomic) datatypes by mapping them. It also allows you to define new simple and complex datatypes. As mentioned above the creation of entities via the [[Entity DSL]] is pivotal in order to create applications with the OSBP Software Factory. Therefore the Datatype DSL is in that manner a central milestone.

Several custom datatypes will also be described in detail in this chapter.

==[[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.

==[[UI DSL ]]==
The UI DSL describes the user interface of an OS.bee application.

==[[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]]==

The Action DSL defines actions that change the OS.bee data models for tasks, select workloads, dialogs, reports, charts, workflows, datainterchange, user interface and functions.

==[[Message DSL]]==

The Message DSL centralizes the contents and definitions of all possible output messages, that will be shown inside the application and make them available to other DSL models, such as the [[Action DSL]].

==[[Menu DSL]]==

Menu model is used for the UI menu definition.

==[[Strategy DSL]]==

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

=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]]==

AutowireHelper

2017-10-19T06:54:45Z

Riegel:

The purpose of an AutowireHelper is the model to model transformation of a [[Entity DSL|''Entity DSL Model'']] or a [[DTO DSL|''DTO DSL Model'']] to an ecview model. An ecview model represents the model for a dialog. It either can be generated by an AutowireHelper or is created by using the [[UI DSL|''UI DSL Model'']] manually. This enables the system to create user interfaces automatically according to the underlying entity. As entity model changes, dialogs using the autobinding keyword and referencing the associated DTO do the same. An autowiring implements rules how to interprete data types and structural information to a valid ecview model. AutowireHelper uses metadata associated with the [[Entity DSL|''Entity DSL Model'']] or [[Datatype DSL|''Datatype DSL Model'']] supplied as properties to modify the transformation behaviour. The generated ecview model is persisted as xmi file and will be interpreted during runtime by a renderer consuming the model. The resulting dialog follows the E4 annotation style and embeds as a view to be placed in an E4 MPart. The placment is done by using [[Perspective DSL|''Perspective DSL Model'']].

To include a custom autowire helper as delegate for the Service to use an entry in the plugin.xml is required.
See the following code as template:

<syntaxhighlight lang="xml"><?xml version="1.0" encoding="UTF-8"?>
<?eclipse version="3.4"?>
<plugin>
<extension
point="org.lunifera.ecview.dsl.autowireDelegate">
<autowireDelegate
autowireDelegateClass="de.compex.autowirehelper.AutowireHelper"
id="de.compex.autowireHelper.autowireDelegate">
</autowireDelegate>
</extension>
</plugin>
</syntaxhighlight>

AutowireHelper

2017-10-19T06:50:54Z

Riegel:

The purpose of an AutowireHelper is the model to model transformation of a entity model or a DTO model to an ecview model. An ecview model represents the model for a dialog. It either can be generated by an AutowireHelper or manually by using the ui model. This enables the system to create user interfaces automatically according to the underlying entity. As entity model changes, dialogs using the autobinding keyword and referencing the associated DTO do the same. An autowiring implements rules how to interprete data types and structural information to a valid ecview model. AutowireHelper uses metadata associated with the entity model to modify the transformation behaviour. The generated ecview model is persisted as xmi file and will be interpreted during runtime by a renderer consuming the model. The resulting dialog follows the E4 annotation style and embeds as a view to be placed in an E4 MPart. The placment is done by using [[Perspective DSL|''Perspective DSL Model'']].

To include a custom autowire helper as delegate for the Service to use an entry in the plugin.xml is required.
See the following code as template:

<syntaxhighlight lang="xml"><?xml version="1.0" encoding="UTF-8"?>
<?eclipse version="3.4"?>
<plugin>
<extension
point="org.lunifera.ecview.dsl.autowireDelegate">
<autowireDelegate
autowireDelegateClass="de.compex.autowirehelper.AutowireHelper"
id="de.compex.autowireHelper.autowireDelegate">
</autowireDelegate>
</extension>
</plugin>
</syntaxhighlight>

AutowireHelper

2017-10-19T06:49:47Z

Riegel:

The purpose of an AutowireHelper is the model to model transformation of a entity model or a DTO model to an ecview model. An ecview model represents the model for a dialog. It either can be generated by an AutowireHelper or manually by using the ui model. This enables the system to create user interfaces automatically according to the underlying entity. As entity model changes, dialogs using the autobinding keyword and referencing the associated DTO do the same. An autowiring implements rules how to interprete data types and structural information to a valid ecview model. AutowireHelper uses metadata associated with the entity model to modify the transformation behaviour. The generated ecview model is persisted as xmi file and will be interpreted during runtime by a renderer consuming the model. The resulting dialog follows the E4 annotation style and embeds as a view to be placed in an E4 MPart. The placment is done by using Perspective DSL.

To include a custom autowire helper as delegate for the Service to use an entry in the plugin.xml is required.
See the following code as template:

<syntaxhighlight lang="xml"><?xml version="1.0" encoding="UTF-8"?>
<?eclipse version="3.4"?>
<plugin>
<extension
point="org.lunifera.ecview.dsl.autowireDelegate">
<autowireDelegate
autowireDelegateClass="de.compex.autowirehelper.AutowireHelper"
id="de.compex.autowireHelper.autowireDelegate">
</autowireDelegate>
</extension>
</plugin>
</syntaxhighlight>

AutowireHelper

2017-10-19T06:45:09Z

Riegel:

The purpose of an AutowireHelper is the model to model transformation of a entity model or a DTO model to an ecview model. An ecview model represents the model for a dialog. It either can be generated by an AutowireHelper or manually by using the ui model. This enables the system to create user interfaces automatically according to the underlying entity. As entity model changes, dialogs using the autobinding keyword and referencing the associated DTO do the same. An autowiring implements rules how to interprete data types and structural information to a valid ecview model. AutowireHelper uses metadata associated with the entity model to modify the transformation behaviour.

To include a custom autowire helper as delegate for the Service to use an entry in the plugin.xml is required.
See the following code as template:

<syntaxhighlight lang="xml"><?xml version="1.0" encoding="UTF-8"?>
<?eclipse version="3.4"?>
<plugin>
<extension
point="org.lunifera.ecview.dsl.autowireDelegate">
<autowireDelegate
autowireDelegateClass="de.compex.autowirehelper.AutowireHelper"
id="de.compex.autowireHelper.autowireDelegate">
</autowireDelegate>
</extension>
</plugin>
</syntaxhighlight>

Statemachine DSL

2017-09-27T08:50:50Z

Riegel:

== Introduction ==

=== State Machine ===

'''State Machine''' or '''extended finite-state machine (EFSM)''' is a mathematical model of computation and represents an abstract machine that can be in exactly one of a finite number of states at any given time. The State Machine can change from one ''state'' to another in response to external ''events''. The change from one state to another is called a ''transition''. A EFSM is defined by a list of its states, its ''initial state'', and the conditions for each transition. The condition for a transition is called ''guard''. There can be many guards protecting a transition to be triggered. Every guard is joined with a logical AND operation, so every guard must evaluate to true, to trigger a protected transition. Data operations can occur before a transition. They are called ''actions''. Actions prepare the indicated state of the transition, calculate things or display information.
The StatemachineDSL described in the following implements an EFSM where the FSM-block is represented by ''states'', the A-block is called ''actions'' and the E-block is called ''guards''.

=== Further reading ===

https://en.wikipedia.org/wiki/Finite-state_machine

https://en.wikipedia.org/wiki/Extended_finite-state_machine

https://en.wikipedia.org/wiki/UML_state_machine

== Statemachine DSL ==
Statemachine DSL implements the state pattern (https://en.wikipedia.org/wiki/State_pattern) and interconnects UI model, FunctionLibrary, DTO and peripheral services like JavaPOS, ZVT protocol and others.

The main semantic elements of the StatemachineDSL 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 other Java classes.
*'''statemachine''' - The container for the implementation of the EFSM following the state pattern.
*'''events''' - Contains all user defined events.
*'''event''' - Defines a single event by id. Events build the interconnection elements between controls and transitions.
*'''controls''' - The container for all type of beans (https://en.wikipedia.org/wiki/JavaBeans) to be controlled by the state machine.
*'''scheduler''' - A type of bean that can be triggered to emit a defined event after a defined delay.
*'''keypad''' - A type of bean that builds a keypad containing one or more buttons to emit a defined event when pressed.
*'''fields''' - A type of bean that holds data of input fields or labels from UI.
*'''dataProvider''' - A type of bean that retrieves and stores data based on DTO.
*'''peripheral''' - A type of bean that controls input/output operations with peripheral units. Peripheral units can be printers, displays or other external devices following the JavaPOS standard (http://www.javapos.com/). Peripheral units can also emit events representing its current state or error.
*'''attribute''' - Defines different types for usage with control.
*'''states''' - The container for all state definitions of this state machine.
*'''state''' - A single state the machine can be at a point in time.
*'''triggers''' - The container for all possible event processing blocks inside a state.
*'''trigger''' - The action block following this trigger will be executed when one of its events occur.
*'''actions''' - The container for all process instructions to be done in sequence inside this block. Optionally an action block can follow a transition.
*'''transistion''' - The transition will be executed when all actions of this block were processed successfully.
*'''guards''' - The container for guards protecting the following transistion.
*'''guard''' - A condition that must evaluate to true that the following transistion will be processed.

====Syntax====

=====package definition=====

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

=====statemachinee=====

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

Statemachine DSL

2017-09-27T08:50:19Z

Riegel: /* package definition */

== Introduction ==

=== State Machine ===

'''State Machine''' or '''extended finite-state machine (EFSM)''' is a mathematical model of computation and represents an abstract machine that can be in exactly one of a finite number of states at any given time. The State Machine can change from one ''state'' to another in response to external ''events''. The change from one state to another is called a ''transition''. A EFSM is defined by a list of its states, its ''initial state'', and the conditions for each transition. The condition for a transition is called ''guard''. There can be many guards protecting a transition to be triggered. Every guard is joined with a logical AND operation, so every guard must evaluate to true, to trigger a protected transition. Data operations can occur before a transition. They are called ''actions''. Actions prepare the indicated state of the transition, calculate things or display information.
The StatemachineDSL described in the following implements an EFSM where the FSM-block is represented by ''states'', the A-block is called ''actions'' and the E-block is called ''guards''.

=== Further reading ===

https://en.wikipedia.org/wiki/Finite-state_machine

https://en.wikipedia.org/wiki/Extended_finite-state_machine

https://en.wikipedia.org/wiki/UML_state_machine

== Statemachine DSL ==
Statemachine DSL implements the state pattern (https://en.wikipedia.org/wiki/State_pattern) and interconnects UI model, FunctionLibrary, DTO and peripheral services like JavaPOS, ZVT protocol and others.

The main semantic elements of the StatemachineDSL 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 other Java classes.
*'''statemachine''' - The container for the implementation of the EFSM following the state pattern.
*'''events''' - Contains all user defined events.
*'''event''' - Defines a single event by id. Events build the interconnection elements between controls and transitions.
*'''controls''' - The container for all type of beans (https://en.wikipedia.org/wiki/JavaBeans) to be controlled by the state machine.
*'''scheduler''' - A type of bean that can be triggered to emit a defined event after a defined delay.
*'''keypad''' - A type of bean that builds a keypad containing one or more buttons to emit a defined event when pressed.
*'''fields''' - A type of bean that holds data of input fields or labels from UI.
*'''dataProvider''' - A type of bean that retrieves and stores data based on DTO.
*'''peripheral''' - A type of bean that controls input/output operations with peripheral units. Peripheral units can be printers, displays or other external devices following the JavaPOS standard (http://www.javapos.com/). Peripheral units can also emit events representing its current state or error.
*'''attribute''' - Defines different types for usage with control.
*'''states''' - The container for all state definitions of this state machine.
*'''state''' - A single state the machine can be at a point in time.
*'''triggers''' - The container for all possible event processing blocks inside a state.
*'''trigger''' - The action block following this trigger will be executed when one of its events occur.
*'''actions''' - The container for all process instructions to be done in sequence inside this block. Optionally an action block can follow a transition.
*'''transistion''' - The transition will be executed when all actions of this block were processed successfully.
*'''guards''' - The container for guards protecting the following transistion.
*'''guard''' - A condition that must evaluate to true that the following transistion will be processed.

====Syntax====

=====package definition=====

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

=====table=====

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

Statemachine DSL

2017-09-27T07:01:39Z

Riegel:

== Introduction ==

=== State Machine ===

'''State Machine''' or '''extended finite-state machine (EFSM)''' is a mathematical model of computation and represents an abstract machine that can be in exactly one of a finite number of states at any given time. The State Machine can change from one ''state'' to another in response to external ''events''. The change from one state to another is called a ''transition''. A EFSM is defined by a list of its states, its ''initial state'', and the conditions for each transition. The condition for a transition is called ''guard''. There can be many guards protecting a transition to be triggered. Every guard is joined with a logical AND operation, so every guard must evaluate to true, to trigger a protected transition. Data operations can occur before a transition. They are called ''actions''. Actions prepare the indicated state of the transition, calculate things or display information.
The StatemachineDSL described in the following implements an EFSM where the FSM-block is represented by ''states'', the A-block is called ''actions'' and the E-block is called ''guards''.

=== Further reading ===

https://en.wikipedia.org/wiki/Finite-state_machine

https://en.wikipedia.org/wiki/Extended_finite-state_machine

https://en.wikipedia.org/wiki/UML_state_machine

== Statemachine DSL ==
Statemachine DSL implements the state pattern (https://en.wikipedia.org/wiki/State_pattern) and interconnects UI model, FunctionLibrary, DTO and peripheral services like JavaPOS, ZVT protocol and others.

The main semantic elements of the StatemachineDSL 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 other Java classes.
*'''statemachine''' - The container for the implementation of the EFSM following the state pattern.
*'''events''' - Contains all user defined events.
*'''event''' - Defines a single event by id. Events build the interconnection elements between controls and transitions.
*'''controls''' - The container for all type of beans (https://en.wikipedia.org/wiki/JavaBeans) to be controlled by the state machine.
*'''scheduler''' - A type of bean that can be triggered to emit a defined event after a defined delay.
*'''keypad''' - A type of bean that builds a keypad containing one or more buttons to emit a defined event when pressed.
*'''fields''' - A type of bean that holds data of input fields or labels from UI.
*'''dataProvider''' - A type of bean that retrieves and stores data based on DTO.
*'''peripheral''' - A type of bean that controls input/output operations with peripheral units. Peripheral units can be printers, displays or other external devices following the JavaPOS standard (http://www.javapos.com/). Peripheral units can also emit events representing its current state or error.
*'''attribute''' - Defines different types for usage with control.
*'''states''' - The container for all state definitions of this state machine.
*'''state''' - A single state the machine can be at a point in time.
*'''triggers''' - The container for all possible event processing blocks inside a state.
*'''trigger''' - The action block following this trigger will be executed when one of its events occur.
*'''actions''' - The container for all process instructions to be done in sequence inside this block. Optionally an action block can follow a transition.
*'''transistion''' - The transition will be executed when all actions of this block were processed successfully.
*'''guards''' - The container for guards protecting the following transistion.
*'''guard''' - A condition that must evaluate to true that the following transistion will be processed.

====Syntax====

=====package definition=====

► '''Syntax''':
<syntaxhighlight lang="java">
package <package name> {
import <import models/class name>
...

table ... [using datamart <datamart name>
{
axis...[details{...}]
[events{...}]
[actions{...}]
}]
...
}
</syntaxhighlight>

=====table=====

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

File:Git-Preferences.png

2017-06-27T11:51:17Z

Riegel: Riegel uploaded a new version of File:Git-Preferences.png

OS.bee Software Factory Installation Neon

2017-06-27T11:49:18Z

Riegel: /* Set preferences in Eclipse */

== 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 Windows, 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 to the program '''C:\eclipse\eclipse.exe''' on the computer's desktop . 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], as described above, 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 start. 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:Git-Preferences.png

2017-06-27T11:45:58Z

Riegel:

Peripheral Devices

2017-04-26T14:36:15Z

Riegel:

=Epson Cash Register Peripherals=
If you want to work with Epson-Seiko cash register peripherals some extra steps are necessary:
* Download and unzip the ADK from the following site: [https://download.epson-biz.com/modules/pos/index.php?page=single_soft&cid=5405&scat=40&pcat=3 Epson Biz]
* You must pass a registration process on the Epson site
* Install the ADK
* From the start menu launch SetupPos and configure the physical hardware according to the Epson manuals
[[File:EpsonSetupPOS.png|600px]] 
* Save the configuration and note the path to the configuration file. The content of this xml file looks something like this:

<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE JposEntries PUBLIC "-//JavaPOS//DTD//EN"
"jpos/res/jcl.dtd">
<JposEntries>


<JposEntry logicalName="CashDrawer">
<creation factoryClass="jp.co.epson.uposcommon.creator.EpsonJposServiceInstanceFactory" serviceClass="jp.co.epson.upos.H6000IV.drw.StandardService"/>
<vendor name="SEIKO EPSON" url="http://www.epson.com"/>
<jpos category="CashDrawer" version="1.14"/>
<product description="EPSON Standard CashDrawer Device Service" name="EPSON Services for JavaPOS(TM) Standard" url="http://www.epson.com"/>


<prop name="OutputTimeout" type="String" value="500"/>
<prop name="epson.trace.file" type="String" value="trace.log"/>
<prop name="OutputBufferSize" type="String" value="4096"/>
<prop name="PinNumber" type="String" value="0"/>
<prop name="OfflineExecutionDevice" type="String" value="1"/>
<prop name="ConfigurationFile" type="String" value="epson/xml/Setting/TM-H6000IVSetting.xml"/>
<prop name="WriteThreadInterval" type="String" value="-1"/>
<prop name="TransmitRetryTime" type="String" value="100"/>
<prop name="DeviceID" type="String" value="36"/>
<prop name="SupportStatistics" type="String" value="1"/>
<prop name="QueuingOfflineTimeout" type="String" value="1000"/>
<prop name="MultiDrawerStatusSupport" type="String" value="0"/>
<prop name="EPurasSupport" type="String" value="TRUE"/>
<prop name="ReceiveRetryTime" type="String" value="25"/>
<prop name="TransmitTimeout" type="String" value="5000"/>
<prop name="Parity" type="String" value="0"/>
<prop name="StopBits" type="String" value="0"/>
<prop name="MemorySwitch" type="String" value="0"/>
<prop name="FlowType" type="String" value="1"/>
<prop name="InputTimeout" type="String" value="100"/>
<prop name="PulseOFFTime" type="String" value="400"/>
<prop name="LogicalPortName" type="String" value="ESDPRT001"/>
<prop name="StatusThreadInterval" type="String" value="100"/>
<prop name="DefaultSlpClampTime" type="String" value="0"/>
<prop name="LogicalPortInterfaceName" type="String" value="EPuras"/>
<prop name="OfflineRetryIntervalTime" type="String" value="25"/>
<prop name="BitLength" type="String" value="8"/>
<prop name="OfflineCount" type="String" value="2"/>
<prop name="PortType" type="String" value="0"/>
<prop name="InitializeThreadTime" type="String" value="1000"/>
<prop name="PortInterfaceName" type="String" value="Serial"/>
<prop name="PhysicalPrinterName" type="String" value="TM-H6000IV"/>
<prop name="LogObject" type="String" value=""/>
<prop name="PulseONTime" type="String" value="100"/>
<prop name="ForceSend" type="String" value="0"/>
<prop name="PulseStep" type="String" value="100"/>
<prop name="DeviceDesc" type="String" value="EPSON Standard CashDrawer"/>
<prop name="PortName" type="String" value="COM1"/>
<prop name="OpenPulseLevel" type="String" value="0"/>
<prop name="OpenWaitTimeout" type="String" value="5000"/>
<prop name="ReceiveTimeout" type="String" value="1000"/>
<prop name="InitializeResponseTimeout" type="String" value="1000"/>
<prop name="InputBufferSize" type="String" value="84"/>
<prop name="OfflineExecutionInitializeSetting" type="String" value="0"/>
<prop name="PhysicalDevice" type="String" value="Standard"/>
<prop name="Upos.Spec_c" type="String" value="false"/>
<prop name="ReadThreadInterval" type="String" value="-1"/>
<prop name="BaudRate" type="String" value="19200"/>
<prop name="epson.tracing" type="String" value="false"/>
<prop name="DeviceType" type="String" value="1"/>
<prop name="epson.trace.max.size" type="String" value="1000"/>
<prop name="Upos.USB_Serial" type="String" value="false"/>
</JposEntry>

<JposEntry logicalName="LineDisplay">
<creation factoryClass="jp.co.epson.uposcommon.creator.EpsonJposServiceInstanceFactory" serviceClass="jp.co.epson.upos.H6000IV.disp.DMD110Service"/>
<vendor name="SEIKO EPSON" url="http://www.epson.com"/>
<jpos category="LineDisplay" version="1.14"/>
<product description="Unknown Product Description" name="EPSON Services for JavaPOS(TM) Standard" url="http://www.epson.com"/>


<prop name="OutputTimeout" type="String" value="500"/>
<prop name="epson.trace.file" type="String" value="trace.log"/>
<prop name="OutputBufferSize" type="String" value="4096"/>
<prop name="OfflineExecutionDevice" type="String" value="1"/>
<prop name="ConfigurationFile" type="String" value="epson/xml/Setting/DM-D110(v1_14_0001)Setting.xml"/>
<prop name="WriteThreadInterval" type="String" value="-1"/>
<prop name="TransmitRetryTime" type="String" value="100"/>
<prop name="DeviceID" type="String" value="36"/>
<prop name="SupportStatistics" type="String" value="1"/>
<prop name="QueuingOfflineTimeout" type="String" value="1000"/>
<prop name="EPurasSupport" type="String" value="TRUE"/>
<prop name="ReceiveRetryTime" type="String" value="25"/>
<prop name="TransmitTimeout" type="String" value="5000"/>
<prop name="Parity" type="String" value="0"/>
<prop name="StopBits" type="String" value="0"/>
<prop name="MemorySwitch" type="String" value="0"/>
<prop name="FlowType" type="String" value="1"/>
<prop name="InputTimeout" type="String" value="100"/>
<prop name="CharacterMode" type="String" value="0"/>
<prop name="LogicalPortName" type="String" value="ESDPRT001"/>
<prop name="StatusThreadInterval" type="String" value="100"/>
<prop name="DefaultSlpClampTime" type="String" value="0"/>
<prop name="LogicalPortInterfaceName" type="String" value="EPuras"/>
<prop name="OfflineRetryIntervalTime" type="String" value="25"/>
<prop name="BitLength" type="String" value="8"/>
<prop name="OfflineCount" type="String" value="2"/>
<prop name="PortType" type="String" value="0"/>
<prop name="InitializeThreadTime" type="String" value="1000"/>
<prop name="ConnectionType" type="String" value="1"/>
<prop name="GraphicWindowLogicalArea" type="String" value="0"/>
<prop name="PortInterfaceName" type="String" value="Serial"/>
<prop name="PhysicalPrinterName" type="String" value="TM-H6000IV"/>
<prop name="LogObject" type="String" value=""/>
<prop name="DirectIOEventTimeout" type="String" value="5000"/>
<prop name="DeviceDesc" type="String" value="EPSON DM-D110 LineDisplay"/>
<prop name="PortName" type="String" value="COM1"/>
<prop name="ReceiveTimeout" type="String" value="1000"/>
<prop name="InitializeResponseTimeout" type="String" value="1000"/>
<prop name="InputBufferSize" type="String" value="84"/>
<prop name="TwoByteCharacter" type="String" value="0"/>
<prop name="OfflineExecutionInitializeSetting" type="String" value="0"/>
<prop name="PhysicalDevice" type="String" value="DM-D110"/>
<prop name="Upos.Spec_c" type="String" value="false"/>
<prop name="ReadThreadInterval" type="String" value="-1"/>
<prop name="BaudRate" type="String" value="19200"/>
<prop name="epson.tracing" type="String" value="false"/>
<prop name="DeviceType" type="String" value="2"/>
<prop name="epson.trace.max.size" type="String" value="1000"/>
<prop name="Upos.USB_Serial" type="String" value="false"/>
<prop name="PrinterConfigurationFile" type="String" value="epson/xml/Setting/TM-H6000IVSetting.xml"/>
</JposEntry>

<JposEntry logicalName="POSPrinter">
<creation factoryClass="jp.co.epson.uposcommon.creator.EpsonJposServiceInstanceFactory" serviceClass="jp.co.epson.upos.H6000IV.pntr.H6000IVService"/>
<vendor name="SEIKO EPSON" url="http://www.epson.com"/>
<jpos category="POSPrinter" version="1.14"/>
<product description="EPSON TM-H6000IV Printer Device Service" name="EPSON Services for JavaPOS(TM) Standard" url="http://www.epson.com"/>


<prop name="FlowType" type="String" value="1"/>
<prop name="Halftone" type="String" value="0"/>
<prop name="PhysicalPrinterName" type="String" value="TM-H6000IV"/>
<prop name="NVRAMControlLevel" type="String" value="1"/>
<prop name="LogicalPortName" type="String" value="ESDPRT001"/>
<prop name="Stamp" type="String" value="0"/>
<prop name="OutputCompleteType" type="String" value="2"/>
<prop name="StatusThreadInterval" type="String" value="100"/>
<prop name="OutputTimeout" type="String" value="500"/>
<prop name="PortType" type="String" value="0"/>
<prop name="epson.trace.detail.file" type="String" value="detail.log"/>
<prop name="OutputBufferSize" type="String" value="4096"/>
<prop name="UsedNVRAM" type="String" value="0"/>
<prop name="FirmRecordLog" type="String" value="1"/>
<prop name="ReceiveTimeout" type="String" value="1000"/>
<prop name="SlpReverseEject" type="String" value="0"/>
<prop name="PortName" type="String" value="COM1"/>
<prop name="OfflineRetryIntervalTime" type="String" value="25"/>
<prop name="Upos.USB_Serial" type="String" value="false"/>
<prop name="DefaultSlpClampTime" type="String" value="500"/>
<prop name="OfflineExecutionDevice" type="String" value="1"/>
<prop name="epson.trace.file" type="String" value="trace.log"/>
<prop name="StopBits" type="String" value="0"/>
<prop name="AsyncProcessingSize" type="String" value="2"/>
<prop name="RecCharactersPerLine" type="String" value="42"/>
<prop name="KanjiTwoWaysPrint" type="String" value="0"/>
<prop name="PulseStep" type="String" value="100"/>
<prop name="PortInterfaceName" type="String" value="Serial"/>
<prop name="GradationMethod" type="String" value="0"/>
<prop name="OfflineExecutionInitializeSetting" type="String" value="0"/>
<prop name="U375Compatible" type="String" value="0"/>
<prop name="BitLength" type="String" value="8"/>
<prop name="Parity" type="String" value="0"/>
<prop name="preCutterFunction" type="String" value="0"/>
<prop name="epson.tracing" type="String" value="false"/>
<prop name="epson.trace.max.size" type="String" value="1000"/>
<prop name="RecPaperSize" type="String" value="80"/>
<prop name="DeviceDesc" type="String" value="EPSON TM-H6000IV POSPrinter"/>
<prop name="PageModeExt" type="String" value="0"/>
<prop name="RecLineSpacing" type="String" value="30"/>
<prop name="SupportStatistics" type="String" value="1"/>
<prop name="FirmProgressRange" type="String" value="10"/>
<prop name="OutputErrorOption" type="String" value="0"/>
<prop name="EndorseLineSpacing" type="String" value="10"/>
<prop name="SupportFirmware" type="String" value="0"/>
<prop name="DeviceID" type="String" value="36"/>
<prop name="SlipPaperType" type="String" value="2"/>
<prop name="InputTimeout" type="String" value="100"/>
<prop name="SlipCharactersPerLine" type="String" value="45"/>
<prop name="AutoPowerOff" type="String" value="0"/>
<prop name="SlpMoreColumns" type="String" value="0"/>
<prop name="RecPaperType" type="String" value="0"/>
<prop name="MemorySwitch" type="String" value="0"/>
<prop name="ReadThreadInterval" type="String" value="-1"/>
<prop name="QueuingOfflineTimeout" type="String" value="1000"/>
<prop name="InitializeThreadTime" type="String" value="1000"/>
<prop name="TwoColor" type="String" value="0"/>
<prop name="BaudRate" type="String" value="19200"/>
<prop name="TwoByteCharacter" type="String" value="0"/>
<prop name="FirmLogFileSize" type="String" value="1000"/>
<prop name="Peeler" type="String" value="0"/>
<prop name="DefaultCodePage" type="String" value="997"/>
<prop name="epson.trace.detail.max.size" type="String" value="0"/>
<prop name="ConfigurationFile" type="String" value="epson/xml/Setting/TM-H6000IVSetting.xml"/>
<prop name="DeviceType" type="String" value="1"/>
<prop name="Custom1Color" type="String" value="0xFF0000"/>
<prop name="preEndorseFunction" type="String" value="0"/>
<prop name="Upos.Spec_c" type="String" value="false"/>
<prop name="LogicalPortInterfaceName" type="String" value="EPuras"/>
<prop name="FirmNotifyAllProgressEvents" type="String" value="0"/>
<prop name="InitializeResponseTimeout" type="String" value="1000"/>
<prop name="ReceiveRetryTime" type="String" value="25"/>
<prop name="UsedInterCharacterSet" type="String" value="0"/>
<prop name="PrinterTransmitTimeout" type="String" value="30000"/>
<prop name="RecMoreColumns" type="String" value="0"/>
<prop name="EndorseFontMode" type="String" value="1"/>
<prop name="WriteThreadInterval" type="String" value="-1"/>
<prop name="preORCBFunction" type="String" value="0"/>
<prop name="EndorseCharactersPerLine" type="String" value="40"/>
<prop name="RecNearEndSensor" type="String" value="1"/>
<prop name="LogObject" type="String" value=""/>
<prop name="Cutter" type="String" value="1"/>
<prop name="PhysicalDevice" type="String" value="TM-H6000IV"/>
<prop name="UsedPeeler" type="String" value="0"/>
<prop name="FirmLogFileName" type="String" value="Firmware.log"/>
<prop name="InputBufferSize" type="String" value="84"/>
<prop name="TransmitTimeout" type="String" value="5000"/>
<prop name="SlipLineSpacing" type="String" value="12"/>
<prop name="EPurasSupport" type="String" value="TRUE"/>
<prop name="OfflineCount" type="String" value="2"/>
<prop name="TransmitRetryTime" type="String" value="100"/>
<prop name="DirectIOEventTimeout" type="String" value="5000"/>
<prop name="epson.trace.detail.info" type="String" value="0"/>
</JposEntry>

</JposEntries>
</syntaxhighlight>
* In Eclipse open Window->Preferences->OSBP Application Configuration
* Select the product to be configured in the field Product Configuration
[[File:ProductConfiguration1.png|600px]] 
* In the tab External Data Sources put the noted path in the field JavaPOS Configuration
[[File:ProductConfiguration2.png|600px]]

Peripheral Devices

2017-04-26T14:30:40Z

Riegel:

=Epson Cash Register Peripherals=
If you want to work with Epson-Seiko cash register peripherals some extra steps are necessary:
* Download and unzip the ADK from the following site: [https://download.epson-biz.com/modules/pos/index.php?page=single_soft&cid=5405&scat=40&pcat=3 Epson Biz]
* You must pass a registration process on the Epson site
* Install the ADK
* From the start menu launch SetupPos and configure the physical hardware according to the Epson manuals
[[File:EpsonSetupPOS.png|600px]] 
* Save the configuration and note the path to the configuration file
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE JposEntries PUBLIC "-//JavaPOS//DTD//EN"
"jpos/res/jcl.dtd">
<JposEntries>


<JposEntry logicalName="CashDrawer">
<creation factoryClass="jp.co.epson.uposcommon.creator.EpsonJposServiceInstanceFactory" serviceClass="jp.co.epson.upos.H6000IV.drw.StandardService"/>
<vendor name="SEIKO EPSON" url="http://www.epson.com"/>
<jpos category="CashDrawer" version="1.14"/>
<product description="EPSON Standard CashDrawer Device Service" name="EPSON Services for JavaPOS(TM) Standard" url="http://www.epson.com"/>


<prop name="OutputTimeout" type="String" value="500"/>
<prop name="epson.trace.file" type="String" value="trace.log"/>
<prop name="OutputBufferSize" type="String" value="4096"/>
<prop name="PinNumber" type="String" value="0"/>
<prop name="OfflineExecutionDevice" type="String" value="1"/>
<prop name="ConfigurationFile" type="String" value="epson/xml/Setting/TM-H6000IVSetting.xml"/>
<prop name="WriteThreadInterval" type="String" value="-1"/>
<prop name="TransmitRetryTime" type="String" value="100"/>
<prop name="DeviceID" type="String" value="36"/>
<prop name="SupportStatistics" type="String" value="1"/>
<prop name="QueuingOfflineTimeout" type="String" value="1000"/>
<prop name="MultiDrawerStatusSupport" type="String" value="0"/>
<prop name="EPurasSupport" type="String" value="TRUE"/>
<prop name="ReceiveRetryTime" type="String" value="25"/>
<prop name="TransmitTimeout" type="String" value="5000"/>
<prop name="Parity" type="String" value="0"/>
<prop name="StopBits" type="String" value="0"/>
<prop name="MemorySwitch" type="String" value="0"/>
<prop name="FlowType" type="String" value="1"/>
<prop name="InputTimeout" type="String" value="100"/>
<prop name="PulseOFFTime" type="String" value="400"/>
<prop name="LogicalPortName" type="String" value="ESDPRT001"/>
<prop name="StatusThreadInterval" type="String" value="100"/>
<prop name="DefaultSlpClampTime" type="String" value="0"/>
<prop name="LogicalPortInterfaceName" type="String" value="EPuras"/>
<prop name="OfflineRetryIntervalTime" type="String" value="25"/>
<prop name="BitLength" type="String" value="8"/>
<prop name="OfflineCount" type="String" value="2"/>
<prop name="PortType" type="String" value="0"/>
<prop name="InitializeThreadTime" type="String" value="1000"/>
<prop name="PortInterfaceName" type="String" value="Serial"/>
<prop name="PhysicalPrinterName" type="String" value="TM-H6000IV"/>
<prop name="LogObject" type="String" value=""/>
<prop name="PulseONTime" type="String" value="100"/>
<prop name="ForceSend" type="String" value="0"/>
<prop name="PulseStep" type="String" value="100"/>
<prop name="DeviceDesc" type="String" value="EPSON Standard CashDrawer"/>
<prop name="PortName" type="String" value="COM1"/>
<prop name="OpenPulseLevel" type="String" value="0"/>
<prop name="OpenWaitTimeout" type="String" value="5000"/>
<prop name="ReceiveTimeout" type="String" value="1000"/>
<prop name="InitializeResponseTimeout" type="String" value="1000"/>
<prop name="InputBufferSize" type="String" value="84"/>
<prop name="OfflineExecutionInitializeSetting" type="String" value="0"/>
<prop name="PhysicalDevice" type="String" value="Standard"/>
<prop name="Upos.Spec_c" type="String" value="false"/>
<prop name="ReadThreadInterval" type="String" value="-1"/>
<prop name="BaudRate" type="String" value="19200"/>
<prop name="epson.tracing" type="String" value="false"/>
<prop name="DeviceType" type="String" value="1"/>
<prop name="epson.trace.max.size" type="String" value="1000"/>
<prop name="Upos.USB_Serial" type="String" value="false"/>
</JposEntry>

<JposEntry logicalName="LineDisplay">
<creation factoryClass="jp.co.epson.uposcommon.creator.EpsonJposServiceInstanceFactory" serviceClass="jp.co.epson.upos.H6000IV.disp.DMD110Service"/>
<vendor name="SEIKO EPSON" url="http://www.epson.com"/>
<jpos category="LineDisplay" version="1.14"/>
<product description="Unknown Product Description" name="EPSON Services for JavaPOS(TM) Standard" url="http://www.epson.com"/>


<prop name="OutputTimeout" type="String" value="500"/>
<prop name="epson.trace.file" type="String" value="trace.log"/>
<prop name="OutputBufferSize" type="String" value="4096"/>
<prop name="OfflineExecutionDevice" type="String" value="1"/>
<prop name="ConfigurationFile" type="String" value="epson/xml/Setting/DM-D110(v1_14_0001)Setting.xml"/>
<prop name="WriteThreadInterval" type="String" value="-1"/>
<prop name="TransmitRetryTime" type="String" value="100"/>
<prop name="DeviceID" type="String" value="36"/>
<prop name="SupportStatistics" type="String" value="1"/>
<prop name="QueuingOfflineTimeout" type="String" value="1000"/>
<prop name="EPurasSupport" type="String" value="TRUE"/>
<prop name="ReceiveRetryTime" type="String" value="25"/>
<prop name="TransmitTimeout" type="String" value="5000"/>
<prop name="Parity" type="String" value="0"/>
<prop name="StopBits" type="String" value="0"/>
<prop name="MemorySwitch" type="String" value="0"/>
<prop name="FlowType" type="String" value="1"/>
<prop name="InputTimeout" type="String" value="100"/>
<prop name="CharacterMode" type="String" value="0"/>
<prop name="LogicalPortName" type="String" value="ESDPRT001"/>
<prop name="StatusThreadInterval" type="String" value="100"/>
<prop name="DefaultSlpClampTime" type="String" value="0"/>
<prop name="LogicalPortInterfaceName" type="String" value="EPuras"/>
<prop name="OfflineRetryIntervalTime" type="String" value="25"/>
<prop name="BitLength" type="String" value="8"/>
<prop name="OfflineCount" type="String" value="2"/>
<prop name="PortType" type="String" value="0"/>
<prop name="InitializeThreadTime" type="String" value="1000"/>
<prop name="ConnectionType" type="String" value="1"/>
<prop name="GraphicWindowLogicalArea" type="String" value="0"/>
<prop name="PortInterfaceName" type="String" value="Serial"/>
<prop name="PhysicalPrinterName" type="String" value="TM-H6000IV"/>
<prop name="LogObject" type="String" value=""/>
<prop name="DirectIOEventTimeout" type="String" value="5000"/>
<prop name="DeviceDesc" type="String" value="EPSON DM-D110 LineDisplay"/>
<prop name="PortName" type="String" value="COM1"/>
<prop name="ReceiveTimeout" type="String" value="1000"/>
<prop name="InitializeResponseTimeout" type="String" value="1000"/>
<prop name="InputBufferSize" type="String" value="84"/>
<prop name="TwoByteCharacter" type="String" value="0"/>
<prop name="OfflineExecutionInitializeSetting" type="String" value="0"/>
<prop name="PhysicalDevice" type="String" value="DM-D110"/>
<prop name="Upos.Spec_c" type="String" value="false"/>
<prop name="ReadThreadInterval" type="String" value="-1"/>
<prop name="BaudRate" type="String" value="19200"/>
<prop name="epson.tracing" type="String" value="false"/>
<prop name="DeviceType" type="String" value="2"/>
<prop name="epson.trace.max.size" type="String" value="1000"/>
<prop name="Upos.USB_Serial" type="String" value="false"/>
<prop name="PrinterConfigurationFile" type="String" value="epson/xml/Setting/TM-H6000IVSetting.xml"/>
</JposEntry>

<JposEntry logicalName="POSPrinter">
<creation factoryClass="jp.co.epson.uposcommon.creator.EpsonJposServiceInstanceFactory" serviceClass="jp.co.epson.upos.H6000IV.pntr.H6000IVService"/>
<vendor name="SEIKO EPSON" url="http://www.epson.com"/>
<jpos category="POSPrinter" version="1.14"/>
<product description="EPSON TM-H6000IV Printer Device Service" name="EPSON Services for JavaPOS(TM) Standard" url="http://www.epson.com"/>


<prop name="FlowType" type="String" value="1"/>
<prop name="Halftone" type="String" value="0"/>
<prop name="PhysicalPrinterName" type="String" value="TM-H6000IV"/>
<prop name="NVRAMControlLevel" type="String" value="1"/>
<prop name="LogicalPortName" type="String" value="ESDPRT001"/>
<prop name="Stamp" type="String" value="0"/>
<prop name="OutputCompleteType" type="String" value="2"/>
<prop name="StatusThreadInterval" type="String" value="100"/>
<prop name="OutputTimeout" type="String" value="500"/>
<prop name="PortType" type="String" value="0"/>
<prop name="epson.trace.detail.file" type="String" value="detail.log"/>
<prop name="OutputBufferSize" type="String" value="4096"/>
<prop name="UsedNVRAM" type="String" value="0"/>
<prop name="FirmRecordLog" type="String" value="1"/>
<prop name="ReceiveTimeout" type="String" value="1000"/>
<prop name="SlpReverseEject" type="String" value="0"/>
<prop name="PortName" type="String" value="COM1"/>
<prop name="OfflineRetryIntervalTime" type="String" value="25"/>
<prop name="Upos.USB_Serial" type="String" value="false"/>
<prop name="DefaultSlpClampTime" type="String" value="500"/>
<prop name="OfflineExecutionDevice" type="String" value="1"/>
<prop name="epson.trace.file" type="String" value="trace.log"/>
<prop name="StopBits" type="String" value="0"/>
<prop name="AsyncProcessingSize" type="String" value="2"/>
<prop name="RecCharactersPerLine" type="String" value="42"/>
<prop name="KanjiTwoWaysPrint" type="String" value="0"/>
<prop name="PulseStep" type="String" value="100"/>
<prop name="PortInterfaceName" type="String" value="Serial"/>
<prop name="GradationMethod" type="String" value="0"/>
<prop name="OfflineExecutionInitializeSetting" type="String" value="0"/>
<prop name="U375Compatible" type="String" value="0"/>
<prop name="BitLength" type="String" value="8"/>
<prop name="Parity" type="String" value="0"/>
<prop name="preCutterFunction" type="String" value="0"/>
<prop name="epson.tracing" type="String" value="false"/>
<prop name="epson.trace.max.size" type="String" value="1000"/>
<prop name="RecPaperSize" type="String" value="80"/>
<prop name="DeviceDesc" type="String" value="EPSON TM-H6000IV POSPrinter"/>
<prop name="PageModeExt" type="String" value="0"/>
<prop name="RecLineSpacing" type="String" value="30"/>
<prop name="SupportStatistics" type="String" value="1"/>
<prop name="FirmProgressRange" type="String" value="10"/>
<prop name="OutputErrorOption" type="String" value="0"/>
<prop name="EndorseLineSpacing" type="String" value="10"/>
<prop name="SupportFirmware" type="String" value="0"/>
<prop name="DeviceID" type="String" value="36"/>
<prop name="SlipPaperType" type="String" value="2"/>
<prop name="InputTimeout" type="String" value="100"/>
<prop name="SlipCharactersPerLine" type="String" value="45"/>
<prop name="AutoPowerOff" type="String" value="0"/>
<prop name="SlpMoreColumns" type="String" value="0"/>
<prop name="RecPaperType" type="String" value="0"/>
<prop name="MemorySwitch" type="String" value="0"/>
<prop name="ReadThreadInterval" type="String" value="-1"/>
<prop name="QueuingOfflineTimeout" type="String" value="1000"/>
<prop name="InitializeThreadTime" type="String" value="1000"/>
<prop name="TwoColor" type="String" value="0"/>
<prop name="BaudRate" type="String" value="19200"/>
<prop name="TwoByteCharacter" type="String" value="0"/>
<prop name="FirmLogFileSize" type="String" value="1000"/>
<prop name="Peeler" type="String" value="0"/>
<prop name="DefaultCodePage" type="String" value="997"/>
<prop name="epson.trace.detail.max.size" type="String" value="0"/>
<prop name="ConfigurationFile" type="String" value="epson/xml/Setting/TM-H6000IVSetting.xml"/>
<prop name="DeviceType" type="String" value="1"/>
<prop name="Custom1Color" type="String" value="0xFF0000"/>
<prop name="preEndorseFunction" type="String" value="0"/>
<prop name="Upos.Spec_c" type="String" value="false"/>
<prop name="LogicalPortInterfaceName" type="String" value="EPuras"/>
<prop name="FirmNotifyAllProgressEvents" type="String" value="0"/>
<prop name="InitializeResponseTimeout" type="String" value="1000"/>
<prop name="ReceiveRetryTime" type="String" value="25"/>
<prop name="UsedInterCharacterSet" type="String" value="0"/>
<prop name="PrinterTransmitTimeout" type="String" value="30000"/>
<prop name="RecMoreColumns" type="String" value="0"/>
<prop name="EndorseFontMode" type="String" value="1"/>
<prop name="WriteThreadInterval" type="String" value="-1"/>
<prop name="preORCBFunction" type="String" value="0"/>
<prop name="EndorseCharactersPerLine" type="String" value="40"/>
<prop name="RecNearEndSensor" type="String" value="1"/>
<prop name="LogObject" type="String" value=""/>
<prop name="Cutter" type="String" value="1"/>
<prop name="PhysicalDevice" type="String" value="TM-H6000IV"/>
<prop name="UsedPeeler" type="String" value="0"/>
<prop name="FirmLogFileName" type="String" value="Firmware.log"/>
<prop name="InputBufferSize" type="String" value="84"/>
<prop name="TransmitTimeout" type="String" value="5000"/>
<prop name="SlipLineSpacing" type="String" value="12"/>
<prop name="EPurasSupport" type="String" value="TRUE"/>
<prop name="OfflineCount" type="String" value="2"/>
<prop name="TransmitRetryTime" type="String" value="100"/>
<prop name="DirectIOEventTimeout" type="String" value="5000"/>
<prop name="epson.trace.detail.info" type="String" value="0"/>
</JposEntry>

</JposEntries>
* In Eclipse open Window->Preferences->OSBP Application Configuration
* Select the product to be configured in the field Product Configuration
[[File:ProductConfiguration1.png|600px]] 
* In the tab External Data Sources put the noted path in the field JavaPOS Configuration
[[File:ProductConfiguration2.png|600px]]