...
Setting | Description | |||
|---|---|---|---|---|
Bucket | The Bucket is the public cloud storage resource available in Amazon S3. | |||
Folder | Enther the path to the folder you want to collect data from and push data to when using the Amazon S3 functions in this field.
|
...
Place the function in your stream and double-click to open the Configuration dialog.
Configure the Common Configurations as described above.
All files in the subfolder(s) to the main folder stated in the Folder field will be collected. You can also choose to not include files from any subfolders by selecting the Do not include files from subfolders checkbox.In the After Collection section you can select to Remove files from Amazon server after collection.
In File information section you can specify the selection criteria for your files including how to Select files and the File format:
Setting | Description |
|---|---|
File selection | |
...
All files in folder | |
...
Select this option |
...
to collect all files in the specified folder. |
...
Based on filename |
...
Select this option to collect files based on specific file |
...
names. You can specify one or several file names. |
Based on regular expression |
...
Select this option to collect files based on file name patterns that you state using regular expressions. |
Based on list of files |
...
Select this option to collect files using a meta file containing the path to another file |
...
. If there is more than |
...
one meta |
...
file |
...
present, they will be processed |
...
simultaneously. |
...
...
You need to specify the following for the meta file: |
...
...
 |
Mandatory meta file formatting
There are also three mandatory prerequisites for this option: |
...
|
...
|
...
|
...
|
...
|
...
|
File format |
...
Depending on what option you select in the this drop-down, you will see different complimentary settings beneath the drop-down list. | |
CSV | Select this option to collect files in CSV format. |
...
Select the Include table header check box to include the table header in the collected file(s). |
...
Select the delimiter for the CSV file |
...
(s) in the Delimiter field. Comma is selected by default but you can also select Tab, Semicolon, Space, or Other. If |
...
you select Other you can |
...
specify a custom delimiter in |
...
the Custom delimiter field that will then be displayed. |
Excel |
...
Select this option to collect files in Excel format |
...
. Select the Include table header check box to include the table header in the collected file(s). Select the All sheets in file |
...
option to collect everything in the file, or the Specific Sheet(s) |
...
option to specify which sheets you want to collect in the Select sheet(s) field that will be displayed. |
JSON |
...
Select this option to collect files in |
...
XML format. |
XML |
...
Select this option to collect files in XML format |
You have now configured the Amazon S3 Collection function.
| Note | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
During collection, the following applies:
For all supported archive file types, the following applies:
There are exceptions to the filename patterns when it comes to collector functions.
|
| Anchor | ||||
|---|---|---|---|---|
|
...
In Amazon Credentials, specify the Access Key and the Secret Key. This information is available on your Amazon S3 account. You also have the option to use the Secrets Wallet option to enter the S3 account credentials.
In File Location, specify the Bucket and the path to the folder in Folder. The folder path cannot begin or end with a ' / '.
Note title Note! If the path to the folder is not specified, the root folder of the S3 bucket is selected by default.
In Output file Information, specify how you want to handle the output file(s) in Filename options. You can select from the following options:
Filename option Action Collector filename Select Collector filename if you want to keep the same filename as your input file(s).
If a collector does not have a filename, for example, Counter, the system generates a filename based on the function.
Custom filename Select Custom filename to define a new filename for all the output files. If you require more flexibility in defining file names refer to Configuring Dynamic Naming in Fields. Select Append timestamp to append the timestamp to the name of the output file. For example, the output filename for a CSV file will look like <
myfile>_<timestamp>.csv.Note title Note! If Append timestamp is not selected, the existing file at the destination can be overwritten by the output file.
In File format, select the format of the output file(s) from the following options:
File format Description CSV Select to send the output file in CSV format. Select Include table header to include the table header in the output file(s).
Specify a Delimiter for the CSV file format. The default value is ' , '.Compression can be toggled by enabling the Compress file option. A dropdown menu is used to select the format – Zip and GZIP are supported.
An additional option toggles the Bucket owner full control.
Excel Select to send the output file in Excel format. You can also specify the Sheet name. The default sheet name is Sheet 1.
Compression can be toggled by enabling the Compress file option. A dropdown menu is used to select the format – Zip and GZIP are supported.
An additional option toggles the Bucket owner full control.
Buffer Select to send the output file in the Buffer format.
If you are reading or processing files containing binary data (Buffer format), for example for performance or other reasons, you can write these files through the AWS S3 Forwarder.
Compression can be toggled by enabling the Compress file option. A dropdown menu is used to select the format – Zip and GZIP are supported.
An additional option toggles the Bucket owner full control.
JSON Select to send the output file in JSON format. Select the preferred output format, Action on records: one file with All in one array, one file with All in one array with key, or One file per record.
Note title Note! If One file per record is selected, you must also select Append timestamp, otherwise, the files will be overwritten.
Compression can be toggled by enabling the Compress file option. A dropdown menu is used to select the format – Zip and GZIP are supported.
An additional option toggles the Bucket owner full control.
JSON files can be formatted for easier reading by selecting the Output file in pretty print option.
To output JSON files in a more compact form, deselect the Output file in pretty print checkbox. By default, pretty print is on.
Note title Note! Selecting pretty print increases the size of the output file.
To compress the output file, select the Compress file checkbox and specify the Compression format. The supported formats are:
Zip
GZip
You have the option to provide the S3 bucket owners full access to the object that are written by other S3 account holders. Select the checkbox, Bucket owner full control, to give this permission. To be able to do this Usage Engine uses an option called as Access Control List (ACL) and is enabled as
ACL = bucket-owner-full-control.
...