Contents x
    Configure an Email Report
        Contents

        Configure an Email Report

            Article summary

            Configuring an Email Report

            You can use email reports to send device updates to your user groups. You will need to configure them in the Rayven Workspace.

            Create a report

            To create an email report:

            1. Select ‘Reports’ from the left panel of the Rayven Workspace.
            2. Click 'Create a report'.
            3. Enter a report name: this will appear as the email subject line.


            Configuring report settings

            You can customize the addresser of the email report and add a report description. Pick an addresser and description that provide clear context.


            The default email address extension is @rayven.io, however, you can change this to your business extension should you wish. See 'Addresser Email' at the end of this page for details.


            You will need to pick a choice for ‘Report scheduling’. You have two options:

            1. Manually select the date and time to send the first report. You can then choose how often to send recurring reports.
            2. Automatically generate a report based on a particular trigger.

            To automatically configure your reports, workflows must contain an email output node. Refer to email nodes for configuration instructions. Once an email output node exists in your workflow, you can select it from the report scheduling dropdown menu. When data reaches this node, it will then trigger a report.


            Select the amount of historical data the report should contain using the Report Time Frame. For example, for a report sent on Friday 30th July, the following definitions for historical data apply:

            • ‘Last 1 day’ produces a report with yesterday’s data.
            • ‘Last 1 day (include today's data)’ produces a report with today’s data.
            • ‘Last 2 days’ produces a report with the data for yesterday and the day before yesterday.
            • ‘Last 2 days (include today's data)’ produces a report containing the data for today and yesterday.
            • ‘Last 7 days’ would produce a report with the data from 24th to 30th July.
            • ‘Last 2 weeks (week starting on Monday)’ would produce a report containing data for the last two complete weeks. In our example, this would be Monday 12th to Sunday 25th July.
            • ‘Last 2 weeks (week starting on Sunday)’ would produce a report containing data for the last two complete weeks. In our example, this would be Sunday 11th to Saturday 24th July.
            • ‘Last 1 month’ would produce a report containing data for the most recently completed month. In our example, this would be from 1st to 30th June.



            Under ‘Recipients’, choose who should receive the report by first selecting the applicable User Group. In the example below, the selected user group is 'Admin Team'. 


            Select the report attachment. Choose an API Output node from the dropdown menu and choose whether the file format should be CSV or TXT. You can also enter a name for the attachment - we recommend this for clarity.


            Finally, choose how the report appears by configuring the Report Content. Select a format:

            • ‘Add to Email Body’ ensures any text and widgets appear in the body of the email report.
            • ‘Attach as PDF’ ensures any widgets appear as an additional PDF attachment. If using this option, you must enter a name for the PDF file. You can also enter text for the email body.


            Note that the report widgets will be identical to those in your 'Historical and Reporting' dashboard. The amount of data the widgets display will depend on your Report's Time Frame settings. Widgets will appear from top to bottom in the email body, in the order you select them.


            Click ‘Save’ to finish configuring your email report.


            Customizing the addresser email

            To customize the domain of the addresser email:

            1. Click the menu button on the top-right of the Rayven Workspace Manager.
            2. Select ‘White Labeling’.
            3. Edit the addresser email domain. Changes will be applied to all solutions in the account. 
            4. If you want to customize the domain for a specific solution, click on ‘Solution White Labeling’ at the top of the screen and repeat the above steps.

            After updating the domain of the addresser email, you will need to update your DNS records to ensure the reports are successfully received to your inbox. Please add a TXT record with the following details. Replace 'rayven.io' with the email address extension that you have configured.

            Name: rayven.io

            Content: v=spf1 ip4:52.169.16.32 ip4:52.155.236.224 ip4:52.178.136.42 ip4:23.102.50.47 include:_spf.google.com ~all

            Please seeDefine your SPF record—Basic setup - Google Workspace Admin Help  for more information.

            What's Next