This content applies solely to Connected KYC, which must be purchased separately from the Appian base platform. This content was written for Appian 23.3 and may not reflect the interfaces or functionality of other Appian versions. |
The Appian Connected KYC solution is a customizable, expertly-developed application built on the Appian low-code platform. It allows financial services professionals to streamline the Investigations process for new and existing institutional customers into financial service products.
This guide provides guidance for installing Connected KYC or upgrading from one Connected KYC version to the most recent.
To check the Appian platform version and database: From the navigation bar, click on About Appian.
Refer to the Appian Version number under System Information.
To check the solution version: From the Connected KYC homepage, scroll to the bottom.
In the instance of technical difficulty, current customers can log into Appian Community and open support cases. All users of Connected KYC can also email Appian Support at support@appian.com.
Installing Connected KYC consists of five main steps, including:
Before starting the installation process, review the System Requirements to make sure all minimum requirements are met.
The first step in installing Connected KYC is to download the software package that contains the following files. These files will be used in the remaining set up steps.
To download the software package:
ConnectedKycv1.6.0 - Forum.zip
to access the installation files.Connected KYC relies on the following plug-ins to be deployed and configured in the target system before the application files can be imported.
To deploy the plug-ins for an Appian Cloud environment:
Appian Solutions Plugin
.Repeat the above steps, but search for and click the following:
Advanced Unzip
Appian Solutions Component Plugins
FS Integration Plugin
Google Cloud Storage Connected System
People Functions
To deploy the plug-ins for a self-managed environment:
Download the following plug-ins from the Appian AppMarket:
Follow the Deploying Plug-ins instructions to deploy the plug-ins listed above.
In order to create the structure for the database tables, views, and other objects that are a part of the Connected KYC application, you will need to run a DDL script in your database.
To create the database objects:
sql
DDL file that was downloaded in Step 1.The next step to install the Connected KYC application is to import the application files into the target environment.
To import the application:
zip
file that was downloaded in Step 1.properties
file that was downloaded in Step 1.
AS KYC Set Group IDs
and AS FS Set Doc IDs
ran successfully.
Note: If the business database is not called Appian
, a warning will occur when inspecting/importing the data stores. To fix this, after the import is complete, open each data store object and update the Data Source.
After your import is completed, you should set up User Start Pages in the Appian Admin Console. This will ensure that when your users log in they will automatically be directed to the correct site.
The recommended start pages for the Connected KYC user groups are:
Group | Start Page URL |
---|---|
AS FS Internal Users | https://< ENVIRONMENT-NAME >/suite/sites/connected-kyc |
AS FS Appian Administrators | https://< ENVIRONMENT-NAME >/suite/design |
Now that the solution is installed and the database is set up, you're not quite done yet. There are a few more steps you need to take to get your solution up and running.
If you're using any integrations: Companies House, DocuSign, Dun and Bradstreet, Northrow, or OFAC, there are some prerequisites to complete and minimal configuration needed from the System Administration Center.
After that, you're going to want to configure the solution for your organization's needs. How to Configure Connected KYC outlines the steps you will need to take to modify the solution to work with your organization's requirements.
Additional specifications such as branding and timezone can be set in the Appian Admin Console.
Caution: Do not delete objects that are not prefixed with AS_KYC
. This can cause problems with future Financial Services solution setups and must be avoided. To learn more about how to safely edit these objects, go to the modifying objects section of our documentation.
When upgrading your Connected KYC solution, if you make any changes to your solution that are not outlined in this Upgrade Guide, your changes may not persist after completing the upgrade or hotfix. This includes any changes or customizations to the application objects or database.
This guide provides instructions for upgrading your Connected KYC solution from version 1.5 to 1.6 to get the latest feature updates and product improvements.
The first step in installing Connected KYC is to download the software package that contains the following files. These files will be used in the remaining set up steps.
To download the software package:
ConnectedKYCv1.6.0 - Forum.zip
to access the installation files.Backup your database and application to the Appian-provisioned cloud. This will give you the ability to revert back to the previous application state in the event that you need to after deploying the upgrade solution environment.
To backup your database:
When prompted, save the .sql generated file to a safe location in case you need to roll back this upgrade.
To backup your application:
Append the current version number (v1.6.x) to the file name and click Export.
Connected KYC relies on the following plug-ins to be deployed and configured in the target system before the application files can be imported.
To deploy the plug-ins for an Appian Cloud environment:
Appian Solutions Plugin
.Repeat the above steps, but search for and click the following:
Advanced Unzip
Appian Solutions Component Plugins
FS Integration Plugin
Google Cloud Storage Connected System
People Functions
The following plug-ins can be downloaded directly from the Appian AppMarket:
Once all plug-ins are downloaded, deploy the plug-ins to all environments. The steps for deploying plug-ins are different depending on if you have an Appian Cloud or self-managed environment.
To deploy the plug-ins for a self-managed environment:
Advanced Unzip
, Appian FS Integration Solutions Plug-in
, Appian Solutions Component Plugins
, Appian Solutions Plug-ins
, Google Cloud Storage Connected System
, and People Functions
files that were downloaded earlier.In order to create the structure for the database tables, views, and other objects that are a part of the Connected KYC application, you will need to run a DDL script in your database.
To create the database objects:
The next step to install the Connected KYC application is to import the application files into the target environment.
To import the application:
Select Include related import customization file and click UPLOAD. Select the 'ConnectedKycv1.6.0.properties' file that was downloaded in Step 1.
If the business database is not called "Appian", a warning will occur when inspecting/importing the data stores. To fix this, after the import is complete, open each data store object and update the Data Source.
Note: If new sites in Appian Cloud for Connected KYC were provisioned for you when your organization purchased the solution, skip this step and continue to the next step.
During the application import, you may see a warning about the Datastore objects. This warning displays if you do not name the database in your environment “Appian”.
To check the database name, click About Appian from the navigation bar
If it does not indicate jdbc/Appian, complete the following steps:
After successfully importing the application container, you will need to update your application’s data stores to ensure that any new data tables present in the new release are included within the application.
To update these data stores:
Execute the following process models:
AS KYC Set Group IDs
- AS FS Set Doc IDs
After validating that the upgrade was completed successfully, you can deploy the upgrade to additional environments. We recommend using connected environments with the ability to directly deploy and completing the following steps.
When you are ready to upgrade your production environment, make sure you upgrade it during an off-peak time, at the end of the calendar day, for the majority of your users.
01.ConnectedKycv1.6.0.sql
will add any missing columns.Installing and Upgrading Connected KYC