Create and Add Report

The Create and Add Reports tab allows the user to use Analysis Server-like reports without Analysis Server installation. It also connects directly to the Core Server flat data files for report creation to avoid loading a massive amount of data in the SQL server, which may cause delay.

Before proceeding, make sure the Create and Add Report page is activated.

Uploading Reports

NOTE

Report package upload only supports zip files. The zip file must contain a Streamlit Python script, a JSON file for metadata, and an executable for generating a data source of the report.

1. Go to Reporting > Create and Add Reports.

2. Click Upload Report.

   

   Upload Report

3. Select the zip file to upload.

4. Wait for the page to finish processing. The page will extract and move files to their respective directories, and the report will then be included in the list.

   Uploading a new report adds a new executable binary in the queries directory, which is by default in C:\ProgramData\OpeniT\Data\queries on Windows and in your defined data-dir upon installation on Unix. This also creates a Python script and metadata in the streamlit directory, which is by default in C:\ProgramData\OpeniT\Data\streamlit on Windows and in your defined data-dir upon installation on Unix.

   
   
   NOTE

   Manually move the new executable query from the streamlit directory to the queries directory in case it is not automatically moved after uploading.

Creating Reports

1. Go to Reporting > Create and Add Reports.

2. Click Create Report corresponding to the report to create. The page will redirect to Streamlit's web interface.

   

   Create Report

   • Autodesk Usage Report - This report displays the visual and statistical analytics on Autodesk package and feature utilization.

     warning

     Make sure that the data types 94, 139, and 140 are available in the database.

     

     Autodesk Usage Report

   • Days Since Last Used - per User - This report is specifically for named user agreements presenting usage activity levels of the users of the selected applications.

     

     Days Since Last Used - per User

   • License Efficiency - A report on efficient license use. It also shows the utilization on max in use and max available licenses on specific percentiles, which is not readily available in the Core Server. By default, the selected percentiles are 1, 5, 50, 95, and 99. Select the percentile to show from the drop-down or click (x) beside the percentile number to remove it from the view.

     

     License Efficiency Report

   • Heatmap - A graphical presentation of the monthly and weekly license usage reports (max or average in use) in colors of varying intensities. This report helps organizations with offices in different time zones monitor license usage. Select whether to show the mean or the max aggregation.

     warning

     Make sure to select the correct time zone when generating Heatmap reports.

     

     Heatmap Report

   • Impact Analysis - This report highlights the date and time that will be affected when the licenses are reduced based on License Efficiency calculation.

   • Utilization Trend - A license usage trend report that includes the license denials of a selected product/feature for a specified period.

     NOTE

     It is best to have both data types 102 and 75 when creating Utilization Trend reports.

     

     Utilization Trend Report

3. Select the filters. The GUI may load multiple times after selecting filters. Wait for the process to finish.

Getting Reports through API

Getting Reports through API

1. On the Core Server web interface, go to Reporting > Create and Add Reports.

2. On the lower half of the page, select from the two options to get reports through the API:

   Specific Report Query

   This query link specifies which report to generate. The link can include the specific report, or it can also include date (date), product (product), feature (feature), months (months), and timezone (tz) parameters.

   NOTE

   The months parameter accepts an integer corresponding to the number of months to include in the report.

   Use the following values for report type:

   • adsk - Autodesk Usage Report
   • dslu - Days Since Last Used - per user
   • efficiency - License Efficiency
   • heatmap - Heatmap
   • impact - Impact Analysis
   • utilization - Utilization Trend
   
   

   # Example:
   http://desktop123win:8080/api/queries/heatmap?date=2022-10-01&product=product1

   A Heatmap report for Product1 on October 1, 2022 will be generated in this example.

   Specific Datatype Query (for BI Integration)

   There are two options for the data type query:

   • To select datatypes - selects the specific data type(s) to include in the report. This query can include data type(s), or it can also include date (date), months (months), timezone (tz), and frequency (freq) parameters.

   • To combine datatypes based on a common column - joins different data types based on their common column. This query can include data type(s) and the common column between the data types (on). It can also include date (date), months (months), timezone (tz), and frequency (freq) parameters.

     NOTE

     The freq parameter accepts D (daily), M (monthly), or Y (yearly) value.

   
   
   Example

   http://desktop123win:8080/api/queries/join?datatype=94,75&on=datetime,product,package&date=2021-06-21&freq=D

   This example demonstrates how to generate a report by combining data from data types 94 and 75, using the date, product, and package information for June 21, 2021.

   For further information about available data types and additional properties that can be utilized in this API, please refer to the Queries page.

3. To get the report in Excel, use the created URL and follow the steps provided in this link.

   For accessing the report in PowerBI, please refer to this link.