Free cookie consent management tool by TermsFeed

Installing Requirements Management

On This Page
This content applies solely to Requirements Management, which must be purchased separately from the Appian base platform.

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. Upgrade 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 25.4 for RM 2.3.
  • 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.

Step 1: Download software package

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

  • RequirementsManagementv2.3.0.sql: SQL script for creating the database objects needed for the RM application.
  • RequirementsManagementv2.3.0.zip: Application package to import into Appian.
  • RequirementsManagementv2.3.0.properties: Import customization file for configuring the application package.
  • LogMessage.jar: Plug-in package for log message.
  • RequirementsManagementNativeAiv2.3.0.zip: Package with AI skill objects for RM.
  • AiDocumentBuilderv1.0.0.zip: Package with AI Document Builder objects for RM.
  • AiDocumentBuilderv1.0.0.sql: SQL script for creating the database objects for AI Document Builder in RM.

To download the software package:

  1. Go to MyAppian > SUPPORT > DOWNLOADS to navigate to the DOWNLOADS tab.

  2. Select the SOLUTIONS tile to navigate to the Available Solutions page.

    MyAppian Support > Downloads page, Solutions tile selected.

  3. Click Requirements Management v25.4.2.3 to navigate to the Requirements Management v25.4.2.3 Summary tab.
  4. Click Requirements Management v2.3.0 in the Downloads section to navigate to the License Agreement page.
  5. Click PROCEED to accept the terms and conditions and navigate to the Configure custom application attributes page.
  6. Select your Relational Database Management System (RDBMS) using the radio buttons.
  7. Enter Data source.
  8. Select your Primary System Locale using the dropdown.
  9. Click CONTINUE to navigate to the Download File page.
  10. Click Requirements Management v2.3.0 to download the ZIP file.
  11. Unzip Requirements Management v2.3.0.zip to access the installation files.
  12. Click Requirements Management Native AI v2.3.0 to download the add-on zip file.
  13. Click AI Document Builder v1.0.0 to download the add-on zip file.

Step 2: Deploy plug-ins

You must deploy the following plug-ins for the RM solution to work:

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

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. Sign in as the deployment user in the target environment.
  2. Navigate to the Admin Console and click Plug-ins.
  3. Click ADD NEW PLUG-INS.
  4. Search for and click AI Knowledge Assistant.
  5. Click DEPLOY.

  6. Repeat steps 4 and 5 for each of the following plug-ins:

    • Appian Solutions
    • Appian Solutions Component Plugins
    • AzureOpenAI
    • Content Tools
    • Date and Time Utilities
    • Document Page Counter
    • Document Vector Database
    • Dynamic Document Generator
    • Excel Tools
    • GenAI Tool-Document Summarizer
    • OpenAI
    • Regular Expression Functions
    • Rich Text

  7. Directly upload the Log Message plug-in.

    Note:  The LogMessage.jar plug-in is downloaded as part of the software package.

    1. Sign 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 plug-in.

Self-managed environments

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

  1. Download the following plug-ins directly from the Appian AppMarket:

    Note:  The LogMessage.jar plug-in is downloaded as part of the software package.

  2. Follow the Deploying Plug-ins instructions to deploy the plug-ins.

Step 3: Create database objects

When installing in a new environment, run RequirementsManagementv2.3.0.sql and AiDocumentBuilderv1.0.0.sql 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. Sign in as the deployment user in the target environment.
  2. Navigate to the Appian Designer.
  3. Click IMPORT.
  4. Click UPLOAD and choose the RequirementsManagementv2.3.0.zip file downloaded in Step 1.
  5. Select Include related import customization file using the checkbox.
  6. Click UPLOAD and choose the RequirementsManagementv2.3.0.properties file downloaded in Step 1.
  7. Click INSPECT to review the inspection results.
  8. Click IMPORT PACKAGE if there are no issues in the inspection results.
  9. Click Upload and choose the RequirementsManagementNativeAiv2.3.0.zip file downloaded in Step 1.
  10. Repeat steps 7 and 8.
  11. Click Upload and choose the AiDocumentBuilderv1.0.0.zip file downloaded in Step 1.
  12. Repeat steps 7 and 8.

Note:  The import may time out due to file size, but the import still runs in the background.

Tip:  If the business database is not called Appian, a warning occurs 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, check for any relevant hotfixes, and if applicable, apply the latest hotfix version by performing the following steps:

  1. Go to MyAppian > SUPPORT > DOWNLOADS to navigate to the DOWNLOADS tab.
  2. Select the SOLUTIONS tile to navigate to the Available Solutions page.
  3. Click Requirements Management v25.4.2.3 to navigate to the Requirements Management v25.4.2.3 Summary tab.
  4. Click the Hotfix link in the Downloads section to navigate to the License Agreement page.
  5. Click PROCEED to accept the terms and conditions and navigate to the Configure custom application attributes page.
  6. Select your Relational Database Management System (RDBMS) using the radio buttons.
  7. Enter the Data source.
  8. Select your Primary System Locale using the dropdown.
  9. Click CONTINUE to navigate to the Download File page.
  10. Click the hotfix file name to download it.
  11. Unzip the hotfix package to access the software installation files.
  12. Repeat Step 3 and Step 4.

Step 6: Upgrade 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 must run the manual migration.

Note:  Complete all deployment steps for RM 2.3 before migrating your existing data. After you have completed all deployment steps, follow the steps below to migrate your data.

Manual data migration

  1. Go to Appian Designer and start the AS RM ZZZ 1.6 Upgrade Data Migration process model after the successful deployment of RM 2.3.
  2. Check that AS RM ZZZ 1.6 Upgrade Data Migration is completed without errors to verify that the migration was successful.

Next steps

After installing the application and setting up the database, configure RM to work with your organization's needs. The following steps help you further customize the RM application:

Additionally, you must add the AS RM All Business Users group to the AS AIDB Users group to use Document Builder in RM. See Groups Reference Page for more information.

Feedback