Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Export bursting rev2 #307

Merged
merged 1 commit into from
Nov 18, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@ id: administration_export_bursting
summary: administration_export_bursting
categories: Administration
environments: web
status: Hidden
status: Published
feedback link: https://github.com/sigmacomputing/sigmaquickstarts/issues
tags:
lastUpdated: 2024-11-19
tags: default
lastUpdated: 2024-11-18

# Export Bursting

Expand Down Expand Up @@ -71,13 +71,13 @@ Duration: 5
<ul> <li><strong>Account Permissions:</strong> You must have an account type with the <em>Export as email burst</em> permission enabled.</li> <li><strong>Access Level:</strong> You need <em>Can Edit</em> or <em>Can Explore</em> access to the specific workbook being exported.</li> <li><strong>IP Allowlist or SMTP Configuration:</strong> If your organization restricts outbound email from certain IP addresses, add <code>198.37.153.185</code> to the allowlist. Alternatively, configure a custom SMTP server. (See <a href="https://help.sigmacomputing.com/docs/customize-welcome-and-invite-emails#custom-smtp-server">Custom SMTP server</a> for setup details.)</li> </ul>

### Limitations
<ul> <li><strong>Splitting Control:</strong> The control used to split recipients must be a list control with values sourced from a column. You can split by a maximum of 500 values.</li> <li><strong>Dynamic Recipients:</strong> Dynamic recipient emails must also come from a column in the same data source as the list control. The key column can be added to a source via join or lookup. You can send to a maximum of 500 dynamic recipients.</li> <li><strong>File Type:</strong> Only PDF files can be sent as attachments.</li> <li><strong>Size Limit:</strong> The total attachment size per email burst is limited to 30MB. If this limit is exceeded, the entire export fails, and the owner of the scheduled export receives a notification. Repeatedly oversized exports are automatically paused, and the owner is notified. (Refer to <a href="LINK_TO_DOWNLOAD_LIMITATIONS">Download, export, and upload limitations</a> for more details.)</li> </ul>
<ul> <li><strong>Splitting Control:</strong> The control used to split recipients must be a list control with values sourced from a column. You can split by a maximum of 500 values.</li> <li><strong>Dynamic Recipients:</strong> Dynamic recipient emails must also come from a column in the same data source as the list control. The key column can be added to a source via join or lookup. You can send to a maximum of 500 dynamic recipients.</li> <li><strong>File Type:</strong> PDF, PNG, Excel, JSON and CSV files can be sent as attachments.</li> <li><strong>Size Limit:</strong> The total attachment size per email burst is limited to 30MB. If the total size of multiple attachments is more than 30 MB an attempt is made to split these attachments in several emails where possible. If this limit is exceeded, the entire export fails, and the owner of the scheduled export receives a notification. Repeatedly oversized exports are automatically paused, and the owner is notified. (Refer to <a href="LINK_TO_DOWNLOAD_LIMITATIONS">Download, export, and upload limitations</a> for more details.)</li><li><strong>Run queries as recipient:</strong> The “Run as recipient” feature is not currently supported for bursting.</li> </ul>

### Restricting export recipients
Sigma Admins can control which domains can receive emails, Google Sheets, and Google Drive exports from Sigma. **If no domains specified as authorized, users can export reports to any email address.**

<aside class="negative">
<strong>NOTE:</strong><br> During scheduled exports or direct downloads in PDF or PNG formats, Sigma may store control values as URL parameters in trace logs for debugging. Exercise caution when exporting workbook content with filters for sensitive data. Restrict who has access to Sigma log data as best practice.
<strong>NOTE:</strong><br> During scheduled exports or direct downloads, Sigma may store control values as URL parameters in trace logs for debugging. Exercise caution when exporting workbook content with filters for sensitive data. Restrict who has access to Sigma log data as best practice.
</aside>

For more information see [Restricting export recipients.](https://help.sigmacomputing.com/docs/restrict-export-recipients#restrict-domains)
Expand All @@ -89,10 +89,10 @@ For more information see [Restricting export recipients.](https://help.sigmacomp
Sigma offers robust support for scheduled email delivery, enabling users to automate the distribution of workbooks, pages, or individual elements to designated recipients. This functionality ensures that stakeholders receive timely, relevant information without manual intervention.

### Key Features:
<ul> <li><strong>Flexible Scheduling:</strong> Users can set up exports to run on daily, weekly, monthly, or custom schedules using cron syntax, accommodating various reporting needs. <a href="https://help.sigmacomputing.com/docs/export-to-email">Export to Email</a></li> <li><strong>Conditional Exports:</strong> Sigma allows the configuration of conditions that determine when an export is sent. For instance, reports can be scheduled to send only if specific data thresholds are met, ensuring recipients receive pertinent updates. <a href="https://help.sigmacomputing.com/docs/schedule-a-conditional-export-or-alert">Schedule a Conditional Export or Alert</a></li> <li><strong>Personalized Content:</strong> By utilizing the "Run queries as recipient" option, exports can be tailored to each recipient's data access permissions, delivering customized insights. <a href="https://help.sigmacomputing.com/docs/export-to-email">Export to Email</a></li> <li><strong>Multiple Formats:</strong> Exports can be sent in various formats, including PDF, Excel, CSV, and PNG, catering to different preferences and requirements. <a href="https://help.sigmacomputing.com/docs/export-to-email">Export to Email</a></li> <li><strong>Comprehensive Management:</strong> Users can view and manage their scheduled exports directly from their profile, with options to pause, edit, or delete schedules as needed. Administrators have the ability to oversee all scheduled exports across the organization, ensuring efficient management. <a href="https://help.sigmacomputing.com/docs/manage-scheduled-exports">Manage Scheduled Exports</a></li> </ul>
<ul> <li><strong>Flexible Scheduling:</strong> Users can set up exports to run on daily, weekly, monthly, or custom schedules using cron syntax, accommodating various reporting needs. <a href="https://help.sigmacomputing.com/docs/export-to-email">Export to Email</a></li> <li><strong>Conditional Exports:</strong> Sigma allows the configuration of conditions that determine when an export is sent. For instance, reports can be scheduled to send only if specific data thresholds are met, ensuring recipients receive pertinent updates. <a href="https://help.sigmacomputing.com/docs/schedule-a-conditional-export-or-alert">Schedule a Conditional Export or Alert</a></li> <li><strong>Personalized Content:</strong> By utilizing the "Run queries as recipient" option, exports can be tailored to each recipient's data access permissions, delivering customized insights. <a href="https://help.sigmacomputing.com/docs/export-to-email">Export to Email</a></li> <li><strong>Multiple Formats:</strong> Exports can be sent in various formats, including PDF, Excel, CSV, JSON and PNG, catering to different preferences and requirements. <a href="https://help.sigmacomputing.com/docs/export-to-email">Export to Email</a></li> <li><strong>Comprehensive Management:</strong> Users can view and manage their scheduled exports directly from their profile, with options to pause, edit, or delete schedules as needed. Administrators have the ability to oversee all scheduled exports across the organization, ensuring efficient management. <a href="https://help.sigmacomputing.com/docs/manage-scheduled-exports">Manage Scheduled Exports</a></li> </ul>

### Considerations:
<ul> <li><strong>Permissions:</strong> To schedule email exports, users must have the appropriate permissions assigned to their account type, such as the "Export to email" and "Schedule export" permissions. <a href="https://help.sigmacomputing.com/docs/export-to-email">Export to Email</a></li> <li><strong>Export Limits:</strong> The total attachment size for emailed exports is limited to 30MB. Exceeding this limit will cause the export to fail, and the owner will be notified. Repeated failures may result in the export being paused automatically. <a href="https://help.sigmacomputing.com/docs/export-to-email">Export to Email</a></li> </ul>
<ul> <li><strong>Permissions:</strong> To schedule email exports, users must have the appropriate permissions assigned to their account type, such as the "Export to email" and "Schedule export" permissions. <a href="https://help.sigmacomputing.com/docs/export-to-email">Export to Email</a></li> <li><strong>Export Limits:</strong> The total attachment size per email burst is limited to 30MB. If the total size of multiple attachments is more than 30 MB an attempt is made to split these attachments in several emails where possible. If this limit is exceeded, the entire export fails, and the owner of the scheduled export receives a notification. Repeatedly oversized exports are automatically paused, and the owner is notified. (Refer to <a href="LINK_TO_DOWNLOAD_LIMITATIONS">Download, export, and upload limitations</a> for more details.)</a></li> </ul>

By leveraging these features, Sigma users can automate the dissemination of critical information, ensuring that stakeholders receive accurate and timely data tailored to their needs.

Expand Down