Architecture Planning
Prerequisites
Before installing MatchPoint 5.0 on a SharePoint farm, please make sure that the environment meets the following prerequisites:
- Microsoft SharePoint 2016 is installed and configured on all servers of the farm.
- At least one web application for use with MatchPoint has been created and configured.
- A site collection that will host the MatchPoint Instance Administration site has been created, see section "Instance Administration Site".
- A search service application (SSA) for querying SharePoint content
is configured
This is not required for Installations of SharePoint Foundation.
To ensure that the SharePoint SSA search works correctly, it is suggested to conduct a test search with the standard SharePoint search interface. - For multi-language installations, all required SharePoint language packs should be installed before MatchPoint is deployed to the system. It is possible to install language packs at a later time.
- Make sure that an event log source with the name "MatchPoint" is available on every server. Refer to Additional Installation Steps.
- On the SQL server instance, the "Full Text Search" feature is installed.
The SQL "Full Text Search" feature is only required, if the tagging functionality of MatchPoint is used. Full text search has to be available on SQL server instances where one or more MatchPoint "tagging service application" instances are created. Full-text search is an optional component of the SQL Server Database Engine. For more information, see the MSDN article [Install SQL Server 2014](https://msdn.microsoft.com/en-us/library/bb500395(v=sql.120).aspx) or another article which corresponds to yur SQL Server version.
Instance Administration Site
Administrative operations of MatchPoint are managed from one site collection that is referred to as the "Instance Administration" site. This site is also used to store MatchPoint configuration files. Only one site collection per web application can be configured as the Instance Administration site.
The web application that contains the Instance Administration site is automatically part of that MatchPoint instance. Additional web applications can either be configured as separate MatchPoint instances (with an own Instance Administration site), or they are associated to the MatchPoint instance on a different web application. Within a MatchPoint instance, all central configuration files are loaded from one Instance Administration site.
Depending on the architecture of a farm, the Instance Administration site can be configured on...
- ... a regular content site collection (in small environments, MatchPoint Workgroup license).
- ... a dedicated site collection (with no other content).
MatchPoint uses a caching mechanism for configuration files that uses the "last modified" date of the Instance Administration site to validate the cache. Therefore, it is recommended to choose a dedicated site collection (which is not the web application root site collection) for most scenarios. This also allows the implementation of specific permission settings on the MatchPoint instance.
For installations using the 'Workgroup' license, you can only use MatchPoint within one site collection. Therefore it is not supported to create a dedicated site collection for the Instance Administration site.
Required Files
The following SharePoint solution files are required to install Colygon MatchPoint:
- Colygon.MatchPoint.wsp
- Colygon.MatchPoint.TaggingService.wsp
- Microsoft.Deployment.Compression.wsp
For the automated installation or for migrations from 3.1.x version, the MatchPoint installer executable is required:
- Colygon.MatchPoint.Installer.exe
The MatchPoint wsp solution files are used by the MatchPoint installer; therefore they need to be located within the same directory as the executable.
Solutions and Features
The following features are deployed to a SharePoint farm with
MatchPoint wsp solution files.
Features that are marked with a * are enabled during the MatchPoint
installation process. Therefore, they might be hidden and can only be
installed using either the MatchPoint installer executable or by using
the "SharePoint Management Shell" (or the STSADM utility).
Depending on your application scenario, you might not use all of the available features. If this is the case, please omit all configuration/installation steps provided within the subsequent chapters of this document.
Colygon.MatchPoint.wsp
Contains all MatchPoint functionality that is available within a SharePoint foundation installation.
Colygon.MatchPoint.Core.Infrastructure*
Feature Id: 093f1c0f-a728-4f29-899e-d04e6b940ed9
Scope: WebApplication
Description: Registers the MatchPoint request handler in the web.config
file.
Colygon.MatchPoint.Core.Administration*
Feature Id: cde85a0c-4b3d-4ac8-b9db-4c805ca7358d
Scope: Site
Description: Enables the MatchPoint Administration on this site
collection.
Colygon.MatchPoint.Tagging.Inheritance
Feature Id: 32ac9c62-1d87-442a-9a3d-4505699e03c4
Scope: WebApplication
Description: Enables the MatchPoint tag inheritance for this instance.
Colygon.MatchPoint.Tagging.Infrastructure
Feature Id: 9585e1c8-0a16-4c2b-b54e-1b38fc068620
Scope: Site
Description: Adds tagging functionality to this site collection.
Colygon.MatchPoint.Core.WebParts
Feature Id: a0bad902-902c-41e2-8891-6280cea16e09
Scope: Site
Description: Adds the MatchPoint Web Parts to the site collection.
Colygon.MatchPoint.Workspace
Feature Id: 39cd0f63-faaa-4277-bb3c-4069912424df
Scope: Web
Description: Adds the MatchPoint Workspaces functionality to this web.
Colygon.MatchPoint.WorkflowKit
Feature Id: 5787fd56-2f95-4126-876c-e1e0d4a07146
Scope: Site
Description: Adds the MatchPoint Workflow Kit functionality to this site
collection.
Colygon.MatchPoint.Provisioning.SaveSiteAsTemplate
Feature Id: 8fb9c9e7-c2f3-4ed4-a616-b546a2571e01
Scope: Site
Description: Displays a custom action "Save Site as Provisioning
Template" on the site settings page.
Colygon.MatchPoint.SendTo
Feature Id: 1a6edec5-8863-41d1-9075-80fe85d0623a
Scope: Site
Description: Adds a custom action that allows sending documents to
MatchPoint enabled locations within the farm.
Colygon.MatchPoint.TaggingService.wsp
Contains the MatchPoint tagging service as a farm-wide feature.
Colygon.MatchPoint.Tagging.Service*
Feature Id: 4cd2fe48-9891-4f5e-812c-49899bbf64eb
Scope: Farm
Description: Installs the MatchPoint tagging service.
Colygon.MatchPoint.Hybrid.wsp
Contains the optional MatchPoint Hybrid features that enables MatchPoint Hybrid support.
Colygon.MatchPoint.Hybrid
Feature Id: 2f7d21ba-5db8-4b4c-b759-b6f3d7655fae
Scope: Site
Description: Installs the MatchPoint Hybrid support functionality.
Colygon.MatchPoint.Hybrid.RemoteWorkspaceCleanup
Feature Id: 0b6e1b7d-f098-4961-94ab-d6da88f13187
Scope: WebApplication
Description: Installs the MatchPoint Remote Workspace Cleanup Timer Job.
Colygon.MatchPoint.wsp and Colygon.MatchPoint.TaggingService.wsp both depend on Colygon.MatchPoint.dll. If one of these solutions is retracted from a server (or farm, as Colygon.MatchPoint.TaggingService.wsp is a farm wide solution), the Colygon.MatchPoint.dll is removed from the assembly cache (depending on the setup either from one server or all servers). This may lead to unexpected behavior (e.g. if Colygon.MatchPoint.dll is missing on the server that hosts Central Administration, MatchPoint tagging service applications and instances are not displayed).
If you decide to retract one of these solutions, the other solution has to be re-deployed using the -force parameter.
SharePoint will also retract Colygon.MatchPoint.dll from the global assembly cache of the specified server if the Microsoft SharePoint Foundation Web Application instance is stopped on a server in a farm. This requires to re-deploy Colygon.MatchPoint.wsp or Colygon.MatchPoint.TaggingService.wsp using the –force parameter.
This solution is introduced new with MatchPoint version 3.1.0. It encapsulates the functionality required for deploying one or more tagging service applications. Within previous versions of MatchPoint, this functionality was part of the Colygon.MatchPoint.wsp solution, which could lead to problems in multi-server SharePoint installations.
If a server is configured as an application server, the service Microsoft SharePoint Foundation Web Application will not be available. However, this service is required if a solution contains resources that are targeted for a web application, site collection or site (like site-collection scoped features). Therefore, it was not possible until now to install only the tagging service on an application server.
The new solution Colygon.MatchPoint.TaggingService.wsp is targeted at servers with DeploymentServerType ApplicationServer and will be deployed globally to all servers in the farm.
Please note, that the installation of the Tagging Service Application requires the server to have the MinRole "Custom". Otherwise the Tagging Service Application will not be compliant.
globally to all servers in the farm.Planning Environments with many workspaces
For more information please refer to Environments with many workspaces.