Follow the instructions below to create a new email Reporting Task in CDP.
{note:title=Notice}Make sure you have configured SMTP Host and SMTP Default Return Address in the Server Options. See [Configuring Server Options].
{note}
1. Click on "Reporting" in the Main Menu to open the "Reports" screen.
|| Standard Edition || Advanced Edition || Enterprise Edition ||
| !reporting-menu-st.png! | !main-menu-reporting.png! | !main-ent.png! |
{info:title=Note} Email reporting and the "Reporting" page are not accessible for Standard Edition running on a free license. To register a paid license, see [Registering a Paid Standard Edition License].{info}
2. Then click "Create New Report" in the Reporting menu located in the top left area.
!create.png!
3. The "Create New Report" window opens.
!ReportCreate1.png!
Familiarize yourself with the introductory information and click "Next."
!ReportCreate2.png!
4. On the next page, define a name and subject for the report and choose whether or not to enable it. A report's name must be unique and the report will only run on its schedule if it is enabled.
!ReportCreate3.png!
Click "Next" to proceed to the following step.
!ReportCreate2.png!
5. On the next screen, select a report owner. You can choose them from the list:
!ReportCreate4.png!
Click "Next" to proceed to the following step.
!ReportCreate2.png!
6. On the next screen, define how frequently the report will be run. You can choose from the next options:
* *On-demand report* \- Run when you manually execute it.
* *Minutely report* \- Defines the period in minutes of report execution. The report will run every X minutes. X can be a value in minutes between 0 and 59.
* *Hourly report* \- Defines the starting minute of the report. Select the start time (minutes after the hour) the report should run.
* *Daily report* \- Defines the starting minute and day hours of report execution. Specify the start time in hours and minutes.
* *Weekly report* \- Defines the start time in hours and minutes and days of week of report execution. Specify the start time in hours and minutes and select one (1) or more week days for the report to run.
* *Monthly report* \- Defines the start time in hours and minutes and days of month of report execution. Specify the start time in hours and minutes and select which day of the month the report should run (1st to 31st).
* *Yearly report* \- Defines the start time in hours and minutes, days of month, and months of year of report execution. Specify the start time in hours and minutes, which day of the month the report should run (1st to 31st), and select one (1) or more months for the report to run.
!ReportCreate5.png!
Click "Next" to proceed to the following step.
!ReportCreate2.png!
7. On the next screen, define the recipients for the report. You can choose from users and groups on the CDP Server, or specify email addresses to deliver the report to.
!ReportCreate6.png!
Click "Next" to proceed to the following step.
!ReportCreate2.png!
8. On the next screen, select from several filters on which to include the tasks in the report.
* *Filtering by Agent* \- Selecting this option will include tasks for the specified agents.
* *Filtering by Task Type* \- Selecting this option will include tasks of the specified types.
* *Filtering by Task State* \- Selecting this option will include tasks of the specified states.
* *Filtering by Task Alert* \- Selecting this option will include either tasks with alerts, or tasks without alerts.
* *Filtering by Log Message Level* \- Selecting this option will include tasks that contain a log message with one of the specified levels.
!ReportCreate7.png!
Click "Next" to proceed to the following step.
!ReportCreate2.png!
8.1. Choose Agents
If you have selected the "Filter by Agent" option in Step 9, then the "Choose Agents" screen will appear. From the drop-down menu, select an Agent name and click "Add." Add as many Agents as you need. The Email Report will contain data about Tasks which concern the selected Agents. Tasks run against other Agents or not associated with an Agent will not be included.
!ReportCreate8.png!
Click "Next" to proceed to the following step.
!ReportCreate2.png!
8.2 Choose Task Types
If you have selected the "Filter by Task Type" option in Step 9, then the "Choose Task Types" screen will appear. From the drop-down menu, select a Task Type and click "Add." The following Task Types can be selected:
* *Bare Metal Restore*
* *Data Protection Policy*
* *Delete Archive Points*
* *E-mail Report*
* *Restore Files*
* *Merge Recovery Points*
* *Vacuum*
* *Database Restore*
* *Task History Clean-up*
The added Task Types will appear in the list. The Email Report will contain information only about the specified Task Types.
!ReportCreate9.png!
Click "Next" to proceed to the following step.
!ReportCreate2.png!
8.3 Choose Task States
If you have selected the "Filter by Task State" option in Step 9, then the "Choose Task States" screen will appear. Select the checkboxes in front of the Task States to include in the Email Report. The following States can be selected:
* *Queued*
* *Running*
* *Finished*
* *Error*
* *Cancelled*
* *Duplicate*
Only tasks that are in the specified states when the report is run will be included. Tasks that are in other states will not be included, and tasks in unfinished states may change state after the report is run.
!ReportCreate10.png!
Click "Next" to proceed to the following step.
!ReportCreate2.png!
8.4 Choose Task Alerts
If you have selected the "Filter by Task Alert" option in Step 9, then the "Choose Task Alerts" screen will appear. On this screen, choose whether to include tasks with alerts or tasks without alerts:
* *Only Include Tasks with Alerts -* If you choose to include tasks with alerts, only tasks that had an alert at the time the report was run will be included.
* *Only Include Tasks without Alerts -* If you choose to include tasks without alerts, only tasks that had no alerts at the time the report was run will be included. An unfinished task without alerts may encounter an alert after the report is run.
!ReportCreate11.png!
Click "Next" to proceed to the following step.
!ReportCreate2.png!
8.5 Choose Log Message Levels
If you have selected the "Filter by Log Message Level" option in Step 9, then the "Choose Log Message Levels" screen will appear. Select the checkboxes in front of the Log Message Levels to include in the Email Reporting. You can select the following:
* *Info*
* *Warn*
* *Error*
Only tasks that have at least one log message at any of the specified levels will be included. Tasks without any log messages at the specified levels will not be included. An unfinished task without any log messages at the specified levels may encounter additional messages after the report is run.
!ReportCreate12.png!
Click "Next" to proceed to the following step.
!ReportCreate2.png!
9. On the next screen, select the checkboxes in front of the options you want to activate:
* *Send Empty Reports* \- Send the report even if there is no new data since the last time it was run.
* *Include Full Alert Details* \- Include the full alert details, which will include the full-text of the alerts and their associated log messages.
* *Specify From Address* \- Specify a from address for the email instead of the CDP Server's default.
!ReportCreate13.png!
Click "Next" to proceed to the following step.
!ReportCreate2.png!
10. The next screen provides a short summary of the newly created report.
!a.png!
11. Click the "Save" button to add the Report to the system.
!ReportCreate15.png!
12. The Email Report has been created. Click "OK" in the notification pop-up.
!aaa.png!
13. You can go to the "Reporting" screen to observe the report details. See [Accessing Reporting].
!ReportCreate16.png! {excerpt:hidden=true}Instructions on how to create a new Report in the CDP Interface.{excerpt}
{note:title=Notice}Make sure you have configured SMTP Host and SMTP Default Return Address in the Server Options. See [Configuring Server Options].
{note}
1. Click on "Reporting" in the Main Menu to open the "Reports" screen.
|| Standard Edition || Advanced Edition || Enterprise Edition ||
| !reporting-menu-st.png! | !main-menu-reporting.png! | !main-ent.png! |
{info:title=Note} Email reporting and the "Reporting" page are not accessible for Standard Edition running on a free license. To register a paid license, see [Registering a Paid Standard Edition License].{info}
2. Then click "Create New Report" in the Reporting menu located in the top left area.
!create.png!
3. The "Create New Report" window opens.
!ReportCreate1.png!
Familiarize yourself with the introductory information and click "Next."
!ReportCreate2.png!
4. On the next page, define a name and subject for the report and choose whether or not to enable it. A report's name must be unique and the report will only run on its schedule if it is enabled.
!ReportCreate3.png!
Click "Next" to proceed to the following step.
!ReportCreate2.png!
5. On the next screen, select a report owner. You can choose them from the list:
!ReportCreate4.png!
Click "Next" to proceed to the following step.
!ReportCreate2.png!
6. On the next screen, define how frequently the report will be run. You can choose from the next options:
* *On-demand report* \- Run when you manually execute it.
* *Minutely report* \- Defines the period in minutes of report execution. The report will run every X minutes. X can be a value in minutes between 0 and 59.
* *Hourly report* \- Defines the starting minute of the report. Select the start time (minutes after the hour) the report should run.
* *Daily report* \- Defines the starting minute and day hours of report execution. Specify the start time in hours and minutes.
* *Weekly report* \- Defines the start time in hours and minutes and days of week of report execution. Specify the start time in hours and minutes and select one (1) or more week days for the report to run.
* *Monthly report* \- Defines the start time in hours and minutes and days of month of report execution. Specify the start time in hours and minutes and select which day of the month the report should run (1st to 31st).
* *Yearly report* \- Defines the start time in hours and minutes, days of month, and months of year of report execution. Specify the start time in hours and minutes, which day of the month the report should run (1st to 31st), and select one (1) or more months for the report to run.
!ReportCreate5.png!
Click "Next" to proceed to the following step.
!ReportCreate2.png!
7. On the next screen, define the recipients for the report. You can choose from users and groups on the CDP Server, or specify email addresses to deliver the report to.
!ReportCreate6.png!
Click "Next" to proceed to the following step.
!ReportCreate2.png!
8. On the next screen, select from several filters on which to include the tasks in the report.
* *Filtering by Agent* \- Selecting this option will include tasks for the specified agents.
* *Filtering by Task Type* \- Selecting this option will include tasks of the specified types.
* *Filtering by Task State* \- Selecting this option will include tasks of the specified states.
* *Filtering by Task Alert* \- Selecting this option will include either tasks with alerts, or tasks without alerts.
* *Filtering by Log Message Level* \- Selecting this option will include tasks that contain a log message with one of the specified levels.
!ReportCreate7.png!
Click "Next" to proceed to the following step.
!ReportCreate2.png!
8.1. Choose Agents
If you have selected the "Filter by Agent" option in Step 9, then the "Choose Agents" screen will appear. From the drop-down menu, select an Agent name and click "Add." Add as many Agents as you need. The Email Report will contain data about Tasks which concern the selected Agents. Tasks run against other Agents or not associated with an Agent will not be included.
!ReportCreate8.png!
Click "Next" to proceed to the following step.
!ReportCreate2.png!
8.2 Choose Task Types
If you have selected the "Filter by Task Type" option in Step 9, then the "Choose Task Types" screen will appear. From the drop-down menu, select a Task Type and click "Add." The following Task Types can be selected:
* *Bare Metal Restore*
* *Data Protection Policy*
* *Delete Archive Points*
* *E-mail Report*
* *Restore Files*
* *Merge Recovery Points*
* *Vacuum*
* *Database Restore*
* *Task History Clean-up*
The added Task Types will appear in the list. The Email Report will contain information only about the specified Task Types.
!ReportCreate9.png!
Click "Next" to proceed to the following step.
!ReportCreate2.png!
8.3 Choose Task States
If you have selected the "Filter by Task State" option in Step 9, then the "Choose Task States" screen will appear. Select the checkboxes in front of the Task States to include in the Email Report. The following States can be selected:
* *Queued*
* *Running*
* *Finished*
* *Error*
* *Cancelled*
* *Duplicate*
Only tasks that are in the specified states when the report is run will be included. Tasks that are in other states will not be included, and tasks in unfinished states may change state after the report is run.
!ReportCreate10.png!
Click "Next" to proceed to the following step.
!ReportCreate2.png!
8.4 Choose Task Alerts
If you have selected the "Filter by Task Alert" option in Step 9, then the "Choose Task Alerts" screen will appear. On this screen, choose whether to include tasks with alerts or tasks without alerts:
* *Only Include Tasks with Alerts -* If you choose to include tasks with alerts, only tasks that had an alert at the time the report was run will be included.
* *Only Include Tasks without Alerts -* If you choose to include tasks without alerts, only tasks that had no alerts at the time the report was run will be included. An unfinished task without alerts may encounter an alert after the report is run.
!ReportCreate11.png!
Click "Next" to proceed to the following step.
!ReportCreate2.png!
8.5 Choose Log Message Levels
If you have selected the "Filter by Log Message Level" option in Step 9, then the "Choose Log Message Levels" screen will appear. Select the checkboxes in front of the Log Message Levels to include in the Email Reporting. You can select the following:
* *Info*
* *Warn*
* *Error*
Only tasks that have at least one log message at any of the specified levels will be included. Tasks without any log messages at the specified levels will not be included. An unfinished task without any log messages at the specified levels may encounter additional messages after the report is run.
!ReportCreate12.png!
Click "Next" to proceed to the following step.
!ReportCreate2.png!
9. On the next screen, select the checkboxes in front of the options you want to activate:
* *Send Empty Reports* \- Send the report even if there is no new data since the last time it was run.
* *Include Full Alert Details* \- Include the full alert details, which will include the full-text of the alerts and their associated log messages.
* *Specify From Address* \- Specify a from address for the email instead of the CDP Server's default.
!ReportCreate13.png!
Click "Next" to proceed to the following step.
!ReportCreate2.png!
10. The next screen provides a short summary of the newly created report.
!a.png!
11. Click the "Save" button to add the Report to the system.
!ReportCreate15.png!
12. The Email Report has been created. Click "OK" in the notification pop-up.
!aaa.png!
13. You can go to the "Reporting" screen to observe the report details. See [Accessing Reporting].
!ReportCreate16.png! {excerpt:hidden=true}Instructions on how to create a new Report in the CDP Interface.{excerpt}