Skip to content

FILESYSTEM - DATA SINK

Description

The FILESYSTEM data sink is designed to write files to the filesystem of the server. This dataSink is particularly useful during development and when developers are using the compose script to run Apiro locally. The use of this dataSinks saves developers time from setting up MAIL or SFTP servers or message queues in order to distribution to downstream systems. .

Config

REQUIRED

Config Parameters

Name Description
filePath This is the relative path to the output file including the name and extension of the file. Please note the default output directory in the compose script is apiro-output.

Config Example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
    <apiroConf xmlns="http://apiro.com/apiro/v1/root" version="1">
        <groups/>
        <loadOrder>10</loadOrder>
        <dataSinks>
            <dataSink definition="FILESYSTEM" name="MY_FILESYSTEM_DATASINK_NAME">
                <groupTags>
                    <groupTag>DEFAULT</groupTag>
                </groupTags>
                <metaData>
                    <item name="METADATA_KEY">
                        <simpleValues>
                            <simpleValue>METADATA_VALUE</simpleValue>
                        </simpleValues>
                    </item>
                </metaData>
                <description>My description</description>>
                <execPredicate>#GRV{ true }</execPredicate>
                <config>
                    <![CDATA[
                        {
                            "filePath":"/apiro-output/my_file_name.csv"
                        }

                    ]]>
                </config>
                <longLived>true</longLived>
            </dataSink>
        </dataSinks>
    </apiroConf>

Common Mistakes

  • Invalid Output Directory: It is possible to update the default output directory apiro-output to something different. The filePath needs to updated accordingly.