Install the Create Claim via API Module - PostgreSQL

Prepare for installation

The Create Claim API add-on module ships as a separate application supported on Connected Claims. Once incorporated with Connected Claims, this module provides an endpoint for external systems to create a new claim in the Connected Claims Management application.

This guide outlines the steps for downloading and installing the Create Claim API add-on module to use it with your Appian Connected Claims Base application.

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

System prerequisites

This section details the minimum requirements your system must meet to run the Create Claim API add-on module.

• Appian platform running version 26.6 or greater.
• An Appian Cloud environment with the advanced or premium platform tiers.
• A supported version of PostgreSQL as a business data source.
  • Note: The PostgreSQL database name must be jdbc/CCM
• A supported web browser.
• Imported Connected Claims Management Base Application application version 2.0 and higher, which includes the following application containers:
  • Connected Claims Management Base (CCM)
  • CCM Studio Generated Objects

Download the software package

Download the software package for the Create Claim API add-on module, which contains the following files. You use these files when you install the module.

• PostgresConnectedClaimsManagementAddOnCreateClaimApiv1.1.0.zip
• PostgresConnectedClaimsManagementAddOnCreateClaimApiv1.1.0.properties
• PostgresConnectedClaimsManagementAddOnCreateClaimApiv1.1.0.sql

To download the software package:

1. In My Appian, navigate to the Support tab.
2. Select DOWNLOADS > SOLUTIONS.
3. In the grid, click Appian Connected Claims.
4. Under Downloads, click Appian Connected Claims and agree to the License Agreement.
5. Click Postgres CCM Add On: Create Claim API v1.0.0 to download and unzip the ZIP file to access the installation files.

Import the application

Import the Create Claim API database script and application into the target environment.

To import the database script:

1. Run the PostgresConnectedClaimsManagementAddOnCreateClaimApiv1.1.0.sql DDL script that you downloaded when you downloaded the software package in your PostgreSQL business database.

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 application PostgresConnectedClaimsManagementAddOnCreateClaimApiv1.1.0.zip file that you downloaded when you downloaded the software package.
5. Click the Include related import customization file checkbox and click UPLOAD. Select the PostgresConnectedClaimsManagementAddOnCreateClaimApiv1.1.0.properties file that you downloaded when you downloaded the software package.
6. Click INSPECT to check for problems before you import.

   Note:  Inspection could take several minutes and may time out. If this occurs, the import will continue in the background.

7. Click IMPORT.
   • Note: The import may time out due to file size. If this occurs, the import will continue in the background.
8. Review the import results to verify the application container was imported.

Create a service account

Create a service account for the Create Claim API Web API to use.

To create the service account:

1. In the target environment, log in as the deployment user.
2. Navigate to the Admin Console.
3. Navigate to Web API Authentication.
4. Create a service account.
5. Create an API key for this service account.
6. Make note of the API key.

Set up the module after installation

After you install the Create Claim API add-on module, follow the setup steps to start using this functionality with Connected Claims.

Feedback