Configuring the Case Management Solution

Estimated Reading Time:  3 minutes

Overview

After installing the Case Management Solution into your workspace, you'll create an application using the Case Management Solution's APIs APIs (application programming interfaces) are a set of protocols and definitions developers use to build and integrate application software. APIs act as the connective tissue between products and services. and Data Model.

TIP  To learn more about installing the Case Management Solution into your workspace, view our Introduction to Case Management Solution article.

Configuring the Case Management Solution in a Module

To configure a module using the Case Management Solution, it must exist in an application that's part of a workspace that contains the activated Case Management Solution. The first step of the process is to determine which Case ManagementAPI APIs (application programming interfaces) are a set of protocols and definitions developers use to build and integrate application software. APIs act as the connective tissue between products and services. you want to use for your application.

When a module exists in a workspace with the activated Case Management Solution, Plug-In components include a Service Type called Case Management. Once selected, you can choose one of the API endpoints and the inputs and Data Source URL automatically populate.

TIP  To learn more about installing the Case Management Solution into your workspace, view our Introduction to Case Management Solution article.

Configure the Plug-In Component

The first step is to configure a Plug-In component and define the data fields you'll need from the Case ManagementData Model. For this example, you'll configure the Create Task API endpoint.

NOTE  These steps assume you have a FE Front-Endmodule opened in an application and workspace where the Case Management Solution package was installed.

To configure the Create Task API endpoint:

1. In the Module Builder, drag and drop a Plug-In component onto the canvas.
2. In the Property ID A Property ID is the unique field ID used by Unqork to track and link components in your module. and Label Text Label Text conveys what the input component is and what information it displays. Enter the purpose of the corresponding component or field. fields, enter plugCreateTask.
3. Navigate to the Plug-In component's Data Settings.
4. From the Service Type drop-down, select Case Management.
5. From the Endpoint drop-down, select Create Task. The Data Source URL and Request Type fields autopopulate and the Inputs table loads with all the necessary inputs.

A static image displaying the Plug-In component's configuration panel and preconfigured Inputs table after selecting the Create Task API endpoint.

6. Click Save Component.

Configure the Case ManagementData Model

Next, you'll define the Case ManagementData Model so a case manager can create tasks using the Admin UI.

To access the Case ManagementData Model and configure the necessary components in your module:

1. To the left of the Module Builder, locate the Default Library ▾ drop-down.
2. From the drop-down, select Case Management.
3. Expand the Taskaccordion An accordion is a type of menu that displays a list of headers stacked on top of one another. to view all the necessary components.

NOTE  Because this how-to guide focuses on the creation of tasks, you only need to drag and drop components from the Task accordion.

4. Drag and drop every Task component onto the canvas.

5. Click Save Component after adding each component.
6. Save you module.

After adding each component to the canvas, your module looks like the following in the Module Builder:

A static image displaying the completed configuration of the module in the Module Builder. All Task components were added to the canvas and saved.

Once administrators have set up the solution using the Setup Admin page, case managers will be able to create tasks. Repeat the steps in this how-to guide to configure other API endpoints in your Case Management Solution.

Accessing the Admin UI

Once your module is configured, use the Admin Setup page to configure your solution. Administrators can use this page to create users, categories, and entity, case, and task types.

IMPORTANT  The data you want collected or manipulated in your solution depends on the Data Model components you configured in your module.

To access the Admin Setup page:

1. Open the workspace where you activated the Case Management Solution.
2. At the top right, click ···.
3. Select Case Management Setup. The Admin Setup page opens in a new tab.

A static image displaying the Case Management Administration page.

TIP  To learn more about setting up the Case Management Solution as an administrator, view our Case Management Admin UI: Administrator Role article.

Resources