Install Upload Claim Document API Module - MariaDB

Prepare for installation

The Upload Claim Document 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 upload documents to claims in the Connected Claims Management application.

This guide outlines the steps for downloading and installing the Upload Claim Document add-on module for MariaDB 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

Before installing the Upload Claim Document API module, ensure your environment meets the following requirements:

This section details the minimum requirements your system must meet to run the Upload Claim Document 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 MariaDB as a business data source.
  • Note: Instructions below are for MariaDB databases. For use with other databases, the SQL script will need to be modified.
• 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

This step involves obtaining the necessary installation files from the Appian Community site to prepare for the Upload Claim Document API module installation.

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

• ConnectedClaimsManagementAddOnClaimUploadDocumentApiv1.1.0.zip
• 01.ConnectedClaimsManagementAddOnClaimUploadDocumentApiv1.1.0.sql

To download the software package:

1. In My Appian, go 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 CCM Add-On: Claim Upload Document API v1.0.0 to download and unzip the ConnectedClaimsManagementAddOnClaimUploadDocumentApiv1.1.0.zip to access the installation files.

Import the application

This step imports the Upload Claim Document API module into your Appian environment, enabling external systems to upload documents to claims programmatically.

Import the Upload Claim Document API module application into the target environment.

To import the application:

1. In the target environment, sign in as the deployment user.
2. Go to Appian Designer.
3. Click IMPORT.
4. Click UPLOAD and choose the application ConnectedClaimsManagementAddOnClaimUploadDocumentApiv1.1.0.zip file that you downloaded when you downloaded the software package.
5. Click INSPECT to check for problems before you import.

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

6. Click IMPORT.

   Note:  The import can time out because of the file size. If the import times out, it continues in the background.

7. Review the import results to verify the CCM Add-On: Claim Upload Document API (CCM_API_CUD) application container was imported.

Create a service account

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

To create the service account:

1. In the target environment, sign 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 Upload Claim Document API add-on module, follow the setup steps to start using this functionality with Connected Claims.

Feedback