Adding some Reports Documentation
This is not all of it, but just two sub-tabs to go.
No files matched your search
@@ -0,0 +1,94 @@
|
||||
# Reports Administration
|
||||
|
||||
This section will describe **Reports Administration** in Cacti.
|
||||
|
||||
The **Reports Administration** tab allows Cacti Administrators to administer all
|
||||
**Reports** in Cacti. The Administrator can change the ownership of or take
|
||||
ownership away from any user on the system, and can edit all **Reports**. The
|
||||
primary difference between the **Reports Administration** and the **Reports User**
|
||||
interfaces breaks down to simply what can be done and seen by the user.
|
||||
|
||||
## The Web Interface
|
||||
|
||||
The administration of any **Report** begins on the main Reports tab in Cacti.
|
||||
A screen shot of the Reports tab is shown below.
|
||||
|
||||

|
||||
|
||||
When viewing any **Reports** from this interface, you will see the following
|
||||
columns:
|
||||
|
||||
- **Report Name** - The name of the Report.
|
||||
- **Owner** - The Cacti account that has ownership of the Report.
|
||||
- **Frequency** - How often the Report is to be sent to the distribution.
|
||||
- **Last Run** - The last time that the Report was sent to the distribution.
|
||||
- **Next Run** - The approximate next time that the report is to be sent.
|
||||
this is not an exact number. It does depend on the poller first running. So,
|
||||
depending on how long your poller runs for, this time could be off by a
|
||||
few minutes.
|
||||
- **From** - The From Name portion of the From Email address
|
||||
- **To** - The list of Emails that the reports is to be sent to.
|
||||
- **Type** - The Image format and the type of embedding done in the Email.
|
||||
- **Enabled** - Is the Report able to be sent on the Schedule.
|
||||
|
||||
The actions that you can take on an existing Report as an Administrator include:
|
||||
|
||||
- **Send Now** - Force send one or more **Reports** now
|
||||
- **Duplicate** - Duplicate one or more **Reports**
|
||||
- **Enable** - Enable one or more **Reports**
|
||||
- **Disable** - Disable one or more **Reports**
|
||||
- **Delete** - Delete one or more **Reports**
|
||||
- **Take Ownership** - Take over ownership of one or more **Reports**
|
||||
|
||||
## Report Editing
|
||||
|
||||
When you click the Add button on the right side of the **Reports** page, or Click on the Report Name of an existing Report, you will be presented with the interface below.
|
||||
|
||||

|
||||
|
||||
This section includes:
|
||||
|
||||
- **Report Name** - The Name of the **Report**
|
||||
- **Enable Report** - Is the **Report** Enabled
|
||||
- **Use Custom Format HTML** - This is an indication that you wish to use a custom html/css
|
||||
document that you can use to customize the layout of your reports and add
|
||||
corporate branding for example.
|
||||
- **Format File to Use** - The specific html/css file to use.
|
||||
- **Graphs Linked** - Provide the recipient of the report a ling back to the actual
|
||||
graph in Cacti.
|
||||
- **Graph Columns** - The number of Graph columns to use per row.
|
||||
- **Graph Width** - The width of each Graph
|
||||
- **Graph Height** - The height of each Graph
|
||||
- **Thumbnails** - Should the Graphs be rendered in Thumbnail mode
|
||||
- **Next Timestamp of Sending Mail Report** - The approximate next time to send out the
|
||||
**Report**.
|
||||
- **Report Interval** - The frequency to send the report. Options are every X Minute, Hours, Days, Weeks, Months on a Day of the Month, Months on the Day of the Week, and Years.
|
||||
- **Interval Frequency** - How often to send, for example if you select Days, and the Interval is one, it means every day, if you select 2, it means every other day.
|
||||
|
||||
The **Email Frequency** section does not use the same layout as does our **Automation Networks**.
|
||||
Correcting that is a future project for the team.
|
||||
|
||||
The last section of the **Report Details** is the **Email Sender/Receiver** section as shown below.
|
||||
|
||||

|
||||
|
||||
From here you can set the following columns.
|
||||
|
||||
- **Subject** - The Email subject.
|
||||
- **From Name** - The From Name on the Email. For example **Cacti Administrator**
|
||||
- **From Email Address** - The From Email address. For example *noreply@mydomain.com*
|
||||
- **To Email Address(es)** - A comma delimited list of Email addresses that should
|
||||
receive the Report.
|
||||
- **BCC Address(es)** - An anonymized list of Email recipients
|
||||
- **Image attach type** - This defines how the Cacti Graph images get attached to the
|
||||
Email. Maybe are for legacy purposes. Most users will use Inline PNG or Inline JPG.
|
||||
|
||||
Once you save a new **Report** additional Tabs will show up. Those tabs are:
|
||||
|
||||
- **Items** - The Graph's, Tree's, Text, Horizontal Rules, and Device's to place on the Report.
|
||||
- **Preview** - See a Preview of your Report
|
||||
- **Events** - Approximate Future Event Days for your Report to be sent. This helps interpret
|
||||
the idiosyncrasies of the scheduler design.
|
||||
|
||||
---
|
||||
<copy>Copyright (c) 2004-2022 The Cacti Group</copy>
|
||||
@@ -0,0 +1,86 @@
|
||||
# Reports Items
|
||||
|
||||
This section will describe the **Report Edit Items** Sub-Tab.
|
||||
|
||||
From this Sub-Tab, you can add, remove, and if **Drag and Drop** is enabled, easily
|
||||
reorder any **Report Item**. **Report Items** include:
|
||||
|
||||
- **Trees** - Including one or more Branches, which include Devices as a Branch Type.
|
||||
- **Graphs** - One or more Graphs from a Device.
|
||||
- **Devices** - One or more Cacti Devices with Graphs whose titles may include a Regular
|
||||
Expression.
|
||||
- **Text** - For example to sub-section a Report and add a Title
|
||||
- **Horizontal Rule** - For separating sections of a **Report**.
|
||||
|
||||
An example **Report Items** interface can be seen below.
|
||||
|
||||

|
||||
|
||||
From this image, you can see a combination of **Graphs**, **Devices**, and a **Device**
|
||||
showing only **Graphs** that include *eth0*, and *SCSI* in their titles indicating
|
||||
something about Interface Graphs and Disk Utilization Graphs.
|
||||
|
||||
## Item Edit Page
|
||||
|
||||
When you either add a new Item by pressing the Add button on the right, or Clicking on the
|
||||
Item # on the left, you will be presented a page that is personalized depending on the *Item Type*. When you add an item for the first time, you will see the image below.
|
||||
|
||||

|
||||
|
||||
Again, the user interface will change layout depending on the *Item Type* that you select
|
||||
which happens to be the first drop-down on that page.
|
||||
|
||||
The columns for a **Graph** Type **Report Item** include:
|
||||
|
||||
- **Site** - A filter that will show only Devices and Graphs from a specific site.
|
||||
- **Device Template** - A filter that will only show Devices and Graphs from a
|
||||
specific Device Template
|
||||
- **Device** - A filter that will show only Graphs from a specific Device.
|
||||
- **Graph Template** - A filter that will show only Graphs from a specific Graph Template.
|
||||
|
||||
The options above are only Filter to reduce the Graph list when you actually select the
|
||||
**Graph Name**, it will apply those filters to narrow in on the Graphs to display in the
|
||||
drop-down. All of the filters above are *optional*.
|
||||
|
||||
The last sections are for the specific Graph in question including:
|
||||
|
||||
- **Graph Name** - The name of the Graph to include.
|
||||
- **Graph Timespan** - The time range to show for the Graph.
|
||||
- **Alignment** - Should the Graph be Center, Left or Right Aligned on the page.
|
||||
- **Sequence** - The Graph Items Sequence number. This is a Read Only variable.
|
||||
|
||||
When, you change the **Report Item** to **Device** the layout of the page will change and
|
||||
you will see the form shown below.
|
||||
|
||||

|
||||
|
||||
In this case, the **Site**, and **Device Template** both remain Filters, and the **Device**
|
||||
represents the **Device** to include on the **Report**. After that, the options below
|
||||
define what Graphs from the Device are to be included.
|
||||
|
||||
- **Graph Template** - Either Any Graph Template, or a Specific Graph Template.
|
||||
- **Graph Name Regular Expression** - A regular expression that limits the **Graphs**
|
||||
to only those matching the Regular Expression.
|
||||
- **Graph Timespan** - The time range to show for the Graph.
|
||||
- **Alignment** - Should the Graph be Center, Left or Right Aligned on the page.
|
||||
- **Sequence** - The Graph Items Sequence number. This is a Read Only variable.
|
||||
|
||||
The last **Report Item** that we will document here is the **Tree** type. The Text and Horizontal Rule types are pretty much self explanitory. The image below is the layout that will be shown
|
||||
when you change the **Report Item** to **Tree**.
|
||||
|
||||

|
||||
|
||||
In this case, there are no filter, just selections. They include:
|
||||
|
||||
- **Graph Tree** - The name of the Cacti Tree to include in the report.
|
||||
- **Graph Tree Branch** - The specific Branch to include if you are only wanting to include a
|
||||
portion of the **Tree**
|
||||
- **Cascade to Branches** - Walk all the **Graph Trees** branches
|
||||
- **Graph Name Regular Expression** - A MySQL/MariaDB compatible Regular Expression of Graph Names
|
||||
to include in the Report.
|
||||
- **Graph Timespan** - The time range to show for the Graph.
|
||||
- **Alignment** - Should the Graph be Center, Left or Right Aligned on the page.
|
||||
- **Sequence** - The Graph Items Sequence number. This is a Read Only variable.
|
||||
|
||||
---
|
||||
<copy>Copyright (c) 2004-2022 The Cacti Group</copy>
|
||||
@@ -0,0 +1,91 @@
|
||||
# Reports User
|
||||
|
||||
This section will describe the user view to Cacti's **Reports** feature.
|
||||
|
||||
The **Reports User** interface allows you to see and manage your own reports.
|
||||
This is unlike the **Reports Administration** interface that allows you to
|
||||
manage others reports in addition to your own.
|
||||
|
||||
## The Web Interface
|
||||
|
||||
The user of any **Report** begins on the main Reports tab in Cacti.
|
||||
A screen shot of the Reports tab is shown below.
|
||||
|
||||

|
||||
|
||||
When viewing any **Reports** from this interface, you will see the following
|
||||
columns:
|
||||
|
||||
- **Report Name** - The name of the Report.
|
||||
- **Owner** - The Cacti account that has ownership of the Report.
|
||||
- **Frequency** - How often the Report is to be sent to the distribution.
|
||||
- **Last Run** - The last time that the Report was sent to the distribution.
|
||||
- **Next Run** - The approximate next time that the report is to be sent.
|
||||
this is not an exact number. It does depend on the poller first running. So,
|
||||
depending on how long your poller runs for, this time could be off by a
|
||||
few minutes.
|
||||
- **From** - The From Name portion of the From Email address
|
||||
- **To** - The list of Emails that the reports is to be sent to.
|
||||
- **Type** - The Image format and the type of embedding done in the Email.
|
||||
- **Enabled** - Is the Report able to be sent on the Schedule.
|
||||
|
||||
The actions that you can take on an existing Report as an Administrator include:
|
||||
|
||||
- **Send Now** - Force send one or more **Reports** now
|
||||
- **Duplicate** - Duplicate one or more **Reports**
|
||||
- **Enable** - Enable one or more **Reports**
|
||||
- **Disable** - Disable one or more **Reports**
|
||||
- **Delete** - Delete one or more **Reports**
|
||||
|
||||
## Report Editing
|
||||
|
||||
When you click the Add button on the right side of the **Reports** page, or Click on the Report Name of an existing Report, you will be presented with the interface below.
|
||||
|
||||

|
||||
|
||||
This section includes:
|
||||
|
||||
- **Report Name** - The Name of the **Report**
|
||||
- **Enable Report** - Is the **Report** Enabled
|
||||
- **Use Custom Format HTML** - This is an indication that you wish to use a custom html/css
|
||||
document that you can use to customize the layout of your reports and add
|
||||
corporate branding for example.
|
||||
- **Format File to Use** - The specific html/css file to use.
|
||||
- **Graphs Linked** - Provide the recipient of the report a ling back to the actual
|
||||
graph in Cacti.
|
||||
- **Graph Columns** - The number of Graph columns to use per row.
|
||||
- **Graph Width** - The width of each Graph
|
||||
- **Graph Height** - The height of each Graph
|
||||
- **Thumbnails** - Should the Graphs be rendered in Thumbnail mode
|
||||
- **Next Timestamp of Sending Mail Report** - The approximate next time to send out the
|
||||
**Report**.
|
||||
- **Report Interval** - The frequency to send the report. Options are every X Minute, Hours, Days, Weeks, Months on a Day of the Month, Months on the Day of the Week, and Years.
|
||||
- **Interval Frequency** - How often to send, for example if you select Days, and the Interval is one, it means every day, if you select 2, it means every other day.
|
||||
|
||||
The **Email Frequency** section does not use the same layout as does our **Automation Networks**.
|
||||
Correcting that is a future project for the team.
|
||||
|
||||
The last section of the **Report Details** is the **Email Sender/Receiver** section as shown below.
|
||||
|
||||

|
||||
|
||||
From here you can set the following columns.
|
||||
|
||||
- **Subject** - The Email subject.
|
||||
- **From Name** - The From Name on the Email. For example **Cacti Administrator**
|
||||
- **From Email Address** - The From Email address. For example *noreply@mydomain.com*
|
||||
- **To Email Address(es)** - A comma delimited list of Email addresses that should
|
||||
receive the Report.
|
||||
- **BCC Address(es)** - An anonymized list of Email recipients
|
||||
- **Image attach type** - This defines how the Cacti Graph images get attached to the
|
||||
Email. Maybe are for legacy purposes. Most users will use Inline PNG or Inline JPG.
|
||||
|
||||
Once you save a new **Report** additional Tabs will show up. Those tabs are:
|
||||
|
||||
- **Items** - The Graph's, Tree's, Text, Horizontal Rules, and Device's to place on the Report.
|
||||
- **Preview** - See a Preview of your Report
|
||||
- **Events** - Approximate Future Event Days for your Report to be sent. This helps interpret
|
||||
the idiosyncrasies of the scheduler design.
|
||||
|
||||
---
|
||||
<copy>Copyright (c) 2004-2022 The Cacti Group</copy>
|
||||
|
After Width: | Height: | Size: 106 KiB |
|
After Width: | Height: | Size: 117 KiB |
|
After Width: | Height: | Size: 38 KiB |
|
After Width: | Height: | Size: 56 KiB |
|
After Width: | Height: | Size: 56 KiB |
|
After Width: | Height: | Size: 54 KiB |
|
After Width: | Height: | Size: 112 KiB |