Upgrade Case Management Studio

About upgrades

Upgrading Case Management Studio can provide access to new capabilities that may help streamline your case management implementations.

This page describes how to upgrade Appian Case Management Studio. With this guide, you'll understand why upgrades are important, how to prepare for a smooth upgrade, and how to import the newest version of the application while minimizing the impact on your existing customizations.

This upgrade guide provides instructions on upgrading to version 2.3.0 from version 2.2.0. For previous upgrade guidance, see version 2.0.0/2.0.1/2.1.0.

Why upgrade?

Upgrades are essential for your Appian environment to receive new functionality, performance enhancements, and important maintenance. Appian releases platform updates monthly, which include new features you may choose to implement in your applications.

Case Management Studio is built on, but separate from, the Appian platform. Therefore, updates for the Case Management Studio application and modules happen separately and at different intervals.

You'll continue to get value out of Case Management Studio apps no matter what version you're on. But, we encourage you to upgrade your apps and modules, allowing you to enhance and streamline your case management processes with the latest Appian functionality.

Case Management Studio functionality delivered each release is documented in the corresponding platform release notes.

Case Management Studio architecture

Case Management Studio comprises several parts, each of which has unique considerations and upgrade paths:

Configure best practices

We encourage you to configure and customize Case Management Studio. In addition to configuring case types in the Control Panel, you're encouraged to configure and extend Case Management Studio via Appian Designer to meet the specific needs of your organization. To help ensure those configurations don't interfere with future upgrades, we encourage you to refer to the following best practices.

We recommend that you:

• Track object changes so it's easier to understand what changes need to be merged into the upgraded Case Management Studio application.
• Limit configurations to core Case Management Studio objects, and employ modularity in making those customizations. Modular design patterns keep specific, often basic, functionality or interfaces in individual objects, which are then referenced in other objects throughout your application.
  • For example, isolate configurations to individual interfaces or subprocesses to make these objects easier to manage and merge during upgrades. Instead of directly adding configurations to a core process model, create a subprocess to do this so that it can be easily merged back into an upgraded process model.

Modules and upgrades

Modules are distinct application containers containing functionality not every Case Management Studio implementation may need. Modules extend Case Management Studio in areas such as AI, productivity, and user experience.

Modules allow you to install only what you need, making it easier to manage and maintain your Case Management Studio application. Modules can be installed and set up with a customized Case Management Studio base application since they contain brand new objects, reducing the impacts of merge conflicts on install. Always verify a module's prerequisites (such as platform version, base version, and plug-ins) before attempting to install it.

Inspect customized objects

When you upgrade a customized Appian application, such as Case Management Studio, you'll observe and need to resolve design object conflicts. Object conflicts occur when the same design object has been changed in both Appian's new version of Case Management Studio and your customized application.

When you import a newer version of Case Management Studio, proceed carefully addressing changes within conflicting objects. View the object's version history and recommendations for addressing conflicts. You may also have to migrate data to support updated data models.

Roles and responsibilities

You may need to work with various teammates to upgrade Case Management Studio, based on the areas you're upgrading and who is best qualified for the task.

The following table is an overview of who is responsible for upgrading the application. Reference the solutions support policy for the latest details on upgrade ownership.

Upgrade Case Management Studio

This section provides a detailed, step-by-step guide to upgrading Case Management Studio. Many of these steps are similar to those in the installation guide, but are provided here for convenience and clarity.

Case Management Studio low-code applications are like any other application: all deployment features are available to support upgrades.

For guidance on upgrading the Appian platform or Appian plug-ins, refer to the solutions support policy. New modules can be easily added via the module's installation and setup instructions.

We'll use the following terminology in the instructions:

• Source application - the original, unmodified version of Case Management Studio you are upgrading from. If you don't have an environment with the source application installed, contact Appian support.
• Target application - the version of Case Management Studio you are upgrading to.
• Custom application - your modified Case Management Studio application.

Before you begin

In version 2.2 and higher, there are two versions of the Case Management Studio base app:

• Case Management Studio - With AI 2.3.0: This version has all of the AI modules for Case Management Studio pre-integrated into the app.
• Case Management Studio 2.3.0: This version does not include AI modules. Use this version if your organization does not allow for AI usage.

Each version has distinct delta packages to make your upgrades easier.

The requirements and steps in the system requirements, verify the Appian version and database type, and enable custom properties sections are the same for both versions.

System requirements

This section details the minimum requirements your system must meet to run Case Management Studio.

• Appian platform running version 26.3 or higher.
• A supported relational database management systems (RDBMS) as a business data source.
  • Note: Case Management Studio provides DDL scripts specifically for MariaDB databases. Step 2 details instructions for MariaDB. If you're using another supported relational database, you must convert the provided MariaDB scripts to match your database's syntax requirements.
• A supported web browser.
• Imported Case Management Studio Base application version 2.2.0.
  • If your current version is not 2.2.0, see the previous upgrade guidance for version 2.0.0/2.0.1/2.1.0.

To check which version of Case Management Studio is used on your environment:

1. In Designer, find and open the CMGT_VRS_CASE_MANAGEMENT_BASE_APPLICATION constant.
2. Check the version listed in the Value field.

Verify the Appian version and database type

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

Enable custom properties

Before installing Case Management Studio, self-managed customers need to add the following .spec.customProperties fields to the Appian CR configuration file:

1
2
3
4
spec:
  customProperties:
    appian.feature.ae.studio.control-panel: "true"
    appian.feature.ae.studio.control-panel.record-hierarchy-metadata: "true"

Once you've added these properties, restart the app server. While the server is restarting, go ahead and start your installation process.

Upgrade the base app with AI modules

This version of the Case Management Studio app v2.3 has all of the AI modules for Case Management Studio pre-integrated into the app.

This means that the following AI modules are integrated into the app and will be included in the delta packages. They do not need to be upgraded or setup individually:

• AI Smart Search module
• Case Comments Summary module
• Case Document Summary module
• Case Record Chat module

Step 1 with AI: Download the software package

To download the software package with AI if the primary locale for your environment is English (US):

1. In MyAppian, navigate to the Support tab.
2. Select DOWNLOADS and then SOLUTIONS.
3. In the grid, click Case Management Studio 2.3.
4. Under Downloads, click Delta Package (with AI) CMS 2.2 to 2.3 and agree to the License Agreement.
5. Click Delta Package (with AI) CMS 2.2 to 2.3 to download the ZIP file.
6. Unzip CaseManagementStudioWithAI-2.3.0 - Delta Package to access the installation files.
7. Continue on with step 2.

To download the software package with AI if the primary locale for your environment is not English (US):

1. Open MyAppian.
2. Click SUPPORT.
3. Click DOWNLOADS.
4. Click SOLUTIONS.
5. Under Available Solutions, select Case Management Studio 2.3.
6. In the grid, click Case Management Studio 2.3.
7. Under Downloads, click Delta Package (with AI) CMS 2.2 to 2.3 and agree to the License Agreement.
8. Select the appropriate primary locale for your environment.
9. Click Delta Package (with AI) CMS 2.2 to 2.3 to download the ZIP file.
10. Unzip CaseManagementStudioWithAI-2.3.0 - Delta Package to access the installation files.
11. Continue on with step 2.

Step 2 with AI: Create database objects

To create the structure for the database tables, views, and other objects, you need to import and run the CaseManagementStudiov2.3.0.sql DDL script downloaded in Step 1 in your MariaDB business database.

For use with other supported database versions, you will need to modify the script to work with your database syntax.

To create the database objects:

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

   • 01.CaseManagementWithAIv2.3.0.sql
   • 02.CaseManagementWithAIv2.3.0.sql
   • 03.CaseManagementWithAIv2.3.0.sql
   • 04.CaseManagementWithAIv2.3.0.sql

Step 3 with AI: Import the application

Next, you need to import Case Management Studio with AI into the target environment.

To import it:

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 CaseManagementWithAIv2.3.0.zip file downloaded in Step 1.
5. Click the Include related import customization file checkbox and click UPLOAD.
6. Select the CaseManagementWithAIv2.3.0.properties file that was downloaded in Step 1.

7. Click INSPECT and IMPORT. For importing the target application or delta package on an environment with the custom application installed, this will help you understand the differences between your modified Case Management Studio version and the more recent version of Case Management Studio. The statuses may be useful in the next step. The inspect page lists design objects with a corresponding status:

   Status	What this means	Risk of overwrite?	Suggested action
   Not Changed	Both you and Appian haven't modified these objects in the target application. These objects will be skipped on import.	No	Import
   New	These objects are entirely new in the target application.	No	Import and review these objects to determine if you'd like to customize them.
   Changed	Appian has modified these objects in the target application, and they do not match the objects in the source application. However, you haven't modified these objects.	No	Import and review these objects to determine if you'd like to customize them.
   Conflict Detected	Appian may have modified these objects in the target application, and they may not match the objects in the source application. Additionally, you have modified the objects in your customized application.	Yes	For each object showing this status, import, then reconcile the product changes with your modifications.

8. Run any process models necessary for upgrade, including the one-time process model for creating detailed document summaries for existing documents.
9. Do any option setup steps, such as the setup for more streamlined task completion and the setup to adjust similarity scores.

Run one-time process model for detailed document summaries

In version 2.3, the AI Smart Search module searches on document summaries. To use this capability, run the following one-time process model that will create detailed summaries for your existing case documents.

To run the one-time process model:

1. In the target environment, navigate to Appian Designer.
2. Find and open the CMGT Add On - Case Document Summary Application.
3. Search for and open the CMGT_DOC_AI_OTP_BackFillDocumentSummary process model.
4. In the process model, click File.
5. Select Start Process for Debugging to run the process model.
6. Go to the Monitor view and confirm that all processes related to the CMGT_DOC_AI_CaseDocumentSummary_Update process are successfully completed.

Upgrade the base app without AI modules

This version of the Case Management Studio base app v2.3 does not include AI modules and should be used for organizations that cannot use AI.

Step 1: Download the software package

To download the software package if the primary locale for your environment is English (US):

1. In MyAppian, navigate to the Support tab.
2. Select DOWNLOADS and then SOLUTIONS.
3. In the grid, click Case Management Studio 2.3.
4. Under Downloads, click Delta Package CMS 2.2 to 2.3 and agree to the License Agreement.
5. Click Delta Package CMS 2.2 to 2.3 to download the ZIP file.
6. Unzip CaseManagementStudio-2.3.0 - Delta Package to access the installation files.
7. Continue on with step 2.

To download the software package if the primary locale for your environment is not English (US):

1. Open MyAppian.
2. Click SUPPORT.
3. Click DOWNLOADS.
4. Click SOLUTIONS.
5. Under Available Solutions, select Case Management Studio 2.3.
6. In the grid, click Case Management Studio 2.3.
7. Under Downloads, click Delta Package CMS 2.2 to 2.3 and agree to the License Agreement.
8. Select the appropriate primary locale for your environment.
9. Click Delta Package CMS 2.2 to 2.3 to download the ZIP file.
10. Unzip CaseManagementStudio-2.3.0 - Delta Package to access the installation files.
11. Continue on with step 2.

Step 2: Create database objects

To create the structure for the database tables, views, and other objects, you need to import and run the CaseManagementStudiov2.3.0.sql DDL script downloaded in Step 1 in your MariaDB business database.

For use with other supported database versions, you will need to modify the script to work with your database syntax.

To create the database objects:

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

   • 01.CaseManagementStudiov2.3.0.sql

Step 3: Import the application

Next, you need to import Case Management Studio into the target environment.

To import it:

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 CaseManagementStudiov2.3.0 file downloaded in Step 1.
5. Click the Include related import customization file checkbox and click UPLOAD.
6. Select the CaseManagementStudiov2.3.0.properties file that was downloaded in Step 1.

7. Click INSPECT and IMPORT. For importing the target application or delta package on an environment with the custom application installed, this will help you understand the differences between your modified Case Management Studio version and the more recent version of Case Management Studio. The statuses may be useful in the next step. The inspect page lists design objects with a corresponding status:

   Status	What this means	Risk of overwrite?	Suggested action
   Not Changed	Both you and Appian haven't modified these objects in the target application. These objects will be skipped on import.	No	Import
   New	These objects are entirely new in the target application.	No	Import and review these objects to determine if you'd like to customize them.
   Changed	Appian has modified these objects in the target application, and they do not match the objects in the source application. However, you haven't modified these objects.	No	Import and review these objects to determine if you'd like to customize them.
   Conflict Detected	Appian may have modified these objects in the target application, and they may not match the objects in the source application. Additionally, you have modified the objects in your customized application.	Yes	For each object showing this status, import, then reconcile the product changes with your modifications.

8. Do the optional setup for more streamlined task completion.

Optional setup for task completion

For steps on the option setup for streamlined task completion, see the Install Guide.

Feedback