eUniversa Electronic Filing Application – System Setup/Upgrade Document
eUniversa
System Setup/Upgrade
(Installation)
Document
Copyright © American Cadastre, LLC - AMCAD®. All rights reserved.
No part of this publication may be reproduced, transmitted, transcribed, stored in a
retrieval system, or translated into any language, in any form or by any means,
electronic, mechanical, photocopying, recording, or otherwise, without prior written
permission from AMCAD®.
AMCAD®. 2016. All rights reserved
Page 1 of 63
eUniversa Electronic Filing Application – System Setup/Upgrade Document
Document Revisions:
Version
Date
#
Editors
Description of Change
1.0
01/31/2013
D V Rao
Creation
1.1
02/04/2013
GFerrigno
Review and Edits
AMCAD®. 2016. All rights reserved
Page 2 of 63
eUniversa Electronic Filing Application – System Setup/Upgrade Document
Table of Contents
DOCUMENT REVISIONS: ............................................................................................................................ 2
TABLE OF CONTENTS ............................................................................................................................... 3
1
INTRODUCTION AND ASSUMPTIONS ........................................................................................... 6
1.1
PURPOSE OF THIS DOCUMENT............................................................................................................ 6
1.2
ASSUMPTIONS .................................................................................................................................. 6
2
OVERVIEW OF INSTALLATION PROCESS AND UPGRADE PROCESS ..................................... 7
2.1
EUNIVERSA NEW INSTALLATION IS PERFORMED IN THIS FOLLOWING ORDER: ......................................... 7
2.2
EUNIVERSA UPGRADE IS PERFORMED IN THIS ORDER: ......................................................................... 7
2.3
HOT FIX PROCESS ............................................................................................................................. 8
3
PREREQUISITE FOR EUNIVERSA ENVIRONMENT ...................................................................... 9
4
EUNIVERSA DATABASE SETUP .................................................................................................. 12
4.1
CREATE LOGINS FOR EUNIVERSA..................................................................................................... 12
4.2
CREATE/RESTORE THE EUNIVERSA DATABASE ................................................................................. 12
4.3
DEFAULT SCRIPTS (EUNIVERSA INSTALLATION RELATED CONFIGURATION).......................................... 13
4.4
SQL BACKUPS................................................................................................................................ 13
4.5
BACKUPS AND HIGH AVAILABILITY .................................................................................................... 13
5
APPLICATION SERVER INSTALLATION...................................................................................... 14
5.1
PREREQUISITES .............................................................................................................................. 14
5.2
MULTIPLE APPLICATION SERVERS (IF APPLICABLE) ............................................................................ 14
5.3
UPGRADE/INSTALLATION ................................................................................................................. 14
5.4
IIS SITE INFORMATION .................................................................................................................... 19
5.5
IIS APPLICATION POOL INFORMATION/CONFIGURATION..................................................................... 20
5.6
APPLICATION SERVER COMPONENTS ............................................................................................... 21
5.7
ASSEMBLIES DEPLOYED INTO GLOBAL ASSEMLY CACHE (GAC) ........................................................ 23
5.8
SMTP SERVER CONFIGURATION ...................................................................................................... 24
5.9
TEMPORARY FILE LOCATION CONFIGURATION ................................................................................... 25
5.10
IMPERSONATION AND SPECIFYING IDENTITY FOR APPLICATIONS ......................................................... 25
5.11
SPECIFYING AICMS FILING REVIEW , COURT RECORD MDE ENDPOINTS .......................................... 26
5.12
EUNIVERSA APPLICATION SERVER - SHARED CONFIGURATION FILES ................................................. 27
5.12.1
web.config ...................................................................................................... 27
AMCAD®. 2016. All rights reserved
Page 3 of 63
eUniversa Electronic Filing Application – System Setup/Upgrade Document
5.12.2
Behaviors.config ............................................................................................. 27
5.12.3
Bindings.config ............................................................................................... 27
5.12.4
connectionStrings.config ................................................................................ 27
5.12.5
settings.config ................................................................................................ 27
5.12.6
SharedServiceSettings.config ........................................................................ 27
5.13
COURTS W EB SERVICE CONFIGURATION FILES................................................................................. 27
5.13.1
web.config ...................................................................................................... 27
5.13.2
settings.config ................................................................................................ 27
5.13.3
Service.config ................................................................................................. 27
5.13.4
diagnostics.config ........................................................................................... 27
5.14
MAILANDNEWS W EB SERVICE CONFIGURATION FILES ...................................................................... 27
5.14.1
web.config ...................................................................................................... 27
5.14.2
Service.config ................................................................................................. 27
5.15
PAYMENTGATEWAY W EB SERVICE CONFIGURATION FILES ................................................................ 27
5.15.1
web.config ...................................................................................................... 27
5.15.2
Service.config ................................................................................................. 27
5.16
REQUESTS W EB SERVICE CONFIGURATION FILES ............................................................................. 27
5.16.1
web.config ...................................................................................................... 27
5.16.2
Service.config ................................................................................................. 27
5.17
SECURITY W EB SERVICE CONFIGURATION FILES .............................................................................. 27
5.17.1
web.config ...................................................................................................... 27
5.17.2
settings.config ................................................................................................ 28
5.17.3
Service.config ................................................................................................. 28
5.18
SERVICEMANAGER W INDOWS SERVICE CONFIGURATION FILES ......................................................... 28
5.19
MIDDLEWARE LOGGING CONFIGURATION ......................................................................................... 33
5.20
SAMPLE OF MIDDLEWARE LOG FILE................................................................................................... 35
6
WEB SERVER INSTALLATION...................................................................................................... 36
6.1
PREREQUISITES .............................................................................................................................. 36
6.2
MULTIPLE W EB SERVERS (IF APPLICABLE)........................................................................................ 36
6.3
UPGRADE/INSTALLATION ................................................................................................................. 36
6.4
IIS SITE INFORMATION (W EB SERVER) ............................................................................................. 39
AMCAD®. 2016. All rights reserved
Page 4 of 63
eUniversa Electronic Filing Application – System Setup/Upgrade Document
6.5
IIS APPLICATION POOL INFORMATION/CONFIGURATION..................................................................... 40
6.6
W EB SERVER COMPONENTS ........................................................................................................... 41
7
NETWORK PORTS ......................................................................................................................... 43
8
VERIFICATION OF EUNIVERSA INSTALLATION ........................................................................ 44
APPENDIX A: ACTIVE DIRECTORY CREDENTIALS IN THE DATABASE ............................................ 48
APPENDIX B: ACTIVE DIRECTORY ACCOUNTS WITH WINDOWS PERMISSIONS ........................... 50
APPENDIX C: ENVIRONMENTAL VARIABLES SPREADSHEET TEMPLATE ...................................... 51
MULTIPLE AICMS INSTANCES/ENVIRONMENTS (IF APPLICABLE) ..................................................................... 51
APPENDIX D: ACTIVE DIRECTORY INTEGRATION .............................................................................. 52
ACTIVE DIRECTORY INTEGRATION MODES ................................................................................................... 52
DATABASE SETUP FOR ACTIVE DIRECTORY .................................................................................................. 54
ACTIVE DIRECTORY MANAGEMENT FROM THE APPLICATION: ......................................................................... 61
AMCAD®. 2016. All rights reserved
Page 5 of 63
eUniversa Electronic Filing Application – System Setup/Upgrade Document
1
Introduction and Assumptions
1.1
Purpose of this document
This document is intended to serve as an installation/upgrade guide for setting the
eUniversa Electronic Filing System environment with AICMS.
1.2
Assumptions
a) This document assumes that the reader has a basic understanding of Information
Technology (Windows administration and SQL Server database administration)
and has performed tasks such as creating shares, assigning permissions,
installing SQL server, start/stop services, event logs etc. This document also
assumes that the reader is familiar with deploying and maintaing web
applications using Internet information server and has perfomed tasks such as
creating Web sites , application pools and applications. If there are two or more
persons who share server administration and database administration
responsibilities, you can jointly perform these installation activities, however a
very integrated and collaborative approach is needed between team members.
b) It is also assumed that reader of this document understands the Environmental
Variables Spreadsheet provided in appendix C. If there are any questions on this
spreadsheet, please discuss with your AMCAD representative.
c) This document is written for all AMCAD clients, if there are things specific to your
installation please contact your AMCAD representative.
d) It is assumed that backup of databases and configuration files is always done
before making changes/doing upgrade
AMCAD®. 2016. All rights reserved
Page 6 of 63
eUniversa Electronic Filing Application – System Setup/Upgrade Document
2
Overview of installation process and upgrade
process
eUniversa installation is detailed in various sections throughout the
document; following is the overview of what it covered throughout this
document.
2.1
eUniversa new installation is performed in this following order:
1) Perform database backups if applicable.
2) Prepare/receive eUniversa database. Please make sure that this database
is configured / synced with the Environmental Variables Spreadsheets.
3) Install Application Server Components (Web Services and Windows
Service). Verify configuration files.
4) Install Web Server Components (Web Site). Verify configuration files.
5) Start Web Sites on Application/Web Servers (if not started), and Windows
Service on application
6) Check event log of application and web servers to make sure they started
properly and without any error
7) Verify eUniversa installation
2.2
eUniversa upgrade is performed in this order:
1) Stop all eFiling related windows services and Web Sites (on application
and Web Servers)
2) Perform eUniversa database backups. Keep backups of all config files as
well.
3) If database upgrade is performed by AMCAD, AMCAD representative will
execute the scripts to update your database. If you are upgrading the
AiCMS database on your own, please execute upgrade scripts provided
with each ETI (External test iteration). For example, if the database needs
to upgrade from 3.9.0.20 to 3.9.5.18, it has ETIs for 3.9.0.25, 3.9.0.30,
3.9.0.38, 3.9.0.44, 3.9.0.50, 3.9.5.10 and 3.9.5.18. For each ETI, database
upgrade scripts and instructions are provided by your AMCAD
representative, these scripts must execute in the correct order to have a
successful upgrade. Please document log, sequence and query results of
the execution of these scripts when the database upgrade is performed.
AMCAD®. 2016. All rights reserved
Page 7 of 63
eUniversa Electronic Filing Application – System Setup/Upgrade Document
For any troubleshooting with upgrade process, please provide this log to
your AMCAD representative.
4) Uninstall Application Server Components. Install Application Server
Components (Web Services, Windows Service). Verify configuration files
5) Uninstall Web Server Components. Install Web Server Components (Web
Site). Verify configuration files
6) Start Web Sites on Application/Web Servers (if not started), and
Windows Service on application
7) Check event log of the application and web servers to make sure they
started properly and without any error
8) Verify the upgrade
2.3
Hot fix process
1.
2.
3.
4.
5.
6.
7.
Bug is reported that meets critical criteria
Bug is duplicated/verified
Current Production/Release Candidate code is branched for a Hot Fix
Bug is resolved in the code branch
Internal testing verifies bug is fixed
Code is merged into Production/Release Candidate release
Hot Fix install package is released for on-site testing (only contains items
necessary to deploy the patch, usually not a full install)
8. Hot Fix is installed in Production/Release Candidate release
AMCAD®. 2016. All rights reserved
Page 8 of 63
eUniversa Electronic Filing Application – System Setup/Upgrade Document
3
Prerequisite for eUniversa environment
Below are the hardware and software requirements before eUniversa Electronic Filing
System can be installed. AMCAD assumes the server hardware requirements listed
below are for dedicated use by AMCAD applications; i.e. a server designated as the
eUniversa application Server should not be designated as a DNS, DHCP or Domain
Controller:
1) Please fill out Environmental Variables Spreadsheet provided in appendix C and
send it to your AMCAD representative 2 weeks prior to receiving the AiCMS
release. Please consult your AMCAD representative if needed. This spreadsheet
must be filled out for each AiCMS instance of each environment.
2) Database server for eUniversa (Optional): Please make sure that the
database server is ready with SQL Server 2008 / SQL Server 2008 R2 installed.
A dedicated database server for eUniversa is not required. Database server used
for running AICMS can be used as database server for eUniversa. Hardware
specifications listed below are for those circumstances when an existing SQL
server instance is not available for managing the eFiling database.
Hardware specifications for the database server:
a) Processor: Dual Quad-core CPU’s
b) Storage: Discuss with your AMCAD representative
c) Memory: 4 GB Memory – minimum, 8 GB Memory - recommended
Software specifications for the database server:
a) Operating system: Microsoft Windows Server 2008 R2 Enterprise
b) SQL Server: Microsoft SQL Server 2008 R2 Standard – minimum,
Microsoft SQL Server 2008 R2 Enterprise – recommended
c) .NET Framework 4.0 Full
3) Database server for Replication (Optional): See Database server for
replication requirements for AiCMS
AMCAD®. 2016. All rights reserved
Page 9 of 63
eUniversa Electronic Filing Application – System Setup/Upgrade Document
4) Temporary data Server (optional): If separate documents server is desired for
storing temporary filing data, please make sure that server is ready.
It is recommended to use:
 Microsoft 2 Node Failover cluster (Active/Passive)
 Storage should be on RAID5/6 Drive (SAN)
 Storage space: Please discuss with your AMCAD
representative
Hardware specifications for the server:



Processor: Dual-core
Memory: 16 GB minimum, 32GB recommended
Storage: Please discuss with your AMCAD representative


Microsoft Windows Server 2008 R2 Standard/Enterprise
.Net framework 4.0 full
Software:
5) eUniversa Application server (Required): Applciation server is required for
eUniversa installation.
Hardware specifications:
 Processor: Quad-core CPU
 Memory: 8 GB Memory – minimum, 16 GB Memory –
recommended
 Storage: Please discuss with your AMCAD representative
Software specifications

Operating system:





Microsoft Windows Server 2008 R2 Standard – minimum
Microsoft Windows Server 2008 R2 Enterprise –
recommended
.Net framework 4.0 Full
Microsoft C++ 2008/2010 Redistributable 64 bit and 32 bit
IIS 7.0 or above (after .NET framework is installed)
6) eUniversa Web server (Required): Web server is required for eUniversa
installation.
AMCAD®. 2016. All rights reserved
Page 10 of 63
eUniversa Electronic Filing Application – System Setup/Upgrade Document
Hardware specifications:
 Processor: Quad-core CPU
 Memory: 8 GB Memory – minimum, 16 GB Memory –
recommended
 Storage: Please contact your AMCAD representative
Software specifications

Operating system:

Microsoft Windows Server 2008 R2 Standard – minimum




Microsoft Windows Server 2008 R2 Enterprise –
recommended
.Net framework 4.0 Full
Microsoft C++ 2008/2010 Redistributable 64 bit and 32 bit
IIS 7.0 or above (after .NET framework is installed)
AMCAD®. 2016. All rights reserved
Page 11 of 63
eUniversa Electronic Filing Application – System Setup/Upgrade Document
4
eUniversa Database setup
4.1
Create Logins for eUniversa
The following logins are the standard eUniversa SQL Server logins.
1. Create eUnivesa login at database instance level:
CREATE LOGIN [euniversa]
WITH PASSWORD='<Desired Password>’,
DEFAULT_DATABASE=[master],
DEFAULT_LANGUAGE=[us_english],
CHECK_EXPIRATION=OFF,
CHECK_POLICY=OFF
(Please make sure that user name and password match with Environmental Variables
Variables. Please do not require password to expire to require password to be
changed at first login.)
4.2
Create/Restore the eUniversa database
1. If euniversa SQL Server database does not exist please create a new SQL
Server database for euniversa with the same name as referenced in the
Environmental Variables Spreadsheet.
2. Create backup of any existing eUniversa databases before doing a restore of the
AICMS database backup file with the syntax below:
RESTORE DATABASE [<AiCMS database name>]
FROM DISK = N'<AICMS Backup location>
WITH FILE = 1,
MOVE N'DAT' TO N'<Desired Data file location>,
MOVE N'LO' TO N'<Desired Log file location>ldf',
NOUNLOAD,
REPLACE,
STATS = 10
(If needed please consult your DBA staff for MDF and LDF file locations or
contact your AMCAD representative)
AMCAD®. 2016. All rights reserved
Page 12 of 63
eUniversa Electronic Filing Application – System Setup/Upgrade Document
4.3
Default Scripts (euniversa installation related configuration)
A script file based on Environmental Variables Spreadsheet may optionally be provided
by AMCAD, which will contain a set of default scripts that must be run anytime the
database is restored. It should be noted that eUniversa maintains environment specific
information in application configuration files and default scripts are not frequently used
4.4
SQL Backups
It is recommended that all databases are set to FULL recovery model (and not simple
recovery model). It is also recommended that database backups are stored in two
different storage locations. Frequency of transaction log backups and full database
backups will be determined by the client. Please contact your AMCAD representative if
needed.
4.5
Backups and High Availability
Business continuity plan and disaster recovery plan is defined by the client. Please
contact your AMCAD representative if needed.
AMCAD®. 2016. All rights reserved
Page 13 of 63
eUniversa Electronic Filing Application – System Setup/Upgrade Document
5
Application Server Installation
5.1
Prerequisites
Please check the prerequisite section in the document to make sure that eUniversa
Application server meets minimum required hardware and software specifications.You
must run the installer as a user with administrative previliges on the machine where
components are installed.
5.2
Multiple Application servers (if applicable)
Please check with your AMCAD representative if you are going to install application
server components into a load balanced (hardware/software) environment.
5.3
Upgrade/Installation
Please take backup of all the configuration files. List of application server component
configuration files are listed in section 5.4. If this is an upgrade, please make sure
previous version of the application server is uninstalled.
Open the Application
Server Installer
package provided by
your AMCAD
representative. (Double
click setup executable
file). Note Executable
file name may be
specific to your
installation but will
always end with
setup.exe. Note : You
must run the installer
as a user with
administrative
previlizes on the
machine where
components are
installed.
AMCAD®. 2016. All rights reserved
Page 14 of 63
eUniversa Electronic Filing Application – System Setup/Upgrade Document
The
eUniversa
Application
Server
Wizard will load. Click
“Next”.
Accept
the
agreement.
“Next”.
license
Click
The Custom installation
will allow you to select
the location that you
want to install the
application
server
components;
the
complete option will
install everything to the
default directory. Select
“Custom” and Click
“Next” to continue.
AMCAD®. 2016. All rights reserved
Page 15 of 63
eUniversa Electronic Filing Application – System Setup/Upgrade Document
Since the “Custom”
option is selected you
can change the location
that the features are
installed to by selecting
the feature and the
“Browse” button.. Click
“Next” to continue.
Click
“Install”
continue.
to
AMCAD®. 2016. All rights reserved
Page 16 of 63
eUniversa Electronic Filing Application – System Setup/Upgrade Document
Click
“Finish”
complete
installation.
to
the
Once the Installation is
completed you will
need to go to the
Services manager to
start the windows
service. You can do
this by going to Start ->
Run or using the
shortcut, Windows key
+ “r”.
Note: The Windows
Service “Amcad
Service Manager
Version 4.3” should not
be started until
database updates and
web services
configuration is
completed.
AMCAD®. 2016. All rights reserved
Page 17 of 63
eUniversa Electronic Filing Application – System Setup/Upgrade Document
In the Run Dialog type
“services.msc”
and
click “OK”
This will open the
Windows Services
Manager. Select the
service named in this
example: “Amcad
Service Manager
Version 4.3”.
If you are utilizing an
Active Directory user
for running the service
to read/write to
temporary file storage
(The AD account and
password is contained
in the Environmental
Variables
Spreadsheet), you will
need to double-click to
open this service, go to
the “Log On” tab, and
then enter the correct
logon information.
Otherwise, the service
will run as the local
system account.
Make sure that the web
services installed are
running and are
accessible Additionally,
if server/credential
information has not
AMCAD®. 2016. All rights reserved
Page 18 of 63
eUniversa Electronic Filing Application – System Setup/Upgrade Document
been provided to
AMCAD (through
Environmental
Variables Spreadsheet)
to build the packages,
you will need to
manually update the
config file as detailed in
sections below before
starting the service.
Once all this has been
done, highlight the
service and hit the
“Start” button.
5.4
IIS Site Information
Application Server installer by default installs a web site and binds it to port 15500 (or as
specified in the environmental variables work sheet). If a web site already is bound to
port 15500, installer skips the site creation step and deploys the application server
components under the existing web site. Web site if installed is bound to application
pool “AiCMS (or as specified in the the environmental variables work sheet). Web Site
by Home directory for default installation is “C:\Program Files\Amcad\eUniversa”, unless
a different folder is selected during the installation. This folder is referred to as
“APPHOMEMDIR” in the subsequent section. All application server components are
deployed under this folder.
AMCAD®. 2016. All rights reserved
Page 19 of 63
eUniversa Electronic Filing Application – System Setup/Upgrade Document
5.5
IIS Application Pool Information/Configuration
Application Server installer by default creates an application pool “AiCMS” (or as
specified in the the environmental variables work sheet) and binds it to .Net Framework
4.0.30319. It is recommened that idle timeout setting be changed to 0 (i.e. do not
shutdown due to inactivity) on production servers. Please see
http://technet.microsoft.com/en-us/library/cc753449(v=ws.10).aspx for additional
information on managing application pools.
AMCAD®. 2016. All rights reserved
Page 20 of 63
eUniversa Electronic Filing Application – System Setup/Upgrade Document
5.6
Application Server Components
See http://msdn.microsoft.com/en-us/library/ms178685(v=vs.100).aspx for information
on ASP.NET Configuration File Hierarchy and Inheritance. Individual files are
discussed below
Name
Type
AMCAD®. 2016. All rights reserved
Configuration Files
Remarks
Page 21 of 63
eUniversa Electronic Filing Application – System Setup/Upgrade Document
eUniversa
Application
Server
Web Site
[APPDIR]\web.config
Settings common to
application
[APPDIR]\Configuration\Behaviors.config all
components
[APPDIR]\ Configuration \Bindings.config
[APPDIR]\Configuration\connectionStrin
gs.config
[APPDIR]\ Configuration \settings.config
[APPDIR]\Configuration\SharedServiceS
ettings.config
Courts
Web
Service
[APPDIR]\courts\web.config
[APPDIR]\courts\Configuration\
settings.config
Service
operations
for supporting courts
filing operations
[APPDIR]\courts\Configuration\
Service.config
[APPDIR]\courts\Configuration\
diagnostics.config
MailAndNews
Web
Service
[APPDIR]\MailAndNews\web.config
PaymentGate
way
Web
Service
[APPDIR]\ PaymentGateway \web.config
Requests
Web
Service
[APPDIR]\ Requests\web.config
AMCAD®. 2016. All rights reserved
[APPDIR]\MailAndNews\Configuration\
Service.config
Service
operations
for supporting mail
and news operations
Service
operations
supporting
[APPDIR]\PaymentGateway\Configuratio for
payment processing
n\ Service.config
[APPDIR]\Requests\Configuration\
Service.config
Service
for
general
operations
supporting
filing
Page 22 of 63
eUniversa Electronic Filing Application – System Setup/Upgrade Document
operations
Security
Web
Service
[APPDIR]\Security\Configuration\
web.config
[APPDIR]\Security\Configuration\
settings.config
Service
operations
for
registration
,
security
[APPDIR]\Security\Configuration\
Service.config
ServiceMana
ger
5.7
Windows
Service
[APPDIR]\ServiceManager\Amcad.Servi
ceManagerQuartz.v4.3.exe.config
Windows
tasks
Assemblies deployed into Global Assemly Cache (GAC)
Following assemblies shared across applications are deployed into Global Assembly
Cache (GAC). Please see http://msdn.microsoft.com/enus/library/yf1d93sz(v=vs.100).aspx for additional information on Global Assembly
Cache
AMCAD®. 2016. All rights reserved
Page 23 of 63
Service
eUniversa Electronic Filing Application – System Setup/Upgrade Document
5.8
SMTP server configuration
SMTP Server configuration for web services is specified in site wide application
configuration file “ [APPDIR]\web.config” ( Example C:\Program
Files\Amcad\eUniversa\web.config” and for the windows service in application
configuration file
“[APPDIR]\ServiceManager\Amcad.ServiceManagerQuartz.v4.3.exe.config”. Please see
http://msdn.microsoft.com/en-us/library/w355a94k(v=vs.100).aspx for details of
“mailsettings” element.
Following is the mail settings element included in installer based on environment
variables worksheeet
<system.net>
<mailSettings>
<smtp from="efilingsupport@SMTP.OSCN.NET">
<network host="SMTP.OSCN.NET" port="25" defaultCredentials="true" />
</smtp>
</mailSettings>
</system.net>
AMCAD®. 2016. All rights reserved
Page 24 of 63
eUniversa Electronic Filing Application – System Setup/Upgrade Document
5.9
Temporary file location configuration
Temporaray file location is specified in the site wide configuration file “
[APPDIR]\Configuration \settings.config“ ( default C:\Program Files\Amcad\eUniversa\
\Configuration\settings.config) by the key "sharedDataHome". Value for this key must
be set to the location (must be a network share in a multi application server
environment) to write files to and read files from
<add key="sharedDataHome"
value="\\OKCUCMSCFS01\DATA\QA\Noble\eUniversa\"></add>
5.10
Impersonation and specifying identity for applications
Web Services running on the application server save temporary data into a location
specified in the site wide configuration file “ [APPDIR]\Configuration \settings.config“ (
see 5.9 above). Windows service tasks also running on the application server read and
write from this location. By default web services writing files to /reading files from this
share run under system account “NetworkService” (http://msdn.microsoft.com/enus/library/windows/desktop/ms684272(v=vs.85).aspx ). Windows Service reading and
writing files from this share also running on the application server by default run under
the system account “LocalSystem" http://msdn.microsoft.com/enus/library/windows/desktop/ms684190(v=vs.85).aspx . By default “NetworkService” and
“LocalSystem” can access locations on the local computer and does not have access to
network locations. If a network location is specified for storing the temporary data, then
the windows and web services must use impersonation and run under an identity that
has required read/write access to the network location. See
http://msdn.microsoft.com/en-us/library/72wdk8cc(v=vs.100).aspx for additional
information. Identity element is specieied under system.web element and an example is
provided below
<system.web>
<httpRuntime maxRequestLength="204800" executionTimeout="300" />
<identity impersonate="true" userName="domain\username" password="<secure
password>"/>
</system.web>
You can change the security context for windows service from Logon tab
AMCAD®. 2016. All rights reserved
Page 25 of 63
eUniversa Electronic Filing Application – System Setup/Upgrade Document
5.11
Specifying AiCMS Filing Review , Court Record MDE Endpoints
AMCAD®. 2016. All rights reserved
Page 26 of 63
eUniversa Electronic Filing Application – System Setup/Upgrade Document
5.12
eUniversa Application Server - Shared Configuration files
5.12.1
web.config
5.12.2
Behaviors.config
5.12.3
Bindings.config
5.12.4
connectionStrings.config
5.12.5
settings.config
5.12.6
SharedServiceSettings.config
5.13
Courts Web Service Configuration files
5.13.1
web.config
5.13.2
settings.config
5.13.3
Service.config
5.13.4
diagnostics.config
5.14
MailAndNews Web Service Configuration files
5.14.1
web.config
5.14.2
Service.config
5.15
PaymentGateway Web Service Configuration files
5.15.1
web.config
5.15.2
Service.config
5.16
Requests Web Service Configuration files
5.16.1
web.config
5.16.2
Service.config
5.17
Security Web Service Configuration files
5.17.1
web.config
AMCAD®. 2016. All rights reserved
Page 27 of 63
eUniversa Electronic Filing Application – System Setup/Upgrade Document
5.17.2
settings.config
5.17.3
Service.config
5.18
ServiceManager Windows Service Configuration files
You can find the configuration files located in the install directory of the
middleware (usually this will be located in your C:\PROGRAM FILES
(x86)\AmCad\Middleware or please search for *.config within c:\program files
(x86)\AMCAD). The configuration file for the middleware will be named
“AiCMS.MiddleWare.exe.config”.
This config file must be already set as per the Environmental Variables
Spreadsheet but it is recommended to verify and report any discrepancies to your
AMCAD representative.
Please open this config file in XML editor and verify following configuration items:

Port (required): Port numbers must be unique for each AiCMS service on a server.
If there are more than one middleware services or more than one AiCMS services,
please make sure port numbers are unique for each service. Also please make sure
that port numbers do not conflict with other windows services such as SQL Server,
IIS etc.
For example:
<channel ref="tcp" port="14000" secure="true" >

UseEncrypt (Required): Specify Y or N to use encryption for the connections string
to the databases within this config file.
For example:
<add key="UseEncrypt" value ="N"/>

ProdDSN (Optional): When UseEncrypt is set to”Y”, this is the encrypted database
connection string to the AiCMS database. Please contact your AMCAD
representative to get encrypted string.
For example:
AMCAD®. 2016. All rights reserved
Page 28 of 63
eUniversa Electronic Filing Application – System Setup/Upgrade Document
<add key="prodDSN" value="8AC7F58A3EB95AC6F5E45E846820A2" />

ConnString (Optional): When UseEncrypt is set to”N”, this contains the
unencyrpted database connection string to the AiCMS database.
For example:
<add key="ConnString" value="Data Source=Server;database=DB;User
Id=user;password=pass;"/>

AVTConnString (Required): This is the connection string for the AVT database.
For example:
<add key="AVTConnString" value="Data Source=Server;database=DB;User
Id=user;password=pass;"/>

ProdAVTUPDATEDSN (Optional): This is the connection string used for database
connection to Statewide AVT database. This is only needed if your install have
statewide AVT database / statewide push utility.
For example:
<add key="ProdAVTUPDATEDSN" value="Data Source=Server;database=DB;User
Id=user;password=pass;"/>

DBVendor (Required): This is used for specifying type of the database, please use
‘SQL2000’ for any SQL Server version.
For Example:
<add key="DBVendor" value="SQL2000" />

AVTDBVendor (Required): This is used for specifying type of the database, please
use ‘SQL2000’ for any SQL Server version.
For example:
<add key="AVTDBVendor" value="SQL2000" />

AuthVendor (Required): This is used for authentication, value of ‘AiCMS’ is
expected here.
For example:
<add key="AuthVendor" value="AICMS"/>

Authentication Provider (Required): This is used for AiCMS authentication
provider, possible values are AICMS, AD or SSO (Single Sign-on).
For example:
<add key="AuthenticationProvider" value="SSO"/>
AMCAD®. 2016. All rights reserved
Page 29 of 63
eUniversa Electronic Filing Application – System Setup/Upgrade Document

Authorization Provider (Required): This is used for AiCMS authorization provider,
possible values are ADSI or AICMS.
For example:
<add key="AuthorizationProvider" value="ADSI"/>

Double Mode (Required): This is used for identifying whether both Active Directory
and AiCMS accounts are allowed for authentication and authorization. Possible
values are ON or OFF.
For example:
<add key="DoubleMode" value="ON"/>

Log file location (Required): This is relative path from installation directory where
middleware log will be created.
For example:
<add key="LogLocation" value="..\Data\"/>

UseMSMQ (Required): Determines whether MSMQ is used or not.
For example:
<add key="UseMSMQ" value="N" />

MSMQ (Optional): If UseMSMQ is set to Y then this will have path for MSMQ.
For example:
<add key="MSMQ" value="NV-Server1" />

PrivateQ (Optional) - If UseMSMQ is set to Y then this will have path for private
queue.
For example:
<add key="PrivateQ" value=" NV-Server1" />

DBTXTFilePath (Required): This is encrypted relative file path used for generating
SDF (Cache) Data files. Please contact your AMCAD representative to get
encrypted value.
For example:
<add key="DBTXTFilePath" value="E380C2EB14BC0E4FCE1BC8C95B7"/>

DBTXTFilePathDecypted (Required): This is decrypted relative file path used for
generating SDF (Cache) Data files.
For example:
<add key ="DBTXTFilePathDecypted" value ="..\Data\Data.txt"/>
AMCAD®. 2016. All rights reserved
Page 30 of 63
eUniversa Electronic Filing Application – System Setup/Upgrade Document

Errorfilename (Required): This is the name of the file for logging the errors on the
server machine.
For example:
<add key="errorfilename" value="error.log" />

Errorprefix (Required): This is used for formatting the subject line of email for
AiCMS client errors.
For example:
<add key="errorprefix" value="AiCMS - Error" />

Erroremail (Required): This is used for determining whether an error needs to be
sent through email or not.
For example:
<add key="erroremail" value="Y" />

Erroremaillist (Required): This is list of email addresses to which AiCMS errors will
be sent.
For example:
<add key="erroremaillist" value="bugreport@amcad.com" />

Errortoeventvwr (Required): This flag indicates whether to log the error in windows
event viewer or not.
For example:
<add key="errortoeventvwr" value="N" />

EmailExtThreadError (Required): If this is true then it sends External Document
processing (for example OnBase) errors also.
For example:
<add key=" EmailExtThreadError" value="False" />

EmailURL (Required): This is URL of Error Email Web Service, this is defaulted to
AMCAD’s error reporting email service.
For example:
<add key="EmailURL" value="http://issues.amcad.com/email.asmx" />

InterfacesStatus (Required): This flag turns interface push on or off.
For example:
<add key="InterfacesStatus" value="ON"/>
AMCAD®. 2016. All rights reserved
Page 31 of 63
eUniversa Electronic Filing Application – System Setup/Upgrade Document

InterFaceService (Optional): If InterfacesStatus is set to ‘ON’, this contains server
name and port to communicate with the interface service. This port must be unique
and not used by any other service.
For example:
<add key="InterFaceService" value="tcp://Server:Port/"/>

InterfaceConnString (Optional): This is the database connection string being used
by the Interface.
<add key="INTERFACEConnString" value="Data
Source=Server;database=DB;User Id=user;password=pass;"/>

InterfaceDBVendor (Optional): This is used for specifying Interface database
platform, please use ‘SQL2000’ for any SQL version.
For example:
<add key="INTERFACEDBVendor" value="SQL2000" />

InterfaceQueueMode (Optional): This specifies the queuing mode, either "MSMQ"
or "DBQUEUE".
For example:
<add key="INTERFACEQUEUEMODE" value="DBQUEUE" />

InterFaceSubmitQueue (Optional): If InterfacesStatus = “On” and
InterfaceQueueMode = “MSMQ”, trigger messages are queued by middleware into
this submit queue. Interface service receives messages from this queue.
For example:
<add key="InterFaceSubmitQueue" value="FormatName:DIRECT=OS:NVCMSAPP1\private$\aicms.interfaces.submit" />

InterFaceSubmitBackoutQueue (Optional): If InterfacesStatus = “On” and
InterfaceQueueMode = “MSMQ”, the middleware service loads the messages into
this queue if an error is encountered while loading messages into the submit queue.
For example:
<add key="InterFaceSubmitBackoutQueue" value="FormatName:DIRECT=OS:NVCMSAPP1\private$\aicms.interfaces.submitbackout" />

InterFaceSubmitAckQueue (Optional): This is the queue where
acknowledgements from the transactions submitted to MSMQ are saved.
For example:
<add key="InterFaceSubmitAckQueue"
value="FormatName:DIRECT=OS:Server\private$\interfaces.submitAck" />
AMCAD®. 2016. All rights reserved
Page 32 of 63
eUniversa Electronic Filing Application – System Setup/Upgrade Document

PDFEXECUTABLELOCATION (Required): This is the location where ADOBE PDF
is installed.
For example:
<add key ="PDFEXECUTABLELOCATION" value ="C:\Program Files\Adobe"/>

ImagingServicePath (Required): This is the server name and port where images
are processed. This is new config for legacy AiCS application. Port number must be
unique.
For example:
<!--AiCS Configurations -->
<add key="ImagingServicePath" value="tcp://OKCUCMSMW01:14200/"/>
5.19
Middleware Logging Configuration
The middleware logging configuration file name is log4net.config. You can find the
configuration files located in the install directory of the middleware (usually this will be
located in your C:\PROGRAM FILES (x86)\AmCad or please search for *.config within
c:\program files (x86)\AMCAD).

File (required): Full path where log file need to be stored.
For example:
<param name="File" value="C:\Program
Files\AmCad\Logs\[client]\MiddlewareLog.log"/>

Header (required): Defines the header of the log file.
For example:
<header type="log4net.Util.PatternString" value="*************************
%newline%date - [Header - Start Log]%newline" />

Footer (required): Defines the footer of the log file.
For example:
<footer type="log4net.Util.PatternString" value="%date - [Footer - End Log]
%newline" />

ConversionPattern (required): This is the format of how the log entries will be
stored in the log file.
For example:
<conversionPattern value="%date - %level - %message %newline" />
AMCAD®. 2016. All rights reserved
Page 33 of 63
eUniversa Electronic Filing Application – System Setup/Upgrade Document

RollingFileAppender (required): Writes logging events to a file in the file system.
The RollingFileAppender can be configured to log to multiple files based upon date
or file size constraints. New log files will be created when date is changed and/or
max file size is reached.
For example:
<appender name="RollingFileAppender"
type="log4net.Appender.RollingFileAppender">

MaxSizeRollBackups (required): The maximum number of backup files that are
kept before the oldest is erased. If set to zero, then there will be no backup files and
the log file will be truncated when it reaches MaxFileSize. If a negative number is
supplied then no deletions will be made. Note that this could possibly result in very
slow performance when large numbers of log files are rolled over. Maximum applies
to each time based upon group of files and not the total.
For example:
<param name="MaxSizeRollBackups" value="-1"/>

MaximumFileSize (Required): The maximum size that the output file is allowed to
reach before being rolled over to new log files. This property allows you to specify
the maximum size with the suffixes "KB", "MB" or "GB". The default maximum file
size is 10MB.
For example:
<param name="MaximumFileSize" value="10MB"/>

RollingStyle (Required): The default rolling style is “Composite”. When set to
“Once”, this Appender's AppendToFile property is set to false, hence the Appender
would append to a single file rather than rolling the file each time middleware is
started.
For example:
<param name="RollingStyle" value="Composite"/>

StaticLogFileName (Required): Set to true if logs should always be logged to the
same file name (such as file.log), otherwise set this flag to false. When set to false,
default log file name format is file.log.yyyy-mm-dd (based on formatted date pattern).
It can also be changed to following formats: file.log.curSizeRollBackup (based on file
size), file.log.yyyy-mm-dd.curSizeRollBackup (based on file size and date).
For example:
<param name="StaticLogFileName" value="false"/>

CountDirection (Required): Indicates if the current log file is the lowest numbered
file or the highest numbered file. By default newer files have lower numbers (when
CountDirection < 0), i.e. log.1 is most recent, log.2 is second most recent, and so on.
AMCAD®. 2016. All rights reserved
Page 34 of 63
eUniversa Electronic Filing Application – System Setup/Upgrade Document
When CountDirection >= 0, it does the opposite, i.e. log.1 is the first backup made,
log.5 is the 5th backup made, and so on.
<param name="CountDirection" value="1"/>

Level (Required): This can be used to set the log levels. Default value is “ALL”.
Possible values include:
 ALL
 INFO
 DEBUG
 WARN
 ERROR
<level value="ALL" />
5.20
Sample of middleware log file
Once the middleware service starts you can open the middleware logs to ensure that
the service started correctly and no errors are reported.
Sample Middleware startup
*************************
2010-12-14 08:58:16,123 - [Header - Start Log]
2010-12-14 08:58:16,170 - INFO - Initializing Middleware log
2010-12-14 08:58:16,170 - INFO - Middleware Log Initialized
AMCAD®. 2016. All rights reserved
Page 35 of 63
eUniversa Electronic Filing Application – System Setup/Upgrade Document
6
Web Server Installation
6.1
Prerequisites
Please check the prerequisite section in the document to make sure that the eUniversa
Web server meets minimum required hardware and software specifications. You must
run the installer as a user with administrative previleges on the machine where
components are installed.
6.2
Multiple Web Servers (if applicable)
Please check with your AMCAD representative if you are going to install web server
components into a load balanced (hardware/software) environment.
6.3
Upgrade/Installation
Please take backup of all the configuration files. List of web server component
configuration files are listed in section 5. If this is an upgrade, please make sure
previous version of the application server is uninstalled.
Open the eUniversa Web Server
Installer package provided by your
AMCAD representative. (Double
click setup executable file). Note
Executable file name may be
specific to your installation but will
always end with setup.exe. Note:
You must run the installer as a
user with administrative
previleges on the machine where
components are installed.
AMCAD®. 2016. All rights reserved
Page 36 of 63
eUniversa Electronic Filing Application – System Setup/Upgrade Document
The eUniversa Setup Wizard will
load. Click “Next”.
Select the installation folder (default
one is typical). Click “Next”.
AMCAD®. 2016. All rights reserved
Page 37 of 63
eUniversa Electronic Filing Application – System Setup/Upgrade Document
Click “Install” to continue.
Installation Status is shown. It may
take several minutes.
Click “Finish”
installation.
to
complete
AMCAD®. 2016. All rights reserved
the
Page 38 of 63
eUniversa Electronic Filing Application – System Setup/Upgrade Document
6.4
IIS Site Information (Web Server)
Web Server installer by default installs a web site and binds it to port 80 (or as specified
in the environmental variables worksheet). If a web site already is bound to port 80,
installer skips the site creation step and deploys the web server components under the
existing web site. Web site if installed is bound to application pool “AiCMS (or as
specified in the the environmental variables work sheet). Web Site by Home directory
for default installation is “C:\Program Files\Amcad\eUniversa”, unless a different folder
is selected during the installation. This folder is referred to as “APPHOMEMDIR” in the
subsequent section. All web server components are deployed under this folder.
AMCAD®. 2016. All rights reserved
Page 39 of 63
eUniversa Electronic Filing Application – System Setup/Upgrade Document
6.5
IIS Application Pool Information/Configuration
Web Server installer by default creates an application pool “AiCMS” (or as specified in
the the environmental variables work sheet) and binds it to .Net Framework 4.0.30319.
It is recommened that idle timeout setting be changed to 0 (i.e. do not shutdown
due to inactivity ) on production servers. Please see http://technet.microsoft.com/enus/library/cc753449(v=ws.10).aspx for additional information on managing application
pools.
AMCAD®. 2016. All rights reserved
Page 40 of 63
eUniversa Electronic Filing Application – System Setup/Upgrade Document
6.6
Web Server Components
See http://msdn.microsoft.com/en-us/library/ms178685(v=vs.100).aspx for information
on ASP.NET Configuration File Hierarchy and Inheritance. Individual files are
discussed below
Name
Type
Configuration Files
Remarks
eUniversa
Web Server
Web Site
[APPDIR]\web.config
Settings common to
all
application
AMCAD®. 2016. All rights reserved
Page 41 of 63
eUniversa Electronic Filing Application – System Setup/Upgrade Document
CMS
Interface
Web Site
[APPDIR]\Configuration\SharedServiceS
ettings.config
components
[APPDIR]\CMSInterface\web.config
Site for supporting
CMS interface
[APPDIR]\CMSInterface\Configuration\
settings.config
[APPDIR]\CMSInterface\Configuration\
Service.config
[APPDIR]\CMSInterface\Configuration\
diagnostics.config
Router
Web Site
[APPDIR]\Router\web.config
[APPDIR]\Router\Configuration\
Service.config
AMCAD®. 2016. All rights reserved
Site for supporting
the routing of all
requests
Page 42 of 63
eUniversa Electronic Filing Application – System Setup/Upgrade Document
7
Network Ports
Following ports need to be opened on servers which are needed for the eUniversa
Electronic Filing System system:
Component/Server
To/From
Ports
*configurable
Application Server
To SMTP
Server
Port 25
Application Server
To eUniversa
SQL Server
Port 1433*
Web Server
To Application
Server
Port 15500
From Public Client
To Web Server
Port 443 for Secure
Communications
Note: SSL is not enabled in
current UAT environment
eUniversa eFiling
To Interface
Services
Port 443 for Secure
Communications (through
Proxy)
To SMTP
Server
Port 25
To eUniversa
SQL Server
AMCAD®. 2016. All rights reserved
Port 1433*
Page 43 of 63
eUniversa Electronic Filing Application – System Setup/Upgrade Document
8
Verification of eUniversa Installation
Step Test
Expected Result
#
1
2
3
Actual
Result
Check whether SQL Server (and related windows All of them running
services), Replication server if applicable (and
related windows services) and SSRS Server (and
related windows services) are up and running
☐Pass
Installation verification process will add data to Backups
the AiCMS database, please backup AiCMS successful
databases if you want to later want to restore
database (to rollback any data changes in
verification process).
☐ Pass
-- Run following query in SQL server and note
down version # of AiCMS
Version number of
AiCMS
AiCMS
version
# is:
Make sure appropriate active directory security
groups are created
AiCMS security
groups exists in
active directory
☐Pass
Start Middleware Service for each AiCMS
instance
Make sure it starts
properly
☐Pass
Start Interface Service for each AiCMS instance
Make sure it starts
properly
☐Pass
Make sure it starts
properly
☐Pass
☐Fail
☐Fail
Select *
from cfg_elements
where element_name = ‘packagenumber’
4
5
6
7
Start Imaging Middleware Service for each
AiCMS instance
AMCAD®. 2016. All rights reserved
☐Fail
☐Fail
☐Fail
☐Fail
Page 44 of 63
eUniversa Electronic Filing Application – System Setup/Upgrade Document
8
9
10
11
12
13
14
15
16
Start AiCMS Web Services for each AiCMS
instance
Make sure it starts
properly
☐Pass
Check logs of all four services to make sure they
started properly and without any error
No error in log files
☐Pass
Launch AiCMS client and login as AiCMS Admin
account (most commonly used is
ADMIN/ADMIN). Make sure active directory
groups mapping is done properly and proper
security rights are assigned to the “ADMIN”
security group. Exit AiCMS client.
AiCMS Security
done/verified
☐Pass
Launch AiCMS client and login as active
directory account (must be in active directory
security group).
Able to logon as
active directory
account. This
verifies active
directory
integration.
☐Pass
Within AiCMS client, search for a case
Search results are
shown in AiCMS
client
☐Pass
Within AiCMS client, try to create new forms
using merge codes
Able to create new
forms using merge
codes
☐Pass
Within AiCMS client, try to run a SSRS report
Report results are
shown in AiCMS
client
☐Pass
Within AiCMS client, try to create receipt for
payment
Payment receipt is
generated
☐Pass
Within AiCMS client, go to Documents within GCI
(General Case Information) and try to upload a
Able to upload a
document
☐Pass
AMCAD®. 2016. All rights reserved
☐Fail
☐Fail
☐Fail
☐ Fail
☐ Fail
☐ Fail
☐ Fail
☐ Fail
☐ Fail
Page 45 of 63
eUniversa Electronic Filing Application – System Setup/Upgrade Document
document
17
18
19
20
Within AiCMS client, try batch scanning using a
scanner
Able to perform
batch scanning
☐Pass
Within AiCMS client, add/edit/delete AVT codes
Able to
add/edit/delete
AVT tables
☐Pass
Able to view
images
☐Pass
No errors
☐Pass
Within AiCMS client, view an image
Click “Refresh middleware AVTs”
☐ Fail
☐ Fail
☐ Fail
☐ Fail
21
Click “refresh Cache”
☐Pass
No errors
☐ Fail
22
23
24
25
26
27
Able to create new
case
☐Pass
Able to browse
WSDLs
☐Pass
If EFiling install is applicable for you, try logging
as filer and ADMIN
Able to logon as
filer and ADMIN
☐Pass
If EFiling install is applicable for you, file a new
case with test credit cards
Able to efile new
case
☐Pass
For Statewide instance of AiCMS, repeat steps 8- Able to add new
10 and then try adding new statewide codes
statewide codes
☐Pass
If Cache (SDF) file is enabled, please check
AiCMS client is working in cache code
☐Pass
For AiCMS, create new case
For ASB and APIs, try browsing WSDLs
AMCAD®. 2016. All rights reserved
☐ Fail
☐ Fail
☐ Fail
☐ Fail
☐ Fail
AiCMS client must
be in cache mode
now
☐ Fail
Page 46 of 63
eUniversa Electronic Filing Application – System Setup/Upgrade Document
28
29
Print a receipt to the printer
Try a test credit card for the payment in AiCMS
UI using MagTek IPAD device. Also capture
signature using signature pad.
Printer prints
receipt
the ☐ Pass
☐ Fail
Payment is
received and
signature is
captured through
AiCMS Client
☐ Pass
☐ Fail
30
Take payment as CASH in AiCMS and make Cash drawer open ☐ Pass
sure cash drawer open and close as expected
and
close
as ☐ Fail
expected
31
If EFiling install is applicable for you, make sure Able to create case ☐ Pass
EFiled cases are in AiCMS work queue and able in AiCMS from ☐ Fail
to create case in AiCMS. Make sure case filing eFiled case
fees is collected.
32
If ASB/API is applicable for you, make sure test Response is shown ☐ Pass
web application for ASB is getting response from in
test
web ☐ Fail
ASB
application
33
Check all error logs again
No Errors
☐ Pass
☐ Fail
If you have reached this step, you have verified that your AiCMS installation is complete
and working. However it is always possible that you may experience problems later
when users interact with specific screens, this could be due to missing configuration,
missing codes in code tables, coding bug etc. If you are ever experience problem,
please provide all 4 log files (client, middleware, interface, web) to your AMCAD
representative.
AMCAD®. 2016. All rights reserved
Page 47 of 63
eUniversa Electronic Filing Application – System Setup/Upgrade Document
Appendix A: Active Directory Credentials in the database
The following AD credentials are stored within the AiCMS database:
Purpose
Table
SSRS
Report
Field
Field
Field
CFG_E Submodule =
lements Reporting
Control_Name
= Login
Element_Name =
encryptedpassword
Forms
CFG_E Submodule =
lements Forms
Control_Name
= Security
Element_Name = password
AD
Integrati
on
CFG_E Submodule =
lements ADProvision
Control_Name
= Security
Element_Name =
ADPassword
Batch
Imperso
nation
CFG_E Submodule =
lements Forms
Control_Name
= Security
Element_Name =
BatchImpersonatePassword
To change the password values within the AiCMS database SQL scripts must be
executed, the scripts are as follows:
SSRS Report:
UPDATE CFG_ELEMENTS
SET VALUE = ‘ENCRYPTED PASSWORD’
WHERE SUBMODULE = ‘REPORTING’
AND CONTROL_NAME = ‘LOGIN’
AND ELEMENT_NAME = ‘ENCRYPTEDPASSWORD’
FORMS:
UPDATE CFG_ELEMENTS
SET VALUE = ‘ENCRYPTED PASSWORD’
WHERE SUBMODULE = ‘FORMS’
AND CONTROL_NAME = ‘SECURITY’
AND ELEMENT_NAME = ‘PASSWORD’
AD Integration:
AMCAD®. 2016. All rights reserved
Page 48 of 63
eUniversa Electronic Filing Application – System Setup/Upgrade Document
UPDATE CFG_ELEMENTS
SET VALUE = ‘ENCRYPTED PASSWORD’
WHERE SUBMODULE = ‘ADPROVISION’
AND CONTROL_NAME = SECURITY’
AND ELEMENT_NAME = ‘ADPASSWORD’
Batch Impersonation:
UPDATE CFG_ELEMENTS
SET VALUE = ‘ENCRYPTED PASSWORD’
WHERE SUBMODULE = ‘FORMS’
AND CONTROL_NAME = ‘SECURITY’
AND ELEMENT_NAME = ‘BATCHIMPERSONATIONPASSWORD’
AMCAD has an encryption utility that encrypts the password; the encrypted value is
place in the database. AMCAD can provide this tool or encrypted value, please discuss
with your AMCAD representative.
AMCAD®. 2016. All rights reserved
Page 49 of 63
eUniversa Electronic Filing Application – System Setup/Upgrade Document
Appendix B: Active Directory Accounts with Windows Permissions
Following Active Directory (AD) permissions are required for Impersonation Accounts:
1) Middleware Service Account: AD account used to execute the AiCMS middleware
services, requires “log on as a service” rights within the Active Directory. This AD
account requires Modify rights to the following directory structures;

C:\program files (x86)\amcad on the Middleware server


Forms Directory
Forms Template Directory

Cache

Image Repository
2) Active Directory Impersonation Account: AD account used to query Active Directory
for the purpose of user authentication and authorization. This AD account does not
require any access to directories.
3) Forms Impersonation Account: AD account used to create, modify and delete Forms
Templates and Forms. This AD account requires Modify rights to the following
directories;

Forms Directory

Forms Template Directory
4) Batch Impersonation Account: AD account used for batch scanning or uploading
documents from AiCMS and users access to images. This AD account requires Modify
rights to the following directory;

Image Repository
5) SSRS Reports Impersonation Account: AD account used to access SSRS Reports.
This AD account does not require any access to directories.
NOTE: The actual paths for the directories identified above are contained in the
Environmental Variables Spreadsheet.
AMCAD®. 2016. All rights reserved
Page 50 of 63
eUniversa Electronic Filing Application – System Setup/Upgrade Document
Appendix C: Environmental Variables Spreadsheet Template
Multiple AiCMS instances/environments (if applicable)
Please check with your AMCAD representative if “Statewide/Other AiCMS instances”
and/or environments is/are applicable to your install. Environmental Variables
Spreadsheet must be filled for all environments and AiCMS instances (one column for
each AiCMS instance of every environment).
Environmental Variables Spreadsheet template dated 01/24/2013:
Environment
Variables Spreadsheet Template.xlsx
AMCAD®. 2016. All rights reserved
Page 51 of 63
eUniversa Electronic Filing Application – System Setup/Upgrade Document
Appendix D: Active Directory Integration
Active Directory Integration Modes
AiCMS currently supports 6 modes of Active Directory integration. These modes are
driven by 3 parameters which are set in the AiCMS Middleware Config File:
AuthenticationProvider, AuthorizationProvider and DoubleMode.
Element Name: AuthenticationProvider: Method of authenticating user
Possible Values: AICMS / ADSI / SSO
Element Name: AuthorizationProvider: Method of authorizing user
Possible Values: AICMS / ADSI
Element Name: DoubleMode: Allow for both modes (Active Directory and AiCMS)
Possible Values: ON / OFF
The following is a listing of the possible combinations and a description of the different
modes.
1. AiCMS Application Authentication and Authorization Only
AuthenticationProvider = AICMS
AuthorizationProvider = AICMS
DoubleMode = OFF
The user is authenticated against the credentials saved in the AiCMS
database. This is the default authentication and authorization setting. The user should
have an account created for him by the AiCMS administrator and given the appropriate
rights to log into the application.
2. Active Directory Authentication and AiCMS Authorization with DoubleMode
OFF
AuthenticationProvider = ADSI
AuthorizationProvider = AICMS
DoubleMode = OFF
Users are authenticated against the Active Directory. They are authorized in
the application with the security groups assigned to them in the AiCMS application. The
ADSI column for the existing AiCMS users’ needs to be updated to map them with their
Active Directory user names. For new users, they need to attempt to login to the
AiCMS application once to have their user information stored automatically in the
AMCAD®. 2016. All rights reserved
Page 52 of 63
eUniversa Electronic Filing Application – System Setup/Upgrade Document
database after which AiCMS administrators can assign the groups from the user admin
screen.
3. Active Directory authentication and AiCMS Authorization with Double Mode
ON
AuthenticationProvider = ADSI
AuthorizationProvider = AICMS
DoubleMode = ON
Users can be authenticated against the Active Directory or AiCMS. They are authorized
in the application with the security groups assigned to them in the AiCMS application. If
using the active directory authentication the ADSI column for the existing AiCMS users’
need to be updated to map them with their active directory user names. Active directory
users can use their active directory user name and password while AiCMS users can
use their AiCMS username and password to logon to the application. A new AiCMS
user can be created in a regular manner. But for new active directory users, they need
to attempt to login to the AiCMS application once to have their user information stored
automatically in the database after which AiCMS administrators can assign the security
groups from the user admin screen.
4. Active Directory Authentication and Authorization with DoubleMode OFF
AuthenticationProvider = ADSI
AuthorizationProvider = ADSI
DoubleMode = OFF
The user is authenticated against the active directory. The default or only users who
belong to a special “allowed group” have direct access to the application initially to set
up active directory mapping. Unlike the AiCMS application authentication where the
user account has to be set up in AiCMS for the user to login, in this case if the active
directory group has access to the application with a specific set of AiCMS security
rights, all the users who belong to that active directory security group can login to the
AiCMS application with the same AiCMS security rights. The user needs to enter the
domain\username and his/her password to log into the AiCMS application.
5. Active Directory Authentication and Authorization with DoubleMode ON
AuthenticationProvider = ADSI
AuthorizationProvider = ADSI
DoubleMode = ON
AMCAD®. 2016. All rights reserved
Page 53 of 63
eUniversa Electronic Filing Application – System Setup/Upgrade Document
Mixed mode allows the users to log into the application by using either their active
directory account or the AiCMS application account. To login using the active directory
account the user has to provide the domain name as well as his/her username
(DOMAIN\WINDOWS-USERNAME). To login using the AiCMS application account the
user has to provide his/her AiCMS application account username and password. The
initial set up remains the same as mentioned above for active directory authentication
and AiCMS application authentication.
6. Single Sign On
AuthenticationProvider = SSO
AuthorizationProvider = ADSI
DoubleMode = OFF
After logging into the machine the user can directly open the AiCMS application without
providing the username and password again. If the user is using the AiCMS application
for first time the location has to be selected then make it the default, after which the user
can directly log into the application after logging into the machine. Similar to the active
directory only authentication, the administrator needs to provide access to the active
directory groups from the AiCMS application initially to allow the active directory group
users to log into the AiCMS application.
Database Setup for Active Directory
The following scripts will need to be run in the AiCMS database to enable Active
Directory integration.
1. CFG_ELEMENTS:
Element Name: MASTER_APPSECGROUP
Possible Values: Choose the group of your choice from the AiCMS application
security groups. Make sure the selected group has access to Active Directory
group/user management screens
--SCRIPT TO SET UP APPLICATION SECURITY GROUP
IF NOT EXISTS (SELECT TOP 1 *
FROM CFG_ELEMENTS
WHERE SUBMODULE = 'USER_ADMIN'
AND CONTROL_NAME = 'DEFAULTGROUP'
AND ELEMENT_NAME = 'MASTER_APPSECGROUP')
BEGIN
AMCAD®. 2016. All rights reserved
Page 54 of 63
eUniversa Electronic Filing Application – System Setup/Upgrade Document
INSERT INTO CFG_ELEMENTS
VALUES ('CASEMANAGEMENT',
'USER_ADMIN',
'DEFAULTGROUP',
'MASTER_APPSECGROUP',
'<@APPLICATION SECURITY GROUPNAME>',
'STRING',
'MASTER APPLICATION SECURITY GROUP',
'Y',
'',
GETDATE(),
GETDATE(),
'ADMIN')
END
ELSE
BEGIN
UPDATE CFG_ELEMENTS
SET VALUE = '<@APPLICATION SECURITY GROUPNAME>'
WHERE SUBMODULE = 'USER_ADMIN'
AND CONTROL_NAME = 'DEFAULTGROUP'
AND ELEMENT_NAME = 'MASTER_APPSECGROUP'
END
2. System Parameters:
Parameter Name: DEFAULT_AD_ADMINGROUP
Purpose: Stores the default domain name and default active group name to have the
access to the AiCMS application with the default AiCMS application security group
rights.
E.g. DC=DOMAINNAME, CN=DEFAULT ACTIVE DIRECTORY NAME
--SCRIPT TO SET UP DEFAULT ACTIVE DIRECTORY GROUP
BEGIN
DECLARE @MAXID AS INT
AMCAD®. 2016. All rights reserved
Page 55 of 63
eUniversa Electronic Filing Application – System Setup/Upgrade Document
SELECT @MAXID =MAX(SYS_PARAMETERS_ID)
FROM ACM_SYS_PARAMETERS
INSERT INTO ACM_SYS_PARAMETERS
([PARAMETER_NAME]
,[PARAMETER_PREFIX]
,[CURRENT_VALUE]
,[DATE_TIME_CREATED]
,[DATE_TIME_MOD]
,[USER_ID]
,[DISABLED_USAGE_FLG]
,[DATE_PARAMETER]
,[CHARACTER_PARAMETER]
,[AMOUNT_PARAMETER]
,[EFFECTIVE_DATE]
,[END_DATE]
,[LOCATION_ID]
,[tm_id]
,[DESCR]
,[SYS_PARAMETERS_ID])
VALUES
('DEFAULT_AD_ADMINGROUP'
,NULL
,NULL
,GETDATE()
,GETDATE()
,'admin'
,'N'
,NULL
,'DC=<@DOMAINNAME>, CN=<@ACTIVE DIRECTORY GROUP>'
,NULL
,GETDATE()
,DATEADD(year, 50, getdate())
AMCAD®. 2016. All rights reserved
Page 56 of 63
eUniversa Electronic Filing Application – System Setup/Upgrade Document
,0
,@MAXID+1
,'TO ALLOW DOMAIN ADMINS TO LOGIN TO APPLICATION TO GRANT
ACCESS TO OTHER USERS'
,@MAXID+1)
END
GO
3. Filter active directory group types
--SCRIPT TO SET UP DEFAULT ACTIVE DIRECTORY FILTER. DEFAULT VALUE IS
SET TO GET BOTH UNIVERSAL AND GLOBAL SECURITY GROUPS.
IF NOT EXISTS (SELECT TOP 1 *
FROM CFG_ELEMENTS
WHERE SUBMODULE = 'USER_ADMIN'
AND CONTROL_NAME = 'ADMANAGEMENT'
AND ELEMENT_NAME = 'DEFAULTADFILTER')
BEGIN
INSERT INTO CFG_ELEMENTS
VALUES ('CASEMANAGEMENT',
'USER_ADMIN',
'ADMANAGEMENT',
'DEFAULTADFILTER',
'(|(&(objectClass=Group)(grouptype=2147483646))(&(objectClass=Group)(grouptype=-2147483640)))',
'STRING',
'DEFAULT FILTER THAT IS ASSIGNED WHEN A NEW DOMAIN IS
INSERTED',
'Y',
'',
GETDATE(),
GETDATE(),
'ADMIN')
END
ELSE
AMCAD®. 2016. All rights reserved
Page 57 of 63
eUniversa Electronic Filing Application – System Setup/Upgrade Document
BEGIN
UPDATE CFG_ELEMENTS
SET VALUE = '(|(&(objectClass=Group)(grouptype=2147483646))(&(objectClass=Group)(grouptype=-2147483640)))'
WHERE SUBMODULE = 'USER_ADMIN'
AND CONTROL_NAME = 'ADMANAGEMENT'
AND ELEMENT_NAME = 'DEFAULTADFILTER'
END
4. Setup account to use for accessing active directory
-- Set up the active directory account used to communicate with Active Directory
server.
IF EXISTS (SELECT TOP 1 *
FROM CFG_ELEMENTS
WHERE SUBMODULE = 'ADPROVISION'
AND CONTROL_NAME = 'SECURITY'
AND ELEMENT_NAME = 'ADUSERNAME')
BEGIN
DELETE FROM
CFG_ELEMENTS
WHERE SUBMODULE = 'ADPROVISION'
AND CONTROL_NAME = 'SECURITY'
AND ELEMENT_NAME = 'ADUSERNAME'
END
GO
BEGIN
INSERT INTO CFG_ELEMENTS
VALUES ('CASEMANAGEMENT',
'ADPROVISION',
'SECURITY',
'ADUSERNAME',
'domain\ad_user',
'STRING',
AMCAD®. 2016. All rights reserved
Page 58 of 63
eUniversa Electronic Filing Application – System Setup/Upgrade Document
'AD provisioning account username',
'Y',
'ADPROVISION_USERNAME',
GETDATE(),
GETDATE(),
'ADMIN')
END
GO
IF EXISTS (SELECT TOP 1 *
FROM CFG_ELEMENTS
WHERE SUBMODULE = 'ADPROVISION'
AND CONTROL_NAME = 'SECURITY'
AND ELEMENT_NAME = 'ADPASSWORD')
BEGIN
DELETE
FROM CFG_ELEMENTS
WHERE SUBMODULE = 'ADPROVISION'
AND CONTROL_NAME = 'SECURITY'
AND ELEMENT_NAME = 'ADPASSWORD'
END
GO
BEGIN
INSERT INTO CFG_ELEMENTS
VALUES
('CASEMANAGEMENT',
'ADPROVISION',
'SECURITY',
'ADPASSWORD',
'Encrypted Password’,
'STRING',
'AD provisioning account encrypted password',
'Y',
'ADPROVISION_PASSWORD',
GETDATE(),
GETDATE(),
'ADMIN')
AMCAD®. 2016. All rights reserved
Page 59 of 63
eUniversa Electronic Filing Application – System Setup/Upgrade Document
END
GO
5. Enable active directory integration in AiCMS
--The following scripts will need to be run in order for the security rights to show up in
the Security Group Administration tab
UPDATE APPSECRIGHTS
SET INTERNALFLAG = 'N',
DATE_TIME_MOD = GETDATE(),
USER_ID = 'ADMIN'
WHERE VERBSYMBOLIC = 'SYNCADUSERSECRIGHTS'
AND DESCRIPTION LIKE 'Sync Active Directory user security rights'
GO
UPDATE APPSECRIGHTS
SET INTERNALFLAG = 'N',
DATE_TIME_MOD = GETDATE(),
USER_ID = 'ADMIN'
WHERE VERBSYMBOLIC = 'UNLINKFROMAD'
AND DESCRIPTION LIKE 'Unlink the user from Active Directory'
GO
UPDATE APPSECRIGHTS
SET INTERNALFLAG = 'N',
DATE_TIME_MOD = GETDATE(),
USER_ID = 'ADMIN'
WHERE VERBSYMBOLIC = 'PROVISIONADUSERS'
AND DESCRIPTION LIKE 'AD User Provisioning'
GO
UPDATE APPSECRIGHTS
SET INTERNALFLAG = 'N',
DATE_TIME_MOD = GETDATE(),
AMCAD®. 2016. All rights reserved
Page 60 of 63
eUniversa Electronic Filing Application – System Setup/Upgrade Document
USER_ID = 'ADMIN'
WHERE VERBSYMBOLIC = 'MANAGEADGROUPS'
AND DESCRIPTION LIKE 'AD Administration'
GO
Active Directory Management from the Application:
The above image shows the active directory management screen in the AiCMS
application which allows the AiCMS administrators to map the AiCMS application
security groups to the active directory groups. All the active directory security groups
are shown in the left most list and the available AiCMS application security groups are
show in the right most list. Select the desired active directory group and then from the
AiCMS application security group select the groups to which that particular active
directory group should be mapped. Users of that active directory will then have all the
AiCMS application security rights from the mapped AiCMS application security groups.
One Active Directory group can be mapped to multiple AiCMS application security
groups and vice versa.
AMCAD®. 2016. All rights reserved
Page 61 of 63
eUniversa Electronic Filing Application – System Setup/Upgrade Document
There is also an option to sync the AiCMS application to the active directory so that the
active directory groups stored in the AiCMS application database are refreshed with
those in the actual active directory itself. Any new groups added to the active directory
are added to the AiCMS application while those that are deleted are removed from the
AiCMS application along with their mappings to the AiCMS application security groups.
Note: Sync has to be done with extra caution as it would do a complete refresh of
the active directory groups stored in the database. The existing mappings
between all the existing active directory groups are preserved while the mappings
for any deleted groups are lost.
AMCAD®. 2016. All rights reserved
Page 62 of 63
eUniversa Electronic Filing Application – System Setup/Upgrade Document
AMCAD®. 2016. All rights reserved
Page 63 of 63