Free cookie consent management tool by TermsFeed

Installing the Public Portal Module

Introduction
Copy link to clipboard

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

System requirements
Copy link to clipboard

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

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

Step 1: Download the software package
Copy link to clipboard

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.PortalModulev1.5.0.sql
  • PortalModulev1.5.0.zip
  • PortalModulev1.5.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, 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.5.0.zip to access the installation files.

Step 2: Create database objects
Copy link to clipboard

To create the structure for the database tables, views, and other objects that are a part of Case Management Studio, you need to run the 01.PortalModulev1.5.0.sql DDL script downloaded in Step 1.

Step 3: Import the application
Copy link to clipboard

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 PortalModulev1.5.0.zip file downloaded in Step 1.
  5. Click the Include related import customization file checkbox and click UPLOAD. Select the PortalModulev1.5.0.properties file downloaded in Step 1.
  6. 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.
  7. Click IMPORT.
    • Note: The import may time out due to file size, but the import will continue in the background.
  8. Review the import results to verify the following CMGT Portal Module (CMGT) application container was imported.

Next steps
Copy link to clipboard

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.

Feedback
Copy link to clipboard