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

Introduction

After installing the Public Portal, you need to set it up before using it with the Case Management Studio. This guide walks you through the recommended setup steps, which include:

Step 1: Setting up the portal site

  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 a note of the API key.

      pp_create_web_api_sa

  4. In Appian Designer, go to the CMGT Case Management Studio Base application.
  5. Search for the CMGT Service Accounts group.
    • Add the service account to the group.
  6. In Appian Designer, go to the CMGT Portal Module application.
  7. Search for CMGT Portal Connected System.
    • Update the Base URL to your environment's Web API URL. The URL should end in /webapi/.
    • Add the API key created in Step 3.
  8. Search for CMGT Google ReCAPTCHA.
    • Note: Appian considers reCAPTCHA services essential for unauthenticated Appian Portals usage. To use Google reCAPTCHA, update the Google reCAPTCHA Project ID, Site Key, and API Key with your Google reCAPTCHA credentials. If you decide not to use Google reCAPTCHA, skip this step and see Removing Google reCAPTCHA.
  9. Search for CMGT_Portal:
    1. Add your service account to the Service Account field.
    2. Note the Portal UUID.
  10. Search for and update CMGT_PORTAL_TXT_URL_UUID with Portal UUID.
  11. Toggle onthe Published field and save changes.
    • Note: Ignore any design guidance warnings due to shared interface objects. These warnings will not impact the portal publishing or functionality.
  12. Verify the Public Portal is working as expected.

Step 2: Sending case creation emails

Complete the following steps to send case creation emails to the contact provided in the portal case submission:

  1. In Appian Designer, go to the CMGT Case Management Studio Base application.
  2. Search for the expression rule CMGT_Email_CaseCreationEmails.
  3. Add the following to the existing array of email creation rules.
    1
    2
    3
    
    =rule!CMGT_Portal_Email_EmailSettingMap_CreateCase(
        case:ri!case
    )
    
  4. Save changes.
  5. Verify that emails are generating as expected.

Step 3: Removing Google reCAPTCHA

By default, the portal ships with Google reCAPTCHA enabled. Appian considers reCAPTCHA services essential for unauthenticated Appian Portals usage. See Google reCAPTCHA to learn more about Google reCAPTCHA.

If you wish to remove Google reCAPTCHA, complete the following steps:

  1. In Appian Designer, go to the CMGT Portal Module 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 interfaces specified in the design guidance warning that calls a!verifyRecaptcha(). Follow the inline comments in each interface to remove the a!verifyRecaptcha() call.

  • Note: This is not a necessary step but will clean up design guidance warnings and make the code cleaner.

Step 4: Managing files uploaded to Portal

Note:  If uploaded documents are expected to contain sensitive information (e.g., PII, financial, medical, etc.), we recommend Appian HIPAA Cloud to ensure potential sensitive user data is protected.

Appian recommends that customers restrict the Portal-exposed file upload fields to a set of permitted file extensions. This is configurable via the admin console.

Portals natively have a file size restriction per document upload.

Step 5: Renaming the portal service account

This is an optional step that allows the portal service account to reflect a user-friendly name on the front end.

  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 you want displayed for the service account in the front end.

Step 6: Translating the application

This is an optional step. Refer to Exporting translation strings for translation for information on translating the Public Portal module to other languages.

Step 7: Monitoring your portal

Portals are publicly accessible to users on the open internet. Appian recommends actively monitoring your Portal to prevent cyber attacks, like a flood of fake submissions. See Appian Portals for more details and recommendations on using Appian Portals.

Open in Github Built: Fri, May 24, 2024 (06:28:21 PM)

Setting Up the Public Portal

FEEDBACK