Installing and Upgrading Connected Onboarding

Introduction

The Appian Connected Onboarding solution is a customizable, expertly-developed application built on the Appian low-code platform. It allows financial services professionals to streamline the Onboardings process for new and existing institutional customers into financial service products.

This guide provides guidance for installing Connected Onboarding or upgrading from one Connected Onboarding version to the most recent.

System requirements

• Appian platform running version 23.3 or greater.
• 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 used in Step 3 for both installing and upgrading will need to be modified.
• A supported web browser.

Verifying Appian version and database type

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 Onboarding homepage, scroll to the bottom.

Technical support

In the instance of technical difficulty, current customers can log into Appian Community and open support cases. All users of Connected Onboarding can also email Appian Support at support@appian.com.

Installing Connected Onboarding

Installing Connected Onboarding consists of five main steps:

1. Download the software package.
2. Deploy Connected Onboarding plug-ins to the Appian environment.
3. Create the database objects in the business data source.
4. Import the Connected Onboarding application into the Appian environment.
5. Configure user start pages

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

Step 1: Download software package

The first step in installing Connected Onboarding is to download the software package that contains the following files. These files will be used in the remaining set up steps.

• 01.ConnectedOnboardingv4.6.0.sql: SQL script for creating the database objects needed for the Connected Onboarding application.
• ConnectedOnboardingv4.6.0.zip: Application package to import into Appian.
• ConnectedOnboardingv4.6.0.properties: Import customization file for configuring the solution package.

To download the software package:

1. In MyAppian, navigate to the Support tab.
2. At the top of the page, select DOWNLOADS and then SOLUTIONS.
3. In the grid, click Connected Onboarding v4.6.0.
4. Under Downloads, click Connected Onboarding Installer and agree to the License Agreement.
5. Click Connected Onboarding Installer v4.6.0 to download the ZIP file.
6. Unzip ConnectedOnboardingv4.6.0 - Forum.zip to access the installation files.

Step 2: Deploy plug-ins

Connected Onboarding relies on the following plug-ins to be deployed and configured in the target system before the application files can be imported.

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 Plugin.
6. Click DEPLOY.
7. 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

Self-managed environments

To deploy the plug-ins for a self-managed environment:

1. Download the following plug-ins from the Appian AppMarket:
   • Advanced Unzip
   • Appian FS Integration Solutions Plug-in
   • Appian Solutions Component Plugins
   • Appian Solutions Plug-in
   • Google Cloud Storage Connected System
   • People Functions
2. Follow the Deploying Plug-ins instructions to deploy the plug-ins listed above.

Step 3: Create database objects

In order to create the structure for the database tables, views, and other objects that are a part of the Connected Onboarding application, you will need to run a DDL script in your database.

To create the database objects:

• In your MariaDB business database, import and run the sql DDL file that was downloaded in Step 1.

Step 4: Import the application

The next step to install the Connected Onboarding application is to import 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 zip file that was downloaded in Step 1.
5. Select Include related import customization file and click UPLOAD. Select the properties file that was downloaded in Step 1.
   • Note: If you have credentials for any of the integrations, you may include them in the properties file.
6. Click INSPECT in order to ensure that there will be no complications on import.
   • Note: Inspection could take several minutes and may time out, but import will continue in the background.
7. Click IMPORT.
   • Note: The import may time out due to file size, but import will continue in the background.
8. Review the import results.
9. In Appian Designer, verify that the processes AS IO Set Group IDs and AS FS Set Doc IDs ran successfully.

Step 5: Configure user start pages

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 Onboarding user groups are:

Group	Start Page URL
AS FS Internal Users	https://< ENVIRONMENT-NAME >/suite/sites/connected-onboarding
AS FS Appian Administrators	https://< ENVIRONMENT-NAME >/suite/design

Next steps

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 Onboarding 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.

Upgrading Connected Onboarding

When upgrading your Connected Onboarding 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 Onboarding solution from version 4.5 to 4.6 to get the latest feature updates and product improvements.

Step 1: Download software package

The first step in installing Connected Onboarding is to download the software package that contains the following files. These files will be used in the remaining set up steps.

• 01.ConnectedOnboardingv4.6.0.sql: SQL script for creating the database objects needed for the Connected Onboarding application.
• ConnectedOnboardingv4.6.0.zip: Application package to import into Appian.
• ConnectedOnboardingv4.6.0.properties: Import customization file for configuring the solution package.

To download the software package:

1. In MyAppian, navigate to the Support tab.
2. At the top of the page, select DOWNLOADS and then SOLUTIONS.
3. In the grid, click Connected Onboarding v4.6.0.
4. Under Downloads, click Connected Onboarding Installer and agree to the License Agreement.
5. Click Connected Onboarding Installer v4.6.0 to download the ZIP file.
6. Unzip ConnectedOnboardingv4.6.0 - Forum.zip to access the installation files.

Step 2: Backup data and reconfiguration

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:

1. Log in to the solution as a system administrator or database administrator.
2. Click the Applications menu icon and select Cloud Database.
3. From your Appian-provisioned cloud database, click on Appian in the panel, and click the Export tab.
4. Select Custom, scroll to the bottom, and select Go.

5. When prompted, save the .sql generated file to a safe location in case you need to roll back this upgrade.

   • This will create a database script with all objects and data in case of the need to revert the changes.

To backup your application:

1. From the application navigation menu, navigate to Appian Designer.
2. From Appian Designer, click the Connected Onboarding application checkbox.
3. Click the Export dropdown and select Application.
4. Append the current version number (v4.6.x) to the file name and click Export.
   • Click Download Package and the Download import customization file link to download the backup.
   • Save the files to a safe location in case you need to roll back the upgrade.
   • Confirm all of the application objects were exported.

Step 3: Deploy plug-in

Connected Onboarding relies on the following plug-ins to be deployed and configured in the target system before the application files can be imported.

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 Plugin.
6. Click DEPLOY.
7. 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

Self-managed environments

The following plug-ins can be downloaded directly from the Appian AppMarket:

• Advanced Unzip
• Appian FS Integration Solutions Plug-in
• Appian Solutions Component Plugins
• Appian Solutions Plug-in
• Google Cloud Storage Connected System
• People Functions

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:

• Follow the Deploying Plug-ins instructions to deploy the 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.

Step 4: Create database objects

In order to create the structure for the database tables, views, and other objects that are a part of the Connected Onboarding application, you will need to run a DDL script in your database.

To create the database objects:

• In your MariaDB business database, import and run the '01.ConnectedOnboardingv6.0.sql' DDL file that was downloaded in Step 1.

Step 5: Import the application

The next step to install the Connected Onboarding application is to import 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 'ConnectedOnboardingv4.6.0.zip' file that was downloaded in Step 1.
5. Select Include related import customization file and click UPLOAD. Select the 'ConnectedOnboardingv4.6.0.properties' file that was downloaded in Step 1.
   • Note: If you have credentials for any of the integrations, you may include them in the properties file.
6. Click INSPECT in order to ensure that there will be no complications on import.
   • Note: Inspection could take several minutes and may time out, but import will continue in the background.
7. Click IMPORT.
   • Note: The import may time out due to file size, but import will continue in the background.
8. Review the import results.
9. In Appian Designer, verify that the processes 'AS IO Set Group IDs' and 'AS FS Set Doc IDs' ran successfully.

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.

Step 6: Update the data stores

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:

Updating the data stores

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:

1. From Appian Designer, open the 'AS FS Tables' data store object.
2. When importing the application files, if a warning displays under Data Source that indicates your business database is not called "Appian", select the correct database.
3. Modify the draft version of the data store.
4. Select the data source from the drop-down.
5. Click Save Draft.
6. Click VERIFY.
7. Click SAVE & PUBLISH.
8. Repeat these steps for the rest of the data store objects.

9. Execute the following process models:

   • AS IO Set Group IDs - AS FS Set Doc IDs

Step 7: Deploy upgrade to other environments (Optional)

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.

1. From Admin Console, set a maintenance window in the target environment.
2. Repeat steps 2, 3, and 4 for your target environment.
3. In the Appian Designer of your source environment, prepare to deploy to a target environment.
   • Select the Connected Onboarding Application
   • Select Compare and Deploy

   

4. Select the target environment and click Next.
5. Select Entire Application.
6. Select Database Scripts tab.
   • Select the Data Source from the dropdown.
   • Upload 01.ConnectedOnboardingv4.6.0.sql in Database Scripts.
7. Click Next to Inspect the package:
   • Make sure there are no missing precedents.
   • During inspection, you may see conflicts show up as warnings. You can safely ignore conflicts that are related to branding configurations or hotfixes that have been directly applied to your solution. Contact technical support if you cannot discern the cause of the conflict.
   • Warnings may show up for database changes. The database script 01.ConnectedOnboardingv4.6.0.sql will add any missing columns.
   • Due to the size of the package, the inspection process may time out and throw an HTTP 504 error. If this happens, you may continue to follow the deployment steps below.
8. Click Next to review the deployment.
9. Click Deploy to deploy the changes to your target environment.
   • Once your deployment is in progress, the deployment details will be available on the Deployments View in the source and target environment. Deployment details are only visible to system administrators and application administrators.
   • If your deployments require review, application administrators and users in the reviewer group will receive emails about the pending deployment. They can approve or reject packages in the deployments view. After a package has successfully deployed to the target environment, the same package can be deployed to additional environments.
10. Once the deployment is complete, remove the maintenance window.

Feedback