Contents

Introduction

This article outlines the process for installing Gimmal Physical Version 3.13. In a typical process, the installer will first be used to install core components, followed by the configuration utility to set up the application to a defined scope.

Note: We highly recommend that the installation and configuration of Gimmal Physical should be coordinated with the assistance of the Gimmal Physical technical support team.

Prerequisites

The following prerequisites are required for installation of Gimmal Physical

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

  • Gimmal Physical requires two Visual C++ Redistributables. Links to these files can be found in the installer:

    • Microsoft Visual C++ 2010 Redistributable (x86)

    • Microsoft Visual C++ 2010 Redistributable (x64)

  • Server Roles should include the following:

Installation

Gimmal Physical will provide an installation file (iso) and access for use in the installation process.

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 two key components which may not be

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

    • Other Information - links to support and the Gimmal website

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

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

  6. 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

Physical Records Web

  1. Choose the installation path and click ‘Next’

  2. Click ‘Next’

  3. Configure IIS Settings

    1. Web Application Name: The default is PhysicalRecords

    2. Web Application Port: The default is 8080

    3. Fully Qualified Domain Name in use on this machine

    4. SSL Certificate Choose from list of installed certificates
      Note: These settings can be configured manually after the installations, but it is more efficient to set them now.

  4. Set Application Pool Account

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

    2. Password for domain account

  5. Click ‘Next’

  6. 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 - checked by default, this option will create a new baseline database on the database server listed above. The configuration tool will still be required to apply options for a fully functional application.

  7. 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 have the appropriate permissions.

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

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

Physical Records REST API

  1.  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 found on this machine

    4. SSL Certificate choose from the drop down list

  2. Set Application Pool Account

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

    2. Password for domain account

  3. Click 'Next'

  4. 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

  5. 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 have the appropriate permissions.

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

Physical Records Service

  1. Prerequisites are verified, then click ‘Next’

  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 AP

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

Once all three components have been installed, the application is functional and should be tested by opening a browser and navigating to the site. For full functionality, however, the application will need to be set up using the Configuration Utility, the usage of which should be discussed with the Gimmal Implementation team.

Upgrade

To upgrade from a previous version of Gimmal Physical, first run the installer, then the configuration utility, followed by some options in the application itself.

Note:

  • Version 3.12 is the minimum supported version that can be upgraded using the installer. If upgrading from a version 3.11 or below , please contact technical support for assistance.

  • The process of the installation automatically runs the scripts to update the database to the latest version

Installer

Follow the same directions as above until you reach the Database Settings page for each component.

  1. For the Database Name value choose the name of the database you are upgrading.

  2. Ensure the Automatically Cerate Database value is NOT checked.

Configuration Utility

Once the components have been installed, the application will still need to be configured using the Configuration Tool (infolinxWebConfiguration.exe). This step also handles the conversion and storage of the CRUD pages.

Reminder: Run the configuration utility as Administrator.

  1. Open the Web Configuration file called web.config found in the default directory under the Web folder.

  2. Adjust details as needed.

  3. Select Misc | Create Item Types | All Item Types from the menu options

  4. Select Misc | Update Permissions from the menu options

  5. Click ‘Save’

  6. Click ‘Exit’

Post Installation

Errors

While the installer validates a number of prerequisites and required values, it is always possilbe 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.

Application Options

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.

  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.

    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.

    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.

Uninstalling

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

Version History

Version

Approved By

Effective Date

Product Version

Description of Change

1

Marta Farensbach

4/28/2023

3.13

Created for version 3.13