Low-Code Configurations for Case Management Studio

Overview

Within Case Management Studio, you can easily create and configure most functionality for your case management apps without leaving Studio or using any code. Some configurations and certain activities, however, can only be done in Designer.

This page is intended for low-code developers and provides an overview of the configurations and activities to do in Designer for case management apps.

Case Management Studio objects

When you create a new case category, case type, or form in Studio, we automatically generate the underlying objects for them in Designer. Basic configurations and functionality for these objects can be done through Studio, but you can also make changes to the objects in Designer to make more complex configurations and robust case management apps.

Objects generated by Studio

When you create a… in Studio	We create a… in Designer
Case category	Record type for the case category and relationship to the All Cases record type that comes out-of-the-box with Studio
Case type	Record type and relationship to the case category record type
Choice list data field	Record type and relationship to the relevant record type
Intake or edit form	Interface for each form
Summary page	Interface for your Case summary view

In addition to these objects, we also generate database scripts to go with all generated record types for case categories and case types.

Configuring generated objects

In Designer, you can make additional configurations and edits to the objects generated by Studio, just like you can configure any Appian objects.

To learn about configuring the record types used for your case types, case categories, and choice list data fields, see our records content or check out the tutorial for record types with a database as a source. Note that the choice list options and whether or not each option is active/inactive can be edited directly in Studio, without needing to be configured in Designer.

To learn about configuring the interfaces used for your intake and edit forms, see our interface content or check out the interface tutorial. Note that interfaces generated by Studio use functions that are specific to Studio and cannot be used in interfaces for other apps. To learn more, check out Functions for Case Management Studio

Configuring forms as generated interfaces

There are some configurations to forms for that you can only make to the interfaces in Designer. Some are more common, like adding a Save Draft button to forms to allow users to save their progress. Some are more use-case specific and are meant to address unique organizational needs, such as adding additional interfaces as pages in the intake and edit form wizards.

Depending on your case management process, you may want to allow users the flexibility to save their progress on create and edit forms as drafts so that they can continue them later. To allow users to save drafts in a form:

1. Open the generated interface for your form.
2. In the interface expression, add two parameters to the a!studio_wizardLayout() function: allowSaveDraft and onSaveDraft.
3. For allowSaveDraft, set the value to true.
4. For onSaveDraft, define a list of saves to execute when the Save Draft button is clicked.

Some organizations may have specific guidelines or use-cases that require them to include additional interfaces in the wizards for the intake and edit forms. For example, your organization may be required to show an interface with a standardized disclaimer or set of instructions to a user before they fill out a specific form, or maybe you need to include a confirmation interface at the end of a form. Whatever content you need to include, these interfaces can be added both before and after the intake or edit forms created in Studio. When you call these additional interfaces into the interfaces that format the form, they appear as pages in the wizard complete with page names included in the milestone bar.

To add additional pages to a wizard and milestone bar for a form:

1. Open the wrapper interface for your case type. This interface is responsible for determining when and whether to show the additional interfaces or the generated interfaces.
2. In the expression for the wrapper interface, call the additional interfaces before or after the a!studio_wizardLayout() function.
3. Open the wizard display interface for your case type. This interface is responsible for constructing the form wizard.
4. In the expression for the wizard display interface, add two parameters (leadingPageNames and followingPageNames) to the a!studio_wizardLayout() function.
   • If you added the additional interfaces before the form configured in Studio, use the leadingPageNames parameter.
   • If you added the additional interfaces after the form configured in Studio, use the followingPageNames parameter.
5. Enter the page name for each additional interface as the values for the relevant parameters above.

To learn more about the wizard layout function in Studio, see [cms-functions.md].

Configuring out-of-the-box objects

Many objects, such as interfaces, process models, translation sets, and record types come out-of-the-box with Case Management Studio. These can be configured and customized as needed.

Case Management Studio comes with a translation set and automatically uses translation strings for all end user text. In addition to providing a head-start on translating your app into new locales, translation sets and translation strings make it easy for you to update terms used throughout your apps to best fit your business terminology. For example, if you refer to a "case" as a "request" or a "ticket", you can search in the translation set to find all the places where "case" is mentioned and update every instance of the term to use your preferred term at one time.

Deploying case management studio objects and apps

Like other Appian objects and apps, objects generated by Studio can be deployed to target environments through your existing deployment pipeline. We automatically package up all of the Studio generated objects, so that they are all in one place and ready to deploy when you are.

This package is called Studio Generated Objects and contains the latest modified objects and corresponding database scripts. The package is named based on when it was created. If a package exceeds 50 attached database scripts, another package will be created and any newly modified objects or associated scripts will be placed there instead of the previous package.

For more information on deploying apps, see Deploy to Target Environment.

Case management security

Case Management Studio apps use a combination of groups and object security to assign permission levels to users, which can only be configured in Designer. For more information, see Security in Case Management Studio.

Feedback