Setting Up Case Comments Summary Module

Introduction

After installing the Case Comments Summary module, you need to set it up before using it with the Case Management Studio Base application. This guide walks you through the setup steps, which include:

1. Generate a summary on new and updated comments.
2. Generate a summary when a comment is deleted.
3. Display the comments summary on the case summary view.

Step 1: Generate a summary on new and updated comments

To set up the Case Comments Summary module with Case Management Studio you need to first update the process model that handles creating and updating case comments so the case comments summary can be generated when a comment is added or updated:

To update the process model:

1. Login to the target environment.
2. Navigate to the Appian Designer.
3. Navigate to the Case Management Studio Base application.
4. Search for and open the CMGT_Comment_CreateUpdate process model.
   1. Add a subprocess node after the Write Comment node and name it Summarize with AI.
      • Note: The incoming path should be chained, but the outgoing path should not be chained.

      

5. In the new subprocess node, go to Properties.

   1. Navigate to the Setup tab and select the following settings:

      

      1. In the Subprocess Setup section, select Asynchronously in the Subprocess will run section.
      2. In the Run this process model section, select CMGT_CMT_AI_CaseCommentSummary_Update as the process to run.
         1. Select the Reporting checkbox to include data from this subprocess in the parent process model reports.

      3. In the Input Variables section, click the Expression Editor for the caseId variable and paste the following code snippet.

         1
         pv!comments['recordType!{e57250b0-f216-4a23-afd9-39e7d532d302-cmgt}CMGT_Comment.fields.{e834d841-d4e3-4e0e-a251-4c864cb0b853}caseId']
         

      4. Navigate to the Other tab and select the Run all instances at the same time.
      5. Click OK.
6. From the File menu, click Save & Publish, then Exit.

Step 2: Generate a summary on comment deletion

For the case comments summary to be generated when a comment is removed:

1. Login to the target environment.
2. Navigate to the Appian Designer.
3. Navigate to the Case Management Studio Base application.
4. Search for and open the CMGT_Comment_Delete process model.
   1. Add a subprocess node after the Write Comment node and name it Summarize with AI.
      • Note: The incoming path should be chained, but the outgoing path should not be chained.

      

5. In the new subprocess node, go to Properties > Setup and select the following settings:

   1. In the Subprocess Setup section, select Synchronously and check Enable activity chaining into all initial nodes in the subprocess.
   2. In the Run this process model section, select CMGT_CMT_AI_CaseCommentSummary_Update as the process to run.
   3. In the Input Variables section:

      1. Click the Expression Editor for the caseId variable and paste the following code snippet.

         1
         pv!comments['recordType!{e57250b0-f216-4a23-afd9-39e7d532d302-cmgt}CMGT_Comment.fields.{e834d841-d4e3-4e0e-a251-4c864cb0b853}caseId']
         

      2. Navigate to the Other tab and select the Run all instances at the same time.
      3. Click OK.
   4. From the File menu, click Save & Publish, then Exit.

Step 3: Display the comments summary on the case summary view

To display the comments summary on the case summary view:

1. Login to the target environment.
2. Navigate to the Appian Designer.
3. Navigate to the Case Management Studio Base application.
4. Search for and open the CMGT_Comment_Sub_CommentThread interface.
   1. Find the section layout that calls CMGT_Comment_Sub_CommentThread_DisplayComment.

      1. Locate the a!forEach() function that calls CMGT_Comment_Sub_CommentThread_DisplayComment and paste the following code snippet above it as shown.

         

         1
         2
         3
         4
         5
         6
         7
         8
         9
         10
         11
         12
         rule!CMGT_CMT_AI_CaseCommentSummary_Display(
         caseId: ri!caseId,
         brandingMap: ri!brandingMap,
         triggerRefresh: ri!triggerRefresh,
         commentRefresh: ri!commentRefresh,
         showWhen: index(
          local!commentTabs,
          local!selectedCommentsTab,
          "name",
          null
         ) = 'translation!{84af98bc-da91-4f4e-a9c3-1fc60289d669}CMGT_CMT_AI Translations.{d97fb5e7-8221-4ccd-a819-de6b9adc8150}Case'
         ),
         

   2. Click SAVE.

Feedback