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 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 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:
This page also provides instructions on extending Case Management Studio with modules 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.
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.
This section details the minimum requirements your system must meet to run the Case Management Studio.
Click About Appian from the navigation bar to check the platform version and database.
Before installing Case Management Studio, self-managed customers need to enable two custom properties in the custom properties file before restarting the app server.
To do this:
<APPIAN_HOME>/conf/
.Set the value of the appian.feature.solutions-api.enabled
property to true
.
appian.feature.solutions-api.enabled=true
.Set the value of the appian.feature.solutions-api.cmStudio.enabled
property to true
.
appian.feature.solutions-api.cmStudio.enabled=true
.Once you've enabled these properties, restart the app server. For instructions on restarting the app server, see Starting and Stopping Appian. While the server is restarting, go ahead and start your installation process.
To download the software package if the primary locale for your environment is not English (US):
The first step in installing Case Management Studio 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.4.0.sql
: SQL script for creating the database objects needed for the Appian Case Management Base application.02.CaseManagementStudiov1.4.0.sql
: SQL script for creating the database objects needed for the Studio application.03.CaseManagementStudiov1.4.0.sql
: SQL script for creating the database objects needed for the Report Builder application.CaseManagementStudiov1.4.0.zip
: Application package to import into Appian.CaseManagementStudiov1.4.0.properties
: Import customization file needed for the Report Builder application.To download the software package if the primary locale for your environment is English (US):
CaseManagementStudiov1.4.0.zip
to access the installation filesThe 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.
To deploy the plug-ins for an Appian Cloud environment:
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+
Appian Regular Expression Functions
Date and Time Utilities
Text Cache
Zip File Utilities
To deploy the plug-ins for a self-managed environment:
To create the structure for the database tables, views, and other objects that are a part of Case Management Studio, you need to run the following DDL scripts in your database.
To create the database objects:
In your MariaDB business database, import and run the following files downloaded in Step 1:
01.CaseManagementStudiov1.4.0.sql
02.CaseManagementStudiov1.4.0.sql
03.CaseManagementStudiov1.4.0.sql
Next, you need to import Case Management Studio into the target environment.
To import it:
CaseManagementStudiov1.4.0
file downloaded in Step 1.CaseManagementStudiov1.4.0.properties
file that was downloaded in Step 1.Security in Case Management Studio 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:
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:
Finally, as an optional step, you can add users to the following security groups with access to the Studio site out of the box.
Now that you've successfully installed Case Management Studio, you can extend its feature capabilities by installing the Portal Module or finishing setup of the Report Builder Module, which was downloaded in Step 1.
Installing Case Management Studio for Self-Managed Customers