| Oracle Agile Engineering Data Management Enterprise Integration Platform Administration Guide Release e6.2.1.0 E69180-01 |
|
 Previous |
 Next |
| Oracle Agile Engineering Data Management Enterprise Integration Platform Administration Guide Release e6.2.1.0 E69180-01 |
|
Previous |
Next |
This chapter describes all connectors that read and write files.
The Business Object Data (BOD) File Connector allows writing the XML messages into a file or reading an XML file as input for further processing by the Integration Platform.
Below is a description of the Business Object Data File connector sections in the eai_ini.xml file. It describes the file parameters (In: Business Object Data File --> Business Object Data; out: Business Object --> Business Object Data File).
<connector name="file-in" version="2.2.0" active="false" class="com.eigner.eai.connector.file.BodFileConnector">
<in name="${eai.temp}/bod_in.xml" iterations="1" action="rename" rename="date"/>
<out name="${eai.temp}/bod_out.xml" write="overwrite"/>
</connector>
Details of the XML tags:
| Tag | Description |
|---|---|
| in | input file |
| out | output file |
Details of the XML tag in:
| Attribute | Description | Values |
|---|---|---|
| directory | directory of the input files | optional |
| name respective filter | name or mask of the input file | If the attribute directory is given, the value of the attribute name respective the filter is used as a RegularExpression for masking the name of the input files. Only the oldest input files will be processed.
If the attribute directory isn't given, the value of the attribute name respective the filter is used as the name of the input file. Hint: name and filter are exchangeable, only one of the both is allowed. |
| iterations | how often should the input file be read | 0 : read the input file endless n : read the input file n times |
| action | action after reading the input file | none (default), delete, rename, move |
| rename | how to rename the input file | date (default) |
| move | directory where the input file has to be moved after reading | the directory must be present |
Details of the XML tag out:
| Attribute | Description | Values |
|---|---|---|
| name respective base | name of the output file respective base part of the name of the output file | If the attribute base is given the file name will be made up of base + '_' + dynamic + '.' + extension
Hint: name and base are exchangeable, only one of the two is allowed. |
| write | write mode of the output file | overwrite (default), backup |
| backup | how to create a backup version of an existing file | date (default), insertDate (the date is inserted into the file name directly before the extension) |
| return_data | in case of a request empty data element if false or return whole data if true | false (default), true |
| dynamic | how to create the dynamic part of the name of the output file | date (default)
Hint: dynamic will be analyzed only in case of the presence of the attribute base |
| extension | extension part of the name of the output file | default: xml
Hint: extension will be analyzed only in case of the presence of the attribute base |
The synchronous Business Object Data (BOD) File Connector is a pure source connector which allows reading an XML file as input for further processing by the Integration Platform.
Below is a description of the synchronous Business Object Data File connector sections in the eai_ini.xml file. It describes the file parameters (In: Business Object Data File --> Business Object Data).
<synchronous name="file-in-sync" version="2.2.0" active="false" class="com.eigner.eai.connector.file.BodFileSyncConnector">
<in directory="${eai.temp}" filter="bod_in_.*xml" directoryInterval="10" fileInterval="10" action="move"
move="${eai.temp}/save"/>
</synchronous>
Details of the XML tags:
| Tag | Description |
|---|---|
| in | input directory |
Details of the XML tag in:
| Attribute | Description | Values |
|---|---|---|
| directory | directory of the input files | |
| filter respective name | filter of the input files | RegularExpression for filtering the name of the input files. The input files will be processed in their temporal order.
Hint: filter and name are exchangeable, only one of the two is allowed. |
| directoryInterval | polling interval of the input directory | value in seconds |
| fileInterval | polling interval of the input files | value in seconds |
| action | action after reading the input file | none (default), delete, rename, move |
| rename | how to rename the input file | date (default) |
| move | directory where the input file has to be moved after reading | the directory must be present |
The Data File Connector can be used for writing into files and for reading from a file. The special feature provided by this connector is the ability to perform an XSL transformation just before writing the file respectively just after reading from the file. This can be used to transform the XML message, e.g. into HTML before writing it to a file or vice versa.
Below is a description of the data file connector section in the eai_ini.xml file. It describes the file parameters (In: Data File --> Business Object Data; out: Business Object --> Data File).
<connector name="data-file-out" version="2.2.0" active="false" class="com.eigner.eai.connector.file.DataFileConnector">
<out name="${eai.temp}/axa_item_out.html" write="overwrite" return_data="false"/>
<transformation direction="out" name="${eai.conf}/data_file.xsl"/>
</connector>
Details of the XML tags:
| Tag | Description | Hint |
|---|---|---|
| in | input file | Input file |
| out | output file | Output file |
| transformation | transformation file (optional) | Transformation |
Details of the XML tag in:
| Attribute | Description | Values |
|---|---|---|
| directory | directory of the input files | Optional |
| name respective filter | name or mask of the input file | If the attribute directory is given, the value of the attribute name respective the filter is used as a RegularExpression for masking the name of the input files. Only the oldest input files will be processed.
If the attribute directory is not given, the value of the attribute name respective the filter is used as the name of the input file. Hint: name and filter are exchangeable, only one of the two is allowed. |
| iterations | how often should the input file be read | 0: read the input file endless n: read the input file n times |
| action | action after reading the input file | none (default), delete, rename, move |
| rename | how to rename the input file | date (default) |
| move | directory where the input file has to be moved after reading | the directory must be present |
Details of the XML tag out:
| Attribute | Description | Values |
|---|---|---|
| name respective base | name of the output file respective base part of the name of the output file | If the attribute base is given the file name will be made up of base + '_' + dynamic + '.' + extension
Hint: name and base are exchangeable, only one of the two is allowed. |
| write | write mode of the output file | overwrite (default), backup |
| backup | how to create a backup version of an existing file | date (default), insertDate (the date is inserted into the file name directly before the extension) |
| return_data | in case of a request empty data element if false or return whole data if true | false (default), true |
| dynamic | how to create the dynamic part of the name of the output file | date (default)
Hint: dynamic will be analyzed only in case of the present of the attribute base |
| extension | extension part of the name of the output file | default: xml
Hint: extension will be analyzed only in case of the present of the attribute base |
Details of the XML tag transformation:
| Attribute | Description | Hint |
|---|---|---|
| direction | Direction for mapping | If the connector is a source connector, direction "in" must be used.
If the connector is a target connector, direction "out" must be used. |
| name | name of the transformation file (optional) | If the attribute is not given or empty, the Data File connector has the same behavior as the Business Object Data File connector. |
The synchronous Data File Connector is a pure source connector which can be used for reading from a file. The special feature provided by this connector is the ability to perform an XSL transformation just after reading from file.
Below is a description of the synchronous Data File connector section in the eai_ini.xml file. It describes the file parameters (In: Data File --> Business Object Data).
<synchronous name="data-file-sync" version="2.2.0" active="false" class="com.eigner.eai.connector.file.DataFileSyncConnector">
<in directory="${eai.temp}" filter="data_in_.*xml" directoryInterval="10" fileInterval="10" action="move"
move="${eai.temp}/save"/>
<transformation direction="in" name="${eai.conf}/data_file.xsl"/>
</synchronous>
Details of the XML tags:
| Tag | Description | Hint |
|---|---|---|
| in | input directory | Input file |
| transformation | transformation file (optional) | Transformation |
Details of the XML tag in:
| Attribute | Description | Values |
|---|---|---|
| directory | directory of the input files | |
| filter respective name | filter of the input files | RegularExpression for filtering the name of the input files. The input files will be processed in their temporal order.
Hint: filter and name are exchangeable, only one of the two is allowed. |
| directoryInterval | polling interval of the input directory | value in seconds |
| fileInterval | polling interval of the input files | value in seconds |
| action | action after reading the input file | none (default), delete, rename, move |
| rename | how to rename the input file | date (default) |
| move | directory where the input file has to be moved after reading | the directory must be present |
Details of the XML tag transformation:
| Attribute | Description | Hint |
|---|---|---|
| direction | Direction for mapping | "in" (source connector) |
| name | name of the transformation file (optional) | If the attribute is not given or empty, the Data File connector has the same behavior as the Business Object Data File connector |
The feature provided by the Fixed File Connector is the ability to write to and read from Fixed Length Files, where the position of data is fixed in every line of the file.
Below is a description of the Fixed Format File connector sections in the eai_ini.xml file. It describes the file parameters.
(In: fixed format file > business object data, i.e. the created XML elements are assigned to the data element of the respective record; out: business object > fixed format file, i.e. root is the data element of the respective record).
<connector name="fixed-file-in" version="2.2.0" class="com.eigner.eai.connector.file.FixedFileConnector" active="false">
<in name="${eai.temp}/fixed_in.txt" iterations="1"/>
<recordtype="ITEM" verb="CREATE"/>
<write_empty>true</write_empty>
<title_lines>1</title_lines>
<title_separator>;</title_separator>
<comment_prefix>//</comment_prefix>
<fieldtitle="PART_ID" begin="1" end="15" align="left"/>
<fieldtitle="UNIT" begin="16" end="18" align="left"/>
<fieldtitle="PART_NAME_GER" begin="20" end="39" align="left"/>
<fieldtitle="PART_NAME_ENG" begin="41" end="60" align="left"/>
</connector>
Details of the XML tags:
| Tag | Description | Values |
|---|---|---|
| in | input file | |
| out | output file | |
| record | corresponding business object | |
| write_empty | write empty tags | true, false |
| title_lines | number of the title lines | |
| title_separator | separator of the title lines | default: ; |
| comment_prefix | prefix which indicates a comment line | |
| field | detail information of a field |
Details of the XML tag in:
| Attribute | Description | Values |
|---|---|---|
| directory | directory of the input files | optional |
| name respective filter | name or mask of the input file | If the attribute directory is given, the value of the attribute name respective the filter is used as a regular expression for masking the name of the input files. Only the oldest input files will be processed.
If the attribute directory isn't given, the value of the attribute name respective the filter is used as the name of the input file. Hint: name and filter are exchangeable, only one of the two is allowed. |
| iterations | how often should the input file be read |
|
| action | action after reading the input file | none (default), delete, rename, move |
| rename | how to rename the input file | date (default) |
| move | directory where the input file has to be moved after reading | the directory must be present |
Details of the XML tag out:
| Attribute | Description | Values |
|---|---|---|
| name respective base | name of the output file respective base part of the name of the output file | If the attribute base is given the file name will be made up of base + '_' + dynamic + '.' + extension
Hint: name and base are exchangeable, only one of the two is allowed. |
| write | write mode of the output file | overwrite (default), append, backup |
| backup | how to create a backup version of an existing file | date (default), insertDate (the date is inserted into the file name directly before the extension) |
| return_data | in case of a request empty data element if false or return whole data if true | false (default), true |
| dynamic | how to create the dynamic part of the name of the output file | date (default)
Hint: dynamic will be analyzed only in case of the presence of the attribute base |
| extension | extension part of the name of the output file | default: txt
Hint: extension will be analyzed only in case of the presence of the attribute base |
Details of the XML tag record:
| Attribute | Description | Values |
|---|---|---|
| type | type of the corresponding business object | |
| verb | verb of the corresponding business object | |
| grouped | a record contains many lines or will be created from many lines (optional) | false (default), true |
| via_tag | name of the tag which identifies one line in the record required if grouped = true |
Details of the XML tag field:
| Attribute | Description | Values |
|---|---|---|
| title | name of the input or output tag | |
| begin | beginning position of the field in the file line | |
| end | ending position of the field in the file line | |
| align | alignment of the field in the file line | left (default), right, middle |
| trim | trimming of the field (tag value) | none (default), left, right, both |
| type | type of the field | string (default), char, int, long, float, double |
| origin | XPath expression to get the source Element |
|
Note: The attribute origin is only used in the "out" mode: business object to fixed format file. In this case, if the attributes title and origin both are given, the attribute origin is used for the determination of the source element. |
The feature provided by the synchronous Fixed File Connector is the ability to read from Fixed Length Files, where the position of data is fixed in every line of the file.
Below is a description of the synchronous Fixed Format File connector sections in the eai_ini.xml file. It describes the file parameters.
(In: fixed format file > business object data, i.e. the created XML elements are assigned to the data-element of the respective record)
<synchronous name="fixed-file-sync" version="2.2.0" class="com.eigner.eai.connector.file.FixedFileSyncConnector" active="false">
<in directory="${eai.temp}" filter="fixed_in_.*xml" directoryInterval="10" fileInterval="10" action="move"
move="${eai.temp}/save"/>
<record type="ITEM" verb="CREATE"/>
<write_empty>true</write_empty>
<title_lines>1</title_lines>
<title_separator>;</title_separator>
<comment_prefix>//</comment_prefix>
<field title="PART_ID" begin="1" end="15" align="left"/>
<field title="UNIT" begin="16" end="18" align="left"/>
<field title="PART_NAME_GER" begin="20" end="39" align="left"/>
<field title="PART_NAME_ENG" begin="41" end="60" align="left"/>
</synchronous>
Details of the XML tags:
| Tag | Description | Values |
|---|---|---|
| in | input file | |
| record | corresponding business object | |
| write_empty | write empty tags | true, false |
| title_lines | number of the title lines | |
| title_separator | separator of the title lines | default: ; |
| comment_prefix | prefix which indicates a comment line | |
| field | detail information of a field |
Details of the XML tag in:
| Attribute | Description | Values |
|---|---|---|
| directory | directory of the input files | |
| filter respective name | filter of the input files | Regular expression for filtering the name of the input files. The input files will be processed in their temporal order.
Hint: filter and name are exchangeable, only one of the two is allowed. |
| directoryInterval | polling interval of the input directory | value in seconds |
| fileInterval | polling interval of the input files | value in seconds |
| action | action after reading the input file | none (default), delete, rename, move |
| rename | how to rename the input file | date (default) |
| move | directory where the input file has to be moved after reading | the directory must be present |
Details of the XML tag record:
| Attribute | Description | Values |
|---|---|---|
| type | type of the corresponding business object | |
| verb | verb of the corresponding business object | |
| grouped | a record contains many lines or will be created from many lines (optional) | false (default), true |
| via_tag | name of the tag which identifies one line in the record required if grouped = true |
Details of the XML tag field:
| Attribute | Description | Values |
|---|---|---|
| title | name of the input or output tag | |
| begin | beginning position of the field in the file line | |
| end | ending position of the field in the file line | |
| align | alignment of the field in the file line | left (default), right, middle |
| trim | trimming of the field (tag value) | none (default), left, right, both |
| type | type of the field | string (default), char, int, long, float, double |
| origin | XPath expression to get the source Element |
|
Note: The attribute origin is only used in the "out" mode: business object to fixed format file. In this case, if the attributes title and origin both are given, the attribute origin is used for the determination of the source element. |
The Comma Separated Value (CSV) File Connector allows writing to and read from files, where the data entries (per line) are separated by a delimiter, e.g. a comma.
Below is a description of the Comma Separated Value File connector sections in the eai_ini.xml file. It describes the file parameters.
(In: comma separated value file > business object data, i.e. the created XML elements are assigned to the data element of the respective record; out: business object > comma separated value file, i.e. root is the data element of the respective record).
<connector name="csv-file-in" version="2.2.0" active="false" class="com.eigner.eai.connector.file.CsvFileConnector">
<in name="${eai.temp}/csv_in.txt" iterations="1"/>
<record type="ITEM" verb="CREATE" grouped="false" via_tag="line"/>
<separator>;</separator>
<write_empty>false</write_empty>
<title_lines>1</title_lines>
<title_separator>;</title_separator>
<comment_prefix>//</comment_prefix>
<field title="PART_ID" trim="both"/>
<field title="UNIT"/>
<field title="PART_NAME_GER"/>
<field title="PART_NAME_ENG"/>
</connector>
Details of the XML tags:
| Tag | Description | Values |
|---|---|---|
| in | input file | |
| out | output file | |
| record | corresponding business object | |
| separator | separator of the file line | default: ; |
| write_empty | write empty tags | true, false |
| title_lines | number of the title lines | |
| title_separator | separator of the title lines | default: separator of the file line |
| comment_prefix | prefix which indicates a comment line | |
| field | detail information of a field |
Details of the XML tag in:
| Attribute | Description | Values |
|---|---|---|
| directory | directory of the input files | optional |
| name respective filter | name or mask of the input file | If the attribute directory is given, the value of the attribute name respective the filter is used as a regular expression for masking the name of the input files. Only the oldest input files will be processed.
If the attribute directory isn't given, the value of the attribute name respective the filter is used as the name of the input file. Hint: name and filter are exchangeable, only one of the two is allowed. |
| iterations | how often should the input file be read | 0: read the input file endless n: read the input file n times |
| action | action after reading the input file | none (default), delete, rename, move |
| rename | how to rename the input file | date (default) |
| move | directory where the input file has to be moved after reading | the directory must be present |
Details of the XML tag out:
| Attribute | Description | Values |
|---|---|---|
| name respective base | name of the output file respective base part of the name of the output file | If the attribute base is given the file name will be made up of base + '_' + dynamic + '.' + extension
Hint: name and base are exchangeable, only one of the two is allowed. |
| write | write mode of the output file | overwrite (default), append, backup |
| backup | how to create a backup version of an existing file | date (default), insertDate (the date is inserted into the file name directly before the extension) |
| return_data | in case of a request empty data element if false or return whole data if true | false (default), true |
| dynamic | how to create the dynamic part of the name of the output file | date (default)
Hint: dynamic will be analyzed only in case of the presence of the attribute base |
| extension | extension part of the name of the output file | default: txt
Hint: extension will be analyzed only in case of the presence of the attribute base |
Details of the XML tag record:
| Attribute | Description | Values |
|---|---|---|
| type | type of the corresponding business object | |
| verb | verb of the corresponding business object | |
| grouped | a record contains many lines or will be created from many lines (optional) | false (default), true |
| via_tag | name of the tag which identifies one line in the record required if grouped = true |
Details of the XML tag field:
| Attribute | Description | Values |
|---|---|---|
| title | name of the input or output tag | |
| trim | trimming of the field (tag value) | none (default), both |
| type | type of the field | string (default), char, int, long, float, double |
| origin | XPath expression to get the source Element |
|
Note: The attribute origin is only used in the "out" mode: business object to comma separated value file. In this case, if the attributes title and origin both are given, the attribute origin is used for the determination of the source element. |
The synchronous Comma Separated Value (CSV) File Connector allows reading from files, where the data entries (per line) are separated by a delimiter, e.g. a comma.
Below is a description of the synchronous Comma Separated Value File connector sections in the eai_ini.xml file. It describes the file parameters.
(In: comma separated value file > business object data, i.e. the created XML elements are assigned to the data element of the respective record).
<synchronous name="csv-file-sync" version="2.2.0" active="false" class="com.eigner.eai.connector.file.CsvFileSyncConnector">
<in directory="${eai.temp}" filter="csv_in_.*xml" directoryInterval="10" fileInterval="10" action="move"
move="${eai.temp}/save"/>
<record type="ITEM" verb="CREATE" grouped="false" via_tag="line"/>
<separator>;</separator>
<write_empty>false</write_empty>
<title_lines>1</title_lines>
<title_separator>;</title_separator>
<comment_prefix>//</comment_prefix>
<field title="PART_ID" trim="both"/>
<field title="UNIT"/>
<field title="PART_NAME_GER"/>
<field title="PART_NAME_ENG"/>
</synchronous>
Details of the XML tags:
| Tag | Description | Values |
|---|---|---|
| in | input file | |
| record | corresponding business object | |
| separator | separator of the file line | default: ; |
| write_empty | write empty tags | true, false |
| title_lines | number of the title lines | |
| title_separator | separator of the title lines | default: separator of the file line |
| comment_prefix | prefix which indicates a comment line | |
| field | detail information of a field |
Details of the XML tag in:
| Attribute | Description | Values |
|---|---|---|
| directory | directory of the input files | |
| filter respective name | filter of the input files | Regular expression for filtering the name of the input files. The input files will be processed in their temporal order.
Hint: filter and name are exchangeable, only one of the both is allowed. |
| directoryInterval | polling interval of the input directory | value in seconds |
| fileInterval | polling interval of the input files | value in seconds |
| action | action after reading the input file | none (default), delete, rename, move |
| rename | how to rename the input file | date (default) |
| move | directory where the input file has to be moved after reading | the directory must be present |
Details of the XML tag record:
| Attribute | Description | Values |
|---|---|---|
| type | type of the corresponding business object | |
| verb | verb of the corresponding business object | |
| grouped | a record contains many lines or will be created from many lines (optional) | false (default), true |
| via_tag | name of the tag which identifies one line in the record required if grouped = true |
Details of the XML tag field:
| Attribute | Description | Values |
|---|---|---|
| title | name of the input or output tag | |
| trim | trimming of the field (tag value) | none (default), both |
| type | type of the field | string (default), char, int, long, float, double |
| origin | XPath expression to get the source Element |
