Reports - Automate_Studio_Manager - Latest

Automate Studio Manager Guide

Product type
Software
Portfolio
Integrate
Product family
Automate
Product
Automate > Automate Studio Manager
Version
Latest
Language
English
Product name
Automate Studio Manager
Title
Automate Studio Manager Guide
Copyright
2024
First publish date
2018
Last updated
2024-07-22
Published on
2024-07-22T13:20:59.472887

Studio Manager reports work on predefined SQL Views. (SQL Views are fixed; you cannot create or modify them.) When you create reports, you can view the predefined SQL Views and their fields. And, you can write complex SQL queries to bring data into the reports.

After you have created and published a report, you can pin it to the top or bottom widget of your home page.

And when a new Studio Manager set up is created, access to several reports is provided by default. For some of these ‘default reports’ (for example, for the License Details report), the data is loaded into the report only when the report is refreshed; the data is not in all default reports when Studio Manager is initially set up.

Note:

Notes: If a view name or a column name includes special characters (anything besides a number, a letter, or an underscore), place the view or column name in square brackets. Example: [square brackets]

When creating a SQL query, use only the view name in the FROM clause; do not include the database name or schema. For example: Valid query: Select Column FROM ViewInvalid query: Select Column FROM db.schema.View

On the Reports page, reports admins have the ability to perform all of the available actions, as follows:

Global Admins, App Admins, and End Users can perform only the following two actions on the Reports page (a subset of reports admins' available actions):

  • Pin a report to the home page
  • View report data

Create a new report

reports admins can create new reports and share them with users from other app groups.

Click here for SQL Views information.

To create a new report:

  1. In the Administrator App, go to the Reports page.
  2. Click Add new Report to open the Add Report pop-up.
  3. Provide the name and a short description of the report.
  4. Click Create to open the configure report wizard and go to the Report Design page.
  5. Enter the SQL query against which the reports need to be created. The SQL Views panel displays view names and their fields; double click the View Name or Field Name to select them, and then click Ctrl+C to copy the View Name or Field Name. This will help construct a query.

    Note:

    It is recommended that you design and test your query in SQL Server Management Studio (SSMS) before pasting it in the SQL Query editor. You can type the SQL view/column names OR copy-paste the names by double-clicking on the SQL view/column name that you want to copy. Once it is selected, you can Copy (CTRL+c) and paste (CTRL+v) it in the SQL query window and build the query.

  6. Click Next to go to the Display Fields page.
  7. All fields used in the query are displayed here. Select the fields you want to display in the report.
  8. Click Next to go to the Select Filters page.
  9. Move the fields you want to use in the filter from the Available Columns box to the Selected Columns box.
  10. Click Next to go to the Set Filters page.
  11. Define the filter for each field, selecting Static or Dynamic.
  12. For a Static filter, you can define multiple filters for the same field. Enter information for the following:
    Static Filter Info Detail
    Filter Text This text is visible when you view the report data in a table or on the home page widget. Filter text needs to define the filter condition and value.
    Filter Select the condition of the filter.
    Value Select the value to be used in the condition.

    For a Dynamic filter, all distinct values in the field will be visible. You can choose any field value in the filter as you view data.

  13. Click Submit to create the report.
Note:

In the SQL query, if you use aggregate functions such as count, you will create a graph-based report. Otherwise, you will create a table-based report.

Only graph-based reports can be pinned to widgets.

SQL functions and CTE (Common Table Expression) queries are not supported in report queries.

Publish a report

Only reports admins can publish reports. Once you have created a report, you can publish it. After you have published a report, you can use it in various ways – with some uses depending on whether it is a graph-based or a table-based report.

To publish a report:

  1. In the Administrator App, go to the Reports page.
  2. Select the report you want to publish.
  3. Click the Publish button at the top of the page.
  4. When prompted to confirm, click Yes. You will receive a message confirming the publication.

Schedule a report

Only reports admins can share reports. After you have published a report, you can schedule updates to the report data – selecting the Schedule or On Demand option.

Schedule If you want report data to be updated at specified intervals, select the Schedule option and follow these steps:

  1. In the Administrator App, go to the Reports page.
  2. Go to the Actions column for the report you need to schedule, click the icon, and click Schedule.
  3. Select the Schedule option. Then click on the Schedule button to go to the Calendar page.
  4. Click Next on the Job Details page (job details are populated automatically).
  5. On the Set Date and Time page, enter the date, time, and schedule for the report. Click Next.
  6. On the Summary page (which displays when the report will be executed), click Submit. The report will be scheduled.

On Demand If you want the report data to be refreshed manually or whenever users access it, select the On Demand option and follow these steps:

  1. In the Administrator App, go to the Reports page.
  2. Go to the Actions column for the report you need to schedule, click the icon, and click Schedule.
  3. Select the On Demand option and enter a Refresh Frequency value – in minutes.
  4. If you want the refresh button to appear on theView Data page of the report, check the Show the Refresh Button check box.

If the report is set to update On Demand, it can be updated in two ways: when the Refresh Frequency time has elapsed or when a user clicks the Refresh button on the View Data page any time after the Refresh Frequency has elapsed. For example, a report is not refreshed if Refresh Frequency is set to 60 minutes and a user opens the report after 55 minutes. If a user opens the report after 65 mins, the report is refreshed upon opening.

Note:

reports displayed on the dashboard are updated if the Refresh Frequency time has elapsed and a user opens the home page.

Share a report

Only reports admins can share reports. Once a report is published, Global Admins and reports admins can share a report with any app group. Users with access to a published report can view the report data; they can also pin graph-based reports to widgets on their home page.

To share a report:

  1. In the Administrator App, go to the Reports page.
  2. For the report you want to share, go to the Actions column and click the icon. Click Share.
  3. All apps and App groups will appear in a side panel.
  4. Select the group to which you want to share the report.
  5. Click Save to share the report with the group or groups you selected.

Pin a report to the home page

All users – reports admins, Global Admins, App Admins, and End Users – can pin published, graph-based reports to which they have access to a widget on their home page.

For table-based reports, they can view the data within the reports only; table-based reports cannot be pinned to a widget on the home page.

To pin graph-based reports to a widget:

  1. In the Administrator App, go to the Reports page.
  2. For the report you want to schedule, go to Actions column and click the icon.
  3. Click Pin to Top Widget or Pin to Bottom Widget based on your preference.
  4. A Display Type pop-up will appear. Select one of the following chart formats:
    • Pie Chart
    • Donut Chart
    • Bar Chart
    • Line Chart
Note:

To change the Display Type of a pinned report, you must first unpin it. Make the change to the Display Type and then re-pin the report to the widget. If the report has one aggregate column, you can use any of the chart formats. If the report has two aggregate columns, you can use the bar chart and the line chart only.

Edit a report

Only Reports Admins can edit reports. Edit reports when you need to change the SQL query or change the filter values or columns.

To edit a report:

  1. In the Administrator App, go to the Reports page.
  2. Select the report you want to edit and click the Edit button at the top of the table.
  3. The Report Configuration page will open.
  4. Make the necessary changes and click Submit. The changes are saved and the report is updated.

View report data

All users – reports admins, Global Admins, App Admins, and End Users – can view the report data for all reports they have access to. To view report data:

  1. In the Administrator App, go to the Reports page.
  2. Select the report for which you want to view the data.
  3. Click the View Data button at the top of the table. The data will display on tabs.
  4. To change the data filters, change the values in the filter drop-down list.

Delete a report

Only Reports Admins can delete reports. When a scheduled report is deleted, its scheduled times are removed from the calendar.

To delete a report:

  1. In the Administrator App, go to the Reports page.
  2. Select the report you want to delete and click the Delete button at the top of the table.
  3. When prompted to confirm, click Yes. You will receive a message confirming the deletion.
Note:

When you delete a solution, the solution SQL View and all reports which draw upon that SQL view are retained - they are not deleted.