This section describes the procedures required to install and configure the RecordPoint software using Windows PowerShell.
In this section the following topics are covered:
- Installing Software – Explains how to run the msi
- Solution Installation – Explains how to run the PowerShell script which installs and deploys the solutions to Central Administration
- Deployment and Configuration – Explains each of the 5 stages of the deployment process. The first four must be completed for a full deployment and final stage (configuration) is optional.
The following stages are:
- Create Site – This process creates a site collection for the RecordPoint Web Application.
- Solution Deployment – This process deploys the solutions to both the RecordPoint and Active Sites
- Local Deployment – This process deploys RecordPoint logging and diagnostic infrastructure components. By default, this process gets installed to the server when running the msi and will only need to be run on additional servers in the farm.
- Content Deployment – This process will update the content for both the RecordPoint and Active Sites.
- Configuration – This process will enable and disable RecordPoint components for both the RecordPoint and Active Sites.
Install RecordPoint Software
This process installs the RecordPoint software to the server.
- Run the RecordPoint Setup msi
- Follow the installation wizard which will load and guide you through the steps
Solution Installation
After installing the RecordPoint software, the RecordPoint solutions must be installed and deployed to Central Administration.
- Open Windows PowerShell
- Run the InstallRecordPoint.bat script
By default, this is located under C:\Program Files\RecordPoint\Scripts.
This script installs the RecordPoint.wsp and RecordPoint.Active.wsp solutions into the SharePoint Farm - Perform an iisreset and timer job service restart on all WFE in the farm
RecordPoint Deployment and Configuration
The RecordPoint Deployment and Configuration is made up of five (5) processes. The first four (4) are mandatory to do a full installation of RecordPoint.
Create Site using Windows PowerShell
This process is used to create a site collection for all the dedicated RecordPoint Web Application(s) using Windows PowerShell. The RecordPoint site collection must be created through this process as RecordPoint requires a blank site template which cannot be created through the SharePoint user interface.
For more information on how to create a site collection using Windows PowerShell refer to Microsoft TechNet article.
| Info |
|---|
This example retrieves a list of all available site templates and then creates a site collection by using the Blank Site template. Ensure you set name to equal RecordPoint otherwise it will not be available for solution deployment via the UI.
Note: Add the RecordPoint Site Collection Administrator account to the Primary Site Collection Administrator |
| Code Block |
|---|
| language | powershell |
|---|
| title | Example |
|---|
| collapse | true |
|---|
|
.Get-SPWebTemplate
$template = Get-SPWebTemplate "STS#1"
New-SPSite -Url "<URL for the new site collection>" -OwnerAlias "<domain\user>" -Template $template -Name "RecordPoint" |
For more information on how to create a site collection using Windows PowerShell refer to Microsoft TechNet article.
Solution Deployment using Windows PowerShell
This process is used to deploy and retract the RecordPoint solution to both the RecordPoint and Active Sites using Windows PowerShell.
Multiple web applications that are available can be specified to deploy or retract solutions to.
| Info |
|---|
This example deploys the installed RecordPoint solution recordpoint.deployment.wsp to the RecordPoint Web Application and specifies that GAC can be deployed for the new SharePoint solution.
The installed solution recordpoint.deployment.active.wsp will need to be deployed to every Active Site Web Application |
| Code Block |
|---|
| language | powershell |
|---|
| title | Example |
|---|
| collapse | true |
|---|
|
Install-SPSolution -Identity recordpoint.deployment.wsp -WebApplication "Name or GUID of the RecordPoint Web Application" -GACDeployment -Force |
For more information on how to complete a solution deployment using Windows PowerShell refer to Microsoft TechNet article.
License RecordPoint using Windows PowerShell
In order to proceed with the installation, you need to license RecordPoint.
For every RecordPoint instance a license key request needs to be generated.
- Open Windows Powershell as Administrator and run the RecordPointLicenseGenerate.
By default, this script is located under C:\Program Files\RecordPoint\Scripts
| Code Block |
|---|
| title | Parameters |
|---|
| collapse | true |
|---|
|
SiteUrl - The url of the RecordPoint Site
FolderPath - The location of the license request text file located |
- Forward this to the RecordPoint Support Team who will provide a license key
- Open Windows Powershell as Administrator and run the RecordPointLicenseUpdate
By default, this script is located under C:\Program Files\RecordPoint\Scripts.
| Code Block |
|---|
| title | Parameters |
|---|
| collapse | true |
|---|
|
SiteUrl - The url of the RecordPoint Site
LicenseKey - The RecordPoint license key |
Local deployment using Windows PowerShell
This process deploys the RecordPoint logging and diagnostic infrastructure components. By default, this process gets installed to the server when running the msi and will only need to be run on additional servers in the farm.
| Info |
|---|
Single server environments do not need to run this process. |
- Open Windows PowerShell as Administrator and run the LocalRecordPointInstall script.
- By default, this is located under C:\Program Files\RecordPoint\Scripts.
Content Deployment using Windows PowerShell
This process will update the content for both the RecordPoint and Active Site(s). Multiple site collections requiring a content upgrade can be selected and run.
There are five parts to this process:
- Content Upgrade for the RecordPoint site collection(s);
- Batch configuration for RecordPoint;
- Configuration Update for RecordPoint;
- Content Upgrade for the Active Site collection(s); and
- Configuration Update for the Active Site.
Content Upgrade for the RecordPoint site collection(s)
- Open Windows PowerShell as Administrator and run the RecordPoint.ContentDeployment script
- By default, this is located under C:\Program Files\RecordPoint\Scripts.
| Info |
|---|
This script will run through and upgrade the content for the RecordPoint site collection(s) |
| Code Block |
|---|
| title | Parameters |
|---|
| collapse | true |
|---|
|
SiteUrl - The URL of the RecordPoint Site Collection
PackType - Only supported pack is ASISO15489
SearchServiceApplication - The name of the Search Service Application Proxy |
Batch configuration for RecordPoint
- Open Windows PowerShell as Administrator and run the Batch Config script
- By default, this is located under C:\Program Files\RecordPoint\Scripts.
| Info |
|---|
This script will configure the RecordPoint site collection(s). |
| Code Block |
|---|
| language | powershell |
|---|
| title | Variables |
|---|
| collapse | true |
|---|
|
$RecordPointSiteUrl = "The RecordPoint Site Url"
$RecordPointActiveSiteUrl = "The RecordPoint Active Site Url"
$SearchApplicationName = "The Search Service Application Proxy to use for RecordPoint"
$TermStore = "The Term Store details used for RecordPoint Classification"
$TermGroup = "RecordPoint"
$TermSet = "Classification" |
Configuration Update for RecordPoint
- Open Windows PowerShell as Administrator and run the RecordPoint.ConfigurationUpdate script
- By default, this is located under C:\Program Files\RecordPoint\Scripts.
| Info |
|---|
This script updates the configuration settings for RecordPoint. |
| Code Block |
|---|
| title | Parameters |
|---|
| collapse | true |
|---|
|
SiteUrl - The url of the RecordPoint site
ConfigurationSettingName - The key in the config list to update
ConfigurationSettingValue - The value for the key in the config list to update
Enumerators:
RecordPointSiteUrl
SecurityeEnabled
RecordPointRecordNumberField
UseRecordPointNumbering
SearchServiceApplicationName
ListMaximum
FolderMaximum
ItemMaximum
SearchResultViewLimit
SearchResultProcessLimit |
Content Upgrade for the Active Site collection(s)
- Open Windows PowerShell as Administrator and run the RecordPontActive.Upgrade script
- By default, this is located under C:\Program Files\RecordPoint\Scripts.
| Info |
|---|
This script will run through and upgrade the content for the Active Site collection(s). |
| Code Block |
|---|
| title | Parameters |
|---|
| collapse | true |
|---|
|
RecordPointSiteUrl - The URL of the RecordPoint Site Collection
SiteUrl - The URL of the Active Site Collection
PackType - The string for the PackType
IsCrossFarmInstallation - Set this when the Active Site is in a different Farm to the RecordPoint site |
Configuration Update for the Active Site
- Open Windows PowerShell as Administrator and run the RecordPointActive.ConfigurationUpdate script
- By default, this is located under C:\Program Files\RecordPoint\Scripts.
| Info |
|---|
This script updates the configuration settings for RecordPoint. |
| Code Block |
|---|
| title | Parameters |
|---|
| collapse | true |
|---|
|
|
Configuration using Windows PowerShell
This process will enable and disable RecordPoint components for both the RecordPoint and Active Sites.
- Open Windows PowerShell as Administrator and run the ConfigureRecordPoint script
- By default, this is located under C:\Program Files\RecordPoint\Scripts.
| Info |
|---|
This script updates the configuration settings for RecordPoint or the Active Site. |
| Code Block |
|---|
| title | Parameters |
|---|
| collapse | true |
|---|
|
SiteUrl - The url of the RecordPoint or Active Site
ComponentName - The name of the component to action as it is named in Central Admin. To get a full list run this command leaving this value blank or invalid |
| Code Block |
|---|
| title | Enumerators |
|---|
| collapse | true |
|---|
|
Delete Request Processing Infrastructure
Export Infrastructure
Holds Infrastructure
Import Mapping Infrastructure
Label Generation Infrastructure
Migration Infrastructure
Movement History
Record Number Infrastructure
Record Promotion
RecordPoint 2013 Visual Upgrade
RecordPoint Audit Settings
RecordPoint Common Ribbon
RecordPoint Configuration
RecordPoint Daily Tasks Infrastructure
RecordPoint Deployment
RecordPoint Disposal Batching Infrastructure
RecordPoint Disposal Infrastructure
RecordPoint Generic Tasks Infrastructure
RecordPoint Landing Page - ASISO15489
RecordPoint Master Pages
RecordPoint Navigation - ASISO15489
RecordPoint Online
RecordPoint Online File Download
RecordPoint Queueing Infrastructure
RecordPoint Search Infrastructure
RecordPoint Site Security Configuration
RecordPoint Storage Settings
RecordPoint System Messages
Reporting Infrastructure
Reporting Services Infrastructure
Requests Infrastructure
Retention Policy Settings Infrastructure
Scanning Infrastructure
Security Infrastructure
Storage Site Update for BLANK Template
Storage Site Version Update
Transfers Infrastructure
UI Settings EnableYN - Set to "Y" to enable the component or "N" to disable the component |