(DOCSP-26646) Email sharing and scheduling (#592)

* (DOCSP-26646) Email sharing and scheduling
---------

Co-authored-by: davidhou17 <[email protected]>

Author: zach-carr

snooty.toml

@@ -57,5 +57,6 @@ json = ":abbr:`JSON (Javascript Object Notation)`"
 jwt = ":abbr:`JWT (JSON Web Token)`"
 cloud-svc = "Cloud"
 css = ":abbr:`CSS (Cascading Style Sheets)`"
+pdf = ":abbr:`PDF (Portable Document Format)`"
 png = ":abbr:`PNG (Portable Network Graphic)`"
 iot = ":abbr:`IoT (Internet of Things)`"

source/dashboards.txt

@@ -326,6 +326,7 @@ tasks:
 
    /manage-dashboards
    /dashboard-permissions
+   /scheduled-reports
    /dashboard-refresh
    /dashboard-filtering
    /interact-with-charts

source/scheduled-reports.txt

@@ -0,0 +1,188 @@
+:noprevnext:
+
+.. _scheduled-reports:
+
+==========================
+Schedule Dashboard Reports
+==========================
+
+.. default-domain:: mongodb
+
+.. contents:: On this page
+   :local:
+   :backlinks: none
+   :depth: 1
+   :class: singlecol
+
+Scheduled Reports
+-----------------
+
+You can create, edit, and delete scheduled reports for your dashboard. 
+A scheduled report automatically sends a snapshot of dashboard data to 
+a group of users at a regular frequency.
+
+To view your scheduled reports, click :guilabel:`Reports` in the 
+sidebar of the |charts-short| UI, under :guilabel:`Scheduling`.
+
+Required Permissions
+~~~~~~~~~~~~~~~~~~~~
+
+To create, edit, and delete scheduled reports for a dashboard, you must 
+have:
+
+- The :guilabel:`Owner` 
+  :ref:`dashboard permission <dashboard-permissions>` 
+  role for your |charts-short| dashboard.
+- Write access to your |service| project through an |service| 
+  :atlas:`user role </reference/user-roles/#project-roles>`.
+
+.. note:: 
+   
+   If you have the :authrole:`Project Owner` user role, you can view all of the 
+   scheduled reports in a project. To edit and delete reports for that dashboard, 
+   you must also have the :guilabel:`Owner` dashboard role.
+
+Limitations
+~~~~~~~~~~~
+
+- For free and shared tier clusters (``M0``, ``M2``, and ``M5``), you 
+  can create one scheduled report per project.
+
+- For paid-tier clusters (``M10+``), you can create up to 100 scheduled 
+  reports per project.
+
+- At this time, scheduled reports can only be sent by email.
+
+.. _create-scheduled-report:
+
+Create a Scheduled Report 
+-------------------------
+
+To create a new scheduled report:
+
+.. procedure::
+   :style: normal
+
+   .. step:: On the :guilabel:`Dashboards` page, select the dashboard for which you want to generate a report.
+  
+   .. step:: Click :guilabel:`Schedule` in the top right corner.
+
+      A :guilabel:`New Report` dialog box opens.
+
+   .. step:: Configure your dashboard report.
+
+      Provide the following information:
+
+      .. list-table::
+         :header-rows: 1
+         :stub-columns: 1
+         :widths: 20 80
+      
+         * - Field
+           - Description
+      
+         * - Name
+           - The name of your report to show on the :guilabel:`Reports` 
+             page. For email reports, this is also the subject line.
+
+         * - To
+           - The list of recipients to whom to send your report. You 
+             can specify any combination of the following:
+
+             - Individual project members
+             - All project members (by clicking :guilabel:`Add All` 
+               from the dropdown)
+             - Individual external email addresses
+
+             .. note::
+
+                You can specify a maximum of 10 external email 
+                addresses.
+
+         * - Message
+           - (*Optional*) A message to send with your report. For email 
+             reports, this is the email body.
+
+         * - Attachment
+           - The type of file to use for the dashboard report. You 
+             can select either |png| or |pdf|.
+
+             If you select PDF, you must also select an orientation for 
+             the report document.
+
+   .. step:: (*Optional*) Send a test email.
+      
+      To send a test email to yourself to view the output of a report 
+      before you send or schedule it, click :guilabel:`Send test email`.
+
+      |charts-short| sends a report to your email address immediately.
+
+   .. step:: Schedule or send your report.
+
+      You can create a schedule for a recurring report, or send a 
+      single report immediately. 
+
+      To schedule a recurring report:
+      
+      a. Toggle the switch to :guilabel:`Schedule`.
+
+      #. Specify a start date and time. The first report will be sent at this time.
+
+      #. Select a frequency from the :guilabel:`Frequency` dropdown. You can select:
+
+         - Once
+         - Daily
+         - Weekly
+         - Quarterly
+      
+      #. Select a timezone from the :guilabel:`Schedule` dropdown.
+
+      #. Click :guilabel:`Schedule`.
+
+      |charts-short| adds your new scheduled report to a list of 
+      reports for your project. To view this list and to edit your 
+      scheduled reports, see :ref:`edit-scheduled-report`.
+
+      To send a single report immediately:
+
+      a. Toggle the switch to :guilabel:`Send now`.
+
+      #. Click :guilabel:`Send now`.
+
+      |charts-short| sends your report immediately. The report isn't 
+      added to the list of scheduled reports for your project.
+
+.. _edit-scheduled-report:
+
+Edit a Scheduled Report 
+-----------------------
+
+To edit an existing scheduled report:
+
+.. procedure::
+   :style: normal
+
+   .. step:: Navigate to the :guilabel:`Reports` page, under :guilabel:`Scheduling` in the |charts-short| sidebar.
+
+   .. step:: For the report that you want to edit, click :guilabel:`Edit`.
+
+   .. step:: Reconfigure your scheduled report information.
+
+   .. step:: Click :guilabel:`Save`.
+
+Delete a Scheduled Report
+-------------------------
+
+You can only delete reports that you have created. To delete an 
+existing scheduled report:
+
+.. procedure::
+   :style: normal
+
+   .. step:: Navigate to the :guilabel:`Reports` page, under :guilabel:`Scheduling` in the |charts-short| sidebar.
+
+   .. step:: For the report that you want to delete, click :icon-fa4:`trash-o`.
+
+      A :guilabel:`Delete Report` dialog box opens.
+
+   .. step:: Click :guilabel:`Delete`.