Free cookie consent management tool by TermsFeed

Install the Public Portal Module

On This Page

Before you begin

The Public Portal module ships as a separate module supported on Case Management Studio. To install the Public Portal module, complete the following steps:

System requirements

This section details the minimum requirements your system must meet to run the Public Portal module.

  • Appian version 26.9 or greater.
  • An Appian Cloud environment with the advanced or premium platform tiers.
  • A supported version of MariaDB or SQL server as a business data source.
  • A supported web browser.
  • Imported Case Management Studio Base application version 2.4 or higher, which includes the following application containers:
    • CMGT Case Management Studio Base (CMGT)
    • CMGT Control Panel Generated Objects (CMGT)

Step 1: Download the software package

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.PortalModulev2.4.0.sql
  • PortalModulev2.4.0.zip
  • PortalModulev2.4.0.properties

To download the software package:

  1. In My Appian, navigate to the Support tab.
  2. Select DOWNLOADS and then SOLUTIONS.
  3. In the grid, find and 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 PortalModulev2.4.0.zip to access the installation files.

Step 2: Create database objects

To create the database tables that are a part of the Public Portal module, you need to run the 01.PortalModulev2.4.0.sql file downloaded in Step 1.

Step 3: Import 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 corresponding Database and run the SQL scripts.
    1. Use scripts folder for MariaDB, and sqlserver-scripts folder for SQL server.
  3. Navigate to the Appian Designer.
  4. Click IMPORT.
  5. Click UPLOAD and choose the application PortalModulev2.4.0.zip file downloaded in Step 1.
  6. Click the Include related import customization file checkbox and click UPLOAD. Select the PortalModulev2.4.0.properties file downloaded in Step 1.
  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 the import will continue in the background.
  9. Review the import results to verify the following CMGT Portal Module (CMGT) application container was imported.

Next steps

Now that you have installed the Public Portal module, follow the steps in Setting Up the Public Portal module to set up your Public Portal with your Case Management Studio application.

Feedback