Free cookie consent management tool by TermsFeed

Contract Lifecycle Management Install Guide

On This Page
This content applies solely to Contract Lifecycle Management, which must be purchased separately from the Appian base platform. This content was written for Appian 25.3 and may not reflect the interfaces or functionality of other Appian versions.

Introduction

Appian Contract Lifecycle Management (CLM) is built on the Appian process automation platform and helps you manage all of the key processes and checkpoints during the contract lifecycle. This guide walks you through installing CLM, which consists of four main steps.

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

System requirements

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

Enable custom properties

Before installing Contract Lifecycle Management, the following custom properties need to be enabled in the customer's environments:

  • appian.feature.solutions-api.enabled
  • appian.feature.ae.studio.control-panel
  • appian.feature.ae.studio.control-panel.record-hierarchy-metadata
  • appian.feature.ae.intelligent-search.records-smart-search
  • appian.feature.ae.designer-components.record-chat

Cloud customers need to submit a support case to enable these custom properties in their environments. Self-managed customers need to enable these custom properties in their custom properties file.

To do this:

  1. Open the custom properties file located at <APPIAN_HOME>/conf/.
  2. Set the value of each of the following properties to true. For example:
    • appian.feature.solutions-api.enabled=true
    • appian.feature.ae.studio.control-panel=true
    • appian.feature.ae.studio.control-panel.record-hierarchy-metadata=true
    • appian.feature.ae.intelligent-search.records-smart-search=true
    • appian.feature.ae.designer-components.record-chat=true

Once you've enabled these properties, restart the app server. For instructions on restarting the app server, see Starting and Stopping Appian. While the server is restarting, go ahead and start your installation process.

Technical support

Appian provides a number of services to ensure the success of your CLM solution. See the Appian Solutions and Documentation Support Guide for more information. For assistance with technical issues related to installing or setting up CLM, current customers can log into Appian Community and open support cases. All users of CLM can also email Appian Support at support@appian.com.

Step 1: Download the software package

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

  • 01.ContractLifecycleManagementv1.1.0.sql: SQL script for creating the database objects needed for the CLM application.
  • ContractLifecycleManagementv1.1.0.zip: Application package to import into Appian.
  • ContractLifecycleManagement1.1.0.properties: Import customization file for configuring the application package.

Step 2: Deploy plug-ins

CLM relies on the following plug-ins to be deployed and configured in the target system before the application files can be imported:

  • Advanced Document Templating
  • AI Knowledge Assistant
  • Appian Solutions Component Plugins
  • Appian Solutions Plugin
  • Content Tools
  • Document Vector Database
  • Dynamic Document Generator
  • PDF Tools
  • Text Utilities

Note:  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 Plugin.
  6. Click DEPLOY.
  7. Repeat for each of the remaining plugins:
    • Advanced Document Templating
    • AI Knowledge Assistant
    • Appian Solutions Component Plugins
    • Content Tools
    • Document Vector Database
    • Dynamic Document Generator
    • PDF Tools
    • Text Utilities

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 steps in Deploying plug-ins to deploy these plug-ins for self-managed environments.

Step 3: Create database objects

To create the structure for the database tables, views, and other objects that are a part of CLM, you need to run the following DDL scripts in your database.

To create the database objects:

  1. In your MariaDB business database, import and run the following file downloaded in Step 1:

    • 01.ContractLifecycleManagementv1.1.0.sql

Note:  You can run this file again if needed. The individual script executions are tracked in CLM_ScriptExecutionsHistory. This table should not be changed or altered in any way.

Step 4: Import the application

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

To import the CLM 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 zip file that was downloaded in Step 1.
  5. Select Include related import customization file and click UPLOAD. Select the properties file that was downloaded in Step 1.
    • NOTE: If you have credentials for any of the integrations, you may include them in the properties file.
  6. Click INSPECT in order to ensure that there will be no complications on import.
  7. Click IMPORT.
  8. Review the import results.

Next steps

Now that CLM is installed and the database is set up, you need to complete these setup steps to get the application up and running.

  1. Configure the solution for your organization's needs:
    • The CLM Setup Guide outlines the steps you will need to take to modify the solution to work with your organization's requirements.
  2. Configure integrations:

Feedback