Install My Cases Module

Introduction

The My Cases module ships as a separate module supported on Case Management Studio 24.2 and higher. Once installed and set up, this module allows authenticated users to submit cases, message case workers, and attach additional documents throughout the case lifecycle.

This guide outlines the steps for downloading and installing the My Cases module before incorporating it with your Appian Case Management Studio Base application. The steps include:

• Download the software package.
• Create the database objects in the business data source.
• Import the application into the Appian environment.

Before starting the installation process, review the System Requirements to ensure all minimum requirements are met.

System requirements

This section details the minimum requirements your system must meet to run the My Cases module.

• Appian version 24.2 or greater.
• A supported version of MariaDB as a business data source.
• A supported web browser.
• Imported Case Management Studio Base application version 1.4 or higher, which includes the following application containers:
  • CMGT Case Management Studio Base (CMGT)
  • CMGT Studio Module (CMGT_WFL)
  • CMGT Studio Generated Objects (CMGT)

Step 1: Download the software package

To install My Cases, you'll need to download the software package containing the following files, which you will use in the remaining set-up steps.

• 01.MyCasesModulev1.0.0.sql: SQL script for creating the database objects needed for the My Cases application.
• MyCasesModulev1.0.0.zip: The application package to be imported into Appian.

To download the software package:

1. In My Appian, navigate to the SUPPORT tab.
2. Click DOWNLOADS > SOLUTIONS.
3. In the grid, find and click Case Management Studio.
4. Under Downloads, click My Cases and agree to the License Agreement.
5. Click My Cases to download the ZIP file.
6. Unzip MyCasesModulev1.0.0.zip to access the software installation files.

Step 2: Create database objects

To create the structure for the database tables, views, and other objects that are a part of the My Cases module in your MariaDB business database, you need to run the 01.MyCasesModulev1.0.0.sql DDL script downloaded in Step 1.

in your MariaDB business database,

Step 3: Import the application

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

To import the My Cases 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 MyCasesModulev1.0.0.zip file downloaded in Step 1.
5. 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.
6. Click IMPORT.
   • Note: The import may time out due to file size. If this occurs, the import will continue in the background.
7. Review the import results to verify the following CMGT Add-On - My Cases Module (CMGT_LA) application container was imported.

Next steps

Now that you have installed the My Cases module, follow the steps in Setting Up My Cases to start using this functionality with Case Management Studio.

Feedback