--- title: Creating a custom report using Advanced Reporting description: Contact your Ping Identity representative if you want to add Advanced Reporting to your Advanced Identity Cloud subscription. component: pingoneaic page_id: pingoneaic:use-cases:use-case-advanced-reporting canonical_url: https://docs.pingidentity.com/pingoneaic/use-cases/use-case-advanced-reporting.html revdate: Feb. 4, 2025 keywords: ["Advanced Identity Cloud", "Reports", "Template", "Custom reports", "Use Case"] section_ids: description: Description goals: Goals before_you_begin: Before you begin tasks: Tasks creating_a_new_custom_report_draft: Creating a new custom report draft adding_a_data_source_and_user_provided_parameters: Adding a data source and user-provided parameters adding_filters_for_the_reports_data: Adding filters for the report's data running_and_viewing_the_report: Running and viewing the report publishing_the_report: Publishing the report duplicating_the_report: Duplicating the report editing_the_copy_and_adding_an_aggregate_count_to_the_report: Editing the copy and adding an aggregate count to the report exporting_and_downloading_the_report: Exporting and downloading the report showing_how_the_end_user_can_access_the_report: Showing how the end user can access the report validation: Validation video_of_validation: Video of validation troubleshooting: Troubleshooting error_when_running_a_report: Error when running a report explore_further: Explore further reference_material: Reference material --- # Creating a custom report using Advanced Reporting | | | | - | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | | Advanced Identity Cloud add-on capabilityContact your Ping Identity representative if you want to add Advanced Reporting to your Advanced Identity Cloud subscription. | ## Description Estimated time to complete: 15 minutes *(tooltip: This assumes you complete the prerequisites beforehand.)* In this use case, you create a custom report called `Userlist by Expertise by Organization` that generates a list of experts within an organization. The use case also shows how to create a duplicate of the report called `Count of Userlist By Expertise By Organization` that generates a count of experts within an organization. ## Goals After completing this use case, you'll know how to do the following: * Create a new custom report draft. * Add a data source and user-provided parameters. * Add filters for the report's data. * Run and view the report. * Publish the report. * Duplicate the report. * Edit the report and add an aggregate count to the report. * Export and download the report. * Show how the end user can access the report. ## Before you begin For this use case, you'll need to have: * A basic understanding of Advanced Identity Cloud concepts: * Advanced Reporting * Journeys * An Advanced Identity Cloud tenant with the Advanced Reporting feature. * Access to the tenant as an administrator. * A set of test data to help correctly configure the report. * An end user test account. ## Tasks ### Creating a new custom report draft 1. In the Advanced Identity Cloud admin console, go to Reports > [icon: plus, set=fa]New Report. 2. In the New Report modal, enter the following: * Name: Enter a descriptive name for the report. For this example, enter `Userlist by Expertise by Organization`. * Description (optional): Enter a description for the report. * Who Can Run: Enter users who can run the report. For example, enter a test user in your database, such as `john.doe`. 3. Click Next. Check in At this point, you've: [icon: check, set=fa]Created a new custom report draft ### Adding a data source and user-provided parameters 1. Click [icon: plus, set=fa]Data Source. 1. In the Add a Data Source modal, select Users. This data source provides access to the user database. 2. Click Next. 2. In the right pane, under Settings, click Data and select the following columns: * Username * Generic Indexed String 1 3. In the right pane, click Organizations to which I Belong. 1. Click [icon: plus, set=fa]and then click [icon: plus, set=fa]Add as Data Source. 2. Under users/orgs, select the Org Name checkbox. 4. Next, add report parameters for `orgName` and `expertise`: 1. Scroll down to Parameters and click [icon: plus, set=fa]for the `orgName` parameter. 2. In the Add a Parameter modal, enter the following: * Name: Enter `orgName` for the parameter's descriptive name. * Input Label: Enter `Org Name` for the parameter's input label. * Input Type: Select String for the parameter's input type. 3. Click Save. 5. Click [icon: plus, set=fa]to add the next parameter. * Name: Select `expertise` for the parameter's descriptive name. * Input Label: Select `Expertise` for the parameter's input label. * Input Type: Select String for the parameter's input type. * Multivalued: Select the Multivalued checkbox to accept one or more values. 6. Click Save. Check in At this point, you've: [icon: check, set=fa]Created a new custom report draft [icon: check, set=fa]Added a data source [icon: check, set=fa]Added user-provided parameters ### Adding filters for the report's data You need to configure filters for retrieving the correct data from your database. Create two filter rules for the `orgName` and `expertise` variables. 1. In the right pane, click [icon: plus, set=fa]next to Filters. 2. In the Add Filters modal, enter or select the following: * Any|All: Select All to require that all conditions must be met to be included in the filter. * Value: Select the users.orgs.name value for the filter rule. * Condition: Select the equals to condition for the filter rule. * Literal or Variable: Select Variable# for the filter, and then select the value, orgName. 3. Click [icon: plus, set=fa], and then click Add Rule. 1. Value: Select the `users.frIndexedString1` for the filter rule. 2. Condition: Select the contains condition for the filter rule. 3. Select Variable for the filter, and then select the value, expertise. ![Add filters to a custom report.](_images/use-case-advanced-reporting/use-case-add-filters.png) 4. Click Save. Check in At this point, you've: [icon: check, set=fa]Created a new custom report draft [icon: check, set=fa]Added a data source [icon: check, set=fa]Added user-provided parameters [icon: check, set=fa]Added report filters ### Running and viewing the report 1. In the Advanced Identity Cloud admin console, return to the Reports page. 2. Locate your newly created report, Userlist by Expertise by Organization. In the report file, click Run. 3. On the Reports page, enter the following input parameters for the report: * Org Name: Enter `Data Science` for the organization name. * Expertise: Enter `Programming`, `Machine Learning`, and `Data Modeling`. 4. Click Run Report. 5. On the Run History tab, click View Report. ![Run the custom report Userlist by Expertise by Organization showing the username, generic indexed string1, and Org Name columns.](_images/use-case-advanced-reporting/use-case-run-report.png) Check in At this point, you've: [icon: check, set=fa]Created a new custom report draft [icon: check, set=fa]Added a data source [icon: check, set=fa]Added user-provided parameters [icon: check, set=fa]Added report filters [icon: check, set=fa]Run the report [icon: check, set=fa]Viewed the report ### Publishing the report 1. After reviewing the draft of your report, return to the Reports page and look for your report. 2. On the report tile, click [icon: ellipsis, set=fa], and then click Publish. The Published icon appears in the top right of the report tile. Check in At this point, you've: [icon: check, set=fa]Created a new custom report draft [icon: check, set=fa]Added a data source [icon: check, set=fa]Added user-provided parameters [icon: check, set=fa]Added report filters [icon: check, set=fa]Run the report [icon: check, set=fa]Viewed the report [icon: check, set=fa]Published the report ### Duplicating the report You can create a similar report with different parameters or columns by duplicating the original report and editing the new report copy. In this example, you'll create a new report listing the count of users by expertise in an organization. 1. On the Reports page, search for a report you want to copy. In this example, you'll search for `Userlist by Expertise by Organization`. 2. Click [icon: ellipsis, set=fa], and then click Duplicate. 3. In the Duplicate Report modal, enter the following: * Name: Enter `Count of Userlist By Expertise By Organization` for the report name. * Description (optional): Enter a general description for the new duplicate report. * Users: Select a test user in your database, such as `john-doe`. 4. Click Duplicate. Check in At this point, you've: [icon: check, set=fa]Created a new custom report draft [icon: check, set=fa]Added a data source [icon: check, set=fa]Added user-provided parameters [icon: check, set=fa]Added report filters [icon: check, set=fa]Run the report [icon: check, set=fa]Viewed the report [icon: check, set=fa]Published the report [icon: check, set=fa]Duplicated the report ### Editing the copy and adding an aggregate count to the report 1. On the Reports page, locate your report. In this example, search for `Count of Userlist By Expertise By Organization`. 2. Click [icon: ellipsis, set=fa], and then click Edit. 3. In the right pane, scroll down the users data source properties, and clear the Username checkbox. 4. In the right pane, scroll down to Aggregate, and click [icon: plus, set=fa]. 1. In the Add an Aggregate modal, enter the following: * Name: Enter `Count of Users` for a descriptive name. * Type: Select `Count of specific rows` for the type of parameter. * Value: Select `users.frIndexedString1` for the parameter value. 2. Click Save. 5. Click Save at the upper right of the page to apply your edits to the report. 6. On the Reports page, locate your report, and click Run. 1. On the Reports page, enter the following input parameters for the report: * Org Name: Enter `Data Science` for the organization name. * Expertise: Enter `Programming`, `Machine Learning`, and `Data Modeling`. 2. Click Run Report, and then click View Report. ![Run the duplicate report.](_images/use-case-advanced-reporting/use-case-run-report-duplicate.png) Check in At this point, you've: [icon: check, set=fa]Created a new custom report draft [icon: check, set=fa]Added a data source [icon: check, set=fa]Added user-provided parameters [icon: check, set=fa]Added report filters [icon: check, set=fa]Run the report [icon: check, set=fa]Viewed the report [icon: check, set=fa]Published the report [icon: check, set=fa]Duplicated the report [icon: check, set=fa]Edited the copy and added an aggregate count to the report ### Exporting and downloading the report 1. On the Reports page, locate your report. 2. Click [icon: ellipsis, set=fa], and then click Run History. If the report isn't available, run the report again. 3. Click the Download icon ([icon: file_download, set=material, size=inline]), and select Export CSV. 4. After the download generates, click Download Report (CSV). 5. Open the CSV file to review the results. Check in At this point, you've: [icon: check, set=fa]Created a new custom report draft [icon: check, set=fa]Added a data source [icon: check, set=fa]Added user-provided parameters [icon: check, set=fa]Added report filters [icon: check, set=fa]Run the report [icon: check, set=fa]Viewed the report [icon: check, set=fa]Published the report [icon: check, set=fa]Duplicated the report [icon: check, set=fa]Edited the copy and added an aggregate count to the report [icon: check, set=fa]Exported and downloaded the report ### Showing how the end user can access the report 1. In the Advanced Identity Cloud admin console, click Journeys. 2. Click the Login journey. 3. In the Preview URL field, click [icon: copy, set=material, size=inline] and paste the URL into an incognito window. 4. In the end-user sign-on page, enter the end user's `User Name` and `Password`. The end user should be the one who can run the report, such as `john.doe`. 5. In the hosted account pages, click Reports. The Reports page displays the reports. ![End user view of the reports](_images/use-case-advanced-reporting/use-case-end-user-view.png) Check in At this point, you've: [icon: check, set=fa]Created a new custom report draft [icon: check, set=fa]Added a data source [icon: check, set=fa]Added user-provided parameters [icon: check, set=fa]Added report filters [icon: check, set=fa]Run the report [icon: check, set=fa]Viewed the report [icon: check, set=fa]Published the report [icon: check, set=fa]Duplicated the report [icon: check, set=fa]Edited the copy and added an aggregate count to the report [icon: check, set=fa]Exported and downloaded the report [icon: check, set=fa]Shown how the end user can access the report ## Validation To validate your work: 1. In the Advanced Identity Cloud admin console, go to Reports. 2. On the Reports page, enter `userlist` in the search box. 3. Click Userlist By Expertise By Organization. 4. Click [icon: ellipsis, set=fa]and then Run History. 5. On the Run History tab, check the report status. If the report displays `Expired`, you need to run the report again. 6. Click the Run Report tab, enter the following parameters: * Org Name: Enter `Data Science`. * Expertise: Enter `Programming`, `Machine Learning`, and `Data Modeling`. 7. Click Run Report. 8. View the report to check that the report displays the data configured for it. ### Video of validation The following video displays the validating steps by running your custom report: **Video (Video)** <\_images/mp4/use-case-advanced-reporting-validation.mp4> ## Troubleshooting ### Error when running a report If you run a report and encounter an error, it's likely because of an incorrect mapping of parameters and variables that's preventing the system from retrieving the user's data from the database. ![Userlist by Expertise by Organization report showing an error in the status columnof the report's run history.](_images/use-case-advanced-reporting/report-error.png) * **Check the report's filters** 1. In the Advanced Identity Cloud admin console, click Reports and locate your report. 2. Go to [icon: ellipsis, set=fa]> Edit. 3. In the right pane, scroll down to Filters and go to [icon: ellipsis, set=fa]> Edit Filter. 4. Review which variables are mapped to the reports parameters. * **Check user details**: 1. In the Advanced Identity Cloud admin console, go to Identities > Manage. 2. Search for a test user. 3. On the Details tab, check the variables used for your report. For example, in this use case, check the following: * `Generic Indexed String1` 4. On the user's page, click Organizations to which I Belong. Check the user's organizations. * **Edit your filters**: 1. In the Advanced Identity Cloud admin console, click Reports and locate your report. 2. Go to [icon: ellipsis, set=fa]> Edit. 3. In the right pane, scroll down to Filters and go to [icon: ellipsis, set=fa]> Edit Filter. 4. Make changes to the filters. 5. Click Save. 6. Run the report and check that it contains the correct data. ## Explore further ### Reference material | Reference | Description | | ---------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- | | [Entities and attributes available in advanced reporting](../reports/administration/advanced-reports.html#entities-and-attributes) | Get a list of entities and their attributes for use in a custom report. |