Difference between revisions of "Data Interchange DSL"

From OS.bee documentation
Jump to: navigation, search
Line 93: Line 93:
  
 
====marker====
 
====marker====
 +
 +
==Configuration Settings / Smooks Framework (A small introduction)==
  
 
==Annotations==
 
==Annotations==
  
 
==Comments==
 
==Comments==
 +
 +
==Smooks (Extended)==
 +
just links???
 +
 +
==WorkerThread (Runnable)==
 +
 +
==TriggerView & Executorservice==
 +
 +
==DSL Inferrer==
 +
 +
==DSL Scope Provider==
 +
 +
==DSL Proposal Provider==
 +
 +
==DSL Validator==
  
 
== Copyright Notice ==
 
== Copyright Notice ==
 
{{Copyright Notice}}
 
{{Copyright Notice}}

Revision as of 07:29, 3 August 2017

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

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

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.

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


Reserved Keywords

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

package

Datainterchange DSL model files must start with a package declaration. Packages are the root element of the Entity DSL grammar. All interchange units have to be defined in the package.

import

interchange

describedBy

merge

persist

remove

elementSize

file -> CSV | EDI | XML

report

delimiter

indent

quoteCharacter

skipLines

strict

beans

entity

createOn

element

expression -> assign | copy | with...as

format

keys -> key

list

mapping -> map...to

lookup

marker

Configuration Settings / Smooks Framework (A small introduction)

Annotations

Comments

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-2021 Compex Systemhaus GmbH