After installing the Report Builder module, you need to set it up before using it with Case Management Studio. This guide walks you through the recommended setup steps, which include:
This is a required step. In order to build reports on data in other applications in the environment using Report Builder, you first need to import record schemas. The following steps need to be completed by a user with administrator access to the applications that will be set up for reporting with Report Builder.
To create and export a record package:
To import record schemas:
This is a required step. Once you import record schemas in Step 1, you must configure each record so business users can create reports.
To configure a reporting record type:
Note: You only select the base record, like Cases, in this step. In subsequent steps, you will select the related records, like Statuses and Case Types, you included when you imported the record schema you want to include and enable in reports on the base record.
Configure the Label and Filter Label attributes for each field as desired.
Navigate to the Filters tab and configure each field's data source for filtering. This step is crucial for text fields and reference data fields so that dropdown filters are provided to end users.
This is an optional step. The following steps will add a REPORTING page group to the Workspace site with all Report Builder pages nested within.
If you do not complete this optional step, users with access to Report Builder will still be able to access Report Builder from the site menu.
To add the Report Builder page group to the main Workspace site, complete the following steps:
translation!Reporting.reporting.bar-chart.1
2
3
4
a!isUserMemberOfGroup(
username: loggedInUser(),
groups: cons!SEUR_GRP_ALL_USERS
)
The Home page is unique to each user and allows them to add up to five important dashboards to their work. In order to add the Home page to the Reporting page group, complete the following steps:
translation!Home.home.SEUR_HomeTab.Visibility: Click Only show when… and copy and paste the following code block:
1
2
3
4
5
6
7
8
a!isUserMemberOfGroup(
username: loggedInUser(),
groups: {
cons!SEUR_GRP_ADMIN,
cons!SEUR_GRP_REPORT_MANAGERS,
cons!SEUR_GRP_REPORT_VIEWERS
}
)
Click ADD.
The Dashboards page provides a grid of all Dashboards created by Report Builder users. To add the Dashboards page to the Reporting page group, complete the following steps:
translation!Dashboards.dashboards.SEUR_DashboardsTab.Visibility: Click Only show when… and copy and paste the following code block:
1
2
3
4
5
6
7
8
a!isUserMemberOfGroup(
username: loggedInUser(),
groups: {
cons!SEUR_GRP_ADMIN,
cons!SEUR_GRP_REPORT_MANAGERS,
cons!SEUR_GRP_REPORT_VIEWERS
}
)
The Reports page provides a grid of all Reports created by Report Builder users. To add the Reports page to the Reporting page group, complete the following steps:
translation!Reports.reports.SEUR_ReportsTab.Visibility: Click Only show when… and copy and paste the following code block:
1
2
3
4
5
6
7
8
a!isUserMemberOfGroup(
username: loggedInUser(),
groups: {
cons!SEUR_GRP_ADMIN,
cons!SEUR_GRP_REPORT_MANAGERS,
cons!SEUR_GRP_REPORT_VIEWERS
}
)
The User Groups page provides a grid of all User Groups created for sharing reports and dashboards created using Report Builder. To add the User Groups page to the Reporting page group, complete the following steps:
translation!User Groups.user-groups.SEUR_ReportingGroupsTab.1
2
3
4
5
6
7
a!isUserMemberOfGroup(
username: loggedInUser(),
groups: {
cons!SEUR_GRP_REPORTING_GROUP_MANAGERS,
cons!SEUR_GRP_ADMIN
}
)
The Notifications page provides a grid of all notifications scheduled that will email reminders to specified Report Builder users to view a specific report or dashboard. To add the Notifications page to the Reporting page group, complete the following steps:
translation!Notifications.notifications.SEUR_Notifications.1
2
3
4
5
6
7
a!isUserMemberOfGroup(
username: loggedInUser(),
groups: {
cons!SEUR_GRP_ADMIN,
cons!SEUR_GRP_REPORT_MANAGERS
}
)
The Style Settings page displays the styling configured in Solutions Hub for Report Builder. To add the Style Settings page to the Reporting page group, complete the following steps:
translation!Style Settings.style-settings.SEUR_StyleSettings.1
2
3
4
5
6
7
a!isUserMemberOfGroup(
username: loggedInUser(),
groups: {
cons!SEUR_GRP_ADMIN,
cons!SEUR_GRP_REPORT_MANAGERS
}
)
The Admin Tools page allows SEUR Admin users to enable Report Builder to build reports on record types in the environment. To add the Admin Tools page to the Reporting page group, complete the following steps:
translation!Admin Tools.admin-tools.SEUR_AdminTools.1
2
3
4
a!isUserMemberOfGroup(
username: loggedInUser(),
groups: { cons!SEUR_GRP_ADMIN }
)
Click SAVE CHANGES to save the Workspace site.
This is an optional step. In order to add a quick action on the Workspace Home page, which takes users to the Reporting page incorporated in Step 3, complete the following steps:
CMGT_SEUR_QuickLink_ItemMap.Note: If you modified the Web Address Identifier value when configuring the Reporting page group, you must also modify the URI in the code block to match it.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
a!map(
icon: "bar-chart",
showWhen: a!isUserMemberOfGroup(loggedInUser(), cons!SEUR_GRP_ALL_USERS),
item: a!richTextDisplayField(
labelPosition: "COLLAPSED",
value: a!richTextItem(
text: if(
a!isUserMemberOfGroup(loggedInUser(), cons!SEUR_GRP_REPORT_MANAGERS),
translation!Manage Reports,
translation!View Reports,
),
link: a!safeLink(
uri: concat(
rule!CMGT_UTIL_GetSiteUrl().authedPath,
"/sites/",
cons!CMGT_TXT_SITE_URL_ADDRESS_IDENTIFIER,
"/group/reporting/page/home"
),
openLinkIn: "NEW_TAB"
),
linkStyle: "STANDALONE"
)
)
)
This is an optional step. Refer to Exporting translation strings for translation for information on translating the Report Builder module to other languages.
