This article describes how to install the eformity Template Manager for SharePoint 2019. How to configure the Template Manager, and how to export content types from SharePoint to your eformity environment.
Downloading the Package
You can download the eformity Template Manager for SharePoint 2019 package from the following URL:
https://download.eformity.nl/eformity.SharePoint.2019.wsp
Installing the package
Installing the Template Manager package is done using PowerShell. The easiest way you can do this is by using the SharePoint 2019 Management Shell, as the required SharePoint modules are automatically loaded. In order to perform the installation, some commands need to be executed to deploy the package.
You can copy the commands below and paste them into PowerShell and run them. Be sure that the path matches the location of your downloaded package.
Deploying the package
To install the Template Manager, you must add the package and install it using the following 2 commands.
Add‑SPSolution "D:\eformity.SharePoint.2019.wsp" |
Install‑SPSolution -Identity "eformity.SharePoint.2019.wsp" -AllWebApplications -GACDeployment |
Please note that after deploying the package you still need to activate the Template Manager before it's available. Read more about this under Activating the feature.
Deployment status
Deploying a package take a while. With the following command you can check the status of the deployment and see if the deployment is already finished or not.
Stsadm -o Enumdeployments |
Updating the package
If you have a new version of the Template Manager, and you want to update it, you can do so with this command.
Update‑SPSolution -Identity "eformity.SharePoint.2019.wsp" -LiteralPath "D:\eformity.SharePoint.2019.wsp" -GACDeployment |
Uninstalling the package
If you need to uninstall the Template Manager, you can do so by running the following 2 commands.
Uninstall‑SPSolution -Identity "eformity.SharePoint.2019.wsp" -AllWebApplications |
Remove‑SPSolution "eformity.SharePoint.2019.wsp" |
Configuring the settings
After installing the package you can use Central Administration to configure the Template Manager settings, for example the URL to your eformity environment.
To get to the settings go via General Application Settings [1] to Configure the Template Manager settings [2]. In the next screen, enter the desired settings and click OK [3].
Available settings
There are several fields you can configure.
- Host
This is the url to your eformity environment. This field is required. - API key
An API key is required to get access to your eformity environment. You can configure an API key in your eformity environment. This field is required. - Default site name
The site name is used when exporting content types from SharePoint to your eformity environment. Exporting content types is described under the heading Exporting content types. - Default value mapper name
This setting allows you to configure which value mapper is used to retrieve and set document properties in SharePoint.
Activating the feature
After the eformity Template Manager has been installed it can be activated at Site Collection. Activating the feature can only be done by a Site Collection administrator.
To activate a feature, go to your site's settings and click on the Site collection features [1] link under the Site Collection Administration heading.
A list of available features for the current Site Collection is displayed. In this list, find the feature eformity | Template Manager and click the Activate [2] button behind this item.
The feature is now activated and visible [3] in your document libraries.
HTTPS with a Self-Signed certificate
This step is only necessary if you are connecting to eformity over an HTTPS connection with a Self-Signed certificate.
If so, the server's root certificate must be set as a trusted certificate in SharePoint. SharePoint ignores trusted certificates set through Manage Computer Certificates.
A trusted certificate can be configured through SharePoint's Central Administration. To do this, go via Security [1] to Manage trust [2].
In the Trust Relationships page click New [3]. You will now see the Establish Trust Relationship window. Enter a name at Name [4] and upload the public key of the root certificate at Root Authority Certificate [5]. Click OK [6] to add the certificate.
Exporting content types
You can export content types from your SharePoint environment to your eformity environment. These content types can be used to automatically set a content type when uploading a document, presentation etc. from eformity to SharePoint.
To export content types navigate to the following URL. Do edit the url to your own SharePoint environment:
https://blueorange.sharepoint.com/_layouts/15/eformity/ExportContentTypes.aspx
On this pagfeClick the menu item Export content types [1] to export content types to your eformity environment.
On the next screen you can choose which content types you want to export and which ones you don't. The content types are organized by group [2]. You can select which content types you want to export to your eformity environment by setting the checkboxes. If the checkbox is checked, this content type will be exported. If it is not checked, it will not be exported. With the checkbox next to the name of the group, for example "Document Content Types", you can check or uncheck all content types in this group at once.
When you have selected all the content types you want to export, click on Export selected items [3].
You will now see a log [4] which will indicate whether the export was successful or not.
All selected content types are now exported to your eformity environment.