Data Interchange DSL

From OS.bee documentation
Revision as of 15:09, 3 August 2017 by Worayeno (Talk | contribs)

Jump to: navigation, search

A general introduction and some high-level concepts for OSBP DSLs can be found in OSBP DSL Documentation.

Please note that you can only make use of the Datainterchange DSL by downloading its packages from the download section of our website.


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.


Figure 1 - Data Interchange Structure.

As shown in Figure 1, 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 WorkerThreadRunnable 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.

The main semantic elements of the Compex Data Interchange DSL are the following:

  • package
- specify the datainterchange package, which acts as a namespace. It should have the form net.osbee.sample.<applicationname>.datainterchanges by convention.
  • titletext
- the name of the datainterchange package. This name will be used for code generation and should thus be unique if there are multiple datainterchange packages.
  • interchangename

Data Interchange Model File

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

Reserved Keywords

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


In the import section are all entities to be found - as full qualified names – that are currently used in the DSL and automatically imported/added (OXImportDeclaration) by editing it. import ns net.osbee.sample.<ApplicationName>.entities.SampleEntity1 import ns net.osbee.sample.<ApplicationName>.entities.SampleEntity2 import ns net.osbee.sample.<ApplicationName>.entities.SampleEntity3


Datainterchange DSL model files must start with a package declaration. Packages are the root element of the DSL grammar and must be defined as follow package <PackageName> for example

package net.osbee.sample.ApplicationName.datainterchanges { }

Data Interchange models may be split into several .data files, as long as they have the same package declaration.

package net.osbee.sample.<applicationname>.datainterchanges title "<titletext>" {
    interchange <interchangename> persist file
    <fileformat> "<filepath>" [<further specifications>]
    beans {
        <entity relationships>


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 the title DataInterchange package net.osbee.sample.foodmart.datainterchanges title "DataInterchange" {}

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


All interchange units have to be defined in the package followed by the Entity they are referencing/applied to. interchange <EntityName> <EntityManagerMode> <FileFormat> {}


With this keyword you get to set the optional description of an interchange unit as shown below. interchange <EntityName> describedBy "This is a description of the Datainterchange DSL Unit EntityName" … {}

persist, merge, remove

With those keywords defined inside the Enum Entity Manager Mode, you set how the data have to be process by inserting then into a database. interchange <EntityName> <EntityManagerMode> … {}

Example 1: interchange SampleEntity1 merge … {} Example 2: interchange SampleEntity2 persist … {} Example 3: interchange SampleEntity3 remove … {}


With the keyword file you are able to set the file format of the files you intent to process with you interchange unit. interchange <EntityName> <EntityManagerMode> file <FileNameFormat> {}

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: interchange SampleEntity1 merge file CSV "C:/temp/testFile.csv” {} Example 2: interchange SampleEntity2 persist file XML "C:/temp/testFile.xml” {} Example 3: interchange SampleEntity3 merge file EDI "C:/temp/testFile.edi” {}

After choosing the file format you can either give the file name in a String value as shown here above or press the buttons Ctrl + Space to get the option of opening a File Chooser/Picker to specify the file you want to work with. File:Example.jpg


With the keyword elementSize followed by a number between 0 and 100 ? you set the average size of the file (or set of data). Example: interchange SampleEntity1 merge elementSize 50 file CSV "C:/temp/testFile.csv” {}


With the keyword delimiter you set the delimiter/separation character of the file. Example: interchange SampleEntity1 merge elementSize 50 file CSV "C:/temp/testFile.csv” delimiter ";" {}


With the keyword skipLines followed by a number you specify the number of line to be skipped or not to be considered in the processing of the selected file. Example: interchange SampleEntity1 merge elementSize 50 file CSV "C:/temp/testFile.csv” delimiter ";" skipLines 1 {}









expression -> assign | copy |


keys -> key


mapping ->








Configuration Settings / Smooks Framework (A small introduction)



Smooks (Extended)

just links???

WorkerThread (Runnable)

TriggerView & Executorservice

DSL Inferrer

DSL Scope Provider

DSL Proposal Provider

DSL Validator

Copyright Notice

All rights are reserved by Compex Systemhaus GmbH. In particular, duplications, translations, microfilming, saving and processing in electronic systems are protected by copyright. Use of this manual is only authorized with the permission of Compex Systemhaus GmbH. Infringements of the law shall be punished in accordance with civil and penal laws. We have taken utmost care in putting together texts and images. Nevertheless, the possibility of errors cannot be completely ruled out. The Figures and information in this manual are only given as approximations unless expressly indicated as binding. Amendments to the manual due to amendments to the standard software remain reserved. Please note that the latest amendments to the manual can be accessed through our helpdesk at any time. The contractually agreed regulations of the licensing and maintenance of the standard software shall apply with regard to liability for any errors in the documentation. Guarantees, particularly guarantees of quality or durability can only be assumed for the manual insofar as its quality or durability are expressly stipulated as guaranteed. If you would like to make a suggestion, the Compex Team would be very pleased to hear from you.

(c) 2016-2023 Compex Systemhaus GmbH