Introduction
eCASE is a .NET web application running on an IIS Server. eCASE is a comprehensive Webbased case management platform that allows users to implement business applications that can automate business process, workflows and interactions between case workers and
employees/public. It uses SQL Server database to store all data and content repository to store all documents.
eCASE includes the following standard application modules:
Case Management: A robust platform for implementing multiple coexisting adaptive case management (ACM) solutions with a single commercial off-the-shelf (COTS) solution.
Correspondence: A robust application for capturing, storing, retrieving, processing, tracking, and reporting correspondence action items.
Human Resources: A centralized solution upon which multiple workflow-driven HR applications can be configured, providing a consistent user interface and tracking/reporting capabilities across the department.
Portal: A website that allows eCASE users the ability to access and submit forms which are generated as folders in eCASE for further processing.
Audit: A comprehensive audit and investigations process management solution, built to support the complete audit life cycle for Offices of Inspectors General (OIGs).
Scope
The purpose of this document is to provide instructions for configuring the eCASE database on the application server and configuring Native DMS within the eCASE application.
Information presented in this document expects Windows 2016 R2/2019 Server installed on each server.
This document does not provide instructions for installing Windows 2016 R2/2019 R2 Server. Please consult your software vendor for further details concerning this installation. A single
server can be used to install eCASE and all its components, however it is highly recommended to configure separate servers for the application, database, and repository due to the processing demands of the CPU.
The following figure illustrates a high-level overview of the eCASE architecture.
Acronyms, Abbreviations, and Definitions
Acronym/ Abbreviation | Definition |
CPU | Central Processing Unit |
GUID | Globally Unique Identifier |
IIS | Internet Information Service |
LDAP | Lightweight Directory Access Protocol |
NTLM | NT Local Area Network Manager (Microsoft windows network) |
Portable Document Format | |
RM | Records Management |
SMTP | Simple Mail Transfer Protocol |
SP1 | Service Pack 1 |
SQL | Structured Query Language |
SSL | Secure Sockets Layer |
URL | Uniform Resource Locator |
XML | Extensible Markup Language |
eCASE System Architecture
The figure below shows the standard eCASE System Architecture
The eCASE platform components are as follows:
Microsoft SQL Server 2016/17/19/2022: The purpose of these servers is to create and store a database that will be used to retrieve and store data requested by eCASE and other related applications within the working environment.
Notes:
For SQL Server 2019, Cumulative Update 8 for SQL Server 2019 (CU8) must be installed.
For SQL Server 2019, the compatibility mode must be manually set to SQL 2017.
eCASE Application Server: The purpose of this server is to store the eCASE application.
eCASE Scheduler Server: The purpose of this server is to run eCASE Scheduler Services.
Repository Server: eCASE supports two types of repositories. One is Native DMS and Microsoft SharePoint. This server is mandatory when Repository Type is selected as SharePoint is to successfully install and use the eCASE application. The purpose of this server is to store the SharePoint application which will be used as a repository for data created while using eCASE.
If Repository type is selected as Native DMS, this server is optional. You can create the DMS folder in eCASE Application Server itself.
The eCASE application and all other components can be installed on a single server if the organization and workload is minimal. However, it is highly recommended to use the database, eCASE application, and SharePoint application (if Repository type is selected as SharePoint) on separate servers due to the high volume of processing required by the CPU.
eCASE Database Server
Below are the minimum requirements for the database server:
Hardware | 4 Core Intel Xeon E5-2640 2.50 GHz 8 GB RAM 150 GB SCSI hard drive with RAID 5 configuration Hard Drives to be 7200 rpm or faster 1000 MB Ethernet (NIC) |
Operating System | Windows Server 2016 R2/2019 with the latest service packs |
Software | Microsoft SQL server 2016/17/19 with Full Text Search 64-bit Database Engines are supported |
Microsoft SQL Server have specific requirements for installation. Please see the following link for Hardware and Software Requirements for Microsoft SQL Server 2017:
Notes:
For SQL Server 2019, Cumulative Update 8 for SQL Server 2019 (CU8) must be installed.
For SQL Server 2019, the compatibility mode must be manually set to SQL 2017.
eCASE Scheduler Server
Below are the minimum requirements for the database server:
Hardware | 4 Core Intel Xeon E5-2640 2.50 GHz 8 GB RAM 150 GB SCSI hard drive with RAID 5 configuration Hard Drives to be 7200 rpm or faster 1000 MB Ethernet (NIC) |
Operating System | Windows Server 2016 R2/2019 with the latest service packs |
Software | Microsoft .NET Framework 4.8 eCASE Scheduler Service |
eCASE Application Server
Below are the minimum requirements for the eCASE application server:
Hardware | 4 Core Intel Xeon E5-2640 2.50 GHz 8 GB RAM 200 GB SCSI hard drive with RAID 5; Hard drive to be 7200 rpm faster 1000 MB Ethernet (NIC) |
Operating System | Windows Server 2016 R2/2019 with the latest service packs |
Software | Microsoft .NET Framework 4.8 Microsoft IIS 10 (Web Server) |
IIS is not installed or enabled by default in the Microsoft Windows Server 2016 R2 operating system. To successfully install eCASE you must first install and enable IIS. Please refer to the following link for details on installing IIS 10 on Windows Server 2016.
http://enterprise.arcgis.com/en/web-adaptor/latest/install/iis/enable-iis-2016-componentsserver.htm
eCASE Portal Server
Below are the minimum requirements for the eCASE Portal server:
Hardware | 4 Core Intel Xeon E5-2640 2.50 GHz 8 GB RAM 200 GB SCSI hard drive with RAID 5; Hard drive to be 7200 rpm or faster 1000 MB Ethernet (NIC) |
Operating System | Windows Server 2016 R2/2019 with the latest service packs |
Software | Microsoft .NET Framework 4.8 Microsoft IIS 10 (Web Server) eCASE Scheduler Service |
IIS is not installed or enabled by default in the Microsoft Windows Server 2016 R2/2019 operating system. To successfully install eCASE you must first install and enable IIS. Please refer to the following link for details on installing IIS 10 on Windows Server 2016: http://enterprise.arcgis.com/en/web-adaptor/latest/install/iis/enable-iis-2016-componentsserver.htm
eCASE Portal Database Server
Below are the minimum requirements for the database server:
Hardware | 4 Core Intel Xeon E5-2640 2.50 GHz 4 GB RAM 150 GB SCSI hard drive with RAID 5 configuration Hard Drives to be 7200 rpm or faster 1000 MB Ethernet (NIC) |
Operating System | Windows Server 2016 R2/2019 with the latest service packs |
Software | Microsoft SQL Server 2016/17/19/22 with Full Text Search 64-bit Database Engines are supported |
Microsoft SQL Server have specific requirements for installation. Please refer to the following links for Hardware and Software Requirements for Microsoft SQL Server 2017: https://docs.microsoft.com/en-us/sql/sql-server/install/hardware-and-softwarerequirements-for-installing-sql-server?view=sql-server-2017
NOTE: For SQL Server 2019, Cumulative Update 8 for SQL Server 2019 (CU8) must be installed. SQL Server 2019, the compatibility mode must be manually set to SQL 2017.
As with any application, an increase in the number of records will result in the necessity of additional storage for the serverās hard drive. Additionally, an increase in the number of concurrent users on a server will result in an increase of RAM required for that server. For further information concerning additional memory or hard disk space for the Repository server please consult with your hardware and/or software vendor.
Client Workstation
Below are the minimum requirements for the Client Workstation:
Hardware | Intel Core i3/i5/i7, 2.0 GHZ processor or higher 4 GB RAM or higher 80 GB or higher IDE/SCSI hard drive 1000 MB Ethernet (NIC) CD ROM or DVD Drive (Optional) |
Operating System | Windows 10 |
Software | New Microsoft Edge 84, Google Chrome 84 Microsoft.NET Framework 4.8 Microsoft Office 2013/2016 |
Scanning Workstation
Below are the minimum requirements for the Scanning Workstation:
Hardware | Intel Core i3/i5/i7, 2.0 GHZ processor or higher 4 GB RAM or higher 80 GB or higher IDE/SCSI hard drive 1000 MB Ethernet (NIC) CD ROM or DVD Drive (Optional) |
Operating System | Windows 10 |
Software | New Microsoft Edge 84, or Google Chrome 84 Microsoft.NET Framework 4.8 |
Scanner | Scanner should support TWAIN Drivers and have an optical resolution of 300dpi |
NOTE: Please consult with your hardware and/or software vendor for further details regarding your specific scanning device.
Virtualization Server
Below are the minimum requirements for a virtualized server:
Configuration | 4 Core processor 8 GBRAM 40 GB SCSI disk |
Operating System | Windows Server 2016 R2/2019 with the latest service packs |
Software | Microsoft .NET Framework 4.8 |
NOTE: Based on your agencyās environment, this server may require additional RAM or hard disk space and may include additional software applications not mentioned in this manual.
Getting Started
Before proceeding with the setup, it is necessary to install Microsoft SQL Server
2016/2017/2019/2022 on the database server. For further information regarding the installation of these products, please consult your software vendor.
NOTE: The SMTP Server must be configured to relay email messages to other domains.
For SQL Server 2019, Cumulative Update 8 for SQL Server 2019 (CU8) must be installed.
eCase Database Account Requirements
There are two accounts you must setup to configure the application, database, and repository servers. The table below outlines the type of accounts, their purpose, and requirements.
Account | Purpose | Requirement |
Application Setup | This user will install and configure the eCASE application and its Services. | This account is setup as a Domain/Local User and is a member of the Administrators on server groups. |
eCASE Database Creation | This user setups the eCASE database user account and grants required permissions. | This account is added to the following SQL SERVER security roles for the user that will create the database either in SQL Server (Window User) or Windows Authentication Mode (NT User):
|
Process Workflow Diagram
The flowchart below displays the workflow of the eCASE setup.
About This Document
This manual is intended to guide system administrators through the required steps to deploy eCase within their organization.
eCase Installation Package
The eCase installation package is a zip file containing all the files needed to install eCase, Scheduler, and database. Your customized installation is driven by the values set in the Inputs.Json file located at the root of directory where the zip file is extracted.
Contact casepoint support at support@casepoint.com for your installation package.
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 eCase deployment. Please take the time to thoroughly review and fulfill the requirements outlined in this section before moving on to the next steps.
NOTE: These prerequisites apply to new installations. For upgrades to existing environments, see the Upgrading ECase section.
From version 11.4.1 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 ECase 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:
Requirement | Description |
Location | Deployment scripts can be executed from Application server. The script must be executed from application server if the Application or Scheduler are installed. |
Requirement | Description |
User Permissions | The logged-in user should have the local administrator permissions. |
Operating System Requirements | Windows 2016/2019/2022 |
Microsoft .NET Framework 4.8 Runtime | Microsoft .NET Framework 4.8 Runtime must be downloaded and installed. It can be downloaded and installed from the following location: https://dotnet.microsoft.com/en-us/download/dotnet-framework/net48 |
SqlPackage | The SqlPackage must be downloaded and installed. It can be downloaded and installed from the following location: https://learn.microsoft.com/en-us/sql/tools/sqlpackage/ release-notes-sqlpackage?view=sql-server-ver16#162557-sqlpackage |
SqlServer | The SqlServer module must be downloaded and installed on the application server. See the Install SQL Server Module section for steps. |
PowerShell Version | PowerShell 5.1.22621.963 must be installed for deployment using auto deployment. https://www.microsoft.com/en-us/download/details.aspx? id=54616 |
Microsoft Visual C++ Redistributable | The Microsoft Visual C++ Redistributable must be downloaded and installed on the application server for all new FX installs. Note: Both executables below must be |
Requirement | Description |
downloaded and installed. https://aka.ms/vs/17/release/vc_redist.x64.exe https://download.microsoft.com/download/1/6/5/165255E7-1014-4D0A-B094-B6A430A6BFFC/vcredist_x64.exe | |
Web Socket Feature | Install web socket feature of IIS. https://learn.microsoft.com/en-us/iis/configuration/system.web server/websocket |
eCase Database Account Permission
The user needs SysAdmin Permission to perform these actions.
Database Readiness for Upgrades
Prior to deploying eCase, we must first execute an analysis of the database. This analysis is intended to identify discrepancies between the production database and the application schema. The following prerequisites must be met to execute the database analysis and proceeding with the upgrade:
Full Text Search on SQL Server
eCASE can be configured to use Windows Search Service or eCASE Search Service for full text searching. If Window Search Service is preferred, then enable Windows Search Service on eCASE Application Server. Otherwise, enable eCASE Search Service as described in this document.
Enable Windows Search Service
This section describes how to enable Windows Search Service by configuring the Windows Index Server for the Native Document Management System.
The procedural steps in this chapter apply to Windows Server 2019.
Steps to Enable Windows Search Service
This section provides step-by-step through the process of enabling the Windows Search Service.
Click Start, and then click Server Manager.
Click Add Roles and Features, and then click Next.
In the navigation panel on the right, click Installation Type, and then click Role-based or feature-base installation.
In the navigation panel on the right, click Server Selection, click Select a server from the server pool, under Server Pool, click the name of a server, and then click Next.
In the navigation panel on the right, click Server Roles, and then:
a. Select File and Storage Services (1 of 12 installed).
b. Select File and iSCSI Services (0 of 11 installed).
c. Select File Server.
d. Click Next.
In the navigation panel on the right, click Features, and then select Windows Search Service.
In the navigation panel on the right, click Confirmation, and then click Install.
In the navigation panel on the right, click Results. After the installation process finishes, click Close.
Steps to Enable Windows Search Service for Use with .TIFF and .PDF files
This section describes how to configure the Windows Search Service to include .tiff and .pdf files in searches. This feature is disabled by default in Windows Server 2012 R2. The Full Text Search Options 11 installation process involves enabling the IFilter feature in Windows Search Service and installing the Adobe PDF IFilter from the Adobe. To enable Windows Search Service:
Click Start, click All Programs, click Administrative Tools, and then click Server Manager.
Click Add Roles and Features, and then click Next.
Download and install Adobe PDF iFilter. This is available on the Adobe website.
After installing Adobe PDF IFilter, restart the Windows Search Service.
Document Management System (DMS) File Storage Location
This section describes how to configure the Windows Search Service to include the file storage area location in searches. The steps described below apply to Windows Server 2012 R2. To enable Windows Search Service for the Native Database Mirroring file storage location.
Launch the Control Panel, click Index Options, and then click Modify.
Remove all locations in the index except the eCASE Native DMS file storage location.
Ensure the search service account has read access to the eCASE Native DMS file storage location.
Click Advanced, and then click Rebuild.
eCase Platform inputs.json Attributes
The eCase Platform can now be installed via an install.ps1 Powershell script that is present in the root of the install package. This package will be copied to a temp area and extracted. We now need to configure the inputs.json file before running the Powershell script. If this has been run before, you can simply copy a previously configured inputs.json into this location.
This is a simple JSON file will all attributes are at the top level. Here is a a description of each attribute:
Attributes | Description |
APP_NAME | Always Required. This is the logical name of the this application. Because these new automated scripts allow us to install multiple eCase installations on the same machine, we need to name each of them uniquely. This name will be used as a subdirectory under the INSTALL_LOCAION as well as names for the IIS App Pool and Website, as well as the scheduler service name. |
INSTALL_LOCATION | Where you would like eCase to be installed (or where it already exists if it is to be upgraded). The APP_NAME is automatically append as a subdirectory to this. For example, if your APP_NAME=nedUAT and the INSTALL_LOCATION=C:\Program Files, this eCase instance will go under C:\Program Files\nedUAT |
BACKUP_LOCATION | During an upgrade on uninstallation, we would typically backup the directory structure. This is the root location where backup should reside. A directory with the APP_NAME and a date/time stamp will |
automatically be created under this location for each backup performed. | |
BACKUP_BEFORE_UPGRADE | Defaults to "Y". This will backup the eCase folder before an upgrade takes place. In development environments it may be useful to set this to N to save time |
ECASE_DEVELOPMENT_MO DE | Defaults to "N". If set to "Y" it will force the database and application to upgrade every time (even if it is already on the latest version). This is useful for developing and QA-ing the latest version as this will be pushed several times prior to release. This implies that artifacts (particular the current version's database upgrade script) are re-runnable multiple times without erroring out. |
INSTALL_DB | Required. Set to "Y" for to install/upgrade the database component and "N" to bypass the database install/upgrade for eCase platform. |
INSTALL_APP | Required. Set to "Y" for to install the IIS components for eCase platform or "N" to bypass. |
INSTALL_SCHEDULER | Required. Set to "Y" for to install the Windows Service for the ECase Scheduler or "N" to bypass. NOTE: At least one of INSTALL_DB, INSTALL_APP, or INSTALL_SCHEDULER should be set to Y |
INSTALL_TIMEXPRESS_DB | Required. Set to "Y" for to install/upgrade the TimeXpress database components and "N" to bypass. |
INSTALL_TIMEXPRESS_APP | Required. Set to "Y" for to install the IIS components for TimeXpress platform or "N" to bypass. NOTE: If TimeXpress is not desired, you should set both INSTALL_TIMEXPRESS_DB and INSTALL_TIMEXPRESS_APP to "N" |
INSTALL_OCR | Required. Set to "Y" for to install the OCR Components within eCase or "N" to bypass. NOTE: You must install eCase platform components at the same time or before installing OCR Components. If this is set to "Y" and eCase platform components are not installed, you will receive an error |
INSTALL_DRM | Required. Set to "Y" for to install the DRM Components within eCase |
or "N" to bypass. NOTE: If INSTALL_DRM is set to "Y" then INSTALL_OCR must also be set to "Y". Additionally, you must install eCase platform components at the same time or before installing DRM Components. If this is set to "Y" and eCase platform components are not installed, you will receive an error | |
DB_SERVER | The SQL Server database server on which the eCase Platform database resides |
DB_PORT | The SQL Server database port number. This is optional and will default to 1433 if not specified |
DB_NAME | The name of the SQL Server database on DB_SERVER that will host eCase. |
CREATE_NEW_DB | Defaults to Y. If IS_NEW = Y the script will use the DB_ADMIN_USER/DB_ADMIN_PASSWORD credentials below to create the database. If the database will be pre-created via some other means (because you do not wish to provide the admin credentials to the installer) this should be set to N so it will assume the database and DB_USER account already exists |
DB_ADMIN_USER | An administrative user that has the ability to create and delete the eCase database, as well as query all database to see if the eCase database exits. If you pass in 'Y' as the second parameter to install.ps1, it will prompt for user names and password in which case you do not have to include this in inputs.json or can set to a default value |
DB_ADMIN_PASSWORD | Password for DB_ADMIN_USER. If you pass in 'Y' as the second parameter to install.ps1, it will prompt for user names and password in which case you do not have to include this in inputs.json or can set to a dummy value |
DB_USER | A database user that has the full update access to DB_NAME database. This is the user that the application will run as. This installer will create this user if it does not already exist in the database. If you pass in 'Y' as the second parameter to install.ps1, it will prompt for user names and password in which case you do not have to include this in inputs.json or can set to |
a default value | |
DB_PASSWORD | Password for DB_USER. If you pass in 'Y' as the second parameter to install.ps1, it will prompt for user names and password in which case you do not have to include this in inputs.json or can set to a dummy value |
DB_SUFFIX | Suffix that will be appended to the Connection String for specifying additional parameters. You may leave blank or not specify if there is nothing else to add. |
APP_PORT | The HTTP(S) port at which the application will listen. This might be a standard port like 80 or 443 or something different. NOTE: This is only used for new installs where an IIS site may need to be created |
INSTALL_SSL | For new installs where the IIS site does not exist, set to "Y" to configure the binding for SSL and configure the below certificate related properties. Otherwise, leave as "N" and the default HTTP binding will be used. |
CERT_PATH | If INSTALL_SLL=Y, this should point to a file path of a Windows PFX file that contains the public and private keys used for securing the site |
CERT_PASSWORD | If INSTALL_SLL=Y, this should be the password for the above CERT_FILE. If you pass in 'Y' as the second parameter to install.ps1, it will prompt for this password in which case you do not have to include this in inputs.json or can set to a dummy value |
DNS_NAME | This should be the DNS name that will be used for the site as it would be accessed by users. This will be used to create the ApplicationURL string that will be used through the application. This would generally be the same host name for CERT_FILE PFX file references. |
ECASE_INTERNAL_URL | Optionally, this can be set to an internal URL for eCase that would be used for other internal systems that need to call eCase web services. Specifically, OnlyOffice will initiate calls to eCase web |
services and it is usually best to use an internal URL to avoid additional network overhead with the external URL and, worse, avoid problem with a network route not being open to the external URL (from the internal server) | |
ONLYOFFICE_URL | This is the URL of OnlyOffice to which this eCase instance should reference for online document editing. This only needs to include the scheme, hostname and port (if applicable). For example, https://onlyoffice.casepoint.com Please note that for customer environments this will need to be a public/external URL because the user's browser will need to interact with this endpoint. |
INDEXING_DIRECTORY_PAT H | Optionally, this can be set to a root directory (locally or network-based) where document indexes will be used for attachment search (dtSearch index location). If this is not specified, it will be stored under C:\Program Data on the application server |
LICENSE_FILE | This points to an eCase license file (.adf file) to be used during the installation. This is only used for the DB_INSTALL part of the installation. |
ECASE_LOGIN_USER | Username of the initial user for eCase to create. NOTE: This is only used for new database installs |
ECASE_LOGIN_PASSWORD | Password for ECASE_LOGIN_USER. NOTE: This is only used for new database installs |
ECASE_LOGIN_EMAIL | Email address for ECASE_LOGIN_USER. NOTE: This is only used for new database installs |
ECASE_LOGIN_FIRST_NAME | First name for ECASE_LOGIN_USER. NOTE: This is only used for new database installs |
ECASE_LOGIN_LAST_NAME | Last name for ECASE_LOGIN_USER. NOTE: This is only used for new database installs |
ECASE_SYSTEM_EMAIL | Email address to set for the built in system user. NOTE: This is only used for new database installs |
ORGANIZATION_NAME | Initial Organization Name be be created during new eCase installs. NOTE: This is only used for new database installs |
OFFICE_CODE | Initial Office Code be be created during new eCase installs. NOTE: This is only used for new database installs |
OFFICE_DESC | Initial Office Description be be created during new eCase installs. NOTE: This is only used for new database installs |
FISCAL_YEAR | Initial Fiscal Year be be created during new eCase installs in YYYY format. NOTE: This is only used for new database installs |
FISCAL_YEAR_START | Date that FISCAL_YEAR starts in MM/DD/YYYY format. NOTE: This is only used for new database installs |
FISCAL_YEAR_END | Date that FISCAL_YEAR ends in MM/DD/YYYY format. NOTE: This is only used for new database installs |
DOC_LIB_NAME | The logical name of the initial document library (i.e. attachment repository) to be created during new eCase installs. NOTE: This is only used for new database installs |
DOC_LIB_ROOT | The absolute path to the root of the initial document library. NOTE: This is only used for new database installs |
DOC_LIB_CAPACITY_MB | The initial capacity of the document library. This should an integer that will be the number of megabytes (MB) to allocate. NOTE: This is only used for new database installs |
SMTP_SERVER | The email relay server that eCase should be pointed to during new installations. NOTE: This is only used for new database installs |
EnablePrompts | Optional. If set to "Y" and a database upgrade is being performed, as prompt dialog will appear reminding you to backup the database before continuing. NOTE: This is only used for upgrade database installs |
APP_POOL | Optional. This is the IIS App Pool that should be created for application installations. It will only be created if it does not already exist. If not specified, this defaults to APP_NAME + "Pool" |
APP_POOL_USER | Optional. This is the Windows user under which the Application Pool should run. If not specified, this default to "Network Service" |
APP_POOL_USER_PASSWOR D | If APP_POOL_USER is defined and you do not wish to be be prompted for passwords, you must provide the password for the |
APP_POOL_USER here. The default user (Network Service) does not require a password. If omitted and APP_POOL_USER is set to a custom value, the install script will prompt for this password | |
SCHEDULER_USER | Optional. This is the Windows user under which the Scheduler Service should run. If not specified, this default to "Network Service" |
SCHEDULER_USER_PASSWO RD | If SCHEDULER_USER is defined and you do not wish to be be prompted for passwords, you must provide the password for the SCHEDULER_USER here. The default user (Network Service) does not require a password. If omitted and SCHEDULER_USER is set to a custom value, the install script will prompt for this password |
SITE_NAME | Optional. This is the IIS WebSite that should be created for application installations. It will only be created if it does not already exist. If not specified, this defaults to APP_NAME + "Site" |
SHARED_IIS_SITE | Optional. If the IIS WebSite defined by SITE_NAME is to be shared with other applications (including other instances of eCase), this should be set to "Y". Setting this to Y will have the effect of prepending all the web applications installed to this site with the APP_NAME-. Normally, the web applications installed under this site would be: eCase, eCaseAdmin, eCaseOData. However, if SHARED_IIS_SITE=Y and APP_NAME=Ned, the web application would be named Ned-eCase, Ned-eCaseAdmin, Ned-eCaseOData. This allows us to install multiple instances of eCase under the same IIS WebSite if desired. Additionally, if this is set to "Y", during uninstall the IIS Website will not be removed (only the web application installed under them will be removed). The defaults to unless SITE_NAME is set to "Default Web Site" in which case it defaults to Y |
SHARED_IIS_POOL | Optional. If the IIS AppPool defined by APP_POOL is to be shared with other applications (including other instances of eCase), this should be set to "Y". If this is set to "Y", during uninstall the IIS AppPool will not be removed. The defaults to unless APP_POOL is set to "DefaultAppPool" in which case it defaults to Y |
HAS_PORTAL | Optional. If the the customer using the eCase Portal application and |
you wish to insert or update the EC_CONFIGURATION records related to the Portal (using the below values) this should be set to Y and one or more of the below values populated. It will also enable the PortaSyncJob. If this is set to N, it will disable the PortalSyncJob. If HAS_PORTAL is blank or not defined, no action will be taken on the database | |
PORTAL_URL | Optional. If HAS_PORTAL = Y and this is populated, the EC_CONFIGURATION for PortalServiceUrl will be updated |
PORTAL_SENDER_EMAIL | Optional. If HAS_PORTAL = Y and this is populated, the EC_CONFIGURATION for SenderEmailAddress will be updated |
PORTAL_SENDER_DISPLAY_ NAME | Optional. If HAS_PORTAL = Y and this is populated, the EC_CONFIGURATION for SenderDisplayName will be updated |
UNINSTALL_DB | Used only when uninstall.ps1 is being invoked. If set to "Y" the eCase database will be dropped during uninstallation |
UNINSTALL_APP | Used only when uninstall.ps1 is being invoked. If set to "Y" the eCase IIS ad Windows Service components will be removed during uninstallation. Default to "N". NOTE: at least one of UNINSTALL_DB or UNINSTALL_APP must be set to Y when running uninstall.ps1 |
BACKUP_BEFORE_UNINSTAL L | Used only when uninstall.ps1 is being invoked. If set to "Y", the eCase directory structure will be backed up prior to uninstallation. Defaults to "Y" |
Deployment Procedure
The deployment of eCase should be performed in accordance with the steps outlined below.
Review Prerequisites
Ensure that all Application Installation Prerequisites have been reviewed and fulfilled prior to proceeding.
Download Packages
Obtain the latest installation packages for eCase and COTS applications from the provided SFTP location.
Prepare the Directory Structure
Extract the eCase package to a suitable location.
Example: E:\eCaseSetups\eCase
Create a subdirectory named COTS within the extracted eCase directory.
Example: E:\Share\eCaseSetups\eCase\COTS\
Copy all downloaded COTS application ZIP files into the newly created
COTS directory.
Configure and Run Installation
Complete the inputs.json file with the appropriate configuration details and execute the install.ps1 PowerShell script to initiate the installation process.
For OIG applications, ensure that the corresponding OIG-related COTS ZIP files are downloaded.
The OIG application suite includes the following modules:
Audit
Investigations
Training
Inventory
Correspondence
The ZIP file names typically follow the format below:
eCase.AuditManagement_X.X.X.X-Release
eCase.Investigations_X.X.X.X-Release
eCase.InvestigationsTraining_X.X.X.X-Release
eCase.InvestigationsInventory_X.X.X.X-Release
eCase.Correspondence_X.X.X.X-Release
Place only the relevant COTS application ZIP files inside the COTS directory corresponding to the applications you intend to install or upgrade.
For guidance on completing the inputs.json file, refer to Section 6.2 ā Inputs.json Settings for New/Upgrade Installations.
For instructions on executing the install.ps1 script, refer to Section 6.3 ā Run Install.ps1.
The installer will install both eCase platform and COTS applications.
Inputs.json Settings for New/Upgrade Installations
Requirement | Description |
INSTALL_LOCATION | Set to root location where eCase should be installed such as C:\ \Program Files |
BACKUP_LOCATION | Set to root location where any backups will be taken, subdirectories with datetime names will be automatically created under here for each backup. Example: C:\\eCaseBackups |
BACKUP_BEFORE_UPGRADE | Set to Y to take a backup before each upgrade, N to skip backup |
APP_NAME | Set to logical name of application such as UAT, QA,PROD,etc; a subdirectory under INSTALL_LOCATION will be created with this name |
INSTALL_DB | Set to Y to install or upgrade eCase database; N to skip database components |
INSTALL_APP | Set to Y to install or upgrade eCase IIS components; N to skip the IIS components |
INSTALL_SCHEDULER | Set to Y to install or upgrade eCase scheduler components; N to skip the scheduler components |
INSTALL_COTS | Set to Y to install or upgrade eCase COTS product (Audit/Investigations, etc). components; N to skip the COTS product components |
INSTALL_TIMEXPRESS_DB | Set to Y to install or upgrade TimeXpress database; N to skip TimeXpress database components |
INSTALL_TIMEXPRESS_APP | Set to Y to install or upgrade TimeXpress IIS components; N to skip the TimeXpress IIS components |
INSTALL_OCR | Set to Y to install OCR components into eCase; N otherwise |
INSTALL_DRM | Set to Y to install DRM components into eCase; N otherwise |
CREATE_NEW_DB | Set to Y if you are supplying DB_ADMIN_USER and DB_ADMIN_PASSWORD and would like the install to create the |
database itself for a new installation; N if the database will be precreated | |
DB_SERVER | Set to SQL server database server name as visiible from applicaiton server |
DB_PORT | Set to port number for SQL Server database; this is usually 1433 unless it changed for your instance |
DB_NAME | Set to eCase database name |
DB_SUFFIX | Set to any suffix that should be appended to SQL Server connection string that is used such as 'Encrypt=True'; leave blank if no special options required |
DB_ADMIN_USER | Set to SQL Server Admin user for a new install where database should be created, or leave blank to be prompted by the script |
DB_ADMIN_PASSWORD | Set to SQL Server Admin password for a new install where database should be created, or leave blank to be prompted by the script |
DB_USER | Set to SQL Server database user that the application will run as, or leave blank to be prompted by the script |
DB_PASSWORD | Set to SQL Server database user that the application will run as, or leave blank to be prompted by the script |
APP_PORT | Set to the IIS port that will be used by the application such as 80 (http) or 443 (https) or something custom |
INSTALL_SSL | Set to Y if below certificate should be installed into IIS, N if no certificate or if it will be managed outside of the installer |
CERT_PATH | C:\\ConfigureForINSTALL_SSL\\PathToPfxFile.pfx |
CERT_PASSWORD | Set to password used to access the above PFX file if applicable, or leave blank to be prompted by the script |
DNS_NAME | Set to the externally accessible application server host name |
APP_POOL_USER | Set to user name that should be used to run the eCase IIS application pool, or leave blank to use default of NT AUTHORITY\ \NETWORK SERVICE user |
APP_POOL_USER_PASSWOR | Set to password for above user or leave blank to be prompted by |
D | the script if needed |
SCHEDULER_USER | Set to user name that should be used to run the eCase Scheduler Windows Service, or leave blank to use default of NT AUTHORITY\ \NETWORK SERVICE user |
SCHEDULER_USER_PASSWO RD | Set to password for above user or leave blank to be prompted by the script if needed |
SITE_NAME | Set to IIS site name into which the eCase applications should be installed; this will be created if it does not exist; you can set to 'Default Web Site' to use IIS's default site |
ONLYOFFICE_URL | Set to externally accessible URL of OnlyOffice like this: https://onlyoffice.mydomain.com |
ECASE_INTERNAL_URL | Optionally set to an internal eCase URL that the OnlyOffice server can access if the external URL is not accessible. Use this format: https://myinternalhostname/eCase |
INDEXING_DIRECTORY_PAT H | Set to root directory or network path where eCase document indexes will be stored |
LICENSE_FILE | Set to path of license file supplied by Casepoint |
ECASE_LOGIN_USER | Default login username to be created with a new eCase installation such as 'Admin' |
ECASE_LOGIN_PASSWORD | Set to initial password to be used for above user or leave blank to be prompted by the script |
ECASE_LOGIN_EMAIL | Email address to be used for above user during new install |
ECASE_LOGIN_FIRST_NAME | First name to be used for above user during new install |
ECASE_LOGIN_LAST_NAME | Last name to be used for above user during new install |
ECASE_SYSTEM_EMAIL | System email to be used in eCase; this will be the default From email address that eCase will use |
ORGANIZATION_NAME | Organization name to be used for new installation like 'MyAgency' |
OFFICE_CODE | Office code to be used for new installation |
OFFICE_DESC | Description for above office code to be used for new installation |
FISCAL_YEAR | Initial fiscal year to be used for new installations such as '2026' |
FISCAL_YEAR_START | Fiscal year start date for new installations such as '10/01/2025' |
FISCAL_YEAR_END | Fiscal year end date for new installations such as '09/30/2026' |
DOC_LIB_NAME | Name of initial document repository for document attachments for new installations; this can be any logical name of letter and numbers (no spaces) |
DOC_LIB_ROOT | Root directory or network location for new installations such as 'C:\\Path\\To\\DMSRoot' |
DOC_LIB_CAPACITY_M B | Disk size in MB to allocate to the above location for new installations; for 100 GB, enter '100000' |
SMTP_SERVER | Host name or IP of SMTP server to create for new installations |
HAS_PORTAL | Set to Y if the eCase Portal is used with this installation |
PORTAL_URL | If HAS_PORTAL is Y, set this to Portal data service URL in this format: https://myPortalHost.agency.com/PortalDataServices/PortalDa taService.svc |
PORTAL_SENDER_EMA I | For new installations that use Portal, set to the email address Portal will use to send notifications |
PORTAL_SENDER_DISP LAY_NAME | For new installations that use Portal, set to the email display name Portal will use to send notifications |
UNINSTALL_DB | When running uninstall.ps1 script, set to Y to uninstall database or N to leave database intact |
UNINSTALL_APP | When running uninstall.ps1 script, set to Y to uninstall IIS/Scheduler components or N to leave these intact |
BACKUP_BEFORE_UNI NSTALL | Set to Y to make a backup for application directories before uninstalling or N to skip backup |
Run Install.ps1
Open Windows Powershell ISE.
Use PowerShell to navigate to the location where you extracted the installation package:
Type .\install.ps1 inputs.json N for either install or upgrade
eCase Portal inputs.json Attributes
Requirement | Description |
APP_NAME | Always Required. This is the logical name of the this application. Because these new automated scripts allow us to install multiple eCasePortal installations on the same machine, we need to name each of them uniquely. This name will be used as a subdirectory under the INSTALL_LOCAION as well as names for the IIS App Pool and Website, as well as the scheduler service name. |
INSTANCE_NAME | This is the logical name of the this application as defined inside the web.config file. If not specified, it will default to APP_NAME |
INSTALL_LOCATION | Where you would like eCase Portal to be installed (or where it already exists if it is to be upgraded). The APP_NAME is automatically append as a subdirectory to this. For example, if your APP_NAME=nedUAT and the INSTALL_LOCATION=C:\Program Files, this eCase instance will go under C:\Program Files\nedUAT |
BACKUP_LOCATION | During an upgrade or uninstallation, we would typically backup the directory structure. This is the root location where backup should reside. A directory with the APP_NAME and a date/time stamp will automatically be created under this location for each backup performed. |
IS_NEW | Required. Set to "Y" for new installations and "N" for upgrades. This pertains to the eCase Portal consisting of Portal web application, PortalAdmin web application, and PortalDataServices web application |
INSTALL_DB | Required. Set to "Y" for to install/upgrade the database component and "N" to bypass the database install/upgrade for eCase Portal. |
INSTALL_APP | Required. Set to "Y" for to install the IIS components for eCase Portal or "N" to bypass. |
DB_SERVER | The SQL Server database server on which the eCase Portal database resides |
DB_PORT | The SQL Server database port number. This is optional and will default to 1433 if not specified |
DB_NAME | The name of the SQL Server database on DB_SERVER that will host eCase Portal. |
CREATE_NEW_DB | Defaults to Y. If IS_NEW = Y the script will use the DB_ADMIN_USER/DB_ADMIN_PASSWORD credentials below to create the database. If the database will be pre-created via some other means (because you do not wish to provide the admin credentials to the installer) this should be set to N so it will assume the database and DB_USER account already exists |
DB_ADMIN_USER | An administrative user that has the ability to create and delete the eCase Portal database, as well as query all databases to see if the eCase Portal database already exits. If you pass in 'Y' as the second parameter to install.ps1, it will prompt for user names and password in which case you do not have to include this in inputs.json or can set to a default value |
DB_ADMIN_PASSWORD | Password for DB_ADMIN_USER. If you pass in 'Y' as the second parameter to install.ps1, it will prompt for user names and password in which case you do not have to include this in inputs.json or can set to a dummy value |
DB_USER | A database user that has the full update access to DB_NAME database. This is the user that the application will run as. This installer will create this user if it does not already exist in the database. If you pass in 'Y' as the second parameter to install.ps1, it will prompt for user names and password in which case you do not have to include this in inputs.json or can set to a default value |
DB_PASSWORD | Password for DB_USER. If you pass in 'Y' as the second parameter to install.ps1, it will prompt for user names and password in which case you do not have to include this in inputs.json or can set to a dummy value |
DB_SUFFIX | Suffix that will be appended to the Connection String for specifying |
additional parameters. You may leave blank or not specify if there is nothing else to add. | |
APP_PORT | The HTTP(S) port at which the application will listen. This might be a standard port like 80 or 443 or something different. NOTE: This is only used for new installs where an IIS site may need to be created |
INSTALL_SSL | For new installs where the IIS site does not exist, set to "Y" to configure the binding for SSL and configure the below certificate related properties. Otherwise, leave as "N" and the default HTTP binding will be used. |
CERT_PATH | If INSTALL_SLL=Y, this should point to a file path of a Windows PFX file that contains the public and private keys used for securing the site |
CERT_PASSWORD | If INSTALL_SLL=Y, this should be the password for the above CERT_FILE. If you pass in 'Y' as the second parameter to install.ps1, it will prompt for this password in which case you do not have to include this in inputs.json or can set to a dummy value |
DNS_NAME | If INSTALL_SLL=Y, this should be the DNS name that will be used for the site. This would generally be the same host name for CERT_FILE PFX file references. |
PORTAL_ADMIN_USER | User Id of Portal Admin User. If not specified, will be prompted on the command line |
PORTAL_ADMIN_PASSWOR D | Password for PORTAL_ADMIN_USER. If not specified, will be prompted on the command line |
EnablePrompts | Optional. If set to "Y" and a database upgrade is being performed, as prompt dialog will appear reminding you to backup the database before continuing. NOTE: This is only used for upgrade database installs |
APP_POOL | Optional. This is the IIS App Pool that should be created for application installations. It will only be created if it does not already exist. If not specified, this defaults to APP_NAME + "Pool" |
APP_POOL_USER | Optional. This is the Windows user under which the Application Pool should run. If not specified, this default to "Network Service" |
APP_POOL_USER_PASSWOR D | If APP_POOL_USER is defined and you do not wish to be be prompted for passwords, you must provide the password for the APP_POOL_USER here. The default user (Network Service) does not require a password. If omitted and APP_POOL_USER is set to a custom value, the install script will prompt for this password |
SITE_NAME | Optional. This is the IIS WebSite that should be created for application installations. It will only be created if it does not already exist. If not specified, this defaults to APP_NAME + "Site" |
SHARED_IIS_SITE | Optional. If the IIS WebSite defined by SITE_NAME is to be shared with other applications (including other instances of eCase), this should be set to "Y". Setting this to Y will have the effect of prepending all the web applications installed to this site with the APP_NAME-. Normally, the web applications installed under this site would be: eCasePortal, eCasePortalAdmin, eCasePortalDataServices. However, if SHARED_IIS_SITE=Y and APP_NAME=Ned, the web application would be named Ned-eCasePortal, Ned-eCasePortalAdmin, Ned-eCasePortalDataServices. This allows us to install multiple instances of eCase Portal under the same IIS WebSite if desired. Additionally, if this is set to "Y", during uninstall the IIS Website will not be removed (only the web application installed under them will be removed). The defaults to unless SITE_NAME is set to "Default Web Site" in which case it defaults to Y |
SHARED_IIS_POOL | Optional. If the IIS AppPool defined by APP_POOL is to be shared with other applications (including other instances of eCase), this should be set to "Y". If this is set to "Y", during uninstall the IIS AppPool will not be removed. The defaults to unless APP_POOL is set to "DefaultAppPool" in which case it defaults to Y |
UNINSTALL_DB | Used only when uninstall.ps1 is being invoked. If set to "Y" the eCase Portal database will be dropped during uninstallation |
UNINSTALL_APP | Used only when uninstall.ps1 is being invoked. If set to "Y" the eCase Portal IIS components will be removed during uninstallation. Default to "N". NOTE: at least one of UNINSTALL_DB or UNINSTALL_APP |
must be set to Y when running uninstall.ps1 | |
BACKUP_BEFORE_UNINSTA LL | Used only when uninstall.ps1 is being invoked. If set to "Y", the eCase Portal directory structure will be backed up prior to uninstallation. Defaults to "Y" |
Once configured, open a Powershell prompt to the directory containing install.ps1. When executing, it supports two command line arguments and will prompt you if they are not defined:
Path to inputs.json to use. This can be a relative or absolute path. Since you would normally be running the install.ps1 from the same directory, you can usually just provide the relative path "inputs.json"
Y/N Flag specifying whether or not to prompt for user credentials on the command prompt. If you wish to create an updated installation, you must configure all credentials in inputs.json and pass in "N" for this. If you pass in "Y", you do not have to configure the credentials in inputs.json and you will be prompted for them as part of the install process.
Deployment Procedure
The deployment of eCase should be performed in accordance with the steps outlined below.
Review Prerequisites
Ensure that all Application Installation Prerequisites have been reviewed and fulfilled prior to proceeding.
Download Packages
Obtain the latest installation packages for eCasePortal and COTS applications from the provided SFTP location.
Prepare the Directory Structure
Extract the eCasePortal package to a suitable location.
Example: E:\eCaseSetups\eCasePortal
Create a subdirectory named COTS within the extracted eCasePortal directory.
Example: E:\Share\eCaseSetups\eCasePortal\COTS\
Copy all downloaded COTS application ZIP files into the newly created
COTS directory.
Configure and Run Installation
Complete the inputs.json file with the appropriate configuration details and execute the install.ps1 PowerShell script to initiate the installation process.
For OIG Portal applications, ensure that the corresponding OIG-related COTS ZIP files are downloaded.
The OIG Portal application suite includes the following modules:
InvestigationsPortal: The ZIP file names typically follow the format below:
- eCase.InvestigationsPortal_X.X.X.X-Release
Place only the relevant COTS application ZIP files inside the COTS directory corresponding to the applications you intend to install or upgrade.
For guidance on completing the inputs.json file, refer to Section 7.2 ā Inputs.json Settings for New/Upgrade Installations.
For instructions on executing the install.ps1 script, refer to Section 7.3 ā Run Install.ps1.
The installer will install both eCase platform and COTS applications.
Inputs.json Settings for New/Upgrade Installations
Requirement | Description |
INSTALL_LOCATION | set to root location where eCase Portal should be installed such as C:\\Program Files |
BACKUP_LOCATION | set to root location where any backups will be taken, subdirectories with datetime names will be automatically created under here for each backup. Example: C:\ \eCaseBackups |
BACKUP_BEFORE_UPG RADE | set to Y to take a backup before each upgrade, N to skip backup |
APP_NAME | set to logical name of application such as UAT, QA,PROD,etc; a subdirectory under INSTALL_LOCATION will be created with this name |
INSTALL_DB | set to Y to install or upgrade eCase Portal database; N to skip database components |
INSTALL_APP | set to Y to install or upgrade eCase Portal IIS components; N to skip the IIS components |
INSTALL_COTS | set to Y to install or upgrade eCase Portal COTS product (e.g. Investigations Hotline, etc). components; N to skip the COTS product components |
PORTAL_ADMIN_USER | admin login username to be created with a new eCase Portal installation such as 'Admin' |
PORTAL_ADMIN_PASS WORD | set to initial password to be used for above user or leave blank to be prompted by the script |
CREATE_NEW_DB | set to Y if you are supplying DB_ADMIN_USER and DB_ADMIN_PASSWORD and would like the install to create the database itself for a new installation; N if the database will be precreated |
DB_SERVER | set to SQL server database server name as visiible from applicaiton server |
DB_PORT | set to port number for SQL Server database; this is usually 1433 unless it changed for your instance |
DB_NAME | set to eCase database name |
DB_SUFFIX | set to any suffix that should be appended to SQL Server connection string that is used such as 'Encrypt=True'; leave blank if no special options required |
DB_ADMIN_USER | set to SQL Server Admin user for a new install where database should be created, or leave blank to be prompted by the script |
DB_ADMIN_PASSWORD | set to SQL Server Admin password for a new install where database should be created, or leave blank to be prompted by the script |
DB_USER | set to SQL Server database user that the application will run as, or leave blank to be prompted by the script |
DB_PASSWORD | set to SQL Server database user that the application will run as, or leave blank to be prompted by the script |
APP_PORT | set to the IIS port that will be used by the application such as 80 (http) or 443 (https) or something custom |
INSTALL_SSL | set to Y if below certificate should be installed into IIS, N if no certificate or if it will be managed outside of the installer |
CERT_PATH | C:\\ConfigureForINSTALL_SSL\\PathToPfxFile.pfx |
CERT_PASSWORD | set to password used to access the above PFX file if applicable, or leave blank to be prompted by the script |
DNS_NAME | set to the externally accessible application server host name |
APP_POOL_USER | set to user name that should be used to run the eCase Portal IIS application pool, or leave blank to use default of NT AUTHORITY\\NETWORK SERVICE user |
APP_POOL_USER_PAS SWORD | set to password for above user or leave blank to be prompted by the script if needed |
SITE_NAME | set to IIS site name into which the eCase Portal applications should be installed; this will be created if it does not exist; you can set to 'Default Web Site' to use IIS's default site |
UNINSTALL_DB | when running uninstall.ps1 script, set to Y to uninstall database or N to leave database intact |
UNINSTALL_APP | when running uninstall.ps1 script, set to Y to uninstall IIS/Scheduler components or N to leave these intact |
BACKUP_BEFORE_UNI NSTALL | set to Y to make a backup for application directories before uninstalling or N to skip backup |
Run Install.ps1
Open Windows Powershell ISE.
Use PowerShell to navigate to the location where you extracted the installation package:
Type .\install.ps1 inputs.json N for either install or upgrade