Datainterchange DSL - Revision history

Mollik: /* file */

2021-08-05T09:57:48Z

‎file

Kraeling: Changed keyword "beans" to "path

2019-09-12T09:33:29Z

Changed keyword "beans" to "path

Kraeling at 15:49, 4 September 2019

2019-09-04T15:49:06Z

Kraeling at 13:08, 2 September 2019

2019-09-02T13:08:25Z

Riegel at 07:30, 8 May 2019

2019-05-08T07:30:46Z

Yang: /* expose */

2018-04-19T13:36:51Z

‎expose

Yang: /* expose */

2018-04-19T13:35:10Z

‎expose

Yang: /* expose */

2018-04-19T13:34:43Z

‎expose

Yang: /* expose */

2018-04-19T13:33:35Z

‎expose

Yang: /* expose */

2018-04-19T13:32:55Z

‎expose

← Older revision		Revision as of 09:57, 5 August 2021
Line 144:		Line 144:

	Please note that you can also change the path(?) of the file to process on runtime by selecting a new file.		Please note that you can also change the path(?) of the file to process on runtime by selecting a new file.
		+
		+	'''new with OS.bee Softwarefactory 4.5.4'''
		+
		+	* Export
		+	** The files created during export will be numbered in case the file already exists. E.g. the next exported "testFile.xml" will be named "testFile#1.xml" if "testFile.xml" is already in the target directory.
		+	** The number of entries in a file can now be configured. The default ist 1000. The configuration can be done via a system configuration paramter corresponding each datainterchange definition. The configuration is created if it is not present and can be adjusted later.
		+
		+	* Import
		+	** The import reads now files that follow a numbering scheme. E.g. "testFile.xml" as the default name is still read. In addition, files with the pattern "testfile#<number>.xml" are also processed. This allows to add new files into the directory althoug "old" files are still there or to split up files due to a huge the number of records that shall be processed.
		+	** The import processes existing files after a system restart.
		+
		+	* Common
		+	** Monitoring of the datainterchange work is now possible through the application frontend. Under Administration / monitoring, one can find a perspective that shows the datainterchange action. The entries are kept 7 days by default. The duration can be configured in the system configuration

	===mapByAttribute===		===mapByAttribute===

@@ Line 56: / Line 56: @@
 ► '''Example''':
 <syntaxhighlight lang="java">
-interchange <InterchangeUnitName> [describedBy <description>] <EntityManagerMode> file <FileType> [<FileDetails>] beans {
+interchange <InterchangeUnitName> [describedBy <description>] <EntityManagerMode> file <FileType> [<FileDetails>] path{
    ...
+}
@@ Line 70: / Line 70: @@
 interchange CurrencyNames persist file
 CSV "C:/data/ISOCurrencyCode20170101.csv" delimiter ";" skipLines 1 encoding "UTF-8"
-beans {
+path {
    ...
+}
 </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".
+The <code>path</code> keyword comes after all the file specification and starts a block of entity definitions, which will be covered in section "entity".
 ===describedBy===
@@ Line 103: / Line 103: @@
 interchange EDIOrders describedBy "Orders" persist file
 XML "C:/data/orders.xml"
-beans {
+path {
    ...
+}
@@ Line 112: / Line 112: @@
 interchange Stores merge file
 XML "C:/data/stores.xml"
-beans {
+path {
    ...
+}
@@ Line 121: / Line 121: @@
 interchange Storesremove remove file
 XML "C:/data/stores_remove.xml"
-beans {
+path {
    ...
+}
@@ Line 172: / Line 172: @@
 ► '''Example''':
 <syntaxhighlight lang="java">
-interchange EDIOrders describedBy "edi orders" persist elementSize 50 file EDI "C:/data/orders.edi" beans {
+interchange EDIOrders describedBy "edi orders" persist elementSize 50 file EDI "C:/data/orders.edi" path {
    ...
+}
@@ Line 236: / Line 236: @@
-===beans===
+===path===
-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.
+The keyword <code>path</code> starts the series of entities. (Formerly, the keyword was named <code>beans</code>. The name "bean" comes from the internal entities called JavaBean, which act as data containers.)
@@ Line 270: / Line 270: @@
 ► '''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 {
+interchange Stores remove vectorName "stores" elementSize 83 file XML "C:/.../net.osbee.sample.foodmart/net.osbee.sample.foodmart.datainterchange/smooks-resources/stores.xml" path {
 	entity Mregion nodeName    "region"
 	entity Mstore nodeName     "store"
@@ Line 277: / Line 277: @@
 </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.
+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 path {...} expression block. The alias you have specified after the keyword will be used as element (entity) name inside the XML files.
@@ Line 289: / Line 289: @@
 ► '''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 {
+interchange Stores remove vectorName "stores" elementSize 83 file XML "C:/.../net.osbee.sample.foodmart/net.osbee.sample.foodmart.datainterchange/smooks-resources/stores.xml" path {
 	entity Mregion
 	entity Mstore nodeName     "store"
@@ Line 413: / Line 413: @@
 	XML "C:/git/development/net.osbee.sample.foodmart/net.osbee.sample.foodmart.datainterchange/smooks-resources/eurofxref-hist-90d.xml"
-	mapByAttribute beans {
+	mapByAttribute path {
 		entity McurrencyStream createOn "/Envelope/Cube" marker latest expression {
 			assign importDate with NowDate as Date

@@ Line 315: / Line 315: @@
 will create an <code>Mcurrency</code> entity when encountering <code>/Envelope/Cube/Cube</code> in the source data file.
-====marker====
+====latestImport / latestExport====
-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:
+With <code>latestImport</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 {
+entity McurrencyStream createOn "/Envelope/Cube" latestImport latest expression {
 	...
+}
@@ Line 328: / Line 328: @@
 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====

@@ Line 34: / Line 34: @@
 ===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>.
+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>.datainterchanges</code>.
 ► '''Example''':

@@ Line 766: / Line 766: @@
 The path value obviously depends on the operating system you are developing.
 == Copyright Notice ==
 {{Copyright Notice}}

@@ Line 536: / Line 536: @@
 </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 can also be exported.
+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'''".
 <syntaxhighlight lang="java">

← Older revision		Revision as of 13:34, 19 April 2018
Line 524:		Line 524:
	</syntaxhighlight>		</syntaxhighlight>

−	~~and~~

	<syntaxhighlight lang="java">		<syntaxhighlight lang="java">

@@ Line 503: / Line 503: @@
          ref <EntityReference>
              on <EntityAttribute>
-           | expose { subExpose }
+           | subExpose
          ...
+     }

← Older revision		Revision as of 13:32, 19 April 2018
Line 509:		Line 509:
	</syntaxhighlight>		</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''':		► '''Example''':