Software Upgrade using the SharePoint User Interface
This section describes the procedures required to upgrade RecordPoint for SharePoint 4.0 software using the SharePoint user interface.
In this section the following topics are covered:
- Installing Software – Explains how to run the msi
- Security groups and Permissions – Explains how to save permissions applied before the upgrade and apply these permissions to the new groups post the upgrade.
- Solution Installation – Explains how to run the PowerShell script which updates the solutions in Central Administration
- Deployment and Configuration – Explains the stage(s) required to completed an upgrade
- Configuration – This process will enable and disable RecordPoint components for both the RecordPoint and Active sites.
- Security configuration – Explains how to update the security settings from both the RecordPoint and Active sites.
The 4.19 upgrade requires either a full crawl to be run or the following script needs to be run MarkStorageSiteContentListsForCrawl.ps1 at the end of the Solution Installation.
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
Security Groups and Permission
RecordPoint provides the ability to manage permissions to record keeping processes and access to record data in the storage layer. Changes to the security infrastructure allows for an opt-in approach to RecordPoint permission settings.
Solution Installation
After updating the RecordPoint software, the RecordPoint solutions must be updated in Central Administration. To complete the solution, update the following two part are required.
An iisreset and Timer Job Service restart is required post running the installation script on all WFE in the SharePoint Farm. This should be scheduled out of business hours.
- Open the command prompt as Administrator
- Run the UpgradeRecordPoint script
By default, this is located under C:\Program Files\RecordPoint\Scripts.
This script updates 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
- Perform a full crawl to be run or the following script needs to be run MarkStorageSiteContentListsForCrawl.ps1
RecordPoint Deployment and Configuration
License RecordPoint using the SharePoint user interface
In order to proceed with the installation, you need to license RecordPoint.
For every RecordPoint instance a license key request needs to be generated. This request needs to be forwarded to the RecordPoint Support Team who will then provide a key that can be updated.
- Go to Application Management
- Go to License RecordPoint
- Select the RecordPoint Web Application
- Select the RecordPoint Site Collection
- Select Generate
- Forward this to the RecordPoint Support Team who will provide a License Key
- Copy and paste the provided Key
- Select Update Key
Configuration using the SharePoint user interface
This process is optional and will enable and disable RecordPoint components for both the RecordPoint and Active Sites.
- Select Configuration
- Select the RecordPoint web application
- Select the RecordPoint site collection
- Check required components
Refer to the Appendix B of this document for components that can be enabled/disabled. - Select Update
Security Configuration
RecordPoint Security in the RecordPoint Site
For the RecordPoint site, four user groups are created as part of deployment. These groups are ranked in order; the lowest level access is granted to Record Visitor. A full description and default permissions for each group can be viewed through the UI under each user group.
A custom SharePoint group created in RecordPoint can have security permissions granted. By default, only the Record Administrator group has full access to stored records, this needs to be enabled for other user groups if required.
To configure security in RecordPoint
Security is enabled by default in the RecordPoint Site.
- Navigate to Management and select Settings
- Under Users and Permissions, click Security Settings
- Select the records role to configure security settings for
- By default, the Records Administrator groups has access to all settings and full control of stored record data
- Update the required settings for this user group, then select the check box under description 'To allow the group access to all records in RecordPoint'. This provides access to the records store so the user can perform actions as per allocated permissions
- If you have a report of previous security settings applied prior to upgrade (section 3.2), add these users to the correct groups
- Click Submit to save
- On the Security configuration page
- Click Update Permissions to synchronise RecordPoint Users to all content sites
RecordPoint Security in the Active Site
For the Active site being managed, by default RecordPoint Security Configuration is disabled. This means that all users granted SharePoint permissions to the active site will have access to perform RecordPoint processes.
However, if RecordPoint Security Configuration is enabled. Administrators will then be able to create custom SharePoint groups and apply specific RecordPoint permissions to this group only. (Thus enforcing security across the active site and limiting RecordPoint functionality to those specified).
A full description and default permissions can be viewed through the UI under each user group.
To configure security in the Active Site
Firstly, security must be enabled for the active site. This must be performed by the system administrator with access to this site.
Enable security
- Navigate to Site Settings, under RecordPoint
- Select Security Settings
- Under Security access for RecordPoint, select Enable
- A confirmation message will update with 'Enabled RecordPoint Security'.
Configure security for existing SharePoint groups
- Navigate to Site Settings, under RecordPoint
- Select Security Settings
- Note: To add users to a group, click View Users to be redirected to the SharePoint page for adding users
- Select the User Group to configure
- Permission levels form will pop up
- Select the required permissions for this user group and click Submit to save.
Applying active site security to multiple active sites
- Run the script, “RecordPointActive.ConfigurationRead.ps1” on the site where security settings have been manually applied.
By default, this is located under C:\Program Files\RecordPoint\Scripts.
This script will save the current settings to a file on disk. - To apply these settings to another active site, use the script “RecordPointActive.ConfigurationUpdate.ps1”