Report Node

Report node helps you automatically send reports through email. It generates reports in the form of PDFs or CSVs. The Report node executes a secure link to download a report and sends it to your email ID.

To add a Report node, click on the ‘+’ and select Report. It is typically added at the end of the workflow, when you need a report generated and sent to you. Or in the case of a reporting use case, for example, generate a report of EC2 instances with CPU utilization less than 90%. If you need reports at a specific stage in the middle of a workflow, the node can also be added in between. Click on the node and select ‘edit’ to open the parameters options for the nodes.

‘Select a resource to notify’- You can choose from the dropdown the output of a particular node that you wish to be reported. For example if you’ve used a ‘filter node’ and filtered out a certain resource based on some condition, and you want to generate a report of the resulting resources, you’ll select the output of the ‘Filter Node’ in this dropdown.

As mentioned before, every resource, resource addon, and every other node has a unique ID that can be referenced in any other node. You can find the ID’s shown at the top of every node, below the ‘Node Name’. Wherever you’re required to reference the resource, you’ll see a dropdown with all the options listed below, and you can simply choose the relevant one.

Select a notification application’ - You can select the option of either ‘None’, ‘Slack’ or ‘Email’. If you select ‘None’, the report will be accessible only in your TotalCloud account, it won't be delivered anywhere. If you select ‘Email’, you have to enter the Email ID, and an Optional Message. If you select ‘Slack’, you will have to select the ‘Slack config’. This requires you to previously configure your Slack account with your TotalCloud account. You can configure multiple Slack accounts, and choose the relevant one in this available dropdown. See how to configure a Slack account, here.

‘Only send report if data is available’ - you can enable this if you only want report when data is available.

We enable you to customize your report, as well. ‘Report Type’ allows you to select one of two types of reports - ‘Passthrough Report’ and ‘Input Transformer’.

For example, if you need to generate a report encompassing a graph, of the count of volumes in each AZ - To create this graph, you need to set AZ as X-axis and volumes as Y-axis. Note that this is possible if your workflow’s Resource node fetches EC2 Volumes.

Passthrough: This sends the report encompassing all the data it receives. Example: Create a list of all EC2 instances belonging to Test Env.

Input transformer: This sends the report in a tabular format with data from only the selected columns/keys. Example: Create a table, listing VolumeID, Volume type, and Snapshot IDs of EC2 volumes belonging to the N. Virginia region.

You get a list of attributes or keys from which you select the relevant columns or points of information you need in a report.

Upon successful execution of this node, an email is sent to the registered email ID with a secure link to download the report.

Here's how a sample email looks like:

Following is an example of a report, when you click on the secure link.

Here’s a usage example of the Report Node.