Explorer Service for Windows Installation Prerequisites

General Windows Prerequisites

  • Microsoft .NET Framework 4.7.2 or 4.8 installed

  • Java Runtime environment 17 or higher

Prerequisites for Windows Operating System Versions

Windows 10

  1. Click Turn Windows features on and off on the Start menu.

  1. Expand .NET Framework 4.X Advanced Services.

  2. Expand WCF Services and click TCP Port Sharing.

Windows Server 2019

  1. Click Administrative Tools > Server Manager on the Start menu.
  2. Click Add roles and features from the dashboard.
  3. Click Next twice.
  4. Click Features.
  5. Expand .NET Framework 4.5 Features in the Features area.
  6. Click WCF Services.
  7. Click TCP Port Sharing under WCF Services.

Windows Server 2016

  1. Click Administrative Tools > Server Manager on the Start menu.

  1. Click Add roles and features from the dashboard.

  2. Click Next twice.

  3. Expand the .NET Framework 4.6 Features in the Features area.

  4. Click WCF Services.

  5. Click TCP Port Sharing in the WCF Services section.

Windows Server 2012 R2

  1. Click Administrative Tools > Server Manager on the Start menu.

  2. Click Add roles and features from the dashboard.

  3. Click Next twice.

  4. Expand .NET Framework 4.5 Features in the Features area.

  5. Click WCF Services.

  6. Click TCP Port Sharing under WCF Services.

Windows Server 2008

  1. Click Administrative Tools > Server Manager on the Start menu.

  2. Click Add features and expand Select .NET Framework 3.5.1 in the Features area.

Windows 7

Click the Microsoft.NET Framework 3.5.1. on the Turn on Windows features on or off dialog.

Explorer Service for Windows Installation Location and Components Installed

The default install location for the Explorer Service and Admin Tool is:

Example: C:\Program Files\TIDAL\Explorer

These components are installed by default in the Explorer folder.

File

Description

 
TidalExplorerService.exe

The Tidal Explorer Service executable.

 
TidalExplorerService.exe.config

The xml configuration file used by the TidalExplorerService.exe.

 
TidalExplorerAdmin.exe

The Tidal Explorer Admin tool.

 
TidalExplorerAdmin.exe.config

The xml configuration file used by the TidalExplorerAdmin.exe.

 
lib/MasterLink.jar
lib/*.jar

The MasterLink component used by the Service and other java libraries used by MasterLink.

 
config/explorer.props

The properties file used to configure the MasterLink component.

 
scripts/create-explorer-service 
cert.ps1

 

PowerShell script to support user creation of root CA-signed Explorer Server certificate when configured for LDAP or Active Directory Authentication. 

ExplorerConfig.exe

The Tidal Explorer Config executable.

 
ExplorerConfig.exe.config

The xml configuration file used by ExplorerConfig.exe.

 
sampleconfigs/activedirectory/
TidalExplorerService.exe.config
TidalExplorerAdmin.exe.config
TidalExplorerAdmin.exe.WShttp.config
config/explorer.props

Sample configuration files for ActiveDirectory.

These samples are used by ExplorerConfig to support configuring the Explorer for ActiveDirectory.

The content of TidalExplorerAdmin.exe.WShttp.config is used when administering an Explorer Service running on Linux.

 
sampleconfigs/ldap/
TidalExplorerService.exe.config
TidalExplorerAdmin.exe.config
TidalExplorerAdmin.exe.WShttp.config
config/explorer.props

Sample configuration files for LDAP.

These samples are used by ExplorerConfig to support configuring the Explorer for LDAP.

The content of TidalExplorerAdmin.exe.WShttp.config is used when administering an Explorer Service running on Linux.

 
sampleconfigs/integratedsignon/
TidalExplorerService.exe.config
TidalExplorerAdmin.exe.config
config/explorer.props

Sample configuration files for Integrated sign-on.

These samples are used by ExplorerConfig to support configuring the Explorer for IntegratedSignOn.

Explorer Service for Windows Processes and configuration files

The diagram shows the main processes and configuration files associated with Explorer Service for Windows.

The Explorer Service for Windows captures and stores data from connected Tidal Masters in a folder configured using the DataStore setting. 

This folder will contain:

  • \data – contains data files from Tidal Masters via MasterLink

  • \derived – contains summary data files produced by Explorer Service

  • \log – contains logs from explorer service, admin tool and MasterLink

  • \search – contains output search results files produced by Explorer Service

The Administration Tool and the Explorer Service are installed on the same Windows machine.