Skip to content

What is a Data Sink?

When distributing Apiro data, a data sink is used to determine the address and method of distribution for egress data. Data Sinks tell Apiro where and how data should be distributed.

Data Sink config?

Global Data Source entity (defined in its own config file and can be referenced by multiple feeds)

The provided XML configuration defines a data sink named "ESG_OPERATIONS_EMAIL_INLINE". This data sink is used for distribution of ESG (Environmental, Social, and Governance) scores. The configuration is structured to specify the details of the email to be sent, including the recipient's email address and the subject line.

Here's a breakdown of the key components and their purposes:

dataSinks: Contains the definition of one or more data sinks, which determine the address and method of distribution for egress data. dataSink name="ESG_OPERATIONS_EMAIL_INLINE" definition="EMAIL_INLINE": Defines a specific data sink named "ESG_OPERATIONS_EMAIL_INLINE" with a type or definition "EMAIL_INLINE". This data sink is designed to handle email operations, specifically for sending emails. see data sinks for a comprehensive list of data sink definitions. config: Contains the configuration details for the data sink, enclosed within a CDATA section to ensure that the JSON-like structure is treated as plain text. This configuration includes: "to": Specifies the recipient's email address. "cc": An array for carbon copy recipients, currently empty. "bcc": An array for blind carbon copy recipients, also currently empty. "subject": The subject line of the email, set to "ESG SCORES AUTO DISTRIBUTION".

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<apiroConf version="1" xmlns="http://apiro.com/apiro/v1/root">
    <loadOrder>25</loadOrder>
    <dataSinks>
        <dataSink name="ESG_OPERATIONS_EMAIL_INLINE" definition="EMAIL_INLINE">
            <config>
                <![CDATA[
                    {
                        "to":["esg.operations.3030@gmail.com"],
                        "cc":[],
                        "bcc":[],
                        "subject":"ESG SCORES AUTO DISTRIBUTION"
                    }
            ]]>
            </config>
        </dataSink>
    </dataSinks>
</apiroConf>
  • Inline/Local (defined in a feed config and can only exist with the feed. It cannot be referenced by other Feeds)

Data Sink Definitions

Existing Data Sink Definitions:



Provide an exmaple of a full REST data source with all options as an xml



Provide an example of the UI showing a REST data source which is an inline entity