Standard Report Modules

Reporting > Reports > Standard Report Modules

Use the Standard Report Modules screen to configure the report modules users see in system reports such as Satisfaction, Profiler, Ranker, and so on. Each module you define is composed of a single parent node (sometimes called a report kind), and 1 or more child nodes (report items). The parent-child structure of report modules and report items gives you flexibility when designing system reports, since you can define several report modules of the same type, assigning each to different roles. You can then create their child report items to show the fields appropriate for those roles. Depending on which user logs in, their report shows only the fields they need.

Warning: Before working in the Standard Report Modules screen, be sure that you have created all of the fields you need in your instance, and that you have some actual data so you can see how your reports appear.

On the main Standard Report Modules screen use the list to browse configured report modules and report items. Select a type of report module in the Filter by Kind/Workspace dropdown to see only the report modules of that type. Below the list, use the following buttons:

New Standard Report Module — Creates a new parent report module.
New Report Item — Creates a new child report item under the selected report module.
Create all missing — Creates all report modules as a way to automatically generate an initial set of reports. Because this creates all reports you will have to review each report module and report item, and update them appropriately. Use this option only for new instances with no existing configuration.
Copy Existing Standard Report Module — Creates a copy of the selected report module. Use this when you need multiple report modules with minimal differences. For example, you might need slightly different fields displayed for different roles.
Delete — Deletes the selected report module or report item. If you delete a report module, all of its report items are also deleted.

Parent report module configuration

A parent report module defines which user roles have access to see the module.

Properties for a new report module on the Standard Report Modules screen

Name

With most report modules you can enter a name that matches the module type. However, the name for the following report modules appear in reports, so consider entering a more user-friendly name.

Responses Form Profile section
Satisfaction (Sat., Score Filter)
Responses Form Problem section
Comment fields

Kind

The type of report module. This determines which system reports can show the module, as described in Report module reference, below.

Create skeleton

If checked, this property creates a new blank child report item automatically when you save a new report module.

Priority

The order in which the report module is listed on the Standard Report Modules screen, with lower numbers being listed before higher numbers.

Description

A description of the report module. Use the description to enter notes for yourself and other administrators.

RIPriority

Note: Do not use this property, which will be deprecated.

Show heading for each section

When turned on, this property shows group headings (the Name you give each report item) on the report. This is used mainly to show headers for Satisfaction Sat., Score Filter, Resp. Form child report items in reports.

Show headings in Score Filter

When turned on, this property causes the Score Filter dropdown in the Control Panel to be hierarchical, showing the parent for each group.

Prefix Parent Text (Action Planner)

When turned on, this property adds the abbreviated name of its parent as a prefix to each driver in the Action Planner List report. For example, a hotel might have several restaurants and will ask guests to rate some of them. It can be confusing for the user to see "Quality of food & beverage" as a potential candidate for improvement in the report since it could apply to any of the restaurants. The Prefix Parent Text (Action Planner) property clarifies the question by adding the parent name as a prefix, such as "R2 Quality of food & beverage" for restaurant 2. For more information about configuring the Action Planner List report, see Action Planner standard reports.

(BETA) Enable bulk actions on Responses

Note: Do not use this property, which is reserved for future use.

Make all users available for MemberRoles

If turned on, this property instructs Experience Cloud to populate the left-side box of the MemberRoles property with individual users instead of user roles. Because this property can make the Standard Report Modules page load slowly, do not use this property if you have many users in your implementation.

MemberRoles

The user roles you move to the right-side box have permission to use this report module. Note that the left-side box is not populated until after the initial save, based on whether you turned on the Make all users available for MemberRoles property.

MemberHideForSurveyMethods

Hides the report module from Responses Form reports with any of the assigned survey methods. For example, Customer Care implementations use this property to hide the Satisfaction and Problem sections on the Responses Form. You can achieve the same functionality with the HideUnanswered property, which is available for report items.

TranslationExplanation

If you are using translation, enter text to help translators understand the context in which this term appears. You can leave this blank, or explain some of the context if the reporting application will be translated. The text you enter appears on translation screens.

Synchronize items from questions

Do not use this button, which becomes available after you save the report module. It replaces fields you selected in child report items with a set of default values.

Report item configuration

The main purpose of the report item is to define which fields the user sees in the report module. Some report modules need only a single report item. Other report modules can use several report items.

Parent

After creating the report item, this property lists the parent report module.

Name

If you create several report items under the same parent report module, give them descriptive names to help you identify them in the list at a glance.

HideUnanswered

If turned on, this property hides rows with no data on reports.

TextFormat

When turned on, for Yes/No questions in the Problem section of the Responses Form report, this property makes the question label appear instead of the customer's response to the question. Use this property to display the questions to which a customer answered "Yes", as in the case of a choose-many question.

RIHeaderCode

Displays additional text in reports to help you provide context for the data being shown. This property is used differently by various report modules, as follows:

For the Comment fields report module you can enter plain text only. It appears as bold and left-aligned.
For the Satisfaction (Sat., Score Filter) report module, use the syntax explained below. By default, the header is center-aligned.

To adjust the font and alignment, you can use additional syntax. In that case, begin with your header text, followed by a code for how many columns the header spans, followed by an alignment character. If you omit either the span code or the alignment character, the report module's default setting is used.

For the span code, use # followed by a number, which defines how many columns of displayed data the header spans. Experiment with different span settings, because depending on the data displayed and the length of your header text, data columns might be compressed or expanded based on the span setting of the header. Additionally, #1 results defines a bold, sentence-case header, while # followed by any other number defines a grey, all-caps header.
For the alignment character, use < for left-aligned, or > for right-aligned.
You can insert pipe characters (|) as dividers to help control alignment relative to the displayed field names and their values.

For example if you enter Drivers#1<| the header appears as in the following image: RIHeaderCode of Drivers#1<|

If you enter |Drivers#1< the header appears as in the following image: RIHeaderCode of |Drivers#1<

If you enter |Extremely Satisfied#5<|Extremely Dissatisfied#5> the header appears s in the following image: RIHeaderCode of |Extremely Satisfied#5<|Extremely Dissatisfied#5>

Priority

The order in which the report item is listed on the Standard Report Modules screen, relative to its sibling report items, with lower numbers being listed before higher numbers.

DisplayFormat

This property applies only to report items in Responses Form Profile section report modules, and determines how to display enumeration sets. Select one of the following options:

SINGLE_VALUE—Shows only the response from the survey respondent. For example:
TABULAR—Shows all values, with the response from the survey respondent highlighted. For example:

SelectedFields

Use the Add/Remove tab to select the fields you want displayed as part of this report item. After you select the fields you need, use the Sort tab to order them as you want them to appear. For reports that display fields left-to-right (for example, as columns in a table), fields are listed left-to-right as they are sorted top-to-bottom on the Sort tab.

TranslationExplanation

Report module reference


Name	Kind ID	Notes
Action Planner Driver fields	PLANNER_IMPROVEMENT_AREA	This determines what fields are used as drivers for key outcome fields in Action Planner reports. Create one child report item that includes all of the fields you wan to use as drivers. For more information, see Action Planner standard reports.
Action Planner Outcome field	PLANNER_IMPACT	This determines what key outcomes are listed in Action Planner reports. You can create multiple child report items, with one key outcome field per report item. For more information, see Action Planner standard reports.
Ask Now (Satisfaction, Responses Form, Segment Distribution Over Time)	ASK_NOW	This report module makes Ask Now feedback accessible from Satisfaction, Responses Form, and Segment Distribution Over Time reports. For more information, see Ask Now.
Comment Fields	COMMENT_REPORT	The comment fields you add using this report module appear in the Customer Comments column of the Responses List report, and as rows in the Comments section of the Responses Form report. It also makes those fields available to be searched by the Search field in the Control Panel. Add all of your comment fields in a single report item. For more information, see Responses reports.
Dashboard Ques. Dropdown (Ranker Snapshot)	RANKER_SNAPSHOT_REPORT	This report kind overrides the Question Group dropdown for Ranker Snapshot Dashboard modules.
Invitations Ranker Questions Dropdown	IM_RANKER	This determines which question fields appear in the Question Group dropdown in the Control Panel for Invitations Ranker reports. You can create multiple child report items, one for each group of question fields. For more information, see Invitation Ranker reports.
Questions Dropdown (Analytics)	QUESTIONS_DROPDOWN_ANALYTICS	For custom reports that include `QUESTIONS_ANALYTICS` in the `plugins` attribute of the `optionbox-filters` element, this module determines which question fields appear in the Question Group dropdown in the Control Panel. You can create multiple child report items, one for each group of question fields. For more information about building custom reports, see Custom reports.
Responses Form customer name	RI_CUSTOMER_NAME	This determines what field is used to identify the customer on Responses Form reports. Use only one field. For more information, see Responses report.
Responses Form Personal section	RI_PERSONAL_INFORMATION	This determines what fields are displayed in the Personal section of Responses Form reports. For more information, see Responses report.
Responses Form Problem section	RI_PROBLEM_REPORT	This determines what fields are displayed in the Problem section of Responses Form reports. For more information, see Responses report.
Responses Form Profile section	RI_PROFILE_REPORT	This determines what fields are displayed in the Profile section of Responses Form reports. Add a report item for each group of fields you want to display. For more information, see Responses report.
Responses Form Respond email	RI_RAPID_RESPONSE_EMAIL	This enables you to use a field other than `e_email` for the customer's email address for Rapid Responses. That field must have an EMAIL ContentKind for its alternative set.
Responses Form survey score	SURVEY_SCORE	The Customer section on Responses Form reports includes a score for the feedback submitted by that customer. This report module determines what field is used to populate that score. Use only one field. That field must have an ENUMERATED ContentKind for its alternative set. The BoxColor property of each alternative set value determines the color of the number. For more information, see Responses report.
Responses Form survey subject	RI_SURVEY_SUBJECT	This module adds a subject (typically the unit or survey type) to Responses reports. It affects reports differently, depending on the app used to view responses. In Medallia Voices, the module adds a survey subject to the bottom-right of the screen. In the Mobile app, it adds a survey subject below the survey-taker's name. In the Web app, it adds a new section to the Responses Form report.
Satisfaction (Sat., Score Filter)	STANDARD_REPORT	This report module defines the fields that appear in Satisfaction Table reports and in the Satisfaction section of Responses Form reports. It also determines what fields are available in the Score Filter dropdown in the Control Panel for Responses List reports. Use one report item for each group of question fields you want to display. For more information, see Satisfaction reports and Responses report.
Searchable fields (completed surveys)	SEARCHABLE_FIELDS	This determines what fields are searchable by the Search field in the Control Panel on most reports (excluding Invitations reports). Your instance can include only one of this report module, and you must select all roles for its MemberRoles property. For more information, see: Profiler reports Ranker reports Responses report Satisfaction reports Note: After adding searchable fields, you must refresh the list of searchable fields before they are actually available in searches. For more information, see Lucene.
Searchable fields (invitations)	SEARCHABLE_TALLSET_FIELDS	This determines what fields are searchable by the Search field in the Control Panel on Invitation reports. Your instance can include only one of this report module, and you must select all roles for its MemberRoles property.