TABLE OF CONTENTS
- Introduction
- Location
- Report types
- Add a Report
- Configuring a Guest Data report
- Export a Sessions Report
- Export a Graphical Report
- Export a Bandwidth Report
- Export a Previous Report
- Delete a Report
Introduction
Reports allow you to gather and export guest and network data. Data can be exported via email or downloaded from the platform upon completion. Reports can be configured to run daily, weekly or monthly with previous reports also being available to download instantly.
The reports that you create are only accessible by the person who created them. You can add multiple email addresses to receive the same report if it needs to be generated on a regular basis.
Location
Step | Description |
1 | Log into the platform. |
2 | Click the Reports menu item from the left-hand menu to access Report configuration. |
Report Types
Report | Description |
Guest Data | Create a report based on guest data gathered at the portal page. |
Sessions | Create a report based on guest sessions. |
Graphical reports | Create a PDF report including graphs of your data. |
Bandwidth | Create a report based on the amount of bandwidth used. |
Add a Report
Adding a report will add the report to the report list. The report list will only show those reports that you have created. You might wish to check with your colleagues if they have already created the same report and if it has a recurrence other than one-off, you could ask them if you could be included in the email list of who has access to it.
Configuring a Guest Data Report
Although you have added the report to the report list, further configuration is required to define the frequency of the report, who should receive it and in what format as well as the data you wish to have.
Once you have saved the report, this will schedule the report to output. The scheduling is approximately 10 minutes from the point you last saved the report.
Step | Description |
1 | Click Add Report to open the report configuration screen. |
2 | Give your report an easily identifiable name by typing it into the Name field. |
3 | Use the Type selection dropdown and select Guest Data. Once selected, Search Parameter field will appear. |
4 | Select the Search Parameter. The search parameter defines what the report will gather data. There are two options, On creation date and On activity. By selecting On creation date you will only report on the first time an account commits an action. By selecting On activity the report will report on all actions after and including the first time an account commits an action. If you don’t want repeat data, choose On creation date. |
5 | Use the Recurrence selection dropdown to select how often you’d like the report to be run. Reports can be run as a one-off, daily, weekly, or monthly. |
6 | Click save. |
7 | You will be returned to the Reports page. Click on your newly created report that should have appeared in the reports table. |
8 | Click the Configuration tab. |
9 | Click General to open the general settings section. |
10 | If you’d like to send your reports by email, click the send as email dropdown and select your preferred format. |
11 | Click save. |
12 | Click on the Condition section. |
13 | Select Add Condition. This will display a pop up window to allow you to define if you want to limit the output by a particular criteria. You can select criteria based on Service tiers, guest data, tags or marketing. See the Export Condition table below for further explanation of the types of conditions. If you want all data in your domain, ignore steps 13 and 14. |
14 | Click save. |
15 | Click Returning Data to open the return data configuration. |
16 | Select the data you want output in the report by clicking the tick boxes associated with the dataset. Please make sure you select data to be shown in the report that is relevant to the data being collected during the authentication process. Otherwise, the report will not show selected data that has not been initially requested. |
Export Conditions
Export Condition | Description |
Service tier | Add a data entry when a user authenticates using your selected service tier |
Guest data | Run the report when a user fills in a particular data field on the portal. E.g. Email address |
Tag | Run the report based on a particular site tag. |
Marketing | Run the report based on previously configured marketing criteria. (Not usually used). |
Export a Sessions Report
Step | Description |
1 | Click Add Report to open the report configuration screen. |
2 | Give your report an easily identifiable name by typing it into the Name field. |
3 | Use the Type selection dropdown and select Sessions. |
4 | Use the Recurrence selection dropdown to select how often you’d like the report to be run. Reports can be run as a one-off, daily, weekly, or monthly. |
5 | Click Save. |
6 | You will be returned to the Reports page. Click on your newly created report that should have appeared in the reports table. |
7 | Click the Configuration tab. |
8 | Click General to open the general settings section. |
9 | If you’d like to send your reports by email, click the send as email dropdown and select your preferred format. |
10 | Click save. |
11 | Click on the Condition section. |
12 | Select Add Condition. This will display a pop up window to allow you to define if you want to limit the output by a particular criteria. You can select criteria based on Service Tiers or Tags. See the Export Condition table below for further explanation of the types of conditions. If you want all data in your domain, ignore steps 12 and 13. |
13 | Click Save. |
14 | Click Returning Data to open the return data configuration. |
15 | Select the data you want output in the report by clicking the tick boxes associated with the dataset. Please make sure you select data to be shown in the report that is relevant to the data being collected during the authentication process. Otherwise, the report will not show selected data that has not been initially requested. |
Export Conditions
Export Condition | Description |
Service Tiers | Run the report based on a service tier. |
Tags | Run the report based on a particular site tag. |
Export a Graphical Report
Step | Description |
1 | Click Add Report to open the report configuration screen. |
2 | Give your report an easily identifiable name by typing it into the Name field. |
3 | Use the Type selection dropdown and select Graphical Reports. |
4 | Use the Recurrence selection dropdown to select how often you’d like the report to be run. Reports can be run as a one-off, daily, weekly, or monthly. |
5 | Click save. |
6 | You will be returned to the Reports page. Click on your newly created report that should have appeared in the reports table. |
7 | Click the Configuration tab. |
8 | Click General to open the general settings section. |
9 | If you’d like to send your reports by email, click the send as email dropdown and select your preferred format. (Only PDF is available for Graphical Reports). |
10 | Click save. |
11 | Click on the Condition section. |
12 | Select Add Condition. This will display a pop up window to allow you to define if you want to limit the output by a particular criteria. For Graphical reports, only site is available. See the Export Condition table below for further explanation of the types of conditions. If you want all data in your domain, ignore steps 11 and 12. |
13 | Click Save. |
14 | Click Returning Data to open the return data configuration. |
15 | Select the data you want output in the report by clicking the tick boxes associated with the dataset. Please make sure you select data to be shown in the report that is relevant to the data being collected during the authentication process. Otherwise, the report will not show selected data that has not been initially requested. |
Export Conditions
Export Conditions | Description |
Sites | Select the site you want to report on. |
Export a Bandwidth Report
Step | Description |
1 | Click Add Report to open the report configuration screen. |
2 | Give your report an easily identifiable name by typing it into the Name field. |
3 | Use the Type selection dropdown and select Bandwidth Report. A Group by field should appear. |
4 | Use the Group by selection dropdown to select whether you want to report on the bandwidth of a particular service tier or an entire site. |
5 | Use the Recurrence selection dropdown to select how often you’d like the report to be run. Reports can be run as a one-off, daily, weekly, or monthly. |
6 | Click save. |
7 | You will be returned to the Reports page. Click on your newly created report that should have appeared in the reports table. |
8 | Click the Configuration tab. |
9 | Click General to open the general settings section. |
10 | If you’d like to send your reports by email, click the send as email dropdown and select your preferred format. |
11 | Click save. |
12 | Click on the Condition section. |
13 | Select Add Condition. This will display a pop up window to allow you to define if you want to limit the output by a particular criteria. For bandwidth reports, only tag is available. See the Export Condition table below for further explanation of the types of conditions. If you want all data in your domain, ignore steps 12 and 13. |
14 | Group tiers allows you to group together service tiers for easier data analysis. To group tiers, ensure each entry that you want group are named the same. In the report, grouped tiers will appear under the name you've set for them. Leave empty if you want to report on all tiers, as they are. |
15 | Click Save. |
16 | Click Returning Data to open the return data configuration. |
17 | Select the data you want output in the report by clicking the tick boxes associated with the dataset. Please make sure you select data to be shown in the report that is relevant to the data being collected during the authentication process. Otherwise, the report will not show selected data that has not been initially requested. |
Export Conditions
Export Condition | Description |
Tags | Run the report based on a particular site tag. |
Export a Previous Report
The reports that you have previously generated will be retained until you decide to delete them. This means that you can go back to previously generated reports to then export the data that generated historically.
Step | Description |
1 | Select the report you’d like to export. |
2 | Scroll down the page to the report configuration. Click on the Reports tab. |
3 | If the report has been configured to run daily, weekly or monthly, the report tab will display each time the report is generated. Click on the date of the report. A pop up window will be displayed. |
4 | Select the format you’d like to export your report in and specify If you’d like headers included. |
5 | Click Download. This will save the file to your Download folder on your computer. |
Delete a Report
Should you no longer need the report, you can delete the report and this will remove the report from the report list.
Steps | Description |
1 | Select the report you’d like to delete. |
2 | Scroll down the page to the report configuration. Ensure you have the Reports tab selected. |
3 | Click General. |
4 | Click Delete. |
Was this article helpful?
That’s Great!
Thank you for your feedback
Sorry! We couldn't be helpful
Thank you for your feedback
Feedback sent
We appreciate your effort and will try to fix the article