Deployment Procedure

Deploying ATIPXpress follows the procedure outlined below. Each step is covered in the subsections in this manual.

1. Review the Application Installation Prerequisites

   1. If this is an Azure installation, also review the Azure Installation Prerequisites

   2. If this is an upgrade of an existing ATIPXpress application, review the Upgrading ATIPXpress section.

2. Download and verify the installation package, then extract the files.

3. Update the Inputs.json file with your deployment details.

4. Run Install.ps1

5. Perform post-installation procedures.

6. For Azure-based environments, also perform the Azure Post-Installation procedures.

Deployment Requirements

While the ATIPXpress deployment package (and this manual) are designed to be usable by anyone, we recommend that installation be completed by an experienced system administrator, as knowledge about your organization’s architecture are necessary to execute this deployment. It is important to check the person doing the installation has the level of access and the accounts specified in the Inputs.json have the access level needed for upgrading or installing the application, databases and services specified.  

Application Installation Prerequisites

The installation prerequisites are crucial as they outline the minimum system requirements and necessary preparations that need to be met before proceeding with the installation process. Ensuring that your system meets these prerequisites will ensure a smooth and successful ATIPXpress deployment. Please take the time to thoroughly review and fulfill the requirements outlined in this section before moving on to the next steps.

Notes:  These prerequisites apply to new installations. For upgrades to existing environments, see the Upgrading ATIPXpress section.

From version 11.4.0 onward, the application will only deploy with a valid HTTPS certificate.  

Recommended System Requirements

The Recommended System Requirements provides information about the environment required for setting up the ATIPXpress (AX) application. It outlines the recommended hardware and software to install the application and its related components. The manual also mentions basic networking recommendations to enhance performance.

Deployment System Requirements

The installation package must be deployed from the application server, which must meet the requirements outlined below:

Prerequisites Checklists

Prerequisites for the Application Server, Database, and Permissions are outlined in the following tables:

Application Server Checklist

Database Checklist

Note: These are the minimum requirements, and the actual requirements may change depending on the factors such as data size, number of documents and users, etc.

ATIPXpress Database Account Requirements

There are three accounts you must set up to configure the application, database, and repository servers. The table below outlines the type of accounts, their purpose, and requirements.

Account Permissions

Ensure the following accounts are granted full permissions as outlined below:

The above accounts must have full access to the file share path configured as the file repository location. The following folders will be created by the deployment tool under this file repository location (for on-prem deployments only). For AWS and Azure, the following folders should be manually created in the file repository location before running the deployment tool.  

The following table summarizes the permissions required on the subfolders in the file repository location.

Database Readiness for Upgrades

Prior to deploying ATIPXpress 11.3.0 or above, we must first execute an analysis of the database. This analysis is intended to identify and discrepancies between the production database and the application schema.

A dacpac tool is used to identify discrepancies in the current database version against the database schema. This tool generates a report of changes that will be made by the upgrade tool to the schema. On deploying the latest version of AX (11.3.0 or higher), the database automatically updates to the latest schema, and deletes any custom updates made to the customer’s schema.

It is crucial to run this report prior to an upgrade to gauge the impact of the upgrade on the customer system. The report must be analyzed by Casepoint for any potential issues or data loss prior to taking any further steps in deploying the application.

Install SQL Server Module

Follow the steps below to install the SQL Server Module on the application server:

1. Navigate to the following link:

https://www.powershellgallery.com/packages/Sqlserver/21.1.18256

2. Under Installation Options, select Manual Download:

3. Click Download the raw nupk file. The SQLserver .nupkg file downloads.

4. Locate the downloaded "SQLserver” file, then right click it and select Properties.

5. On the General tab, select Unblock, then click Apply.

6. Next, edit the “SQLserver” file extension from .nupkg to .zip.

7. Extract the .zip package in the downloaded location. After the folder is extracted, remove “sqlserver.” from the folder name:

8. Navigate to C:\ProgramFiles\WindowsPowerShell\Modules and create a folder called SqlServer.  

9. Copy the renamed .zip folder from the downloaded location to the SqlServer folder created in the previous step (C:\ProgramFiles\WindowsPowerShell\Modules\SqlServer)

Install Full Text Search on SQL Server

Note: The steps below are for SQL Server 2019. SQL Server 2016 and 2022 may require a different series of steps.

1. Copy the SQL Server setup files on the server where you want to install it or add it to existing installation. Right click the SQL Server setup file and select Run as Administrator….

2. The installation center screen appears where you’ll install the full text search feature. Click Installation on the left side of the screen.

3. Select the New SQL Server stand-alone installation or add features to an existing installation option.

4. The SQL Server Setup screen appears. Click the Next button to continue.

5. Setup files will be installed as part of the prerequisites. Once this is complete, the Next button will be enabled. Click Next to continue.

6. The Install Rules screen appears, which checks install rules. If no rules are failed, click the Next button to continue.

Note: If any rule returns a Warning, you can continue. You will not be able to continue if any failures are encountered.

1. The next screen will allow you to choose an existing instance to enable Full Text Search. Click the Add features to an existing instance of SQL Server radio button then click Next to continue.

2. The Feature Selection screen appears. Click the checkbox beside the Full-Text and Semantic Extractions for Search option, then click Next.  

3. At the Server Configuration screen, click Next.

4. The Ready to Install screen appears. When you’re ready to proceed, click Install.

5. The Installation Progress screen appears where you can track the installation using the progress bar. Wait until it is completed.

6. Once Full Text Search is installed successfully, the Complete screen appears. You can click on the link for the log file for this installation if you want to see more details.

7. Click the Close button to close the window. Full Text Search is now installed for your SQL Server instance, and you can create Full Text Catalogs and Indexes based on your requirements

HTTP Redirection and Activation

Install HTTP Redirection Feature

Prior to installing the application, you must install and configure the HTTP Redirection feature

on the IIS web server. This serves to navigate between ATIPXpress controls (Scan, Correspondence, Document Management, etc.).

Notes: Make sure to perform this installation on the application server.

You must install the Windows 2016, 2019, or 2022 on the application server for this feature to function properly.

URL to download hotfix: http://support.microsoft.com/kb/980368

1. Click Start > All Programs > Administrative Tools > Server Manager. The Server Manager application launches.

2. Click Roles.

3. Click IIS. The Servers screen appears.  

4. Select Add Roles and Features from the Tasks drop-down list. The Add Roles and Features wizard appears.  

5. Click Server Roles. The Add Role Services window opens displaying a list of services.

6. Click the Web Server (IIS) checkbox.  

7. Click Add Features.

8. Click Next. The Features list appears.  

9. Click Next. The Destination Server detail page appears.  

10. Click Next.  

11. Click the Web Server checkbox.  

12. Click the Common HTTP Features checkbox.

13. Click the HTTP Redirection checkbox under the Common HTTP Features node.

14. Click Next. The Confirm Installation Selections window opens displaying the feature to be installed.

15. Click Install. The Installation Progress window appears depicting the progress of the installation on the web server. This may take a few minutes.

16. Once the installation is completed, the Installation Results window appears confirming the feature(s) that was installed on the web server. Click Close to exit the application.

Install HTTP Activation Feature

Prior to installing the application, you must install and configure the HTTP Activation feature on the IIS web server. This is a required element for Microsoft .NET Framework 4.8.

1. Click Start > All Programs > Administrative Tools > Server Manager. The Server Manager application launches.

2. Right-click Features.

3. Click Roles.

4. Click IIS. The Servers screen appears.  

5. Select Add Roles and Features from the Tasks drop-down list. The Add Roles and Features wizard appears.  

6. Click Features. The Add Features window opens displaying a list of features.

7. Click .NET Framework 4.8 Features.

8. Click WCF Services.

9. Click the HTTP Activation checkbox. The Add Features Wizard window appears.

10. Click Add Features. The Add Features Wizard window closes. The Select Features window appears.

11. Click Next. The Confirm Installation Selections window appears.

12. Verify the components for installation are correct and click Install. The Installation Progress window appears.

13. Once the installation is completed, the Installation Results window appears confirming the feature(s) that was installed on the web server. Click Close.

Install CORS Module

For all installations (v11.8.0 and up) you must also install IIS CORS Module on the application server using the Web Platform Installer. The IIS CORS module allows the application to support the CORS protocol. Learn more and download the CORS module from the following location:

https://www.iis.net/downloads/microsoft/iis-cors-module

Database Installation

On a freshly installed SQL server, the following steps are required:

• Assign server-level permissions

• Create the database using a sysadmin account. In case of upgrade the DB already exists.

• Grant database-level permissions.

Performing the above actions requires a user account with sysadmin privileges.

Server Level Permissions

Commands:

1. Select FULLTEXTSERVICEPROPERTY('IsFULLTextInstalled')  

1. EXEC sp_configure 'show advanced options';  

If the output is not as expected, then configure using the following command and recheck. EXEC sp_configure 'show advanced options' , '1'; reconfigure;

1. EXEC sp_configure 'clr enabled';  

            Expected output is as shown below.  

If the output is not as expected, then configure using the following command and recheck. EXEC sp_configure 'clr enabled' , '1' reconfigure;

1. EXEC sp_configure 'clr strict security';

If the output is not as expected, then configure using the following command and recheck.

EXEC sp_configure 'clr strict security', 0; reconfigure;

GRANT VIEW ANY DEFINITION TO opxapp;

GRANT Create any Database TO opxapp;

GRANT View server state TO opxapp;

Create database with sysadmin user. Create user (username) to whom we’ll be giving permissions.

Database Level Permissions

Note: opxapp is the user with limited permissions. You can replace it with any username suitable.

USE [dbname];

CREATE USER opxapp FOR LOGIN opxapp;

GRANT SELECT, INSERT, UPDATE, DELETE ON DATABASE::[dbname] TO opxapp;

GRANT EXECUTE ON SCHEMA::dbo TO opxapp;  

GRANT REFERENCES ON SCHEMA::dbo TO opxapp;

GRANT ALTER TO opxapp;

GRANT CREATE TABLE TO opxapp;

GRANT CREATE PROCEDURE TO opxapp;

GRANT CREATE FUNCTION TO opxapp;

GRANT CREATE VIEW TO opxapp;

GRANT VIEW DEFINITION TO opxapp;

Note: In case of databases being restored please run the additional commands.

FX:

USE [dbname]

ALTER AUTHORIZATION ON FULLTEXT CATALOG::[CASE_FIELDS] TO [opxapp];

ALTER AUTHORIZATION ON FULLTEXT CATALOG::[CASESEARCH] TO [opxapp];

ALTER AUTHORIZATION ON FULLTEXT CATALOG::[CORRSEARCH] TO [opxapp];

ALTER AUTHORIZATION ON FULLTEXT CATALOG::[PAGESEARCH] TO [opxapp];

EDR:

USE [dbname]

ALTER AUTHORIZATION ON FULLTEXT CATALOG::[DIS] TO [opxapp];

COLLAB:

USE [dbname]

ALTER AUTHORIZATION ON FULLTEXT CATALOG::[CASE_FIELDS] TO [opxapp];

ALTER AUTHORIZATION ON FULLTEXT CATALOG::[CASESEARCH] TO [opxapp];

ALTER AUTHORIZATION ON FULLTEXT CATALOG::[CORRSEARCH] TO [opxapp];

ALTER AUTHORIZATION ON FULLTEXT CATALOG::[PAGESEARCH] TO [opxapp];

Azure Installation Prerequisites

Configure Azure SQL Database

Please refer to the following link for detail on using Azure SQL database.  

https://azure.microsoft.com/en-us/products/azure-sql/database

Use these RDS SQL server database details for your FOIAXpress application deployment if using AWS.

File Repository Setup

The first prerequisite for Azure installation is to create the required file repository. This is created through the Azure portal as a directory in an Azure File Share. To ensure full functionality, it is recommended that users access the Azure Portal site using Google Chrome or Microsoft Edge.  

Create Storage Account

Complete the steps below to create a storage account:

1. Navigate to the Azure portal and select Storage Accounts from the sidebar.

2. Add a new storage account to your resource group titled “fxfilestorage”.

3. Click Review + create.

Create ATIPXpress File Repository as a File Share

Complete the steps below to create the ATIPXpress File Repository/File Share:

1. Select the newly created storage account and click Files (or select Files under File Service from the inner sidebar).

2. Add a new File Shares to the storage account (“fxrepo”) and specify a disk size quota (>50GB is recommended).  

Note: The File Share is used to contain all documents uploaded into and generated by the AX application and should be sized accordingly.  

Note: After creation, the File Share is not immediately accessible, but it will appear after a short time (<5 minutes).  

Create ATIPXpress File Repository subfolders in the File Share

To create the necessary ATIPXpress File Repository Subfolders within the File Share:

1. Open the newly created file repository once available in the list of File Shares.  

2. Click Add Directory and add a new directory called AXRepo.

3. Within the AXRepo directory, add a new directory for each of the following folder names:  a. afxwcorl

   1. afxwdocs

   2. afxwdofl

   3. afxwerr

   4. afxwpng

4. After the required folders are created, click Connect from the Folder screen to view connection details.

5. Save the text content from the second PowerShell command – this contains the UNC path, and the Username and Password information that will be required in later configuration steps. The Username should be the name of the Storage Account that was created in the first step.

AWS Prerequisites

Configure Amazon Web Services RDS for SQL Server

Please refer to the following link for detail on using RDS for SQL server. Please use the RDS SQL server database details for your ATIPXpress application deployment if using AWS.

https://aws.amazon.com/rds/sqlserver/

File Repository Setup Using Amazon FSx

The link below provides details to configure an Amazon FSx shared storage for use with your ATIPXpress application.  

https://aws.amazon.com/fsx/windows/

When complete, this will enable a UNC path for a Windows file share for use in ATIPXpress to store AX documents and files. Please refer to the Application Installation Prerequisites for details on the permissions required for these file shares.

Upgrading ATIPXpress

This section provides steps and details for users upgrading an existing ATIPXpress environment to the latest version.

Upgrade Assumptions

Information presented in this section assumes that the applications listed below are installed on the server:

• Windows 2016/2019/2022 Server

• Microsoft .NET Framework 4.8

• Microsoft .NET Framework 4.8 is required to use the Permissions Migration tool.

• Previous version of ATIPXpress installed and configured.

Upgrade Prerequisites

Note: Important upgrade prerequisites were added for v11.3.0. Review the following section in full before proceeding.

Prior to deploying ATIPXpress 11.3.0 or above, we must first execute an analysis of the database. This analysis is intended to identify and discrepancies between the production database and the application schema.

A dacpac tool is used to identify discrepancies in the current database version against the database schema. Please contact Casepoint support to have this tool run on your application.

This tool generates a report of changes that will be made by the upgrade tool to the schema. On deploying the latest version of AX (11.3.0 or higher), the database automatically updates to the latest schema, and deletes any custom updates made to the customer’s schema.

It is crucial to run this report prior to an upgrade to gauge the impact of the upgrade on the customer system. The report must be analyzed by Casepoint for any potential issues or data loss prior to taking any further steps in deploying the application.

In addition, ensure you have fulfilled the prerequisites below:

• Backup the database(s) before upgrading.

• The upgrade installation must be performed on the database, application, and services servers.

Upgrading ATIPXpress

• A new license key is required. It is included in the Setup file, or was sent to you in a separate email. If you cannot find your key, please email support@Casepointtech.com.

• Speak with your ATIPXpress administrator before upgrading to determine how you want to convert your existing System, Request, and File Cabinet privileges to ATIPXpress’s new role-based permission structure. This can be done manually, or automatically during the upgrade. You must determine your approach before proceeding with the upgrade.

• If your agency has purchased the EDR module, please make a note of the EDR database name(s) before starting the upgrade process.  

• You must have full control permissions to all ATIPXpress folders, databases, and backup folders.

• The application upgrade can be run from the specific drive where your database and application servers have access. However, this guide is written assuming you have copied the application to the C: drives on the respective servers.

Download the Installation Package

The ATIPXpress installation package contains the files needed to install ATIPXpress and its associated components. Contact Casepoint support at support@Casepointtech.com for your installation package.

After downloading the package, follow the steps below to unzip the file:

1. Locate the downloaded .zip file, then right click it and select Properties.

2. On the General tab, select Unblock, then click Apply.

3. Next, unzip the contents of the folder. The contents of the package appear as shown in the following example:

Verify the Integrity of the Installation Package

Steps to verify the integrity of the installation package.

1. Open Windows Powershell ISE.

2. Use the command below to verify the integrity of installation package:

Test-FileCatalog -CatalogFilePath "<<catalog file path(with extension of .cat) from downloaded artifact>>" -Path "<< folder that should be validated against the catalog file >>"

3. It will show as valid, as shown in the following example:  

About the Installation Package

There are two primary files you’ll interact with during installation:

1. Inputs.json: Drives the installation of the ATIPXpress system components. The file is in a standard json format and needs to remain a valid json file for successful installation.

2. Install.ps1: The executable file you will run to deploy the installation package with the parameters configured in the Inputs.json file.

Inputs.json Settings for New Installations

About the Inputs.json File

The Inputs.json file located in the root directory of the extracted deployment package zip file drives the installation of the different components of the ATIPXpress system. The file is in a standard json format and needs to remain a valid json file post updates prior to the installation.  

The settings are grouped into sections, each addressing settings which may or may not require configuration, depending on your specific installation. The following subsections in this chapter describe each section of the Inputs.Json file.  

The parent node is the ‘inputs’ section. This section appears as follows:

Each section has parameters you can adjust to configure your installation. An example section is shown below, with an explanation for how it works:

Each (1) Section (“InstallType” in this example) includes various (2) Settings (“New” in this example) to configure.  

For each (A) Setting (“Upgrade” here), you can edit the (B) text in quotations (“N” here to indicate “No”) to configure the settings for your installation. This might include adding a file path, user name, password, or simply a “Y” or “N” depending on the field you are configuring.

The first section under the parent node is the Install Type. See the following section for details on configuring your install type, with the remaining sections following in the order they appear in the Inputs file.

Install Type

Use the “InstallType” section to determine if this is a new installation, or an upgrade for an existing system:

Install Components

The “Components” section allows you to determine which components to include with this installation. To include a component with your installation, be sure to assign the component a “Y” value on the corresponding line:

Application and Scheduler

The “APPANDSCHEDULER” section has settings related to the ATIPXpress application and scheduler installations. A value must be set for all values in this section to successfully install the application:

Note: any files paths specified must have two backslashes where a path in windows explorer requires a single backslash.  

Database Settings

The “DB” section contains the settings for installing or upgrading your ATIPXpress database.

In case of a new installation, an agent account will be created.

File Repository Settings

The “FileRepository” section contains the setting for different file paths used by the ATIPXpress application to store files.

Note: The “DocumentsComments” lines in this section are included to provide additional information and do not need to be edited or configured as part of the installation. Each comment line indicates the folder name you must use for the corresponding repository. File paths are required to have two backslashes for the regular one backslash used in specifying windows paths.

Authentication Settings

The “Authentication” section contains settings needed for ATIPXpress to authenticate using FORMS authentication after the application is installed:

SMTP Server Settings

The “SMTPServer” section contains setting for the application’s mail server:

EDR Settings

EDR Inputs

The “EDRDBS” section is used to store database settings for one or more EDR databases. The settings should specify the database server where the named database(s) should be installed using the CreaterDBUserId and password. If the AgentAccount is not present, the given AgentAccount must be created.

Multiple EDR Servers

You can configure multiple EDR Servers within the inputs.json file. Follow the steps below to configure multiple EDR Servers:

1. Configure the settings for the first EDR server using the existing fields.

2. Select and copy the fields under the EDRDBS section. Be sure to only copy the lines highlighted below:

3. Next place your cursor here, after the closing bracket that follows the last input field, and add a comma (“,”):

4. Next, paste the content you copied in step 2 after the comma you added in the previous step:

5. Configure the second set of EDRDBS fields with the details of the second EDR Server:

6. Repeat steps 2 through 6 to add more EDR servers as needed.

General Application Configuration

The “Configuration” section contains settings for initial install application configuration, setting up the basic details required to log in and get started in the application. This account is the primary administrator account for the application.

Inputs.json Settings for Upgrade

This section discusses the inputs.json settings used when upgrading an existing AX environment. For information on using the inputs.json file, see the About the Inputs.json File section of this manual.

Note: Some fields that would be required for a new installation should be left as-is for an upgrade. It is important to not edit or remove these fields as this could compromise the integrity of the inputs.json file. These are described where appropriate in the following sections.

Install Type

Use the “InstallType” section to determine if this is a new installation, or an upgrade for an existing system:

Install Components

The “Components” section allows you to determine which components to include with this upgrade. If you included a component in your previous installation, be sure to assign the component a “Y” value on the corresponding line:

Application and Scheduler

The “APPANDSCHEDULER” section only requires input in the InstallLocation and BackupLocation fields.  

Note: All fields not listed above can remain as-is during an upgrade.

Database Settings

The “DB” section contains the settings for installing or upgrading your ATIPXpress database. In case of a new installation, an agent account will be created.

Note: You do not need to edit the AgentAccount fields during an upgrade, these can remain as-is.

File Repository Settings

The “FileRepository” section contains the setting for different file paths used by the ATIPXpress application to store files.  

Notes:  These fields can remain as-is during the upgrade.

If these settings are ever updated, you must restart IIS on the application server. Failure to restart IIS on the application server after changing the file repository settings will cause cache-related issues

Authentication Settings

The “Authentication” section contains settings needed for ATIPXpress to authenticate using FORMS authentication after the application is installed. These fields can remain as-is during the upgrade.

Note: These fields can remain as-is during the upgrade.

SMTP Server Settings

The “SMTPServer” section contains setting for the application’s mail server. These fields can remain as-is during the upgrade.

Note: These fields can remain as-is during the upgrade.

EDR Settings

The “EDRDBS” section is used to store database settings for one or more EDR databases. The settings should specify the database server where the named database(s) should be installed using the CreaterDBUserId and password. If the AgentAccount is not present, you must create the given AgentAccount.

Note: You do not need to edit the AgentAccount fields during an upgrade, these can remain as-is.

General Application Configuration

The “Configuration” section contains settings for initial install application configuration, setting up the basic details required to log in and get started in the application. This account is the primary administrator account for the application.

Note: These fields can remain as-is during the upgrade.

Run Install.ps1

Before you are ready to run the Install.ps1 file, review the steps below to verify you’ve completed all the steps to this point:

• Ensure your system meets the minimum requirements outlined in the Deployment System Requirements section

• Make sure you have connectivity to the servers where the software is being installed

• Complete the procedures described in the Application Installation Prerequisites section

• Download, verify, and extract the ATIPXpress Installation package

• Configure the Inputs.json file for your installation

Once the above prerequisites are complete, follow the steps below to deploy the ATIPXpress Installation package.

1. Open Windows Powershell ISE

2. Use PowerShell to navigate to the location where you extracted the installation package:

3. Type .\install.ps1 for either install or upgrade.

4. If the inputs.json file is in same location as the extracted installation files, simply click enter to execute the installation. Alternatively, if you have file in different location provide this file location, then execute the script.

5. Once the inputs.json parameter is passed, it will ask whether to show/not to show prompts for passwords during the installation process. If you provided the password in the Inputs.json file, enter N. To enter the password manually, or if you did not enter the password in the Inputs.json file, enter Y. Next, hit Enter on your keyboard.

6. The installation procedure executes. See the following section for post-installation procedures to verify the application deployed successfully.  

7. If you elected to enter your password manually, you will be prompted to do so at times during the installation.  

Post-Installation Procedures

After successfully executing the install, you’ll want to complete the post-install procedures outlined in the following sections to ensure the application and associated components are present and accessible in the installed location.

ATIPXpress Site

Follow the steps below to verify creation of the ATIPXpress site:

1. Open IIS.

2. Click to expand the Default Web Site list:

3. Verify that the ATIPXpress application is listed.

Application Pool - FXAppPool Exists

Follow the steps below to verify that the application pool created for the application exists:

1. Open IIS.

2. Click to expand the Application Pools list:

3. Verify that the Application Pool specified in the inputs.json file is listed.

Database Check

Follow the steps below to check that the databases specified in inputs.json were successfully created:

1. Using management studio, connect to the database server specified in the Inputs.Json.

2. Login with the CreaterDBUserId login and password specified in the Inputs.Json.

3. Expand the list of databases.

4. Verify that the database specified in the Inputs.Json is listed.

5. Open up a query window and execute the following query.

select * from tblConfig where vckey = ‘Version’

6. In the row returned from this query, the vcValue should match the database version:

URL Access

To verify that the application successfully loads when accessing the URL, open a supported web browser and navigate to the configured application URL. The ATIPXpress log in screen appears as shown below. Enter the Admin credentials configured in the general settings section of the Inputs.json file (see General Application Configuration) to log in.

Update License

Follow the steps below to update the ATIPXpress license within the application:

1. Log in to ATIPXpress.

2. Navigate to Administration > Features and Licenses:

3. Select Upgrade Licenses.

4. The Upgrade Licenses window appears as shown below. Click Browse to locate and select the license file from your local machine or other network location.

5. After selecting the file, click Save to save your application license.

Add Scheduler Jobs

After installing FOIAXpress, you must manually add any required scheduler jobs via FOIAXpress Administration:

1. Log in to FOIAXpress.

2. Navigate to Administration > System Administration  

3. Click Scheduler Configuration. The Scheduler Configuration screen appears as shown below:

4. Select your respective scheduler and jobs from the drop-down lists. When you’ve configured your scheduled jobs, click Save to save the configuration.

EDR Post-Installation

EDR Database Password

For new installations which include the EDR module, the EDR Database Password must be manually updated within the application to enable EDR access. Follow the steps below to update the EDR password following application deployment.

1. Access the application as an Administrator and select Administration > Electronic Document Review (EDR) > EDR Databases:

2. Select the EDR database from the list then click Change Password:

3. Enter the EDR database password in the New Password and Confirm New Password fields, then click Save:

Calculate Page Count Job

A new job was added to EDR for v11.8.0 to calculate page counts. When completing a new installation or upgrading from version 11.7.2 or earlier, add the new EDR – Calculate Page Count job to the Scheduler Configuration (Administration > System Administration > Scheduler Configuration) to enable the EDR Page Count:

Logs

There are multiple logs that get generated during the installation that provide more detail:

• Databasedeploy.txt: Contains ATIPXpress database detailed deployment information.

• Edrdatabasedeploy.txt: contains EDR database detailed deployment information.

• ATIPXpress_Install_LOG_<date>.txt: Contains the top-level deployment log.

• Scheduler Logs: Scheduler log files will be in the ATIPXpress application log folder.

Pendo Integration

For SaaS customers, Pendo integration must be enabled when upgrading from any version below 11.5.1. This integration only needs to be enabled once.

Note: Pendo integration is only for SaaS customers and should not be enabled for on-prem installations.

To enable Pendo integration for SaaS customers:

1. Update the 'PendoIntegration' value to 'Y' by running the following query in the database:

   update tblConfig set vcValue='Y' where vcKey='PendoIntegration' and vcSection='General'

2. Use the IISRESET command to restart IIS.

API Installation

We’ve created the ATIPXpress API to allow for integration with external data monitoring applications. This is a standalone API that is included in the ATIPXpress installation package. This API must be installed separately from the ATIPXpress application, and users of the API must be authenticated application users with permissions to access the data being queried.

Notes:  The API is required for v11.7.0 and above.

The API must be upgraded along with the application. If you already have the API installed, you’re still required to upgrade the API to the latest version.

API Installation Prerequisites

The following prerequisites must be fulfilled to use the API:

• The application and the API must be on the same version. Update the application to the latest version before installing or upgrading the API.

• You must install .Net Core Hosting Bundle v.8.0.6:  

https://dotnet.microsoft.com/en-us/download/dotnet/thank-you/runtime-aspnetcore-

8.0.6-windows-hosting-bundle-installer

Unzip the Installation Package

The API installation package is included in the ATIPXpress application files. After downloading the package, follow the steps below to unzip the file:

1. Locate the downloaded .zip file, then right click it and select Properties.

2. On the General tab, select Unblock, then click Apply.

3. Next, unzip the contents of the folder. The contents of the package appear as shown in the following example:

About the Installation Package

There are two primary files you’ll interact with during installation:

1. Inputs.json: Drives the installation of the API components. The file is in a standard json format and needs to remain a valid json file for successful installation.

2. Install.ps1: The executable file you will run to deploy the installation package with the parameters configured in the Inputs.json file.

Inputs.Json Settings for Installation

The Inputs.json file located in the root directory of the extracted deployment package zip file drives the installation of the different components of the ATIPXpress API. The file is in a standard json format and needs to remain a valid json file post updates prior to the installation.  

The settings are grouped into sections, each addressing different parts of your installation. This section describes each part of the Inputs.Json file.  

Use the “InstallType” section to determine if this is a new installation, or an upgrade for an existing system:

The “API” section has settings related to the Collaboration Portal application and scheduler installations. A value must be set for all fields in this section to successfully install the application:

Notes:  For the SSLCert and AppPool fields, use the same values provided for ATIPXpress installation

Any files paths specified must have two backslashes where a path in windows explorer requires a single backslash.  

The “DB” section contains the settings for installing or upgrading your API database. In case of a new installation, an agent account will be created.

Note: Database details should be the same as used for the ATIPXpress installation.

Install the API

Before you are ready to run the Install.ps1 file, review the steps below to verify you’ve completed all the steps to this point:

• Make sure you have connectivity to the servers where the software is being installed.

• Download, verify, and extract the API Installation package.

• Configure the Inputs.json file for your installation.

Once the above prerequisites are complete, follow the steps below to deploy the API installation package.

1. Open Windows Powershell ISE.

2. Use PowerShell to navigate to the location where you extracted the installation package:

3. Type .\install.ps1 for either install or upgrade.

4. If the inputs.json file is in same location as the extracted installation files, simply click enter to execute the installation. Alternatively, if you have file in different location provide this file location, then execute the script.

5. The installation procedure executes. To verify the installation, launch the API

Managing API Access

About Authentication

Each API user must be authenticated before they are able to use the API. To provision API access, we’ve created an Access Token Tool which you’ll use to create tokens for each API user. These tokens are time limited and must be provisioned again after expiration. This expiration period is configurable, and we recommend a 30-day expiration period for these tokens.

Authentication using Access Token Tool

Each API user must be authenticated before they are able to use the API. To provision API access, we’ve created an Access Token Tool which you’ll use to create tokens for each API user. These tokens are time limited and must be provisioned again after expiration. This expiration period is configurable, and we recommend a 30-day expiration period for these tokens.

Follow the steps below to create access tokens for your API users:

1. When logged into the application as an Administrator, click your User Menu then select Access Token:

2. After selecting Access Token, the tool appears as shown in the following example:

3. You’ll use the fields on this screen to configure tokens for your API users. These are described below:

   1. The AccessToken ID is a random GUID which is assigned to each token. This is prepopulated.

   2. Enter a name in the Access Token Name field, which should help reference back to the token’s assignee.

   3. In the User field, enter the application username for the user who will be assigned this token. This must be a valid application username, and the user must have application permissions to view the request data they will be querying using the API.

   4. Enter an Expiration time for the token. The token will expire after the listed date, and a new token must be provided for that user to access the tool. Expiration options include 30 days, 60 days, 90 days, or you can use the Custom days option to configure a custom expiration period. Use the Calendar to select the custom expiration date

4. Click the Create button to create the token with the provided details.

5. After clicking Create, the screen refreshes to display the generated token. You can manually copy the token, or click Copy to copy it to your clipboard.

Note: You must copy the token from this screen, as the token is not stored anywhere in the application and cannot be retrieved once this screen is closed.

6. Save the copied token to a secure location, where you can retrieve it to authenticate this user.

7. You can also click Validate Access Token to check whether the token is currently validated. If validated, a pop up appears as shown below:

API Logs

You can view logs of actions taken in the API. These are available in the following location: <ATIPXpress_Install_Location>\Logs\ATIPXpress\API

If the default location is chosen, the logs should be located at: C:\Program Files\ATIPXpress\Logs\ATIPXpress\API

AI Assistant Integration

To integrate with the ATIPXpress AI Assistant, you must complete the following:

• Install CoreNLP, either via Docker or Java (both processes are outlined in the following sections)

• Configure the application with the ATIPXpress API and AI API details  

CoreNLP for Docker

Follow the steps in the section below to deploy CoreNLP using Docker.

Install Docker Desktop for Windows

You must have Docker Desktop installed. If you don’t have Docker Desktop installed, follow the steps below:

1. Download Docker Desktop: Visit the official Docker website and download the Docker Desktop version for Windows. Docker Desktop

2. Run the Installer: Execute the installer and follow the instructions. You may need to enable virtualization in your BIOS if it's not already activated.

3. Restart Your Computer: Restarting ensures all necessary features are activated and functioning.

4. Start Docker Desktop: Open Docker Desktop from the Start menu. It might take a while to initiate for the first time as it sets everything up.

Configure Docker Desktop

Check Settings: Click on the Docker icon in the system tray and open Settings or

Preferences. Make sure to adjust the memory and CPUs allocated according to the software's needs you plan to run CoreNLP.

Get the Docker Image for Stanford CoreNLP

1. Open Command Prompt or PowerShell: You can do this by searching for "cmd" or "PowerShell" in the Start menu and selecting the application.

2. Download the CoreNLP Docker Image: Run the following command to download the official image: Bash: docker pull nlpbox/corenlp

This command pulls the Docker image containing Stanford CoreNLP from Docker Hub.

Run CoreNLP Inside a Docker Container

Start the Container with Custom Settings: To use CoreNLP with extended timeout settings and a custom port, execute the following command:

Bash: docker run -p 59000:59000 -e TIMEOUT_MILLISECONDS=600000 -d nlpbox/corenlp

This command starts the Docker container exposing port 59000 for local use and sets the server's timeout to 600,000 milliseconds (10 minutes). The -d option ensures the container runs in "detached" mode, freeing up the command line for other uses.

Verify Execution

To check if the CoreNLP server is running correctly, you can try accessing http://localhost:59000 in your browser. If configured correctly, you should be able to see the Stanford CoreNLP web interface.

With these steps, Docker and Stanford CoreNLP are now set up on your Windows system with specific customizations to better suit your analysis needs and extended timeout settings.

Install CoreNLP Using Java

Install Java

Stanford CoreNLP requires Java 8 or later. If you do not already have this application installed on the application server, follow the steps below:

1. Download Java:

   1. Visit the Oracle website to download the Java JDK: Oracle JDK Downloads.

   2. Choose the appropriate Windows installer for your system architecture (32-bit or 64-bit).

2. Install Java:

   1. Run the downloaded installer and follow the installation instructions.

3. Verify Java Installation:

   1. Open Command Prompt and type:

Bash:  

java -version

• 1. This should display the installed version of Java. Ensure it is Java 8 or higher.

Download and Set Up Stanford CoreNLP Download Stanford CoreNLP:

1. Go to the Stanford CoreNLP official website:

https://stanfordnlp.github.io/CoreNLP/index.html

1. Download the latest version of Stanford CoreNLP zip file.

2. Once downloaded, extract the zip file to a directory of your choice, for example, C:\StanfordNLP.

Run Stanford CoreNLP Server

1. Launch the Stanford CoreNLP Server:

2. Open Command Prompt.

3. Navigate to the directory where you extracted Stanford CoreNLP:

Bash (example):

cd C:\StanfordNLP

4. Use the following command to start the server:

Bash:

java -mx4g -cp "*"

edu.stanford.nlp.pipeline.StanfordCoreNLPServer -port 59000 timeout 15000

Note: Port 59000 is an example, you are not required to use this port. If you change this value, use the updated value in the following section when entering the URL.

5. This command starts the CoreNLP server on port 59000 with a timeout of 15000 milliseconds and allocates 4 GB of memory to the process.

Verify the Server

1. Open a web browser and go to http://localhost:59000

Note: The “59000” value above is based on the port configured in the previous section. Use your configured port value in this URL.

2. You should see the Stanford CoreNLP server interface, indicating that the server is running and ready to process text. Leave this browser tab open, you'll need to retrieve this URL and add it to ATIPXpress configuration later in this process

Application Configuration

General Configuration

1. Log in to the application as an administrator and access Administration > System Configuration > General Configuration.

2. Under Application Next-Gen URL, copy and paste the API This should follow the format https://<IP>/ATIPXpressAPI where <IP> is the installed IP for the API.

3. In the AI API URL field, copy and paste the AI URL (from step 2 in section 10.11.2.4).

4. Click Save to save the configuration.

AI Roles and Permissions

There are three types of AI user permissions within the application:

1. AI Config Application Role Permission: Users with the AI Config application role permission can view and edit three AI configuration pages. Click the links below to learn more about these configuration pages:

   1. AI Redaction Templates

   2. Redaction Knowledge Base

   3. AI Trainers

2. AI User Role: Application users who are allowed to use the AI Assistant feature within document management. This is a license-based role, and all AI users must have an active license.

3. AI Trainer Role: A subset of the AI Users, AI Trainers are selected to feed redaction data into the Redaction Knowledge Base, which contains a repository of all redactions performed by AI Trainer to identify patterns and frequently encountered data.

Using the AI Assistant

There are two main components to the AI Assistant feature. AI Redaction Templates, and applying these templates to documents in Document Management. Follow the links below to learn more about using the AI Assistant with CoreNLP:

Using the AI Assistant

AI Redaction Templates

User Manual URL

An important note when upgrading to AX 11.7.2: you must manually update the User Manual URL in the General Settings. The incorrect link was provided as a default value in the setup files, so these must be corrected manually. Follow the steps below after upgrading to v11.7.2 to correct the manual link:

1. Log in to the application as an Administrator

2. Access Administration > System Configuration > General Configuration and locate the User Manual URL field:

3. In the User Manual URL field, paste the following over the existing link:

4. If no values are present in the Application Next-Gen API URL field, enter dummy data here to bypass the requirement (“x” for example).

5. Click Save.

6. Log out of the application, then log back in.

7. Click Help > Online Manual and verify that the correct version of the User Manual opens at the correct link (with v11.7.0 in the URL).

Azure Post-Installation Procedures

For environments using Azure, you must also complete the following procedures after running the installation file.  

Note: These steps only apply to Azure based environments.

Creating App Service on Azure Portal

Follow the steps below to crate the app service on the Azure portal:

1. Log in to the Azure portal and navigate to App Services in the left sidebar.

2. Select Add to create a new App Service. Click the Web App option and click the Create.

3. Enter the name the application (“fxapp”) in the App Name field and click Create.

Note: The newly created App Service is not immediately accessible but will appear after a short time (<5 minutes).  

Zip Deploy ATIPXpress to the Azure App Service

Follow the steps below to zip deploy AX to the Azure app service:

1. Click the newly created App Service (“fxapp”) and navigate to the Development Tools section in the middle pane. Select Advanced Tools and click Go in the right pane.

2. The site opens the Diagnostic Console in a new tab. Navigate to the new tab, click the Debug console drop-down list and select CMD.

3. Using either file browser at the top or the command line console at the bottom, add new folders for Application Logs by creating the path “D:\home\site\Logs\ATIPXpress”.

4. Navigate to D:\home\site\wwwroot and delete hostingstart.html.

5. Click the Tools drop down, and select Zip Push Deploy.

6. Locate the AzureApp.zip file provided in the ATIPXpress setup folder. Drag and drop the zip file onto the Kudu console and wait for 100% completion.

Note: Use Google Chrome or Microsoft Edge to ensure Drag and Drop functionality is available in the Kudu console.

Configure the ATIPXpress App Service

Follow the steps below to configure the AX app service:

1. Navigate to the Azure Portal tab in your browser and select Application Settings within the Settings section in the middle pane.

2. Within General Settings, make the following changes and click Save.

3. Change the PHP version to Off.

4. Change the Platform setting to 64-bit.

5. Change the Always On setting to On.

6. Scroll down to Application Settings, click + Add a new setting to add each of the following settings and click Save:

7. Within the Connection Strings section, click + Add to add a new connection string. Enter the following values, substituting YourSQLServerName, YourFXDatabaseName, YourFXDatabaseLoginID and YourFXDatabasePassword that was provided during ATIPXpress database creation:

8. Click Save.  

9. Navigate to the Default Documents section, remove all default entries, add login.aspx and click Save at the top of the pane.

10. Navigate back to the Overview section in the middle pane and click Browse to view the ATIPXpress application.

11. Once the application has finished loading, add ATIPXpress to your Trusted Sites.  

12. Click the cog at the top right of the screen and select Internet Options from the dropdown list.

13. In the Internet Options window that appears, navigate to the Security tab.

14. Select the Trusted sites zone and click Sites. The Trusted Sites pop-up window appears.

15. Click Add and enter the ATIPXpress site to the list of Trusted sites.

Services Server Setup

The next step in the ATIPXpress Azure setup installs and configures the ATIPXpress Scheduler Service in an Azure VM environment. Complete the following steps for each Service server in the ATIPXpress Azure environment.

Install Required Dependencies

Follow the steps below to install required dependencies:

1. In the local copy of the setup files, locate the ATIPXpress\Server\Setup\VCRedist folder.

2. Install both versions of the Microsoft Visual C++ Redistributables: “vcredist2015_x64.exe” and “vcredist2010_x64.exe”.  

Configure the ATIPXpress Scheduler Service

Once the installation is finished, the ATIPXpress Scheduler Service is further configured to permit access to the Azure File Shares created in the first step of the ATIPXpress Azure setup process. Follow the steps below to configure the AX scheduler service.

1. Create a new user account on the ATIPXpress Services server using the username and password information obtained after creating the Azure File Shares.  

2. In the example provided, username is “fxfilestorage” and password is

“44yH0quDSoAmapeAKVGoNhqh3vEhD169U8n8SSyYS2jNNSmj5Z7n2znBQ2tTZSElw4 GbE9RB/CwGesjesjyGlg==”.

3. Grant Read and Write permissions to the newly created user for the ATIPXpress Scheduler Service installation folder (“C:\Program Files\AINS ATIPXpress\”).

4. Grant Read and Write permissions to the newly-created user to the Windows system folder (“C:\Windows\Temp”) to permit access to the Temp folder and .NET Framework resources.

5. Navigate to Services from the start menu and locate the ATIPXpress Scheduler Service. Right click on the service and select Properties. Click on the Log On tab and configure the Service to log on using the newly created user account.

Steps to Configure Single Sign-On in Azure AD

The process to configure SSO in AD is described in the following steps:

1. Login to the Azure portal and create an application for ATIPXpress (under Enterprise Application), and Select Set up Single Sign On:

Note: While images in this manual are from the ATIPXpress configuration, the process is the same for this application.

2. Next, select SAML:

3. Under Basic SAML Configuration, click Edit:

4. Next, provide the (A) Identifier (Entity ID) and (B) Reply URL:

   1. Identifier (Entity ID): Enter the name of your application site, i.e. ATIPXpressTest

   2. Reply URL: Enter the following, using your org’s app URL: https://[YOUR APPLICATION URL]/foiaxpress/homepage.aspx

5. Mark both the Identifier and Reply URL as Default, then click Save.

6. Once complete, download the Federation Metadata XML and email it to your Casepoint Project Manager or Implementation Specialist.

EDR in Azure

EDR File Repository Setup

The file repository required by the EDR module is created on one of the Azure VM instances in the ATIPXpress Azure environment. Follow the steps below to create the repository:

1. Create a root-level repository folder in C:\ (“edrrepo”). Add the following subfolders: data, index, reports, and text.

2. Share the root folder with the user account created on the ATIPXpress Services server (“fxfilestorage”) with Read/Write access and note the UNC path that is designated for the share (“\\MachineName\edrrepo”).  

EDR File Repository Configuration

The ATIPXpress Database will also store information about the location of the EDR File Repository folders. Once the EDR File Repository folders are created, this information can be updated through the ATIPXpress web application.

1. Log in to the ATIPXpress web application using the admin user account.

2. Navigate to the Administration screen, select the Electronic Document Review (EDR) section in the sidebar and open the EDR Configuration menu.

3. Provide the relevant path information to the Path sections:

   1. Data Path Root, Index Path Root, Reports Path and Text Path Root are the UNC location of the corresponding Azure VM shared folders.

   2. EDR File Download Url is the URL associated with the EDRFileDownload web service (“http://<EDRServerIP>/EDRFILEDOWNLOAD”).