Skip to main content
Skip table of contents

Installation Guide

Introduction

This article outlines the process for configuring a new on-premises installation of Gimmal Physical Version 3.15.x

Note: If you are already using an earlier version of Gimmal Physical, please contact Gimmal support for assistance with the upgrade process.

Prerequisites

The following prerequisites are required for the installation of Gimmal Physical

  • Database Server

    • Minimum SQL Server compatibility level 120 (SQL Server 2014)

    • Full-Text and Semantic Extractions for Search feature installed

    • The account used during the installation process must have the following roles in SQL Server:

      • dbcreator

      • securityadmin
        Note: If you are restoring or otherwise replacing an existing database, the account used during installation must be granted dbreader, dbwriter, and dbowner rights on that database.

  • Visual C++ Redistributable. Links to these files can be found in the installer wizard:

    • Microsoft Visual C++ 2010 Redistributable (x86)

    • Microsoft Visual C++ 2010 Redistributable (x64)

  • App Server(s)

    • .Net v4.8

  • Required Server Roles (via Server Manager)

    • IIS Web Server

      • Web Server

        • Common HTTP Features

          • Default Document

          • Directory Browsing

          • HTTP Errors

          • HTTP Redirection

          • Static Content

        • Health and Diagnostics

          • HTTP Logging

        • Performance

          • Static Content Compression

        • Security

          • Request Filtering

          • Basic Authentication

          • Windows Authentication

        • Application Development

          • .NET Extensibility 4.8

          • ISAPI Extensions

          • ISAPI Filters

          • ASP.NET 4.8

      • Management Tools

        • ­ IIS Management Console

          • IIS 6 Management Compatibility

            • IIS 6 Metabase Compatibility

            • IIS 6 WMI Compatibility

            • IIS 6 Scripting Tools

  • Required Server Features (Via Server Manager)

    •   .NET Framework 3.5 Features

      • .NET Framework 3.5 (includes .NET 2.0 and 3.0)

    • .NET Framework 4.8 Features

      • ASP .NET 4.8

      • WCF Services

        • HTTP Activation

    • Windows Process Activation Service

      • Process Model

      • Configuration APIs

Please Note:

  • If installing Gimmal Physical using HTTPS/SSL mode, ensure that the SSL certificate is added to the Trusted Certificate Store before installing the application.

  • The install will fail if passwords contain one or more equals signs (=) .

In some environments with elevated server hardening, the installer may fail to properly validate the provided Server and/or App Pool credentials. Where this occurs, please ensure that any Group Policy restrictions on Incoming and Outgoing NTLM traffic are disabled or set to 'Allow All' to ensure the validation of account credentials.

If you need further assistance, please contact Gimmal Support.

Installation

Gimmal Physical will provide an installation file (iso) for use in the installation process. This file includes the installer and many of the installation components.

To run the installer, please follow the steps below:

  1. Mount and open the provided iso format installation package

  2. Double-Click the setup.hta to run the installer.

  3. The Installer home page opens with a number of choices.

    • Prepare - provides links to useful documentation

    • Prerequisites - provides links to the two Visual Studio C++ Redistributable prerequisite components that may need to be installed, if not present

    • Install - handles the installation of core components (see below)

    • Other Information - links to support and the Gimmal website

  4. If necessary, click on each of the entries listed under Prerequisites to install them

  5. To Install the required components to run the software, click Core Components under the Install option

  6. Click ‘Yes’ on the UAC page to continue.

  7. The main installation page will open, providing a choice of the components to install. For a complete program experience, all components need to be installed.
    Note: The installer will check for prerequisites as it continues

image-20240507-192954.png

Physical Records Web

  1. The Web Installer will first verify the Prerequisites.  If they verify successfully, click ‘Next’.  If any anomalies are detected, resolve them, then restart the process.

    1. Choose the installation path and click ‘Next’

  2. Configure IIS Settings

    1. Web Application Name: The default is PhysicalRecords

    2. Web Application Port: The default is 8080

    3. Fully Qualified Domain Name: Provide the FQDN for the current server host (or alternatively, the FQDN DNS name to be used)

    4. SSL Certificate Choose from the list of installed certificates
      Note:

      1. These settings can be configured manually after the installations, but it is more efficient to set them now.

      2. To avoid issues the selected certificate must be in the Trusted Certificate Store.

  3. Set Application Pool Account

    1. Username for a domain account. Note, use domain\username format

    2. Password for the domain account
      Note: The Application Pool account requires Full Control to the application directory.

  4. Click ‘Next’

  5. Configure Database Settings

    1. Database Server - The name of the database server which will host this database

    2. Database Name - the name of the database. The default name is PhysicalRecords

    3. Automatically Create Database - This option should be unchecked for on-premises installations. However, it is checked by default, this option will create a new baseline database on the database server listed above. This is not recommended for on-premises clients. In most cases, on-premises clients will receive a preconfigured database to import and they should uncheck this option.
      Note: If you are using non-standard regional settings and receive an error, please see note below.

  6. Authentication (Database)
    Note: If these values are not set, then Windows Authentication will be used to connect to the database. In this case, the logged in user will have the appropriate permissions.

    1. Use SQL Authentication Check this option if you prefer to use SQL authentication with the credentials listed below

  7. Click ‘Next’ to install the Physical Records Web and configure the database.

  8. The installer will verify all components have installed correctly. Click ‘Next’.

  9. Click ‘Finish’ to return to the main menu.

In certain localized (on-prem) installations, when selecting the option to automatically create a database during installation, the installer may fail with an error similar to:

ExecuteNonQuery failed for Database 'DIS_DEV_Dummy'. ---> Microsoft.SqlServer.Management.Common.ExecutionFailureException: An exception occurred while executing a Transact-SQL statement or batch. --->

 The result will be that the database is either not created or initialized incorrectly. However, the application binaries themselves are installed correctly. For additional assistance, please contact your Gimmal Team member after completing the installation.

Physical Records REST API

  1.  The Rest API Installer will first verify the Prerequisites.  If they verify successfully, click ‘Next’.  If any anomalies are detected, resolve them and then restart the process.

  2. Choose the installation path and click ‘Next’

  3. Configure IIS Settings

    1. Web Application Name the default is PhysicalRecords

    2. Web Application Port the default is 8081
      Note: Ensure this is a different port from that configured for the Physical Records Web in the steps above.

    3. Fully Qualified Domain Name Provide the FQDN for the current (application) server host

    4. SSL Certificate Choose from list of installed certificates (if available)
      Note:

      1. These settings can be configured manually after the installations, but it is more efficient to set them now.

      2. To avoid issues the selected certificate must be in the Trusted Certificate Store.

  4. Set Application Pool Account

    1. Username for a domain account. Note: use domain\username format

    2. Password for domain account
      Note: The Application Pool account requires Full Control to the application directory.

  5. Click 'Next'

  6. Configure Database Settings

    1. Database Server - The name of the database server which will host this Gimmal Physical database

    2. Database Name - the name of the database. The default name is PhysicalRecords

    3. Authentication (Database)
      Note: If these values are not set, then Windows Authentication will be used to connect to the database. In this case, the logged in user must have the appropriate permissions.

      1. Use SQL Authentication Check this option if you prefer to use SQL authentication. Enter the credentials listed below if this option is selected.

  7. Click ‘Next’ to install the Physical Records Rest API.

  8. The installer will verify all components have installed correctly. Click ‘Next’

  9. Click ‘Finish’ to return to the main menu.

Physical Records Service

This component is used to coordinate job services.

Note: For optimal performance, Gimmal recommends installing the Physical Records Service on a machine separate from your web server. This machine must have access to the database server.

  1. The Rest API Installer will first verify the Prerequisites.  If they verify successfully, click ‘Next’.  If any anomalies are detected, resolve them and then restart the process.

  2. Choose the installation location and click ‘Next’

  3. Configure Service Settings by entering the Username and Password of a service account which will run the Physical Records Service. Click ‘Next’ when finished.

  4. Configure Database Settings and Authentication to mimic those used in setting up the physical Records REST API

  5. Click ‘Next’ to begin the setup and configuration of the Physical Records Service

  6. Click ‘Next’ to install the Physical Records Service

  7. The installer will verify all components have installed correctly. Click ‘Next’

  8. Click ‘Finish’ to return to the main menu.

Once all three components have been installed, the application is functional and should be tested by opening a browser and navigating to the site.

Upgrade

If you have an existing installation of Gimmal Physical that needs to be upgraded, please contact Gimmal Support for assistance.

Post-Installation

After installing or upgrading the Gimmal Physical Application, there are several optional, but recommended, steps that reset cache and configuration so the recent updates will be shown correctly. These are performed inside the application.

  1. Reset Application Cache -

    1. Navigate to Admin on the Top Level Menu

    2. Choose Reset Application Cache from the Technical section close to the bottom (2).

    3. Click ‘OK’ at the popup box to verify the reset.

  2. Recreate Resource Files -

    1. Navigate to Admin on the Top Level Menu

    2. Choose Resource Files close to the bottom of the Configuration section (1).

    3. Click the Create Resource Files link from the Manage Resource Files page

    4. Click the ‘Recreate English’ button from the top right of screen. This recreates the default pages for the resource pages.

Troubleshooting

While the installer validates a number of prerequisites and required values, it is always possible for errors to occur. The installer will log any such errors in the Windows Event Viewer.

The Application Log found in Admin | Application Settings may also prove helpful.

Uninstalling

To Uninstall Gimmal Physical, please use the Programs and Features option in the Control Panel to uninstall each component. This will remove aspects of the application except the database.

Please contact Gimmal Support with any questions or concerns.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.

Contact Support Close