Free cookie consent management tool by TermsFeed Installing the Public Portal [Case Management Studio]
Installing the Public Portal

Introduction

This guide outlines the steps for downloading and installing the Public Portal module and integrating it with Case Management Studio. The steps include:

System prerequisites

  • Appian platform running version 23.3 or greater.
  • A supported web browser.
  • Imported Case Management base application

Step 1: Import the application

Next, you will need to import the application files into the target environment.

The first step in installing the Public Portal module is to download the software package that contains the following files. These files will be used in the remaining setup steps.

  • 01.PortalModule.sql
  • PortalModulev1.2.0.zip
  • PortalModule.properties

To download the software package:

  1. In MyAppian, navigate to the Support tab.
  2. At the top of the page, select DOWNLOADS and then SOLUTIONS.
  3. In the grid, click Case Management Studio.
  4. Under Downloads, click Public Portal and agree to the License Agreement.
  5. Click Public Portal to download the ZIP file.
  6. Unzip PortalModulev1.2.0.zip to access the installation files.

Step 2: Creating database objects

To create the structure for the database tables, views, and other objects that are a part of Case Management Studio, 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.PortalModule.sql file downloaded in Step 1.

Step 3: 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 zip file.
  5. Click the Include related import customization file checkbox.
  6. Upload the properties file.
  7. Click INSPECT to ensure that there will be no complications on import.
    • Note: Inspection could take several minutes and may time out, but import will continue in the background.
  8. Click IMPORT.
    • Note: The import may time out due to file size, but import will continue in the background.
  9. Review the import results.

Step 2: Set up portal site

Required incorporation

  1. Log in to the target environment.
  2. Navigate to the Admin Console.
  3. Navigate to Web API Authentication:
    • Create a service account.
    • Create an API Key for this service account.
    • Make note of the API key.

      pp_create_web_api_sa

  4. In Appian Designer, go to the CMGT Case Management Base Application.
  5. Search for the CMGT Case Workers group.
    • Add the service account to the group.
  6. In Appian Designer, go to the CMGT Case Management Portal Add-On application.
  7. Search for CMGT Portal Connected System.
    • Update the base URL to your environment web api url (the URL should end in /webapi/)
    • Add the API key created in step 3.

Update the Google ReCAPTCHA

Perform the steps below if you intend to use the Google ReCAPTCHA, which is recommended, to update the project ID and appropriate keys. If you are not using Google reCAPTCHA, skip this step and see Remove Google reCAPTCHA.

  1. Search for CMGT Google ReCAPTCHA.
    • If you intend to use Google reCAPTCHA update the Google reCAPTCHA Project Id, Site Key, and API Key with your Google reCAPTCHA credentials.
  2. Search for CMGT_Portal:
    • Add service account to the Service Account field.
    • Note the Portal UUID
  3. Search for and update CMGT_PORTAL_TXT_URL_UUID with Portal UUID.
  4. Republish the Public Portal:
    • Ignore any design guidance warnings due to shared interface objects. These warnings will not impact the portal publishing or functionality.
  5. Verify the Public Portal is working as expected.

Step 3: Send case creation emails

Optional incorporation

In order to send case creation emails to the contact provided in the portal case submission, complete the following steps:

  1. In Appian Designer, go to the CMGT Case Management Base Application.
  2. Search for the expression rule CMGT_Email_CaseCreationEmails.
  3. Add the expression rule CMGT_Portal_Email_EmailSettingMap_CreateCase to the existing array of email creation rules.
    • Pass in ri!case into the case parameter.
  4. Save changes.
  5. Verify email is generating as expected.

Step 4: Remove Google reCAPTCHA

By default, the portal ships with Google reCAPTCHA enabled. Learn more about Google reCAPTCHA at Appian Docs. In order to remove Google reCAPTCHA, which is an optional step, complete the following steps:

  1. In Appian Designer, go to the CMGT Case Management Portal Add-On application.
  2. Search for CMGT_Portal.
  3. In the Service Access section, remove the connected system in the Google reCAPTCHA field.
  4. Click Save Changes & Republish Portal.
    • Note: A design guidance warning about missing Google reCAPTCHA configuration will appear.
  5. Verify the Public Portal is working as expected.

If this is a permanent removal of reCAPTCHA, navigate to the interface specified in the design guidance warning that calls a!verifyRecaptcha() and refactor it to remove that call, following the inline comments.

  • Note: That this is not necessary but will clean up design guidance warnings and make the code cleaner.

Step 5: Rename portal service account to automated system

This is an optional incorporation that allows the portal service account to reflect a user-friendly name on the front end, follow the steps in this section.

  1. In Appian Designer, go to the Objects tab.
  2. Search for the constant CMGT_TXT_AUTOMATED_SYSTEM.
  3. Update the constant to match the text that you want displayed for the service account in the front end.
  4. In Appian Designer, go to the Objects tab.
  5. Search for the group CMGT Service Accounts.
  6. Add the portal service account user to this group.
Open in Github Built: Fri, May 24, 2024 (06:28:21 PM)

Installing the Public Portal

FEEDBACK