Install the Server Usage Report
Note
Deprecation of the Server Usage Report
We are deprecating The Server Usage Report as of Server 2022.3.
We offered Server Usage Report as a separate download alongside the Server product. It runs a workflow in Designer that connects to MongoDB to help admins get valuable statistics about their Server setup.
The validity and value of the report outputs have diminished over time due to ongoing changes to Server DB schemas. The report isn't capturing new schema additions in the underlying Server product database. As such, we'll stop offering the Server Usage Report alongside Server as a separate download.
The report can still be downloaded on the 2021.4 and 2022.1 download pages. But ongoing database changes continue to devalue the outputs of this report.
Since the report is a Designer macro, any user can download and update it for ongoing use based on the information desired from MongoDB. The Alteryx product team will not update or maintain the report in its current state.
If you want to submit feedback on the Server Usage Report, please complete this survey. Our Server product team wants to capture any asks for future inclusion in our product suite.
Use the Alteryx Server Usage Report to report on Server user access, content, schedules, and job analysis. The report can be viewed as Tableau dashboards or PDF and Excel files.
Download the Installation File
Sign in to the Alteryx Downloads and Licenses portal at licenses.alteryx.com.
Under Product Downloads, select Alteryx Server.
On the Download Products page, select the version of the product you want to download. The latest version is available on the New Versions tab. Access previous versions on the Previous Versions tab.
On the Downloads page, select the AlteryxServerUsageReport.zip link in the File Name column to download the file.
Configure and Run the Report
Unzip the AlteryxServerUsageReport.zip.
Open the Alteryx_Server_Usage_Report.yxmd file.
On the canvas, select the Alteryx Server Usage Report macro.
In the Configuration window, select the type of output for viewing the results.
Tableau workbook: Creates a workbook and a set of dashboards with user access, content, schedules, and job analysis information.
Select the Output macro.
In the Configuration window, select the Save Tableau Workbook tab.
Select the Save resulting Tableau workbook to a specific location checkbox.
Select a location and enter a file name.
PDF: Creates Summary.pdf, AppExecutions.xlsx, and SessionActivity.xlsx files with data for the number of days specified.
Enter the Database Host, Username, and Password found on the Controller > Persistence page of System Settings.
Select Advanced Options to change the Alteryx Server and Alteryx Service database names from the defaults.
Run the workflow.
In the Results window, select the link to the output files.
For the Tableau workbook, select the link to the Workbook.twb file.
For the PDF, select the links to the SessionActivity.xlsx, Summary.pdf, and AppExecutions.xlsx files.
Schedule the Report
Follow previous steps to configure and run the report.
Save the workflow.
Select Options > Schedule Workflow.
Select a schedule location. You can use the local machine, an existing controller, or add a new controller using the Add Controller option.
Select Run the workflow from its original location on disk.
Select the frequency and complete the schedule options.
Select OK.
Limitations
The users count in the Server Usage Report might be different than the actual users count in these scenarios:
If the same email address is used to register licenses on multiple machines, the users count is lower than actual users. For example, an administrator might use the same email address to register multiple machines.
If any user does not have the valid XML tag for collecting usage data to the local Server in their RuntimeSettings.xml ,the users count is lower than actual users.
If any user does not have connectivity to the Server, the users count is lower than actual users. If Designer is unable to connect to this URL (for example, a user is working from home without network connectivity to the Server) data is not collected.