diff --git a/site/sigmaguides/src/administration_export_bursting/_shared_assets/1.png b/site/sigmaguides/src/administration_export_bursting/_shared_assets/1.png new file mode 100644 index 00000000..726cde47 Binary files /dev/null and b/site/sigmaguides/src/administration_export_bursting/_shared_assets/1.png differ diff --git a/site/sigmaguides/src/administration_export_bursting/_shared_assets/10.png b/site/sigmaguides/src/administration_export_bursting/_shared_assets/10.png new file mode 100644 index 00000000..a88d5d8b Binary files /dev/null and b/site/sigmaguides/src/administration_export_bursting/_shared_assets/10.png differ diff --git a/site/sigmaguides/src/administration_export_bursting/_shared_assets/2.png b/site/sigmaguides/src/administration_export_bursting/_shared_assets/2.png new file mode 100644 index 00000000..7087109c Binary files /dev/null and b/site/sigmaguides/src/administration_export_bursting/_shared_assets/2.png differ diff --git a/site/sigmaguides/src/administration_export_bursting/_shared_assets/3.png b/site/sigmaguides/src/administration_export_bursting/_shared_assets/3.png new file mode 100644 index 00000000..aae562bf Binary files /dev/null and b/site/sigmaguides/src/administration_export_bursting/_shared_assets/3.png differ diff --git a/site/sigmaguides/src/administration_export_bursting/_shared_assets/4.png b/site/sigmaguides/src/administration_export_bursting/_shared_assets/4.png new file mode 100644 index 00000000..85d1e24d Binary files /dev/null and b/site/sigmaguides/src/administration_export_bursting/_shared_assets/4.png differ diff --git a/site/sigmaguides/src/administration_export_bursting/_shared_assets/5.png b/site/sigmaguides/src/administration_export_bursting/_shared_assets/5.png new file mode 100644 index 00000000..ce0d7728 Binary files /dev/null and b/site/sigmaguides/src/administration_export_bursting/_shared_assets/5.png differ diff --git a/site/sigmaguides/src/administration_export_bursting/_shared_assets/6.png b/site/sigmaguides/src/administration_export_bursting/_shared_assets/6.png new file mode 100644 index 00000000..b7b3cd01 Binary files /dev/null and b/site/sigmaguides/src/administration_export_bursting/_shared_assets/6.png differ diff --git a/site/sigmaguides/src/administration_export_bursting/_shared_assets/7.png b/site/sigmaguides/src/administration_export_bursting/_shared_assets/7.png new file mode 100644 index 00000000..b053ded8 Binary files /dev/null and b/site/sigmaguides/src/administration_export_bursting/_shared_assets/7.png differ diff --git a/site/sigmaguides/src/administration_export_bursting/_shared_assets/8.png b/site/sigmaguides/src/administration_export_bursting/_shared_assets/8.png new file mode 100644 index 00000000..3cf0e617 Binary files /dev/null and b/site/sigmaguides/src/administration_export_bursting/_shared_assets/8.png differ diff --git a/site/sigmaguides/src/administration_export_bursting/_shared_assets/9.png b/site/sigmaguides/src/administration_export_bursting/_shared_assets/9.png new file mode 100644 index 00000000..3aff50c3 Binary files /dev/null and b/site/sigmaguides/src/administration_export_bursting/_shared_assets/9.png differ diff --git a/site/sigmaguides/src/administration_export_bursting/_shared_assets/Sigma_Footer.png b/site/sigmaguides/src/administration_export_bursting/_shared_assets/Sigma_Footer.png new file mode 100644 index 00000000..df51d771 Binary files /dev/null and b/site/sigmaguides/src/administration_export_bursting/_shared_assets/Sigma_Footer.png differ diff --git a/site/sigmaguides/src/administration_export_bursting/_shared_assets/crane.png b/site/sigmaguides/src/administration_export_bursting/_shared_assets/crane.png new file mode 100644 index 00000000..18822acb Binary files /dev/null and b/site/sigmaguides/src/administration_export_bursting/_shared_assets/crane.png differ diff --git a/site/sigmaguides/src/administration_export_bursting/_shared_assets/sigma-crane.png b/site/sigmaguides/src/administration_export_bursting/_shared_assets/sigma-crane.png new file mode 100644 index 00000000..a2bf082f Binary files /dev/null and b/site/sigmaguides/src/administration_export_bursting/_shared_assets/sigma-crane.png differ diff --git a/site/sigmaguides/src/administration_export_bursting/administration_export_bursting.md b/site/sigmaguides/src/administration_export_bursting/administration_export_bursting.md new file mode 100644 index 00000000..9494f143 --- /dev/null +++ b/site/sigmaguides/src/administration_export_bursting/administration_export_bursting.md @@ -0,0 +1,335 @@ +author: pballai +id: administration_export_bursting +summary: administration_export_bursting +categories: Administration +environments: web +status: Hidden +feedback link: https://github.com/sigmacomputing/sigmaquickstarts/issues +tags: +lastUpdated: 2024-11-19 + +# Export Bursting + +## Overview +Duration: 5 + +Export bursting ("bursting") is a powerful feature that enables automated distribution of personalized or filtered report content to a dynamic list of recipients as scheduled email bursts. + +With this feature, users no longer need to create or customize reports for different audiences manually. Instead, reports are generated automatically and securely sent to the appropriate stakeholders, streamlining data delivery across teams. + +This process **bursts** a single report into customized segments for each user, allowing tailored content—such as an entire workbook, specific workbook pages, or individual elements to be sent as attachments. + +When coupled with [export conditions](https://help.sigmacomputing.com/docs/schedule-a-conditional-export-or-alert), customers are able to create alert functionality that unlocks a variety of valuable use cases. + +Export bursting helps organizations deliver specific insights to targeted audiences, ensuring that recipients see only the most relevant data for their role or needs. + +### Benefits and Use Cases + +Bursting is particularly valuable in scenarios where information needs to be disseminated quickly and efficiently, tailored for various departments or users without requiring manual intervention. + +For instance, finance departments may distribute monthly reports segmented by region to regional managers, or sales teams could receive weekly performance metrics filtered by each sales representative’s territory. + +This process can reduce report preparation time, increase information relevance, and promote data-driven decision-making across teams. + +### Considerations for Using Export Bursting + +While export bursting is highly effective, certain scenarios may benefit from alternative methods. + +For example, reports containing sensitive information that require enhanced security may be better suited to more secure delivery channels, especially where regulatory compliance restricts data sharing via email. + +Additionally, for frequent or high-volume email distributions, ensuring recipients receive only the most relevant information at a manageable pace can help maintain engagement. In such cases, using secure portals or leveraging Sigma’s role-based access may offer a more tailored solution. + +### Target Audience + +Anyone responsible for regularly distributing tailored reports to specific groups within an organization. Users who manage reporting workflows, especially those needing to deliver customized content to diverse stakeholders efficiently, will find export bursting a valuable tool for automating and streamlining report delivery. + + + +### Prerequisites + + + + + + + +![Footer](assets/sigma_footer.png) + +## Requirements and Limitations +Duration: 5 + +### Requirements + + + +### Limitations + + +### 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.** + + + +For more information see [Restricting export recipients.](https://help.sigmacomputing.com/docs/restrict-export-recipients#restrict-domains) + +![Footer](assets/sigma_footer.png) + + +## About Scheduling in Sigma +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: + + +### Considerations: + + +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. + +Duration: 5 + +![Footer](assets/sigma_footer.png) + + +## Enable Bursting for an Account Type +Duration: 5 + +With the background out of the way, we can proceed to demonstrate (on a very small scale) bursting in Sigma. + +Log into Sigma as an administrator and navigate to `Administration` > `Account Types`. + +While we might consider creating a new account type that mimics an existing one but includes bursting, we’ll simply enable it for an existing type to keep things straightforward. + +For more information on account types see [License and account type overview.](https://help.sigmacomputing.com/docs/license-and-account-type-overview) + +Lets enable our `Pro` users to use bursting. + + + +Click to select the `Pro` account type and then click the `Edit` button: + + + +Scroll down to the `Sharing / Folders` section and check on the box for `Export as email burst`: + + + +Click `Save` at the top right corner of the page. + +The permission is added to the `Pro` list: + + + + +![Footer](assets/sigma_footer.png) + + +## Create Something to Burst +Duration: 5 + +Lets create a workbook to use for our bursting test. + +Click the icon to return to the homepage and then click `Templates` > `Plugs Electronics Profit Planning Tool`: + +`Dismiss` the `Use your data` popup and click `Save as`. + +Name the workbook `Plugs Profit Planning Tool` and click `Save`. + +![Footer](assets/sigma_footer.png) + + +## Key Bursting Properties +Duration: 5 + +Lets take a quick look at the important properties of bursting before we go to far. + +Open the workbook menu and select `Schedule exports`: + + + +Click `Add schedule`. + +In the `Schedule exports` modal we see many options. + +To use bursting, we need to first click the icon shown as number 1, in the `Export as email burst` row. + +### Split by +Lets focus on item `2`, `Split by` for a moment. + + + +`Split by` allows us to restrict the data emailed to each user based on a page control value. + + + +### Dynamic recipients +Dynamic recipients each receive an email with data filtered based on the `Split by` control value setting, sent to the corresponding email address. + +### Standard recipients +Email addresses specified here receive all attachments, and no segmentation of data based on the `Split by` control value. + +The remainder of the export properties are the same. + +For more information, see [Export to email](https://help.sigmacomputing.com/docs/export-to-email) + +![Footer](assets/sigma_footer.png) + + +## Sample Use Case +Duration: 5 + +Let’s assume we have two users: one who manages the `East region` and another who manages the `West`. + +The `Plugs Profit Planning Tool` workbook includes a control labeled `Region`, which allows the workbook to be filtered by the selected region's data. + +We will leverage this control to generate and distribute customized reports tailored to each stakeholder's specific data view and permissions. + +To achieve this, we need a way to associate recipient email addresses with their respective regions. However, Sigma’s sample data does not include email addresses, which is often the case with existing datasets. For this demonstration, we will adjust our approach to handle the absence of email addresses. If email addresses were already present in the source data, we could have simply used them directly + +![Footer](assets/sigma_footer.png) + + +## Email Lookup Table2 +Duration: 5 + +Your organization may already have a table that can be used but in our case, we will use a Sigma [Input table](https://help.sigmacomputing.com/docs/intro-to-input-tables) to quickly add the required region-to-email assignments. + +With the workbook in edit mode, select the `Data` page and add a `Empty` input table: + + + +Select the `Sigma Sample Database` as the source and click `Create`. + +Configure the input table as shown, replacing the email addresses with your own valid test addresses. + + + +In order to associate the email address in our new input table, we will add a [Lookup]() from the `T Transaction Details - Base` table on the `Data` page to our new input table. + +Select the `T Transaction Details - Base` table and in the element panel, click the `+` > `Add column via` and `Lookup...`: + + + +Configure as shown: + + + +We can see the new column added, with the rows for `Store Region` aligning to the `Email Address` (showing west as example): + + + +Perform the same steps on the `T Transaction Details - KPIs` table on the `Data` page so that both tables have the email address reference column. This ensures that all the elements on the `Profit Planning Tool` page have access to these two email addresses. + +![Footer](assets/sigma_footer.png) + + +## Create a bursting schedule +Duration: 5 + +We are ready to schedule a bursting schedual to our two email addresses. + +Open the workbooks menu and click `Schedule exports...`: + + + +Configure the export job for bursting, `Split by` `F_Region` and set the `Dynamic recipients` to our new email column that was added via lookup earlier. We can leave all other default settings. + +Click `Create`: + + + +The schedule is created and the list of schedule jobs is shown. For my example, there is only one. + +Open the actions menu and select `Send now` to test the job. + + + + + +The result is two emails sent, one to the `east` address and one to the `west`: + + + +The attached PDFs show only the expected data, with the `Region` control showing the filter that has been applied to the data prior to sending. + + + +Very nice! + +![Footer](assets/sigma_footer.png) + + +## Conditional Exports (Alerts) +Duration: 5 + +If all we wanted to do was email reports based on a dynamic filter, our work would be complete. + +However, a less obvious but highly effective approach is to send workbook content when your data indicates that something important has happened. This ensures employees are promptly made aware of critical events and can take immediate action, rather than discovering the issue later, which might not be ideal. + +Sigma supports this via [Conditional Alerts.](https://help.sigmacomputing.com/docs/schedule-a-conditional-export-or-alert) + +We could edit the scheduled export directly from the workbook, but lets do it in a different workflow. + +Reopen the `Scheduled exports` modal, open the menu and click `Edit`: + + + +Enable `Conditions` and configure as shown: + + + +Click `Test condition`. This will evaluate if there is `Data that meets condition exists.`. + +Once satisfied, we can `Save` and the `Send now`, as we have previously done. + +Now the same reports will be delivered whenever the condition is met. + + + +![Footer](assets/sigma_footer.png) + + + + +## What we've covered + +Duration: 5 + +In this QuickStart, we explored how to use export bursting through a simple use case. We also discussed its features, benefits, and limitations as they stand at the time of this QuickStart. + +Please refer to [https://help.sigmacomputing.com/docs/export-as-email-burst.](https://help.sigmacomputing.com/docs/export-as-email-burst) + +**Additional Resource Links** + +[Blog](https://www.sigmacomputing.com/blog/)
+[Community](https://community.sigmacomputing.com/)
+[Help Center](https://help.sigmacomputing.com/hc/en-us)
+[QuickStarts](https://quickstarts.sigmacomputing.com/)
+ +Be sure to check out all the latest developments at [Sigma's First Friday Feature page!](https://quickstarts.sigmacomputing.com/firstfridayfeatures/) +
+ +[](https://twitter.com/sigmacomputing)  +[](https://www.linkedin.com/company/sigmacomputing)  +[](https://www.facebook.com/sigmacomputing) + +![Footer](assets/sigma_footer.png) + + + diff --git a/site/sigmaguides/src/administration_export_bursting/assets/bursting1.png b/site/sigmaguides/src/administration_export_bursting/assets/bursting1.png new file mode 100644 index 00000000..223971e4 Binary files /dev/null and b/site/sigmaguides/src/administration_export_bursting/assets/bursting1.png differ diff --git a/site/sigmaguides/src/administration_export_bursting/assets/bursting10.png b/site/sigmaguides/src/administration_export_bursting/assets/bursting10.png new file mode 100644 index 00000000..7f0c6b46 Binary files /dev/null and b/site/sigmaguides/src/administration_export_bursting/assets/bursting10.png differ diff --git a/site/sigmaguides/src/administration_export_bursting/assets/bursting11.png b/site/sigmaguides/src/administration_export_bursting/assets/bursting11.png new file mode 100644 index 00000000..b662281c Binary files /dev/null and b/site/sigmaguides/src/administration_export_bursting/assets/bursting11.png differ diff --git a/site/sigmaguides/src/administration_export_bursting/assets/bursting12.png b/site/sigmaguides/src/administration_export_bursting/assets/bursting12.png new file mode 100644 index 00000000..d26b4b39 Binary files /dev/null and b/site/sigmaguides/src/administration_export_bursting/assets/bursting12.png differ diff --git a/site/sigmaguides/src/administration_export_bursting/assets/bursting13.png b/site/sigmaguides/src/administration_export_bursting/assets/bursting13.png new file mode 100644 index 00000000..f246592f Binary files /dev/null and b/site/sigmaguides/src/administration_export_bursting/assets/bursting13.png differ diff --git a/site/sigmaguides/src/administration_export_bursting/assets/bursting14.png b/site/sigmaguides/src/administration_export_bursting/assets/bursting14.png new file mode 100644 index 00000000..293c024e Binary files /dev/null and b/site/sigmaguides/src/administration_export_bursting/assets/bursting14.png differ diff --git a/site/sigmaguides/src/administration_export_bursting/assets/bursting15.png b/site/sigmaguides/src/administration_export_bursting/assets/bursting15.png new file mode 100644 index 00000000..f19ffd4a Binary files /dev/null and b/site/sigmaguides/src/administration_export_bursting/assets/bursting15.png differ diff --git a/site/sigmaguides/src/administration_export_bursting/assets/bursting16.png b/site/sigmaguides/src/administration_export_bursting/assets/bursting16.png new file mode 100644 index 00000000..bea6d910 Binary files /dev/null and b/site/sigmaguides/src/administration_export_bursting/assets/bursting16.png differ diff --git a/site/sigmaguides/src/administration_export_bursting/assets/bursting17.png b/site/sigmaguides/src/administration_export_bursting/assets/bursting17.png new file mode 100644 index 00000000..6a28dfbc Binary files /dev/null and b/site/sigmaguides/src/administration_export_bursting/assets/bursting17.png differ diff --git a/site/sigmaguides/src/administration_export_bursting/assets/bursting18.png b/site/sigmaguides/src/administration_export_bursting/assets/bursting18.png new file mode 100644 index 00000000..813bb952 Binary files /dev/null and b/site/sigmaguides/src/administration_export_bursting/assets/bursting18.png differ diff --git a/site/sigmaguides/src/administration_export_bursting/assets/bursting2.png b/site/sigmaguides/src/administration_export_bursting/assets/bursting2.png new file mode 100644 index 00000000..66ccdfcd Binary files /dev/null and b/site/sigmaguides/src/administration_export_bursting/assets/bursting2.png differ diff --git a/site/sigmaguides/src/administration_export_bursting/assets/bursting3.png b/site/sigmaguides/src/administration_export_bursting/assets/bursting3.png new file mode 100644 index 00000000..23a046ab Binary files /dev/null and b/site/sigmaguides/src/administration_export_bursting/assets/bursting3.png differ diff --git a/site/sigmaguides/src/administration_export_bursting/assets/bursting4.png b/site/sigmaguides/src/administration_export_bursting/assets/bursting4.png new file mode 100644 index 00000000..b7aa4ed0 Binary files /dev/null and b/site/sigmaguides/src/administration_export_bursting/assets/bursting4.png differ diff --git a/site/sigmaguides/src/administration_export_bursting/assets/bursting5.png b/site/sigmaguides/src/administration_export_bursting/assets/bursting5.png new file mode 100644 index 00000000..ff012b98 Binary files /dev/null and b/site/sigmaguides/src/administration_export_bursting/assets/bursting5.png differ diff --git a/site/sigmaguides/src/administration_export_bursting/assets/bursting6.png b/site/sigmaguides/src/administration_export_bursting/assets/bursting6.png new file mode 100644 index 00000000..c002e209 Binary files /dev/null and b/site/sigmaguides/src/administration_export_bursting/assets/bursting6.png differ diff --git a/site/sigmaguides/src/administration_export_bursting/assets/bursting7.png b/site/sigmaguides/src/administration_export_bursting/assets/bursting7.png new file mode 100644 index 00000000..3f1364eb Binary files /dev/null and b/site/sigmaguides/src/administration_export_bursting/assets/bursting7.png differ diff --git a/site/sigmaguides/src/administration_export_bursting/assets/bursting8.png b/site/sigmaguides/src/administration_export_bursting/assets/bursting8.png new file mode 100644 index 00000000..1750557d Binary files /dev/null and b/site/sigmaguides/src/administration_export_bursting/assets/bursting8.png differ diff --git a/site/sigmaguides/src/administration_export_bursting/assets/bursting9.png b/site/sigmaguides/src/administration_export_bursting/assets/bursting9.png new file mode 100644 index 00000000..9e8b27a5 Binary files /dev/null and b/site/sigmaguides/src/administration_export_bursting/assets/bursting9.png differ diff --git a/site/sigmaguides/src/administration_export_bursting/assets/facebook.png b/site/sigmaguides/src/administration_export_bursting/assets/facebook.png new file mode 100644 index 00000000..fa3f0e02 Binary files /dev/null and b/site/sigmaguides/src/administration_export_bursting/assets/facebook.png differ diff --git a/site/sigmaguides/src/administration_export_bursting/assets/greencheckbox.png b/site/sigmaguides/src/administration_export_bursting/assets/greencheckbox.png new file mode 100644 index 00000000..69cb876e Binary files /dev/null and b/site/sigmaguides/src/administration_export_bursting/assets/greencheckbox.png differ diff --git a/site/sigmaguides/src/administration_export_bursting/assets/horizonalline.png b/site/sigmaguides/src/administration_export_bursting/assets/horizonalline.png new file mode 100644 index 00000000..7c49d872 Binary files /dev/null and b/site/sigmaguides/src/administration_export_bursting/assets/horizonalline.png differ diff --git a/site/sigmaguides/src/administration_export_bursting/assets/linkedin.png b/site/sigmaguides/src/administration_export_bursting/assets/linkedin.png new file mode 100644 index 00000000..d1a0636d Binary files /dev/null and b/site/sigmaguides/src/administration_export_bursting/assets/linkedin.png differ diff --git a/site/sigmaguides/src/administration_export_bursting/assets/sigma_footer.png b/site/sigmaguides/src/administration_export_bursting/assets/sigma_footer.png new file mode 100644 index 00000000..df51d771 Binary files /dev/null and b/site/sigmaguides/src/administration_export_bursting/assets/sigma_footer.png differ diff --git a/site/sigmaguides/src/administration_export_bursting/assets/twitter.png b/site/sigmaguides/src/administration_export_bursting/assets/twitter.png new file mode 100644 index 00000000..5a827d72 Binary files /dev/null and b/site/sigmaguides/src/administration_export_bursting/assets/twitter.png differ