File IoT Consumer Definition#
The File Sinker IoT Consumer Definition is provided by the system to allow the user to extract data from the IoT Data Platform into a CSV or a JSON file.
When creating or editing an IoT Consumer with the File Sinker IoT Consumer Definition, the user can provide some parameters in the configuration step:
- Metadata Connection String - For the database which contains the IoT Event Definition metadata.
- File Name Format
- A Consumer accessible folder (e.g.: network folder) and then a dynamic file name with the following tokens:
{YYYY} {MM} {DD} {HH} {mm} {SS}
- It also supports the use of tokens from the message system or application properties, as well as the data, using the syntax $PathToProperty
- e.g.
\\my-ftp\MyFolder\{YYYY}{HH}\$Data.MyProperty\MyFile.json
- e.g.
- A Consumer accessible folder (e.g.: network folder) and then a dynamic file name with the following tokens:
- File Content - JSON or CSV.
- Data Only - If set to true, the envelope header (system and application properties) is excluded, leaving only the data payload. This property is not applicable if the File Content is CSV, since it only considers data.
- Starting Offsets
- Earliest - processes every event stored
- Latest - processes events that arrive after the consumer starts
- Start Date
- Alternative to Starting Offsets, taking precedence over it
- Ingests events that were not previously consumed by this consumer and have an Event Timestamp later than this date.