Installing Case Management Studio [Case Management Studio] (2024)

Installing Case Management Studio

Introduction

Appian 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. Appian Case Management Studio is the foundational requirement for building any Appian Case Management solution and extending its capabilities with modules.

This guide covers the installation process for the Appian Case Management Studio Base application, which consists of 5 main 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.

It also provides instructions for extending the CMS base application by incorporating one or more of the modules that ship with CMS.

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 23.4 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 the Appian Case Management Studio Base application is to download the software package that contains the following files. These files will be used in the remaining setup steps.

• 01.CaseManagementStudioBasev1.2.0.sql: SQL script for creating the database objects needed for the Appian Case Management base application.
• CaseManagementStudioBasev1.2.0: Application package to import into Appian.

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 Appian Case Management Studio Base 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
   • Content Tools - 1.9.2+
   • Rich Text

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
2. Follow the Deploying Plug-ins instructions above to deploy the plug-inse.

Step 3: Creating database objects

To create the structure for the database tables, views, and other objects that are a part of the Appian Case Management base application, you need to run a DDL script in your database.

To create the database objects:

• In your MariaDB business database, import and run the 01.CaseManagementStudioBasev1.2.0.sql file downloaded in Step 1.

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 CaseManagementStudioBasev1.2.0 file downloaded in Step 1.
5. Click INSPECT to ensure that there will be no complications on import.
   • Note: Inspection could take several minutes and may time out. The import will continue in the background.
6. Click IMPORT.
   • Note: The import may time out due to file size, but the import will continue in the background.
7. 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.

Step 6: Extending the CMS Base application

Now that the Appian Case Management Studio Base application has been successfully installed, you can extend the feature capabilities of your CMS by choosing to install any of these optional modules:

• Case Management 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.
• Studio Module: Allows business administrators to define and configure tasks, task blocks, and workflows for case types.