BOOST V1 Permission Report User Guide

: June 5, 2024
: BOOST

Table of Contents

BOOST V1 Permission Report
Introduction
Installation
Software Requirements
Server Installation
Generate Permission Reports
Appendix 1: License Management
Documents / Resources

BOOST V1 Permission Report

Copyright
Copyright ©2022 BoostSolutions Co., Ltd. All rights reserved.
All materials contained in this publication are protected by Copyright and no part of this publication may be reproduced, modified, displayed, stored in a retrieval system, or transmitted in any form or by any means, electronic, mechanical, photocopying, recording or otherwise, without the prior written consent of BoostSolutions.
Our web site: https://www.boostsolutions.com

Introduction

Permission Report grants administrators with the capability to generate various SharePoint permission reports based on an account, permission level, permission inheritance and more. With these reports, it is easier for administrators to understand permission hierarchy and improve management.
This user guide is used to instruct and guide users to configure and use Permission Report.
For the latest copy of this and other guides, please visit:
https://www.boostsolutions.com/download-documentation.html

Installation

Product Files
After you download and unzip the Permission Report zip file from www.boostsolutions.com, you will find the following files:

Path	Descriptions
Setup.exe	A program that installs and deploys the WSP solution packages to

the SharePoint farm.
EULA.rtf| The product End-User-License-Agreement.
Permission Report_V1_User Guide.pdf| User guide for Permission Report in PDF format.
Library\4.0\Setup.exe| The product installer for .Net Framework 4.0.
Library\4.0\Setup.exe.config| A file containing the configuration information

for the installer.

Library\4.6\Setup.exe| The product installer for .Net Framework 4.6.
Library\4.6\Setup.exe.config| A file containing the configuration information for the installer.
Solutions\Foundtion\ BoostSolutions.FoundationSetup15.1.wsp| A SharePoint solution package containing

Foundation files and resources for SharePoint 2013 or SharePoint Foundation 2013.

Solutions\Foundtion\ BoostSolutions.FoundationSetup16.1.wsp| A SharePoint solution package containing

Foundation files and resources for SharePoint 2016/2019/Subscription Edition.

Solutions\Foundtion\Install.config| A file containing the configuration information for the installer.
Solutions\PermissionChecker\ BoostSolutions.PermissionReportSetup15.1.wsp| A SharePoint solution package containing

Permission Report files and resources for SharePoint 2013 or SharePoint Foundation 2013.

Solutions\PermissionChecker\ BoostSolutions.PermissionReportSetup16.1.wsp| A SharePoint solution package containing

Permission Report files and resources for SharePoint 2016/2019/Subscription Edition.

Solutions\PermissionChecker\Install.config| A file containing the configuration information for the installer.

Software Requirements

Before you install Permission Report, ensure your system meets the following requirements:

SharePoint Server Subscription Edition

Operating System

| Windows Server 2019 Standard or Datacenter Windows Server 2022 Standard or Datacenter
---|---
Server| Microsoft SharePoint Server Subscription Edition

Browser

| ****

Microsoft Edge Mozilla Firefox Google Chrome

SharePoint 2019

Operating System

| Windows Server 2016 Standard or Datacenter Windows Server 2019 Standard or Datacenter
---|---
Server| Microsoft SharePoint Server 2019

Browser

| Microsoft Internet Explorer 11 or above Microsoft Edge

Mozilla Firefox Google Chrome

SharePoint 2016

Operating System

| Microsoft Windows Server 2012 Standard or Datacenter X64 Microsoft Windows Server 2016 Standard or Datacenter
---|---

Server

| Microsoft SharePoint Server 2016 Microsoft .NET Framework 4.6

Browser

| Microsoft Internet Explorer 10 or above

Microsoft Edge

Mozilla Firefox

Google Chrome

SharePoint 2013

Operating System

| Microsoft Windows Server 2012 Standard or Datacenter X64 Microsoft Windows Server 2008 R2 SP1
---|---

Server

| Microsoft SharePoint Foundation 2013 or Microsoft SharePoint Server 2013 Microsoft .NET Framework 4.5

Browser

| Microsoft Internet Explorer 8 or above

Microsoft Edge

Mozilla Firefox

Google Chrome

Server Installation

Follow these steps to install Permission Report on your SharePoint servers.

Installation Preconditions

Before you start installing the product, please make sure these services are started on your SharePoint servers: SharePoint Administration and SharePoint Timer Service.

Permission Report must be run on one front-end Web server in the SharePoint farm where Microsoft SharePoint Foundation Web Application services are running. Check Central Administration → System Settings for a list of servers running this service.

Required Permissions
To perform this procedure, you must have specific permissions and rights.

Member of the local server’s Administrators group.
Member of the Farm Administrators group.

To install Permission Report on SharePoint server.

Download the zip file (*.zip) for Permission Report from the BoostSolutions website, then extract the file.
Open the created folder and run the Setup.exe file.
Note If you cannot run the setup file, please right click the Setup.exe file and choose Run as administrator.
A system check is performed to verify if your machine meets all the requirements for installing the product. After the system check is finished, click Next.
Review and accept the End-User License Agreement and click Next.
In the Web Application Deployment Targets, select the web applications you are going to install and click Next.
Note If you select Automatically activate features, the product features will be activated in the target site collection during the installation process. If you want to manually activate the product feature later, uncheck this box.
Upon completion of the installation, details are displayed showing which web applications Permission Report has been installed to. Click Close.

Upgrade
Download the latest version of Permission Report and run the Setup.exe file.
In the Program Maintenance window, select Upgrade and click Next.

Uninstallation
If you want to uninstall Permission Report, double-click the Setup.exe file.
In the Repair or Remove window, select Remove and click Next. Then the application will be removed.

Command_Line Installation
The following instructions are for installing the solution files for Permission Report using the SharePoint STSADM command line tool.
Required permissions
To use STSADM, you must be a member of the local Administrators group on the server.

To install Permission Report to SharePoint servers.

Extract the files from the product zip pack to a folder on one SharePoint server.
Open a command prompt and make sure your path is set with the SharePoint bin directory. C:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\16\BIN
Add the solution files to SharePoint in the STSADM command line tool.
stsadm -o add solution -filename BoostSolutions.PermissionReportSetup16.1.wsp stsadm -o addsolution -filename BoostSolutions.FoundationSetup16.1.wsp
Deploy the added solution with the following command:
stsadm -o deploy solution -name BoostSolutions.PermissionReportSetup16.1.wsp -allowgacdeployment –url [virtual server url] –immediate
stsadm -o deploysolution -name BoostSolutions.FoundationSetup16.1.wsp -allowgacdeployment –url [virtual server url] –immediate
Wait for the deployment to complete. Check the final status of the deployment with this command: stsadm -o displaysolution -name BoostSolutions.PermissionReportSetup16.1.wsp stsadm -o displaysolution -name BoostSolutions.FoundationSetup16.1.wsp
The result should contain a parameter for which the value is TRUE

Note:
After install product using command line, you can check whether the product is installed and deployed successfully in Central Administration.

On the Central Administration Home page, click System Settings.
In the Farm Management section, click Manage farm solutions.
On the Solution Management page, check whether the solution “boostsolutions.permissionreportsetup16.1.wsp” is deployed to the web applications.
On the Solution Properties page, click Deploy Solution.
On the Deploy Solution page, in the Deploy When section, select Now.
In the Deploy To? section, in the A specific web application list, click either All web applications or select a specific Web application.
Click OK.

To remove Permission Report from SharePoint servers.

Removal is initiated with the following command:
stsadm -o retractsolution -name BoostSolutions.PermissionReportSetup16.1.wsp -immediate -url [virtual server URL]
Wait for the removal to finish. To check the final status of the removal you can use the following command:
stsadm -o display solution -name BoostSolutions.PermissionReportSetup16.1.wsp
The result should contain the parameter for which the value is FALSE and the parameter with the RetractionSucceeded value.
Remove the solution from the SharePoint solutions storage:
stsadm -o deletesolution -name BoostSolutions.PermissionReportSetup16.1.wsp

Note:
After uninstalling the product using the command line, you can check whether the product is removed and successfully in Central Administration.

On the Central Administration Home page, click System Settings.
In the Farm Management section, click Manage farm solutions.
On the Solution Management page, click “boostsolutions.permissionreportsetup16.1.wsp”.
On the Solution Properties page, click Retract Solution.
On the Retract Solution page, in the Deploy When section, select Now.
In the Retract From section, in the A specific web application list, click All content web applications.
Click OK.
Wait a minute, and refresh the browser until you see “Not Deployed” as the status for “boostsolutions.permissionreportsetup16.1.wsp”.
Select “boost solutions.permissionreportsetup16.1.wsp”.
On the Solution Properties page, click Remove Solution.

To remove BoostSolutions Foundation from SharePoint servers.

The BoostSolutions Foundation is designed to provide a centralized interface to manage licenses for all BoostSolutions software from within SharePoint Central Administration. If are still using BoostSolutions product on your SharePoint server, DO NOT remove Foundation from the servers.

Removal is initiated with the following command:
stsadm -o retractsolution -name BoostSolutions.FoundationSetup16.1.wsp –immediate –url [virtual server URL]
Wait for the removal to finish. To check the final status of the removal you can use the following command:
stsadm -o displaysolution -name BoostSolutions.FoundationSetup16.1.wsp
The result should contain the parameter for which the value is FALSE and the parameter with the RetractionSucceeded value.
Remove the solution from the SharePoint solutions storage:
stsadm -o deletesolution -name BoostSolutions.FoundationSetup16.1.wsp

Feature Activation

By default, the application’s features are automatically activated once the product is installed. You can also activate the product feature manually.

Select Settings and then select Site Settings.
Under Site Collection Administration click Site collection features.
Find the application feature and click Activate. After a feature is activated, the Status column lists the feature as Active.

Generate Permission Reports

Entering the Permission Report page

Select Settings and then select Site Settings.
Under the Users and Permissions section, click Permission Report ( Powered by SharePoint Boost) to enter the product page.

Generate an Account Permission Report
This feature enables you to generate a permission report based on a specific SharePoint group or user. The report includes the accounts’ permissions on site and list level, but does not include permissions on item level.

On the Permission Report page, click Account Permission Report.
In the Account Name box, enter a user or group name and then click Run. A report will be generated.

The following icons represent an account’s permissions for sites or lists:

The account has inherited permissions in the specified scope.
The account has unique permissions in the specified scope.
The permission is inherited but this account does not have permissions in the specified scope.
The permission is unique but this account does not have permissions in the specified scope.
The permission is inherited, but the current logon user has insufficient permissions to check permissions.
The permission is unique, but the current logon user has insufficient permissions to check permissions.

To view the specified account’s permissions on other sites or lists, select a site or list from the Site Tree on the left.
Only 30 permission items are displayed per page. Click Previous or Next to view more items.
To modify a user’s permissions, click Manage to enter the permission settings page.

Generate a Permission Level Access Report

This feature enables you to check which users or groups have specified permission levels, for example, you can check which users have full control permission levels.
Note, this report only lists users or groups who are directly granted specific permissions, permissions inherited from SharePoint groups are not listed.

On the Permission Report page, click Permission Level Access Report.
Select a permission level from the drop-down list, which will contain all site collection permission levels.
Click Run to generate a report.
To view permission level access on other sites, select the site in the Site Tree.
To manage permissions, click Manage to enter the site or list permission settings page.

Generate a Permission Inheritance Report

This feature generates a permission hierarchy report of sites and lists. It enables you to view all contents permissions on one page without enter individual objects.

On the Permission Report page, click Permission Inheritance Report.
Select one type of permission inheritance, such as Unique, and click Run. There are three choices to help administrators generate a Permission Inheritance Report: Unique: Generates a report that only shows sites or lists where permissions are unique.
Inherited: Generates a report that only shows sites or lists where permissions are inherited.
All: Generates a report that shows all contents permissions, including unique and inherited.
To view permission inheritance in other sites, just select the site in the Site Tree.
To change the permission, click Manage.

Generate a SharePoint Group Report

To generate this report, click SharePoint Group Report.
In this report, administrators can locate additional SharePoint groups in other sites by selecting one on the Site Tree.

Only 20 group members will be shown for each group in the report. To view more members, click More … to enter a group’s page.

Generate a Site or List Permission Report

On the Permission Report page, click Site or List Permission Report.
Open the Scope drop-down list, select a site or list and then click Run.
The site or list permission report will then be generated.
In the report, a Permission Level filter is provided to filter the site or list permission report. These permission levels are pulled from the site collection. To filter a report, just select the desired permission level.
Additionally, administrators can enter the site or list permissions settings page by clicking Manage Permissions.

Export a Report

The Export function saves reports as an excel file. After a report is generated, the Export function becomes available.
To export reports, click the Export button on the ribbon menu. In the popup window, administrators can then save the report to a location of their choosing.

Contact Us

Troubleshooting FAQ:
https://www.boostsolutions.com/general-faq.html#Show=ChildTitle9
Contact Info:
Product & Licensing Inquires: [email protected]
Technical Support (Basic): [email protected]
Request a New Product or Feature: [email protected]

Appendix 1: License Management

You can use Permission Report without entering any license code for a period of 30 days from when you first use it.
To use product without limitation, you will need to purchase a license and register the product.

Finding License Information

In the products main page, click the trial link and enter the License Management Center.
Click Download License Information, choose a license type and download the information (Server Code, Farm ID or Site Collection ID). In order for BoostSolutions to create a license for you, you MUST send us your SharePoint environment identifier (Note: different license types need different information). A server license needs a server code; a Farm license needs a farm ID; and a site collection license needs a site collection ID.
Send the above information to us ([email protected]) to generate a license code.

When you receive a product license code, enter the License Management Center page.
Click Register on the license page and a Register or Update license window will open.
Upload the license file or enter the license code and click Register. You will get confirmation that your license has been validated. ss For more details on license management, see the BoostSolutions Foundation.