You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/reports/reports/standard-reports.mdx
+74-46Lines changed: 74 additions & 46 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,17 +3,26 @@ title: "Standard Reports"
3
3
sidebar_position: 15.5
4
4
---
5
5
6
-
From version 18.13.00, the traditional "Classic Reports" menu option has been renamed to **Standard Reports** under the **Analytics** menu. Standard Reports are generally the quickest and easiest way to query and report on information within Device42.
6
+
importThemedImagefrom'@theme/ThemedImage'
7
+
importuseBaseUrlfrom'@docusaurus/useBaseUrl'
8
+
9
+
The traditional "Classic Reports" menu option has been renamed **Standard Reports** under the **Analytics** menu. Standard reports are generally the quickest and easiest way to query and report on information within Device42.
7
10
8
11
The standard reporting feature is the first place to go to answer difficult business questions with system data. These reports integrate this powerful tabular reporting functionality with DOQL queries, MA object tables, and the catalog of existing reports.
Use the Standard Reporting options to create tabular reports directly from an existing report or from a list within the UI, or use a custom DOQL to retrieve and populate the data. These reports can then be exported or scheduled to email, providing recipients with data-rich tabular exports from the system that are easy to configure and digest.
21
+
Use the standard reporting options to create tabular reports directly from an existing report or from a list within the UI, or use a custom DOQL to retrieve and populate the data. These reports can then be exported or scheduled to email, providing recipients with data-rich tabular exports from the system that are easy to configure and digest.
13
22
14
23
## Creating a Standard Report
15
24
16
-
You can create a Standard Report in several ways:
25
+
You can create a standard report in several ways:
17
26
18
27
- Using DOQL
19
28
- From a pre-defined report
@@ -24,47 +33,56 @@ You can create a Standard Report in several ways:
24
33
25
34
A DOQL statement, or Device42 Object Query Language statement, is a query that can be run against the Device42 database in the **Insights+** interface, through the application, or using the RESTful API. DOQLs can be used in Standard Reporting to generate the data to display in the results table.
26
35
27
-
**NOTE:** To create reports using DOQL, you should be familiar with and consult the data dictionary under the **Viewer Schema** option under the help icon.
36
+
:::note
37
+
To create reports using DOQL, you should be familiar with and consult the **Data Dictionary** under the **Viewer Schema** option under the help icon.
To use DOQL to create or edit a Standard Report, name the report and then select **DOQL Query** from the report-type dropdown. Enter the DOQL commands in the text box. The start of a sample select statement is displayed in the DOQL text box. If an error is encountered during parsing (for example, due to invalid syntax or referencing a table or field that does not exist), an error message will show at the bottom of the text box.
48
+
To use DOQL to create or edit a standard report, name the report and then select **DOQL Query** from the report-type dropdown. Enter the DOQL commands in the text box. The start of a sample select statement is displayed in the DOQL text box. If an error is encountered during parsing (for example, due to invalid syntax or referencing a table or field that does not exist), an error message will show at the bottom of the text box.
32
49
33
50
### Creating a Report From a Pre-Defined Report
34
51
35
-
Create a multitab Standard Report with one tab containing the results of a previous existing report. Select the **Pre-Defined Report** option and choose from a set of existing reports to be included as a separate tab.
52
+
Create a multi-tab standard report with one tab containing the results of a previous existing report. Select the **Pre-Defined Report** option and choose from a set of existing reports to be included as a separate tab.
To build a Standard Report using the Guided Report option, select the model (like **Devices**), then select the table columns that are part of that device model. Field filters can be added or set to alter the result display of this report.
65
+
Select the **Guided Report** option and the object to create the report on. Filters can be added and set to alter the report.
You can create a new Standard Report from list pages. A Standard Report can be emailed and scheduled.
50
-
51
-
Create a Standard Report from Infrastructure list pages for:
52
-
53
-
- Rooms
54
-
- Racks
55
-
- Telco Circuits
56
-
- Parts Models
57
-
- Parts List
58
-
- Power Units
59
-
- Hardware Models
60
-
- Customers
61
-
- Departments
62
-
- Purchases
63
-
- Vendors
64
-
65
-
Click the **Report** button at the top of the table.
66
-
67
-
Create a Standard Report from lists from the **Resources** menu for:
85
+
You can create a new standard report from any of the object list pages. A standard report can be emailed and scheduled. For example, you can create a standard report from the following list pages under the **Resources** menu:
68
86
69
87
- All Devices
70
88
- All Assets
@@ -79,28 +97,38 @@ Create a Standard Report from lists from the **Resources** menu for:
79
97
- Software In Use
80
98
- Secrets
81
99
82
-
First create and apply filters to a list, then create a Standard Report using the **Report** button at the top of the table.
As with the previous Classic Reports, you can view the report output on the screen or export the results in tab-separated values (TSV) or Excel formats.
122
+
As with the previous classic reports, you can view the report output on the screen or export the results in tab-separated values (TSV) or Excel formats.
101
123
102
124
## Scheduling Standard Reports
103
125
104
-
You can set and apply a schedule to the report, including a comma-separated list of recipients.
126
+
Toggle **Report Schedule** on and include a comma-separated list of recipients to send the report to.
105
127
106
-
## Quickly create an advanced report using custom SQL
6
+
Advanced reporting in Device42, introduced mid-2018, empowers you to create and schedule extremely complex reports that the old reporting engine simply couldn't handle. You can also combine all of the built-in reports and features that advanced reporting includes out-of-the-box with your own custom SQL objects to achieve an entirely new level of reporting flexibility, including using SQL's ability to pre-process and transform objects as part of your query.
7
7
8
-
Advanced Reporting in Device42, added mid-2018, empowers users to create and schedule extremely complex reports that the old reporting engine simply couldn't handle. You can also combine all of the built-in reports and features that advanced reporting includes out-of-the-box with your own custom SQL objects to acheive an entirely new level of reporting flexibility, including leveraging SQL's ability to pre-process / transform objects as part of your query!
8
+
## Create an Advanced Report Using Custom SQL
9
9
10
-
1. Head to menu: _“Reports” → “Advanced Reporting”_
10
+
1. Head to **Analytics > Reports > Advanced Reporting**.
11
11
2. Add a new Advanced Report and give it a name.
12
-
3. Don’t select any categories; instead, choose the _“Add SQL”_ button at the bottom right, instead.
13
-
4. Give your new SQL object a name, and then proceed to enter your query into the _“Custom SQL Object”_ form. Select a unique key field from the dropdown at the bottom of the window _(a unique key is required)_. Click OK twice:
12
+
3. Don’t select any categories; instead, choose the **Add SQL** button at the bottom right.
13
+
4. Give your new SQL object a name, and then proceed to enter your query into the **Custom SQL Object** form. Select a unique key field from the dropdown at the bottom of the window (a unique key is required). Click **Okay** twice:
14
14
15
-
15
+
16
16
17
-
_\*You’ll notice all of the categories are now greyed out. The SQL query you provided has taken care of this, so there’s no need to choose any here!_
17
+
_*You’ll notice all of the categories are now greyed out. The SQL query you provided has taken care of this, so there’s no need to choose any here._
18
18
19
-
1. Head to the “Layout” tab. Use the report designer to format your report data by choosing placing the fields you’d like to include into the report.
20
-
2. Click finish & it’s saved.
21
-
3. You’re done! You can go back and edit as you see fit. Run your report at at any time, or sort & filter further!
19
+
5. Head to the **Layout** tab. Use the report designer to format your report data by choosing the fields you’d like to include in the report.
20
+
6. Click **Finish** to save.
21
+
7. You’re done! You can go back and edit as you see fit. Run your report at any time, or sort and filter it further.
0 commit comments