Applies to: Calendar E-Mail Extension for SharePoint on premise (SP2010, SP2013, SP2016, SP2019)
Other versions: View the version for Office 365/SharePoint online
The following guide describes how to install the Calendar E-Mail Extension on your SharePoint on premise.
In this article:Preparation
Sign on to the SharePoint application server as an administrator.
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 Calendar E-Mail Extension to during the setup.
Uninstall previous version to upgrade from version 3
For a new deployment you can skip this section.
Step 1: Run the following command in SharePoint Management Shell for each site where the features are activated. Change http://yoursite with the URL of the site collection.
$web = Get-SPWeb http://yoursite $f = $web.Fields.GetFieldByInternalName("icExternalParticipants") $f.Type = [Microsoft.SharePoint.SPFieldType]::Note; $f.Update($true) $f = $web.Fields.GetFieldByInternalName("icExternalInvitedParticipants") $f.Type = [Microsoft.SharePoint.SPFieldType]::Note; $f.Update($true)
$web = Get-SPWeb http://yoursite
$f = $web.Fields.GetFieldByInternalName("icExternalParticipants")
$f.Type = [Microsoft.SharePoint.SPFieldType]::Note;
$f.Update($true)
$f = $web.Fields.GetFieldByInternalName("icExternalInvitedParticipants")
$f.Type = [Microsoft.SharePoint.SPFieldType]::Note;
$f.Update($true)Step 2: Deactivate the Meeting Organizer and Calendar E-Mail Extension features in the site settings of all sites where these features are activated.
Step 3: Run SetupMO (as an administrator!) to uninstall Meeting Organizer. Alternatively you can retract and delete the solution package calendar_email_extension_mws from the solution store in the central administration, system settings.
Step 4: Run Setup (as an administrator!) to uninstall Calendar E-Mail Extension. Alternatively you can retract and delete the solution package sapiens.at.sharepoint.calendar_email_extension from the solution store.
Step 5: Run SetupFramework (as an administrator!) to uninstall sapiens.at.sharepoint.all.2.3.0 from the solution store.
Step 6: In Server Manager, Configuration, Services restart SharePoint Timer service (on all servers in your farm which can process incoming e-mail).
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 so on.
Navigate to …sapiens.at.setup.CEE\SP201x\Calendar Email Extension 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, SharePoint 2016 or SharePoint 2019.
Ignore the security warning and click on Run.
This is the setup’s welcome screen. Click on Next.
Setup verifies the system state. Make sure the SharePoint Administration Service is started. You will have to restart the setup if one check fails.
Select the Web Applications which you want the Calendar E-Mail Extension to be deployed to.
Enter the license key and click on Next.
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.
The Calendar E-Mail Extension consists of 8 solution packages that must be added and deployed. This will take a few minutes.
After the last deployment job completes, click on Next …
… to view a summary of the installation.
You can verify the installation by viewing the “farm solutions” of your SharePoint.
The following 8 solutions must be installed and deployed.
Please note that you don’t need the last solution if you use it on SharePoint 2010.
If all solutions are deployed successfully, continue with the configuration.
Calendar Email Extension Configuration
Calendar Email Extension 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.
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 “Calendar E-Mail Extension” site collection feature. Go to the site settings of an Calendar E-Mail Extension site, click on Manage site collection features and deactivate and re-activate the Calendar E-Mail Extension feature.
Finally restart the SharePoint Timer Service on all servers in the SharePoint farm.
Uninstall
If you want to uninstall the solution completely, you have to delete all calendar lists that were created from our template. Otherwise you’ll receive an error when opening a calendar after the uninstall. You also have to deactivate all sapiens.at.SharePoint site collection and site features.
When all the features are deactivated, you can uninstall the solution. Re-run the setup and choose Remove after the system check.
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.
