Options Wizard

This article explains how to use the Options wizard to adjust and change your SPDocKit settings.

SPDocKit Subscriptions and Alerts

Here you can change the startup options:
  • whether to load last saved farm settings file on SPDocKit startup or not.
  • enable Verbose logging – use this only for diagnostics purposes or when asked by the support team
  • modify how many site collections will be shown in the Site Topology report
  • modify the maximum number of principals that will be used to generate data for in throttled reports
  • modify the maximum number of site collections that will be used to generate data for in throttled reports
  • modify the maximum number of query results per site collection
  • turn on automatic update check
  • change skin
  • adjust proxy settings

SPDocKit-6.3 Options - General

Allows you to customize how documents are saved. Tags used while constructing the header and footer are: CompanyName, Logo, AppName, Date, Page, TotalPages and Server.

By using the | separator the location of each tag can be specified i.e. if it is set {CompanyName}||{Logo} for the header, the company name will appear in the upper left corner of the page, the upper center will be blank and the upper right corner of the page will contain the logo (if uploaded).

The default footer is set to Generated by {AppName} on {Date}|Page {Page}/{TotalPages} i.e. application name and the date of report export will appear in the lower left corner of the page, the lower center will be blank and the lower right corner of the page will contain the number of the page currently opened and total page number.

SPDocKit-6.3 Options - Save

This section allows you to configure SPDocKit Service running period and the default snapshot location.

You can choose whether to save snapshots directly to the SPDocKit database or to the preferred disk location or even both.

The time you set here is the time when the Service will start taking an automatic snapshot and collecting the data you defined in the Snapshot Options and Load Target tab of the Options Wizard. A Minimal period is every four hours. The SPDocKit service will start executing defined task at the selected time and it will be repeated a selected number of days or hours (default value: 1 day). You can also define period value, i.e. intervals in which Service runs depending on the period type.

Enabling the automatic index reorganization will result in better SPDocKit database space usage and performance when generating the reports. This job will be run outside the business hours (around 5 AM).

SPDocKit 6.2 Service Settings

This section allows you to choose what will be loaded by both SPDocKit Service when taking an automatic snapshot and if you select the Default mode in the Take Snapshot Wizard. Available options are: Personal Sites, Installed Programs and Available Updates, SQL Server Information, Features and Solutions, Backup and Analyze Solution Files, Permissions, Active Directory Group Members, Content Types and Workflows.

Farm settings will be loaded by default and they cannot be excluded when taking a snapshot.

You can also specify the load depth, which means how deep  down you want to crawl your SharePoint with SPDocKit. Possible choices are: site collection. subsites, list and list items. Be aware that there are some dependencies related to the load depth selection and the available SharePoint information SPDocKit can retrieve. For example, if you want to load Content Types and Workflows, lists are the minimum required load depth. SPDocKit will warn you if your current selection is not possible and provide instruction message how to enable certain load option.

SPDocKit also allows you to backup all *.wsp files in use by your farm, but you’ll need to define a location for this backup. This data can also be used later on to find out if there are any problems with the assemblies deployed on your farm.

Finally, you can customize the snapshots name template. Under Snapshot Configuration, note the Snapshot Name Template. By default, we enabled Farm Name, Snapshot Mode (which can be Automatic or Auto) and Date which you can customize any way you like. By default it is: “Date:yyyy_MM_dd_HH_mm_ss”. You can change the format by rearranging the item order and delimiter type. You can observe this name if you go to Snapshots tab and include File Name column using the View ribbon button called Choose Columns.

To reduce the farm loading time we recommend not to check in the Personal Sites. You can also use load performance slider to switch between low resource usage load to a high-performance load.

SPDocKit-6.3 Options - Snapshot Options

This section allows you to customize how SPDocKit crawls your SharePoint farm. If you want to reduce the loading time and know exactly what data you are interested in, you can narrow down your loading scope to a specific web application, site collection or even subsite. If you want to be sure you’ve loaded all the data, farm is the recommended scope.

The selection you make here applies both for the SPDocKit Service taking an automatic snapshot and when using the Default mode in the Take Snapshot Wizard.

SPDocKit-6.3 Options - Load Target

This tab was removed in version 6.2, since the Monitoring feature has been completely redesigned. If you would like to track your farms’ health and explore SharePoint ULS and Windows event viewer logs, configure the SPDocKit Event Collection feature. Learn more about SPDocKit Event Viewer and how it can help you address all possible issues in your farm.

In this section, the user can set how long the database data will be kept for. After the configured time period elapses, all of the data records from SPDocKit database and disk location older than the configured time period will be deleted. The default time period for storing the data records is 6 months. SPDocKit service will execute this job every day at the random time between 1:30AM and 5AM.

Set the preferred database size and SPDocKit will warn you when database size passes the defined threshold.

If your SPDocKit database becomes too big, you can force manual data retention using Execute button. Please note that this action will also try to execute SHRINKDATABASE command on you SPDocKit database, which will fail unless you have the necessary permissions – member of the sysadmin or db_owner role by default. Specified data will still be deleted but database size will not reduce until this command is executed, using SPDocKit or directly on SQL server.

Please note that there is an option to “Mark Configuration as Good”. Meaning that you can mark a certain snapshot and it will be excluded from data retention policy. For more information on this go here.

SPDocKit 6.2 Data Retention Options

If you wish to use Subscriptions and Alerts feature feature, check in Subscriptions Enabled box. Configure job execution time and on which day will the weekly reports be sent on. Time of the day to send subscriptions option determines at which time will daily, weekly, monthly, and quarterly subscription be sent, while Send weekly subscriptions option on dictates the day at which weekly subscriptions will be sent.  

To enable email as a preferred delivery method, configure outgoing email server settings. After the outgoing email server settings are provided, you can test if these are valid by clicking theTest Email Settingsbutton. There is also an option to customize the email footer and email body text. 

Read more about scheduling subscriptions and alerts.

SPDocKit 6.2. Subscription Settings

Email Settings configuration has been relocated to the Subscription Settings tab in SPDocKit 6.2.0.

Email Alerts feature has been redesigned in SPDocKit 6.2.0. Please note! Email alerts created with SPDocKit versions older than 6.2.0 will not be preserved when upgrading to the version 6.2.0. You will have to create new alerts. In order to create an alert containing the Farm Documentation, Farm Differences, and Best Practices Documentation reports, please follow these instructions.

  1. Enable automatic subscriptions in the Subscription Settings tab.
  2. Create new alert containing the Farm Documentation, Farm Differences and Best Practices Documentation reports.
  3. When adding a Farm Differences report, you will be prompted to enter source and destination farm (in case there are multiple farms in your SPDocKit database). Source Farm will already be set to Farm you picked in the General tab. If you want to compare a current and previous state of your farm, in both Source and Target filter must be the same farm. If you wish to compare differences for two different farms, change the Target filter accordingly.
  4. Please note that alerts are sent only after a service takes a snapshot but only if there are differences detected. If you would like to receive these reports even if there are no differences detected, please create subscription instead of an alert in step 2.
  5. When done click Save & Close.

This section allows  you to define which farm settings should be compared in the Compare Wizard. The selection you make here will be used as a default template when comparing two farms, but you can modify it directly in the Compare Wizard each time you use it.

SPDocKit-6.3 Options - Compare