Free cookie consent management tool by TermsFeed

Setting Up Report Builder Module

Introduction

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:

Step 1: Importing record schemas

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:

  1. In Appian Designer, navigate to your application.
  2. Click Build, then CREATE PACKAGE.
  3. Under All Objects, click the Record Types filter.
  4. Click the checkbox for each record type you want to enable reporting on in the Report Builder.
  5. Click ADD TO PACKAGE.
  6. Select the package you created, and click ADD.
  7. Once you add all record types to the package you want to report on, select your package and click EXPORT PACKAGE.

To import record schemas:

  1. In Report Builder as an SEUR Admin user, go to Admin Tools.
  2. Click UPLOAD RECORD SCHEMAS.
  3. Click UPLOAD and select the record package you exported.
  4. Click SUBMIT.

Step 2: Configuring record types for reports

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:

  1. In Report Builder as an SEUR Admin user, go to the Admin Tools page.
  2. Click CONFIGURE REPORTING RECORD TYPES.
  3. Click Add Reporting Record.
  4. Select the base record for which you would like to enable business users to create reports.

    • 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_reporting_record_types

  5. Click the Edit icon for the selected record to configure it.
  6. Click the checkbox for each field and related record field you would like to enable users to include in the reports they build on the record type you are configuring.
  7. On the Default tab:

    • Configure the Label and Filter Label attributes for each field as desired.

      configure_reporting_record_type_default

    • Select fields in Grid Report Filters to enable the fields to be added as user filters to grid reports created on the record type.
    • Select record actions and related actions in Actions to enable the actions to be added to raw data grid reports and dashboards.
      • Note: Record actions and related actions can be added to grid reports. Only record actions can be added to dashboards.

  8. 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.

    configure_reporting_record_type_filters

  9. After configuring the record fields, click SAVE.
  10. Click SAVE AND CLOSE.

Step 3: Incorporating the Report Builder page group in the Workspace site

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.

reporting_page_group

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.

report_builder_site_menu

Add the Reporting page group

To add the Report Builder page group to the main Workspace site, complete the following steps:

  1. In Appian Designer, go to the CMGT Case Management Studio Base.
  2. Search for CMGT_WorkspaceSite.
  3. Under Pages, click ADD PAGE GROUP.
  4. Complete the Add Page Group dialog. You may use the values suggested below or write your own.
    • Title: Click Expression and enter translation!Reporting.
    • Web Address Identifier: reporting.
    • Icon: bar-chart.
    • Visibility: Click Only show when… and copy and paste the following code block: 
      1
2
3
4

      a!isUserMemberOfGroup(
   username: loggedInUser(),
   groups: cons!SEUR_GRP_ALL_USERS
)
  5. Click ADD.

Add the Home page

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:

  1. Click + Add Page in the Reporting page group card
  2. Complete the Add Page dialog as follows.
    • Title: Click Expression and enter translation!Home.
    • Web Address Identifier: home.
    • Interface Content: SEUR_HomeTab.
    • Width: Click Full.

    • 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
  }
)

  3. Click ADD.

    seur_home_page_configuration

Add the Dashboards page

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:

  1. Click + Add Page in the Reporting page group card
  2. Complete the Add Page dialog as follows.
    • Title: Click Expression and enter translation!Dashboards.
    • Web Address Identifier: dashboards.
    • Interface Content: SEUR_DashboardsTab.
    • Width: Click Full.

    • 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
  }
)
  3. Click ADD.

Add the Reports page

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:

  1. Click + Add Page in the Reporting page group card
  2. Complete the Add Page dialog as follows.
    • Title: Click Expression and enter translation!Reports.
    • Web Address Identifier: reports.
    • Interface Content: SEUR_ReportsTab.
    • Width: Click Full.

    • 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
  }
)
  3. Click ADD.

Add the User Groups page

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:

  1. Click + Add Page in the Reporting page group card
  2. Complete the Add Page dialog as follows.
    • Title: Click Expression and enter translation!User Groups.
    • Web Address Identifier: user-groups.
    • Interface Content: SEUR_ReportingGroupsTab.
    • Width: Click Full.
    • Visibility: Click Only show when… and copy and paste the following code block:
    1
2
3
4
5
6
7

    a!isUserMemberOfGroup(
  username: loggedInUser(),
  groups: {
    cons!SEUR_GRP_REPORTING_GROUP_MANAGERS,
    cons!SEUR_GRP_ADMIN
  }
)
  3. Click ADD.

Add the Notifications page

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:

  1. Click + Add Page in the Reporting page group card
  2. Complete the Add Page dialog as follows.
    • Title: Click Expression and enter translation!Notifications.
    • Web Address Identifier: notifications.
    • Interface Content: SEUR_Notifications.
    • Width: Click Full.
    • Visibility: Click Only show when… and copy and paste the following code block: 
      1
2
3
4
5
6
7

       a!isUserMemberOfGroup(
    username: loggedInUser(),
    groups: {
      cons!SEUR_GRP_ADMIN,
      cons!SEUR_GRP_REPORT_MANAGERS
    }
 )
  3. Click ADD.

Add the Style Settings page

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:

  1. Click + Add Page in the Reporting page group card
  2. Complete the Add Page dialog as follows.
    • Title: Click Expression and enter translation!Style Settings.
    • Web Address Identifier: style-settings.
    • Interface Content: SEUR_StyleSettings.
    • Width: Click Full.
    • Visibility: Click Only show when… and copy and paste the following code block: 
      1
2
3
4
5
6
7

      a!isUserMemberOfGroup(
   username: loggedInUser(),
   groups: {
     cons!SEUR_GRP_ADMIN,
     cons!SEUR_GRP_REPORT_MANAGERS
   }
)
  3. Click ADD.

Add the Admin Tools page

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:

  1. Click + Add Page in the Reporting page group card
  2. Complete the Add Page dialog as follows.
    • Title: Click Expression and enter translation!Admin Tools.
    • Web Address Identifier: admin-tools.
    • Interface Content: SEUR_AdminTools.
    • Width: Click Full.
    • Visibility: Click Only show when… and copy and paste the following code block: 
      1
2
3
4

      a!isUserMemberOfGroup(
   username: loggedInUser(),
   groups: { cons!SEUR_GRP_ADMIN }
)
  3. Click ADD.

Save the Workspace site object

  1. Click SAVE CHANGES to save the Workspace site.

    cmgt_workspace_site_reporting_page_group

Step 4: Incorporating a quick action in the Reporting page group

workspace_manage_reports_quick_action

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:

  1. In Appian Designer, go to the CMGT Case Management Studio Base.
  2. Create a new expression rule called CMGT_SEUR_QuickLink_ItemMap.
  3. Copy and paste the following code block.

    • 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"
    )
  )
)
  4. Click SAVE CHANGES.
  5. Review the newly created expression rule.
    1. Verify the URL is generated as expected.
    2. Verify the visibility logic.
  6. Confirm the quick action is working as expected.

Step 5: Translating the application

This is an optional step. Refer to Exporting translation strings for translation for information on translating the Report Builder module to other languages.

Feedback