Metalogix ControlPoint 8.5 - User Guide

Analyzing Site Activity

The Site Activity Analysis provides activity statistics for one or more selected sites, including the distribution of activity among sites within the scope of your analysis.  You can report daily activity, which uses data from the SharePoint Usage database, and for SharePoint 2013 and later, you can report monthly activity.

To generate a Site Activity Analysis:

1Select the object(s) for which you want to analyze site activity.

2Choose Activity > Site Activity Analysis.

3Select either Show Daily Activity or Show Cumulative Monthly Activity.

4Specify additional parameters for your analysis.

Note that, in addition to the "standard" parameters, Number of Top Sites to show in Graph must be specified.  The value in this field (which is 10 by default, but may be changed) represents the number of pages with the most activity that you want to compare graphically (in the form of a pie chart).

The Site Activity Analysis displays the following sections:

·site collections and sites

·Activity Distribution

Site Collections and Sites Section

The site collections and sites section lists the sites within the scope of your analysis, along with the following statistics for the specified day or time period:

·each site and subsite within the scope of your selection

·the site URL

·the Avg. Unique Users/Day

·total Requests (for daily activity) or cumulative Hits (for monthly activity)

·the date or month when the site was Last Accessed.

NOTE:  For Daily activity, the Last Accessed date shows the last day the site was accessed within the date range covered by the analysis.  For Monthly activity, the Last Accessed date shows the last month the site was accessed—as far back as the earliest month in the SharePoint Search Services database—regardless of the date range covered by the analysis.

Note that the indentation of each site and subsite within a site collection reflect the appropriate hierarchical level.

Activity Distribution Section

The Activity Distribution section consists of a pie chart that depicts the distribution of activity among sites within the scope of your analysis.

NOTE:  If the analysis encompasses only one site, the pie chart will appear solid.

Analyzing Activity by User

The Activity by User analysis lets you examine SharePoint pages and documents requested by one or more users.

You can analyze activity over the past 30 days.  

You can analyze activity beyond 30 days for SharePoint 2010 Server farms, as long as the Web Analytics Service is used by the Web Application.

You can also use this analysis to identify only files that are currently checked out.

Note About "Common" File Names

Lists of "common file names" and "common file extensions" are maintained in XML file ActivityByUserOrDoc_ExcludedFileNames_2010.xml located on the Web front-end server where ControlPoint is installed, in the following SharePoint hive subdirectory: \TEMPLATE\LAYOUTS\Axceler\App_Data.  

The purpose of this list is to give you the option of either including or excluding frequently used files from analysis results.  You can customize the XML files to include file names specific to your environment.  For example, you may want to filter out image files used on many pages that do not reflect actual patterns of user activity.  You can also remove any of the default file names provided by Metalogix.  

NOTE:  Names in this file will populate the Exclude File Names parameter.  By default, this file includes SharePoint internal files.  When you specify the parameters for your analysis, you can exclude some or all of the file names in this list.

IMPORTANT:  Changes that you make to these files must be copied to any additional Web front-end servers in your farm.  Also, whenever you install a ControlPoint update or patch, these files are overwritten with files containing the default lists.  Therefore, if you choose to make modifications, it is recommended that you keep a backup of the file in a different location so that you can replace the default version after an update or patch.

To generate an Activity by User analysis:

1Select the object(s) on which you want to perform the analysis.

2Choose Activity > Activity by User.

3Specify the parameters for your analysis.

In addition to "standard" parameters (and the ability to exclude files, as described above), you can choose to have analysis results display information about Checked-out documents only.  Results will include documents that were checked out between the specified start and end date, but have not been checked back in as of the analysis run date.  If you select this option and also check Include Documents with no checked-in version, only documents that have never been checked in (which may happen, for example, if a document was uploaded but a value was not provided for a required property).

NOTE:  If you accept the default (All Activity), the Include Documents with no checked-in version checkbox will always be ignored.

Now you can:

·run the operation immediately (by clicking the [Run Now] button)

OR

·schedule the operation to run at a later time or on a recurring basis.

OR

·save the operation as XML Instructions that can be run at a later time.

Analyzing Activity by Document

The Activity by Document analysis lets you examine request detail for each document or page within a selected scope.

You can analyze activity for all SharePoint farms over the past 30 days.  

You can analyze activity beyond 30 days for SharePoint 2010 Server farms, as long as the Web Analytics Service is used by the Web Application.

You can also use this analysis to identify only files that are currently checked out.  (If you want to identify all currently-checked out documents, regardless of date range, use the Checked Out Documents analysis.)

Note About "Common" File Names

Lists of "common file names" and "common file extensions" are maintained in XML file ActivityByUserOrDoc_ExcludedFileNames_2010.xml located on the Web front-end server where ControlPoint is installed, in the following SharePoint hive subdirectory: \TEMPLATE\LAYOUTS\Axceler\App_Data.  

The purpose of this list is to give you the option of either including or excluding frequently used files from analysis results.  You can customize the XML files to include file names specific to your environment.  For example, you may want to filter out image files used on many pages that do not reflect actual patterns of user activity.  You can also remove any of the default file names provided by Metalogix.  

NOTE:  Names in this file will populate the Exclude File Names parameter.  By default, this file includes SharePoint internal files.  When you specify the parameters for your analysis, you can exclude some or all of the file names in this list.

IMPORTANT:  Changes that you make to these files must be copied to any additional Web front-end servers in your farm.  Also, whenever you install a ControlPoint update or patch, these files are overwritten with files containing the default lists.  Therefore, if you choose to make modifications, it is recommended that you keep a backup of the file in a different location so that you can replace the default version after an update or patch.

To generate an Activity by Document analysis:

1Select the object(s) on which you want to perform the analysis.

2Choose Activity > Activity by Document.

3Specify the parameters for your analysis.

In addition to "standard" parameters (and the ability to exclude files, as described above), you can choose to have analysis results display information about Checked-out documents only.  Results will include documents that were checked out between the specified start and end date, but have not been checked back in as of the analysis run date.  If you select this option and also check Include Documents with no checked-in version, documents for which no checked version exists (which may happen, for example, if a document was uploaded but a value was not provided for a required property) will also be included and will be flagged.

NOTE:  If you accept the default (All Activity), the Include Documents with no checked-in version checkbox will always be ignored.

Now you can:

·run the operation immediately (by clicking the [Run Now] button)

OR

·schedule the operation to run at a later time or on a recurring basis.

OR

·save the operation as XML Instructions that can be run at a later time.

Identifying Checked Out Documents

The Checked Out Documents analysis lets you identify all files that are currently checked out of SharePoint for a selected scope.

NOTE:  If you want to identify only those files that have been checked out over a given date range, use the Activity by Document analysis.

Note About "Common" File Names

Lists of "common file names" and "common file extensions" are maintained in XML file ActivityByUserOrDoc_ExcludedFileNames_2010.xml located on the Web front-end server where ControlPoint is installed, in the following SharePoint hive subdirectory: \TEMPLATE\LAYOUTS\Axceler\App_Data.  

The purpose of this list is to give you the option of either including or excluding frequently used files from analysis results.  You can customize the XML files to include file names specific to your environment.  For example, you may want to filter out image files used on many pages that do not reflect actual patterns of user activity.  You can also remove any of the default file names provided by Metalogix.  

NOTE:  Names in this file will populate the Exclude File Names parameter.  By default, this file includes SharePoint internal files.  When you specify the parameters for your analysis, you can exclude some or all of the file names in this list.

IMPORTANT:  Changes that you make to these files must be copied to any additional Web front-end servers in your farm.  Also, whenever you install a ControlPoint update or patch, these files are overwritten with files containing the default lists.  Therefore, if you choose to make modifications, it is recommended that you keep a backup of the file in a different location so that you can replace the default version after an update or patch.

To generate a Checked Out Documents analysis:

1Select the object(s) on which you want to perform the analysis.

2Choose Activity > Checked Out Documents.

3Specify the parameters for your analysis.

In addition to "standard" parameters (and the ability to exclude files, as described above), you can choose to Include Documents with no checked-in version. When this box is checked, documents for which a checked-in version does not exist (which may happen, for example, if a document was uploaded but a value was not provided for a required property) will also be included in results and will be flagged.

Now you can:

·run the operation immediately (by clicking the [Run Now] button)

OR

·schedule the operation to run at a later time or on a recurring basis.

OR

·save the operation as XML Instructions that can be run at a later time.

For each user who has checked out documents, analysis results display the following information for each:

·the Document Name (with a link to the ControlPoint Audit Log analysis for the specified date)

NOTE:  If SharePoint auditing is not enabled for the check in/check out event, the Audit Log analysis will show No Results to Display.

·the URL to the document within the library

·the date and time that the document has been Checked Out Since

·the Last Modified Time

If you chose to Include Documents with no checked-in version, documents that meet that criteria (if any) will also be included in analysis results, flagged by the symbols ###.