Updating MatchPoint Snow
Update MatchPoint
Update MatchPoint using either the MatchPoint installer binary or by using PowerShell.
For more information, please refer to the MatchPoint Installation Guide document.
Update MatchPoint Snow
Use Update-SPSolution
to update the MatchPoint Snow solution:
Update-SPSolution -Identity Colygon.MatchPoint.Snow.wsp
-LiteralPath c:\path\Colygon.MatchPoint.Snow.wsp
-GacDeployment
Restart-Service SPTimerV4
This will deploy the newest DLL to the GAC. After the update, the Cmdlet
for updating MatchPoint Snow configuration files and other components
will be available (Update-MPSBase
and Update-MPSWebs
).
PowerShell needs to be restarted in order for the new/updated CmdLet to become available.
The following chapters will describe the two PowerShell CmdLets which need to be executed in order to update MatchPoint Snow:
Update-MPSBase
: re-enables the two MatchPoint Snow features (Colygon.MatchPoint.Snow
on the MatchPoint Snow site collection andColygon.MatchPoint.Snow.Configurations
on the MatchPoint Instance web). Also non-web-specific update steps are processed.Update-MPSWebs:
iterates over all webs which are part of MatchPoint Snow and updates them to the current version.
A script for updating MatchPoint Snow is located at: ..\3_MatchPoint_Snow\Update\Update.ps1
Note that you have to specify the optional parameter -updateWebs
if
you also want to update the webs and not only perform the Update-MPSBase
step.
This script will consider the MatchPointSnowUpdateConfiguration
which can be created in the MatchPoint Configuration Editor. You will be
notified and asked if you want to use and configure it in all scripts
that consider it. These update settings can also be used to select which
version specific update steps will be performed.
The Update Settings are considered as follows:
- There is no update configuration:
In this case
Update-MPSBase
andUpdate-MPSWebs
will just work as before and all mandatory parameters will be required and requested - There is an update configuration: In this case the update configuration will be taken into concern, even if it is not explicitly referenced using the UpdateConfigurationName parameter.
- There are multiple update configurations: The script will notify you and you have to specify which one should be used.
The parameters specified in the PowerShell will always overrule the settings in the configuration.
Update-MPSBase Cmdlet
The Update-MPSBase
PowerShell Cmdlet is available in the SharePoint
2013 Management console. Please note that you need to execute it with a
user that is member of the farm administrators group.
The following steps are executed by the Cmdlet:
- Backup changed files: Any configuration files that are part of
MatchPoint Snow and that have been changed from the ones released
with former MatchPoint Snow version will be saved in the
configuration library. The name of the backup has the format
{name}\_Backup\_{version}.xml
- Reactivate the feature
Colygon.MatchPoint.Snow.Configurations
on the MatchPoint instance site collection: This deploys the new configuration files to the MatchPoint configuration library. - Reactivate the feature
Colygon.MatchPoint.Snow
on the MatchPoint Snow root site collection: This will update the configuration file MatchPointSnowConfiguration.xml with the URL of the Snow root site (SiteCollectionUrl property). - Generally non-web-specific updates will be processed, e.g. changing Configurations files.
- Some configurations that are no longer in use will be deleted (i.e. user control configurations that were transformed to user controls located in the _layouts folder).
- Process any pre-actions which are defined per version. This could the reactivation of features or executing a tag importer.
- Process any post-actions which are defined per version. This could the reactivation of features or executing a tag importer.
The Cmdlet can be executed with following parameters:
Parameter name | Type | Required | Description |
---|---|---|---|
LogFilePath | Path | Yes | The output / log file will be written to this file. If the file already exists, it will be overwritten, the directory however needs to exist. |
WebApp | Url | Yes | The URL to the web application which hosts MatchPoint and MatchPoint Snow. |
IgnoreVersionCheck | Flag | Ignore the current version applied and perform the update for all versions anyway. | |
IgnoreVersionCheckFor | String Array | An array of versions (e.g. @('2013.11.0.0')) for which the version check should be ignored, e.g. the update process for this versions will be done regardless of the applied version. | |
SkipBackups | Flag | Do not create backups of the change configuration files. | |
Verbose | Flag | Specify this flag to write the output to the console as well as to the log file. | |
SkipSnowFeatureActivation | Flag | Specify this flag to prevent the MatchPoint Snow features (Colygon.MatchPoint.Snow.Configurations and Colygon.MatchPoint.Snow from being activated on the Snow site collection) |
|
SkipComposedLookReApplication | Flag | ||
UpdateConfigurationName | String | The file name of the MatchPoint Snow Update configuration, which can be created and configured using the MatchPoint Configuration Editor |
Update-MPSWebs Cmdlet
Depending on the parameter specified, the script will iterate over the relevant SharePoint elements and perform following actions:
- Update the web to the current version of MatchPoint Snow (perform all steps required from source- to target version). An example of such an action can be adding a Web Part to the landing page of a workspace or re-enabling certain features (web- or site-scoped).
- Reapply the current composed look. This is required in order to ensure that the themable CSS files and images are generated.
- Write the currently installed/updated version of MatchPoint
Snow (e.g. 2013.11.0.0) to the property bag of the SPWeb. The property
is called
__MPSnowVersion
. - Snow related sites include:
- The MatchPoint Snow site collection and sub webs (recursive)
- Any Snowflake site collections and sub webs (recursive)
- Any Snow workspaces (based on the workspace list), their sub workspaces (meetings) and other sub webs (recursive)
Parameter name | Type | Required | Description |
---|---|---|---|
LogFilePath | Path | Yes | The output / log file will be written to this file. If the file already exists, it will be overwritten, the directory however needs to exist. |
WebApp | Url | (Yes) |
The URL to the web application which hosts MatchPoint and MatchPoint Snow. If this parameter is specified, then all webs belonging the current Snow Application will be updated. This means:
In case you have workspaces which are based on a different template, you need to specify the WorkspaceListUrl. |
WorkspaceListUrl | Url | (Yes) | The URL to a list contain workspaces which are also related to MatchPoint Snow, but are not the ones defined in the default MatchPoint Snow Workspace Template (MPSnow.Workspace.Template.xml) |
WebUrl | Url | (Yes) | The URL to a specific web which should be updated. |
SkipComposedLook-ReApplication | Flag | ||
IgnoreVersionCheck | Flag | Ignore the current version applied and perform the update for all versions anyway. | |
IgnoreVersionCheckFor | String Array | An array of versions (e.g. @('2013.11.0.0')) for which the version check should be ignored, e.g. the update process for this versions will be done regardless of the applied version. | |
UpdateConfigurationName | String | The file name of the MatchPoint Snow Update configuration, which can be created and configured using the MatchPoint Configuration Editor |
Please note that you either need to specify the WebApp
, the
WorkspaceListUrl
or a WebUrl
. Webs which do not belong to
MatchPoint Snow will not be processed.
Update the Managed Properties
The managed properties required by MatchPoint Snow need to be updated in order to match the managed properties as described in Post Installation Steps, Search Service Application.
Add-MPSManagedProperties -SearchServiceApplication <SSA>
Update the User Properties
The user properties required by MatchPoint Snow need to be updated.
Add-MPSUserProperties -WebAppUrl <WebAppUrl>
Workspace Aggregation Mode
If the workspace aggregation mode has been changed by using the PowerShell cmdlet Set-MPSWorkspaceAggregation
, it has to be executed with the same parameters again after updating MatchPoint Snow.
Workspace Item Storage Mode
If the workspace storage mode has been changed to distributed mode by using the PowerShell cmdlet Enable-MPSWorkspaceItemInWebMode
, it has to be executed with the same parameters again after updating MatchPoint Snow.