Setting Up Data Delivery
The Data delivery option in the report configuration allows you to set up locations where your data should be delivered once it is prepared. You can configure multiple locations for data delivery.
Supported delivery destinations
Grepsr supports following data delivery options:
- Email
- Dropbox
- Box
- Webhook
- Slack
- Amazon S3
- Google Cloud
- Azure Cloud
- Digital Ocean
- FTP
Supported file formats
Grepsr supports multiple file formats, including:
- XLSX
- CSV (default format)
- XML
- JSON
- YAML
- PARQUET
File compression option
A compression option is available for large files to enable faster transfer. Files larger than 50 MB are automatically compressed, even if this option is left unchecked. Similarly, if the output contains multiple CSV files, they are also automatically compressed.
Setting up individual delivery options
Available settings for Email
| Fields | Description |
|---|---|
| Email where the files will be delivered |
To send data via email from the platform, follow the steps below:
-
Step 1: Access the Data Delivery Section - Begin by logging into the platform. From the main menu, click on the “Data Delivery” button.
-
Step 2: Choose Email as the Destination - In the list of available delivery destinations, select Email.
-
Step 3: Enter the Recipient’s Email Address - Provide the email address where the data should be sent.
-
Step 4: Save the Configuration - After entering the email address, click “Save” to complete the setup. - You also have the option to “Save and apply to all reports” if you'd like this email to be used across multiple deliveries.
The email destination is now set and data will be delivered directly to the specified email address.
Additional configurations
- Apply to All Reports in This Project: Applies the storage location to all existing reports in the project. New reports added later will not include this setting.
Available settings for Dropbox
| Fields | Description |
|---|---|
| credential | Dropbox credentials |
Dropbox is a versatile tool for securely storing and easily sharing files. Follow these steps to link your Dropbox account with the platform:
-
Step 1: Open the Platform - Begin by opening the platform and clicking on the "Data Delivery" button to get started.
-
Step 2: Select Dropbox as Your Delivery Destination - From the available options, choose "Dropbox" as your preferred delivery destination.
-
Step 3: Add Dropbox - In the top right corner of the platform, click on "Add Dropbox" to link your account.
-
Step 4: Dropbox Will Be Linked - Once clicked, Dropbox will automatically be linked to your platform account.
-
Step 5: Choose Upload Path - You will now have the option to "Upload to a custom path". This allows you to select a specific location for your files within Dropbox.
-
Step 6: Replace Old Files (Optional) - If necessary, you can also choose to "Replace old files". After making your selection, save your settings according to your preference.
Additional configurations
- Upload to Custom Path: Allows specifying a sub-folder in the container where the data should be stored.
- Replace Old Files: Overwrites an existing file with the same name.
- Apply to All Reports in this Project: Applies the storage location to all existing reports in the project. New reports added later will not include this setting.
Available settings for Box
| Fields | Description |
|---|---|
| credential | Box credentials |
Box is a cloud-based file storage and collaboration platform that allows users to securely store, manage, and share files. Follow these steps to configure Box as your data delivery destination:
-
Step 1: Access Data Delivery - Open the platform and navigate to the "Data Delivery" section.
-
Step 2: Select Box - Choose "Box" as your preferred delivery destination.
-
Step 3: Add Box - Click on "Add Box" in the top-right corner of the platform.
-
Step 4: Grant Access - A prompt will appear asking you to grant access to Box. Click to authorize the connection.
-
Step 5: Link Box to Your Account - Once access is granted, Box will be successfully linked to your account.
-
Step 6: Set a Custom Upload Path - You will have the option to specify a custom path for file storage within Box.
-
Step 7: Enable File Replacement (Optional) - If needed, select the "Replace old files" option to automatically update existing files.
-
Step 8: Save Your Settings - Review your preferences and save the configuration.
Once set up, your files will be automatically delivered to Box according to your chosen settings.
Additional configurations
- Upload to Custom Path: Allows specifying a sub-folder in the container where the data should be stored.
- Replace Old File: Overwrites an existing file with the same name.
- Apply to All Reports in this Project: Applies the storage location to all existing reports in the project. New reports added later will not include this setting.
Available settings for wehbook
| Fields | Description |
|---|---|
| webhool url | webhook url where files needs to be delivered |
Webhook Payload
'HTTP Method' : 'POST'
'Content-Type' : 'application/x-www-form-urlencoded'
Form Fields
| FIELD NAME | TYPE | DESCRIPTION |
|---|---|---|
| csv_url | string | URL of the CSV file (if applicable). |
| json_url | string | URL of the JSON file (if applicable). |
| json2_url | string | URL of the JSON2 file (if applicable). |
| parquet_url | string | URL of the Parquet file (if applicable). |
| xlsx_url | string | URL of the XLSX file (if applicable) |
| xml_url | string | URL of the XML file (if applicable). |
| yaml_url | string | URL of the YAML file (if applicable). |
| project_id | number | ID of the project. |
| project_name | string | Name of the project. |
| report_id | number | ID of the report. |
| report_name | string | Name of the report. |
| history_id | number | ID of the run history. |
| total_records | number | Total number of records processed. |
| run_started | timestamp | Timestamp when the run started. |
| run_ended | timestamp | Timestamp when the run ended. |
| next_update | timestamp | Timestamp for the next scheduled update. |
| run_duration | number | Duration of the run in seconds. |
Note
- Only one file URL field (csv_url, json_url, etc.) will be present in the payload, depending on the file type generated during the run.
Example Payload
POST /your-webhook-endpoint HTTP/1.1
Host: yourdomain.com
Content-Type: application/x-www-form-urlencoded
csv_url=https://example.com/files/data.csv&project_id=12345&project_name=Sample%20Project&report_id=67890&report_name=Monthly%20Report&history_id=54321&total_records=1000&run_started=2023-10-01T10%3A00%3A00Z&run_ended=2023-10-01T10%3A05%3A00Z&next_update=2023-10-02T10%3A00%3A00Z&run_duration=300
Additional configurations
- Skip validation on save: Skips validating the permissions on API keys and tokens. This allows you to set up the delivery destination first and configure permissions later. However, without proper permissions, the file cannot be delivered.
- Apply to All Reports in this Project: Applies the storage location to all existing reports in the project. New reports added later will not include this setting.
Available settings for Slack
| Fields | Description |
|---|---|
| Slack url | Slack url where files needs to be delivered |
A Slack channel is a dedicated space within a Slack workspace where team members can communicate and share files. Follow these steps to link your Slack channel with the platform:
-
Step 1: Access Data Delivery - Open the platform and navigate to the "Data Delivery" section.
-
Step 2: Select Slack - Choose "Slack" as your delivery destination.
-
Step 3: Enter the Webhook URL - In the designated field, enter your Slack Webhook URL, which is located in the top-right section of the platform.
-
Step 4: Optional: Skip Validation on Save - If required, you can enable the "Skip validation on save" option.
-
Step 5: Save the Configuration - Click "Save" to confirm and apply the settings.
-
Step 6: Delivery Destination Saved - Slack is now set as a delivery destination on the platform.
-
Step 7: Verify in Slack - Once configured, messages will be sent to the Slack channel whenever data is delivered.
With this setup, your platform will automatically send notifications to Slack, ensuring seamless updates.
Additional configurations
- Skip validation on save: Skips validating the permissions on API keys and tokens. This allows you to set up the delivery destination first and configure permissions later. However, without proper permissions, the file cannot be delivered.
- Apply to All Reports in this Project: Applies the storage location to all existing reports in the project. New reports added later will not include this setting.
Available settings for Amazon S3
| Fields | Description |
|---|---|
| S3 Access Key ID | Unique ID for authenticating API requests to Amazon S3. |
| S3 Secret Key | Private key used to securely sign API requests. |
| Bucket name | Storage container in Amazon S3 where the files get delivered. |
Additional configurations
- Upload to Custom Path: Allows specifying a sub-folder in the container where the data should be stored.
- Replace Old File: Overwrites an existing file with the same name.
- Skip validation on save: Skips validating the permissions on API keys and tokens. This allows you to set up the delivery destination first and configure permissions later. However, without proper permissions, the file cannot be delivered.
- Apply to All Reports in this Project: Applies the storage location to all existing reports in the project. New reports added later will not include this setting.
- Deliver Manifest file:
- Delivery content file :
- Assume cross account role :
Available settings for Google Cloud
| Fields | Description |
|---|---|
| Google Cloud Service Account Key | This is the domain or IP address of the FTP server. It specifies the server where your files will be uploaded or downloaded from |
| Bucket name | The corresponding username for the FTP account |
Additional configurations
- Upload to Custom Path: Allows specifying a sub-folder in the container where the data should be stored.
- Replace Old File: Overwrites an existing file with the same name.
- Skip validation on save: Skips validating the permissions on API keys and tokens. This allows you to set up the delivery destination first and configure permissions later. However, without proper permissions, the file cannot be delivered.
- Apply to All Reports in this Project: Applies the storage location to all existing reports in the project. New reports added later will not include this setting.
Available settings for Azure Cloud
| Fields | Description |
|---|---|
| Azure Cloud Connection String | This is the domain or IP address of the FTP server. It specifies the server where your files will be uploaded or downloaded from |
| Container name | The corresponding username for the FTP account |
SAS (Shared Access Signature) URL Support for Azure
Seamlessly and securely access Azure cloud resources with SAS URL support. This feature ensures that your data is protected while maintaining ease of use, providing temporary, permission-based access without exposing full credentials.
Key Benefits
| Benefits | Description |
|---|---|
| Grant Temporary Access and Share Files Securely | Generate time-limited URLs to share files securely without compromising sensitive credentials. |
| Control Permissions | Set granular access controls to determine who can view, edit or manage files, ensuring proper security measures. |
| Simplify Integrations | Easily integrate with Azure workflows by leveraging SAS URLs, reducing complexity while boosting security. |
Additional configurations
- Upload to Custom Path: Allows specifying a sub-folder in the container where the data should be stored.
- Replace Old File: Overwrites an existing file with the same name.
- Skip validation on save: Skips validating the permissions on API keys and tokens. This allows you to set up the delivery destination first and configure permissions later. However, without proper permissions, the file cannot be delivered.
- Apply to All Reports in this Project: Applies the storage location to all existing reports in the project. New reports added later will not include this setting.
Available settings for Digital Ocean
| Fields | Description |
|---|---|
| Access Key Id | Unique identifier for API authentication. |
| Secret key | Private key for securely signing API requests. |
| Bucket name | Storage container in DigitalOcean Spaces. |
| Region | Location of your DigitalOcean resources. |
Additional configurations
- Upload to Custom Path: Allows specifying a sub-folder in the container where the data should be stored.
- Replace Old File: Overwrites an existing file with the same name.
- Skip validation on save: Skips validating the permissions on API keys and tokens. This allows you to set up the delivery destination first and configure permissions later. However, without proper permissions, the file cannot be delivered.
- Apply to All Reports in this Project: Applies the storage location to all existing reports in the project. New reports added later will not include this setting.
Available settings for FTP
| Fields | Description |
|---|---|
| Hostname | This is the domain or IP address of the FTP server. It specifies the server where your files will be uploaded or downloaded from |
| Username | The corresponding username for the FTP account |
| Password | The corresponding password for the FTP account |
| Port | The port number used to connect to the FTP server. |
| Custom path | File path if files to be stored in specific directory |
SFTP for Secure File Transfers
Securely transfer files with SFTP (Secure File Transfer Protocol), an enhanced option alongside FTP, ensuring smooth, encrypted data transfers every time. This upgrade guarantees safer file handling, making your workflows more reliable.
Key Benefits
| Benefits | Description |
|---|---|
| Enhanced Security | SFTP adds an extra layer of security to FTP by leveraging SSH (Secure Shell) protocol and encrypted SSH keys to protect your data. |
| Encrypted Transfers | Ensure end-to-end encryption, safeguarding sensitive information throughout the transfer. |
| Password-Free Access | Replace passwords with SSH keys, reducing vulnerabilities and streamlining authentication. Three types of SSH keys ECDSA, ED25519 and RSA — work for secure access. |
| Reliable & Stable | Enjoy consistent performance and robust connection stability. |
Additional configurations
- Upload to Custom Path: Allows specifying a sub-folder in the container where the data should be stored.
- Replace Old File: Overwrites an existing file with the same name.
- Skip validation on save: Skips validating the permissions on API keys and tokens. This allows you to set up the delivery destination first and configure permissions later. However, without proper permissions, the file cannot be delivered.
- Apply to All Reports in this Project: Applies the storage location to all existing reports in the project. New reports added later will not include this setting.
What is the default file format supported in platform?
CSV is the default file format supported in platform.