Introduction

Installing Requirements Management (RM) consists of four main steps:

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. Import the administration console settings
6. Install hotfixes for your RM solution version.

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

System requirements

• Appian running version 21.4 for RM 1.5.
• A supported version of a MariaDB database as a business data source.
  • Note: Instructions below are tailored for MariaDB databases. For use with other databases, the SQL scripts used in Step 3 will need to 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 will be used in the remaining set up steps.

• RequirementsManagementv1.5.0.sql: SQL script for creating the database objects needed for the RM application.
• RequirementsManagementv1.5.0.zip: Application package to import into Appian.
• RequirementsManagementv1.5.0-AdminConsole.zip: Export of the default start pages of the admin console.
• RequirementsManagementv1.5.0.properties: Import customization file for configuring the application package.
• Plugins: Folder that contains the JAR files used to deploy the latest plug-ins needed for self-managed environments.

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. On the right side of the page, under Downloads, click RM Components and agree to the License Agreement.
5. Click RM Components to download the ZIP file.
6. Unzip RM Components V1.5.0.zip to access the installation files.

Step 2: Deploy plug-ins

For the RM application to work, you must deploy the Appian Solutions and Content Tools plug-ins. 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.
3. On the left side of the console, click Plug-ins.
4. Click DEPLOY NEW PLUG-INS.
5. Search for and click Appian Solutions.
6. Click DEPLOY.

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 that were downloaded in Step 1.

Step 3: Create database objects

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

To create the database objects:

• In your database, run the RequirementsManagementv1.5.0.sql DDL file that was downloaded in Step 1.

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

Step 4: Import the application

The final step to install the RM application is to import 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 RequirementsManagementv1.5.0.zip file that was downloaded in Step 1.
5. Select Include related import customization file and click UPLOAD. Select the RequirementsManagementv1.5.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.

Step 5: Import the administration console settings

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

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

Step 6: 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'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 the main installation steps from 3 to 5 above.

Next steps

Now that the application is installed and the database is set up, you're not quite done yet. The following outlines the steps you will need to take to modify the application to work with your organization's requirements.

• Set up inline editing.
• Configure and create a new requirement process.
  • Configuring dropdown lists.
  • Configuring UI text.
  • Configuring document templates.
• Import reference data.
• Create requirement checklists.
• Set up contract file folder structure.