Free cookie consent management tool by TermsFeed

Install AI Document Builder

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

AI Document Builder enables users to create requirement documents using AI directly from the requirement record. This step is optional and only required if your organization plans to use AI-powered document generation.

Before starting the installation process, review the System requirements for AI Document Builder to make sure all minimum requirements are met.

System requirements for AI Document Builder

Get technical support

Contact Appian Support if you need assistance installing AI Document Builder (AIDB). All AIDB users can also contact Appian Support at support@appian.com.

Step 1: Download the AI Document Builder software package

  1. Go to MyAppian > SUPPORT > DOWNLOADS to navigate to the DOWNLOADS tab.
  2. Select the SOLUTIONS tile to go to the Available Solutions page.
  3. Click AI Document Builder to navigate to the AI Document Builder Summary tab.
  4. Click AI Document Builder V1.2.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 AI Document Builder V1.2.0 to download the ZIP file.

  11. Unzip AI Document Builder V1.2.0 - Forum.zip to access the following installation files:

    • 01.AiDocumentBuilderv1.2.0.sql: SQL script for creating the database objects needed for the AIDB application.
    • AiDocumentBuilder1.2.0.zip: Application package to import into Appian.
    • AiDocumentBuilderv1.2.0.properties: Import customization file for configuring the application package.
    • AiDocumentBuilderTemplateMariaDBv1.0.sql: SQL script for creating the out of the box AI Document Builder Templates configured for Appian Solutions in MariaDB.
    • AiDocumentBuilderTemplateOracleDBv1.0.sql: SQL script for creating the out of the box AI Document Builder Templates configured for Appian Solutions in OracleDB.

Step 2: Deploy plug-ins for AI Document Builder

You must deploy the following plug-ins for the AI Document Builder (AIDB) 1.2 solution to work:

  • Appian Regular Expression Functions
  • Appian Solutions Plugins
  • Content Tools

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 in an Appian Cloud environment for AI Document Builder:

  1. Sign in as the deployment user in the target environment.
  2. Go to Admin Console > Plug-ins.
  3. Click ADD NEW PLUG-INS.
  4. Search for and click Appian Regular Expression Functions.
  5. Click DEPLOY.

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

    • Appian Solutions Plugin
    • Content Tools

Self-managed environments

To deploy the plug-ins in a self-managed environment for AI Document Builder:

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

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

Step 3: Create database objects for AI Document Builder

When installing in a new environment, run the following DDL scripts downloaded in Step 1: Download the AI Document Builder software package to create the database tables, views, and other objects for the AI Document Builder (AIDB) application:

  • AiDocumentBuilderv1.2.0.sql
  • AiDocumentBuilderTemplateMariaDBv1.0.sql: For MariaDB environments.
  • AiDocumentBuilderTemplateOracleDBv1.0.sql: For Oracle environments.

Note:  This DDL file is optimized for MariaDB and Oracle. If you are using a different type of database, the DDL file needs modification.

Step 4: Import the AI Document Builder application

The next step is to import the application files into the target environment.

To import the AI Document Builder (AIDB) 1.2 application:

  1. Sign in as the deployment user in the target environment.
  2. Navigate to Appian Designer.
  3. Click IMPORT.
  4. Click UPLOAD and choose the AiDocumentBuilderv1.2.0.zip file downloaded in Step 1: Download the AI Document Builder software package.
  5. Select Include related import customization file using the checkbox.
  6. Click UPLOAD and choose the AiDocumentBuilderv1.2.0.properties file downloaded in Step 1: Download the AI Document Builder software package.
    1. Click INSPECT to review the inspection results.
    2. Click IMPORT PACKAGE if there are no issues in the inspection results.

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.

Next steps

After installing the application and setting up the database, Set Up AI Document Builder to work with your organization's needs.

Feedback