Free cookie consent management tool by TermsFeed Installing Report Builder [Case Management Studio]
Installing Report Builder


By default, the Report Builder application comes with a separate reporting site that allow users to configure and create their own reports from records and data in the application. The following instructions are recommended steps for incorporating the Report Builder module with the Case Management Base Application.

This guide walks you through the steps for installing and integrating the Report Builder module with Case Management Studio, including:

System prerequisites

  • Appian platform running version 24.1 or higher.
  • A supported web browser.
  • Imported Case Management base application
  • Imported Report Builder module

Step 1: Downloading the software package

The first step in installing the Report Builder module is to download the software package that contains the following files. These files will be used in the remaining setup steps.

  • 01.ReportBuilderv2.0.0.sql

Note that you may have already downloaded and partially installed Report Builder when you installed Case Management Studio. If so, skip to step 4.

To download the software package:

  1. In MyAppian, navigate to the Support tab.
  2. At the top of the page, select DOWNLOADS and then SOLUTIONS.
  3. In the grid, click Appian Case Management Studio.
  4. Under Downloads, click Report Builder and agree to the License Agreement.
  5. Click Report Builder v2.0.0 to download the ZIP file.
  6. Unzip to access the installation files.

Step 2: Deploying plug-ins

The steps for deploying plug-ins differ depending on whether you have an Appian Cloud or a self-managed environment. Before importing the Report Builder module files, you must deploy and configure the plug-ins required for your environment in the target system. To download the necessary plug-ins and deploy them to your environments, follow the steps that match your environment setup.

Appian Cloud environments

To deploy the plug-ins for an Appian Cloud environment:

  1. In the target environment, log in as the deployment user.
  2. Navigate to the Admin Console.
  3. On the left side of the console, click Plug-ins.
  4. Click ADD PLUG-INS.
  5. Search for and click Appian Solutions Plugin.
  6. Click DEPLOY.
  7. Repeat the above steps for each of the following plug-ins:
    • Appian Regular Expression Functions
    • Content Tools
    • Date and Time Utilities
    • Text Cache
    • Zip File Utilities

Self-managed environments

To deploy the plug-ins for a self-managed environment:

  1. Download the following plug-ins directly from the Appian AppMarket:
  2. Follow the Deploying Plug-ins instructions above to deploy the plug-ins.

Step 3: Creating database objects

To create the structure for the database tables, views, and other objects that are a part of the Report Builder module, you need to run a DDL script in your database.

To create the database objects:

  • In your MariaDB business database, import and run the 01.ReportBuilderv2.0.0.sql file downloaded in Step 1.

Step 4: Importing the application

Next, you need to import the application into the target environment.

To import the application:

  1. In the target environment, log in as the deployment user.
  2. Navigate to the Appian Designer.
  3. Click IMPORT.
  4. Click UPLOAD and choose the application file that was downloaded in Step 1.
  5. Click the Include related import customization file checkbox and click UPLOAD. Select the properties file that was downloaded in Step 1.
  6. Click INSPECT to ensure that there will be no complications on import.
    • Note: Inspection could take several minutes and may time out, but import will continue in the background.
  7. Click IMPORT.
    • Note: The import may time out due to file size, but the import will continue in the background.
  8. Review the import results.

Step 5. Configuring user groups and security

There are four security groups in the Report Builder module. Complete the following steps to ensure Appian Case Management users can access and use the Report Builder module:

  1. In Appian Designer, go to the Report Builder application.
  2. Search for and select each Report Builder (SEUR) security group listed below to add the suggested Appian Case Management (CMGT) security group.
  3. Verify users can access Report Builder as expected.
SEUR Security Group CMGT Security Group
SEUR Report Viewers CMGT Case Worker
SEUR Report Managers CMGT Case Manager
SEUR Reporting Group Managers CMGT Case Manager
SEUR Admin CMGT Design Administrators

Next steps

Now that you have installed the Report Builder module, follow the steps in Setting Up the Report Builder to set up Report Builder with Case Management Studio.

Open in Github Built: Fri, May 24, 2024 (06:28:21 PM)

Installing Report Builder