Introduction

Case Management Studio Base is a pre-built application container with common case management functionality, including a case workspace, case, entity, task records, configurable workflows, conditional tasking, workflow visualization, auditing and reporting, and so much more.

Case Management Studio is built on the Appian low-code platform with a modular design, with both in-app and extendable design modules to ensure that it meets your needs. Case Management Studio for Public Sector has two modules with pre-built features that are easily configurable and allow you to expand your app functionality quickly.

This guide provides instructions for installing Case Management Studio using the following steps:

1. Downloading the software package.
2. Deploying the application plug-ins.
3. Creating the database objects.
4. Importing the application.
5. Setting up groups.

This page also provides instructions for translating Studio and extending your Case Management Studio for Public Sector application by incorporating one or more of the modules that ship with it.

Before proceeding with the installation steps outlined in this guide, review the System Requirements to ensure your system environment meets all minimum requirements.

System requirements

• Appian platform running version 24.1 or greater.
• A supported version of MariaDB as a business data source.
  • Note: Instructions below are for MariaDB databases. For use with other databases, the SQL script used in Step 3 will need to be modified.
• A supported web browser.

Verify the Appian version and database type

Click About Appian from the navigation bar to check the platform version and database.

Step 1: Downloading the software package

The first step in installing Case Management Studio for Public Sector is to download the Case Management Studio (Base + Studio + Report Builder) software package that contains the following files. These files will be used in the remaining setup steps.

• 01.CaseManagementStudiov1.3.0.sql: SQL script for creating the database objects needed for the Appian Case Management Base application.
• 02.StudioModule2.0.0.sql: SQL script for creating the database objects needed for the Studio application.
• 03.ReportBuilderv3.0.0.sql: SQL script for creating the database objects needed for the Report Builder application.
• CaseManagementStudiov1.3.0.zip: Application package to import into Appian.
• CaseManagementStudiov1.3.0.properties: Import customization file needed for the Report Builder application.

To download the software package:

1. In MyAppian, navigate to the SUPPORT tab.
2. Select DOWNLOADS and then SOLUTIONS.
3. In the grid, click Case Management Studio for platform version 24.1.
4. Under Downloads, click Case Management Studio (Base + Studio + Report Builder) and agree to the License Agreement.
5. Click Case Management Studio to download the ZIP file.
6. Unzip CaseManagementStudiov1.3.0.zip 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 Case Management Studio for Public Sector application 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.
6. Click DEPLOY.

7. Repeat the above steps for each of the following plug-ins:

   • Appian Solutions Component Plugins 1.1.0+
   • Appian Solutions Plugin 1.35.1+
   • Content Tools - 1.1.11+
   • Rich Text Editor Component Plug-In 1.12.1+
   • Regular Expression Functions 2.2.36+
   • Date and Time Utilities 1.3.0+
   • Text Cache 1.1.1+
   • Zip File Utilities 2.1.1+

Self-managed environments

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

1. Download the following plug-ins directly from the Appian AppMarket:
   • Appian Solutions Plug-in
   • Content Tools
   • Appian Solutions Component Plugins
   • Rich Text Editor Component Plug-In
   • Regular Expression Functions
   • Date and Time Utilities
   • Text Cache
   • Zip File Utilities
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 Case Management Studio for Public Sector and Studio, you need to run the following DDL scripts in your database.

To create the database objects:

1. In your MariaDB business database, import and run the following files downloaded in Step 1:

   • 01.CaseManagementStudiov1.3.0.sql
   • 02.01.StudioModule2.0.0.sql
   • 03.ReportBuilderv3.0.0.sql

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 CaseManagementStudiov1.3.0 files downloaded in Step 1.
5. Click the Include related import customization file checkbox and click UPLOAD. Select the CaseManagementStudiov1.3.0.properties file that was downloaded in Step 1.
6. Click INSPECT to ensure that there will be no complications on import.
   • Note: The inspection could take several minutes to complete and may time out. If this occurs, the 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: Setting up groups

Security in the Appian Case Management Studio Base application is defined by two main role groups: Caseworkers and Case Managers. Functionally, these groups have the same access rights to the Workspace application, with the expectation that you may alter group security to meet the needs of specific use cases.

To allow users to access the Case Management Workspace, complete the following steps:

1. From Appian Designer, find the CMGT Case Workers or CMGT Case Managers group.
2. Click Add Members.
3. In the Search field, enter the usernames you want to select and add them to the Users to Add field.
4. After locating all users, click Add.

Next, you need to set up business-level groups, which are used for assigning cases and tasks. Because the use case defines these groups, no business groups are shipped with the application.

To create new business groups, complete the following steps:

1. From Appian Designer, locate and click the CMGT Business Groups.
2. Click New Group.
   • Enter a name for the new business group (For example, Finance).
   • Add group members.
   • Set group Visibility to Public.
3. Click Create.
4. Repeat these steps until you create all the necessary business groups.

Finally, as an optional step, you can add users to the following security groups with access to the Studio site out of the box.

• CMGT Design Administrators
• CMGT Case Managers

Step 6: Translating Studio

This is an optional step. Refer to Exporting translation strings for translation for information on translating Studio to other languages.

Step 7: Extending Case Management Studio

Now that Case Management Studio for Public Sector has been successfully installed, you can extend its feature capabilities by choosing to install any of these optional modules:

• Portal Module: Portal site that allows unauthenticated users access to create cases, check case statuses, and learn more about your organization.

• Report Builder Module: Allows users to create reports and dashboards using the data in an application.

  • Note: If you already installed Report Builder as part of the Case Management Studio Base application, follow the instructions in Setting Up the Report Builder to complete the set-up steps and begin using it with Case Management Studio.