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

Was this helpful?

  1. Query & Change SharePoint Settings

Create SPDocKit Query

This article describes how to use the SPDocKit Query wizard to create a query report.

PreviousCreate SharePoint Governance Policy RuleNextChange SPDocKit Query Results Limit

Last updated 2 years ago

Was this helpful?

This section describes how to use the SPDocKit Query wizard to create a query report. We will now create a query that will provide you with a list of all checked-out documents on a selected scope.

  1. Go to Queries & Rules and click New Query from the Home ribbon.

  2. Type in the name of your query and select a query scope. The query scope defines the type of SharePoint objects that will be crawled for their properties in this report. Click Next to continue.

  3. Select the list fields you would like to include in this report. Read more about . Click Next to continue.

  4. Use the Up and Down arrows to choose and modify the order and sorting type. Click Next to continue.

  5. Choose whether you would like to manually execute this query or automatically execute it. Click Next to continue.

    • Manual execution – you will have to run this query from the Home ribbon using the Run button every time you want to check whether there are any changes.

    • Automatic execution – requires an active SPDocKit Service and a .

    If the SPDocKit Service is not running, a warning bar will appear. Click Configure to enable the SPDocKit Service.

  6. Under Filters select the Checked Out To list property, click the underlined value “specific” and choose the Is Not Empty condition. Click Next to continue.

  7. Define the query targets. Depending on your selected query scope in the first step of this wizard, you can target an entire web application, specific site collections, subsites, or lists and list items. Each time the query is executed, it will list all files that are currently checked out to someone on the specified scope.

    If you have chosen the manual execution in the previous steps, you can skip this step – select the Skip target selection; ask me on execution check box. You will be able to choose the desired scope each time you start the query. Click Finish to run your query.

    It is also possible to send the query results to specified email addresses in one of the three available formats: XLSX, DOCX, PDF. This will be sent for both manual and automatic execution, each time a query is executed.

  8. Run this query right away or wait for the scheduled time for the query to run automatically, after which you can explore the results. Each time you or the SPDocKit Service executes a query definition, a history record is created. Click on the desired record and explore the query results by date.

Tips & tricks

SPDocKit comes with a couple of predefined manual queries grouped into two folders.

The Samples folder contains following queries: Checked Out Files, Document Libraries Without Check Out, and Document Libraries Without Versioning.

The Audit Settings folder contains following queries: Audit Log Trimming, Documents and Items, and Lists, Libraries, and Sites.

If you wish to run them, you will just be required to select a query scope. Also, you can edit the query definitions to better suit your needs.

To learn more about the Audit settings queries, please check out the .

supported query properties
defined schedule
following article