Free cookie consent management tool by TermsFeed Installing Vendor Management [Vendor Management v22.4.1.3]
Page not found in the selected version; redirected to the home page.
Installing Vendor Management
This content applies solely to Vendor Management, which must be purchased separately from the Appian base platform. This content was written for Appian 22.4 and may not reflect the interfaces or functionality of other Appian versions.

Introduction

Installing Vendor Management (VM) consists of five main steps:

  1. Download the software package.
  2. Deploy VM plug-ins to the Appian environment.
  3. Create the database objects in the business data source.
  4. Import the VM application into the Appian environment.
  5. Install Portals.

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 or Oracle databases. For use with other databases, the SQL scripts used in Step 3 will need to be modified.

Step 1: Download software package

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

  • scripts/1.VendorManagementv1.3.0.sql: SQL script for creating the database objects needed for the VM application.
  • VendorManagementv1.3.0.zip: Application package to import into Appian.
  • VendorManagementv1.3.0.properties: Import customization file for configuring the application package.
  • plugins: Folder that contains JAR files used to deploy the plug-ins needed for self-managed environments.

To download the software package:

  1. Go to the SUPPORT tab on My Appian.
  2. Click the DOWNLOADS tab.
  3. Click SOLUTIONS.
  4. Find and open Vendor Management V22.4.1.3.
  5. In Downloads, click the Vendor Management Installer link.
  6. Click PROCEED to agree to the License Agreement.
  7. Choose your Relational Database Management System.
  8. Click Continue.
  9. Click Vendor Management Installer v22.4.1.3 to download the ZIP file.
  10. Unzip VendorManagementv1.3.0.zip to access the software installation files.

Step 2: Deploy plug-ins

For the VM application to work, you must deploy the Appian Solutions, Content Tools, Regular Expression Functions, and Rich Text Editor plug-ins. 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. On the left side of the console, click Plug-ins.
  4. Click ADD 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 appian-solutions-1.18.6.jar 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 VM application, you will need to run a DDL script in your database.

To create the database objects:

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

Step 4: Import the application

The next step needed is to install the VM application by importing 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 VendorManagementv1.3.0.zip file that was downloaded in Step 1.
  5. Select Include related import customization file.
  6. Click UPLOAD. Select the VendorManagementv1.3.0.properties file that was downloaded in Step 1.
  7. Click INSPECT.
  8. Review the inspection results. If there are no issues, click IMPORT PACKAGE.
    • NOTE: The import may time out due to file size, but 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 Portals

Once you have finished installing the Vendor Management solution, you can install portals.

To install portals for VM:

  1. Create a new API key. Copy the API key and save it securely for future reference.

    portals_api_key.png

  2. Create a new service account and name it vmportals.

    portals_service_account.png

  3. Add the service account to the AS VM Portals Service Account group.
  4. Update the AS VM CS Portals Connected System.
    • Base URL: site url + /suite/webapi/. Example: https://examplesite.appiancloud.com/suite/webapi/.
    • API Key Value: API key saved above.
  5. Open the AS_VM_Portal Portal Object in Designer.
  6. Configure and Publish the Portal. Refer to the Portal Object documentation for assistance.
    • If reCAPTCHA is not needed, the interface can be updated to AS_VM_PORTAL_FM_homePageWithoutRecaptcha.
    • The service account should be set to the one created in Step 2.

Installing Vendor Management

FEEDBACK