Configuring Ranker reports

Important: This module is superseded by the Dashboard Ranking module, which is part of Medallia Alchemy Experience Reporting. Do not create new Ranker reports in Setup. Medallia recommends that you migrate any existing Ranker standard reports to the new module, and then remove access to the legacy report. For more information, see Removing access to legacy Ranker reports, below.

Configuring Ranker reports involves several procedures, to be completed in the following order:

Creating a Ranker report and selecting fields

The fields you select appear as subtabs in report navigation. For more information about report navigation, see Navigation.

Note: Ordinarily, in report navigation the names of your subtabs appear to users. However, when you associate a Ranker report with a subtab, the name of the subtab you enter on the Navigation screen is not shown to users. Instead, the fields you select in the Ranker report are displayed as subtabs.
  1. Open the Reporting > Reports > Ranker screen.
  2. Click New.
  3. Enter a  Name.
  4. On the Add/Remove tab of the  Rank Fields table, select the fields you want to rank, and then click Add.

    If you select no fields, Medallia Experience Cloud selects the e_unitid field and all unit group fields in your instance when you save the report.

  5. On the Sort tab, reorder the fields from top-to-bottom as you want them to appear in report navigation, left-to-right.
  6. In the  MemberRoles property, choose the roles that will use this report.

    If you want different reports for different groups of users, create different Ranker reports with different MemberRoles selections. For example, if you only want users in the Corporate role to be able to rank performance by District, create a separate Ranker report for the Corporate role.

  7. Click Save. Configure Ranker reports on the Reporting > Reports > Ranker screen.

Selecting which questions can be used for ranking

Determine which questions appear in the Question Group dropdown in Ranker reports by creating a Question Groups filter in Control Panels. For more information, see Filters and control panels.

Note: R-fields take substantially more time to render in reports than other field types because R-fields recalculate every time a report is loaded. If you use a faster field type (such as Q-fields or K-fields), in the Question Group dropdown, Ranker reports load faster. For more information about R-fields, see R-fields.

Using permission contexts to expand data access for users in Ranker reports

As needed, use permission contexts to override the default data scope for certain roles. For example, users with the Store Manager role might have access to see data only for their store. Therefore, when using a Ranker report to rank by employee they would see only employees at their store, and when ranking by Store they would see only their store. However, you might want those users to see all stores when ranking by Store. Do do this, create permission contexts to allow that data exception. For more information about using permission contexts to set data exceptions, see Permission contexts

  1. Open the Company > Users > Roles > Permission Contexts screen.
  2. Click New.
  3. Enter a Name and then click Save. This creates the permission context object, but you still need to assign it to a role and to Ranker report itself. Create permission contexts on the Company > Users > Roles > Permission Contexts screen.
  4. Assign the permission context to a role: 
    1. Open the Company > Users > Roles > Roles screen.
    2. Select the role that will use the new permission context.
    3. In the MemberPermissionContexts property, choose the permission context you created. Assign permission contexts to roles on the Company > Users > Roles > Roles screen.
  5. Configure the permission context in the Ranker report:
    1. Open the Reporting > Reports > Ranker screen.
    2. In the list of Ranker reports, select the Ranker you want to modify.
    3. Select the permission context in the dropdown for each Ranker subtab that should use the exception, and then click Save. Configure Ranker reports to use the permission contexts you created.
  6. Update user records to grant the extra data access.

    For most implementations you will use AutoImporter to import user data you receive from the company periodically. If you were to to update user records manually to use the new permission context, those manual changes might be overwritten by the next import of user data. Instead, work with your company representative to update the user file they send you to include a new column for the permission context, and update your AutoImporter to use that column. For example, the following sample code in AutoImporter adds the permission context called Ranker Permission to the Store Manager role, and allows those users to see data for the sirius_master_unit_type_store segment.

    // ADD RANKER PERMISSION CONTEXT
    permission('Store Manager','Ranker Permission', 'sirius_master_unit_type_store', CHECK_USER_HAS_ROLE);

    For more information about importing data, see Importing. For information about using Auto Importer to set permissions, see Setting access permissions with Auto Importer. If you need assistance configuring your import, contact your Medallia Expert Services lead.

Selecting which fields are searchable in reports

By default, Experience Cloud includes a Searchable Fields (completed surveys) report module defined for all users, with a child report item that makes the Survey ID, Email, and Phone fields searchable in reports. Searchable fields are set globally for all reports in your instance, so if you want to add or remove fields from search, modify the provided report module.

  1. Open the Reporting > Reports > Standard Report Modules screen.
  2. Click the child report item under the Searchable Fields (completed surveys) report module included by default.
  3. On the Add/Remove tab of the Selected Fields table, select the fields you want searchable and then click Add.
  4. Click Save.
  5. In the MemberRoles property, select all roles by moving them to the right-side box.

    Select the fields you want searchable in Ranker reports.

  6. Reindex your set of searchable field data:
    1. Open the Reporting > Report Helpers > Lucene screen.
    2. Turn on the Enable TALL_SET for lucene (invitations indexing) property, and then click Save.
    3. Turn on the Confirm property, and then click ReloadFullTextIndex. For more information about using the Lucene report helper, see Lucene.

Configuring click-through from custom reports in Ranker reports

By default, Experience Cloud allows users to click a row in a Ranker report to drill down to more detail about that row in a Satisfaction Table report. However, if you are displaying custom reports in a Ranker report, click-through functionality is not enabled by default on those subtabs. To enable click-through functionality from a Ranker subtab based on a custom report, you must ensure that the XML of your report includes a redirect to another page. For detailed information about custom reports, see Click-through in custom reports.

  1. Open the Reports > Reporting > Advanced Analytics screen.
  2. Select the report being used in a Ranker report.
  3. In the XML box, add a link-headers-to attribute to the unit-split element for data rows, specifying the page that should open when a user clicks a row.

    For example, to redirect to the Satisfaction Table, format the unit-split element as shown in line 14 of the following report:

    <analytics-report hide-empty-rows="true">
    	<axis axis="Questions">
    		<optionbox-filter plugins="UNIT,TIMEPERIOD,MULTI_FILTER,QUESTIONS,CALCULATION"/>
    		<unitdata field="u_bb_functional_area"/>
    		<heading css-class="sample-size" text="Sample Size">
    			<aggregate operation="NUM_SAMPLES"/>
    			<format decimals="0"/>
    		</heading>
    		<questions-dropdown-split/>
    	</axis>
    	<axis axis="Unit Rank">
    		<calculation-dropdown/>
    		<format decimals="2"/>
    		<unit-split link-headers-to="satisfaction_table">
    			<dynamic-sort pagination="true" page-size="10000"/>
    		</unit-split>
    	</axis>
    </analytics-report>

    You can use the following values for the link-headers-to attribute of a unit-split element:

    • responses_filter

    • invitations_filter
    • satisfaction_table
    • satisfation_graph
    • satisfaction_distribution
    • satisfaction_compare
    • ranker
    • profiler_table
    • competitor_overview (Social Rivals)
    • competitor_responses (Social Rival Responses)
    • tag_investigator
    • _self (to link the report back to itself)
    • The label for any saved custom report
    • The name of a Dashboard

  4. Click Save.

Configuring optional Ranker report settings

  1. Open the Reporting > Reports > Ranker Settings screen.
  2. By default, Experience Cloud hides columns that have no data. If you want to override that behavior for Ranker reports, turn on the Disable Column Hiding property.
  3. If you want to include unit data fields in the All Data export in Ranker reports, choose the unit data fields you want included.
  4. Click Save. Configure optional Ranker settings on the Reporting > Reports > Ranker Settings screen.

Configuring which roles can use Ranker reports

When you create a Ranker report you select which roles can use that Ranker by shuttling right roles in the MemberRoles property. However, while that setting grants access to that specific Ranker report, it does not grant access to see Ranker reports in general. You must configure that access separately, as described below.

  1. Open the Company > Users > Roles > Roles screen.
  2. Select a role to receive new capabilities.
  3. In the MemberCaps property, choose one or more of the following capabilities:

    • View Ranker — Allows the role to see the desktop version of Ranker reports.
    • Mobile XP Ranker Module — Allows the role to see the Mobile version of Ranker reports.

    • Ranker All Question Export — Allows the role to export all data in the opened Ranker report, even if the data is not visible due to filtering. Users select the Export > All Data option.
    • Ranker, All Records Visible Columns Export — Allows the role to export data in the opened Ranker report only for the columns currently displayed. Users select the Export > Excel (All Records, Visible Columns) option.

Adding a Ranker report to report navigation

To make a ranker report visible to users you must add it to a subtab in report navigation. For more information,, see Navigation.

  1. Create the Ranker standard report:

    1. Open the Reporting > Reports > Standard Reports screen.

    2. Click New.

    3. For the ReportType property, select PROPERTY_RANKER.

    4. In the MemberRoles property, choose the roles that can use this report by moving them to the right-side box.

      Note that any user role can be assigned only to one Ranker standard report.

    5. Click Save.

  2. Assign the Ranker standard report to a subtab in report navigation, as described in Navigation.

    Note: Users will not see the name of the subtab in report navigation. Instead, the fields you selected in the Ranker report will appear as subtabs. Since the subtab name will not be seen, consider naming it according to the roles that can use the Ranker report, such as RankerTier3Support.

Removing access to legacy Ranker reports

As you migrate away from legacy Ranker reports to the Dashboard Ranking dashboard module in Medallia Alchemy Experience Reporting, consider removing access to the legacy report.

  1. Remove roles from each Ranker system report:
    1. Open the Reporting > Reports > Standard Reports screen.
    2. In the list of reports, select a Ranker report.
    3. Remove all roles from the MemberRoles property, and then save and publish your changes.
  2. Remove role-based permission to legacy Ranker reports:
    1. Open the Company > Users > Roles > Roles screen.
    2. In the list of roles, select a role.
    3. Remove the following permissions from the MemberCaps property, and then click Save:
      • View Ranker
      • Mobile XP Ranker Module
      • Ranker All Question Export
      • Ranker, All Records Visible Columns Export