Install Case Management Studio for Self-Managed Customers

Introduction

Case Management Studio is a suite of applications with pre-built functionality, including a case workspace, case, entity, task records, configurable workflows, conditional tasking, workflow visualization, auditing, and so much more.

Case Management Studio is built on the Appian process automation platform with a modular design, with both in-app and extendable design frameworks to ensure that it meets your needs. Case Management Studio ships with modules that include pre-built features that are easily configurable and allow you to quickly expand your app functionality.

Case Management Studio is available out-of-the-box with the Appian platform for Appian Cloud and self-managed customers. Case Management Studio comes pre-installed in new cloud sites with English (US) as the primary locale, and can be installed by Support upon request in existing cloud sites for first time installs. For Appian Cloud customers with Case Management Studio already installed, the steps on this page are not needed.

For self-managed customers, Case Management Studio must be installed 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.

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

If you're upgrading Case Management Studio instead of downloading for the first time, follow the steps in our Case Management Studio Upgrade Guide.

Before you begin

Before you being downloading and installing Case Management Studio, be sure to check the system requirements and verify your Appian version and database type. Self-managed customers also need to enable two custom properties and restart the app server.

In versions 2.2 and higher, there are two versions of the Case Management Studio base app that you can install:

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

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

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.

Install 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 come installed and integrated into the app. They do not need to be installed or setup individually:

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

Step 1 with AI: Downloading 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 Case Management Studio - With AI 2.3.0 and agree to the License Agreement.
5. Click Case Management Studio With AI 2.3.0 to download the ZIP file.
6. Unzip CaseManagementStudioWithAIv2.3.0 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.0.
6. Under Downloads, click Case Management Studio - With AI 2.3.0 and agree to the License Agreement.
7. Select the appropriate primary locale for your environment.
8. Click Case Management Studio With AI 2.3.0 to download and finish.
9. Unzip the CaseManagementStudioWithAIv2.3.0 ZIP file to access the installation files.
10. Continue on with step 2.

The following files from the content you just downloaded will be used in the remaining setup steps:

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

Step 2 with AI: 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 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
   • Appian Solutions Plugin
   • Content Tools
   • Appian Regular Expression Functions
   • Date and Time 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:
   • Appian Solutions Plug-in
   • Appian Solutions Component Plugins
   • Content Tools
   • Date and Time Utilities
   • Regular Expression Functions
2. Follow the Deploying Plug-ins instructions above to deploy the plug-ins.

Step 3 with AI: Creating 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 4 with AI: Importing 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 CaseManagementStudioWithAIv2.3.0.zip file downloaded in Step 1.
5. Click the Include related import customization file checkbox.
6. Click UPLOAD and select the CaseManagementStudioWithAIv2.3.0.properties file that was downloaded in Step 1.
7. 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.
8. Click IMPORT.
   • Note: The import may time out due to file size, but the import will continue in the background.
9. Review the import results to confirm the following Case Management Studio application containers were imported:
   • CMGT Case Management Studio Base (CMGT)
   • CMGT Control Panel Generated Objects (CMGT)
   • CMGT Add-On - Smart Search Module (CMGT_SMS_AI)
   • CMGT Add-On - Case Comments Summary (CMGT_CMT_AI)
   • CMGT Add On - Case Document Summary (CMGT_DOC_AI)
   • CMGT Add-On - Case Record Chat Module (CMGT_RC_AI)

Step 5 with AI: Setting up groups

Security in Case Management Studio is defined by two main role groups: Case Workers and Case Managers. Functionally, these groups have the same access rights to the Workspace site, 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 Studio Workspace site, 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 the Control Panel out-of-the-box.

• CMGT Design Administrators
• CMGT Case Managers

Optional setup for task completion in AI version

In versions 2.2 and higher, we changed how tasks get marked as "not needed" on the path that wasn't chosen in workflows. Instead of happening right away, this now runs during a nightly sync — which makes task transitions faster. You'll find a toggle for this in the task completion flow.

If you're working with a smaller workload, you can turn off that toggle. That way, the cleanup happens right when a task is completed instead of waiting for the nightly sync.

To turn off "nightly sync" setting:

1. In the target environment, navigate to Appian Designer.
2. Open CMGT Case Management Base Application.
3. In the app, search for and open the CMGT_BOL_TOGGLE_RUN_SMART_WORKFLOW_NIGHTLY_SYNC constant.
4. In the constant, set the Value field to False.
5. Click SAVE.

Optional setup to adjust similarity scores for AI Smart Search

In versions 2.2 and higher, we've set the similarity score threshold for the AI Smart Search module to 0.41 — so you'll only see results that score above that. If the results aren't quite what you're looking for, you can tweak the threshold. Raise the similarity score to get more precise matches, or lower it to broaden the range of results.

1. In the target environment, navigate to Appian Designer.
2. Open CMGT Add-On - Smart Search Module Application.
3. Search for and open the CMGT_SMS_AI_DEC_SIMILARITY_SCORE constant.
4. Raise or lower the number in the Value field to adjust the similarity score.
5. Click SAVE.

Install the base app without AI modules

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

Step 1: Downloading 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 Case Management Studio 2.3.0 and agree to the License Agreement.
5. Click Case Management Studio 2.3.0 to download the ZIP file.
6. Unzip CaseManagementStudiov2.3.0.zip 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.0.
6. Under Downloads, click Case Management Studio 2.3.0 and agree to the License Agreement.
7. Select the appropriate primary locale for your environment.
8. Click Case Management Studio 2.3.0 to download and finish.
9. Unzip the Case Management Studio 2.3.0 zip file to access the installation files.
10. Continue on with step 2.

The following files from the content you just downloaded will be used in the remaining setup steps:

• 0.1CaseManagementStudiov2.3.0sql: SQL script for creating the database objects needed for the Appian Case Management Base application.
• CaseManagementStudiov2.3.0.zip: Application package to import into Appian.
• CaseManagementStudiov2.3.0.properties: Import customization file needed to set the nightly sync time.

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 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
   • Appian Solutions Plugin
   • Content Tools
   • Appian Regular Expression Functions
   • Date and Time 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:
   • Appian Solutions Plug-in
   • Appian Solutions Component Plugins
   • Content Tools
   • Date and Time Utilities
   • Regular Expression Functions
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, 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:

   • CaseManagementStudiov2.3.0.sql

Step 4: Importing 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.
6. Click UPLOAD and select the CaseManagementStudiov2.3.0.properties file that was downloaded in Step 1.
7. 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.
8. Click IMPORT.
   • Note: The import may time out due to file size, but the import will continue in the background.
9. Review the import results to confirm the following Case Management Studio application containers were imported:
   • CMGT Case Management Studio Base (CMGT)
   • CMGT Control Panel Generated Objects (CMGT)

Step 5: Setting up groups

Security in Case Management Studio is defined by two main role groups: Case Workers and Case Managers. Functionally, these groups have the same access rights to the Workspace site, 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 Studio Workspace site, 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 the Control Panel out-of-the-box.

• CMGT Design Administrators
• CMGT Case Managers

Optional setup for task completion

In versions 2.2 and higher, we changed how tasks get marked as "not needed" on the path that wasn't chosen in workflows. Instead of happening right away, this now runs during a nightly sync — which makes task transitions faster. You'll find a toggle for this in the task completion flow.

If you're working with a smaller workload, you can turn off that toggle. That way, the cleanup happens right when a task is completed instead of waiting for the nightly sync.

To turn off "nightly sync" setting:

1. In the target environment, navigate to Appian Designer.
2. Open CMGT Case Management Base Application.
3. In the app, search for and open the CMGT_BOL_TOGGLE_RUN_SMART_WORKFLOW_NIGHTLY_SYNC constant.
4. In the constant, set the Value field to False.
5. Click SAVE.

Feedback