Installation and Upgrade Guide Documentation

1.Foreword #

The purpose of this document is to explain the installation requirements, pre-requisites, installation and configuration steps, upgrade procedures, and uninstall steps of your software solution.

2.Installation Preparation #

2.1.Installation Requirements #

  • XPressEntry installer (latest version) and license file. Administrator rights are required for installation.
  • Windows Firewall ports 30000/30001 opened for the XPressEntryService executable. This is needed for the handheld devices to find the server.

2.2.Installation Pre-requisites #

  • Windows 7/Windows Server 2012 or newer, >= 8GB RAM
  • .NET Framework 4.7.2
  • 20GB free disk space for very large installations.
  • A windows domain service account (or local user if no domain) for the XPressEntry Service. Will be set to be either DB Owner or DB Reader/Writer of the XPressEntry SQL Server database.
  • SQL Server or SQL Server Express installed and available locally or within the network.

3.Installation of XPressEntry #

3.1.Run the XPressEntry MSI Installer #

  1. Run the XPressEntry MSI Installer.
  2. Select the Location to install XPressEntry
  3.  
    xpressentry installation
     

  4. When the installation is complete, select Close.
  5.  
    xpressentry installation complete

3.2.XPressEntry Service Setup #

A Windows service account for SQL Server database trusted connection access is required.
 
NOTE: If the windows service account that will be used IS NOT an administrator on the Windows machine, first Start the XPressEntry Service for the first time as Local System, and stop the service before continuing.
 

  1. Open Windows Services. Search for the XPressEntry Service, Right Click, and click properties.
  2.  
    xpressentry service
     

  3. Click Log On Tab.
  4. Click This Account, and enter the Windows domain service account information that will be used to connect to SQL Server. Click Apply.
  5.  
    xpressentry service properties
     

3.3.Setup SQL Server #

SQL Server

  1. Open SQL Server Management Studio. Login with an account with database admin access.
  2.  
    SQL servier
     

  3. From the Object Explorer window, right click Databases and click New Database… Name the database for the XPressEntry database. Click OK.
  4.  
    xpressentry new database
     

  5. Next, we need to give the Windows service account dbo.owner access to the newly created XPressEntry database. From Object Explorer window, expand Security, and right click Logins. Click New Login… Search or add the windows service account for the Login name.
  6.  
    xpressentry login
     

  7. Click on User Mapping on the left Select a page window. Search for the newly created database, and check the Map box. Below, in the Database role membership, check db_owner, or separately, the combination of db_datareader and db_datawriter. Db_owner supersedes db_datareader and db_datawriter Click OK.
  8.  
    login properties
     

  9. Go to the location where XPressEntry was installed, or search in the Windows Start Menu for XPressEntryDatabaseTool. Run the XPressEntryDatabaseTool.exe
  10. Any Windows user that will be accessing the XPressEntryDatabaseTool will require db_owner access to run database migrations. Running XPressEntryDatabaseTool as the service windows user will streamline the process if it is set to db_owner.
  11. Any Windows users that will be accessing the XPressEntry Server Application will also need db_datareader and db_datawriter access. This can be assigned to the domain users, or explicitly to administrators or specific users only.
  12.  
    xpressentry database tool
     

  13. Add the XPressEntry License – Click Browse for License File and add the license file provided by Telaeris. If successful, the About XPressEntry page will close.
  14.  
    xpressentry license
     

  15. Click Change/Set the Database
  16.  
    xpressentry set the database
     

  17. Set the Server Information of the SQL Server Database, and click Load Database.
  18.  
    xpressentry database connection
     

  19. Select the XPressEntry database to connect to, and click Finish.
  20.  
    xpressentry set and connect the database
     

  21. Click Validate Current User is Owner.
  22.  
    xpressentry current user
     

  23. Click Run Table Creation/Migrations.
  24.  
    xpressentry run table creation
     

  25. The database connection is setup correctly when Database Connection Success, Current User is db_owner, and Database Version is up to date are shown.
  26. If XPressEntryDatabaseTool is running as Administrator, you may stop or start the XPressEntry Service. It is okay for the service to be stopped with red X icon.
  27. Check API will check if the API route is functioning properly. This requires the service to be started.
  28. Check Service Permissions will check if the Log On user for XPressEntry service has proper read and write permissions to the XPressEntry database.
  29.  
    xpressentry service permissions
     
     
    xpressentry administrator
     

3.4.Database Troubleshooting #

  1. You may double click any error box to display the full message.
  2. If the Logged in windows user does not have reader or write access to the XPressEntry database, you will see the following error message during opening, or when click Check Connection. Assign proper read and write access to the current windows user.

 
xpressentry database

4.Upgrading XPressEntry #

  1. Run the XPressEntry MSI Installer and/or the specfic Datamanager Plugin Installer.
  2. Select the Location to install XPressEntry.
  3.  
    xpressentry install
     

  4. When the installation is complete, select Close.
  5.  
    xpressentry installation complete
     

  6. Go to the location where XPressEntry was installed, or search in the Windows Start Menu for XPressEntryDatabaseTool. Run the XPressEntryDatabaseTool.exe
  7.  
    xpressentry database tool
     

  8. Check the Database Migration Version by clicking check migration. If the Migration version needs to be updated to the latest version, select Run Table Creation/Migration. If the Migration version is up to date, Database Version is up to date at [VERSION].
  9.  
    xpressentry run table creation
     
     

    xpressentry check migration
     

  10. Click Done. Start the XPressEntryService.

5.Uninstalling XPressEntry #

  1. Stop the XPressEntryService.
  2. Run the XPressEntry MSI Installer or XPressEntry specific Datamanager Plugin Installer. Select Remove XPressEntry.
  3.  
    remove xpressentry
     

  4. Select Everyone. Click Next.
  5.  
    uninstall xpressentry
     

Suggest Edit