Free cookie consent management tool by TermsFeed

Installing Requirements Management

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

Introduction

Installing Requirements Management (RM) consists of five main steps and a sixth step for upgrading from RM 1.5 or earlier:

  1. Download the software package.
  2. Deploy RM plug-ins to the Appian environment.
  3. Create the database objects in the business data source.
  4. Import the RM application into the Appian environment.
  5. Install hotfixes for your RM solution version.
  6. Upgrading from RM 1.5 or earlier.

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

System requirements

  • Appian running version 24.3 for RM 2.1.
  • A supported business data source.

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

  • A supported web browser.
  • A supported business data source.

Step 1: Download software package

The first step in installing RM is to download the software package that contains the following files. These files will be used in the remaining setup steps.

  • RequirementsManagementv2.1.0.sql: SQL script for creating the database objects needed for the RM application.
  • RequirementsManagementv2.1.0.zip: Application package to import into Appian.
  • RequirementsManagementv2.1.0.properties: Import customization file for configuring the application package.
  • LogMessage.jar: Java Archive file for Log Message Plugin.

To download the software package:

  1. In MyAppian, navigate to the downloads tab for the application.
  2. At the top of the page, select DOWNLOADS and then SOLUTIONS.
  3. In the grid, click Requirements Management.
  4. Under Downloads, click Requirements Management v2.1.0 and agree to the License Agreement.
  5. Select your database and locale preferences, enter Data source, and click CONTINUE.
  6. Click Requirements Management v2.1.0 to download the ZIP file.
  7. Unzip Requirements Management v2.1.0.zip to access the installation files.

Step 2: Deploy plug-ins

For the RM application to work, you must deploy the following plug-ins:

  • Appian Solutions
  • Appian Regular Expression Functions
  • Rich Text
  • OpenAI
  • Azure OpenAI
  • Log Message
  • Content Tools
  • Date and Time Utilities
  • Appian Solutions Component Plugins
  • AI Knowledge Assistant
  • Document Page Counter
  • Document Vector Database
  • Dynamic Document Generator
  • Excel Tools
  • GenAi Tool- Document Summarizer

The steps for deploying plug-ins are different depending on if you have an Appian Cloud or a self-managed 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 and click Plug-ins.
  3. Click ADD NEW PLUG-INS.
  4. Search for plug-in names.
  5. Click DEPLOY.
  6. Repeat the steps above for each of the following plug-ins:
    • Appian Regular Expression Functions
    • Rich Text
    • OpenAI
    • Azure OpenAI
    • Log Message
    • Content Tools
    • Date and Time Utilities
    • Appian Solutions Component Plugins
    • AI Knowledge Assistant
    • Document Page Counter
    • Document Vector Database
    • Dynamic Document Generator
    • Excel Tools
    • GenAi Tool- Document Summarizer
  7. Directly upload the Log Message Plugin.
    1. Log in as a deployment user in the target environment.
    2. Navigate to the Admin Console.
    3. Click Plug-ins.
    4. Click ADD NEW PLUG-INS.
    5. Select the Direct Upload tab.
    6. Click Upload and select the LogMessage.jar file downloaded in Step 1.
    7. Click DEPLOY to deploy the Log Message Plugin.

Self-managed environments

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

  • Follow the Deploying Plug-ins instructions to deploy the latest plug-in files from the App Market.

Step 3: Create database objects

When installing in a new environment, run the RequirementsManagementv2.1.0.sql DDL file downloaded in Step 1 to create the structure for the database tables, views, and other objects that are part of the RM application.

When upgrading from a previous RM version, read the readme.txt file in the package for instructions related to DB migration scripts.

Note:  This DDL file is optimized for MariaDB and Oracle. If you are using a different type of database, the DDL file needs modification. Included in the scripts is Best in Class (BIC) contracts data that is used in the BIC contract recommendation feature.

Step 4: Import the application

The final step to install the RM application is to import the application files into the target environment.

Caution:  If you have not already done so, you must update the User record type to the latest version before importing the application. See Update a Legacy Record Type for more information.

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 RequirementsManagementv2.1.0.zip file that was downloaded in Step 1.
  5. Select Include related import customization file and click UPLOAD. Select the RequirementsManagementv2.1.0.properties file that was downloaded in Step 1.
  6. Click INSPECT.
  7. Review the inspection results. If there are no issues, click IMPORT PACKAGE. Note: The import may time out due to file size, but the import will continue in the background.

    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 5: Install hotfixes

After you finish installing RM, 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 Requirements Management version that is 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 the main installation steps from 3 to 4 above.

Step 6: Upgrading from RM 1.5 or earlier

Requirements Management 1.6 introduced a new way to manage document folders, which requires a migration of the existing data. If you are upgrading from Requirements Management 1.5 or earlier, you need to run a manual migration.

Note:  Complete all deployment steps for RM 2.1 before migrating your existing data. After you have completed all deployment steps, follow the steps below for the manual data migration.

Manual data migration

  1. After successful deployment of RM 2.1, go to Appian Designer and start the AS RM ZZZ 1.6 Upgrade Data Migration process model.
  2. To verify that the migration was successful, check that AS RM ZZZ 1.6 Upgrade Data Migration is completed without errors.

Next steps

After installing the application and setting up the database, you'll want to configure RM to work with your organizations' needs. The following outlines steps you can take to further customize the RM application:

Feedback