Getting Started
The RapidIdentity Portal Reporting Module allows users to access the Audit database to create and view reports.
My Reports
Upon accessing the Reports Module, the active workspace displayed in the left menu is My Reports. This menu provides an interface to display and access saved reports as well as to provide a starting point to create new reports. Users with appropriate permissions can create a new report or import a saved report. When at least one report is saved or shared, the My Reports module will have reports populated in the workspace. Choose to view these reports in Grid or List view.
 |
The My Reports workspace displays three labeled columns. The columns with the arrows in the header are sortable in both ascending and descending order.
Report: The name of the report.
Owner: The ID of the user who manages the report.
Description: The brief description added during the report's creation.
When selected, existing reports will have an option to Run or view Details. Clicking Run processes the selected report, prompting for report criteria if applicable.
 |
Enter the prompt value as needed and click Run to display the report results.
 |
Other action buttons include Import, Export, Clone, Delete. The action buttons available depend upon the user's permissions.
 |
Import: Users with appropriate permissions can create a new report or import a saved report. The report file to be imported must be a JSON file. Click Import and select the appropriate JSON file and also rename the report with its description. Click for more information on importing system reports.
Export: All exported reports are saved as <Report Name>.report.json.
Clone: Create a new report with exactly the same criteria as the original selected report.
Delete: Users that have created a report or with appropriate permissions can delete the selected report.
Details
Clicking Details allows Portal Reporting Admins to adjust report criteria for an existing report.
 |
The top right of the screen displays who can see the report by showing Private or Public. Click Edit to change this setting, then toggle to activate the desired status.
 |
 |
Click Save once all settings have been adjusted.
Settings
The Settings menu at the bottom left allows Portal Reporting Admins to set extra restrictions to reports, such as the maximum number of report results to return and who can access them, which would be defined by Roles or Attributes.
Simply click the Settings cog at the bottom left of the Reports screen.
Determine the maximum number of report results to return (default is 1,000) and if there will be any RBAC or ABAC Access Control restrictions. Once these settings have been updated, click Save to commit them.
Shared with Me
The Shared with me interface displays reports shared with the authenticated user.
 |
Users with permissions can choose to run these reports and also create new reports.
Shared with Me contains three labeled columns. The columns with the arrows in the header are sortable in both ascending and descending order.
Report: The name of the report
Owner: The name of the user who owns the report.
Description: The brief description added during the report creating.
Community
The Community interface displays reports shared with the authenticated user.
Users with permissions can choose to import these reports.
Shared with Me contains three labeled columns. The columns with the arrows in the header are sortable in both ascending and descending order.
Report: The name of the report
Rating: How many stars the report has been given by the organization's users.
Downloads: How many times the report was downloaded.
 |
Existing reports will have at least one action button, the Import button. This button imports the selected report into the My Reports section and allows the user to run the report from there.
 |