In 2021 PSIcapture Fusion, previously PSIfusion, was renamed PSIcapture Mailroom. In order to facilitate the upgrade process from previous versions, the following guide has been created in an attempt to exhaustively cover all the steps and procedures required to upgrade PSIcapture Fusion / PSIfusion 3.0 to PSIcapture Mailroom 3.3+. As a brief overview, Administrators will need to remove the old program files and web server files hosted through IIS and then run the installers for PSIcapture Mailroom. Follow the steps below depending on your environment, and be sure to refer to any important notes throughout the process that may affect your unique configuration.
IMPORTANT NOTE ABOUT ASSIGNMENT OF DOCUMENT TYPES
- When documents were migrated from PSIcapture to Fusion 2.0, an index field containing the name of the document’s assigned Fusion Document Type should have been set to “Include” on the Field Settings of the Migration Settings
- This creates a value in that document’s metadata.xml file tagged DocumentTypeName
- If documents were migrated from PSIcapture to Fusion 2.0 without this value included, then Mailroom 18.104.22.168 will NOT automatically assign a Document Type to the document
- The document will be without a Document Type, and any metadata that was associated with this document will be lost upon selecting a desired Document Type
- This issue can be determined prior to upgrading from Fusion 2.0 > Mailroom 22.214.171.124 by browsing to
- C:\ProgramData\PSIGEN\Fusion\Organizations\<org name>\Queue
- Select a Queue with existing documents in it
- Open an existing document’s metadata.xml file
- Determine whether or not the metadata.xml file contains the tag <DocumentTypeName=”….”>
- If it contains the DocumentTypeName tag, then there will not be any issues with this document after upgrading to Mailroom 3.3
- If it is missing the DocumentTypeName, then Mailroom 3.3 will not know what type of document it is, and metadata will be lost
- Recommend in this case processing these documents and purging all Document Queues prior to upgrade
Updating PSIcapture Fusion / PSIfusion 3.0 to PSIcapture Mailroom 3.3+
Step 1: Uninstall Existing Installation
- Begin by opening windows Control Panel > Programs and Features > PSIcapture Fusion / PSIfusion > Uninstall and complete the uninstallation process.
- Then, proceed to determining that the environment has the latest Prerequisites for PSIcapture Mailroom 3.3+
Step 2: Prerequisite Checks - Windows Features
See PSIcapture Mailroom: System Requirements for further information on how to prepare a system.
The following programs need to be installed on the system prior to installation.
Note: On Windows Server 2012+ OS, these features should be added through the Server Management Console (detailed below).
Note: While PSIcapture is not required for installation, a PSIcapture installation is required to migrate to PSIcapture Mailroom.
Microsoft .NET Framework
The PSIcapture Mailroom installers will install or update the .NET Framework installation on your server. However, if you wish to install the latest version of the framework manually you may use the links below to do so.
.NET Framework 3.5 (includes .NET 2.0 and 3.0)
.NET Framework 4.6/7+ Advanced Services > WCF Services > HTTP Activation
Internet Information Services > World Wide Web Services > Application Development Features > .NET Extensibility 3.5 & 4.7 & ASP .NET 3.5 & 4.7
Please make sure the following features are selected.
|Enable ASP 4.5
|Enable HTTP Activation
Turning on Windows Features
If PSIcapture Mailroom is being installed locally or on a VM OS users want to make sure certain features are enabled prior to installation. These can be found in the Control Panel > Programs and Features >Turn Windows features on or off (left side of programs list).
Please make sure the following features are selected:
|Enable ASP .NET 4.6
|Enable HTTP Activation
For complete documentation of the installation procedure for the .NET Framework please refer to the following article:
Adding Features in Windows Server OS:
For installing on Windows Server 2012 R2+ Administrators must enable some roles and features. In previous versions we ran aspnet_regiis in the cmd prompt instead.
In the server manager click "Add roles and features":
After selecting your server, in the Server Roles tab find and enable ASP.NET 4.5 as in the following screenshot:
Also, in the Features tab enable HTTP Activation under WCF Services under .NET Framework 4.5 Features as in the following screenshot:
The webapp won't run properly without these roles and features enabled on Windows versions later than 2008.
Microsoft Internet Information Services (IIS)
IIS, the Windows integrated web server, cannot be automatically installed by the PSIcapture Mailroom installer. A guide for installing IIS is located here:
IIS 7+ (Including all Windows Features)
Internet Information Services > World Wide Web Services > Common HTTP Features > Static Content
There are some roles and features users want to make sure are enabled prior to installation. These can be found in the Server Manager > Add roles and features.
More information on IIS can be found here:
Microsoft SQL Server
Ensure your computer meets the minimum requirements above, and you’ve downloaded:
Microsoft SQL Express 2019+ (x86 or x64)
Microsoft SQL 2019 Management Studio Express 18.9
Download and installation instructions for SQL Server express can be found here:
This completes the Prerequisite checks for PSIcapture Mailroom 3.3+
Step 3: Proceed with Installation
PSIcapture Mailroom Installers:
PSIcapture Mailroom does not support:
- Apache HTTP Web Server
- NGINX, and other open-source web server platforms
- SQLite or similar serverless databases
- PSIcapture Mailroom is supported for both 32-bit and 64-bit platforms. We recommend, but do not require, a 64-bit server platform for optimum performance.
- The amount of disk space is generally required for the operating system and framework, the requisite updates, and the volume of files being processed during peak volumes. More may be required depending on the operating system version, and more disk space will be required for storage of scanned documents.
- Microsoft Internet Information Services (IIS) will not serve a web application to more than 10 concurrent users when running on a non-server operating system. PSIcapture Mailroom will only be supported on non-server operating systems for demonstration purposes.
For Enterprise applications of PSIcapture Mailroom, please install a Load Balancing Server for environments with more than 200 users:
- For Non-Enterprise applications of PSIcapture Mailroom, please do NOT install a Load Balancing Server.
PSIcapture Mailroom (File) Service Installation
Prerequisites During Installation
The installer will then check for any missing prerequisites programs (NOT the features we installed above) including missing Microsoft .NET and C++ Redistributable libraries. These are necessary and should not be bypassed. Failure to install all prerequisite files may result in the product not working correctly, or not working at all.
Install PSIcapture Mailroom using default settings, or specify an installation directory accordingly. By default the program installation path is C:\Program Files (x86)\PSIGEN\Mailroom. The path can be changed however, it is not recommended.
Before Proceeding, be sure to review these important details:
- There are two separate installation files (as of this release):
- Kofax.PSIcapture.Mailroom.FileServer.Setup.x.x.x.exe - The File Server (Reactor Service) hosting the service providing file access to the application.
- Kofax.PSIcapture.Mailroom.WebServer.Setup.x.x.x.exe - The Web Server(s) users will access, including the API.
- If UAC is enabled, you may need to enter Administrator Credentials to proceed.
- If you want to deploy the Mailroom File (Reactor) Service and Web Application on the same machine, be sure to install “Kofax.PSIcapture.Mailroom.FileServer.Setup.x.x.x.exe” and “Kofax.PSIcapture.Mailroom.WebServer.Setup.x.x.x.exe” on the same machine. In this case, granting permission to the Fusion Folder (next page) is not required.
- Run “Kofax.PSIcapture.Mailroom.FileServer.Setup.x.x.x.exe” on the machine hosting the main server, and the screenshot below will appear:
- Click “I agree to the License terms and conditions” check box and Install.
- Click Yes to proceed. Restart your system if necessary when the following appears:
PSIcapture Mailroom (File) Service Permissions
4. After successful installation verify “Mailroom (File) Service” folder at following path:
C:\Program Files (x86)\PSIGEN\Fusion Services
5. Go to Services and stop the “Mailroom (File) Services”. Restart when the following is complete.
6. Create Users “FusionAdmin” and “FusionFileServer” via AD or otherwise.
7. Grant these users Read/Write Access to Fusion Folder “C:\ProgramData\PSIGEN\Fusion”.
8. Additionally, add system profiles “IIS AppPool\Mailroom3.3.9”, “IIS AppPool\PSIcapture Mailroom - [Deployment Name] e.g. “PSIcapture Mailroom - Deployment1” “NETWORK”, and “SYSTEM”, and grant the same Read-Write permissions granted above.
9. Now, right-click on the same Fusion folder in ProgramData and click “Share”. A dialog window will appear displaying a shared path. Make sure to copy this path, as it will be used in later steps.
Backup and Verify SQL Database for PSIcapture Mailroom
Once installation is complete, the Installation Package can be archived or deleted as necessary.
A detailed, technical log of any actions performed by the installer can be found at C:\ProgramData\PSIGEN\Mailroom\Setup\InstallLog.txt. This log also includes details on any errors that may have occurred.
Backup existing SQL Database for PSIcapture Mailroom
- Backup your existing SQL Database connected to PSIcapture Fusion / PSIfusion via SSMS > Databases > [Fusion DB] > Tasks > Back Up...
- Set the Backup Type to full and specify a local disk location to save the database.
- Default settings otherwise remain the same for this process.
- Once the Database is backed up securely, proceed to the Web App Installation steps below.
PSIcapture Mailroom Web App Installation
Install Website and Application Pool
- Run Kofax.PSIcapture.Mailroom.WebServer.Setup.x.x.x.exe as an Administrator, and the screenshot pictured below will appear.
- Check the “I agree to the License terms and conditions” checkbox and click Install.
Installation should complete automatically. Contact Support should you encounter any errors during this installation process.
- Once complete, the website files and application pool of IIS should be installed. To verify a successful installation along with corresponding permissions and configuration settings, see Configure IIS and Verify Settings section below.
- Access the Windows Start menu and type in “Deployment Manager”.
- Open the Deployment Manager Application to begin the licensing process, and the following screen will appear:
- If you are licensing on the same machine which hosts the website and application pool files you just installed, select “Same Server”. If installing a Load Balance Server, see the “Load Balance” section or separate guide for more information.
- Deployment Path - Set this to the UNC path for the deployment folder (e.g., 10.1.1.12\Fusion or DOC-PC7\Fusion). The default Mailroom Deployment folder is C:\ProgramData\PSIGEN\Fusion\Deployments.
- UNC UserName and Password: Set these credentials to a user who has been granted full read/write access to the folder, as specified in the previous step or configured in Active Directory by an IT Administrator, who has been granted access to the folder.
Deployment Manager Scenarios after Upgrade
The Deployment manager will be in one of two states after performing an upgrade. The first will be that the deployment needs to be fully re-licensed and setup as a new deployment within the Deployment Manager. The second scenario is that the previous deployment will still exist within the Deployments.XML file and will need to be updated according to the below steps.
How the Deployment Manager Determines the State of a Deployment
The application reads the Deployments.XML file from the C:\ProgramData\PSIGEN\Fusion\Deployments path. If there was previously a file in this location, or the location specified in the initial "Deployment Mode" above contains the Deployments.XML file, PSIcapture Mailroom 3.3+ will attempt to read this file and implement existing deployment licensing and associations.
If your installation did not contain a previous Deployments.XML file, proceed to PSIcapture Mailroom Administrator Guide: Creating a New Deployment.
IMPORTANT NOTE: The Application Pool and Website are created after the Deployment Manager saves your licensing information. Therefore, it's important to complete the licensing process BEFORE proceeding to check on the IIS permissions and configurations of the next step.
IMPORTANT NOTE: For Enterprise applications of PSIcapture Mailroom, please install a Load Balancing Server for environments with more than 200 users:
For Non-Enterprise applications of PSIcapture Mailroom, please do NOT install a Load Balancing Server.
If the Deployment setup or Deployment Manager is handled or does not apply to your environment, and the Mailroom installation is licensed, Administrators can proceed to:
Otherwise, if your installation contains a previous Deployments.XML and you wish to continue with the upgrade process to ensure that your existing PSIcapture Mailroom (Previously Fusion) database content, Document Profiles, and configuration information remains intact, proceed to the following checks as they apply to your unique situation.
Port Exceptions (Check before Proceeding)
Before proceeding with the installation, be aware that PSIcapture Mailroom uses the following ports:
(Add Inbound and Outbound entries)
TCP/IP: 47232-47233 (Service Ports)
UDP: 1434 (SQL Server Browser for SQL Service Instance Host)
8080 (Or custom port in IIS)
If your installation does contain a previous Deployments.XML file check the following as they apply to your environment and configuration:
Update Existing Deployment
- From Services.msc, STOP Mailroom Services
- Open Deployment Manager
- Enter Deployment Path (c:\programdata\PSIGEN\Fusion)
- Enter UNC credentials
- Select existing Deployment on left side
- Select Edit
- Set File Server Path to C:\programdata\PSIGEN\Fusion
- Select Save
- Deployment will be saved
Rename Existing Queue to Incoming
- From Services.msc, START Mailroom Services
- Browse to C:\programdata\PSIGEN\Fusion\Organizations\<org name>
- Delete “Incoming” folder
- Rename “Queue” to “Incoming”
- New Queue folder will be created and populated
- This process can take time depending on number of documents
Update IIS Settings
- Launch IIS Manager
- Expand Sites
- Select OLD site (not named Mailroom)
- Delete OLD site
- Select NEW site (will be named PSIcapture Mailroom - <org name>)
- Right click NEW site and select Edit Bindings
- Edit http binding and change from 8081 to 8080
- Restart IIS Server
- Browse to new site
- Verify ability to log in as Administrator/Admin-01
- Log out as Administrator
Reset User Passwords
- Log in as another Mailroom user
- At this point, all user passwords have been RESET to be the same as their username
- For instance, a username of “bobsmith” now has a password of “bobsmith”
- Enter username/password
- User is prompted to reset their password
- Once password is reset, user can log in
- They will receive a notice that the user account is already logged in
- Select Login
- Once user is logged in, verify document and metadata integrity
- Proceed to reset all user passwords
Your PSIcapture Mailroom installation should be upgraded and ready to use.