Installation

System Requirements

  • The client machine must have PowerShell 3.0 or newer, with CLRVersion 4.0 or newer
  • The remote server must be running SharePoint Server 2013 Enterprise or newer
  • Both on-prem and Office365 cloud-hosted sites are supported
  • The Managed Metadata Service must be enabled on the server
  • The Client-Side Object Model (CSOM) service must be accessible on the server
NOTE: You do not need an administrator account to use this tool. Any account with Taxonomy permissions will work.

Basic Usage

TaxonomyToolkit's functionality is exposed as a Windows PowerShell cmdlet. To get started, follow these steps:

1. Extract the zip archive into a folder, e.g. C:\TaxonomyToolkit


2. Open the Windows PowerShell command prompt.


3. Check the $PSVersionTable variable to confirm that PSVersion is at least 3.0 and CLRVersion is at least 4.0. If not, install the free upgrade from here:


4. In some configurations, Windows does not trust DLL files that were downloaded from the internet, which causes PowerShell to report a "FileLoadException" when it tries to load the TaxonomyToolkit module. To override this policy, you can use the Unblock-File command (substituting the folder location from step 1):

Unblock-File C:\TaxonomyToolkit\TaxonomyToolkit.PowerShell.dll


NOTE: You must close and reopen your PowerShell console after executing the Unblock-File command.



5. To load the TaxonomyToolkit module, execute this command (substituting the folder location from step 1):

Import-Module C:\TaxonomyToolkit\TaxonomyToolkit.PowerShell.psd1



6. To see the manual pages for the cmdlets, execute these commands:

Get-Help Export-Taxml -Full

Get-Help Import-Taxml -Full

Get-Help Convert-CsvToTaxml -Full

See the Powershell Help section for an online copy of the manual pages.


7. To export taxonomy data from a SharePoint site:

Export-Taxml -Path Output.taxml -SiteUrl http://www.example.com/ -Verbose

If your site is hosted by the Office 365 cloud service, include the -CloudCredential switch in your command line, like this:

$credential = Get-Credential -UserName 'alias@example.com' -Message 'Enter password:'

Export-Taxml -Path Output.taxml -SiteUrl http://www.example.com/ -Credential $credential -CloudCredential -Verbose



8. To create/update a SharePoint site with data from a TAXML file:

Import-Taxml -Path Input.taxml -SiteUrl http://www.example.com/ -Verbose

Or, if the site is hosted by Office 365:

$credential = Get-Credential -UserName 'alias@example.com' -Message 'Enter password:'

Import-Taxml -Path Input.taxml -SiteUrl http://www.example.com/ -Credential $credential -CloudCredential -Verbose

Last edited Jun 9, 2016 at 5:16 PM by pgonzal, version 16