SharePoint List Filter Web Part Installation

Applies to: SharePoint List Filter Web Part for SharePoint on premise (SP2010, SP2013, SP2016, SP2019)


The following guide describes how to install the SharePoint List Filter Web Part.

In this article:

The SharePoint List Filter Web Part comes with a simple installer that lets you deploy the solution with a few clicks.

The SharePoint List Filter Web Part is available for SharePoint 2010, SharePoint 2013, SharePoint 2016 and SharePoint 2019. The setup contains a 2010, 2013, 2016 and a 2019 folder.

Preparation

Sign on to the SharePoint Server’s console as an administrator.

Extract the SharePoint Filter Web Part Setup

Download the latest release and unzip the setup files to a local folder.

Make sure that the setup has write access to the setup files folder.

The worker process pools of your SharePoint Farm will be recycled during installation. Consider which web applications you want to deploy the List Filter Web Part to during the setup.

Installation

Browse to the folder where you unzipped the setup files. The folder SP2010 contains the setup and solution packages for SharePoint 2010, the folder SP2013 contains the setup and solution packages for SharePoint 2013 and the folder SP2016 contains the setup and solution packages for SharePoint 2016.

Navigate to …sapiens.at.setup.FWP\SP201x\List Filter Web Part and run Setup.exe (as an administrator!).

NOTE: The screen shots were taken from the SharePoint 2013 setup. There should be no differences in SharePoint 2010 or SharePoint 2016.

Run the SharePoint Filter Web Part Setup

Ignore the security warning and click on Run.

This is the setup’s welcome screen. Click on Next.

Welcome to the List Filter Web Part for SP2013 setup wizard

Setup verifies the system state. Make sure the SharePoint Administration Service is started. You will have to restart the setup if one check fails.

Filter Web Part Setup - System Check

Enter the license key and click on Next.

SharePoint List Filter Web Part Setup - License Key

Select the Web Applications which you want the SharePoint List Filter Web Part to be deployed to.

SharePoint List Filter Web Part Setup - Select Web Application

The setup will now try to validate the key. If the setup can’t connect to the key validation service (http://keyvalidation.sapiens.at/validate.asmx) the setup will fail. To continue with the installation, please take a look at Offline license validation.

SharePoint List Filter Web Part Setup - Validating License

The SharePoint List Filter Web Part consists of 3 solution packages that must be added and deployed. This will take a few minutes.

SharePoint List Filter Web Part Setup - Installation Progress

After the last deployment job completes, click Next …

SharePoint List Filter Web Part Setup - Installation successfully completed

… to view a summary of the installation.

SharePoint List Filter Web Part Setup - Summary

You can verify the installation by viewing the “farm solutions” of your SharePoint.

SharePoint Manage Farm Solutions

The following 3 solutions must be installed and deployed.

SharePoint Solution Management

If all solutions are deployed successfully, continue with the configuration.

SharePoint List Filter Web Part Configuration

SharePoint List Filter Web Part Overview

Update

The new version is published as the latest setup. The download contains one setup for SharePoint 2010, one for SharePoint 2013, one for SharePoint 2016 and one for SharePoint 2019.

Download the latest setup

View the release notes

Run setup.exe as an administrator and choose ‘Repair’ after the system check.

If the setup can’t connect to the key validation service the setup will fail. To continue with the installation, please take a look at Offline license validation.

If your key is invalid, please send an e-mail to support@sapiens.at and include your current license key. We will get back to you as soon as possible.

After the setup is complete, you have to deactivate and then re-activate the “Sapiens.at.SharePoint List Filter Web Part” site collection feature. Go to the site settings of a site with the List Filter Web Part, click on site collection features and deactivate and re-activate the Sapiens.at.SharePoint List Filter Web Part feature.

Finally restart the SharePoint Timer Service on all servers in the SharePoint farm.

Uninstall

If you want to uninstall the filter web part completely, you have to remove the web part from all pages and deactivate all sapiens.at.SharePoint site collection and site features.

When all the features are deactivated, you can uninstall the web part. Re-run the setup and choose Remove after the system check.

Remove the solution

As an alternative, you can also retract and remove the solutions from the farm solutions in central administration. Please note that you cannot move the license to a different system if you use this approach.

Offline key validation

If your SharePoint Server is located behind a proxy or is not permitted to access our online key validation service you will need to perform an offline validation to successfully complete the setup and activate the solution. For online validation go to http://keyvalidation.sapiens.at/manualvalidation.aspx. The unvalidated surety file which you need to upload is created during the setup process. Upload it, then validate it and download the validated surety file to the setup folder and run the setup again.

Move license to a different system

If you want to move your license to a different system, please uninstall the solution from your old system using our setup (see Uninstall) and install the solution again on your new system. This is not possible if you use a trial key.

Manually remove license usage

If your SharePoint Server is located behind a proxy or is not permitted to access our online key validation service you will need to remove the license usage manually to be able to use the license key again on a different system. If the setup can’t connect to the key validation service (http://keyvalidation.sapiens.at/validate.asmx) it will create a file named uninstallSurety…xml in the setup folder. Upload this file to http://keyvalidation.sapiens.at/manualuninstall.aspx to remove the license usage. Now the license key can be used on a different system.