Table of Contents |
---|
Overview
Plugin Configuration
General
Within the General tab:
The following settings can be configured:
Setting | Description |
---|
Storage Account Name | The |
Secret key
account in which to store the file. | |
SAS Token | The Token used to authenticate the requests |
Bucket
The S3 buckets that the data should be stored in
Bucket Region
Container Name | The name of the container to place the file into |
File prefix | The prefix of the filename output |
File prefix (Field/Param) | Allows you to add a File prefix via a Field or Parameter |
Include Date/Time | Allows the selection of various Date / Time values to add to the Filename* |
StepNr | Adds the start step in case more than one step could start the KTR file. This provides another element of uniqueness. |
Node Name | Adds the Node Name (IP) to the File name. This provides another element of uniqueness if files are being output quickly from different nodes. |
Folder (optional) | The sub-folder within the |
where the data should be output | |
Extension | The extension of the file that should be output e.g. csv, txt |
Buffer Size | During rule development it is useful to have a fast buffer retention period so that data written out by rules appears frequently |
. However when the rule is in production a short buffer period can cause a large number of files to accumulate. This Buffer Size setting allows you to adjust the Buffer and the frequency the data is passed to |
Azure. | |
Time Period (Mins) | Allows a time period to be set to control when the data is written |
Write only if | Choose to write only if the data is valid or not. See data validity. |
Content
Within the Content tab:
The following settings can be configured:
Setting | Description |
---|---|
Separator |
Thelimiter that is used to separate the values within the file.
| ||
Enclosure | The data qualifier enclosing the data
| |
Header | If “Header” is selected the first row of data within the output file created will contain the field names output. |
Fields
The Fields tab is required to be populated with the fields that are required to be output to the file:
Example
The following table illustrates an example of how data will be exported to S3 with certain setting applied:
Content
Fields
Example Data Output
Code Block |
---|
Field1,Field2,Field3
1,"A","A"
2,"B","B"
3,"C","C" |
Understanding how files are formatted
The rule files will be formatted as you specify in the step configuration, however the file names will be different when executed within . Example:
Description
File name
File prefix
MyFile_clientname_s3output_3_172.31.11.190_20180202_114856_0_6.txt
DDE Client name
MyFile_clientname_s3output_3_172.31.11.190_20180202_114856_0_6.txt
Rule name
MyFile_clientname_s3output_3_172.31.11.190_20180202_114856_0_6.txt
Rule version
MyFile_clientname_s3output_3_172.31.11.190_20180202_114856_0_6.txt
Node Name (internal) IP address
MyFile_clientname_s3output_3_172.31.11.190_20180202_114856_0_6.txt
Inlcude Date / Time stamp
MyFile_clientname_s3output_3_172.31.11.190_20180202_114856_0_6.txt
File count (Split every X rows)