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
  • Enable Role Based Security
  • Admin role
  • Viewer role
  • Manage Roles
  • Create a new role
  • Edit an existing role
  • Delete an existing role
  • Manage Users

Was this helpful?

  1. Configure & Extend SPDocKit

Role Based Security

This article describes how to use Role Based Security feature in SPDocKit to grant different permission levels to SPDocKit end users.

This advanced security feature is meant to help admins take control and allow them to define different SPDocKit access levels. Users and groups can be assigned to specific roles based on elements of SPDocKit or on SharePoint site collection permissions.

Enable Role Based Security

To enable this feature, navigate to the Backstage Configuration Screen, click Role Based Security, and select the Enable role based security check box. Click Save to apply this change.

Please note! The user who enables this feature will automatically be assigned to the Admin role. For role based security to work, you have to use a database and have the securityadmin and db_owner permissions.

Admin role

This role gives you full control over SPDocKit, as well as over the entire role based security system. As an admin you can create new custom roles, and assign users or groups to them or to one of our predefined roles (Admin and Viewer).

Please note! The first person who activates the RBS (role based security) will be automatically given the admin role.

Viewer role

The Viewer role is predefined, along with the Admin role. This is a read-only role, and some reports are unavailable to members of this role due to security reasons.

Please note! With the Viewer role, you cannot see certain reports, like the Web.config files, Storage Metrics, All Farm Users, Users with Privileged Access, and the entire Passwords and Product Keys section in the Farm Explorer. You also cannot create a new view for a report.

Manage Roles

This section describes how to manage SPDocKit roles.

Create a new role

To create a new role, follow these instructions:

  1. Navigate to the Backstage Configuration Screen and click Manage Roles.

  2. Click Add Role.

  3. The SPDocKit Role Wizard will open. Under General, type in the name of the role and add a description. Click Next to continue.

  4. If you wish a user to see and access the Farm Explorer and Best Practices, under Snapshots, select the Allow access to Farm Explorer and Best Practices report categories check box.

Please note! The Farm Explorer reports may contain sensitive information such as passwords and other important SharePoint settings.

  1. Under Report Categories define the report categories to which the SPDocKit user will have access. You can also fine-tune which SharePoint objects will be visible on these report categories. You can choose to give permissions and access:

  2. to all objects (reports will show data from all farms),

  3. based on SharePoint permissions (users will only see data from the Site Collections for which they are members of the Site Administrators group), and/or

  4. to the selected site collections (reports will show data for explicitly defined site collections).

Please note! If you choose only certain Site Collections, the user will still need to be a Site Administrator to view the specific Site Collection.

Bear in mind that these settings differ from the ones in a previous screen. The farms you choose there only apply to the Farm Explorer and Best Practices. Permissions you can manage here are Site Explorer, Permission Explorer, Permission Reports, and Content and Usage Reports. They directly correspond to the same tabs in SPDocKit. Click Next to continue.

  1. Add users to this new role. Click Next to create your role and exit the Role Wizard.

Edit an existing role

To edit an existing role, follow these instructions:

  1. Navigate to the Backstage Configuration Screen

  2. Click Manage Roles

  3. Select the role you wish to edit, and then click Edit.

Delete an existing role

  1. Navigate to the Backstage Configuration Screen

  2. Click Manage Roles

  3. Select the role you wish to edit, and then click Delete.

Manage Users

This section explains how to add principals and manage users.

  1. Navigate to the Backstage Configuration Screen, and click Manage Users.

  2. To add a new user, click Add Users.

    Enter user names or search to add them as principals and assign them a certain role. Click Assign to finish and save your changes.

  3. To edit or delete a user use the corresponding buttons in the toolbar.

Please note! For convenience we provide an option to delete the SQL login of the selected user as part of deleting the user from the SPDocKit database.

If the selected user is using a database other than the SPDocKit on a given server, you shouldn’t try to delete its SQL login. However, if the SPDocKit database is the only one the selected user is using, you can completely remove his or her logon rights

PreviousLicense ManagementNextExtend SPDocKit

Last updated 2 years ago

Was this helpful?

In the Farms subsection you must choose which farm(s) you wish to enable the aforementioned permissions for. Click to learn more about using the same database with more than one farm. Click Next to continue.

here