Free cookie consent management tool by TermsFeed

Installing GCA

This content applies solely to Government Clause Automation, which must be purchased separately from the Appian base platform.

Introduction

Installing Government Clause Automation (GCA) consists of five main steps:

  1. Download the software package.
  2. Deploy GCA plug-ins to the Appian environment.
  3. Create the database objects in the business data source.
  4. Import the GCA application into the Appian environment.
  5. Import the administration console settings.
  6. Install hotfixes for your GCA solution version.

Before starting the installation process, review the System Requirements to make sure all minimum requirements are met.

System requirements

  • Appian version 24.2 for GCA 2.6.
  • A supported version of a MariaDB or Oracle database as a business data source.
    • Note: Instructions below are tailored for MariaDB databases. The SQL scripts used in Step 3 will need to be modified for use with other databases.
  • A supported web browser.

Note:  Instructions below are tailored for MariaDB or Oracle databases. For use with other databases, the SQL scripts used in Step 3 will need to be modified.

Step 1: Downloading the software package

To install GCA, you'll need to download the software package that contains the following files you'll use in the remaining set up steps.

  • 01.ClauseAutomationv2.6.0.sql: SQL script for creating the database objects needed for the GCA application.
  • ClauseAutomationv2.6.0.zip: Application package to import into Appian.
  • ClauseAutomationv2.6.0-AdminConsole.zip: Export of the default start pages of the admin console.
  • ClauseAutomationv2.6.0.properties: Import customization file for configuring the application package.

To download the software package:

  1. In My Appian, navigate to the SUPPORT tab.
  2. Click the DOWNLOADS tab.
  3. Click SOLUTIONS.
  4. Find and open Government Clause Automation (GCA) v24.2.2.6.0.
  5. In Downloads, click the Download GCA v24.2.2.6 link.
  6. Click PROCEED to agree to the License Agreement.
  7. Click Download GCA v24.2.2.6 to download the ZIP file.
  8. Unzip ClauseAutomationv2.6.0.zip to access the software installation files.

Step 2: Deploying plug-ins

For the GCA application to work, you must deploy the following plug-ins.

  • Appian Solutions
  • Content Tools
  • Regular Expression Functions
  • Rich Text Editor

The steps for deploying plug-ins are different for an Appian Cloud or self-managed environment. Be sure to note which set of deployment steps you need for your environment.

Appian Cloud Environments

To deploy the plug-ins for an Appian Cloud environment:

  1. In the target environment, log in as the deployment user.
  2. Navigate to the Admin Console.
  3. Click Plug-ins.
  4. Click ADD PLUG-INS.
  5. Search for and click Appian Solutions.
  6. Click DEPLOY.
  7. Repeat steps 3-6 for each of the following plug-ins:
    • Content Tools
    • Regular Expression Functions
    • Rich Text Editor

Self-Managed environments

To deploy the plug-ins for a self-managed environment:

  1. Download the following plug-ins directly from the Appian AppMarket:
  2. Follow the Deploying Plug-ins instructions to deploy each plug-in.

Step 3: Creating database objects

In order to create the structure for the database tables, views, and other objects that are a part of the GCA application, you will need to run a DDL script in your database.

To create the database objects:

  • In your database, run the 01.ClauseAutomationv2.6.0.sql DDL file that was downloaded in Step 1.

  • Note: This DDL file is optimized for MariaDB or Oracle databases. If you are using a different type of database, the DDL file may need to be modified.

Step 4: Importing the application

The final step needed is to install the GCA application by importing the application files 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 ClauseAutomationv2.6.0.zip file that was downloaded in Step 1.
  5. Select Include related import customization file.
  6. Click UPLOAD. Select the ClauseAutomationv2.6.0.properties file that was downloaded in Step 1.
  7. Click INSPECT.
  8. Review the inspection results. If there are no issues, click IMPORT PACKAGE.
    • NOTE: The import may time out due to file size, but import will continue in the background.

Step 5: Importing the administration console settings

If you want to overwrite the current default start page for your GCA solution, you need to import the Admin Console. This is an optional step that is only applicable for specific versions of GCA or a related hotfix. Before performing these steps, be sure they apply to the GCA version installed in your environment.

For instructions on how to do this, see Appian Administration Console.

Note:  If the business database is not called Appian, a warning will occur when importing the data stores. To fix this, after the import is complete, open each data store object and update the Data Source dropdown list.

Step 6: Installing hotfixes

After you finish installing GCA, be sure to check for any relevant hotfixes, and if applicable, apply the latest hotfix version by performing the following steps:

  1. Go to the SUPPORT tab on My Appian.
  2. Click DOWNLOADS.
  3. Click SOLUTIONS.
  4. Find and open the Government Clause Automation version that's installed in your environment.
  5. In Downloads, click the first link under the Hotfix section.
  6. Click PROCEED to agree to the License Agreement.
  7. Click the hotfix file name to download it.
  8. Unzip the hotfix package to access the software installation files.
  9. Repeat installation steps 3 to 5.

Feedback