Enclosure14_Sept2020_ExtProd_Appian_Shared_Platform_Deployment_Instructions_Redacted Update.pdf

Comptroller of the Currency Office of Management

Operations Program Management Office

Appian Shared Platform Deployment Document

9/11/2020 September 2020 ExtProd Platform Deployment

Appian Shared Platform Deployment Document

Operations Program Management Office 1

Document Control

Platform Name Appian Shared Platform Platform Acronym APPN Document Title Deployment Document Document Date March 26, 2018 Document Version

Client Organization Information Technology Services (ITS)

Operations Program Management Office 3

1 Introduction This document provides guidance in the deployment of releases, hot-fixes and data-fixes. The guide is broken down to different sections for database deployment, Appian application deployment, and post-import procedures.

There are multiple sections in this document that require various types of files. To obtain those files the people doing the install will need to access them through JAZZ.

Operations Program Management Office 4

2 Build Preparation The Platform deployment files will need to be checked out of JAZZ onto each server that is being deployed to before running the Appian configuration script.

2.1 Check-Out APPN repository from Rational Team Concert

This steps need to be performed on your local workstation. For detailed instructions on working with Rational Team Concert please contact the Rational Support Team.

1. Open Rational Team Concert

2. Ensure that it is connected to the Small Applications (Change Management) repository connection (Work with Rational Support Team if this is not setup).

3. Navigate to Small Applications (Change Management) Builds

4. Expand the appropriate build for the environment you are deploying to (i.e.

“Production Deploy – P04”)

5. Right click on the build that represents the specific server you wish to deploy to, and select “Request Build”

Operations Program Management Office 6

3 Pre-Application Deployment The steps outlined in this section are steps that need to be completed before the Ap-plication is imported.

3.1 Deploy Appian 20.2 HF C

Note: this section should be deleted if there are no upgrades, patches or hotfixes to deploy.

Follow the instructions in the Appian documentation to install Appian version num-ber. Perform this step on each server that has Appian installed. Note that for Appian to start properly, the build configurations in the directory must be rede-ployed, which will be performed in section 4.4.

Operations Program Management Office 7

4 Application Deployment The steps outlined in this section will walk you through deploying applications to the Appian Shared Platform.

4.1 What’s New in the EMS September Release

4.1.1 Database Scripts setup

Execute the following script:

EMS 2020.7 - Step 01 - table and views.sql

4.1.2 Instructions for Emergency Rollback to earlier database state (if needed) If for some reason there is a need to roll-back the database to its previous state, restore the backup of the database.

4.1.3 EthicsMgt Database Changes

New table dbo.T_FinancialDisclosureDigitalSigna-tureExemption

Keeps track of Financial Disclosures that have an exemption from doing a digital signature and are doing an electronic signature instead

Altered views dbo.V_EthicsItemLinkToEthicsItemAnd- FinancialDisclosure

Added FinancialDisclosureStatusID and Eth-icsItemStatusID dbo.V_FinancialDisclosureXMLforPDF

Added Section subPart8, which has the following components:

subCertification/subCertAcknowledge-ment/Cert_chkAcknowledge1 subCertification/subCertAcknowledge-ment/Cert_chkAcknowledge2 subCertification/subCertAcknowledge-ment/Cert_chkAcknowledge3 subCertification/subCertAcknowledge-ment/Cert_chkAcknowledge4 subCertification/subEmployeeElectron-icSignature/TypedElectronicSignature subCertification/subEmployeeElectron-icSignature/ElectronicallySignedByUsername subCertification/subEmployeeElectron-icSignature/ElectronicallySignedDate

Deployment Document .

Operations Program Management Office 8 dbo.V_Recusal

Added the following columns which are used in dbo.V_RecusalForNSA:

UserEmployeeID ReviewCompleteDate ActionDesc RecusalIsActive

Restructured view so that it now uses Common Table Expression (CTE) dbo.V_RecusalForNSA Rewrote view so that it is new derived off of dbo.V_Recusal

4.2 Shutdown All Services

1) On the Tomcat server: Shut down the Tomcat service, and verify that the java process has stopped

2) Stop the Appian Search service.

3) On the Appian server: Stop Appian by running . When the command finishes, verify that no k processes are active and no Java processes are running (except for the one where you are shown as the User in taskmgr, all other java processes would have service account user).

4.3 Shared Platform Appian configuration

IInstallation Perform the following steps to apply the hotfix:

1. Stop Appian. See Starting and Stopping Appian for detailed instructions:

1. Shut down the application server.

2. Shut down the search server.

3. Shut down the data server.

4. Shutdown all Appian Engines, ensuring that the engines are check-pointed upon shutdown.

2. Back up your existing Appian instance. See Backing Up Your Existing Ap-pian Instance for instructions.

3. Unzip the contents of the HHotfix_Package. archive into your <AP- PIAN_HOME> directory.

Operations Program Management Office 9

4. Run the ddeleteFiles script (deleteFiles.bat on Windows, deleteFiles.sh on Linux) that is now located in your <APPIAN_HOME> directory.

o If the script reports that some files were not deleted, address the rea-son for the failure (common causes listed below), and run it again until it no longer reports failed deletions.

o Common causes of failed file deletion include:

o The file is open in another window or process o The file is locked o You do not have permission to delete the file

5. Unzip the contents of the uupdates.zip archive that is now located your <AP- PIAN_HOME> directory.

6. Run the iinstallJdk script (installJdk.bat on Windows, installJdk.sh on Linux).

7. If you maintain customized or overridden Spring Security .xml files, merge them with the associated base files in the /deployment/web.war/WEB- INF/conf/security/ directory.

8. Delete the ddeleteFiles scripts, the iinstallJdk scripts, the OOpenJDK ..tar.gz and ..zip files, and uupdates.zip.

9. If you are using a Web server, copy the content of <APPIAN_HOME>/deploy-ment/web.war to the folder where the Web server is getting the static re-sources. See Copy Static Resources to the Web Server for more information.

10.Run the configure script to deploy your environment's configuration

11.Start Appian:

0. Start the Appian Engines.

1. Start the data server.

2. Start the search server.

3. Start the application server.

To determine if Appian 20.2 Hotfix Package C is deployed, open the bbuild.info file located in <APPIAN_HOME>/conf/.

Operations Program Management Office 10

4.4 Application Import

This Section describes how to Import the Applications. Both the Appian Services and Tomcat must be running. The regular application files are located under the directory. Applications are located in the directory speci-fied below. All objects should be deployed in the order given.

Tip: To prevent your session from timing out during extensive imports, keep the process modeler open.

4.4.1 Deploy OCC Common Objects

Deploy the OCC Common Objects app, as it is a prerequisite of the following apps.

(Since this app is frequently updated, this step is permanent).

1) APPN\etc\Process_Applications\OCC Common Objects.zip

4.4.2 EMS – September 2020 Release

1) APPN\Products\EMS\Patch_Applications\Release_2020.7_Applications\EMS 2020.7\EMS 2020.7.zip

Include the import customization file.

1) APPN\Products\EMS\Patch_Applications\Release_2020.7_Applications\EMS 2020.7\EMS 2020.7.properties

4.4.3 ITR September 2020 Patch Release

ITR requires two patch installations to its two applications.

1) In Jazz, navigate to APPN Dev Stream > APPN > APPN > Products > ITR > Patch_Applications > ITR September 2020 release (please be careful not to

2) Retrieve two packages:

a. ITR CDT and Groups - Patch - 2020-09-09_1016.zip

b. ITR FM All Objects - Patch - 2020-09-09_1016.zip

3) In Appian production shared external, open application ITR CDT and Groups;

and import patch ITR CDT and Groups - Patch - 2020-09-09_1016.zip

4) AAfter completing the prior import, in Appian production shared external, open application ITR FM All Objects; and import patch ITR FM All Objects - Patch

- 2020-09-09_1016.zip

Operations Program Management Office 11

Operations Program Management Office 12

5 Post-Deployment Procedures After applications have been imported into Appian, the Administrator may need to perform several additional activities to complete the application configuration or to update running process to reflect changes made during the sprint.

All actions must be completed a System Administrator.

5.1 Take Full App Exports

We must ensure that each product has a full application containing all pertinent ob-jects which is exported and checked into our version control system, Jazz. These need to exclude any “Common Objects”.

For each app deployment import that was done this release, please do the following as a system administrator in the design interface:

1) Identify the correct full application for the product (It is usually named with just the acronym of the product, i.e. “EMS”) and open it.

2) Click on “Add Existing”, and choose “Application Contents”

3) Add the release application that was imported in the Application Import sec-tion for this Product.

a. Do nnot add the common objects application, or any application that was not specific to this product

4) Export the product application

5) Check it into the repository under APPN/Products/<Product Name>/Prod-uct_Applications

a. Overwrite the existing app there with the same name.

6) Check in and deliver the applications in Rational Jazz

5.2 Restart App Server

Before running post deployment steps, the Tomcat Application Server should be re-started. This is recommended by Appian in order to ensure that the cache is refreshed after importing many objects.