SPDocKit
Try it for FreeContact UsProduct Site
  • SPDocKit by Syskit
  • Release Notes
    • SPDocKit 12
    • SPDocKit 11.1.0
    • SPDocKit 11
    • SPDocKit 10
    • SPDocKit 9.1.0
    • SPDocKit 9
    • SPDocKit 8.0.3
    • SPDocKit 8
  • Requirements
    • SharePoint On-Premises User Permissions Requirements
    • Supported SharePoint Editions
    • System Requirements
    • Server Load Permission Requirements
    • Service Application Permission Requirements
  • Installation
    • Install SPDocKit
    • Upgrade to the Latest Version
    • Uninstall SPDocKit
  • Activation
    • Activate SPDocKit
    • Manage License
    • Activation Privacy Statement
  • Configuration
    • Configure SPDocKit
    • Configure SPDocKit Database
    • Import and Export SPDocKit Settings
  • Create SharePoint Farm Snapshots
    • Snapshots Screen
    • Manual Snapshots
    • Automatic Snapshots
  • Explore Reports & Create Documentation
    • Farm Explorer
      • Farm Explorer Screen
      • Farm Dashboard
      • Farm Explorer Reports
      • Farm Documentation
      • Passwords and Product keys
      • Generate an AutoSPInstaller XML Configuration File
      • Change the Limit on Site Topology Report
    • Site Explorer
      • Site Explorer Screen
    • Permission Reports
      • Permissions Reports screen
    • Analytics and Usage Reports
      • Analytics and Usage Reports Screen
      • Analytics Dashboard
      • Site Collection Analytics
      • Document Extensions Reports
    • Audit Reports
      • Audit Reports Screen
      • Audit Dashboard
      • Audit Log Details
      • Administrative Actions
      • Audit Settings
    • Best Practices
      • Best Practices Screen
      • Best Practices Reports
    • Subscriptions and Alerts
      • Subscriptions and Alerts
      • Create New Subscription
      • Create New Alert
    • Customizing Reports
      • Customize View
      • Add Comments
  • Compare SharePoint Configurations
    • Compare Wizard
    • Compare SharePoint Farms
    • Compare Servers
    • Compare Web Applications
    • Compare Site Collections
    • Compare SharePoint Permissions
    • Compare Web.Config Files
  • Manage SharePoint Permissions
    • Permissions Explorer Screen
    • Manage Permissions Ribbon Actions
    • Users and Groups Actions
      • Manage Groups Wizard
      • Group Memberships Wizard
      • Copy Permissions Wizard
      • Move Permissions Wizard
      • Manage Permissions Wizard
      • Remove Permissions Wizard
    • Securable Objects Actions
      • Break/Restore Permission Inheritance Wizard
      • Restore Permissions
      • Copy Object Permissions Wizard
    • Site Collection Actions
      • Site Collection Administrators Wizard
      • Permission Levels Wizard
      • Clean Site Collections Wizard
    • Add Tags
    • SPDocKit Permission Management Event Log
  • Configure & Extend SPDocKit
    • Backstage Screen
    • Options Wizard
    • License Management
    • Role Based Security
    • Extend SPDocKit
      • Install SPDocKit Extensions
      • Download SPDocKit Extensions
      • Activate SPCAF Extension
  • Query & Change SharePoint Settings
    • Queries and Rules Screen
    • Create SharePoint Governance Policy Rule
    • Create SPDocKit Query
    • Change SPDocKit Query Results Limit
    • Create Audit Queries and Rules
  • FAQ
    • Requirements
    • Installation
    • Activation
    • Configuration
    • Features
    • Security
    • Miscellaneous
    • SPDocKit Insights Removed
    • SPDocKit Insights Migration
  • Known Issues
    • CREATE TABLE permissions denied
    • Custom features missing in reports
    • Data retention not working properly
    • Distributed Cache loading issue
    • Load crashes with NullReference exception
    • Available Windows updates
    • Permissions Wizard issue
    • PowerPivot FileNotFoundException issue
    • SQL Clusters support
    • Storage Metrics report subscription
    • Unaccounted differences in the UPA settings
    • Custom Query issue with URL export
    • Recursive groups issue with export
  • Troubleshooting
    • SharePoint
      • Could not access content database
      • The service application ‘UPA Name’ does not have any proxies that are default in a proxy group
    • Server Load & User Permissions
      • RPC Server is Unavailable
      • Error occurred while loading Web Application
      • Error occurred while trying to load 'Problems and Solutions' and 'Rule Definitions'
      • Error while loading IIS Settings Information
      • Errors while trying to load the SharePoint farm
      • Errors while loading server information
      • Failed at retrieving SQL Accounts from the following servers
      • My permissions loading status is reported as ”Failed”
      • Service was unable to read Active Directory properties
      • SQL Server is unavailable
      • Error adding service account to "spdockit_service_role" database role
    • SQL Server Connection
      • SPDocKit won’t connect to a provided server and database
      • Configure SQL server to listen on a specific port
      • Is SQL Server configured to use a named instance
      • Inbound traffic on TCP Port 1433 needs to be allowed on the SQL
      • Service user does not have rights to connect to the SQL server
      • TCP/IP network traffic not enabled on the SQL Server
Powered by GitBook
On this page
  • SharePoint Server Information
  • Required permissions
  • Granting permissions
  • SQL Server Information
  • Required permissions
  • Granting permissions
  • Project Server Information
  • Required Permissions
  • Granting permissions

Was this helpful?

  1. Requirements

Server Load Permission Requirements

This article lists all permissions necessary for SPDocKit to gather information about SharePoint farm servers.

SharePoint Server Information

During the Snapshot creation process, SPDocKit will try to retrieve information about your servers.

Please note! The following permissions on your servers are optional, but depending on them some or all information about your server configuration and the corresponding best practices reports will not be available in SPDocKit.

Required permissions

In order to allow SPDocKit to successfully gather all the information about your SharePoint farm servers, the following permissions are necessary:

  • Local Administrator on the server

  • Windows Update service up and running

Granting permissions

To add the SPDocKit user to the Local Administrator group follow these steps:

  1. On the server open the Local Users and Groups management console. Find it by typing "Edit local users and groups" or "lusrmgr.msc" in Windows Search.

  2. Under Groups find the Administrators group.

  3. Click the Add button and enter the user accounts running SPDocKit.

  4. Confirm your changes by clicking OK.

In case you have a very strict security policy and cannot add this account to the Local Administrators group, you can use the following procedure to get most of the reports working:

  • Add your SPDocKit accounts to the following local groups: Backup Operators and Performance Log Users. This will allow us to remotely execute WMI queries and get information about SQL servers.

  • Start winmgmt.msc, right click on WMI Control and select Properties.

  • Go to the Security tab and expand Root node. In the expanded list select cimv2 and click on the Security button.

  • Click on Advanced button, then click Add… and enter the desired user and click OK.

  • Select option This namespace and subnamespaces in a dropdown list Apply to.

  • Make sure that you select Enable Account and Remote Enable on the Allow list and then click OK four times.

To start the Windows Update service, open the Service Microsoft Management Console, right click on the service and choose Start.

SQL Server Information

There are some additional SPDocKit permission requirements necessary to load SQL servers information.

Please note! The following permissions on your SQL servers are optional, but depending on them, some or all information about your SQL server configuration and the corresponding Best Practices reports will not be available in SPDocKit.

Required permissions

In order to allow SPDocKit to successfully gather all the information about your SQL servers the following permissions are necessary:

  • Sysadmin server role

In case that you can’t give those permissions due to security requirements, you can use the following permissions to get most of the SQL specific reports working:

  • Public server role

  • Dbcreator server role and VIEW SERVER STATE permission

  • Dbaccess permission on model database

  • Db_owner database role on each of the affected databases

Granting permissions

Follow these steps to grant required permissions:

  1. Create a new user on the SQL server that will be used by SPDocKit.

  2. Add the sysadmin role to your SPDocKit account.

In case you have a very strict security policy and cannot add the sysadmin role to the SPDocKit account, you can use the following procedure to get most of the SQL reports working:

  1. Create a new user on the SQL server that will be used by SPDocKit.

  2. Add the dbcreator role to your SPDocKit account and execute the following T-SQL query:

       USE master  
       GO  
       GRANT VIEW SERVER STATE TO “DOMAIN\ACCOUNT”
  3. Execute following T-SQL query to add necessary permissions:

       USE model  
       GO  
       EXECUTE sp_grantdbaccess 'DOMAIN\ACCOUNT'

To grant the db_owner database role to the SPDocKit accounts, follow these steps:

  1. Connect to your SQL server using SQL Server Management Studio.

  2. Navigate to Security > Logins and select the SPDocKit account.

  3. Right click on the account and open the Login Properties dialog.

  4. Under User Mappings, make sure that the account has the db_owner database role for all affected databases.

Project Server Information

During the snapshot creation process, SPDocKit will try to retrieve information about your Project server sites.

Please note! The following permissions on your Project server sites are optional, but depending on them some or all information about your Project server sites configuration reports will not be available in SPDocKit.

Required Permissions

In order to allow SPDocKit to successfully gather all the information about your Project server sites the following permissions are necessary:

  • SPDocKit account needs to be a member of the Project Server Administrators group on each of the Project server sites

Granting permissions

To add your SPDocKit account to the Administrators group, follow these steps:

  1. In a browser navigate to your Project server site.

  2. Click Settings > PWA Settings to open up the PWA Settings page.

  3. Under Security click Manage Users.

  4. Click New User and add your SPDocKit user accounts (console account and the service account, if you are using automatic snapshots).

    • Under User logon account specify the Domain\Username of the SPDocKit user account.

    • Under Security Groups make sure that this user is a member of the Administrators security group.

PreviousSystem RequirementsNextService Application Permission Requirements

Last updated 2 years ago

Was this helpful?