Set Up Public Self-Registration Module

Introduction

After installing the Public Self-Registration 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, including:

• Setting up the Connected System.
• Adding the Sign Up page to the portal.
• Linking the Portal home page to the Sign Up page.
• Adding the Claim Case page to the My Cases site.
• Linking the My Cases home page to the Claim Case page.
• Adding the Claimed By details to the Case Summary view.
• Capturing the Audit for Claiming a Case.

Before performing these incorporation steps, ensure that your system meets the required prerequisites

System Prerequisites

This section details the prerequisites your system must meet to run the Public Self-Registration module.

• Appian platform running version 26.3 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 must be modified to fit syntax requirements.
• A supported web browser.
• Imported Case Management Studio Base application version 2.3 or higher, which includes the following application containers:
  • CMGT Case Management Studio Base (CMGT)
  • CMGT Control Panel Generated Objects (CMGT)
• CMGT Portal Module (CMGT) application container imported and installed in the target environment.
• CMGT Add-On - Self Registration (CMGT_SELF) application container imported and installed in the target environment.

Step 1: Set up the connected system

The first step in setting up the Public Self-Registration module with your Case Management Studio Base application involves setting up the connected system that backs claiming a case.

1. Log in to the target environment.
2. Navigate to the Admin Console and select Web API Authentication.
3. From the API Key tab, click CREATE.
4. In the Description field, add a unique description for the API key.
5. Click the icon next to the Service Account field to create a new service account.
   1. In the Username field, enter claimCase.
   2. In the Groups field, enter CMGT Service Accounts to add it to the appropriate group.
   3. Click CREATE to apply the new service account to the API key.
6. Click CREATE to create the new API key, copy it, and save it to use in step 11.
7. Go to Appian Designer > Applications and select the CMGT Add-On - Self Registration application.
8. Under Object Type, select Connected System.
9. Search for and open CMGT SELF Connected System.
10. Find the Value field and click the Clear link next to it.
11. Paste the API key you saved in step 6 in the cleared Value field.
12. In the Base URL field, update the URL to match the URL of the target environment you are in. Be sure to use the following URL format: https://sample-url.com/suite/webapi/.
13. Click SAVE.

Step 2: Add the Sign Up page

Next, you must add the Sign Up page to the portal.

To update the portal:

1. From Appian Designer > Applications, select the CMGT Portal Module application.
2. Search for and open the CMGT_Portal portal object.
3. Click Add Page and enter the following details:
   • Title: Sign Up
   • Web Address Identifier: sign-up
   • Icon: file-o
   • Content: CMGT_SELF_PortalPage_SignUp
4. Click DONE > SAVE.

Step 3: Link the Portal home page to the Sign Up page

This section provides instructions for linking the portal home page to the Sign Up page.

To add a link from the portal home page to the Sign Up page:

1. From Appian Designer > Applications, select the CMGT Portal Module application.
2. Search for and open the CMGT_PortalPage_Home interface and click the Expression Editor view.

   1. Locate the local!portalPages variable, remove the a!map() item for the ContactUs page type, and replace it with the following a!map() code snippet.

      1
      2
      3
      4
      5
      6
      7
      8
      a!map(
         pageType: "SignUp",
         label: 'translation!{2ed0b429-53f7-4b8b-923d-ec5b1ef98825}CMGT_SELF Translations.{624d9976-905d-4e2a-8b27-39a4749a5f53}Sign Up',
         link: local!portalUrl & "/page/" & cons!CMGT_SELF_TXT_SIGN_UP_PORTAL_URL_STUB,
         icon: "user-plus",
         backgroundColor: local!stampScheme[3],
         description: 'translation!{2ed0b429-53f7-4b8b-923d-ec5b1ef98825}CMGT_SELF Translations.{0c575c22-89c1-4d0a-8c5d-0b86886a9663}Register or log in to submit, view, and communicate about cases..'
       ),
      

      

3. Click SAVE and close the interface.

Step 4: Add the Claim Case page to the My Cases site

Next, you must add the Claim Case site page to the My Cases site, so users can find their cases once logged in.

To add the Claim Case site page to the My Cases site:

1. From Appian Designer > Applications, open the CMGT Add On: My Cases Module application.
2. Search for and open the CMGT_LA_CaseManagementSite site object and click Add Page.
3. Enter the following details:
   • Title: Claim Case
     • Note: Use the translation string from CMGT_SELF Translations translation set.
   • Web Address Identifier: claim-case
   • Icon: file-o
   • Type: Interface
   • Content: CMGT_SELF_LA_SitePage_ClaimCase
   • Width: Wide
   • Visibility: Always show
4. Click DONE.
5. Use the up arrow to move the new Claim Case page up so it is positioned after the Cases site page and before the Contact Us site page.
6. Click SAVE and close.

Step 5: Link the My Cases home page to the Claim Case page

Follow the steps in this section to add a link from the My Cases home page to the Claim Case page, which provides another way for users to navigate back and forth between these pages.

To add a link from the My Cases home page to the Claim Case page:

1. From Appian Designer > Applications, open the CMGT Add On: My Cases Module application.
2. Search for and open the CMGT_LA_ActionsAndLinks interface and click the Expression Editor view.

3. Copy the following code block, and paste it after the a!sideBySideItem that contains the Create Case record action, as shown.

   1
   2
   3
   4
   5
   6
   7
   8
   9
   a!sideBySideItem(
      item: rule!CMGT_SELF_LA_ClaimCaseDisplayLink(
        showActions: ri!showActions,
        brandingMap: ri!brandingMap,
        linkColor: ri!claimCaselinkColor
      ),
      width: "MINIMIZE"
    ),
   
   

   

4. Click SAVE and close the interface.

Step 6: Add the Claimed By details in the case summary

Follow the steps in this section to add the Claimed By details to the Case Summary view.

To add the Claimed By details:

1. From Appian Designer > Applications, open the CMGT Case Management Studio Base application.
2. Search for and open the CMGT_Case_CaseSummary interface and click the Expression Editor view.

3. Locate the a!cardLayout, then copy and paste the following code block after the a!studio_displayStyle() function as shown.

   1
   2
   3
   4
   rule!CMGT_SELF_CaseSummary_ClaimedBy(
   brandingMap: ri!brandingMap,
   case: ri!case
   ),
   

   

4. Click SAVE and close the interface.

Step 7: Capture the audit for claiming a case

Finally, you need to incorporate the logic that tracks an audit event when a case is claimed.

To add that logic:

1. From Appian Designer > Applications, select the CMGT Case Management Studio Base application.
2. Search for and open the CMGT_Role_SetEvents expression rule.
3. Add another condition to the match() statement that returns a value based on the roleTypeId. See the image for where and how to add the condition.
   • Note: If the role being added is the claimant, this new logic returns the reference ID for the Add Claimant event type.

   

4. Click SAVE.

Next step

Now that you have set up the Public Self-Registration module, your unauthenticated users will be able to create their own user accounts, granting them access to log in to your case management system to view and follow up on their cases.

Feedback