Dell Site Admin for SharePoint - User Guide

Document technical information

Format pdf
Size 2.3 MB
First found May 22, 2018

Document content analysis

Category Also themed
Language
English
Type
not defined
Concepts
no text concepts found

Persons

Organizations

Places

Transcript

Dell™ Site Administrator for
SharePoint® 5.2.3
User Guide
©
2015 Dell Inc. All rights reserved.
This product is protected by U.S. and international copyright and intellectual property laws. Dell™ and the
Dell logo are trademarks of Dell Inc. in the United States and/or other jurisdictions. All other marks and names
mentioned herein may be trademarks of their respective companies.
Legend
CAUTION: A CAUTION icon indicates potential damage to hardware or loss of data if instructions
are not followed.
WARNING: A WARNING icon indicates a potential for property damage, personal injury, or death.
IMPORTANT, NOTE, TIP, MOBILE, or VIDEO:An information icon indicates supporting information.
Site Administrator for SharePoint User Guide
Updated - September 2015
Software Version - 5.2.3
Contents
General Information
9
About Site Administrator for SharePoint
9
Key Features
9
Discovery and Reporting
10
Prepare Before You Migrate
10
Comprehensive Security Control
10
Operational Auditing
10
Growth Forecasting and Management
10
Deploying Site Administrator for SharePoint
11
System Requirements
11
Port Requirements
12
Required Permissions
12
Adding Farms
14
Setting Required Permissions
15
Setting Permissions on SQL Databases
15
Granting SharePoint Permissions
18
Granting Local Administrator Right
18
Installation Procedure
19
Installing Site Administrator for SharePoint
19
Configuring Web Application Port
20
Installing Site Administrator for SharePoint - Security Explorer
20
Uninstalling Site Administrator for SharePoint
21
Uninstalling Management Console
21
Upgrading Site Administrator
21
Working with Site Administrator for SharePoint
23
Getting Started
23
Adding SharePoint Farms
23
Adding SharePoint Server with Configured SQL Aliases
24
Information Portal Levels of Access
25
Sign In Under Different User Account
26
Search
26
SharePoint Online
26
Sign in
26
Build-in Domain Accounts
26
Federated Domain Accounts
27
Site Administrator for SharePoint 5.2.3 User Guide
3
Reporting
27
Dashboards
28
Viewing Dashboards
28
Dashboard Descriptions
28
Reports
34
Viewing Reports
34
Report Descriptions
34
IT Infrastructure Reports
35
Content Management Reports
42
Security Reports
49
Activity Reports
52
Exporting Reports
57
Scheduling Report Export to CSV/SQL
59
Managing SharePoint
62
Managing Security
62
Managing User Permissions
62
Applying Security Settingss
64
Restructuring SharePoint Content
64
Copying Sites
65
Copying Lists
65
Configuring Version Settings for Document Libraries
65
Policies
67
How it works:
67
Site Administrator Settings
67
Access Settings
67
Report Settings
68
Action and Policy Settings
68
File Filter Settings
68
License
68
How It Works
68
Agent and Broker Web Services
68
Information Portal Front-End
69
Collecting and Showing Report Data
69
Collecting Grid Report Data
69
Site Administrator for SharePoint – Security Explorer
71
Managing Objects
71
Managing Your SharePoint
72
Working with SharePoint Web Service
72
Modifying SharePoint Authentication
73
Site Administrator for SharePoint 5.2.3 User Guide
4
Managing SharePoint Groups
73
Modifying SharePoint Properties
73
Previewing SharePoint Objects
73
Managing SharePoint Permissions
74
Viewing SharePoint Permissions
74
Granting Permissions
75
Cloning Permissions
77
Modifying Permissions
78
Modifying SharePoint Permissions Levels
79
Deleting Permissions
80
Backing Up Permissions
80
Using the Backup Scheduler
81
Restoring Permissions
81
Exporting Permissions
81
Managing Favorites
82
Adding Favorites While Browsing
82
Adding Favorites
83
Removing Favorites
83
Managing Enterprise Scope
84
Creating an Enterprise Scope While Browsing
84
Creating an Enterprise Scope
84
Editing an Enterprise Scope
85
Removing an Enterprise Scope
85
Searching For Permissions
85
Adding a Search Scope While Browsing
85
Adding a Search Scope
86
Searching for SharePoint Objects
87
Setting Permission Search Criteria
87
Setting SharePoint Search Criteria
88
Starting the Search
88
Saving Search Results
89
Saving Search Criteria
89
Customizing Security Explorer
89
Setting General Options
89
Setting Advanced Options
90
Setting SharePoint Options
91
Site Administrator for SharePoint REST
93
Request and Response Format
93
REST Resources and URL Structure
93
Site Administrator for SharePoint 5.2.3 User Guide
5
REST Resources
93
GET /farms
96
PUT /farms
98
GET /farms/actual_on
98
GET /servers
99
PUT /servers
101
GET /servers/actual_on
101
GET /sitecollections
102
PUT /sitecollections
102
GET /sitecollections/actual_on
103
GET /sites
103
PUT /sites
104
GET /sites/actual_on
105
GET /site/common_info
105
PUT /site/common_info
107
GET /site/common_info/actual_on
107
GET /content/site_info
108
PUT /content/site_info
109
GET /content/site_info/actual_on
109
GET /content/lists
110
PUT /content/lists
111
GET /content/lists/actual_on
111
GET /content/doclibs
112
PUT /content/doclibs
114
GET /content/doclibs/actual_on
114
GET /storage_growth
115
PUT /storage_growth
116
GET /storage_growth/actual_on
116
GET /space_distribution
117
PUT /space_distribution
118
GET /space_distribution/actual_on
118
GET /alerts
119
PUT /alerts
122
GET /alerts/actual_on
123
GET /security/counters/unique_perms
123
PUT /security/counters/unique_perms
124
GET /security/counters/unique_perms/actual_on
124
GET /security/counters/ad_objs
125
PUT /security/counters/ad_objs
126
GET /security/counters/ad_objs/actual_on
126
Site Administrator for SharePoint 5.2.3 User Guide
6
GET /security/counters/open_content
126
PUT /security/counters/open_content
127
GET /security/counters/open_content/actual_on
127
GET /security/counters/sp_groups
128
PUT /security/counters/sp_groups
129
GET /security/counters/sp_groups/actual_on
129
GET /usage
130
PUT /usage
131
GET /usage/actual_on
131
GET /usage/counters/unused_pages
132
PUT /usage/counters/unused_pages
133
GET /usage/counters/unused_pages/actual_on
133
GET /document/counters/docs_and_pages
134
PUT /document/counters/docs_and_pages
134
GET /document/counters/docs_and_pages/actual_on
135
GET /activity/changes
135
PUT /activity/changes
136
GET /activity/changes/actual_on
136
GET /activity/users/most_active
137
PUT /activity/users/most_active
137
GET /activity/users/most_active/actual_on
138
GET /schedule/report
138
PUT /schedule/report
140
DELETE /schedule/report
140
POST /job/disallow_everyone
141
DELETE /job/disallow_everyone
141
GET /job/disallow_everyone
142
POST /job/propagate_version_settings
143
DELETE /job/propagate_version_settings
144
GET /job/propagate_version_settings
144
POST /job/restore_broken_inheritance
145
DELETE /job/restore_broken_inheritance
145
GET /job/restore_broken_inheritance
146
Site Administrator for SharePoint Scripts
148
CSV to SQL Export
148
Prerequisites
148
Synopsis and Usage
148
Export Grid Reports to PDF
149
Synopsis and Usage
149
Site Administrator for SharePoint 5.2.3 User Guide
7
Clean Up Report Data
150
Synopsis and Usage
151
Clean Up Usage Collector Data
151
Synopsis and Usage
152
Data Gathering for Enterprise Level Reports
152
FAQ
154
How to Install Information Portal Using Command Line
154
How to Get the Best Performance for Multiple Concurrent Users Working with Information
Portal
155
How to Install Information Portal SharePoint Solution (SharePoint Integration Module) without
Installing Full Information Portal Setup on a SharePoint Front-end Server
155
How to Uninstall Information Portal SharePoint Solution (SharePoint Integration Module)
157
How to Automate PDF Export of Site Metrics Report for Specific Site
157
How to Configure IIS 7 as Web Front-end Server for Information Portal
158
Step 1. Configure IIS 7 as Reverse Proxy
159
Step 2. Configure Apache to be Localhost Only
162
Step 3. Reconfigure Information Portal SharePoint Integration Feature
163
How to Change Port for Information Portal
164
How to Change Ports for Information Portal Services
165
How to Change Password for Install and Service Accounts
165
What Permissions Are Required for Site Owners
165
Why is the Actual Size of the SharePoint Content Database Shown in the Reports Much Bigger
than Size of the Site Collection Located in this Database?
165
Information Portal Reports Show Zero or N/A in Usage Data (e.g. the Number of Views, the
Number of Users, Most Used Content)
166
Information Portal Detailed Reports (Site Collections, Sites, Documents, Lists, Document
Libraries) Display Only 20 Records. How to View all Results if the Number of Objects Exceeds
this Limit?
167
Why Is the Site Size Different in Enterprise/Site Metrics and Sites Reports?
167
How to Clear Authorization Cache
167
How to Move Reporting Database to Another SQL Server
168
How to View What Users are Using Site Administrator for SharePoint
168
How to Override Add Farm Behavior
169
Information Portal Advanced Troubleshooting
170
About Dell
173
Contacting Dell
173
Technical support resources
173
Site Administrator for SharePoint 5.2.3 User Guide
8
General Information
In this section:
l
About Site Administrator for SharePoint
l
Key Features
l
Discovery and Reporting
l
Prepare Before You Migrate
l
Operational Auditing
l
Growth Forecasting and Management
About Site Administrator for SharePoint
Site Administrator for SharePoint ® is a web-based tool that allows you to monitor, audit and gain valuable
insight from the content, security and activity information within your SharePoint 2007, 2010 or 2013
environment. With Site Administrator you can:
l
Better understand your infrastructure by identifying and reporting on your entire SharePoint
environment, including farms, servers and those instances you did not know existed.
l
Accurately plan, scope and prioritize your migration to reduce your migration risk.
l
Protect your SharePoint content by managing and monitoring the users who have access to
that content.
l
Empower content owners to access, schedule and export reports, and manage permissions on the
content they own.
l
Track user activity and security modifications across sites and site collections.
l
Forecast and manage SharePoint growth.
Key Features
Site Administrator for SharePoint addresses the limitations of SharePoint and helps you use SharePoint more
effectively in your environment with the following features:
l
Discovery and Reporting
l
Prepare Before You Migrate
l
Comprehensive Security Control
l
Operational Auditing
l
Growth Forecasting and Management
Site Administrator for SharePoint 5.2.3 User Guide
General Information
9
Discovery and Reporting
Site Administrator for SharePoint allows you to better understand your infrastructure by identifying and
reporting on your entire SharePoint environment, including farms, servers and those instances you did not
know existed.
Through a security-trimmed, web-based interface, Site Administrator gives content owners the tools and
reports they need without compromising your security policies.
Prepare Before You Migrate
With Site Administrator you can quickly discover the true extent of your environment and use context reports
to prioritize your content before your migration starts to ensure a smooth project with no surprises.
Comprehensive Security Control
Site Administrator enables you to quickly search for users and access rights across the entire environment,
even users granted permissions via SharePoint Groups, Active Directory or broken inheritance, and then modify
permissions rights from within the search results and reports.
Security Explorer, shipped with Site Administrator, simplifies SharePoint security with point-and-click
permissions management.
Operational Auditing
Site Administrator tracks user activity across sites and site collections, aggregating content and security
modifications in easy to read interactive reports for analysis and decision making by both administrators and
business content owners
Growth Forecasting and Management
With Site Administrator you can protect your SharePoint from out-of-control growth and content sprawl and
plan for future expansions. Site Administrator enables you to run a report and then within that same
dashboard act on and enforce content versions and structure across your environment as well as monitor
growth trends over time.
Site Administrator for SharePoint 5.2.3 User Guide
General Information
10
Deploying Site Administrator for
SharePoint
In this section:
l
System Requirements
l
Required Permissions
l
Setting Required Permissions
l
Installation Procedure
l
Uninstalling Site Administrator for SharePoint
l
Upgrading Site Administrator
System Requirements
Before installing Site Administrator for SharePoint, make sure that your system meets the following minimum
hardware and software requirements:
Requirement
Description
Platform
Intel Pentium 1 GHz processor (x86, x64) or equivalent
Memory
512MB of RAM
Disk space
1 GB of available hard disk space for installation and log files Site Administrator database is
used only for configuration information. It requires up to 100 MB of space.
Operating
System
One of the following:
Additional
Software &
Services
l
Windows Server 2003 (x86 or x64) SP1 or higher
l
Windows Server 2008 (x86 or x64)
l
Windows Server 2008 R2 (x64)
l
Windows Server 2012 (x64)
l
Windows Server 2012 R2 (x64)
Microsoft .Net Framework 3.0 SP2
Microsoft .Net Framework 4.0 (for Security Explorer)
One of the following:
l
Microsoft Internet Explorer 8/9/10/11
l
Google Chrome (latest)
Site Administrator for SharePoint 5.2.3 User Guide
Deploying Site Administrator for SharePoint
11
Requirement
Description
l
Mozilla Firefox (latest)
One of the following:
Supported
SharePoint
Versions
l
Microsoft SQL Server 2005 (Express, Standard or Enterprise edition)
l
Microsoft SQL Server 2008 (Express, Standard or Enterprise edition)
l
Microsoft SQL Server 2012 (Express, Standard or Enterprise edition)
Site Administrator supports the following SharePoint versions:
l
SharePoint 2007 (MOSS and WSS 3.0)
l
SharePoint 2010 (Server and Foundation)
l
SharePoint 2013 (Server and Foundation)
l
SharePoint Online (Office 365 Enterprise)
NOTE: Before installing Site Administrator on a SharePoint front-end server running Windows 2008, it is
required to install IIS 6 WMI compatibility component.
NOTE: Site Administrator for SharePoint does not support Azure High Availability scenarios at the
moment.
Port Requirements
The following ports should be opened for correct Information Portal operation:
l
3141: incoming (Apache Web Server listens on this port)
l
3142: incoming (the agent service implemented as the cherrypy web server http://www.cherrypy.org/
listens on this port)
l
3143: incoming (localhost ONLY. This port should not be opened outside the server).
File sharing on the Site Administrator server for the reports exported on a schedule - 445 or 139.
All reports require SQL ports to be opened on the SharePoint back-end server - 1433, 1434. SQL ports must be
also opened on the server hosting QSP_Repository.
To add a farm, WMI ports must be opened on one front-end server.
For system information in the Servers report, WMI must be opened on all SharePoint and SQL servers.
WMI uses RPC. RPC dynamically selects a free port above 1024 and uses 135 for binding. You can configure
custom port range (for more information, please refer to http://support.microsoft.com/kb/154596/en-us.)
Required Permissions
The account under which you install Site Administrator for SharePoint should have the following rights:
Site Administrator for SharePoint 5.2.3 User Guide
Deploying Site Administrator for SharePoint
12
l
Local Administrator rights on the computer where Site Administrator for SharePoint is installed
l
either of the following:
l
dbcreator role on the SQL server where the Dell repository database will be created and
securityadmin role as Site Administrator for SharePoint setup grants db_owner role for the
created Dell repository database to the service account
l
db_owner role for the existing database to be used as Dell repository database.
NOTE: If the installation account does not have SQL Server level permissions (dbcreator and
securityadmin roles), ask your SQL Server administrator to create a new empty database and to grant
the db_owner role on this database to both the installation and service accounts. Site Administrator for
SharePoint setup populates this database with all the necessary tables.
If Site Administrator for SharePoint is installed on a SharePoint front-end server, the SharePoint integration
feature will be deployed. The installation account must also have the following permissions:
l
db_owner role for the SharePoint configuration database
l
Farm Administrator granted in SharePoint Central Administration
NOTE: If the account does not have these permissions, Site Administrator for SharePoint setup will
complete without errors, but the SharePoint integration feature will not be installed. The SharePoint
integration feature can be installed later. For detailed information, please see How to Install
Information Portal SharePoint Solution (SharePoint Integration Module).
The Site Administrator for SharePoint service account should have at least the following permissions:
l
Local Administrator rights on the computer where the product is installed
l
db_owner role for the Dell repository database
l
db_datareader role for configuration and content SharePoint databases
l
the execute permission for the fn_EscapeForLike function in SharePoint content database
TIP: To apply the execute permission, run the following script:
USE [SHAREPOINT_CONTENT_DB];
GRANT EXECUTE ON dbo.fn_EscapeForLike
TO [INFOPORTAL_SERVICE_ACCOUNT];
GO
l
db_datareader role for web analytics reporting database (SharePoint 2010 Server only)
l
Logon as Service privilege is automatically granted by Site Administrator for SharePoint setup
For system information in the Servers report:
l
Local Administrator rights on the SharePoint server
l
Local Administrator rights on the SharePoint back-end server
NOTE: If local administrator cannot be provided for some servers, the servers report will show partial
data. The information about disk free space, RAM, OS version and service pack will not be displayed.
For the account used to run the SASP_Usage_Collector_task scheduled task (SharePoint 2013):
l
db_datareader role for configuration and content SharePoint databases
l
db_owner role for the existing database to be used as Dell repository database
Site Administrator for SharePoint 5.2.3 User Guide
Deploying Site Administrator for SharePoint
13
l
db_datareader role for Logging database (SharePoint 2013 Server or Foundation only)
For information about the Health Analyzer alerts:
l
db_datareader role for the SharePoint administration content database (SharePoint_
AdminContent_{GUID})
For SharePoint management tools such as permission revoke, reassignment, duplicate, site and list copy:
l
Full control permissions granted via the web application policy
l
db_owner role for the SharePoint content database
l
db_owner role for the SharePoint configuration database.
NOTE: Site Administrator for SharePoint needs to be installed on a front-end server in each SharePoint
farm where you want to manage permissions and content.
By default, the account under which you install Site Administrator for SharePoint is allowed to view all Site
Administrator reports.
SharePoint Site Collection Administrators and site owners can also view Site Administrator reports for the sites
where they have permissions.
For details, please see the Information Portal Levels of Access section.
Adding Farms
The Site Administrator for SharePoint service account must have the following rights:
l
be a member of the Local Administrator group on the SharePoint server being discovered. The
permission is required to read the registry on the server to get information about the installed
SharePoint and read IIS metabase to get the web application configuration
l
db_datareader role for the configuration database of the SharePoint farm being discovered
l
db_owner for the Dell Repository database. The permission is required to write SharePoint farm
configuration to the Repository database.
NOTE: Firewall may prevent discovery of the farm. While discovering a SharePoint farm, Site
Administrator reads registry of the SharePoint server and IIS metabase using Windows Management
Instrumentation (WMI), configuration and content databases of the farm. The following ports should be
opened for the farm:
l
SQL ports. The default instance of the Database Engine uses port 1433. Refer to the following
article for more details: Configure a Firewall for SQL Server Access.
l
WMI/RPC ports. Services typically use 135 and 445 ports to communicate using Remote
Procedure Calls (RPC) and Distributed Component Object Model (DCOM). In addition, RPC uses
the port range of 1024 to 5000 for allocating ports for endpoints. You can configure custom port
range. Refer to the following articles for detailed information: How to configure RPC to use
certain ports and How to configure RPC dynamic port allocation to work with firewalls.
If you use Windows firewall, you may enable the Allow remote administration exception policy to allow
WMI connection. Refer to the Connecting Through Windows Firewall article for detailed information.
Once you have discovered the required farm, you can close WMI/RPC ports.
Site Administrator for SharePoint 5.2.3 User Guide
Deploying Site Administrator for SharePoint
14
Setting Required Permissions
In this section:
l
Setting Permissions on SQL Databases
l
Granting SharePoint Permissions
l
Granting Local Administrator Right
Setting Permissions on SQL Databases
Create a login for the user who will install the Site Administrator for SharePoint to be able to login to
the SQL server.
1. Open MS SQL Server Manager Studio.
2. Expand your SQL instance node.
3. Open the Security node and select the Logins node.
4. Right-click the Logins and select the New Login option. In the new login window enter the user name in
the domain\user format.
Site Administrator for SharePoint 5.2.3 User Guide
Deploying Site Administrator for SharePoint
15
Figure 1: Login-New Window
5. Click OK. The login appears in the list of the Logins node.
6. Locate the login in the list and right-click it. The Login Properties page is displayed.
7. Select the database in the upper pane and set the permissions for the database in the lower pane.
Site Administrator for SharePoint 5.2.3 User Guide
Deploying Site Administrator for SharePoint
16
Figure 2: Set Permissions Repository
8. Click OK.
Alternatively, you can set permissions for a database as follows:
1. Expand your SQL instance node.
2. Expand the Databases node. Locate the required database.
3. Go to Security.
4. Right-click the Users node and select a new user. The Database User-New window is displayed.
5. Specify the login name and find it in the AD.
6. Select the appropriate permission in the Database role membership pane. Click OK.
Repeat these steps to grant permissions to the Site Administrator account for the content and configuration
SharePoint databases.
Site Administrator for SharePoint 5.2.3 User Guide
Deploying Site Administrator for SharePoint
17
Granting SharePoint Permissions
1. Go to Start | SharePoint | Central Administration.
2. In the Central Administration window select the Application Management tab.
3. In the Application Management window go to the Application Security section and select Policy for
Web application. The Policy for Web Application window appears.
4. At the top bar of the Policy for Web Application window select the Web Application from the dropdown list and click the Add Users icon. The Add Users window appears.
5. In the right part of the Add Users window select the user in the Users field and check the appropriate
permissions in the Permissions section.
Setting SharePoint Permissions
6. Click Finish.
7. The Policy for Web Application window displays the new user permissions.
Granting Local Administrator Right
On every computer where Site Administrator for SharePoint is installed, perform the following:
1. Right-click My Computer and select Manage from the short-cut menu. The Computer Management
window appears.
2. Go to System Tools | Local Users and Groups | Groups.
3. In the right pane select Administrators. The Administrators Properties window appears.
4. Click Add. The Select Users, Computers, or Groups dialog appears.
Site Administrator for SharePoint 5.2.3 User Guide
Deploying Site Administrator for SharePoint
18
5. In the Select Users, Computers, or Groups dialog, enter the user name you want to grant
administrators rights to.
6. Click OK.
Alternatively, you can grant local administrator rights as follows:
1. Go to Start | Control Panel.
2. In the Control Panel window, select User Accounts. The User Accounts dialog appears.
3. In the User Accounts dialog, select the Add... button. The Add New User window appears.
4. Enter the domain and name of a user you want to grant permissions. Click Next.
5. Select the Other radio button and then Administrators from the drop-down list.
6. Click Finish.
Installation Procedure
In this section:
l
Installing Site Administrator for SharePoint
l
Installing Site Administrator for SharePoint - Security Explorer
Installing Site Administrator for SharePoint
NOTE: If you install Site Administrator for SharePoint on Windows Server 2008, it is required to disable
the Network access: Do not allow storage of passwords and credentials for network authentication
policy (Security Settings > Local Policies > Security Options) in the Local Group Policy editor. Otherwise,
Site Administrator will fail to create scheduled tasks.
To install Site Administrator for SharePoint, run the autorun.exe file and select Install Site Administrator for
SharePoint. The Installation Wizard starts.
Complete the installation wizard as follows:
1. On the Welcome page, click Next.
2. On the License Agreement page, read and accept the license agreement. Click Next.
3. On the Configuration Database page, specify the SQL server instance to host the configuration database
and the database name to create (QSP_Repository by default).
TIP: You should have permissions to create a database on the specified SQL server for the first
installation to a new database.
NOTE: If Site Administrator for SharePoint is installed on a SharePoint server, the farm is automatically
added to the configuration database during setup.
TIP: The account used to run Site Administrator for SharePoint services should have Read permissions on
the SharePoint configuration and content databases.
Site Administrator for SharePoint 5.2.3 User Guide
Deploying Site Administrator for SharePoint
19
4. On the Additional Parameters page, specify the account to run Site Administrator for
SharePoint services.
5. On the Ready to Install Application page, click Next to begin installation.
6. Click Finish. The Site Administrator for SharePoint Welcome page is automatically opened.
NOTE: During the installation, the Getting Started and Information Portal shortcuts are created in Start
| Programs | Dell | Site Administrator for SharePoint. By selecting the Getting Started shortcut,
you are taken to the Welcome page of the tool. Selecting the Information Portal shortcut opens the
Enterprise report.
NOTE: To access Site Administrator for SharePoint remotely, the port used by Site Administrator should
be opened in Windows Firewall. To get the port number, run the Site Administrator for SharePoint
shortcut. The port number is displayed in the URL of your browser.
NOTE: Site Administrator for SharePoint is installed with the Try Me license valid for 30 days. After
installation, it is required to update the license using the Site Administrator settings.
NOTE: If multiple users are supposed to work with Site Administrator for SharePoint simultaneously,
install the product on several front-end servers, and then configure load-balancing between them.
It is also recommended to deploy multiple instances configuration using the balancer.cmd script. Please
see How to Get the Best Performance for Multiple Concurrent Users Working with Information Portal
Configuring Web Application Port
By default, Site Administrator for SharePoint uses port 3141. To change it to 80, perform the following steps:
1. Open the httpd.conf file located in the Site Administrator for SharePoint\SharePoint Information
Portal\Python25\conf folder.
NOTE: It is recommended to backup this file before configuring it.
2. Replace the 3141 value (5 occurrences) with 80.
3. Restart the Quest.InfoPortal.WebAccess service.
NOTE: If the service does not start, the port is not free and cannot be used by Site Administrator.
Installing Site Administrator for SharePoint Security Explorer
To install Security Explorer, run the autorun.exe file, select Install Site Administrator - Security Explorer
and follow the steps of the Installation Wizard.
Site Administrator for SharePoint 5.2.3 User Guide
Deploying Site Administrator for SharePoint
20
Uninstalling Site Administrator for
SharePoint
To uninstall Site Administrator for SharePoint, perform the following steps:
1. Remove the following products from Site Administrator server using the Add or Remove Programs tool:
l
Site Administrator for SharePoint
l
Security Explorer 7 for SharePoint
2. Remove the Reporting (QSP_Repository by default) database if needed.
3. Delete the log files written to the product installation folder (the default path is C:\Program
Files\Dell\ProductName]) during the uninstallation process if needed.
Uninstalling Management Console
If you want to remove Management Console from your computer, perform the following steps:
1. Backup the registry key:
l
32 bit: HKEY_LOCAL_MACHINE\SOFTWARE\Quest Software\SharePoint Manager
l
64 bit: HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Quest Software\SharePoint
Manager
2. Remove Site Administrator for SharePoint 4.3.
3. Restore the registry key.
If the registry key is lost, you must create the STRING values manually:
l
32 bit: [HKEY_LOCAL_MACHINE\SOFTWARE\Quest Software\SharePoint Manager]
l
64 bit: [HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Quest Software\Sharepoint
Manager]
"StorageProvider"="SQL"
"StorageName"="QSP_Repository"
"StorageMachineName"="sqlserver"
Here:
l
QSP_Repository - the database name (assuming that it was created by Site
Administrator installation);
l
sqlserver - SQl server where the repository is located.
Upgrading Site Administrator
To upgrade Site Administrator from an earlier version to 5.2.3, run the Site Administrator for SharePoint
5.2.3 setup.
Site Administrator for SharePoint 5.2.3 User Guide
Deploying Site Administrator for SharePoint
21
The new version of Site Administrator for SharePoint requires new license 5.X. After the upgrade, the
product will use the Try Me license 5.X for 30 days. When the 30-day period expires, you will need to
update the license.
To upgrade Site Administrator - Security Explorer, uninstall the older version, and then install the new version
of Security Explorer.
Site Administrator for SharePoint 5.2.3 User Guide
Deploying Site Administrator for SharePoint
22
Working with Site Administrator for
SharePoint
In this section:
l
Getting Started
l
Information Portal Levels of Access
l
Search
l
SharePoint Online
l
Reporting
l
Managing SharePoint
l
Policies
l
Site Administrator Settings
l
How It Works
Getting Started
Site Administrator for SharePoint is a web-based tool that allows you to monitor, audit and gain valuable insight
from the content, security and activity information within your SharePoint 2007, 2010 or 2013 environment. A
Welcome page opens at the end of the product installation. Click the tiles on the start page to view the
required dashboard report or the product tour.
NOTE: : In case the tool is installed on a separate server or no farms were added to the product scope
during installation, you will be redirected to the Search SharePoint Farms page. For more information,
please refer to the Adding SharePoint Farms section.
NOTE: If you access the tool as site collection administrator, the Site Collection Administrator page is
displayed. If you access the tool as site owner, the Site Owner page is displayed. For more information,
please refer to the Information Portal Levels of Access section.
Alternatively, you can open the start page by selecting Start | Programs | Dell Software | Site Administrator
for SharePoint | Getting Started.
You can also access Site Administrator for SharePoint with a Start menu shortcut: Programs| Dell | Site
Administrator for SharePoint | Information Portal.
Adding SharePoint Farms
If no farms were added to the product scope during installation, the discovery of SharePoint servers within your
environment is initiated and you are redirected to the Search SharePoint Farms page when you try to access
Site Administrator for SharePoint 5.2.3 User Guide
Working with Site Administrator for SharePoint
23
dashboard reports on the start page. On the Search SharePoint Farms you can see the list of SharePoint
servers discovered in your environment:
Figure 3: Available SharePoint Servers
After the discovery process completes, you can add a SharePoint farm to the product scope by clicking the Add
farm link, which appears when pointing to the required server. When the farm is successfully added, the
Enterprise report opens.
You can also add a SharePoint farm as follows: select add yours, specify NETBIOS or DNS name or IP address of
the server in the farm you want to add and click Add.
NOTE: Site Administrator may not discover SharePoint servers in certain specific advanced
configurations (hardware and software load-balancers, SSL-enabled servers, etc.). For more information,
please see How to Override Add Farm Behavior.
To update the list of discovered SharePoint servers, select Update.
To filter servers by SharePoint version, click the appropriate column header.
To export the data to a PDF file, click the PDF link in the right upper corner of the page.
Adding SharePoint Server with Configured SQL Aliases
Site Administrator is on 32 bit Server
If Site Administrator is installed on the SharePoint server being added, the Add Farm wizard starts to work
immediately.
If Information Portal is installed on a separate server, it is required to configure SQL aliases on the machine
hosting Site Administrator the same way they were configured on a front-end server. Run
C:\Windows\System32\cliconfg.exe both on the SharePoint and Site Administrator servers, and then add all
SharePoint server aliases to the Site Administrator server.
Site Administrator for SharePoint 5.2.3 User Guide
Working with Site Administrator for SharePoint
24
Site Administrator is on 64 bit Server
Regardless of the fact whether Site Administrator is installed on the SharePoint front-end server being added
or not, it is required to copy 64-bit SQL aliases of the SharePoint server to 32-bit aliases of the Site Administrator
server. To do that, perform the following:
1. On the SharePoint server, run C:\Windows\System32\cliconfg.exe.
2. On the Site Administrator server, run C:\Windows\SysWOW64\cliconfg.exe.
3. Copy the SharePoint server aliases to the Site Administrator server.
For information on how to configure SQL aliases, please refer to http://www.mssqltips.com/tip.asp?tip=1620.
Information Portal Levels of Access
To use Site Administrator web UI (Information Portal), access to SharePoint servers is not required. Web UI is
security trimmed and provides the following levels of access:
l
Information Portal Administrator
Information Portal administrators have full access to all Site Administrator reports and actions. Full
access can be granted to individual administrators using the Information Portal settings. Users are not
required to have administrator rights on any of the servers.
By default, the Enterprise report displays an overview of all SharePoint farms, content databases and
web applications.
l
SharePoint Site Collection Administrator
Users with site collection administrator privileges can access reports and perform actions within their
management scope (i.e. within the sites and site collections where they have rights in SharePoint). No
additional configuration is required. Information Portal checks the user permissions in SharePoint and
automatically trims user access based on the SharePoint security.
When running Information Portal, site collection administrators are redirected to a page which displays
all sites from all site collections the user has the administrator access to. User can run reports or
perform actions on this page.
Reports are also available on the SharePoint site settings page which is extended with the
corresponding links after Site Administrator installation.
l
SharePoint Site Owner
Users with full control access to individual sites/sub-sites can view reports for these sites.
NOTE: Reports display information about all document libraries, lists, list items and documents in a site
even if some of them have unique permissions with no access to a site owner.
When running Information Portal, site owners are redirected to a page which displays all sites they have full
control access to. On this page, users can search across all these sites by any part of site URL or view reports for
the selected site.
Reports are also available from the SharePoint site settings page which is extended with the corresponding
links after Site Administrator installation.
Site Administrator for SharePoint 5.2.3 User Guide
Working with Site Administrator for SharePoint
25
Sign In Under Different User Account
Information Portal users can sign in to the tool under different user account for evaluation and
troubleshooting purposes.
Perform the following:
1. Click the current account you are logged in.
2. Provide the user name in the domain\user format and password and click OK.
Search
The search option allows you to search for any SharePoint site you need to review in more detail across all your
SharePoint storage using a URL or a part of the URL. Wildcard search is supported.
To start the search, click
press Enter.
in the Information Portal menu. In the displayed field, specify the site URL and
Search
You can limit your search to looking in Farms, Web Applications, Site Collections and Sites by selecting the
corresponding from the Information Portal menu.
To limit the search results number to display, specify the following in the URL: search_limit=N, where N is the
search results number to display.
SharePoint Online
In the Information Portal menu you can see the SharePoint Online link, which allows you to view Information
Portal reports for SharePoint Online within Microsoft Office 365 cloud.
NOTE: Note that the SharePoint Online link is available only for Information Portal administrators.
Sign in
Build-in Domain Accounts
The accounts of built-in or non-federated domains like [email protected]<TenantName>.onmicrosoft.com should be used
to log in to IPO 365. The login account should have the Global Administrator role. Only the Global Administrator
account can access administrative site collection and is able to get site collections list. The account should be
the site collection administrator for all site collections to gather report data.
Site Administrator for SharePoint 5.2.3 User Guide
Working with Site Administrator for SharePoint
26
NOTE: In case the provided account does not have permissions to access the site collection, the site
collection data will not be included into the report.
Federated Domain Accounts
Sign in using Active Directory Federation Services (ADFS) is not supported in IPO 365. In case the ADFS 2.0 service
is an intranet site, the IPO 365 server is not able to access it. If the ADFS 2.0 service is globally available, then it
could be accessed by the IPO 365 server, but it has not been implemented yet.
Reporting
Site Administrator provides over a dozen of various valuable reports available on different scopes. All reports
are grouped under 4 major governance areas: IT Infrastructure, Content Management, Security, and User
Activity. For each of these areas a specific dashboard is provided to roll up aggregated data, give users a quick
summary view and expose one-step drill down to all reports relevant to the area.
All Site Administrator reports and dashboards are security trimmed. Depending on your security level, you can
view the following dashboards and reports:
Table 1: Security Levels and Available Reports
Reports
Information
Portal
administrator
Site Collection administrator
IT
Infrastructure
+
-
Content
Management
+
+
+
Security
+
+
+
Enterprise
+
+
+
Servers
+
-
-
Farm metrics
+
-
-
Web
Applications
+
-
-
Content
Databases
+
-
-
Site Collections
+
+
-
Site Metrics
+
+
+
Sites
+
+
-
Document and
Pages
+
+
+
Lists
+
+
+
Document
+
+
+
Site Administrator for SharePoint 5.2.3 User Guide
Working with Site Administrator for SharePoint
Site
owner
27
Reports
Information
Portal
administrator
Site Collection administrator
Site
owner
Site Permissions
+
+
+
User
Permissions
+
+
+
Security
Changes
+
+
+
Usage
+
+
+
Activity
+
+
+
Daily Usage
+
+
+
Content
Changes
+
+
+
Libraries
Information Portal reports and dashboards are supported for SharePoint 2007, SharePoint 2010 and
SharePoint 2013.
Dashboards
Viewing Dashboards
To view a dashboard, select the desired item from the Dashboards menu.
NOTE: If your current scope is enterprise, farm or web application, you will see the Select site window
when trying to view the dashboard for a site. Specify the desired site for which you want to view the
dashboard and click OK.
Dashboard Descriptions
This section contains detailed description of the Site Administrator dashboards:
l
IT Infrastructure
l
Content Management
l
Security
l
Activity
IT Infrastructure
The IT Infrastructure dashboard provides summary information about your SharePoint infrastructure across the
enterprise. The dashboard allows you to drill down into details on farms, servers, web applications, content
databases and sites as well as to quickly assess storage used by SharePoint content and health of the
SharePoint environment.
Site Administrator for SharePoint 5.2.3 User Guide
Working with Site Administrator for SharePoint
28
The dashboard contains the following information:
l
the total content size of multiple farms and the total number of servers and farms. Click View more to
see the Enterprise report.
l
the Information Growth graph displaying the total growth of all SharePoint farms content. Click View
more to see the Enterprise report.
l
the number of content databases, web applications, site collections, and sites. Click View more to see
the Enterprise report.
l
the Storage Space Distribution chart displaying the ratio of total sizes for content, versions, user and
administrator recycle bins. Click View more to see the Documents and Pages report for the
enterprise scope
l
the number of servers in each role
NOTE: Each server can have several roles.
l
the number of alerts in each category. Selecting any alert category opens a dialog displaying detailed
information on each alert in the selected category. All alerts are sorted by severity and marked with
particular color.
NOTE: Health alerts are not supported for SharePoint 2007. If only 2007 SharePoint farms are available in
your SharePoint environment, the "Not available" message will be displayed.
l
top 10 farms, servers, web applications, content databases, site collections and sites.
NOTE: Top 10 farms are displayed only if the dashboard is opened for the enterprise scope.
Selecting the farm title in the farms list opens the IT Infrastructure report for this farm.
Site Administrator for SharePoint 5.2.3 User Guide
Working with Site Administrator for SharePoint
29
To add a farm to the product scope, click the Add another farm link. For more information, please refer to the
Adding SharePoint Farms section.
To view all farms, web applications, content databases, site collections and sites available in your enterprise,
click the View more link.
Content Management
The Content Management dashboard provides information that allows you to understand how much storage is
used by the site or site collection, whether this storage space is used efficiently, and identify opportunities for
cleanup. The report allows you to modify and propagate version settings for document libraries, and enforce
these settings as an ongoing policy.
Figure 4: Content Management Dashboard
The dashboard contains the following information:
l
Total Content - displays the total content size of the current site, limit of the site collection size (if set)
and available space (if set). The following formula is used to calculate the available space: Site
Collection Quota - Space Already Used by Site Collection.
Clicking the tile opens the Site metrics report for the current site.
l
the Information Growth graph displaying the total growth of the site content. Clicking the tile opens
the Site metrics report for the current site.
l
the number of sub-sites, lists, list items, document libraries, documents, document versions,
attachments and the total size of all documents.
NOTE: The number of sub-sites is not available for site owners.
Clicking the tile opens the Site metrics report for the current site.
Site Administrator for SharePoint 5.2.3 User Guide
Working with Site Administrator for SharePoint
30
l
the top used document types. Clicking the tile opens the Documents and Pages report for the
current site.
l
the Space Distribution pie-chart, displaying the ratio of total sizes for content, versions, user and
administrator recycle bins. Clicking the tile opens the Documents and Pages report for the current site.
l
Version Policy - allows you to enforce version settings for document libraries in the current site scope.
For more information, please refer to Configuring Version Settings for Document Libraries.
l
10 top sized sub-sites, lists, document libraries, document types, documents.
NOTE: The top sized sub-sites are not available for site owners.
To view all sub-sites, lists, document libraries, document types, documents for the current site, click
the View more link.
To select another site for the dashboard click
next to the report title, and then select the desired site
using the search option in the Select site window.
Security
The Security dashboard provides access to the key permission-related indicators and detailed security reports.
It uncovers potential security issues, such as broken permission inheritance and content open to all users.
Figure 5: Security Dashboard
The dashboard contains the following information:
Site Administrator for SharePoint 5.2.3 User Guide
Working with Site Administrator for SharePoint
31
l
Authorized Users - the total number users having permissions within the current site; the number of
SharePoint and Active Directory groups used to grant permissions to the current scope. Clicking the tile
opens the Site Permissions report for the current scope.
l
Broken Inheritance - the total number of SharePoint objects with unique permissions; the number of
sites, lists and document libraries, list items and pages with unique permissions. Clicking the tile opens
the Site Permissions report for the current scope.
l
Open Content - the total number of SharePoint objects (i.e. sites, lists, document libraries, pages,
documents, and items) where NT Authority\Authenticated Users have permissions. Clicking the tile
opens the User Permissions report for NT Authority\Authenticated Users.
l
User Permissions - allows you to search for permissions that a specific user has within the current scope.
Clicking the tile allows you to view the User Permissions report for the current site.
l
Inheritance Policy - allows you to enforce permission inheritance for the current site. For more
information, please see Applying Security Settings.
l
Authenticated Users Policy - allows you to remove permissions granted to NT Authority\Authenticated
Users within the current site scope. For more information, please see Applying Security Settings.
l
Recent Security Changes - the list of recent security changes. Clicking View more opens the Security
Changes report for the current site.
To select another site for the dashboard click
next to the dashboard title, and then select the desired
site using the search option in the Select site window.
Activity
It is essential to understand who is using your SharePoint environment, and how they are using it. The Activity
dashboard provides information on both read and modification activity, giving you a comprehensive picture of
how the site is being used. The dashboard helps IT and site owners to assess user adoption of a particular
site/project, quickly identify unused and stalled content, assess how current is the site content; see most
active users and contributors.
NOTE: For SharePoint 2007, the dashboard displays information over two weeks' period. For SharePoint
2010 and SharePoint 2013, the report displays information over a month's period.
Site Administrator for SharePoint 5.2.3 User Guide
Working with Site Administrator for SharePoint
32
Figure 6: Activity Dashboard
The dashboard contains the following information:
l
Page Views - displays the total number of page hits over the reported period, average number of page
views per day and when the site was last accessed. The bar chart displays the usage of the site over the
reported period daily. Clicking the tile opens the Usage report for the current site.
l
Visitors - displays the total number of users who accessed the site pages over the reported period and
lists 3 most active visitors. Clicking the tile opens the Daily Usage report for the current site.
l
Unused - displays the percentage of unused content. The following formula is used to calculate the
percentage: 100% (Total Number of Documents and Pages - Number of Accessed Pages over Last month)
/ Total Number of Documents and Pages. Clicking the tile opens the Documents and Pages report for the
current site.
l
Content Changes - displays the total number of content and security changes made within the current
site, average number of content changes per day and when the content was last modified. The bar
chart displays the number of changes over the reported period daily. Clicking the tile opens the Activity
report for the current site.
l
Contributors - displays the total number of users who modified the site content over the reported
period and lists 3 most active contributors. Clicking the tile opens the Content Changes report for the
current site.
l
Unchanged - displays the percentage of unchanged content. The following formula is used to calculate
the percentage: 100% Number of Documents and Pages Modified over a month's period / Total Number of
Documents and Pages. Clicking the tile opens the Documents and Pages report for the current site.
l
Recent Content Changes - displays 10 recent content changes. Clicking View more opens the Content
Changes report for the current site.
Site Administrator for SharePoint 5.2.3 User Guide
Working with Site Administrator for SharePoint
33
NOTE: The usage data displayed in the dashboard for SharePoint 2013 will be incomplete until the data
has been accumulated in the QSP_Repository database for one month. The dashboard will display
current data that affects monthly aggregated values, such as total views and users. After initial
synchronization the data collected for two weeks will be displayed since SharePoint stores this history.
Two weeks after a farm was added to the product scope, the dashboard will display the data collected
for one month.
To select another site for the dashboard click
next to the dashboard title, and then select the desired
site using the search option in the Select site window.
Reports
In this section:
l
Viewing Reports
l
Report Descriptions
l
IT Infrastructure Reports
l
Content Management Reports
l
Security Reports
l
Activity Reports
Viewing Reports
To view a report, select the desired item from the Reports menu.
To view a report on the farm or web application scope, select Farms or Web Applications from the upper
menu. Navigate to the object you want to view the report for, and then select the required report link.
Report Descriptions
Site Administrator for SharePoint provides the following reports:
IT Infrastructure reports:
l
Enterprise
l
Servers
l
Farm Metrics
l
Web Applications
l
Content Databases
l
Site Collections
Content Management reports:
l
Site Metrics
l
Sites
l
Documents and Pages
Site Administrator for SharePoint 5.2.3 User Guide
Working with Site Administrator for SharePoint
34
l
Lists
l
Document Libraries
Security reports:
l
Site Permissions
l
User Permissions
l
Security Changes
Activity reports:
l
Usage
l
Activity
l
Daily Usage
l
Content Changes
IT Infrastructure Reports
Enterprise Report
This report provides detailed information about your SharePoint environment:
Figure 7: Enterprise Report
The report contains the following information:
l
Enterprise - This section provides information on the number of: Web applications, Content databases,
Site Collections, Sites, Document Libraries, Documents, List Items and Lists.
The Enterprise Information Growth graph displays the total growth of all SharePoint farms content over
a year’s period. To construct the graph, the document creation dates stored in the SharePoint content
Site Administrator for SharePoint 5.2.3 User Guide
Working with Site Administrator for SharePoint
35
database are used. The Y axis shows the total size of the documents created by the date marked on the
X axis. You can select the period you want to view the graph for.
l
Top Sizes - This section provides the data on five biggest web applications, content databases, site
collections, sites and documents.
When navigating to a web application or site/site collection, links to specific reports and dashboards
appear. Selecting any of the given links opens the corresponding dashboard or report for the selected
web application or site scope.
Selecting View more in the Web Application/ Content Database/ Site Collections/ Sites/ Documents
block opens a report displaying information on all web applications/content databases/site
collections/sites/documents within your whole enterprise.
You can specify the file types to be displayed in the Documents block by using the File Filter Settings.
To do this, click the
l
icon next to the block title.
Farms - This section displays the list of farms within your SharePoint. Selecting the Add another farm
link, which appears when navigating to the total farms' size, opens a page, displaying all available
SharePoint servers within your environment. Please refer to Adding SharePoint Farms for more
information.
When navigating to a farm, the Farm metrics and Remove links appear. Selecting the Farm metrics link
opens the Farm Metrics report. Selecting the Remove link removes the farm from your SharePoint.
l
Storage Space Distribution - This section is a pie-chart, displaying the ratio of total sizes for content,
versions, user and administrator recycle bins.
l
Document Types - This section provides the list of all document types available in your environment,
including the document extensions, the number and size for documents of each type. Click View more
to view the Documents and Pages report for your whole enterprise.
Servers Report
This report provides the key metrics for all servers within the enterprise or farm scope.
Site Administrator for SharePoint 5.2.3 User Guide
Working with Site Administrator for SharePoint
36
Figure 8: Servers Report
The report provides the following information for each server:
l
the name of the SharePoint server
l
the SharePoint version
l
the operating system the server is running
l
the name of the host server farm
l
the disk free space
l
the amount of memory used by the server
l
the list of roles and services
Farm Metrics Report
This report provides detailed information on the selected SharePoint farm.
Site Administrator for SharePoint 5.2.3 User Guide
Working with Site Administrator for SharePoint
37
Figure 9: Farm Metrics Report
The report contains the following information:
l
Farm Metrics - This section provides information on the number of: Web applications, Content
databases, Site Collections, Sites, Document Libraries, Documents, List Items and Lists.
The Farm Information Growth graph displays the total growth of all SharePoint farm content over a
year’s period. To construct the graph, the document creation dates stored in the SharePoint
content database are used. The Y axis shows the total size of the documents created by the date
marked on the X axis.
l
Top Sizes - This section provides the data on five biggest web applications, content databases, site
collections, sites and documents.
When navigating to a web application or site/site collection, links to specific reports and dashboards
appear. Selecting any of the given links opens the corresponding dashboard or report for the selected
web application or site scope.
Selecting View more in the Web Application/ Content Database/ Site Collections/ Sites/ Documents
block opens a report displaying information on all web applications/content databases/site
collections/sites/documents within your farm.
You can specify the file types to be displayed in the Documents block by using File Filter Settings. To do
this, click the icon next to the block title.
l
Farm Information - This section displays information on the farm.
l
Storage Space Distribution - This section is a pie-chart, displaying the ratio of total sizes for content,
versions, user and administrator recycle bins.
l
Document Types - This section provides the list of all document types available within the selected
farm, including the document extensions, the number and size for documents of each type. Click View
more to view the Documents and Pages report for the selected farm.
Site Administrator for SharePoint 5.2.3 User Guide
Working with Site Administrator for SharePoint
38
Web Applications Report
This report presented as a grid provides the key metrics for all web applications within the enterprise
or farm scope.
NOTE: Please note that the report will not contain any data until it is collected by the data gathering
task.
NOTE: The list of web applications is taken from the SharePoint configuration database. Each time a user
opens the report, the web application list is refreshed, i.e. the report displays all the web applications
including those created after the farm was discovered. If for some reason the SharePoint configuration
database is unavailable, the list of web applications is taken from the QMC repository.
Figure 10: Web Applications Report
By default, the report displays the following information:
l
the name of the farm hosting the web application
l
the number of all site collections within the web application
l
the number of all sites within the web application
l
the number of all content databases within the web application
l
the total number of users. The users number value is taken from the Users table in every
content database
l
the total size of all site collections within the web application
You can filter and sort the report contents as well as add or delete columns to/from the report using the
options from the drop-down menu.
Content Databases Report
This report provides the key metrics for all content databases within the enterprise or farm scope.
NOTE: Please note that the report will not contain any data until it is collected by the data gathering
task.
Site Administrator for SharePoint 5.2.3 User Guide
Working with Site Administrator for SharePoint
39
Figure 11: Content Databases Report
By default, the report displays the following information:
l
the name of the database
l
the number of all site collections in the content database
l
the number of all sites in the content database
l
the total size of all files in the content database including transaction logs
l
the total size of all the content such as documents, lists, and list items in the content database
l
the maximum number of sites that the content database can contain
l
the number of sites that can be created before a warning event is generated and sent to the site
collection owner
You can filter and sort the report contents as well as add or delete columns to/from the report using the
options from the drop-down menu.
Site Collections Report
This report provides you with the key metrics for all site collections within the web application, farm or the
enterprise scope.
Site Administrator for SharePoint 5.2.3 User Guide
Working with Site Administrator for SharePoint
40
Figure 12: Site Collections Report
The report provides the following information for each site collection:
l
the name of the site collection;
l
the path to the site collection;
l
the links to the Activity, Content Management, and Security dashboards. The links appear when
navigating to the required site collection.
l
the date when the site collection was created;
l
the name of the user who created the site collection;
l
the name of the site collection administrator;
l
the date when any content, page or document within the site or site collection was last accessed;
l
the date when the site collection was last modified;
l
the number of sites within the site collection;
l
the total number of the document/page views within the scope over the past 30 days;
l
the number of unique users who accessed any content within the site collection scope over the
past 30 days;
l
the total size of the site collection.
NOTE:
l
For SharePoint 2010 Foundation, the usage information (the number of views and the last access
date) is displayed only for pages. The documents usage information is not displayed.
Site Administrator for SharePoint 5.2.3 User Guide
Working with Site Administrator for SharePoint
41
l
The usage data displayed in the report for SharePoint 2013 will be incomplete until the data has
been accumulated in the QSP_Repository database for one month. The report will display
current data that affects monthly aggregated values, such as total views and users. After initial
synchronization the data collected for two weeks will be displayed since SharePoint stores this
history. Two weeks after a farm was added to the product scope, the report will display the data
collected for one month.
By default, the report displays only 20 site collections. To adjust the scope, change the report setting on the
Information Portal Settings page. For more information, please refer to Report Settings.
NOTE: Each site can generate 5-10 seconds. If, for example, you change the default value to 200, the
process of generating report may take up to 3 hours.
You can export the report to CSV or SQL format. For more information, please refer to Exporting Reports.
NOTE: If any issues occur when running the report, you will see them at the top of the page.
Content Management Reports
Content Management Reports
Site Metrics Report
The Site Metrics report provides detailed information on the selected SharePoint site.
Figure 13: Site Metrics Report
The report contains the following information:
Site Administrator for SharePoint 5.2.3 User Guide
Working with Site Administrator for SharePoint
42
l
Metrics for {Site name (URL)} - This section provides information on the site total content size, the
number of Sub-sites, Lists, List Items, Document Libraries, Documents, and the total size of all
documents, the number of their versions and attachments.
The Site Information Growth graph displays the total growth of the site content with all its sub-sites
over a month’s period. If you work with Information Portal as site owner, the graph displays the total
growth of the site content only. To construct the graph, the document creation dates stored in the
SharePoint content database are used. The Y axis shows the total size of the documents created by the
date marked on the X axis.
To select another site for the report, click the
search option in the Select site window.
l
icon and then select the desired site using the
Top Sizes - This section provides the data on five biggest sub-sites, document libraries, lists and
documents on the site.
When navigating to a site/site collection, links to specific dashboards appear. Selecting any of the given
links opens the corresponding dashboard for the selected scope.
Selecting View more in the Sites/ Documents/ List/ Doc library block opens a report displaying
information on all sub-sites/documents/lists/ document libraries within the current site scope.
NOTE: The View more link in the Sites block is not available for site owners.
You can specify the file types to be displayed in this section by using File Filter Settings. To do this, click
the
icon next to the section title.
NOTE: The filter option is available only for Information Portal administrators.
l
Site Information - This section displays the site creation information.
Site Collection Information provides the URLs of the web application and site collection, site
administrators, size quota and content database.
Storage Space Distribution - This section is a pie-chart, displaying the ratio of total sizes for content,
versions, user and administrator recycle bins.
l
Document Types - This section provides the list of all document types available in your environment,
including the document extensions, the number and size for documents of each type. Click View more
to view the Documents and Pages report for the site.
Sites Report
This report provides you with the key metrics for all sites and sub-sites within the site collection, site, farm or
enterprise scope.
Site Administrator for SharePoint 5.2.3 User Guide
Working with Site Administrator for SharePoint
43
Figure 14: Sites Report
The report provides the following information for each site:
l
the name of the site;
l
the path to the site;
l
the links to the Activity, Content Management, and Security dashboards. The links appear when
navigating to the required site collection.
l
the date when the site was created;
l
the name of the user who created the site;
l
the name of the site administrator;
l
the date when the site was last accessed;
l
the date when the site content was last modified;
l
the number of sub-sites within the site;
l
the number of the site views over the past month;
l
the number of site unique users over the past month;
l
the site size excluding its sub-sites.
NOTE:
l
For SharePoint 2010 Foundation, the usage information (the number of views and the last access
date) is displayed only for pages. The documents usage information is not displayed.
l
The usage data displayed in the report for SharePoint 2013 will be incomplete until the data has
Site Administrator for SharePoint 5.2.3 User Guide
Working with Site Administrator for SharePoint
44
been accumulated in the QSP_Repository database for one month. The report will display
current data that affects monthly aggregated values, such as total views and users. After initial
synchronization the data collected for two weeks will be displayed since SharePoint stores this
history. Two weeks after a farm was added to the product scope, the report will display the data
collected for one month.
l
Site properties are displayed for each site individually, i.e. the Views property displays the
number of views only for this particular site, etc.
By default, the report displays only 20 sites. To adjust the scope, change the report settings on the Information
Portal Settings page. For more information, please refer to Report Settings.
NOTE: Each site can generate 5-10 seconds. If, for example, you change the default value to 200, the
process of generating report may take up to 3 hours.
You can export the report to CSV or SQL format. For more information, please refer to Exporting Reports.
NOTE: If any issues occur when running the report, you will see them at the top of the page.
Documents and Pages Report
This report allows you to view the key metrics for all documents and pages within the enterprise, farm, web
application, site collection or site scope including its subsites.
NOTE: For site owners the report displays information for the site scope excluding its sub-sites.
A site owner will see all documents and pages in the report even if documents and pages are in the library with
broken permissions inheritance and the site owner’s access to this library is revoked.
Figure 15: Documents and Pages Report
Site Administrator for SharePoint 5.2.3 User Guide
Working with Site Administrator for SharePoint
45
The report provides the following information for each document and page:
l
the name of the document/page;
l
the path to the document/page. Displayed only for documents in document libraries;
l
the type of the document/page. Displayed only in CSV report;
l
the time when the document/page was created;
l
the time when the document/page was last modified;
l
the name of the user who created the document/page;
l
the name of the user who modified the document/page;
l
the date when the document/page was last accessed;
l
the total number of the document/page views within the scope over the past 30 days;
l
the number of the document versions;
l
the total size of the document/page;
l
the size of the last document/page version.
NOTE:
l
For SharePoint 2010 Foundation, the usage information (the number of views and the last access
date) is displayed only for pages. The documents usage information is not displayed.
l
The usage data displayed in the report for SharePoint 2013 will be incomplete until the data has
been accumulated in the QSP_Repository database for one month. The report will display
current data that affects monthly aggregated values, such as total views and users. After initial
synchronization the data collected for two weeks will be displayed since SharePoint stores this
history. Two weeks after a farm was added to the product scope, the report will display the data
collected for one month.
By default, the report displays all document and page types. You can specify the file types to be displayed in
the report by using File Filter Settings. To do this, click the
icon next to the report title. To filter the
contents of the grid report, use the filter option from the drop-down.
NOTE:
l
The filter option is available only for Information Portal administrators.
l
Note that filter settings are not applied to CSV version of the report. Therefore, it will contain
unfiltered data.
By default, the report displays only 20 sites. To adjust the scope, change the report settings on the Information
Portal Settings page. For more information, please refer to Report Settings.
You can export the report to CSV or SQL format. For more information, please refer to Exporting Reports.
To change the site scope for the report, click the
icon next to the report title, and then select the
desired site using the search option in the Select site window.
NOTE: If any issues occur when running the report, you will see them at the top of the page.
Lists Report
This report provides the key metrics for all lists within the site collection or site scope including its sub-sites.
NOTE: For site owners the report displays information for the site scope excluding its sub-sites.
Site Administrator for SharePoint 5.2.3 User Guide
Working with Site Administrator for SharePoint
46
System lists are displayed only in the CSV report.
Lists from the Recycle Bin are not displayed.
Figure 16: Lists Report
The report provides the following information for each list:
l
the type of the list;
l
the name of the list;
l
the path to its parent site;
l
the date when the list was created;
l
the date when the list was last modified;
l
the number of all list items;
l
the number of all list attachments;
l
the total size of the list;
l
the number of all item versions.
By default, the report displays only 20 lists. To adjust the scope, change the report settings. For more
information, please refer to the Site Administrator Settings section.
To change the site scope for the report, click the
icon next to the report title, and then select the
desired site using the search option in the Select site window.
Document Libraries Report
This report provides the key metrics for all document libraries within the site collection or site scope including
its sub-sites.
Site Administrator for SharePoint 5.2.3 User Guide
Working with Site Administrator for SharePoint
47
NOTE: For site owners the report displays information for the site scope excluding its sub-sites.
System document libraries are displayed only in the CSV report.
Document libraries from the Recycle Bin are not displayed.
Figure 17: Document Libraries Report
The report provides the following information for each document library:
l
the type of the document library
l
the name of the document library
l
the path to its parent site
l
the date when the document library was created
l
the date when the document library was last modified
l
the number of documents in the document library
l
the total size of the document library
l
the number of all documents versions
By default, the report displays only 20 document libraries. To adjust the scope, change the report settings. For
more information, please refer to the Site Administrator Settings section.
To change the site scope for the report, click the
icon next to the report title, and then select the
desired site using the search option in the Select site window.
Site Administrator for SharePoint 5.2.3 User Guide
Working with Site Administrator for SharePoint
48
Security Reports
Site Permissions Report
The site permissions report allows you to view the list of users having access to a specific site, its sub-sites,
lists, document libraries, folders and documents and their permission levels, with expanded SharePoint and
Active Directory group membership. You can also see how each permission level has been granted to a user.
NOTE: User permissions for system lists are not displayed.
The report displays permissions of the groups and users from external forests even with one-way trusts.
Groups (except for the well-known groups like Authenticated users) are automatically expanded to the
list of users.
Figure 18: Site Permissions Report
The report contains the following information:
l
the name of the user who has access to the site
l
the user name (received from Active Directory)
l
the level of user access and how it is granted
NOTE: The report displays only the leading and trailing groups through which permissions were granted.
Click the trailing group to view the complete list of groups.
Note that the number of unique permissions displayed in the report is limited to 500.
Site Administrator for SharePoint 5.2.3 User Guide
Working with Site Administrator for SharePoint
49
To change the site scope for the report, click the
icon next to the report title, and then select the
desired site using the search option in the Select site window.
User Permissions Report
This report provides a summary view of security permissions that a user or group (SharePoint or Active
Directory) has within the farm, web application, site collection or site scope. You can also see how each
permission level has been granted to a user or group. The report:
l
Displays all sites/sub-sites a user or group has permissions for within the current farm/web
application/site collection/site, permission level for each site/ sub-site and how it is granted
l
Displays any lists and libraries that do not inherit site permissions
l
Displays any document, folder and list item with explicit permissions
l
Supports complex multi-domain and multi-forest environments
NOTE: For Active Directory groups the report displays only permissions granted explicitly or via
SharePoint groups. Permissions granted via another Active Directory group are not displayed.
In multi-forest environments, make sure the Information Portal service account has all required
permissions and sufficient trusts for the domains involved.
To view the report, select User Permissions from the Reports menu, specify the account you want to view
permissions for and click Show Permissions.
Figure 19: User Permissions Report
NOTE: The report displays only the leading and trailing groups through which permission were granted.
Click the trailing group to view the complete list of groups.
Note that the number of unique permissions displayed in the report is limited to 500.
Site Administrator for SharePoint 5.2.3 User Guide
Working with Site Administrator for SharePoint
50
To change the site scope for the report, click the
icon next to the report title, and then select the
desired site using the search option in the Select site window.
NOTE: Both the User Permissions and Site Permissions reports have management options allowing you to
perform a number of actions on permissions. For more information, please refer to the Managing
Security section.
Security Changes Report
This report displays all the security changes within the site scope including its sub-sites and when the
changes were made.
NOTE: The following site collection level security changes are displayed for site owners:
l
create/delete a SharePoint group
l
add/remove a member to/from a SharePoint group
l
create site collection event
Figure 20: Security Changes Report
By default, the report displays only 20 changes. To adjust the scope, change the report settings. For more
information, please refer to the Site Administrator Settings section.
To change the site scope for the report, click the
icon next to the report title, and then select the
desired site using the search option in the Select site window.
Site Administrator for SharePoint 5.2.3 User Guide
Working with Site Administrator for SharePoint
51
Activity Reports
Usage Report
This report provides you with the site usage statistics over a month's period.
NOTE: The usage report displays the data collected by SharePoint. SharePoint collects data only if the
Usage Analysis Processing option is enabled.
In WSS 3.0 and MOSS 2007, the Usage Analysis Processing option is disabled by default. You must enable
it manually from Central Administration. For information on how to enable the option, please refer to
http://support.microsoft.com/kb/825541. After the Usage Analysis Processing option is enabled, the
SharePoint usage analysis job operates daily on each front-end server and gathers yesterday logs. This
process is not supposed to be very resource intensive as the job collects information for one day only.
The data is accumulated, and then moved to the SharePoint content database. It is not required to
configure MOSS 2007 Shared Services provider. The Information Portal data is based on the SharePoint
Services usage analysis job only.
In SharePoint 2010 Foundation, the Usage Analysis Processing option is enabled by default. In case it was
disabled, enable it manually. SharePoint has a new mechanism which collects usage information from
text logs and moves it to the WSS_Logging database every 30 minutes. Then the usage analysis
processing job processes the database and moves the usage data to content database (the same location
and format as in SharePoint 2007). Information Portal displays the data the same way as in SharePoint
2007.
SharePoint 2010 Server has the Web analytics feature, which is configured by default and includes the
Web Analytics services, the Web Analytics staging and reporting databases. The usage data is collected
from text logs and moved to the staging database by the SharePoint job every 30 minutes. Every day the
Web Analytics service collects and aggregates data from the staging to the reporting database. The data
format is different from the one in SharePoint 2010 Foundation. Information Portal uses the web
analytics reporting database to display usage statistics.
For SharePoint 2013, the usage data gathering process is initiated by the SASP_Usage_Collector_task
scheduled task (usage collector) at 2 a.m every day. The usage data is collected from the WSS_Logging
database and stored in the QSP_Repository database. The usage data collection may result in growth of
the QSP_Repository database as a result of the usage collector work. To prevent unlimited growth and
impact on the report performance, old data is removed from the database at 1 a.m. every day (the
process is initiated by the SASP_Repository_Cleanup_task scheduled task). The scheduling can be
modified by updating the SASP_Usage_Collector_task and SASP_Repository_Cleanup_task properties
using the Windows Task Scheduler.
IMPORTANT: The usage data displayed in the report for SharePoint 2013 will be incomplete until the
data has been accumulated in the QSP_Repository database for one month. The report will display
current data that affects monthly aggregated values, such as total views and users. After initial
synchronization the data collected for two weeks will be displayed since SharePoint stores this history.
Two weeks after a farm was added to the product scope, the report will display the data collected for
one month.
Site Administrator for SharePoint 5.2.3 User Guide
Working with Site Administrator for SharePoint
52
Figure 21: Usage Report
The report contains the following information:
l
Monthly Usage for {Site name (URL)} - This section provides summary information on the: average
number of daily views, number of users accessing the site, number of sub-sites, total content size, date
when the site was last accessed and modified.
NOTE: For SharePoint 2010 Foundation, the information is displayed only for pages. The documents
usage information is not displayed.
Number of Page Views is a graph displaying the number of page views per month.
l
Top Used Content - This section provides information on five most visited sites, documents and pages
within the site.
NOTE: For SharePoint 2010 Foundation, the information is displayed only for pages. The documents
information is not displayed.
When navigating to a sub-site, links to specific dashboards appear. Selecting any of the given links opens
the corresponding dashboards for the selected sub-site scope.
Selecting View more in one of the displayed blocks opens a report displaying information on all sub-sites
or documents within the current site scope.
You can specify the file types to be displayed in the Most used documents and pages block of the section
by using File Filter Settings. To do this, click the
icon next to the block title.
NOTE: Only Information Portal administrators can use the filtering option.
l
Top Unused Content - This section provides the data on five least visited sites and five long unused
sites. Long unused sites are top five sites sorted by the last access date in the following order: from
Site Administrator for SharePoint 5.2.3 User Guide
Working with Site Administrator for SharePoint
53
least to most recently accessed. Note that the access date is the date when a page in the sub-site tree
was last accessed.
When navigating to a sub-site, links to specific dashboards appear. Selecting any of the given links opens
the corresponding dashboards for the selected sub-site scope.
Selecting View more in one of the displayed blocks opens a report displaying information on all sub-sites
within the current site scope. For more information, see the Sites report section.
l
Site Information - This section displays the site creation information.
Site Collection Information provides the URLs of the web application and site collection, site
administrators, size quota and content database.
l
Most Active Users - This section lists five most active users and indicates the number of hits in the
scope of the selected site including its sub-sites.
Selecting View more opens the Daily Usage report for the current site.
To change the site scope for the report, click the
icon next to the report title, and then select the
desired site using the search option in the Select site window.
Activity Report
This report provides summary information about users' activity within the site scope.
NOTE: The report displays information in the SharePoint change log. By default, the change log retains
data for 15 (SharePoint 2007) or 60 (SharePoint 2010, SharePoint 2013) days. You can configure this
setting in Central Administration. For more information, please refer to the following article:
http://msdn.microsoft.com/en-us/library/ms436733%28office.12%29.aspx.
Figure 22: Activity Report
The report contains the following information:
Site Administrator for SharePoint 5.2.3 User Guide
Working with Site Administrator for SharePoint
54
l
{Site name (URL)} - This section displays the total number of changes made within the selected
site including its sub-sites, number of users who made the changes and period over which the
changes were made.
The graph displays the number of changes within the selected site including its sub-sites daily.
l
Most Recent Changes - This section contains information on 5 recent content and security changes
within the selected site including its sub-sites.
NOTE: The following site collection level security changes are displayed for site owners:
l
create/delete a SharePoint group
l
add/remove a member to/from a SharePoint group
l
create site collection event
Selecting View more in the Content or Security block opens the Content Changes or Security
Changes report.
l
Modification Types - This section is a bar chart allowing you to compare how many updates, deletions
and additions are made within the selected site including its sub-sites.
l
Modification Ratio - This section is a pie-chart, displaying the ratio of changed and unchanged content
of the selected site including its sub-sites.
l
Site Information - This section displays the site creation information.
Site Collection Information provides the URLs of the web application and site collection, site
administrators, size quota and content database.
NOTE:The Site Collection Information is not available for site owners.
To change the site scope for the report, click the
icon next to the report title, and then select the
desired site using the search option in the Select site window.
Daily Usage Report
This report provides you with the activity details of the 5 most active users on a site/site collection over a
month's period.
Site Administrator for SharePoint 5.2.3 User Guide
Working with Site Administrator for SharePoint
55
Figure 23: Active Users Report
The report displays the following information:
l
the date when the site was visited;
l
the site visitors number;
l
the site views number;
l
the user display name (received from Active Directory) or user login;
l
the user title (received from Active Directory);
l
the user e-mail (received from Active Directory).
To change the site scope for the report, click the
icon next to the report title, and then select the
desired site using the search option in the Select site window.
Content Changes Report
This report displays all content changes made within the site scope including its sub-sites and when the
changes were made.
Site Administrator for SharePoint 5.2.3 User Guide
Working with Site Administrator for SharePoint
56
Figure 24: Content Changes Report
By default, the report displays only 20 changes. To adjust the scope, change the report. For more information,
please refer to the Site Administrator Settings section.
To change the site scope for the report, click the
icon next to the report title, and then select the
desired site using the search option in the Select site window.
Exporting Reports
The Export feature allows Information Portal administrators to export report data to the following formats:
PDF, CSV, SQL.
NOTE: Export to PDF is supported for the following reports: Enterprise, Farm Metrics, Site Metrics,
Usage, Activity.
Export to CSV is supported for the following reports: Servers, Web Applications, Content Databases, Site
Collections, Sites, Documents and Pages, Lists, Document Libraries, Site Permissions, User Permissions,
Security Changes, Daily Usage, Content Changes.
Export to SQL is supported for the following reports: Servers, Site Collections, Sites, Documents and
Pages, Lists, Document Libraries, Site Permissions, User Permissions, Security Changes, Daily Usage,
Content Changes.
To export report data to PDF format, click the PDF link.
To export report data to CSV format, click the CSV or Create CSV report link. You can also configure the report
to be exported to CSV automatically at specific times using scheduling options.
To export report data to SQL format, configure the report export using scheduling options.
NOTE: Scheduling options are available only for Information Portal administrators.
Site Administrator for SharePoint 5.2.3 User Guide
Working with Site Administrator for SharePoint
57
NOTE: You can also export report data to CSV or SQL programmatically. For more information, please
refer to the Exporting Reports Programmatically section.
In CSV file format, the information is stored as comma separated values. For each report, a CSV file will be
generated. The name of the CSV file will be the name of the report.
In SQL export format, the information is stored as SQL tables in the QSP_Repository database. For each report, a
separate table with fields same as in the report will be created:
l
Servers - dbo.sa4sp_repdata1_servers
l
Documents and Pages - dbo.sa4sp_repdata1_documents_and_pages
l
Lists - dbo.sa4sp_repdata1_lists
l
Document Libraries - dbo.sa4sp_repdata1_document_libraries
l
Site Permissions - dbo.sa4sp_repdata1_site_permissions
l
User Permissions - dbo.sa4sp_repdata1_user_permissions
l
Security Changes - dbo.sa4sp_repdata1_activity_more_Security
l
Daily Usage - dbo.sa4sp_repdata1_daily_active_users
l
Content Changes - dbo.sa4sp_repdata1_activity_more_Content
Report data is accumulated in the table with each data collection.
NOTE: The names and schema of the tables have been changed in this version of Site Administrator. You
can use SQL Views that duplicate the names and schema of SQL tables in previous version:
l
Servers - dbo.sa4sp_repdata_servers
l
Web Applications - dbo.sa4sp_repdata_webapps
l
Content Databases - dbo.sa4sp_repdata_contentdbs
l
Site Collections - dbo.sa4sp_repdata_site_collections
l
Sites - dbo.sa4sp_repdata_sites
l
Documents and Pages - dbo.sa4sp_repdata_documents_and_pages
l
Lists - dbo.sa4sp_repdata_lists
l
Document Libraries - dbo.sa4sp_repdata_document_libraries
l
Site Permissions - dbo.sa4sp_repdata_site_permissions
l
User Permissions - dbo.sa4sp_repdata_user_permissions
l
Security Changes - dbo.sa4sp_repdata_activity_more_Security
l
Daily Usage - dbo.sa4sp_repdata_daily_active_users
l
Content Changes - dbo.sa4sp_repdata_activity_more_Content
NOTE: You can export data from a generated CSV file to any SQL database table using a script included
with the product. For more information, please refer to CSV to SQL Export.
Export of report data to CSV/SQL can be run for any individual site as well as for enterprise, web application or
farm if the report is available on these scopes. For information on the supported report scopes, please refer to
Report Descriptions.
Site Administrator for SharePoint 5.2.3 User Guide
Working with Site Administrator for SharePoint
58
If you want to export report data on your whole enterprise and the report is not available on the enterprise
scope, it is recommended to write a script using the Site Administrator for SharePoint REST API.
Scheduling Report Export to CSV/SQL
Information Portal administrators are allowed to schedule reports to be exported to CSV or SQL automatically at
specific times.
To set a schedule:
l
for the report export to CSV, click the
icon next to the report title.
l
for the report export to SQL, click the
icon next to the report title.
From the drop-down menu select either of the following:
l
run the report export according to one of the predefined schedules (weekly, monthly, or quarterly).
l
customize you own schedule. By default, scheduled task for the Custom option is disabled.
Therefore, it is required to enable it and then configure the required schedule using the Scheduled
Task control panel.
l
disable the report schedule.
If any issues occur when scheduling the report export, you will see an error message at the top of the page.
Clicking the details link displays more information about the occurred error.
NOTE: If Information Portal is installed on several front-end servers, note that:
l
First Information Portal installation is considered as a master server.
l
Only Windows Scheduled Tasks executed on this server run the report export. The export
results are stored only on this master server.
l
Any scheduling adjustments using Windows Task Scheduler must be made on this master server.
l
If Information Portal was removed from the master server, scheduling will be broken. In this
case, you can either reinstall Information Portal on the master server or change the master
server by editing the NetBiosHostName column of the QMasterAgent SQL table in the
Information Portal configuration database.
NOTE: Scheduled tasks to initiate the report export to SQL and CSV are shared, i.e. if you modify custom
schedule for the report export to CSV, the report export to SQL will also run in accordance with the
new schedule.
How It Works
The process of exporting report data to CSV/SQL is initiated by the Site Administrator scheduled task on a frontend server in accordance with the specified schedule. The task executes the job which is created in the QSP_
Repository database table after you enable the report scheduling.
When exporting data to SQL, the data is first exported to CSV and then the scheduled task runs a script that
transfers CSV data to SQL server database (for more information on the script, see CSV to SQL Export). CSV files
are not deleted after report data is exported to SQL.
Site Administrator for SharePoint 5.2.3 User Guide
Working with Site Administrator for SharePoint
59
Export to SQL Performance Test Results
Performance tests were run for Documents and Pages and Site Permissions reports.
Test Results:
Documents and Pages report:
l
Content: 2 436 825 documents
l
Time taken: 7 h 20 minutes. 7 hours are taken for CSV Export ( 15.7 KB/sec, 96 items/sec); 20 minutes
are taken to import CSV to SQL (330 KB/sec, 2000 items/sec)
l
Ratio: 92 documents/sec or 15 KB/sec
l
Size: 387 MB in 13 csv files (12 MB in zip archive).
l
SQL Table size: 587 MB
Site Permissions report:
l
Content: 152 073 permissions
l
Total time: 27 minutes
l
Ratio: 93 permissions/sec or 23 KB/sec
l
Size: 36 MB (700 KB in zip archive)
Memory Usage:
l
services: each up to 100 MB of working set.
l
python32 import process: <78 MB
l
ipy64 import process: <124 MB
Hardware and Software used in test:
l
Virtual Machine: 16 GM RAM, 4 processors X5650 2.67 GHz
l
SharePoint 2010 + SQL 2008 R2
Exporting Reports Programmatically
To export report data to CSV or SQL format using API calls, perform the following:
1. Call the PUT http://server:port/<reportname>/<filetype>?[scope]&[user] method to start
the export operation. Starting the export operation initiates either the CSV/SQL update for the reports
with slow performance or cache update for the reports with fast performance.
here server is the server name of Information Portal web access, port is the port number of Information
Portal web access (default port is 3141), <filetype> is the file type to which report data will be exported:
sql or csv.
[scope] can be either of the following:
l
without scope - Enterprise level
<report_name> is one of the following:
l
contentdbs
l
webapps
Site Administrator for SharePoint 5.2.3 User Guide
Working with Site Administrator for SharePoint
60
l
l
site_collections
l
sites
l
documents_and_pages
farm=<sharepointconfig db> - Farm level
<report_name> is one of the following:
l
l
site_collections
l
documents_and_pages
l
user_permissions
webapp=<webapp url> - Web Application level
<report_name> is one of the following:
l
l
site_collections
l
documents_and_pages
l
user_permissions
url=<site_url> - Site and Site Collection level
<report_name> is one of the following:
l
sites
l
document_and_pages
l
user_permissions
l
site_permissions
l
lists
l
documents_libraries
l
daily_active_users
[user] parameter:
user=domain\name
user_permissions
Some examples of API methods:
http://server:port/webapps/csv
http://server:port/document_and_pages/csv?farm=<sharepoint config db>
http://server:port/site_collections/csv?wabapp=<wab app url>
http://server:port/site_permissions/csv?url=<siteurl>
http://server:port/user_permission/csv/?farm=<sharepoint config db>&user=<user_
name>
2. Wait until the operation is finished. To check the progress, call the GET
http://server:port/<reportname>/<filetype>/state?[scope]&[user] method with interval
5-10 seconds until it returns 100%.
Parameters of this method are the same as in the PUT method (see above).
Site Administrator for SharePoint 5.2.3 User Guide
Working with Site Administrator for SharePoint
61
Response returns in JSON format:
{"progress": 100, "actual_on": "2011-15-09 02:50", "error": "message"}
"progress" is the percentage of the export progress. Slow reports have only 0%, 50% and 100%.
"actual_on" is the date and time of the last exported file.
"error" displays a message if an error occurred, otherwise - empty string.
3. Download the result file using the following method:
GET http://server:port/<reportname>/<filetype>?[scope]&[user]
The file can be downloaded several times without executing the operation which should be used to
update the file.
Parameters of this method are the same as in the PUT method (see above).
Managing SharePoint
In this section:
l
Managing Security
l
Restructuring SharePoint Content
l
Configuring Version Settings for Document Libraries
Managing Security
Information Portal allows you to control access to site and site content (folders, documents and list items) by
adjusting users' permissions with permission management options and applying security settings.
Managing User Permissions
With permission management options you can:
l
revoke permissions
l
grant permissions
l
duplicate permissions
l
reassign permissions
NOTE: Site collection administrators can only revoke and grant permissions in the scope of the site
collections they manage. Site owners are not allowed to manage permissions.
NOTE: Information Portal needs to be installed on a front-end server in each SharePoint farm you want
to manage permissions. Otherwise, management options will fail to work.
NOTE: Make sure that scripting is enabled in your browser. Otherwise, permission management options
will fail to work.
Permission management options are available on the User Permissions or Site Permissions report page.
Site Administrator for SharePoint 5.2.3 User Guide
Working with Site Administrator for SharePoint
62
Alternatively you can access the options by selecting either the Farms, Web Applications, Site Collections or
Sites link in the Information Portal menu, and then selecting the required entity you want to manage
permissions for.
Revoking Permissions
To revoke user permissions:
1. Click the Revoke button.
Alternatively, on the Site Permissions report, navigate to the desired user record, click
select Revoke from the drop-down menu.
, and then
2. On the Confirmation dialog, click Yes to revoke user permissions.
Granting Permissions
To grant user permissions:
1. Click the Grant button. The Grant Permissions dialog appears:
Alternatively, on the Site Permissions report, navigate to the desired user record, click
select Grant from the drop-down menu.
, and then
2. In the Select Users area, specify the users to apply the permissions.
In the Select Permissions area, select the desired permission level.
NOTE: The Edit permission level introduced in SharePoint 2013 and supported by Site Administrator
cannot be granted to SharePoint 2007 and SharePoint 2010 sites. The Edit check box will be displayed in
the dialog only if you grant permissions to a SharePoint 2013 site. However, when you use the Grant
option available on the search page, the Edit check box will be displayed regardless of the site
SharePoint version. If you apply this permission level to a SharePoint 2007 or SharePoint 2010 site, it will
appear in the resulting report but the applied role will show blank space instead of Edit.
3. Click Grant.
NOTE: Permissions granted on a web application are spread to all sub-sites and lists with unique
permissions.
Duplicating Permissions
To duplicate user permissions:
1. Click the Duplicate button. The Duplicate Permissions dialog appears.
Alternatively, on the Site Permissions report, navigate to the desired user record, click , and then
select Duplicate from the drop-down menu.
2. Specify a user whose permissions you want to copy, and then the users to apply the copied permissions.
Click Duplicate.
NOTE: User permissions granted via AD group cannot be copied. But you can copy the AD group
permissions granted directly.
Site Administrator for SharePoint 5.2.3 User Guide
Working with Site Administrator for SharePoint
63
Reassigning Permissions
To reassign user permissions:
1. Click the Reassign button. The Reassign Permissions dialog appears
Alternatively, on the Site Permissions report, navigate to the desired user record, click , and then
select Reassign from the drop-down menu.
2. Specify a user whose permissions you want to reassign, and then the users to apply the permissions.
Click Reassign.
Applying Security Settingss
Site Administrator for SharePoint allows you to apply the following security settings to your sites:
l
restore broken inheritance permissions for a specific site including its sub-sites and items.
l
remove access granted to the NT Authority\Authenticated Users group within the current site
including its sub-sites.
NOTE: Only Information Portal administrators and site collection administrators can apply security
settings.
To apply security settings, open the Security dashboard for the desired site, click the Inheritance Policy or
Authenticated Users Policy tile and select either of the following:
l
Apply Once - the security setting will be applied to the site only once.
l
Set as Policy - the security setting will be applied to the site hourly. For more information, please refer
to the Policies section.
Restructuring SharePoint Content
Information Portal provides options which allow you to reorganize your SharePoint content structure within
the same farm.
NOTE: Information Portal needs to be installed on a front-end server in each SharePoint farm you want
to manage permissions. Otherwise, management options will fail to work.
NOTE: Make sure that scripting is enabled in your browser. Otherwise, permission management options
will fail to work.
NOTE: Content management options are not available for site owners.
Content management options are not available for site owners.
You can restructure you SharePoint content in the following ways:
l
copy sites
l
copy lists
Site Administrator for SharePoint 5.2.3 User Guide
Working with Site Administrator for SharePoint
64
Copying Sites
This action can be performed on any site, including the root site of a site-collection. Its entire content will be
copied to the specified destination.
1. Click the Site Collections or Sites link from the top menu of Information Portal. On the displayed page,
use check-boxes to select the sites that you want to copy.
NOTE: Sites being copied must belong to the same site collection.
2. Click the Copy Site button, and then select the destination under which you want to copy selected
sites. Use search to ease finding of the destination site.
NOTE: Note that destination sites must belong to the same farm as the source.
3. Click Copy.
As a result the content of the source site will be appended to the existing hierarchy of the destination site.
Copying Lists
1. Go to the Site Collections or Sites link from the top menu of Information Portal. Select sites whose lists
you want to copy.
NOTE: Sites you select should be from the same site collection.
2. Click the Copy List button. Select lists you want to move in the Select lists window. Click Next.
3. Select the target site you want to move the copied lists to using URL search in the Select target
site window.
4. Click Copy.
Configuring Version Settings for Document
Libraries
Versioning in document libraries enables you to track and manage information as it evolves and to view and
recover earlier versions if necessary. With Site Administrator for SharePoint you can configure version settings
for a document library within a specific site collection or site depending on your requirements. You can specify
whether to track all versions in the same way or specify that some versions are major and some are minor as
well as control how many versions are stored in a document library, which can help you to preserve server
space and prevent the version history from becoming too excessive.
NOTE: Only Information Portal administrators and site collection administrators can configure and apply
version settings.
To configure and apply version settings for a document library:
1. Go to the Content Management dashboard for the desired site and click the Version Policy tile. The
Propagate versioning settings and clean up dialog appears:
Site Administrator for SharePoint 5.2.3 User Guide
Working with Site Administrator for SharePoint
65
Figure 25: Versioning
2. Specify the required settings. The following version settings are provided:
l
No Versioning - specifies that no previous versions of documents are saved. This option is
selected by default.
l
Create major versions - specifies that numbered versions of documents are retained by using a
simple versioning scheme.
l
Create major and minor (draft) versions - specifies that numbered versions of documents are
retained by using a major and minor versioning scheme.
l
Keep the following number of major versions - specifies how many previous major versions to
keep, counting back from the current version.
l
Keep drafts for the following number of major versions - specifies how many major versions
being kept should include their respective minor versions.
3. Select either of the following:
l
Apply Once - the version settings will be applied to the site only once.
l
Set as Policy - the version settings will be applied to the site hourly. For more information, please refer
to the Policies section.
Site Administrator for SharePoint 5.2.3 User Guide
Working with Site Administrator for SharePoint
66
Policies
Site Administrator for SharePoint introduces a new way of applying a certain number of predefined rules to the
production SharePoint environment.
The policies allow you to manage:
l
Open content - prevents the use of the "NT Authority\Authenticated Users" permissions in order to
restrict access to the SharePoint items so that only the users with explicit permissions could
access them.
l
Broken inheritance - restores broken inheritance permissions for a specific site. The action involves subsites and items in the given site.
l
Version settings - sets version settings for document libraries within the specified site or site collection.
How it works:
The policy application process is run on the front-end server of every farm and initiated by the SASP_Policy_
task scheduled task on regular basis (every hour). The scheduling can be modified by updating the SASP_
Policy_task properties using Windows Task Scheduler.
NOTE: The changes in the SharePoint environment that do not match the current policy settings are not
prevented to happen when they are applied; the policy engine tracks the changes and rollbacks or
updates the settings each time the SASP_Policy_task task is run.
Site Administrator Settings
The Settings page allows you to grant additional users rights to view all Site Administrator Information Portal
reports, set the number of items to be displayed in the reports and hide management options in Site
Administrator.
To open the settings page, click the
icon in the application bar.
NOTE: The settings are not available for site owners.
Access Settings
By default, site collections administrators have access to the reports on the sites they manage. In addition, the
user account used to install Site Administrator Information Portal can access reports for the entire
environments. Information Portal allows you to grant a user full access to view all Information Portal reports.
Perform the following:
1. Open the settings page.
2. In the Access Settings section, specify the account you want to grant full access, and then click Add.
The account appears in the list below.
To delete the account from the list, click the icon
.
NOTE: You cannot delete the last user account with full access to Site Administrator for SharePoint Information Portal reports from the list.
Site Administrator for SharePoint 5.2.3 User Guide
Working with Site Administrator for SharePoint
67
Report Settings
You can adjust the number of the items (sites, documents, etc.) to be displayed in Site Administrator reports.
Perform the following:
1. Open the settings page.
2. In the Report Settings section, select the number of the items you want to be displayed in Site
Administrator reports from the drop-down list (maximum 200) and click Set.
Action and Policy Settings
Action settings allow you to control whether users can access management options, security and content
policies from Site Administrator for SharePoint. If you want to hide management options and security and
content policies in Site Administrator, uncheck the Show action buttons in Site Administrator reports box.
File Filter Settings
File filter settings allows you to specify the file types to be displayed in the Documents and Pages, Usage, Site
Metrics and Enterprise reports. Use a semicolon (;) to separate file extensions.
NOTE: Note that filter settings are not applied to CSV version of the report. Therefore, it will contain
unfiltered data.
If you want to roll back filter settings, click the Set Default button.
License
Site Administrator for SharePoint is installed with the Try Me license valid for 30 days. To update the license,
click Browse, select the path where the new license file is located, and then click Upload.
NOTE: Only Information Portal Administrators are allowed to upload a new license.
How It Works
The Information Portal workability is based on the following components:
l
Agent service
l
Broker service
l
Information Portal front-end
Agent and Broker Web Services
These services request SharePoint configuration and content databases for information about a server farm.
The Quest SharePoint Broker service searches Dell repository database for the registered agents and requests
information about the existing SharePoint structure from them. The Agent and Broker services are built on
CherryPy web server.
Site Administrator for SharePoint 5.2.3 User Guide
Working with Site Administrator for SharePoint
68
NOTE: Multiple agents installed on the farms allow you to distribute the load over the network more
efficiently. However, if one agent deployment is used, the agent still collects information on the
structure of the farms discovered by Management Console or Site Administrator for SharePoint.
Each agent can have different sets of permissions. If the enterprise installation includes several farms
and no account has administrator rights on all of them, separate administrative accounts can be used for
each farm assigned to the corresponding agent.
Information Portal Front-End
Information Portal Front-End is a user interface used to access Information Portal web services. It is built on the
highly customizable Django web server and uses templates. For integrated NTLM authentication, the Apache
service is used as an entry point to the Django web server.
Information Portal uses a self-contained Apache web server instance that does not interfere with IIS in any
way. Apache web service is designed to be used by individual applications, so you can have multiple Apache
instances running on the same box together with other web servers such as IIS with no conflicts. You just
need to make sure each IP + port number combination is only used by one web server. Information Portal
setup takes care of this: it generates a random port number and verifies it is not in use by IIS already to avoid
any possible conflict.
Collecting and Showing Report Data
As soon as you open report, the process is initiated on the Information Portal server side to collect the data for
the requested report from the SharePoint content database.
This process is not long and resource-intensive as it requests only the data needed for this particular report.
After the process is finished (expected time is from several seconds to several minutes), the page will be
refreshed with the information collected. The report data is cached on the Information Portal web server to
[ProductInstallPath]\SharePoint Information Portal\Application\database\model.db file.
The cache allows displaying the report immediately when opening it next time. There is no heavyweight data
gathering job.
Information Portal works with the SharePoint production using only SQL queries to the configuration and
content databases.
Collecting Grid Report Data
Site Administrator data gathering is a mechanism to export SharePoint data to SQL tables in the Site
Administrator repository. When gathering data for grid reports SQL queries span each SharePoint content
database, web application, site and site collection and retrieve all information about documents, pages,
content size, usage, etc. That is why the data gathering process may be resource and time consuming. To avoid
affecting your SharePoint server performance, data gathering is scheduled to run every night at 3 AM. This
scheduling takes into account that the SharePoint Usage Data job usually runs from 1 AM to 3 AM, and therefore
the latest SharePoint usage information is gathered by Site Administrator.
It takes about 6 hours for SharePoint environments with 6 million documents to complete data gathering. For
bigger SharePoint environments the data gathering process will take more time.
Site Administrator for SharePoint 5.2.3 User Guide
Working with Site Administrator for SharePoint
69
The data gathering process is initiated by the SASP_Data_Gathering_Grid_Reports_task scheduled task. Using
Windows Task Scheduler you can easily reconfigure the default scheduling to start earlier and complete data
gathering before working hours.
Site Administrator for SharePoint 5.2.3 User Guide
Working with Site Administrator for SharePoint
70
Site Administrator for SharePoint –
Security Explorer
Security Explorer for SharePoint is a feature of Dell Site Administrator for SharePoint that searches for and
modifies security on SharePoint servers. Security Explorer's graphical interface increases administrator
productivity and provides centralized control, simplifying and standardizing the management of the
security resources.
Comprehensive backup, restore, search, grant, clone and export functions take management of permissions to
new levels. Tasks that were previously either impossible or extremely difficult are now as simple as Point,
Click, Done!
NOTE: Security Explorer works with SharePoint 2007, SharePoint 2010 and SharePoint 2013.
With Security Explorer you can:
Manage Permissions
l
Instant Access to Security and Permissions - No more navigating through files, folders and registry keys
selecting Properties and trying to find the Advanced button to see a complete security list! Security
Explorer's interface allows for easy navigation of SharePoint servers, and instantly shows both assigned
and inherited permissions.
l
Comprehensive Security Management - Security Explorer lists the current security settings, and allows
full granting, modifying as well as cloning permissions on SharePoint servers.
Search
Finding security weaknesses and over-privileged users as Security Explorer lets administrators search
SharePoint Servers for specific assignments to all types of user and group, including permissions received
through inheritance, or where a user or group does not have a specific permission.
Manage Security
l
Backup and Restore Permissions - Recovery from accidental changes to security settings has never
been easier! Security Explorer can backup complete sets of permissions for files and folders, without
having to backup the data they contain. Administrators can then select any combination of files and
folders to recover those permissions, without affecting the underlying data or resources.
l
Export Security Settings in Multiple Formats - Security Explorer can export a database or spreadsheet
listing the permissions on files or folders anywhere in the directory tree.
To run Security Explorer, select Start | Programs | Dell | Site Administrator for SharePoint |
Security Explorer.
Managing Objects
Dell Site Administrator for SharePoint - Security Explorer allows you to:
Site Administrator for SharePoint 5.2.3 User Guide
Site Administrator for SharePoint – Security Explorer
71
l
Manage your SharePoint
l
Manage SharePoint Permissions
l
Manage Favorites
Managing Your SharePoint
To use Dell Site Administrator for SharePoint - Security Explorer's functionality you need to install SharePoint
Web Service on your target server.
You can then perform the following:
l
Modify SharePoint authentication
l
Manage SharePoint groups
l
Modify SharePoint properties
l
Preview SharePoint objects
Working with SharePoint Web Service
To access the security for a selected SharePoint site, you must install the Web Service on the target server.
The first time you select a SharePoint server in the Navigation pane, you are prompted to install a web service.
To install the service, perform the following:
1. Select a SharePoint server in the Navigation pane.
2. The SharePoint Web Service Installation box displays the name of the selected server in the
Server Name box.
Figure 26: SharePoint Web Service
1. Click Install. The Remote Setup box displays the installation progress.
2. Click Close.
Site Administrator for SharePoint 5.2.3 User Guide
Site Administrator for SharePoint – Security Explorer
72
To remove the SharePoint Web Service, right-click the SharePoint server in the Navigation pane, and then
choose Remove SharePoint Web Service.
Modifying SharePoint Authentication
If SharePoint Authentication fails, the SharePoint Authentication box displays an error message, and provides
the opportunity to view the details of the error, to change and save credentials, and to edit the base URL.
To edit the base URL, perform the following:
1. Click Edit URL. The base URL displays at the top of the box.
2. In the box, type text to add to the end of the URL that displays. To view the new URL, click Preview.
NOTE: The following options are available:
l
Connect securely (using https) - Select this option to use https in the URL instead of http.
l
Include port number - Select this option to include the port number in the URL. To change the
port, click Change Port, type the port number, and then click OK.
Managing SharePoint Groups
Select a group in the Permissions pane, and then click
. The SharePoint Groups box displays the
currently selected group name, description, the owner, and members.
You also can select a group from the drop-down list, or click
to locate a SharePoint group.
Table 2: Manage SharePoint Groups Options
Button
Description
New Group
Create a new SharePoint group.
Delete Group
Delete the displayed SharePoint group.
New Member
Add a new member to the displayed SharePoint group.
Delete Member
Delete a member from the displayed SharePoint group.
Modifying SharePoint Properties
To modify SharePoint properties, perform the following:
1. Select a SharePoint server in the Navigation pane. The items for the SharePoint server display in the
Objects pane.
Alternatively, choose Properties from the Tools
2. Select an item in the Objects pane, and then click
menu, or right-click the item, and then choose Properties from the shortcut menu. The Properties
window for the selected item appears.
Previewing SharePoint Objects
For SharePoint sites/webs and lists, you can display a web browser in place of the Objects pane.
Site Administrator for SharePoint 5.2.3 User Guide
Site Administrator for SharePoint – Security Explorer
73
Perform the following:
1. Select a SharePoint site/web or list in the Navigation pane.
The Objects pane is replaced by a web browser and the SharePoint page for the selected
2. Click
object displays.
To hide the preview and redisplay the Objects pane, click the Preview icon again.
Managing SharePoint Permissions
Dell Site Administrator for SharePoint - Security Explorer allows you to manage your SharePoint permissions in
the following ways:
l
view permissions
l
grant permissions
l
clone permissions
l
modify permissions
l
modify permission levels
l
delete permissions
l
backup permissions
l
restore permissions
l
export permissions
Viewing SharePoint Permissions
There are three ways to select a SharePoint server.
NOTE: The first time you select a SharePoint server, you are prompted to install the SharePoint Web
Services. See the *Working with SharePoint Web Service* section.
NOTE: If the Always open authentication dialog check box is selected on the SharePoint tab of the
Options dialog box, the SharePoint Authentication box appears. Enter the necessary credentials, and
then click OK.
l
Expand Network Neighborhood in the Navigation pane to view a list of all sites for a selected server,
including the Central Administration site.
l
Type a URL in the Path field, and then click Set. A new root node is created in the Navigation pane.
l
Type a URL in the Path field, and then click Go. The site is added automatically to the Favorites list.
NOTE: Only root SharePoint sites can be added to the Favorites list. If you want to display sub-sites,
lists, or other items, use one of the other two methods.
The Objects pane displays the sites, subsites, lists, and items, such as documents, calendar items, and events,
for the selected server. Select an object to view its permissions in the Permissions pane.
Site Administrator for SharePoint 5.2.3 User Guide
Site Administrator for SharePoint – Security Explorer
74
Granting Permissions
You can grant permissions to users and groups without affecting any other user's permissions. First, choose the
permissions to grant, and then select a user or group. You can grant different permissions for several users and
groups with one operation.
To grant permissions, perform the following steps:
1. Select an item in the Navigation pane. Alternatively, type a path in the Path box, and then click Go.
NOTE: Typing a URL in the Path box, and then clicking Go, adds the URL to the Favorites list.
2. Select an object in the Objects pane or a permission in the Permissions pane, and then click
or
. Alternatively, choose Grant Permissions from the Security menu, or right-click the
object or permission, and then choose Grant Permissions from the shortcut menu.
The Grant SharePoint Permissions dialog box displays the path, and the associated groups and users for
the current object.
3. Select the groups and users to apply the permission. There are a variety of ways to select
groups and users.
To select a group or user, you can choose from the Groups and Users list in the left pane, or from the
list in the right pane. The selected group or user displays in the Group/User box and the currently
applied permission displays in the Permission box.
NOTE: If you want to apply the same permission to several groups and users, select the permission
settings first, and then double-click the groups and users in the left pane. The groups and users are
added to the List of users and groups to grant list with the selected permission settings.
NOTE: During loading the Reload button becomes a Stop button. If loading is taking too long, you can
click Stop. You can show or hide the Stop button on the View menu.
NOTE: To filter the list in the left pane, you can type a server name or base path in the box, and then
click Set. To return the full list to view, click Reset. The list returns to full view the next time you open
Grant Permissions.
l
To change to another domain or to the local computer, select the domain or the local computer
from the List Names From list.
l
To display users in the list, click Show Users. To return the list to show only groups,
click Refresh.
l
To add a group or user not included in the current Names list, click Advanced User Selection.
l
To select a group/user who is not displayed, type a name or click Advanced User Selection.
4. From the Permission list, select the permissions to grant. The options are:
l
Full Control
l
Design
l
Manage Hierarchy
Site Administrator for SharePoint 5.2.3 User Guide
Site Administrator for SharePoint – Security Explorer
75
l
Approve
l
Contribute
l
Read
l
View Only
l
Limited Access
5. From the Action list, select whether to replace or add to the group/user's current permissions.
6. To add the group/user to the List of users and groups to grant list, click Add. The selection is added
to the list.
Figure 27: Granting Permissions
NOTE: To add a selected group or user automatically to the List of users and groups to grant list with the
selected permission settings, you can hold down CTRL or SHIFT, and then click a group or user in the top
pane; or double-click a group or user in the left pane.
To remove a selected user or group from the list, click Remove.
NOTE: Only users and groups in the List of users and groups to grant list are affected by the grant
action. You can sort each column by clicking the column heading. To remove a selected user or group
from the list, click Remove.
7. Click OK. The Granting Permissions box displays the progress.
Site Administrator for SharePoint 5.2.3 User Guide
Site Administrator for SharePoint – Security Explorer
76
Cloning Permissions
The Clone feature allows you to copy individual permissions. To clone an existing permission, perform
the following:
1. Select an object in the Objects pane or a permission in the Permissions pane, and then click
or
.
Alternatively, choose Clone Permissions from the Security menu, or right-click the object, and then
choose Clone Permissions.
The Clone SharePoint Permissions dialog box opens to the Manual User/Group Selection tab and
displays the path to the selected object and the associated groups and users.
2. In the Source Group or User area, select the domain or object from which to pull the permissions. The
default is the current object, whose path displays in the top box.
In the Destination Group or User area, select the domain or object to receive the cloned permissions.
The default is the current object, whose path displays in the top box.
3. Click Add. The selected pair displays in the List of users and groups to clone list.
Figure 28: Cloning Permissions
NOTE: The following options are available:
Site Administrator for SharePoint 5.2.3 User Guide
Site Administrator for SharePoint – Security Explorer
77
l
Replace source permissions with destination permissions - Select this option to change the
source permissions to match the destination permissions.
l
Include protected folders and files when cloning (files and folders with 'Inherit Permissions
from Parent' disabled) - Select this option to include those files and folders for which the Allow
inheritable permissions from parent to propagate to this object check box is unavailable.
NOTE: Only users and groups in the List of users and groups to clone list are affected by the clone
action. You can sort each column by clicking the column heading.
4. Click OK. The Cloning Permissions box displays the progress.
Modifying Permissions
You can modify the permissions of a group or user on the selected folder or file. Use for quick changes to
someone who is already in the list. Use the Grant feature to give permissions to accounts that are not in the
permissions list already.
NOTE: You cannot modify inherited permissions directly. Inherited permissions are indicated by
|permissions| in the Type column. To modify these permissions, you must modify the parent object.
To modify permissions, perform the following steps:
or
. Alternatively, you
1. In the Permissions pane, select a permission, and then click
can right-click the permission, and then choose Modify Permissions; or choose Modify Permissions from
the Security menu. The SharePoint Permission dialog box displays the current permission settings.
2. From the Permissions list, select the permission. Permissions in bold cannot be modified.
Site Administrator for SharePoint 5.2.3 User Guide
Site Administrator for SharePoint – Security Explorer
78
Figure 29: Modifying Permissions
NOTE: To modify the permission levels, click Permissions Levels.
3. Click OK.
Modifying SharePoint Permissions Levels
. The SharePoint
1. In the Objects pane, select a SharePoint object, and then click
Permission Levels dialog displays the selected object, its owner, and the current permissions.
Figure 30: SharePoint Permissions Levels
Button
Description
New
Create a new Permission Level
Delete
Delete selected Permissions Levels
Select All
Select all displayed check boxes
Clear All
Clear all the displayed check boxes
Site Administrator for SharePoint 5.2.3 User Guide
Site Administrator for SharePoint – Security Explorer
79
Deleting Permissions
NOTE: You cannot delete inherited permissions, which are indicated by |permissions| in the Type
column of the Permissions pane. Navigate up the directory tree to locate the parent, and then
continue with the delete process.
To delete permissions, perform the following:
or
. Alternatively,
1. In the Permissions pane, select the permission(s), and then click
you can right-click the selected permission(s), and then choose Delete Permission; or choose Delete
Permission from the Security menu.
NOTE: If a permission is not selected when you click or |delete button|, the currently selected object
(folders, files, registry keys, or services) is deleted.
A warning box appears.
NOTE: Selecting the Force deletion down entire tree (including protected objects) option allows you
to delete the selected permission(s) down the directory tree even if a file or folder is protected.
2. To delete the permission(s), click Yes.
Backing Up Permissions
Before modifying any security permissions, make a backup in case you need to restore the permissions to their
original state. You also can back up permissions on files for which you don't have access. As long as you are an
administrator, or have the Backup files and directories user right, you can back up and restore permissions on
all files, which is helpful when backing up and restoring a user's home directories.
You can backup your permissions manually, or use a backup scheduler to run the backup at a set time.
Perform the following steps to backup manually:
.
1. From the Navigation or Object pane, select an object to back up, and then click
Alternatively, select Backup Security from the Security menu, or right-click an object, and then
select Backup Security.
NOTE: Acceptable objects are volumes, folders, or shares. Files cannot be backed up individually, but
can be backed up within the parent folder.
The Backup Security dialog box appears with the selected objects displayed in the Path list box.
to locate a path and name the backup file (Security Explorer
2. In the Backup File Name box, click
SharePoint Backup File has the * .spb extension).
3. To back up the selected paths, click Backup Security. The Backing Up Permissions box displays
the progress.
Perform the following steps to schedule a backup:
1. From the Backup Security dialog box, use the Backup Scheduler section and type a name for the job in
the Job Name box, and then click Schedule.
2. The Schedule a Backup box opens. If the backup paths are local, Create single scheduled task on local
machine is selected. The Job Name, Wildcard, and Backup Name carry over from the previous screen.
Site Administrator for SharePoint 5.2.3 User Guide
Site Administrator for SharePoint – Security Explorer
80
3. In the Account box, click |dots| to locate an account under which to run the backup. If you do not enter
an account, the backup runs under the local system account.
4. To schedule the task, click Schedule. The task is assigned the default run time of Weekly, every Monday
at midnight.
NOTE: To change the run time, edit the backup using the Backup Scheduler.
Errors that occur during the task are captured in the Windows Event Log.
Using the Backup Scheduler
The Backup Scheduler provides a convenient place in which to create, edit, and delete backup jobs.
. Alternatively, select Backup Scheduler from the Security menu, or right-click an object, and
1. Click
then select Backup Scheduler from the shortcut menu. The Backup Scheduler Task List box lists the
currently defined backup jobs in ascending alphabetical order by computer name.
2. To sort the columns, click the column heading once for ascending order and again for descending order.
3. To create a new backup job, click New. The Backup Security dialog box opens where you can create a
new backup job.
4. To edit a selected backup job, click Edit. The Backup Security dialog box opens where you can make
changes to the backup job
5. To delete a selected backup job, click Delete. A warning message appears. To continue with the
deletion, click Yes.
Restoring Permissions
You can restore your permissions from a backup file created by using the Backup function. You can restore
some or all of the backup files. Prior to initiating the restore process, you can verify the permissions against the
current permissions.
To restore security, perform the following:
. Alternatively, choose Restore Security from the Security menu, or right-click an object, and
1. Click
then choose Restore Security from the shortcut menu.
2. In the Backup File Name box, type the full path and name for the backup file, or click Load to locate a
backup file. The contents of the backup file display in the left pane.
3. Expand the backup file and examine the contents. You can choose specific objects to restore by
selecting the box next to the object.
4. Click Restore. The Restoring Permissions box displays the progress.
Exporting Permissions
To export SharePoint permissions, perform the following:
1. Select the type of group or user in the Navigation pane, or select a single group or user in the Objects
pane, and then click
.
Site Administrator for SharePoint 5.2.3 User Guide
Site Administrator for SharePoint – Security Explorer
81
Alternatively, right-click a type of group of user in the Navigation pane or anywhere in the Objects
pane, and then choose Export from the shortcut menu. The Export box displays the selected type of
group or user.
By default, the Save to Microsoft Excel(R) Spreadsheet radio box is checked. Group and user
information can be saved only to a delimited file for use with Microsoft Excel. Select either Commadelimited file (.CSV) or Tab-delimited file (.TXT).
2. Click to locate a destination for the file.
3. To export the data in the specified format, click OK.
Managing Favorites
You can add frequently-accessed sites (prefixed with http:// or https://) and computers (prefixed with \) to a
list of favorites.
You can add an object to the Favorites list as you are browsing, or, if you know what objects you want in your
Favorites list, you can use the Manage Favorites function to add them all at once.
Similarly, you can remove Favorites one at a time or in batches. Removing an object from the Favorites list does
not remove the object from the system.
Adding Favorites While Browsing
While you are browsing, you can add objects quickly to the Favorites list:
. Alternatively, choose Add to Favorites from the Tools menu, or
1. Select the object, and then click
right-click an object, and then choose Add to Favorites from the shortcut menu. The Add to Favorites
box opens showing the selected path in the New Favorites list.
l
To add additional paths to the New Favorites list, click Browse, and then select a path; or type a
path in the Path box, and then click Add.
l
To remove a selected path from the New Favorites list, click Del.
l
To remove all paths from the New Favorites list, click Clear.
Site Administrator for SharePoint 5.2.3 User Guide
Site Administrator for SharePoint – Security Explorer
82
Figure 31: Adding Favorites
Adding Favorites
You can add Favorites using the Manage Favorites option:
or choose Manage Favorites from the Tools menu. The Manage Favorites (All types) box lists
1. Click
the objects in the Favorites list.
2. Click New. The Add to Favorites box opens.
3. You can add objects one at a time by typing a path in the Path box, and then clicking Add. Repeat as
many times as necessary.
To add multiple objects while browsing, click Browse. The Add (All Types) box appears. Select the
objects, and then click OK.
l
To remove a selected path from the New Favorites list, click Del.
l
To remove all paths from the New Favorites list, click Clear.
4. Click OK. The object[s] appears under the Favorites heading in the Navigation pane.
Removing Favorites
NOTE: Removing an object from the Favorites list does not delete the object from the system.
To remove an object from the Favorites, perform one of the following:
Site Administrator for SharePoint 5.2.3 User Guide
Site Administrator for SharePoint – Security Explorer
83
l
Right-click the object in the Navigation pane, and then choose Remove from Favorites from the
shortcut menu.
l
Click
or choose Manage Favorites from the Tools menu. The Manage Favorites (All types) box lists
the objects in the Favorites list.
l
Select the object, and then click Remove. A warning message will appear. To remove the
object, click Yes.
Managing Enterprise Scope
An Enterprise Scope is grouping of sites, similar to a folder that contains multiple files, on which you can
manipulate permissions. Use Enterprise Scopes to organize sites into logical groups so that you can more easily
manage the permissions associated with these objects.
There are two ways to create an Enterprise Scope. As you are navigating through the Navigation and Object
panes, you can select an object and add it to an Enterprise Scope. You also can create Enterprise Scopes
through the Manage Enterprise Scopes feature, which is an efficient method for creating multiple scopes in an
organized manner.
Creating an Enterprise Scope While Browsing
When you are navigating through the Navigation and Object panes, you can create an Enterprise Scope quickly
by selecting an object and then adding it to a scope.
. Alternatively, choose Add to
1. Select a site in the Navigation or Objects pane, and then click
Enterprise Scope from the Tools menu, or right-click a site object, and then choose Add to
Enterprise Scope.
The Enterprise Scope box displays the path to the selected site in the Paths box. Select one of the
following options:
l
Add to existing Enterprise Scope - Select to add the URL displayed in the Paths box to an
existing Enterprise Scope, and then select an Enterprise Scope from the Name list. Available
only if at least one Enterprise Scope exists.
l
Create and add to existing Enterprise Scope - Select to create a new Enterprise Scope for the
URL displayed in the Paths box, and then type a name for the scope in the Name box.
l
Edit contents of enterprise scope - Select to open the Manage Enterprise Scope dialog box
where you can edit or remove URLs from the Enterprise scope.
2. Click OK.
If you did not select the Edit contents of enterprise scope check box, the scope appears under
Enterprise Scope in the Navigation pane.
If you selected the Edit contents of enterprise scope check box, the Edit Enterprise Scope box
appears where you can add more paths to the scope.
Creating an Enterprise Scope
If you have several Enterprise Scopes to define, creating the scopes through the Manage Enterprise Scope
feature is efficient.
Site Administrator for SharePoint 5.2.3 User Guide
Site Administrator for SharePoint – Security Explorer
84
. Alternatively, choose Manage Enterprise Scope from the Tools menu. The Manage
1. Click
Enterprise Scope dialog box lists the existing Enterprise Scopes for the selected module.
2. Click New. The Create Enterprise Scope box opens.
3. In the Name box, type a name for the Enterprise Scope, and then click OK. The Enterprise Scope is
listed in the Manage Enterprise Scope box.
4. Select the Enterprise Scope, and then click Edit. The Edit Enterprise Scope list box appears.
5. To add a URL, click Browse, and then select a URL; or type a URL in the Path box, and then click Add.
Repeat as many times as necessary.
6. Click OK.
Editing an Enterprise Scope
1. Click
. Alternatively, choose Manage Enterprise Scope from the Tools menu.
2. Select an Enterprise Scope, and then click Edit. The Edit Enterprise Scope box displays the paths
currently assigned to the selected Enterprise Scope.
3. To add a URL, click Browse, and then select a URL; or type a URL in the Path box, and then click Add.
4. To remove a selected URL from the Name list, click Del.
5. To remove all paths from the Name list, click Clear.
6. When you are finished editing, click OK to apply the changes.
Removing an Enterprise Scope
1. Click
. Alternatively, choose Manage Enterprise Scope from the Tools menu.
2. Select the Enterprise Scope[s] to remove, and then click Remove. A confirmation message appears. To
remove the selected Enterprise Scope[s], click Yes.
Searching For Permissions
Searching is a very powerful tool to analyze your user's permissions and close hard-to-find security holes.
Simply choose a group or user, and a set of permissions to search for, and begin your search. When the search
results display, you can click on any files or directories in your search results to modify their permissions
immediately.
1. In the Navigation pane, open the Search tab. Alternatively, you could open a new Search window by
choosing Add Search Scope from the Search menu.
2. Select a Search Scope. For more information please refer to Adding a Search Scope.
Adding a Search Scope While Browsing
While you are browsing in the Navigation or Objects pane, you can select a path, and then add it automatically
to a Search Scope.
Site Administrator for SharePoint 5.2.3 User Guide
Site Administrator for SharePoint – Security Explorer
85
NOTE: If you want to create a more complex Search Scope with multiple paths, use the Add Search
Scope function.
To add an object to a Search Scope, right click an object in the Navigation or Objects pane, and then
choose Search in a New Window from the shortcut menu. The selected object is added automatically to a
Search Scope.
Adding a Search Scope
Use this process when you want to create complex Search Scopes that may have multiple paths.
NOTE: You can quickly add a single path to a Search Scope while you are browsing in the Navigation and
Objects pane.
Perform the following steps:
1. In the Navigation pane, open the Search tab. Alternatively, you could open a new Search window by
choosing New Search Window from the Search menu.
2. Click Add Search Scope. The Add Search Scope box appears.
3. Select from the tree, or type a location in the box. If you enter a location, you must select a type:
Domain, Computer, AD Forest, AD OU.
Figure 32: Adding Search Scope
4. Click OK. The scope displays in the Search tab.
Site Administrator for SharePoint 5.2.3 User Guide
Site Administrator for SharePoint – Security Explorer
86
Searching for SharePoint Objects
To search for SharePoint objects, complete the following steps:
1. In the Navigation pane, open the Search tab. Alternatively, you can open a new Search window by
choosing New Search Window from the Search menu.
2. Select a Search Scope.
or Advanced User Selection to browse
3. Type a group or user name in the Group/User box, or click
for a group or user. The selected group or user displays in the Group/User box.
Figure 33: Group/User Search Criteria
Setting Permission Search Criteria
By default, inherited and explicit permissions are included in the search.
1. From the Search dialog box, open the Permission Search Criteria tab.
2. Choose what permissions to search.
Figure 34: Permission Search Criteria
Site Administrator for SharePoint 5.2.3 User Guide
Site Administrator for SharePoint – Security Explorer
87
NOTE: The following options are available:
l
Inherited Permissions - Select this option to include inherited permissions in the search results.
Inherited permissions are indicated by (I) in the Type column.
l
Explicit Permissions - Select this option to include explicit permissions in the search results.
Setting SharePoint Search Criteria
By default, a search includes site, list, and item permissions for all contents.
1. Click
to scroll right, if necessary. Open the SharePoint Search Criteria tab.
2. Choose whether to search sites, lists, and/or item permissions. You can choose to recurse across all
contents or to a specific depth.
Figure 35: SharePoint Search Criteria
NOTE: The following options are available:
l
Search for site permissions - By default, site permissions are included in the search. To remove
site permissions from the search, clear the check box.
l
Search for list permissions - By default, list permissions are included in the search. To remove
list permissions from the search, clear the check box.
l
Search for item permissions - By default, item permissions are included in the search. To
remove item permissions from the search, clear the check box.
l
Recurse all contents - By default, all contents are included in the search results.
l
Recurse to Depth - Select this radio button to include contents to the depth specified in the
box. The default depth is 1, which is one level below the selected object.
Starting the Search
Now that you defined the search scope and criteria, you can start the search.
To start the search, click Start Search. The results will be displayed in the Search Results area. The status bar
displays the number of objects searched and permissions/services/tasks found.
Site Administrator for SharePoint 5.2.3 User Guide
Site Administrator for SharePoint – Security Explorer
88
NOTE: To stop the search, click Stop. To clear the results, click Clear Results.
Within the Search Results area when searching for permissions, you can use the buttons along the bottom, the
toolbar icons, or the menus to grant, revoke, clone, modify, delete, or print the permissions.
NOTE: The Automatically update results option allows you to automatically update the search results
after you select to grant, revoke, clone, replace, modify, or delete a permission.
Saving Search Results
You can save the results of a search to a Security Explorer Search Results (* .txt) file. The search criteria and
scope are not saved. To save search criteria and scope, see Saving Search Criteria.
To save search results, perform the following steps:
1. Right-click in the Search Results area, and then choose Save Search Results from the shortcut menu.
2. In the Save As box, locate a folder, type a name for the file, and then click Save. You can open the
Security Explorer Search Results (* .txt) file in any word processing application.
Saving Search Criteria
You can save search criteria and scope for use at a later time. The actual search results are not saved. To save
search results, see Saving Search Results.
To save search criteria, perform the following steps:
1. After defining the search criteria and search scope, click Save. The Save Search box appears.
2. In the Name box, type a name for the search. In the Description box, type an optional description which
may be helpful if you have multiple user searches.
3. Click OK. The search appears under User Searches in the Saved Searches area.
Customizing Security Explorer
You can use the following to customize Security Explorer:
l
General options
l
Advanced options
l
SharePoint options
Setting General Options
To set General options, select Options from the Tools menu, or click
General tab. Select the options you want and click OK.
. The Options dialog box opens to the
In the Reload at Startup area the following options are available:
l
Window state (size and view menu entries) - Select this option to restore the size of the Security
Explorer window and view the menu entries. Clear to use the standard size and center the Security
Site Administrator for SharePoint 5.2.3 User Guide
Site Administrator for SharePoint – Security Explorer
89
Explorer window on your display (default).
In the Modifying Permissions area the following options are available:
l
Always display progress dialog
l
Display progress dialog for long operations only
l
Never display progress dialog
Select one of these options to manage the display of the progress dialog when you modify permissions
Choosing to display the progress dialog for long operations only (default) or to never display the progress
dialog may help with memory management.
l
Auto-close progress dialog on completion - Select this option to always close the progress dialog box
upon completion of a process, such as granting or cloning.
l
Perform an inheritance check after creating new folders - Select this option to always perform an
inheritance check and repair after creating new folders, select the.
In the Logging area the following options are available:
l
Log all security changes - Select this option to log all permission changes to the selected root path
displayed in the Folder box. Click
to locate the root folder. Only information about the selected
root path is logged; no information about changes to sub-items is logged.
l
Show detailed error messages - Select this option to show detail for error messages in the log file.
Setting Advanced Options
To set Advanced options, select Options from the Tools menu, or click
. The Options dialog box opens to
the General tab. Go to the Advanced tab, select the options you want and click OK.
In the Domains and Computers area the following options are available:
l
Load domain computers, groups and users using Active Directory - By default, Security Explorer loads
domain computers, groups and users using Active Directory.
l
Include unknown computers when browsing/searching domains - Select this option to include
unknown computers in the Navigation pane.
l
Highlight domain controllers when browsing domains - Select this option to display domain controller|
next to domain controllers.
l
Highlight workstations and servers when browsing domains - By default, the servers are identified by
next to the server name, and workstations are identified by
next to the workstation name. If you
clear the Highlight workstations and servers when browsing domains check box, both servers and
workstations are identified by .
l
Auto-detect computers which are members of a cluster - Select this option to automatically select
the Show Cluster File Shares check box when browsing computers that are members of a cluster. If
selected, a warning message displays when you click OK. Click Yes to verify the selection.
l
Check connection before loading (Ping) - Select this option to ping computers before loading. If a
computer is unavailable, a warning message appears. The default time-out is set to 1,500 ms. By
default, Security Explorer does not check the connection, which could cause a response delay if that
computer is unavailable.
In the Cache Options (Browsing) area the following options are available:
Site Administrator for SharePoint 5.2.3 User Guide
Site Administrator for SharePoint – Security Explorer
90
l
Use cache when browsing - By default, if the user browses to a path, such as c:\windows, the contents
of c:\windows is stored in the cache as one entry. You can set the cache up to 250 entries in the Size
(entries) box. Clear the Use cache when browsing check box to always reload information from the disk.
l
Do not use cached entries older than - By default, the age of the cache entry is examined prior to
loading a path. By default, entries older than 3 hours are reloaded from the disk. You can set the value
in the Period (hours) box up to 24 hours.
If the user revisits a path, the age of the cached entry is inspected to determine if the path is loaded
from the cache or disk.
l
If the age of the cache entry is less (younger) than the value set in the Period (hours) box, the
entry is reloaded from the cache.
l
If the age of the cache entry is greater (older) than the value set in the Period (hours) box, then
the cache entry is removed and the entry is reloaded from disk.
To load the contents of c:\windows from the disk regardless of the age of the entry in the cache,
click Reload.
l
View indicator when items loaded from cache - By default,
displays next to items loaded from the
cache. CACHE displays in the status bar. Clear to remove the indicator from display.
In the Thread Count area, enter a value in the type box to modify the number of searches and process
operations that will run concurrently (by default, up to 10 searches and some process operations can run
concurrently).
Setting SharePoint Options
To set SharePoint options, select Options from the Tools menu, or click . The Options dialog box opens to the
General tab. Go to the SharePoint tab, select the options you want and click OK.
In the SharePoint Options area the following options are available:
·Download SharePoint Icons when Browsing - By default, icons representing each SharePoint object display
next to each item. These icons are downloaded automatically from the SharePoint site. To remove the icons
and use simpler default icons, clear the check box.
In the Default SharePoint Credentials area the following options are available:
l
Use Windows Authentication - By default, Security Explorer uses Windows Authentication when
connecting to a SharePoint server.
l
Always open authentication dialog - Select this option to display the open authentication dialog box
when connecting to a SharePoint server.
l
Use alternate credentials list - Select this option to use the alternate credentials list when connecting
to a SharePoint server. Security Explorer tries each account in the order they appear in the list until an
account is found with sufficient privileges. If no account is found, Access Denied is displayed.
To add alternate credentials:
1. In the Account box, type an account name, or click to select an account.
2. In the Password and Confirm boxes, type the password.
3. Click Add. Security Explorer uses the accounts in the order listed in the Alternate Credentials list.
To delete a name from the list, click Del.
Site Administrator for SharePoint 5.2.3 User Guide
Site Administrator for SharePoint – Security Explorer
91
To clear all names from the list, click Clear.
To remove all saved and alternate SharePoint credentials, click Reset All. A message box asks for confirmation.
Site Administrator for SharePoint 5.2.3 User Guide
Site Administrator for SharePoint – Security Explorer
92
Site Administrator for SharePoint
REST
Site Administrator for SharePoint REST API allows you to programmatically access and update your SharePoint
2007 and 2010 data with an easy to use JSON API over HTTPS.
Request and Response Format
The request and response format for all requests and responses is a JSON object.
REST Resources and URL Structure
Urls for a Site Administrator for SharePoint REST API resource have the following structure:
HTTP://[SERVER]:[PORT]/api/resource_name
Here [SERVER] is the Information Portal web access server, [Port] is the port number and resource_name
identifies the required resource. For more information on the REST resources, please refer to REST Resources.
REST Resources
This section describes every REST resources of the Site Administrator for SharePoint API:
l
GET /farms
l
PUT /farms
l
GET /farms/actual_on
l
GET /servers
l
PUT /servers
l
GET /servers/actual_on
l
GET /sitecollections
l
PUT /sitecollections
l
GET /sitecollections/actual_on
l
GET /sites
l
PUT /sites
l
GET /sites/actual_on
Site Administrator for SharePoint 5.2.3 User Guide
Site Administrator for SharePoint REST
93
l
GET /site/common_info
l
PUT /site/common_info
l
GET /site/common_info/actual_on
l
GET /content/site_info
l
PUT /content/site_info
l
GET /content/site_info/actual_on
l
GET /content/lists
l
PUT /content/lists
l
GET /content/lists/actual_on
l
GET /content/doclibs
l
PUT /content/doclibs
l
GET /content/doclibs/actual_on
l
GET /storage_growth
l
PUT /storage_growth
l
GET /storage_growth/actual_on
l
GET /space_distribution
l
PUT /space_distribution
l
GET /space_distribution/actual_on
l
GET /alerts
l
PUT /alerts
l
GET /alerts/actual_on
l
GET /security/counters/unique_perms
l
PUT /security/counters/unique_perms
l
GET /security/counters/unique_perms/actual_on
l
GET /security/counters/ad_objs
l
PUT /security/counters/ad_objs
l
GET /security/counters/ad_objs/actual_on
l
GET /security/counters/open_content
l
PUT /security/counters/open_content
l
GET /security/counters/open_content/actual_on
l
GET /security/counters/sp_groups
l
PUT /security/counters/sp_groups
l
GET /security/counters/sp_groups/actual_on
l
GET /usage
l
PUT /usage
l
GET /usage/actual_on
Site Administrator for SharePoint 5.2.3 User Guide
Site Administrator for SharePoint REST
94
l
GET /usage/counters/unused_pages
l
PUT /usage/counters/unused_pages
l
GET /usage/counters/unused_pages/actual_on
l
GET /document/counters/docs_and_pages
l
PUT /document/counters/docs_and_pages
l
GET /document/counters/docs_and_pages/actual_on
l
GET /activity/changes
l
PUT /activity/changes
l
GET /activity/changes/actual_on
l
GET /activity/users/most_active
l
PUT /activity/users/most_active
l
GET /activity/users/most_active/actual_on
l
GET /schedule/report
l
PUT /schedule/report
l
DELETE /schedule/report
l
POST /job/disallow_everyone
l
DELETE /job/disallow_everyone
l
GET /job/disallow_everyone
l
POST /job/propagate_version_settings
l
DELETE /job/propagate_version_settings
l
GET /job/propagate_version_settings
l
POST /job/restore_broken_inheritance
l
DELETE /job/restore_broken_inheritance
l
GET /job/restore_broken_inheritance
Site Administrator for SharePoint 5.2.3 User Guide
Site Administrator for SharePoint REST
95
GET /farms
NOTE: This method is available only for Information Portal administrators.
Table 3: GET /farms
Description
Query String
returns information on farms
including top biggest web
applications and content databases
within the enterprise or farm
scope.
l
l
Returns
farm=[FARM_ID], where [FARM_ID]
is the farm URL. If this parameter is not
specified, you will get information
about all farms within your whole
enterprise scope.
limit=[LIMIT], where [LIMIT] is a
parameter, which specifies how many
records should be returned. By
default, it is set to 10.
l
200 - OK.
l
401 Unauthorized.
l
500 - Internal
Server Error.
Error details
are in
response body
Example:
curl --user satestlab\\administrator 1 http://infoportal:3141/api/farms // enterprise
curl --user satestlab\\administrator 1 http://infoportal:3141/api/farms?id=Sharepoint_
[email protected] // farm
Response body example
{
"actual_on": "08/07/2012 02:06:39 AM", // time when data was cached
"estimation_time": 0, // estimated time(in seconds) to update the cache
data":
{
"SitesCount": 30, // total Sites count for all farms
"TLSCount": 10, // total Site Collections count for all farms
"WebAppCount": 2, // total Web Applications count for all farms
"FarmCount": 1, // farms number
"Size": 123553324, // total size of the farm content
"Farms":
[
{
"CentrlAdminUrl": "http://arthur10:10000", // SharePoint Central Administration URL
"SQLConfigDB": "SharePoint_Config", // SQL Config database name
"Created": "Dec 27 2010", // date when the farm was created
"SQLHost": "ARTHUR10", // Database Server host name
"SPVersion": "14.0.4762.1000", // SharePoint version
Site Administrator for SharePoint 5.2.3 User Guide
Site Administrator for SharePoint REST
96
"LastContentChange": "12,08,03,02,44", // date and time when farm content was
last modified
"SitesCount": 30, // total Sites count for the current farm
"TLSCount": 10, // total Site Collections count for the current farm
"WebAppCount": 2, // total Web Applications count for the current farm
"ContentDBCount": 3, // total Content Databases count for the current farm
"Size": 123553324 // total Content size of the current farm
}
],
"WebApps":
[
{
"CentrlAdminUrl": "http://arthur10:10000", // SharePoint Central Administration URL
"TLSCount": 2, // number of site collections in the web application
"FarmHost": "ARTHUR10", // farm host name
"Url": "http://arthur10:3716", // web application URL
"SitesCount": 2, // number of sites in web application
"FarmConfigDB": "SharePoint_Config", // config database name of the farm
"LastContentChange": "12,06,11,09,18", // date and time when the web application
content was last modified
"Size": 7023296 // web application size, in bytes
}
],
"ContentDBs":
[
{
"ContentDBName": "WSS_Content_3716", // content database name
"PhysicalSize": "31.31 MB", // total size of all files in the content database,
including trasation logs
"webapp": "http://arthur10:3716", // web application URL related to the Content
Database
"Size": 7023296, // total size of all files in the content database, including
trasation logs, in bytes
"ContentDBServer": "ARTHUR10" // content database server
}
],
}
}
Site Administrator for SharePoint 5.2.3 User Guide
Site Administrator for SharePoint REST
97
PUT /farms
NOTE: This method is available only for Information Portal administrators.
Table 4: Put/farms
Description
Query String
updates information
either about all farms or
about the specified
farm
l
l
Returns
farm=[FARM_ID], where [FARM_ID] is the farm
URL. If this parameter is not specified, you will get
information about all farms within your whole
enterprise scope.
limit=[LIMIT], where [LIMIT] is a parameter,
which specifies how many records should be
returned. By default, it is set to 10.
l
200 - OK.
l
401 Unauthorized.
l
500 - Internal
Server Error.
Error details
are in
response body
Example:
curl --user satestlab\\administrator 1 -X PUT http://infoportal:3141/api/farms //
enterprise
curl --user satestlab\\administrator 1 -X PUT
http://infoportal:3141/api/[email protected] // farm
GET /farms/actual_on
NOTE: This method is available only for Information Portal administrators.
Table 5: GET /farms/actual_on
Description
retrieves date and time
when farms information
was last updated
Query String
Returns
l
farm=[FARM_ID], where [FARM_ID] is the
farm URL.
l
limit=[LIMIT], where [LIMIT] is a
parameter, which specifies how many records
should be returned. By default, it is set to 10.
l
200 - OK.
l
401 Unauthorized.
l
500 - Internal
Server Error.
Error details are
in response body
Example:
curl --user satestlab\\administrator 1 http://infoportal:3141/api/farms/actual_on
// enterprise
curl --user satestlab\\administrator 1 http://infoportal:3141/api/farms/actual_
[email protected] // farm
Response body example:
"05/31/2012 1:01 PM"
Site Administrator for SharePoint 5.2.3 User Guide
Site Administrator for SharePoint REST
98
GET /servers
NOTE: This method is available only for Information Portal administrators.
Table 6: Insert
Description
Query String
Returns
returns a list of
servers
farm=[FARM_ID], where [FARM_ID] is
the farm URL.
l
200 - OK.
l
401 - Unauthorized.
l
500 - Internal Server Error. Error
details are in response body
Example:
curl --user satestlab\\administrator 1 http://infoportal:3141/api/farms/actual_on
// enterprise
curl --user satestlab\\administrator 1 http://infoportal:3141/api/farms/actual_
[email protected] // farm
The following parameters are returned for all servers: ServerName, Role and Version.
The server Role can be one of the following: Front-End, Application, Database, Search. Each server can have
several roles.
The following roles should be assigned to the server if one of the services is running on that server:
Table 7: Roles and Services
Role
Services Running
Application
Access, Business Data Connectivity, Excel Services Application, Managed Metadata,
PerformancePoint Service Application, Visio Graphics, Web Analytics, Word Automation, Secure
Store, User Profile, Subscription Settings, Lotus Notes Connector, Application Registry,
Document Conversions Launcher, Document Conversions Load Balancer.
Front-End
Foundation Web Application
Database
Database Service
Search
SharePoint Server Search Service
Example:
curl --ntlm --user [email protected]:1 http://SP2010N01:3141/api/servers
// enterprise
curl --ntlm --user [email protected]:1
http://SP2010N01:3141/api/[email protected] // farm
Response body example:
{
"estimation_time": 0, // estimated time(seconds) to update the cache
"actual_on": "08/07/2012 02:06:39 AM", // time when data was cached
"data":{
"ServerServices": [
Site Administrator for SharePoint 5.2.3 User Guide
Site Administrator for SharePoint REST
99
{
"ServerName": "WSS3BE",
"ServiceName": "Microsoft.SharePoint.Administration.SPDatabaseServiceInstance",
"ServiceStatus": "0" // (0 - running, 1 - stopped)
},
{"ServerName": "WSS3FE", "ServiceName":
"Microsoft.Office.Server.Search.Administration.SearchServiceInstance",
"ServiceStatus": "0"},
{"ServerName": "WSS3FE", "ServiceName":
"Microsoft.SharePoint.Administration.SPAdministrationServiceInstance",
"ServiceStatus": "0"},
{"ServerName": "WSS3FE", "ServiceName":
"Microsoft.Office.Excel.Server.ExcelServerSharedWebServiceInstance", "ServiceStatus":
"1"},
{"ServerName": "WSS3FERMSP", "ServiceName":
"Microsoft.Office.Server.Search.Administration.SearchServiceInstance",
"ServiceStatus": "0"},
{"ServerName": "WSS3FERMSP", "ServiceName":
"Microsoft.Office.Excel.Server.ExcelServerSharedWebServiceInstance", "ServiceStatus":
"0"},
{"ServerName": "WSS3FERMSP", "ServiceName":
"Microsoft.SharePoint.Administration.SPAdministrationServiceInstance",
"ServiceStatus": "0"}
],
"ServersInfo": [
{
"Status": "0", // (0 - running, 1 - stopped)
"ServerName": "WSS3BE",
"Version": "12.0.0.6545", // the latest version installed
"ServerRole": "SQL" // (FrontEnd, Application, SQL, SingleServer)
},
{"Status": "0", "ServerName": "WSS3FE", "Version": "12.0.0.6545", "ServerRole":
"Application"},
{"Status": "0", "ServerName": "WSS3FERMSP", "Version": "12.0.0.6545", "ServerRole":
"Application"}
]
},
"errors": [] // list of errors (if any occur)
}
Site Administrator for SharePoint 5.2.3 User Guide
Site Administrator for SharePoint REST
100
PUT /servers
NOTE: This method is available only for Information Portal administrators.
Table 8: PUT /servers
Description
Query String
Returns
updates topology
information either for the
enterprise or farm scope
farm=[FARM_ID], where [FARM_ID] is the farm URL.
If this parameter is not specified, you will get
information for the whole enterprise scope
l
200 - OK.
l
401 Unauthorized.
l
500 - Internal
Server Error.
Error details
are in response
body
Example:
curl --ntlm --user [email protected].qsft:1 -X PUT
http://SP2010N01:3141/api/servers // enterprise
curl --ntlm --user [email protected]:1 -X PUT
http://SP2010N01:3141/api/[email protected] // farm
GET /servers/actual_on
NOTE: This method is available only for Information Portal administrators.
Table 9: Get/servers/actual_on
Description
Query String
Returns
retrieves date and time
when topology information
was last updated
id=[FARM_ID], where [FARM_ID] is the farm URL. If
this parameter is not specified, information wii be
returned for the whole enterprise
l
200 - OK.
l
401 Unauthorized.
l
500 - Internal
Server Error.
Error details
are in response
body
Example:
curl --ntlm --user [email protected]:1
http://SP2010N01:3141/api/servers/actual_on // enterprise
curl --ntlm --user [email protected]:1
http://SP2010N01:3141/api/servers/[email protected] // farm
Response body example:
"05/31/2012 1:01 PM"
Site Administrator for SharePoint 5.2.3 User Guide
Site Administrator for SharePoint REST
101
GET /sitecollections
NOTE: This method is available only for Information Portal administrators.
Table 10: GET /sitecollections
Description
Query String
returns information
on site collections
within the
enterprise or farm
scope
l
l
Returns
farm=[FARM_ID], where [FARM_ID] is the farm URL
in the [email protected] format. Note that if
this parameter is not specified, you will get information
about site collections within your whole enterprise
scope.
limit=[LIMIT], where [LIMIT] is a parameter,
which specifies how many records should be returned.
By default, it is set to 10.
l
200 - OK.
l
401 Unauthorized.
l
500 - Internal
Server Error.
Error details
are in
response body
Example:
curl --ntlm --user warrior\\administrator:1 http://warrior101:3141/api/[email protected]&limit=10
Response body example:
{
"estimation_time": 0, // estimated time (in seconds) to update the cache
"actual_on": "08/07/2012 02:06:39 AM", // time when data was cached
"data":
[
{
"title": "Test Blank123", // site collection title
"quota": 0, // disk quota size, in bytes
"size": 183939314, // site collection size, in bytes
"fullurl": "http://worksp07/sites/sc1", // full url of the site collection
"database": "[email protected]_Content" // content database name with which the site
collection is associated
} ,,,,
]
"errors": [] // list of errors (if any occur)
}
PUT /sitecollections
NOTE: This method is available only for Information Portal administrators.
Site Administrator for SharePoint 5.2.3 User Guide
Site Administrator for SharePoint REST
102
Table 11: PUT /sitecollections
Description
updates information about
site collections within the
enterprise or farm scope
Query String
l
l
Returns
farm=[FARM_ID], where [FARM_ID] is the
farm URL in the [email protected]
format.
limit=[LIMIT], where [LIMIT] is a
parameter, which specifies how many
records should be returned. By default, it is
set to 10.
l
200 - OK.
l
401 Unauthorized.
l
500 - Internal
Server Error.
Error details
are in response
body
Example:
curl --ntlm --user warrior\\administrator:1 -X PUT http://warrior101:3141/api/[email protected]&limit=10
GET /sitecollections/actual_on
NOTE: This method is available only for Information Portal administrators.
Table 12: GET /sitecollections/actual_on
Description
retrieves date and time
when site collections
information was last updated
Query String
l
l
Returns
farm=[FARM_ID], where [FARM_ID] is the
farm URL in the [email protected]
format.
limit=[LIMIT], where [LIMIT] is a
parameter, which specifies how many
records should be returned. By default, it is
set to 10.
l
200 - OK.
l
401 Unauthorized.
l
500 - Internal
Server Error.
Error details are
in response
body
Example:
curl --ntlm --user warrior\\administrator:1 http://warrior101:3141/api/sitecollections/[email protected]&limit=10
Response body example:
"2/18/2012 1:01 PM"
GET /sites
NOTE: This method is available only for Information Portal administrators.
Site Administrator for SharePoint 5.2.3 User Guide
Site Administrator for SharePoint REST
103
Table 13: GET /sites
Description
Query String
returns
information on
sites within the
enterprise or
farm scope
l
l
Returns
farm=[FARM_ID], where [FARM_ID] is the farm URL in
the [email protected] format. Note that if this
parameter is not specified, you will get information about
sites within your whole enterprise scope.
limit=[LIMIT], where [LIMIT] is a parameter, which
specifies how many records should be returned. By
default, it is set to 10.
l
200 - OK.
l
401 Unauthorized.
l
500 - Internal
Server Error.
Error details
are in
response body
Example:
curl --ntlm --user warrior\\administrator:1 http://warrior101:3141/api/[email protected]&limit=10
Response body example:
{
"estimation_time": 0, // estimated time(in seconds) to update the cache
"actual_on": "08/07/2012 02:06:39 AM", // time when data was cached
"data":
[
{
"title": "removeuserfromsite", // site title
"type": "Site", // site type
"size": 8912051, // site size, in bytes
"fullurl": "http://worksp07/sites/sc1http://worksp07/sites/sc1/removeuserfromsite", //
full url of the site
"database": "[email protected]_Content" // content database name with which the site
is associated
} ,,,,
]
"errors": [] // list of errors (if any occur)
PUT /sites
NOTE: This method is available only for Information Portal administrators.
Site Administrator for SharePoint 5.2.3 User Guide
Site Administrator for SharePoint REST
104
Table 14: PUT /sites
Description
Query String
updates information about
sites within the enterprise
or farm scope
l
l
Returns
farm=[FARM_ID], where [FARM_ID] is the
farm URL in the [email protected]
format.
limit=[LIMIT], where [LIMIT] is a
parameter, which specifies how many records
should be returned. By default, it is set to 10.
l
200 - OK.
l
401 Unauthorized.
l
500 - Internal
Server Error.
Error details are
in response body
Example:
curl --ntlm --user warrior\\administrator:1 -X PUT http://warrior101:3141/api/sites?farm=SharePoint_Config&limit=10
GET /sites/actual_on
NOTE: This method is available only for Information Portal administrators.
Table 15: GET /sites/actual_on
Description
Query String
retrieves date
and time when
sites information
was last updated
l
l
Returns
farm=[FARM_ID], where [FARM_ID] is the farm URL in
the [email protected] format. Note that if this
parameter is not specified, you will get information about
sites within your whole enterprise scope.
limit=[LIMIT], where [LIMIT] is a parameter, which
specifies how many records should be returned. By
default, it is set to 10.
l
200 - OK.
l
401 Unauthorized.
l
500 - Internal
Server Error.
Error details
are in
response body
Example:
curl --ntlm --user warrior\\administrator:1 http://warrior10-1:3141/api/sites/actual_
on?farm=SharePoint_Config&limit=10
Response body example:
"2/18/2012 1:01 PM"
GET /site/common_info
NOTE: This method is available only for Information Portal administrators.
Site Administrator for SharePoint 5.2.3 User Guide
Site Administrator for SharePoint REST
105
Table 16: GET /site/common_info
Description
Query String
Returns
returns common information
on the specified site
collection or site
url=[SITE_URL], where [SITE_URL] is the
site collection or site URL used to retrieve
information
l
200 - OK.
l
401 - Unauthorized.
l
500 - Internal Server
Error. Error details
are in response
body
Example:
curl --ntlm --user warrior\\administrator:1 http://warrior10-1:3141/api/site/common_
info?url=http://sharepoint/site
Response body example:
{
"estimation_time": 0, // estimated time(in seconds) to update the cache
"actual_on": "08/07/2012 02:06:39 AM", // time when data was cached
"data":
{
"FirstAdminLogin": "WARRIOR\\administrator", // login of the first site collection
administrator
"Errors": [], // list of errors
"FirstAdminTitle": "WARRIOR\\administrator", // title of the first site collection
administrator
"Database": "WSS_Content", // content database name with which the site
collection/site is associated
"diskquota": 0, // diskquota size, in bytes
"SqlServer": "WORKSP07", // sql sever name
"selfTitle": "Test Blank123", // site title
"CreatorTitle": "WARRIOR\\administrator", // site collection/site author title
"SecondAdminLogin": "WARRIOR\\sheldon", // login of the second site collection
administrator
"SecondAdminTitle": "Sheldon", // title of the second site collection administrator
"CreatorLogin": "WARRIOR\\administrator", // site collection/site author login
"CreatedDate": "09/02/2011 05:34", // time (mm/dd/yyyy HH:MM) when the site
collection/site was created
"tlsurl": "http://worksp07/sites/sc1", // site collection url with which the site
is associated
"WebAppUrl": "http://worksp07" // web application url with which the site is
associated
},
Site Administrator for SharePoint 5.2.3 User Guide
Site Administrator for SharePoint REST
106
"errors": [] // list of errors (if any occur)
}
NOTE: The following parameters are not available for site owners: "Database", "SqlServer" and
"tlsurl".
PUT /site/common_info
Table 17: PUT /site/common_info
Description
Query String
Returns
updates information about
the specified site collection
or site
url=[SITE_URL], where [SITE_URL] is the
site collection or site URL used to retrieve
information
l
200 - OK.
l
401 - Unauthorized.
l
500 - Internal Server
Error. Error details
are in response body
Example:
curl --ntlm --user warrior\\administrator:1 -X PUT http://warrior101:3141/api/site/common_info?url=http://sharepoint/site
GET /site/common_info/actual_on
Table 18: GET /site/common_info/actual_on
Description
Query String
Returns
retrieves date and time when
information on the specified site
collection or site was last updated
url=[SITE_URL], where [SITE_URL]
is the site collection or site URL used to
retrieve information
l
200 - OK.
l
401 Unauthorized.
l
500 - Internal
Server Error.
Error details are
in response body
Example:
curl --ntlm --user warrior\\administrator:1 http://warrior10-1:3141/api/site/common_
info/actual_on?url=http://sharepoint/site
Response body example:
"2/18/2012 1:01 PM"
Site Administrator for SharePoint 5.2.3 User Guide
Site Administrator for SharePoint REST
107
GET /content/site_info
Table 19: GET /content/site_info
Description
Query String
Returns
returns information on the specified site
(including top sites, site overview, top files
and document extension information)
url=[SITE_URL], where [SITE_
URL] is the site collection or site URL
used to retrieve information
l
200 - OK.
l
401 Unauthorized.
l
500 - Internal
Server Error.
Error details
are in
response body
Example:
curl --ntlm --user warrior\\administrator:1 http://warrior10-1:3141/api/content/site_
info?url=http://sharepoint/site
Response body example:
{
"actual_on": "5/23/2012 12:23 PM", // time when data was cached
"estimation_time": 23, // estimated time to update the cache
"data":{"FirstAdminLogin": "WARRIOR\\administrator",
"Errors": [],
"DocumentsCount": 392,
"tlsurl": "http://jimmymoss2010/",
"WebAppUrl": "http://jimmymoss2010",
"AttachmentsCount": 0,
"AllDocExtensionsWithSize": [{"Count": 4, "Name": "zip", "Size": 16020476}, ...],
"diskquota": 1254247,
"CreatorTitle": "Peter Ng",
"ListsCount": 206,
"SitesInfo": [{"Url": "http://jimmymoss2010/", "Type": "Site Collection", "SiteSize":
41099778, "Title": "mySite"}, ...],
"AllSiteSize": 62128852,
"AllDocVesrionsCount": 400,
"FirstAdminTitle": "WARRIOR\administrator",
"Database": "WSS_Content",
"SubSitesCount": 34,
"SqlServer": "JIMMYMOSS2010",
"SecondAdminLogin": "",
Site Administrator for SharePoint 5.2.3 User Guide
Site Administrator for SharePoint REST
108
"TopDocsBySize": [{"dir_name": "http://jimmymoss2010/TestAdmin", "leaf_name":
"Application.zip", "d_id": "D1036193-FDBE-4257-8FB1-CEEA52C91421", "w_id": "1256E444B2C7-4604-AB4C-FD0A234AAF1A", "RowNum": 1, "size": 5579841, "count_ver": 1, "curr_
size": 5579841}, ...],
"ListItemsCount": 602,
"AllDocumentsSize": 22121357,
"DocLibsCount": 161,
"selfTitle": "mySite",
"SecondAdminTitle": "",
"CreatorLogin": "WARRIOR\peter",
"CreatedDate": "10,09,21,09,09"}
}
PUT /content/site_info
Table 20: PUT /content/site_info
Description
Query String
Returns
updates information
about the specified
site
url=[SITE_URL], where [SITE_URL] is the site
collection or site URL used to retrieve information
l
200 - OK.
l
401 - Unauthorized.
l
500 - Internal Server
Error. Error details are
in response body
Example:
curl --ntlm --user warrior\\administrator:1 -X PUT http://warrior101:3141/api/content/site_info?url=http://sharepoint/site
GET /content/site_info/actual_on
Table 21: GET /content/site_info/actual_on
Description
Query String
Returns
retrieves date and time when
the total content size was last
updated
url=[SITE_URL], where [SITE_URL] is the
site collection or site URL used to retrieve
information
l
200 - OK.
l
401 - Unauthorized.
l
500 - Internal
Server Error. Error
details are in
response body
Example:
curl --ntlm --user warrior\\administrator:1 http://warrior10-1:3141/api/content/site_
info/actual_on?url=http://sharepoint/site
Site Administrator for SharePoint 5.2.3 User Guide
Site Administrator for SharePoint REST
109
Response body example:
"2/18/2012 1:01 PM"
GET /content/lists
Table 22: GET /content/lists
Description
retrieves information on the
largest lists within the
specified site collection or site
Query String
l
l
Returns
url=[SITE_URL], where [SITE_URL] is
the site collection or site URL used to
retrieve information
limit=[LIMIT], where [LIMIT] is a
parameter, which specifies how many
records should be returned. By default, it
is set to 10
l
200 - OK.
l
401 Unauthorized.
l
500 - Internal
Server Error.
Error details
are in response
body
Example:
curl --ntlm --user warrior\\administrator:1 http://warrior101:3141/api/content/lists?url=http://sharepoint/site&limit=10
Response body example:
{
"actual_on": "5/23/2012 12:23 PM", // time when data was cached
"estimation_time": 23, // estimated time(seconds) to update the cache
"data":
{
"totalCount": 1995, // total count of lists in the scope of the given site url.(system
lists are hidden, and hidden lists will be counted in)
"Errors": [], // list of errors (if any occur)
"lists": [ // list of SharePoint lists
{
"EditorLogin": "SHAREPOINT\\system", // login of the latest editor
"AuthorLogin": "SHAREPOINT\\system", // login of the list author
"ListSize": 12560433, // list size, in bytes
"WebTitle": "subsite1", // site title with which the list is associated
"attachments": 0, // attachments number
"Title": "Shared Documents", // list title
"Url": "http://worksp07/sites/sc1/subsite1/Lists/cuslist", // list url
"AuthorDispName": "System Account", // author name
"WebUrl": "http://worksp07/sites/sc1/site/subsite1", // site url with which the list
is associated
Site Administrator for SharePoint 5.2.3 User Guide
Site Administrator for SharePoint REST
110
"Modified": "11,11,14,07,27", // time (yy,mm,dd,hh,mm) when list items were last
modified
"EditorDispName": "System Account", // display name of the latest editor
"ListId": "F81AC49B-810D-4A42-B934-B19E3974ED94", // list id
"VerCount": 0, // list versions number, current version will not be counted in
"UniquePerms": 0, // list unique psermissions number
"Flags": 67112968, // list flags
"ItemCount": 1, // list items number
"ServerTemplate": 101, // server templates number
"Created": "11,11,14,07,27" // time (yy,mm,dd,hh,mm) when the list was created
, , , ,
}
]
}
}
PUT /content/lists
Table 23: PUT /content/lists
Description
updates information on the
largest lists within the
specified site collection or site
Query String
l
l
Returns
url=[SITE_URL], where [SITE_URL] is
the site collection or site URL used to
retrieve information
limit=[LIMIT], where [LIMIT] is a
parameter, which specifies how many
records should be returned. By default, it
is set to 10
l
200 - OK.
l
401 Unauthorized.
l
500 - Internal
Server Error.
Error details
are in response
body
Example:
curl --ntlm --user warrior\\administrator:1 -X PUT http://warrior101:3141/api/content/lists?url=http://sharepoint/site&limit=10
GET /content/lists/actual_on
NOTE: This method is available only for Information Portal administrators.
Site Administrator for SharePoint 5.2.3 User Guide
Site Administrator for SharePoint REST
111
Table 24: GET /content/lists/actual_on
Description
retrieves date and time when
information on the lists within the
specified site was last updated
Query String
l
l
Returns
url=[SITE_URL], where [SITE_URL]
is the site collection or site URL used to
retrieve information
limit=[LIMIT], where [LIMIT] is a
parameter, which specifies how many
records should be returned. By default,
it is set to 10
l
200 - OK.
l
401 Unauthorized.
l
500 - Internal
Server Error.
Error details
are in
response body
Example:
curl --ntlm --user warrior\\administrator:1 http://warrior101:3141/api/content/lists/actual_on?url=http://sharepoint/site&limit=10
Response body example:
"2/18/2012 1:01 PM"
GET /content/doclibs
Table 25: GET /content/doclibs
Description
retrieves information on the
largest document libraries within
the specified site collection or site
Query String
l
l
Returns
url=[SITE_URL], where [SITE_URL]
is the site collection or site URL used to
retrieve information
limit=[LIMIT], where [LIMIT] is a
parameter, which specifies how many
records should be returned. By default,
it is set to 10
l
200 - OK.
l
401 Unauthorized.
l
500 - Internal
Server Error.
Error details
are in
response body
Example:
curl --ntlm --user warrior\\administrator:1 http://warrior101:3141/api/content/doclibs?url=http://sharepoint/site&limit=10
Response body example:
{
"actual_on": "5/23/2012 12:23 PM", // time when data was cached
"estimation_time": 23, // estimated time(seconds) to update the cache
"data":
{
Site Administrator for SharePoint 5.2.3 User Guide
Site Administrator for SharePoint REST
112
"totalCount": 1995, // total count of lists in the scope of given site url.(system
lists are hidden, and hidden lists will be counted in)
"Errors": [], // list of errors (if any ocur)
"lists": [ // document libraries list
{
"EditorLogin": "SHAREPOINT\\system", // login of the latest editor
"AuthorLogin": "SHAREPOINT\\system", // login of the document library author
"ListSize": 51084, // list size, in bytes
"WebTitle": "Test Title of Web", // site title with which the document library
is associated
"attachments": 0, // attachments number
"Title": "Shared Documents", // document library title
"Url": "http://worksp07/sites/sc1/site110/Shared Documents", // document library url
"AuthorDispName": "System Account", // author name
"WebUrl": "http://worksp07/sites/sc1/site110", // site url with which the document
library is associated
"Modified": "12,06,04,07,28", // time (yy,mm,dd,hh,mm) when documents in the document
library were last modified
"EditorDispName": "System Account", // display name of the latest editor
"ListId": "61A121DE-445B-47EB-B71A-93668140A49B", // document library id
"VerCount": 0, // document library versions number, current version will not be
counted in
"UniquePerms": 1, // document library unique psermissions number
"Flags": 67112968, // document library flags
"ItemCount": 1, // documents number in the document library
"ServerTemplate": 101, // server template number
"Created": "12,06,04,07,28" // time (yy,mm,dd,hh,mm) when the document library
was created
, , , ,
}
]
}
}
Site Administrator for SharePoint 5.2.3 User Guide
Site Administrator for SharePoint REST
113
PUT /content/doclibs
Table 26: PUT /content/doclibs
Description
Query String
updates information on the
document libraries within the
specified site collection or site
l
l
Returns
url=[SITE_URL], where [SITE_URL] is
the site collection or site URL used to
retrieve information
limit=[LIMIT], where [LIMIT] is a
parameter, which specifies how many
records should be returned. By default,
it is set to 10
l
200 - OK.
l
401 Unauthorized.
l
500 - Internal
Server Error.
Error details
are in
response body
Example:
curl --ntlm --user warrior\\administrator:1 -X PUT http://warrior101:3141/api/content/doclibs?url=http://sharepoint/site&limit=10
GET /content/doclibs/actual_on
Table 27: GET /content/doclibs/actual_on
Description
retrieves date and time when
information on the documents
libraries within the specified site was
last updated
Query String
l
l
Returns
url=[SITE_URL], where [SITE_
URL] is the site collection or site URL
used to retrieve information
limit=[LIMIT], where [LIMIT] is
a parameter, which specifies how
many records should be returned. By
default, it is set to 10
l
200 - OK.
l
401 Unauthorized.
l
500 - Internal
Server Error.
Error details
are in
response body
Example:
curl --ntlm --user warrior\\administrator:1 http://warrior101:3141/api/content/doclibs/actual_on?url=http://sharepoint/site&limit=10
Response body example:
"2/18/2012 1:01 PM"
Site Administrator for SharePoint 5.2.3 User Guide
Site Administrator for SharePoint REST
114
GET /storage_growth
Table 28: GET /storage_growth
Description
Query String
this method returns storage growth trend
data for enterprise, farm or site scope
depending on the query parameter. Note
that site collections administrators and site
owners can use this method only to retrieve
data for the site scope
l
Returns
farm=[FARM_ID], where
[FARM_ID] is the farm ID for
which you want to retrieve
storage growth trend data
l
url=[SITE_URL], where
[SITE_URL] is the site
collection or site URL used to
retrieve storage growth trend
data
l
period=[PERIOD], where
[PERIOD] is the period (in
days) for which you want to
retrieve storage growth trend
data. The default value is 365.
This parameter is required to
be specified for all scopes
l
200 - OK.
l
401 Unauthorized.
l
500 - Internal
Server Error.
Error details
are in
response body
Example:
curl --user satestlab\\administrator 1 http://infoportal:3141/api/storage_
growth?period=30 // enterprise
curl --user satestlab\\administrator 1 http://infoportal:3141/api/storage_
[email protected]&period=30 // farm
curl --user satestlab\\administrator 1 http://infoportal:3141/api/storage_
growth?url=http://testlab/sharepointsite&period=30 // site
Response body example:
{
"actual_on": "12/28/2011 12:14 PM", // time when data was cached
"time_estimation": 80, // estimated time (in seconds) to update the cache
"data": [
{"date": "2010.12.28", // date in the "yyyy.mm.dd" format when the site content size
was modified
"size": 10479279 // content size, in bytes
},
{"date": "2010.12.29", "size": 12342545},
{"date": "2010.12.30", "size": 12389897}
],
"errors": []
}
Site Administrator for SharePoint 5.2.3 User Guide
Site Administrator for SharePoint REST
115
PUT /storage_growth
Table 29: PUT /storage_growth
Description
this method updates storage growth trend
data for enterprise, farm or site scope
depending on the query parameter. Note
that site collections administrators and site
owners can use this method only to retrieve
data for the site scope
Query String
Returns
farm=[FARM_ID], where
[FARM_ID] is the farm ID for
which you want to update
storage growth trend data
l
l
url=[SITE_URL], where
[SITE_URL] is the site
collection or site URL used to
update storage growth trend
data
l
period=[PERIOD], where
[PERIOD] is the period (in
days) for which you want to
update storage growth trend
data. The default value is 365.
This parameter is required to
be specified for all scopes
l
200 - OK.
l
401 Unauthorized.
l
500 - Internal
Server Error.
Error details
are in
response body
Example:
curl -X PUT --user satestlab\\administrator 1 http://infoportal:3141/api/storage_
growth?period=30 // enterprise
curl -X PUT --user satestlab\\administrator 1 http://infoportal:3141/api/storage_
[email protected]&period=30 // farm
curl -X PUT --user satestlab\\administrator 1 http://infoportal:3141/api/storage_
growth?url=http://testlab/sharepointsite&period=30 // site
GET /storage_growth/actual_on
Table 30: GET /storage_growth/actual_on
Description
this method retrieves the date and time when
storage growth trend data for enterprise, farm
or site scope was last updated
Query String
l
Returns
farm=[FARM_ID], where
[FARM_ID] is the farm ID
for which you want to
retrieve data
l
url=[SITE_URL], where
[SITE_URL] is the site
collection or site URL used
to retrieve data
l
period=[PERIOD], where
[PERIOD] is the period (in
days) for which you want to
retrieve data
l
200 - OK.
l
401 Unauthorized.
l
500 - Internal
Server Error.
Error details
are in
response body
Site Administrator for SharePoint 5.2.3 User Guide
Site Administrator for SharePoint REST
116
Example:
curl --user satestlab\\administrator 1 http://infoportal:3141/api/storage_
growth/actual_on?period=30 // enterprise
curl --user satestlab\\administrator 1 http://infoportal:3141/api/storage_
growth/[email protected]&period=30 // farm
curl --user satestlab\\administrator 1 http://infoportal:3141/api/storage_
growth/actual_on?url=http://testlab/sharepointsite&period=30 // site
Response body example:
"05/31/2012 1:01 PM"
GET /space_distribution
Table 31: GET /space_distribution
Description
Query String
this method returns storage space distribution data for
enterprise, farm or site scope depending on the query
parameter. Note that site collections administrators
and site owners can use this method only to retrieve
data for the site scope
l
l
Returns
farm=[FARM_ID],
where [FARM_ID]
is the farm ID for
which you want to
retrieve storage
space distribution
data
l
200 - OK.
l
401 Unauthorized.
l
500 - Internal
Server Error.
Error details
are in
response body
url=[SITE_URL],
where [SITE_URL]
is the site
collection or site
URL used to
retrieve storage
space distribution
data
Example:
curl --user satestlab\\administrator 1 http://infoportal:3141/api/space_distribution
// enterprise
curl --user satestlab\\administrator 1 http://infoportal:3141/api/space_
[email protected] // farm
curl --user satestlab\\administrator 1 http://infoportal:3141/api/space_
distribution?url=http://testlab/sharepointsite // site
Response body example:
{
"actual_on": "12/28/2011 12:14 PM", // time when data was cached
"time_estimation": 80, // estimated time (in seconds) to update the cache
"data":{
"content": 18813960, // content size, in bytes
Site Administrator for SharePoint 5.2.3 User Guide
Site Administrator for SharePoint REST
117
"userRecBin": 14052352, // size of the user recycle bin content, in bytes
"adminRecBin": 0, // content size of the sharepoint central administration recycle
bin, in bytes
"versions": 0 // version size, in bytes
},
"errors": []
}
PUT /space_distribution
Table 32: PUT /space_distribution
Description
Query String
this method updates storage space distribution data for
enterprise, farm or site scope depending on the query
parameter. Note that site collections administrators
and site owners can use this method only to retrieve
data for the site scope
l
l
farm=[FARM_ID],
where [FARM_ID]
is the farm ID for
which you want to
update storage
space distribution
data
Returns
l
200 - OK.
l
401 Unauthorized.
l
500 - Internal
Server Error.
Error details
are in
response body
url=[SITE_URL],
where [SITE_URL]
is the site
collection or site
URL used to update
storage space
distribution data
Example:
curl -X PUT --user satestlab\\administrator 1 http://infoportal:3141/api/space_
distribution //enterprise
curl -X PUT --user satestlab\\administrator 1 http://infoportal:3141/api/space_
[email protected] //farm
curl -X PUT --user satestlab\\administrator 1 http://infoportal:3141/api/space_
distribution?url=http://testlab/sharepointsite //site
GET /space_distribution/actual_on
Table 33: GET /space_distribution/actual_on
Description
this method retrieves the date and time when
storage space distribution data for enterprise,
farm or site scope was last updated
Query String
l
Returns
farm=[FARM_ID], where
[FARM_ID] is the farm ID
for which you want to
l
200 - OK.
l
401 -
Site Administrator for SharePoint 5.2.3 User Guide
Site Administrator for SharePoint REST
118
Description
Query String
Returns
retrieve data
l
Unauthorized.
url=[SITE_URL], where
[SITE_URL] is the site
collection or site URL used
to retrieve data
l
500 - Internal
Server Error.
Error details
are in
response body
Example:
curl --user satestlab\\administrator 1 http://infoportal:3141/api/space_
distribution/actual_on //enterprise
curl --user satestlab\\administrator 1 http://infoportal:3141/api/space_
distribution/[email protected] //farm
curl --user satestlab\\administrator 1 http://infoportal:3141/api/space_
distribution/actual_on?url=http://testlab/sharepointsite //site
Response body example:
"05/31/2012 1:01 PM"
GET /alerts
Table 34: GET /alerts
Description
Query String
Returns
returns a list
of Health
Analyzer
alerts
farm=[FARM_ID], where [FARM_ID] is the farm ID for which you
want to retrieve data. If this parameter is not specified, you will get
information for all farms within your enterprise
l
200 - OK.
l
401 Unauthorized.
l
500 - Internal
Server Error.
Error details
are in
response body
Table 35: List Alert Attributes
Attribute
Attribute Description
Category
Specifies the category for the health analyzer:
l
System - identifies a problem with the SharePoint Health Analyzer
l
Security - identifies a problem that could affect the security of the system
l
Performance - identifies a problem that could affect how well the system performs
l
Configuration - identifies a problem with SharePoint Foundation configuration
l
Availability - identifies a problem that could reduce availability
Site Administrator for SharePoint 5.2.3 User Guide
Site Administrator for SharePoint REST
119
Attribute
Attribute Description
l
Severity
Custom - identifies a problem in a custom category
Specifies the severity of a problem detected by the health analyzer:
l
0 - Rule Execution Failure
l
1 - Error
l
2 - Warning
l
3 - Information
l
4 - Success
AlertType
The full type name, e.g. Microsoft.SharePoint.Administration.Health.ServiceIsNotRunning,
Microsoft.SharePoint.Health, Version=14.0.0.0, Culture=neutral,
PublicKeyToken=71e9bce111e9429c
Title
The alert title displayed in the Central Administration
LastModified
The time when the alert has been last updated
Servers
Either NULL or the string of \r\n-separated servers where alert has occurred
Services
The service name that alert has executed. Can be: SPTimerService (SPTimerV4),
SPWebService, SPWebService (WSS_Administration), OfficeServerService,
SPSecurityTokenService (SecurityTokenService), etc.
Explanation
The description displayed in the Central Administration
Remedy
Describes what needs to be done
FarmName
The farm name of the [email protected] type
Example:
curl --ntlm --user [email protected]:1 http://SP2010N01:3141/api/alerts
// enterprise
curl --ntlm --user [email protected]:1
http://SP2010N01:3141/api/[email protected] // farm
Response body example:
{
"estimation_time": 0,
"actual_on": "10/04/2012 11:36:04 AM",
"data": [
{
"ItemId": 39,
"Category": "Security",
"AlertType":
"Microsoft.SharePoint.Administration.Health.FarmAccountIsSharedWithUserServices,
Microsoft.SharePoint.Health, Version=14.0.0.0, Culture=neutral,
PublicKeyToken=71e9bce111e9429c",
"Severity": "1 - Error",
Site Administrator for SharePoint 5.2.3 User Guide
Site Administrator for SharePoint REST
120
"Title": "The server farm account should not be used for other services.",
"LastModified": "2012-09-29 20:00:40",
"Explanation": "VELASKEC\\SPAdmin, the account used for the SharePoint timer service
and the central administration site, is highly privileged and should not be used for
any other services on any machines in the server farm. The following services were
found to use this account: \tSharePoint - 80 (Application Pool)\r\n\tSharePoint - 8080
(Application Pool)\r\n",
"Servers": null,
"Remedy": "Browse to http://sp2010-02:555/_admin/FarmCredentialManagement.aspx and
change the account used for the services listed in the explanation. For more
information about this rule, see \"http://go.microsoft.com/fwlink/?LinkID=142685\".",
"Services": "SPTimerService (SPTimerV4)",
"FarmName": "[email protected]"
},
{
"ItemId": 40,
"Category": "Configuration",
"AlertType": "Microsoft.SharePoint.Administration.Health.OutgoingEmailIsNotConfigured,
Microsoft.SharePoint.Health, Version=14.0.0.0, Culture=neutral,
PublicKeyToken=71e9bce111e9429c",
"Severity": "1 - Error",
"Title": "Outbound e-mail has not been configured.",
"LastModified": "2012-09-29 20:00:40",
"Explanation": "A default SMTP server has not been configured. One or more web
applications do not have SMTP servers configured. Because of this, features such as
alerts will not function properly.",
"Servers": null,
"Remedy": "Configure an outgoing e-mail server from the central administration site or
execute the following command: C:\\Program Files\\Common Files\\Microsoft Shared\\Web
Server Extensions\\14\\bin\\stsadm.exe-o email -outsmtpserver <SMTP server> fromaddress <[email protected]> -replytoaddress <[email protected]> -codepage
<codepage> For more information about this rule, see
\"http://go.microsoft.com/fwlink/?LinkID=142684\".",
"Services": "SPTimerService (SPTimerV4)"
"FarmName": "[email protected]"
},
{
"ItemId": 7,
"Category": "Availability",
"AlertType": "Microsoft.SharePoint.Administration.Health.ServiceIsNotRunning,
Microsoft.SharePoint.Health, Version=14.0.0.0, Culture=neutral,
PublicKeyToken=71e9bce111e9429c",
Site Administrator for SharePoint 5.2.3 User Guide
Site Administrator for SharePoint REST
121
"Severity": "1 - Error",
"Title": "One or more services have started or stopped unexpectedly.",
"LastModified": "2012-10-04 11:00:02",
"Explanation": "The following services are managed by SharePoint, but their running
state does not match what SharePoint expects: SPAdminV4. This can happen if a service
crashes or if an administrator starts or stops a service using a non-SharePoint
interface. If SharePoint-managed services do not match their expected running state,
SharePoint will be unable to correctly distribute work to the service.",
"Servers": "SP2010-02 \r\n",
"Remedy": "To stop or start a service managed by SharePoint, use the SharePoint
service management interface in the SharePoint Central Administration Site. If a
service has crashed, restart the service manually on the affected servers by running
\"net start [service name]\" from a command prompt. For more information about this
rule, see \"http://go.microsoft.com/fwlink/?LinkID=142683\".",
"Services": "SPTimerService (SPTimerV4)",
"FarmName": "[email protected]"
}
],
"errors": []
}
PUT /alerts
Table 36: PUT /alerts
Description
Query String
Returns
updates the Health
Analyzer Alerts
information for all farms
or for the given farm
farm=[FARM_ID], where [FARM_ID] is the farm ID for
which you want to retrieve data. If this parameter is not
specified, you will get information for all farms within
your enterprise
l
200 - OK.
l
401 Unauthorized.
l
500 - Internal
Server Error.
Error details
are in
response body
Example:
curl --ntlm --user [email protected]:1 -X PUT
http://SP2010N01:3141/api/alerts // enterprise
curl --ntlm --user [email protected]:1 -X PUT
http://SP2010N01:3141/api/[email protected] // farm
Site Administrator for SharePoint 5.2.3 User Guide
Site Administrator for SharePoint REST
122
GET /alerts/actual_on
Table 37: GET /alerts/actual_on
Description
Query String
Returns
retrieves date and time
when the Health Analyzer
Alerts information was last
updated
id=[FARM_ID] is the farm ID for which you want to
retrieve data. If this parameter is not specified, you
will get information for all farms within your
enterprise
l
200 - OK.
l
401 Unauthorized.
l
500 - Internal
Server Error.
Error details
are in
response body
Example:
curl --ntlm --user [email protected]:1
http://SP2010N01:3141/api/alerts/actual_on // enterprise
curl --ntlm --user [email protected]:1
http://SP2010N01:3141/api/alerts/[email protected] // farm
Response body example:
"05/31/2012 1:01 PM"
GET /security/counters/unique_perms
Table 38: GET /security/counters/unique_perms
Description
Query String
Returns
returns the number of unique permissions on
sites, lists/ document libraries and list items/
documents with unique permissions within the
specified site collection or site
url=[SITE_URL], where
[SITE_URL] is the site
collection or site URL used to
retrieve the permissions number
l
200 - OK.
l
401 Unauthorized.
l
500 - Internal
Server Error.
Error details
are in
response body
Example:
curl --ntlm --user warrior\\administrator:1 http://warrior101:3141/api/security/counters/unique_perms?url=http://sharepoint/site
Response body example:
{
"actual_on": "5/23/2012 12:23 PM", // time when data was cached
Site Administrator for SharePoint 5.2.3 User Guide
Site Administrator for SharePoint REST
123
"time_estimation": 23, // estimated time to update the cache
"data":
{
"number": // number of unique permissions
{
"sites": 32,
"lists": 251,
"items": 3541
},
"errors": []
}
}
PUT /security/counters/unique_perms
Table 39: PUT /security/counters/unique_perms
Description
Query String
Returns
updates the number of
unique permissions for the
specified site
url=[SITE_URL], where [SITE_URL] is the site
collection or site URL used to update the
permissions number
l
200 - OK.
l
401 Unauthorized.
l
500 - Internal
Server Error. Error
details are in
response body
Example:
curl --ntlm --user warrior\\administrator:1 -X PUT http://warrior101:3141/api/security/counters/unique_perms?url=http://sharepoint/site
GET /security/counters/unique_perms/actual_on
Table 40: GET /security/counters/unique_perms/actual_on
Description
Query String
Returns
retrieves the date and time when
the unique permissions number was
last updated
url=[SITE_URL], where [SITE_URL] is
the site collection or site URL used to
retrieve information
l
200 - OK.
l
401 Unauthorized.
l
500 - Internal
Server Error. Error
details are in
response body
Site Administrator for SharePoint 5.2.3 User Guide
Site Administrator for SharePoint REST
124
Example:
curl --ntlm --user warrior\\administrator:1 http://warrior101:3141/api/security/counters/unique_perms/actual_on?url=http://sharepoint/site
Response body example:
"2/18/2012 1:01 PM"
GET /security/counters/ad_objs
Table 41: GET /security/counters/ad_objs
Description
Query String
Returns
returns the number of AD users and
groups which have the Limit Access
permission level on the specified
SharePoint site
url=[SITE_URL], where [SITE_URL]
is the site collection or site URL used to
retrieve the number of AD objects
l
200 - OK.
l
401 Unauthorized.
l
500 - Internal
Server Error.
Error details
are in
response body
Example:
curl --user satestlab\\administrator 1
http://infoportal:3141/api/security/counters/ad_objs?url=http://sharepoint/site
Response body example:
{
"actual_on": "12/28/2011 12:14 PM", // time when data was cached
"time_estimation": 60, // estimated time(seconds) to update the cache
"data":
{
"number": // unique permissions number
{
"ad_users": 30, // AD users number
"ad_groups": 20 // AD groups number
},
"errors": [ ] // list of errors (if any occur)
}
}
Site Administrator for SharePoint 5.2.3 User Guide
Site Administrator for SharePoint REST
125
PUT /security/counters/ad_objs
Table 42: PUT /security/counters/ad_objs
Description
Query String
Returns
updates the number of AD url=[SITE_URL], where [SITE_URL] is the site
objects within the
collection or site URL used to update the number
specified site
of AD objects
l
200 - OK.
l
401 - Unauthorized.
l
500 - Internal
Server Error. Error
details are in
response body
Example:
curl --user satestlab\\administrator 1 -X PUT
http://infoportal:3141/api/security/counters/ad_objs?url=http://sharepoint/site
GET /security/counters/ad_objs/actual_on
Table 43: GET /security/counters/ad_objs/actual_on
Description
Query String
Returns
retrieves date and time when
the AD objects number was
last updated
url=[SITE_URL], where [SITE_URL] is the
site collection or site URL used to retrieve the
number of AD objects
l
200 - OK.
l
401 Unauthorized.
l
500 - Internal
Server Error.
Error details are
in response body
Example:
curl --user satestlab\\administrator 1
http://infoportal:3141/api/security/counters/ad_objs/actual_
on?url=http://sharepoint/site
Response body example:
"05/31/2012 1:01 PM"
GET /security/counters/open_content
Table 44: GET /security/counters/open_content
Description
Query String
retrieves the Open Content counter (the total number of
url=[SITE_URL],
Returns
l
200 - OK.
Site Administrator for SharePoint 5.2.3 User Guide
Site Administrator for SharePoint REST
126
Description
Query String
Returns
sites, lists, document libraries, list items and documents
where the NT Authority\Authenticated users group have
permissions) for the specified SharePoint site. Objects with
inherited permissions are counted too
where [SITE_URL] is
the site collection or
site URL used to
retrieve information
l
401 Unauthorized.
l
500 - Internal
Server Error.
Error details
are in
response body
Example:
curl --user satestlab\\administrator 1
http://infoportal:3141/api/security/counters/open_content?url=http://sharepoint/site
Response body example:
{
"actual_on": "12/28/2011 12:14 PM", // time when data was cached
"time_estimation": 60, // estimated time to update the cache
"data":{"value": 20, "errors": [ ] }
}
PUT /security/counters/open_content
Table 45: PUT /security/counters/open_content
Description
Query String
Returns
updates the Open Content
counter for the specified
SharePoint site
url=[SITE_URL], where [SITE_URL] is the
site collection or site URL used to update
information
l
200 - OK.
l
401 - Unauthorized.
l
500 - Internal Server
Error. Error details
are in response
body
Example:
curl --user satestlab\\administrator 1 -X PUT
http://infoportal:3141/api/security/counters/open_content?url=http://sharepoint/site
GET /security/counters/open_content/actual_on
Table 46: GET /security/counters/open_content/actual_on
Description
Query String
Returns
retrieves the date and time when
url=[SITE_URL], where [SITE_URL] is
l
200 - OK.
Site Administrator for SharePoint 5.2.3 User Guide
Site Administrator for SharePoint REST
127
Description
Query String
Returns
the Open Content counter was
last updated
the site collection or site URL used to
retrieve information
l
401 Unauthorized.
l
500 - Internal
Server Error. Error
details are in
response body
Example:
curl --user satestlab\\administrator 1
http://infoportal:3141/api/security/counters/open_content/actual_
on?url=http://sharepoint/site
Response body example:
"05/31/2012 1:01 PM"
GET /security/counters/sp_groups
Table 47: GET /security/counters/sp_groups
Description
Query String
Returns
returns the number of SharePoint
groups created on a site collection
within the specified SharePoint site
url=[SITE_URL], where [SITE_URL]
is the site URL used to retrieve the
number of SharePoint groups
l
200 - OK.
l
401 Unauthorized.
l
500 - Internal
Server Error.
Error details
are in response
body
Example:
curl --user satestlab\\administrator 1
http://infoportal:3141/api/security/counters/sp_groups?url=http://sharepoint/site
Response body example:
{
"actual_on": "12/28/2011 12:14 PM", // time when data was cached
"time_estimation": 60, // estimated time to update the cache
"data":{
"value": 20, // SharePoint groups number
"errors": [] // list of errors (if any occur)
}
}
Response body example if an error occurs:
Site Administrator for SharePoint 5.2.3 User Guide
Site Administrator for SharePoint REST
128
{
"actual_on": "12/28/2011 12:14 PM", // time when data was cached "time_estimation":
60, // estimated time to update the cache
"data":{
"value": 20, // SharePoint groups number
"errors": [{
"errors": "[email protected]_Content_100",
"errors": "(ProgrammingError) ('42000', '[42000] [Microsoft][ODBC SQL Server
Driver][SQL Server]Cannot open database...Invalid connection string attribute (0)
') None None"
}]
}
}
PUT /security/counters/sp_groups
Table 48: PUT /security/counters/sp_groups
Description
Query String
Returns
updates the number of
SharePoint groups for the
specified site
url=[SITE_URL], where [SITE_URL] is the
site URL used to update the number of unique
permissions
l
200 - OK.
l
401 - Unauthorized.
l
500 - Internal Server
Error. Error details
are in response
body
Example:
curl --user satestlab\\administrator 1 -X PUT
http://infoportal:3141/api/security/counters/sp_groups?url=http://sharepoint/site
GET /security/counters/sp_groups/actual_on
Table 49: GET /security/counters/sp_groups/actual_on
Description
Query String
Returns
retrieves the date and time when the
number of SharePoint groups was last
updated
url=[SITE_URL], where [SITE_URL] is
the site URL used to retrieve
information
l
200 - OK.
l
401 - Unauthorized.
l
500 - Internal Server
Error. Error details
are in response body
Example:
Site Administrator for SharePoint 5.2.3 User Guide
Site Administrator for SharePoint REST
129
curl --user satestlab\\administrator 1
http://infoportal:3141/api/security/counters/sp_groups/actual_
on?url=http://sharepoint/site
Response body example:
"2/18/2012 1:01 PM"
GET /usage
Table 50: GET /usage
Description
Query String
Returns
retrieves the usage
statistics for the specified
site including its sub-sites
url=[SITE_URL][&period][&limit=DATA_LIMIT]
[&extensions=DATA_EXTENSION]
l
[SITE_URL] - the site collection or site URL used
to retrieve the usage information.
l
[&period] - if this parameter is specified, the
retrieved information will be limited by
SharePoint defaults.
l
[&extensions=DATA_EXTENSION] - the list of
file extensions to be displayed in the most_
active_pages table. Use a comma ( , ) to separate
file extensions
l
200 - OK.
l
401 Unauthorized.
l
500 - Internal
Server Error.
Error details
are in
response body
Example:
curl --ntlm --user satestlab\\administrator:1
http://siteadmin:3141/api/usage?url=http://sharepoint/site&period&limit=10&extensions=
pdf,doc,aspx
Response body example:
{
"actual_on": "06/25/2012 10:46:03 AM", // time when data was cached
"estimation_time": 12, // estimated time to update the cache
"data":
{
"page views": [{"date": "2012.06.18", "views": 10},...], // list of views by date
"most_long_visited_sites": [{"url": "http://osasps/web1", "is_tls": false, "last_
accessed_dates": "May 22, 2012", "visits": 0, "title": "web1"}, ...], // top 5 long
unused sites
"visitors": [{"display_name": "administrator", "name": "satestlab\\administrator",
"visits": 18}, ... ], // top 5 most active visitors
"most_active_pages": [{"name": "page", "url": "http://osasps/page.aspx", "visits": 5,
"site_url": "http://osasps", "last_access_date": 1341385200.0, "site_title":
"RootTls"}, ... ],
"summary": {"day_last_accessed": "Jul 05, 2012", // date when site was last accessed
Site Administrator for SharePoint 5.2.3 User Guide
Site Administrator for SharePoint REST
130
"avg_views": 0, // average views by period
"subsites": 2, // subsites number
"total_views": 23, // total number of views
"day_last_modified": "Jul 05, 2012", // date of last modification
"unique_users": 2, // unique users number
"unique_pages": 12,}, // number of pages and documents accessed over a month's period
"least_visited_sites": [{"url":"http://osasps/web1", "is_tls": false, "visits": 0,
"title": "web1"}, ... ], // top 5 least visited sites
"most_visited_sites": [{"url": "http://osasps", "is_tls": false, "visits": 21,
"title": "Root Tls"}, ... ] // top 5 most visited sites
}
}
PUT /usage
Table 51: PUT /usage
Description
Query String
Returns
updates the usage
statistics for the
specified site including
its sub-sites
url=[SITE_URL][&period][&limit=DATA_LIMIT]
[&extensions=DATA_EXTENSION]
l
[SITE_URL] - the site collection or site URL used
to retrieve the usage information.
l
[&period] - if this parameter is specified, the
retrieved information will be limited by
SharePoint defaults.
l
[&extensions=DATA_EXTENSION] - the list of
file extensions to be displayed in the most_
active_pages table. Use a comma ( , ) to separate
file extensions
l
200 - OK.
l
401 Unauthorized.
l
500 - Internal
Server Error.
Error details
are in
response body
Example:
curl --ntlm --user satestlab\\administrator:1 -X PUT
http://siteadmin:3141/api/usage?url=http://sharepoint/site&period
GET /usage/actual_on
Table 52: GET /usage/actual_on
Description
Query String
retrieves the date and
time when the usage
information was last
updated
url=[SITE_URL][&period][&limit=DATA_LIMIT]
[&extensions=DATA_EXTENSION]
l
Returns
[SITE_URL] - the site collection or site URL
l
200 - OK.
l
401 Unauthorized.
Site Administrator for SharePoint 5.2.3 User Guide
Site Administrator for SharePoint REST
131
Description
Query String
Returns
used to retrieve the usage information.
l
[&period] - if this parameter is specified, the
retrieved information will be limited by
SharePoint defaults.
l
[&extensions=DATA_EXTENSION] - the list of
file extensions to be displayed in the most_
active_pages table. Use a comma ( , ) to separate
file extensions
l
500 - Internal
Server Error.
Error details
are in
response body
Example:
curl --ntlm --user satestlab\\administrator:1 http://siteadmin:3141/api/usage/actual_
on?url=http://sharepoint/site&period
Response body example:
"2/18/2012 1:01 PM"
GET /usage/counters/unused_pages
Table 53: GET /usage/counters/unused_pages
Description
Query String
Returns
returns the total number of unused
documents (including attachments and .aspx
pages) over a month's period within the
specified site collection or site
url=[SITE_URL], where [SITE_
URL] is the site collection or site URL
used to calculate the number of
unused documents
l
200 - OK.
l
401 Unauthorized.
l
500 - Internal
Server Error.
Error details
are in
response body
Example:
curl --ntlm --user satestlab\\administrator:1
http://ip1sp2k10:3141/api/usage/counters/unused_pages?url=http://sharepoint/site
Response body example:
{
"actual_on": "5/23/2012 12:23 PM", // time when data was cached
"time_estimation": 23, // estimated time to update the cache
"data":157
}
Site Administrator for SharePoint 5.2.3 User Guide
Site Administrator for SharePoint REST
132
PUT /usage/counters/unused_pages
Table 54: PUT /usage/counters/unused_pages
Description
Query String
Returns
updates the number of unused
documents for the specified
site collection or site
url=[SITE_URL], where [SITE_URL] is the
site collection or site URL used to calculate the
number of unused documents
l
200 - OK.
l
401 Unauthorized.
l
500 - Internal
Server Error.
Error details are
in response
body
Example:
curl --ntlm --user satestlab\\administrator:1 -X PUT
http://ip1sp2k10:3141/api/usage/counters/unused_pages?url=http://sharepoint/site
GET /usage/counters/unused_pages/actual_on
Table 55: GET /usage/counters/unused_pages/actual_on
Description
Query String
Returns
retrieves the date and time when
the total number of unused
documents was last updated
url=[SITE_URL], where [SITE_URL] is the
site collection or site URL used to calculate the
number of unused documents
l
200 - OK.
l
401 Unauthorized.
l
500 - Internal
Server Error.
Error details
are in response
body
Example:
curl --ntlm --user satestlab\\administrator:1
http://ip1sp2k10:3141//api/usage/counters/unused_pages/actual_
on?url=http://sharepoint/site
Response body example:
"2/18/2012 1:01 PM"
Site Administrator for SharePoint 5.2.3 User Guide
Site Administrator for SharePoint REST
133
GET /document/counters/docs_and_pages
Table 56: GET /document/counters/docs_and_pages
Description
Query String
Returns
retrieves the total number of documents (including
attachments and .aspx pages) for the specified site
collection or site. Documents, attachments and pages
should not have size = 0 and should have allowed extension
(the list of allowed extensions can be modified on the
Settings page)
url=[SITE_URL],
where [SITE_URL] is
the site collection or
site URL used to
calculate the
documents number
l
200 - OK.
l
401 Unauthorized.
l
500 - Internal
Server Error.
Error details
are in
response body
Example:
curl --ntlm --user satestlab\\administrator:1
http://ip1sp2k10:3141/api/document/counters/docs_and_pages?url=http://sharepoint/site
Response body example:
{
"actual_on": "5/23/2012 12:23 PM", // time when data was cached
"time_estimation": 23, // estimated time to update the cache
"data":157
}
PUT /document/counters/docs_and_pages
Table 57: PUT /document/counters/docs_and_pages
Description
Query String
Returns
updates the number of
documents for the
specified site
url=[SITE_URL], where [SITE_URL] is the site
collection or site URL used to calculate the
documents number
l
200 - OK.
l
401 - Unauthorized.
l
500 - Internal
Server Error. Error
details are in
response body
Example:
curl --ntlm --user satestlab\\administrator:1 -X PUT
http://ip1sp2k10:3141/api/document/counters/docs_and_pages?url=http://sharepoint/site
Site Administrator for SharePoint 5.2.3 User Guide
Site Administrator for SharePoint REST
134
GET /document/counters/docs_and_pages/actual_on
Table 58: GET /document/counters/docs_and_pages/actual_on
Description
Query String
Returns
retrieves the date and time
when the documents number
was last updated
url=[SITE_URL], where [SITE_URL] is the
site collection or site URL used to calculate the
documents number
l
200 - OK.
l
401 Unauthorized.
l
500 - Internal
Server Error.
Error details are
in response body
Example:
curl --ntlm --user satestlab\\administrator:1
http://ip1sp2k10:3141/api//document/counters/docs_and_pages/actual_
on?url=http://sharepoint/site
Response body example:
"2/18/2012 1:01 PM"
GET /activity/changes
Table 59: GET /activity/changes
Description
Query String
Returns
retrieves
information
on the
content
changes
made within
the selected
site
url=[SITE_URL][&period], where [SITE_URL] is the site
collection or site URL used to retrieve information on the content
changes, [&period] is an optional parameter that specifies whether
the retrieved data is limited by date or not. If the parameter is not
set, all data will be retrieved. If it is set (and no value is specified),
the data over past 15 days for SharePoint 2007 and 30 days for
SharePoint 2010 will be retrieved
l
200 - OK.
l
401 Unauthorized.
l
500 - Internal
Server Error.
Error details
are in
response body
Example:
curl --ntlm --user satestlab\\administrator:1
http://siteadmin:3141/api/activity/changes?url=http://sharepoint/site
curl --ntlm --user satestlab\\administrator:1
http://siteadmin:3141/api/activity/changes?url=http://sharepoint/site&period
Response body example:
{
"actual_on": "06/25/2012 10:46:03 AM", // time when data was cached
"estimation_time": 12, // estimated time to update the cache
Site Administrator for SharePoint 5.2.3 User Guide
Site Administrator for SharePoint REST
135
"data": {"users":2,"changes":45,"days":80},
"errors": [] // list of errors (if any occur)
}
PUT /activity/changes
Table 60: PUT /activity/changes
Description
Query String
Returns
updates
information
on the
content
changes
made within
the selected
site
url=[SITE_URL][&period], where [SITE_URL] is the site
collection or site URL used to retrieve information on the content
changes, [&period] is an optional parameter that specifies whether
the retrieved data is limited by date or not. If the parameter is not
set, all data will be retrieved. If it is set (and no value is specified),
the data over past 15 days for SharePoint 2007 and 30 days for
SharePoint 2010 will be retrieved
l
200 - OK.
l
401 Unauthorized.
l
500 - Internal
Server Error.
Error details
are in
response body
Example:
curl --ntlm --user satestlab\\administrator:1 -X PUT
http://siteadmin:3141/api/activity/changes?url=http://sharepoint/site
curl --ntlm --user satestlab\\administrator:1 -X PUT
http://siteadmin:3141/api/activity/changes?url=http://sharepoint/site&period
GET /activity/changes/actual_on
Table 61: GET /activity/changes/actual_on
Description
Query String
Returns
retrieves
the date
and time
when
information
on the
content
changes was
updated
url=[SITE_URL][&period], where [SITE_URL] is the site
collection or site URL used to retrieve information on the content
changes, [&period] is an optional parameter that specifies whether
the retrieved data is limited by date or not. If the parameter is not
set, all data will be retrieved. If it is set (and no value is specified),
the data over past 15 days for SharePoint 2007 and 30 days for
SharePoint 2010 will be retrieved
l
200 - OK.
l
401 Unauthorized.
l
500 - Internal
Server Error.
Error details
are in
response body
Example:
curl --ntlm --user satestlab\\administrator:1
http://siteadmin:3141/api/activity/changes/actual_on?url=http://sharepoint/site&period
Response body example:
"2/18/2012 1:01 PM"
Site Administrator for SharePoint 5.2.3 User Guide
Site Administrator for SharePoint REST
136
GET /activity/users/most_active
Table 62: GET /activity/users/most_active
Description
Query String
Returns
retrieves the
list of most
active editors
of SharePoint
content or
security
within the
specified site
url=[SITE_URL][&period], where [SITE_URL] is the site
collection or site URL used to retrieve information on the active
users, [&period] is an optional parameter that specifies whether
the retrieved data is limited by date or not. If the parameter is not
set, all data will be retrieved. If it is set (and no value is specified),
the data over past 15 days for SharePoint 2007 and 30 days for
SharePoint 2010 will be retrieved
l
200 - OK.
l
401 Unauthorized.
l
500 - Internal
Server Error.
Error details
are in
response body
Example:
curl --ntlm --user satestlab\\administrator:1
http://ip1sp2k10:3141/api/activity/users/most_active?url=http://sharepoint/site
curl --ntlm --user satestlab\\administrator:1
http://ip1sp2k10:3141/api/activity/users/most_
active?url=http://sharepoint/site&limited_period
Response body example:
{
"actual_on": "06/25/2012 10:46:03 AM", // time when data was cached
"estimation_time": 12 // estimated time to update the cache
"data": // list of most active editors
[
{"name":"John Smith", "changes":45},
{"name":"Ben Johnson", "changes":23}
]
,
"errors": [] // list of errors
}
PUT /activity/users/most_active
Table 63: PUT /activity/users/most_active
Description
Query String
Returns
updates the list of
active users for the
specified site
url=[SITE_URL], where [SITE_URL] is the site
collection or site URL used to retrieve the list of
active users
l
200 - OK.
l
401 - Unauthorized.
Site Administrator for SharePoint 5.2.3 User Guide
Site Administrator for SharePoint REST
137
Description
Query String
Returns
l
500 - Internal Server
Error. Error details
are in response body
Example:
curl --ntlm --user satestlab\\administrator:1 -X PUT
http://ip1sp2k10:3141/api/activity/users/most_active?url=http://sharepoint/site
GET /activity/users/most_active/actual_on
Table 64: GET /activity/users/most_active/actual_on
Description
Query String
Returns
retrieves the date and time
when the list of most active
editors was last updated
url=[SITE_URL], where [SITE_URL] is the
site collection or site URL used to retrieve the
list of the most active users
l
200 - OK.
l
401 Unauthorized.
l
500 - Internal
Server Error.
Error details are
in response
body
Example:
curl --ntlm --user satestlab\\administrator:1
http://ip1sp2k10:3141/api/activity/users/most_active/actual_
on?url=http://sharepoint/site
Response body example:
"2/18/2012 1:01 PM"
GET /schedule/report
NOTE: This method is available only for Information Portal administrators.
Table 65: GET /schedule/report
Description
returns all schedule information
for the given scope, report name
and target parameters
Query String
l
Returns
report_name:[REPORTNAME]-the name
of the report to be scheduled for
export
l
url:[URL] - the scope URL (Enterprise,
Farms, Web Applications and Sites)
l
target: [TARGET] - can be either csv or
sql. By default, the value is set to csv.
Please note that the value is casesensitive
l
200 - OK.
l
401 Unauthorized.
l
500 - Internal
Server Error.
Error details
are in response
body
Site Administrator for SharePoint 5.2.3 User Guide
Site Administrator for SharePoint REST
138
Example:
curl --user satestlab\administrator:1
http://infoportal:3141/api/schedule/report?report_
name=sites&url=http://sharepoint/site&target=csv
Response body example:
[
{
"TaskToRun": "\"C:\\Program Files (x86)\\Dell\\Site Administrator for
SharePoint\\SharePoint Information Portal\\Application\\scheduler\\runner.bat\" SASP_
Reports_Monthly_task", // specify the task action
"selected": true, // the flag indicating which scheduler type is set
"occurrence": "2",
"Author": "Administrator", // the task author
"ShareLocalPath": "C:\\Program Files (x86)\\Dell\\Site Administrator for
SharePoint\\SharePoint Information Portal\\Exports", // the local directory to share
"NetbiosName": "INFOPORTAL", // Network Basic Input/ Output System name
"NextRunTime": "2/1/2013 2:00:00 AM", // indicates when the task will run next time
"ScheduleType": "Monthly", // the schedule type value
"Status": "Ready", // the task status value
"StartDate": "12/19/2012", // the date when the task will be started
"Repeat": "Stop If Still Running: Disabled",
"EndDate": "N/A",
"Description": "Monthly", // the description text
"Schedule": "Scheduling data is not available in this format.",
"IdleTime": "Disabled",
"HostName": "INFOPORTAL", // the host name where the task is running
"ScheduledTaskState": "Enabled",
"LastResult": "1",
"ShareNetworkPath": "\\\\INFOPORTAL\\SASP_Exports", // the network path to share
"DeleteTaskIfNotRescheduled": "Enabled",
"StartIn": "N/A",
"RunAsUser": "satestlab\\administrator", // the user running the task
"Months": ["Every month"], // months to run the task
"Days": ["01"], // indicates what day of the month the task will be run
"PowerManagement": "Stop On Battery Mode, No Start On Batteries",
"LastRunTime": "N/A",
"TaskName": "SASP_Reports_Monthly_task", // the task name
"Comment": "N/A",
Site Administrator for SharePoint 5.2.3 User Guide
Site Administrator for SharePoint REST
139
"FileName": "sites_%TIMESTAMP%", // the report file name format
"StopTaskIfRunsXHoursandXMins": "72:00:00",
"StartTime": "2:00:00 AM",
"LogonMode": "Interactive/Background"
// these two values are returned for export to SQL.
"SqlServer": "SqlServerHostName", // the sql server host name "Database": "dbName" //
the database name
},
{...}, {...}
]
PUT /schedule/report
NOTE: This method is available only for Information Portal administrators.
Table 66: PUT /schedule/report
Description
enables
scheduling for
the report
export
Query String
l
Returns
task_id: [TASKID] - the scheduler task type (SASP_Reports_
Custom_task, SASP_Reports_Monthly_task, SASP_Reports_
Quarterly_task and SASP_Reports_Weekly_task)
l
report_name: [REPORTNAME] - the name of the report to
be scheduled for export
l
url: [URL] - the scope URL (Enterprise, Farms, Web
Applications and Sites)
l
target: [TARGET] - can be either csv or sql. By default, the
value is set to csv. Please note that the value is casesensitive
l
200 - OK.
l
401 Unauthorized.
l
500 - Internal
Server Error.
Error details are
in response
body
Example:
curl --user satestlab\administrator:1 -X PUT -d "task_id=SASP_Reports_Monthly_
task&report_name=sites&url=http://sharepoint/site&target=sql"
http://infoportal:3141/api/schedule/report
DELETE /schedule/report
NOTE: This method is available only for Information Portal administrators.
Table 67: DELETE /schedule/report
Description
disables
scheduling for
the report
Query String
l
Returns
task_id: [TASKID] - the scheduler task type (SASP_Reports_
Custom_task, SASP_Reports_Monthly_task, SASP_Reports_
Quarterly_task and SASP_Reports_Weekly_task)
l
200 - OK.
l
401 -
Site Administrator for SharePoint 5.2.3 User Guide
Site Administrator for SharePoint REST
140
Description
export
Query String
Returns
l
report_name: [REPORTNAME] - the name of the report to
be scheduled for export
l
url: [URL] - the scope URL (Enterprise, Farms, Web
Applications and Sites)
l
target: [TARGET] - can be either csv or sql. By default, the
value is set to csv. Please note that the value is casesensitive
Unauthorized.
500 - Internal
Server Error.
Error details are
in response
body
l
Example:
curl --user satestlab\administrator:1 -X DELETE -d "task_id=SASP_Reports_Monthly_
task&report_name=sites&url=http://sharepoint/site&target=sql"
http://infoportal:3141/api/schedule/report
POST /job/disallow_everyone
Table 68: POST /job/disallow_everyone
Description
Query String
Returns
creates a policy to prevent NT
AUTHORITY\authenticated users from being
used for permissioning and applies it to the
specified site collection or web application
siteurl=[SITE_URL], where
[SITE_URL] is the site collection or
web application URL to which you
want to apply the policy
run_type=policy
l
200 - OK.
l
401 Unauthorized.
l
500 - Internal
Server Error.
Error details
are in
response body
Example:
curl --ntlm --user [email protected]:1 -X POST -d '
{"siteurl":"http://sp14-alt/sites/Test", "run_type":"policy"}' http://sp14alt:3141/api/job/disallow_everyone
DELETE /job/disallow_everyone
Table 69: DELETE /job/disallow_everyone
Description
Query String
Returns
deletes the policy for the
specified site collection or
web application
siteurl=[SITE_URL], where [SITE_URL] is the
site collection or web application URL for which you
want to delete the policy
l
200 - OK.
l
401 Unauthorized.
l
500 - Internal
Site Administrator for SharePoint 5.2.3 User Guide
Site Administrator for SharePoint REST
141
Description
Query String
Returns
Server Error.
Error details are
in response body
Example:
curl --ntlm --user [email protected]:1 -X DELETE -d '
{"siteurl":"http://sp14-alt/sites/Test"}' http://sp14-alt:3141/api/job/disallow_
everyone
GET /job/disallow_everyone
Table 70: GET /job/disallow_everyone
Description
Query String
Returns
returns policy details for the
specified site collection or
web application
siteurl=[SITE_URL], where [SITE_URL] is the
site collection or web application URL used to
retrieve the policy details
l
200 - OK.
l
401 Unauthorized.
l
500 - Internal
Server Error.
Error details are
in response body
Example:
curl --ntlm --user [email protected]:1 -X GET http://sp14alt:3141/api/job/disallow_everyone?siteurl=http://sp14-alt/sites/Test
Response body example:
{
"job_type": "disallow_everyone",
"sch_type": "policy",
"agent": "sp14-alt",
"scope": "http://sp14-alt/sites/Test/SubSite1/",
"user_name": "VELASKEC\Administrator",
"create_time": 1341873885.0,
"status": -1,
"args": {"with_subsites": true, "run_type": "policy", "siteurl":"http://sp14alt/sites/Test/SubSite1"},
"id":15
}
here:
Site Administrator for SharePoint 5.2.3 User Guide
Site Administrator for SharePoint REST
142
l
job_type - the job name, const = disallow_everyone
l
sch_type - execution type, const = policy
l
agent - the netbios name of the InfoPoral agent running the job
l
scope- the site collection or web application url to which the policy is applied
l
user_name - the user name who created the task
l
create_time - the time when the policy was created in numeric format
l
status - the task status:
l
NULL - the job execution has not started yet
l
1 - the job is in progress
l
100 - the job is completed
l
-1 - an error has occurred during the job execution
l
args - policy settings
l
siteurl - the site collection or web url to which the policy is applied
l
with_subsites - applies the policy to all subsites recursively
POST /job/propagate_version_settings
Table 71: POST /job/propagate_version_settings
Description
Query String
Returns
creates a policy to set version settings for
document libraries within the specified site
collection or site
{
l
200 - OK.
siteurl:[SITE_URL] // site url to
propagate settings
l
401 Unauthorized.
keep_major: [TRUE / FALSE] //
limit the number of major versions
flag
l
500 - Internal
Server Error.
Error details are
in response body
keep_draft: [TRUE / FALSE] // limit
the number of minor versions flag
major: [NUMBER] // number of
major versions to keep
minor: [NUMBER] // number of
minor versions to keep
do_cleanup: [TRUE/FALSE] //
cleanup flag for the first apply
time run_type=policy
}
Example:
curl --ntlm --user caissa\\administrator:1 -X POST -d
{"siteurl":"http://sp2007single/sites/Test","keep_draft":true,"keep_
major":true,"major":5,"minor":3,"run_type":"policy","do_cleanup":true}
http://sp2007single:3141/api/job/propagate_version_settings
Site Administrator for SharePoint 5.2.3 User Guide
Site Administrator for SharePoint REST
143
DELETE /job/propagate_version_settings
Table 72: DELETE /job/propagate_version_settings
Description
Query String
Returns
deletes the policy for
the specified site
collection or site
siteurl=[SITE_URL], where [SITE_URL] is the
site collection or site URL for which you want to
disable the policy
l
200 - OK.
l
401 - Unauthorized.
l
500 - Internal
Server Error. Error
details are in
response body
Example:
curl --ntlm --user [email protected]:1 -X DELETE -d '
{"siteurl":"http://sp14-alt/sites/Test"}' http://sp14-alt:3141/api/job/propagate_
version_settings
GET /job/propagate_version_settings
Table 73: GET /job/propagate_version_settings
Description
Query String
Returns
returns policy details for
the specified site
collection or site
siteurl=[SITE_URL], where [SITE_URL] is the
site collection or site URL for which you want to
retrieve the policy details
l
200 - OK.
l
401 Unauthorized.
l
500 - Internal
Server Error.
Error details are
in response body
Example:
curl --ntlm --user caissa\administrator:1 -X GET
http://sp2007single:3141/api/job/propagate_version_
settings?siteurl=http://sp2007single/sites/Test&run_type=policy
Response body example:
{
"job_type": "propagate_version_settings", // job name
"sch_type": "policy", // execution type
"agent": "sp2007single", // netbios name of the InfoPoral agent running the job
"scope": "http://sp2007single/sites/Test" // site url to propagate settings
"user_name": "UTAH\administrator", // user name who created the task
"create_time": 1342100767, // creation time (UTC) in numeric format "status": 100, //
task status:
Site Administrator for SharePoint 5.2.3 User Guide
Site Administrator for SharePoint REST
144
// NULL has not been executed yet
// 1 is in progress
// 100 done
// -1 an error occurred
"args": { // version settings to propagate:
"siteurl": "http://sharepoint/site", // site url to propagate settings
"keep_major": true, // limit number of major versions flag
"keep_draft": false, // limit number of minor versions flag
"major": 5, // number of major versions to keep
"minor": 0, // number of minor versions to keep
}
}
POST /job/restore_broken_inheritance
Table 74: POST /job/restore_broken_inheritance
Description
Query String
Returns
creates a policy to restore broken
permissions inheritance for a site
including its subsites and items
siteurl=[SITE_URL], where [SITE_
URL] is the site collection or web URL the
policy is to be applied to
run_type=policy
l
200 - OK.
l
401 Unauthorized.
l
500 - Internal
Server Error.
Error details are
in response
body
Example:
curl --ntlm --user warrior\administrator:1 -X POST -d '{"siteurl":"http://warrior101/sites/Test", "run_type":"policy"}' http://warrior10-1:3141/api/job/restore_broken_
inheritance
DELETE /job/restore_broken_inheritance
Table 75: DELETE /job/restore_broken_inheritance
Description
Query String
Returns
disables the policy
for the specified
site
siteurl=[SITE_URL], where [SITE_URL] is the site
collection or web URL for which you want to disable the
policy
l
200 - OK.
l
401 - Unauthorized.
run_type=policy
l
500 - Internal Server
Error. Error details
are in response body
Site Administrator for SharePoint 5.2.3 User Guide
Site Administrator for SharePoint REST
145
Example:
curl --ntlm --user warrior\administrator:1 -X DELETE http://warrior101:3141/api/job/restore_broken_inheritance?siteurl=http://warrior10-1/sites/Test&run_
type=policy
GET /job/restore_broken_inheritance
Table 76: GET /job/restore_broken_inheritance
Description
Query String
Returns
returns policy
details for the
specified site
siteurl=[SITE_URL], where [SITE_URL] is the site
collection or web URL used to retrieve the policy
details
l
200 - OK.
l
401 - Unauthorized.
run_type=policy
l
500 - Internal Server
Error. Error details
are in response body
Example:
curl --ntlm --user warrior\administrator:1 -X GET http://warrior101:3141/api/job/restore_broken_inheritance?siteurl=http://warrior10-1/sites/Test
Response body example:
{
"job_type": "restore_broken_inheritance",
"sch_type": "policy",
"agent": "warrior10-1",
"scope": "http://warrior10-1/sites/Test/SubSite1/",
"user_name": "warrior\Administrator",
"create_time": 1341873885.0,
"status": -1,
"args": {"with_subsites": true, "run_type": "policy", "siteurl":"http://warrior101/sites/Test/SubSite1"},
"id":15
}
here:
l
job_type - the job name, const = restore_broken_inheritance
l
sch_type - execution type, const = policy
l
agent - the netbios name of the InfoPoral agent running the job
l
scope - the site collection or web url to which the policy is applied
l
user_name - the user name who is created the task
l
create_time - the time when the policy was created
Site Administrator for SharePoint 5.2.3 User Guide
Site Administrator for SharePoint REST
146
l
status - the task status:
l
NULL - the job execution has not started yet
l
1 - the job is in progress
l
100 - the job is completed
l
-1 - an error has occurred during the job execution
l
args - policy settings
l
siteurl - the site collection or web url to which the policy is applied
l
with_subsites - applies the policy to all subsites recursively
Site Administrator for SharePoint 5.2.3 User Guide
Site Administrator for SharePoint REST
147
Site Administrator for SharePoint
Scripts
In this section:
l
CSV to SQL Export
l
Export Grid Reports to PDF
l
Clean Up Report Data
l
Clean Up Usage Collector Data
l
Data Gathering for Enterprise Level Reports
CSV to SQL Export
You can export report data from a generated CSV file to any SQL database table using a script located in the
{SA4SP installation folder}/SharePoint Information Portal/Scripts/CSV2SQL folder.
If the target table exists, the tool appends new data without modifying existing data.
NOTE: The following file formats are supported for export: .csv and .zip (CSV files compressed using zip).
Prerequisites
Before you run the script, make sure the following software is installed on the machine:
l
.Net 2.0 or later.
One of the following:
l
SQL Server 2005
l
SQL Server 2008
l
SQL SERVER 2012
Synopsis and Usage
To export report data from CSV to SQL, run python.exe csv2sql.py [options] or csv2sql.cmd
[options].
Options:
l
-h, --help - shows this help message and exits
l
-p CSVPATH, --csvPath=CSVPATH - the path to the csv file
Site Administrator for SharePoint 5.2.3 User Guide
Site Administrator for SharePoint Scripts
148
l
-s DBSERVER, --dbServer=DBSERVER - the database server host
l
-d DBNAME, --dbName=DBNAME - the name of the database to be used for csv to sql export
-t TABLENAME, --tableName=TABLENAME - the table name (same as the report name)
l
The -p, -s, -d, -t options are required to be specified. If they are not specified or incorrect, the usage
information will be displayed.
Exit Code Description:
1 – An exception occurred
2 -- No input parameters are specified
3 -- The parameter is incomplete
Example:
python.exe csv2sql.py -p "c:\documentreport\documentreport.csv" -s "Warrior10-1" -d
"QSP_Repository" -t "DocumentDetails"
Command line examples:
csv2sql.cmd "c:\documentreport\documentreport.zip" "Warrior10-1" "QSP_Repository"
"DocumentDetails"
csv2sql.cmd "c:\documentreport\ContentDataBase.csv" "Warrior10-1" "QSP_Repository"
"ContentDataBaseReport"
Export Grid Reports to PDF
You can export grid reports to PDF using a script located in the {SA4SP installation folder}/ SharePoint
Information Portal\OData2PDF folder.
Synopsis and Usage
To export report data to PDF, run OData2PDF.cmd [options].
Options:
l
l
l
-h, --help - shows this help message and exits
-u, --URL - the ODataService URL in the http://127.0.0.1:[ ODataService port]/[name of
the data table]?[ODATA filter] format
-t, --template - the template name
The -u, -t options are required to be specified. If they are not specified or incorrect, the usage information
will be displayed.
Exit Code Description:
2 – An error occurred when retrieving data from the OData service
Site Administrator for SharePoint 5.2.3 User Guide
Site Administrator for SharePoint Scripts
149
1 – An exception occurred
0 – The operation completed successfully
-1 – BIRT error occurred
The following example will generate a PDF file with 10 sites created after December 9, 2012 and number of
views not equal to 0. $top=10&$filter=(Created gt datetime'2012-04-09' and (Views ne 0)) is the ODATA filter. For
more information refer to http://www.odata.org/docs/ and http://www.odata.org/documentation/odata-v3documentation/odata-core/.
NOTE: By default port 3147 is used by ODataService. In case it is busy, use the port specified in the Site
Administrator for SharePoint\SharePoint Information
Portal\OData4SQL\OdataProvider\WebSettings.conf (server.socket_port variable value).
NOTE: PDF files will be stored in the {SA4SP installation folder}/ SharePoint Information
Portal\OData2PDF\exportFiles folder.
NOTE: The Site Administrator for SharePoint package contains the 64 bit version of Java Runtime
Environment. If you are running a 32-bit Windows operating systems, you can install the 32 bit Java
version. In this case, you will need to modify the JAVA_HOME and JAVACMD variables in the Site
Administrator for SharePoint\SharePoint Information Portal\birtruntime\ReportEngine\genReport.bat file.
NOTE: When exporting a large amount of data to PDF, the Java process for BIRT requires sufficient
physical memory, otherwise, there will be errors when generating PDF files and data will be
incomplete. As a workaround, set the maximum Java heap size.
Table 77: Template Names for Grid Reports
Report
Template Name
Data Table
Documents and Pages
documents_and_pages_report
sa4sp_repdata2_documents_and_pages
Sites
sites_report
sa4sp_repdata2_sites
Site Collections
site_collections_report
sa4sp_repdata2_site_collections
Content Databases
contentdbs_report
sa4sp_repdata2_contentdbs
Web Applications
webapps_report
sa4sp_repdata2_webapps
Example:
OData2PDF.cmd -u “http://127.0.0.1:3147/sa4sp_repdata2_sites?$top=10&$filter=(Created gt datetime'2012-1209')” -t "sites_report"
Clean Up Report Data
To clean up old report data exported to SQL by the CSV to SQL command line tool or by schedule, use a script
located in the {SA4SP installation folder}/SharePoint Information Portal/Scripts/CleanUpReporting folder.
Site Administrator for SharePoint 5.2.3 User Guide
Site Administrator for SharePoint Scripts
150
Synopsis and Usage
To clean up report data, run python.exe cleanup_reporting.py [options] or cleanup_
reporting.cmd [options].
Options:
l
-h, --help - shows this help message and exits
l
-s DBSERVER, --dbServer=DBSERVER - the database server host
l
l
-d DBNAME, --dbName=DBNAME - the name of the database to be cleaned up
-n NUMBEROFDAY , --numberOfDay=NUMBEROFDAY - specifies the cutoff date for deleting report
data. All report data that was collected the specified number of days ago and earlier will be deleted.
The -s, -d, -n options are required to be specified. If they are not specified or incorrect, the usage
information will be displayed.
Exit Code Description:
1 -- Exception occurred
2 -- No input parameters are specified
3 -- The parameter is incomplete
Example:
python.exe cleanup_reporting.py Warrior10-1 QSP_Reporsitory 12
Command line examples:
cleanup_reporting.cmd Warrior10-1 QSP_Reporsitory 12
Clean Up Usage Collector Data
Site Administrator for SharePoint stores the usage report data in the QSP_Repository database. Over time, the
usage data collection results in growth of the database as a result of the usage collector work. To prevent
unlimited growth and impact on the report performance, Site Administrator provides a script allowing users to
purge old data from the database.
The script removes data older than N days specified as an input parameter. At the same time, it preserves the
most recent data on each page and user. This data is displayed as Last accessed in the Activity reports.
NOTE: 31 days are supposed to be specified as an input parameter because the Activity reports require
one month of history data.
NOTE: The script removes data from the [SA4SP_Usage_Users] and [SA4SP_Usage_Pages] tables of the
QSP_Repository database.
Site Administrator for SharePoint 5.2.3 User Guide
Site Administrator for SharePoint Scripts
151
Synopsis and Usage
To purge the usage collector data, run Python.exe cleanup_usage_data [option] or cleanup_usage_
data.cmd [option] located in the {SA4SP installation folder}/SharePoint Information
Portal/UsageCollector folder.
Options:
l
l
-h, --help - shows this help message and exits
-n NUMBEROFDAY , --numberOfDay=NUMBEROFDAY - specifies the cutoff date for deleting the usage
collector data. All data that was collected the specified number of days ago and earlier will be deleted.
The -n option is required to be specified.
Exit Code Description:
1 – An exception occurred
2 -- No input parameters are specified
Example:
python.exe cleanup_usage_data.py -n 31
Command line examples:
cleanup_usage_data.cmd 31
Data Gathering for Enterprise Level
Reports
Information Portal administrators can gather the enterprise level report data to the QSP_Repository database
by running data_gathering.cmd located in the {SA4SP installation folder}/SharePoint Information
Portal/DataGathering folder.
data_gathering.cmd run by Python 2.7 starts the data gathering process.
NOTE: Before data gathering, the tool will discover all SharePoint farms available in your environment
to make sure all changes on the farms are up-to-date.
NOTE: All old data will be cleaned up before writing report data to the database.
The following table lists all enterprise level reports and QSP_Repository database tables to which the report
data is gathered:
Site Administrator for SharePoint 5.2.3 User Guide
Site Administrator for SharePoint Scripts
152
Table 78: Data Tables
Report
Data Table
Documents and Pages
sa4sp_repdata_documents_and_pages
Lists
sa4sp_repdata_lists
Document Libraries
sa4sp_repdata_document_libraries
Sites
sa4sp_repdata_sites
Site Collections
sa4sp_repdata_site_collections
Site Permissions
sa4sp_repdata_site_permissions
Security Changes
sa4sp_repdata_activity_security
Content Changes
sa4sp_repdata_activity_content
Daily Usage
sa4sp_repdata_daily_active_users
Content Databases
sa4sp_repdata_contentdbs
Web Applications
sa4sp_repdata_webapps
Servers
sa4sp_repdata_servers
Site Administrator for SharePoint 5.2.3 User Guide
Site Administrator for SharePoint Scripts
153
FAQ
l
How to Install Information Portal Using Command Line
l
How to Get the Best Performance for Multiple Concurrent Users Working with Information Portal
l
How to Install Information Portal SharePoint Solution (SharePoint Integration Module) without Installing
Full Information Portal Setup on a SharePoint Front-end Server
l
How to Uninstall Information Portal SharePoint Solution (SharePoint Integration Module)
l
How to Automate PDF Export of Site Metrics Report for Specific Site
l
How to Configure IIS 7 as Web Front-end Server for Information Portal
l
How to Change Port for Information Portal
l
How to Change Ports for Information Portal Services
l
How to Change Password for Install and Service Accounts
l
What Permissions Are Required for Site Owners
l
Why is the Actual Size of the SharePoint Content Database Shown in the Reports Much Bigger than Size
of the Site Collection Located in this Database?
l
Information Portal Reports Show Zero or N/A in Usage Data (e.g. the Number of Views, the Number of
Users, Most Used Content)
l
Information Portal Detailed Reports (Site Collections, Sites, Documents, Lists, Document Libraries)
Display Only 20 Records. How to View all Results if the Number of Objects Exceeds this Limit?
l
Why Is the Site Size Different in Enterprise/Site Metrics and Sites Reports?
l
How to Clear Authorization Cache
l
How to Move Reporting Database to Another SQL Server
l
How to View What Users are Using Site Administrator for SharePoint
l
How to Override Add Farm Behavior
l
Information Portal Advanced Troubleshooting
How to Install Information Portal Using
Command Line
To install Information Portal using the command line, run the following command: msiexec /i qsInfoPortal.msi
/quiet AGENT_ACCOUNT=%1 AGENT_PASSWORD=%2 SQLSERVER=%3 DBNAME=%4 /lv! ipsetup.log.
Site Administrator for SharePoint 5.2.3 User Guide
FAQ
154
How to Get the Best Performance for
Multiple Concurrent Users Working with
Information Portal
If hundred of users work with Information Portal reports, it is recommended to deploy multiple instances
configuration.
Perform the following steps:
1. Run cmd.exe as Administrator.
2. Change directory to [Product Install Path]\SharePoint Information Portal\Scripts.
3. Run balancer.cmd "[domainuser]" "[password]", where [domainuser] and [password] is the service
account used for the Web Access service.
By default, the script creates 8 instances for Web Access, which can be found in the services.msc snapin. It may
be required to modify the instances number depending on the hardware configuration.
To change the number of the BrowserBroker and BrowserAgent services, modify the following command line
in balancer.cmd: @..\Python25\python.exe balancer.py "%1" "%2" [ApacheInstances]
[BrowserServicesInstances], where [ApacheInstances] is the number of Apache instances (8 by
default) and [BrowserServicesInstances] is the number of BrowserAgent and BrowserBroker instances (4
by default).
To uninstall multiple instances, run remove_balancer.cmd.
NOTE: When uninstalling or upgrading the product, multiple instances are automatically removed. You
should deploy multiple instances configuration using the balancer.cmd script each time you upgrade
the product.
It is also recommended to install Information Portal on several SharePoint front-end servers and configure loadbalancing between them. Installing Information Portal on several front-ends improves the tool performance
and provides fault tolerance.
NOTE: Each Information Portal installation has its own Settings database. So, each setting should be
configured individually on each Information Portal server. The following settings are affected:
Information Portal Administrators, Number of items shown in reports, Show action buttons, License
settings.
How to Install Information Portal
SharePoint Solution (SharePoint
Integration Module) without Installing
Full Information Portal Setup on a
SharePoint Front-end Server
NOTE: Please note that all Information Portal actions (such as permissions grant, revoke, site or copy)
Site Administrator for SharePoint 5.2.3 User Guide
FAQ
155
are available only if Information Portal is installed on a front-end within the farm. The actions will not
work in the described scenario. For more information about action capabilities, see Manage Security.
Applied both for SharePoint 2007, SharePoint 2010 and SharePoint 2013.
Perform the following steps:
1. Install Information Portal on the server where you plan to use it. Save Information Portal Enterprise
Report URL. It should be like: http://info_portal_server:3141.
2. Create a temporary folder on a SharePoint front-end server to deploy the solution. For example:
C:\QuestSPSolution.
3. Copy the [ProductInstalPath]\SharePoint Information Portal\SPIntegration and [ProductInstalPath]
\SharePoint Information Portal\IronPython26 for SharePoint 2007 and 2010 or [ProductInstalPath]
\SharePoint Information Portal\IronPython27 for SharePoint 2013 folders from the server hosting
Information Portal to the QuestSPSolution folder on a front-end server.
4. Run cmd.exe on a front-end server.
5. Make the QuestSPSolutionSPIntegration folder current:
cd c:QuestSPSolutionSPIntegration
6. Make sure that Windows SharePoint Services Administration (SharePoint 2007) or SharePoint 2010
Administration (Sharepoint 2010) service is started on the front-end.
7. Run the following command:
For SharePoint 2007 and 2010: ..\IronPython26\ipy64.exe wsp_install.py http://info_
portal_server:3141
For SharePoint 2013: ..\IronPython27\ipy64.exe wsp_install.py http://info_portal_
server:3141
8. Make sure the output does not contain errors. The process successfully completed should look like:
1/28/2011 8:57:50 PM: Sharepoint Integration install [‘wsp_install.py’,
‘http://info_portal_server:3141’]
1/28/2011 8:57:53 PM: Generating wsp solution in .\\SPIntegrationFeature for
http://info_portal_server:3141
1/28/2011 8:57:55 PM: setup solution:
.\\SPIntegrationFeature\SPIntegrationFeature.wsp
1/28/2011 8:57:55 PM: stop running jobs
1/28/2011 8:57:56 PM: remove old solution
1/28/2011 8:57:59 PM: add solution
1/28/2011 8:58:09 PM: deploy solution
9. Ensure that SharePoint sites have the Site Administrator Reports section containing the links
to the Information Portal reports in the Site Settings. In SharePoint 2010, it looks as follows:
10. Now the QuestSPSolution folder can be deleted.
Site Administrator for SharePoint 5.2.3 User Guide
FAQ
156
How to Uninstall Information Portal
SharePoint Solution (SharePoint
Integration Module)
To uninstall Information Portal SharePoint solution from a farm, run the following commands on the SharePoint
front-end server where Information Portal is installed:
cd C:\\Program Files (x86)\\Dell\\Site Administrator for SharePoint\\SharePoint
Information Portal\\SPIntegration ..\\IronPython26\\ipy64.exe wsp_uninstall.py
where C:\Program Files (x86)\Dell\Site Administrator for SharePoint is the folder where Information Portal
is installed.
The following lines indicate that Information Portal SharePoint solution is successfully uninstalled:
Removing solution SharePoint Integration
uninstall solution: a96ccaa2-44fe-8501-04e3-756c6ab95697
stop running jobs
retracting solution a96ccaa2-44fe-8501-04e3-756c6ab95697
How to Automate PDF Export of Site
Metrics Report for Specific Site
To automate the PDF export of the Site Metrics report for the specified site, run the following
PowerShell script:
### the following part should be configured according to you environment
$siteadmin = "http://siteadmin_server:3141" # site administrator reports URL
$site = "http://sharepoint/site" # generate PDF for this Sharepoint site
$pdf_path = "c:\site_metrics.pdf" # result PDF file path
# report specific:
$pdf_url = '/site_metrics/pdf' # URL of PDF export for this report
$report = "/site_collection"
###
$wc = New-Object System.Net.WebClient
$wc.Credentials = [System.Net.CredentialCache]::DefaultCredentials
$act = $wc.DownloadString( $siteadmin + $report + "?url=" + $site ) | %{ if ($_ -match
'&diagrams_actual_on=.*esgt_actual_on=(None|\d*.\d*)') {$matches[0]} }
$act
Site Administrator for SharePoint 5.2.3 User Guide
FAQ
157
$pat = '{"sgtBusy": false, "listsBusy": false, "docsBusy": false, "docExtBusy": false,
"doclibsBusy": false, "esgt_busy": false, "siteInfoBusy": false, "ssdBusy": false}'
$st = ''
while ( $st -ne $pat)
{
sleep 5
$st = $wc.DownloadString( $siteadmin + "/site/state" + "?url=" + $site + $act )
$st
}
$wc.DownloadFile( $siteadmin + $pdf_url + "?url=" + $site , $pdf_path )
To run the script:
1. Provide values specific for your environment for the $siteadmin, $site and $pdf_path variables.
2. Save the file with .ps1 extension.
3. Open the PowerShell console and run the script.
How to Configure IIS 7 as Web Frontend Server for Information Portal
By default, Information Portal uses Apache (http://en.wikipedia.org/wiki/Apache_HTTP_Server) as a web
server. It is included in the Information Portal installation package and automatically configured to be accessed
by the URL like: http://server:3141.
You can configure IIS 7 to work as a web server for Information Portal if it is required to use IIS for all web
applications by the company policy. The following are additional options available in IIS 7:
l
Configure SSL encryption
l
Configure a host-header with the default port
l
Configure load distribution
l
Use automatic Windows updates to always have IIS in the most secured state.
Configuration includes three steps:
1. Configure IIS 7 as a reverse proxy (http://en.wikipedia.org/wiki/Reverse_proxy). This means that all
requests from users are sent to IIS 7 site and then redirected to the Portal Apache server. The response
from Apache goes back to IIS, and then IIS sends it back to the user. We use Application Request Routing
Module http://www.iis.net/download/ApplicationRequestRouting to implement this process.
2. To avoid the direct access to Information Portal via Apache server, disable listening external requests.
Apache is hidden for all users since listening external requests are disabled.
3. Reconfigure the Information Portal SharePoint Integration feature to point to a new IIS site.
Site Administrator for SharePoint 5.2.3 User Guide
FAQ
158
Step 1. Configure IIS 7 as Reverse Proxy
The solution is based on the standard IIS extension - the Application Request Routing module. Install it on the
server hosting Information Portal and IIS 7. The Application Request Routing module can be downloaded at
http://www.iis.net/download/ApplicationRequestRouting.
1. After the Application Request Routing (ARR) module has been installed, it should be
configured to act as a proxy server (this functionality is not enabled by default). In IIS
Manager, highlight the Application Request Routing Cache feature and click Open Feature in
the Actions pane.
2. Click Server Proxy Settings in the Actions pane.
Site Administrator for SharePoint 5.2.3 User Guide
FAQ
159
3. Tick the Enable proxy checkbox, and then click Apply. Leave all the default values in place.
4. Next, configure the URL Rewrite rule, so that IIS knows what to do with requests which you want to
forward to Information Portal Apache. Click a site which is supposed to be used for Information Portal. If
you do not have any site, create it. In our example, a test site (http://atsp2010:82) is used. Highlight the
URL Rewrite icon, and then click Open Feature in the Actions pane.
Site Administrator for SharePoint 5.2.3 User Guide
FAQ
160
5. In the URL Rewrite feature, click Add Rules in the Actions pane.
6. In the Add Rule(s) dialog box, select Blank rule and click OK.
7. In the Edit Inbound Rule feature, specify the new rule name and type .* in the Pattern dialog box. The
new rule should default to using Regular Expressions (if it does not, ensure that you select this option).
In the Action section of the Edit Inbound Rule feature, ensure that the Action type is set to Rewrite
and then enter http://localhost:3141/{R:0} in the Rewrite URL dialog box as shown below. Click Apply
to create the new rule.
We assume that Information Portal is installed on port 3141 (default), so http://locahost:3141 is the
Information Portal Apache server URL.
Site Administrator for SharePoint 5.2.3 User Guide
FAQ
161
8. Now you can test the URL: http://atsp2010:82. It displays the Information Portal Enterprise report in
the same way as the http://localhost:3141 URL.
9. SSL can be configured on this IIS site. For more information, see the following article:
http://learn.iis.net/page.aspx/144/how-to-set-up-ssl-on-iis-7.
Step 2. Configure Apache to be Localhost Only
Now disable the direct access to Information Portal via Apache server.
Perform the following:
1. Open C:\Program Files (x86)\Dell\Site Administrator for SharePoint\SharePoint Information
Portal\Python25\conf\httpd.conf in notepad. (here we assume that the product is installed in the
default path on x64 OS).
2. Change ServerName atsp2010:3141 to ServerName 127.0.0.1:3141 (assuming that atsp2010 is the
name of this server).
3. Change Listen 3141 to Listen 127.0.0.1:3141.
The modified httpd.config file will look as follows:
ServerRoot "C:\Program Files (x86)\Dell\Site Administrator for
SharePoint\SharePoint Information Portal\Python25"
ServerName 127.0.0.1:3141
ServerSignature Off
ServerTokens Prod
Site Administrator for SharePoint 5.2.3 User Guide
FAQ
162
DocumentRoot "C:\Program Files (x86)\Dell\Site Administrator for
SharePoint\SharePoint Information Portal\Python25"
Listen 127.0.0.1:3141
...
4. Restart the Quest.InfoPortal.WebAccess service.
Verify that http://atsp2010:3141 does not work from other servers (atsp2010 is the name of the server hosting
Information Portal. Replace it with your server name).
Verify that http://atsp2010:82 works.
Now you have Information Portal installed with the IIS web front-end server.
Step 3. Reconfigure Information Portal SharePoint
Integration Feature
As the Information Portal URL has been changed to http://atsp2010:82, it is required to reconfigure the
SharePoint Integration feature.
Perform the following:
1. Run cmd.exe on the server hosting Information Portal.
2. Make the C:\Program Files (x86)\Dell\Site Administrator for SharePoint\SharePoint Information
Portal\SPIntegration folder current.
3. Make sure that Windows SharePoint Services Administration (SharePoint 2007) or SharePoint 2010
Administration (Sharepoint 2010) service is started on the front-end.
4. Run the following command:
..\IronPython26\ipy64.exe wsp_install.py http://atsp2010:82
5. Make sure the output does not contain errors. The process successfully completed should look like:
1/28/2011 8:57:50 PM: Sharepoint Integration install ['wsp_install.py',
'http://atsp2010:82']
1/28/2011 8:57:53 PM: Generating wsp solution in .\\SPIntegrationFeature for
http://atsp2010:82
1/28/2011 8:57:55 PM: setup solution:
.\\SPIntegrationFeature\SPIntegrationFeature.wsp
1/28/2011 8:57:55 PM: stop running jobs
1/28/2011 8:57:56 PM: remove old solution
1/28/2011 8:57:59 PM: add solution
1/28/2011 8:58:09 PM: deploy solution
6. Ensure that SharePoint sites have the Site Administrator Reports section containing the links
to the Information Portal reports in the Site Settings. Try to open these links. In SharePoint
2010, it looks as follows:
Site Administrator for SharePoint 5.2.3 User Guide
FAQ
163
How to Change Port for Information
Portal
By default, Information Portal is installed on port 3141. To change it, perform the following steps:
1. Open the Apache configuration file: [ProductInstallDir]\SharePoint Information
Portal\Python25\conf\httpd.conf.
It contains the following:
ServerRoot c:\Program Files\Dell\Site Administrator for SharePoint\SharePoint
Information Portal\Python25
ServerName hostname:3141
ServerSignature Off
ServerTokens Prod
DocumentRoot c:\Program Files\Dell\Site Administrator for SharePoint\SharePoint
Information Portal\Python25
Listen 3141
2. Replace 3141 port number with the one you need both in the ServerName and Listen
properties. For example, if you change the default port to 8080, the httpd.conf file will look
as follows:
ServerRoot c:\Program Files\Dell\Site Administrator for SharePoint\SharePoint
Information Portal\Python25
ServerName hostname:8080
ServerSignature Off
ServerTokens Prod
DocumentRoot c:\Program Files\Dell\Site Administrator for
SharePoint\SharePoint Information Portal\Python25
Listen 8080
If you apply port 80, the httpd.conf file will look as follows:
ServerRoot c:\Program Files\Dell\Site Administrator for SharePoint\SharePoint
Information Portal\Python25
ServerName hostname
ServerSignature Off
ServerTokens Prod
DocumentRoot c:\Program Files\Dell\Site Administrator for
SharePoint\SharePoint Information Portal\Python25
Listen 80
NOTE: Ensure that the port you apply is free. No IIS site or other application should use this port.
You can verify that the port is free by the netstat utility.
3. Restart the Quest.InfoPortal.WebAccess service.
4. Check the new URL in your browser: http://hostname:8080 or http://hostname.
5. Reinstall Information Portal SharePoint Solution (SharePoint Integration Module) on any front-end server
of each discovered farm as described in the following article.
The new port will be preserved in future upgrades.
Site Administrator for SharePoint 5.2.3 User Guide
FAQ
164
How to Change Ports for Information
Portal Services
NOTE: The default port numbers used by the Information Portal services are 3142 and 3143. However, in
some cases they may be different.
To change the default ports, perform the following:
1. Open the SPInfo.conf file to change 3142 port and SPInfoBroker.conf to change 3143 port. The files are
located in the [ProductInstallDir]\SharePoint Information Portal\SharePoint Browser folder.
2. Replace the default port number with the one you need in server.socket_port.
3. Restart all the services, including Quest.InfoPortal.WebAccess.
How to Change Password for Install and
Service Accounts
Credentials should be changed for all Quest.InfoPortal.* services and SASP_* scheduled tasks in all Site
Administrator installations.
What Permissions Are Required for
Site Owners
All requests are performed by Information Portal services under service account that should have the db_
reader acess to content databases. Information portal restricts access for Site Collection Administrators/Site
Owners and they can see reports about any content below the site they have access to.
Why is the Actual Size of the
SharePoint Content Database Shown in
the Reports Much Bigger than Size of
the Site Collection Located in this
Database?
The database size is the physical size of the database files (mdf and ldf). It is queried by the sp_helpdb stored
procedure. This size includes all SQL data related to the database: transactions logs, indexes, SQL database
schema, permissions and tables metadata. Depending on SQL administration it may include pre-allocated space
for future growth - around 10-25%.
Site Administrator for SharePoint 5.2.3 User Guide
FAQ
165
The site collection size in our reports is the total size of the following data:
l
documents
l
doc versions
l
list items
l
account personalization info
l
webparts
l
document metadata.
Content size does not include SharePoint permissions structures, audit and events data. The same approach is
used by the SharePoint Storage Space Allocation page.
If a user uploads 10 x 1 MB documents to a site, the site content in our report is increased by 10 MB. At the same
time, the SQL database size either may not change in case space has already been allocated for these data; or
the change will be greater as SQL needs to keep auxiliary structures such as transactions logs, indexes,
document properties in order to store these documents. So, there will be storage overhead added by the
SharePoint and possibly by SQL auxiliary data.
Using Information Portal reports, you can identify this overhead as we show both the database size and the site
collection content size. If the overhead is too big (30% or more), you can clean up the space by the SQL
database defragmentation and shrink operations.
Information Portal Reports Show Zero
or N/A in Usage Data (e.g. the Number
of Views, the Number of Users, Most
Used Content)
Verify the following:
1. Usage Analysis Processing is enabled in Central Administration > Operations > Usage Analysis
Processing.
2. The usage analysis job is successfully executed. You can check the job status in Central Administration
> Operations > Timer Job Status. Make sure the job is scheduled to run daily.
3. Windows SharePoint Services Timer is started on each front-end server.
4. The account used in Windows SharePoint Services Timer has read and write permissions for the
SharePoint Logs folder (specified in Central Administration > Operations > Usage Analysis Processing).
To do that:
To verify that the account used in Windows SharePoint Services Timer has read and write permissions for the
SharePoint Logs folder, perform the following:
1. Execute the runas command under the current account.
2. Open NotePad, and then try to open SharePoint Usage Log. You can find the path to the log in Central
Administration > Operations > Usage Analysis Processing.
3. Make sure the account can create and edit a file in the logs folder.
Site Administrator for SharePoint 5.2.3 User Guide
FAQ
166
Information Portal Detailed Reports
(Site Collections, Sites, Documents,
Lists, Document Libraries) Display
Only 20 Records. How to View all
Results if the Number of Objects
Exceeds this Limit?
You can increase the number of the objects displayed up to 200 on the Settings page.
To view a complete list of objects, export the report to a CSV file. Then you can analyze, sort and filter the
report data in Excel.
Why Is the Site Size Different in
Enterprise/Site Metrics and Sites
Reports?
Enterprise and Site Metrics (refer Content Management Reports and IT Infrastructure Reports) reports display
the size of a site including its sub-sites. The Sites report displays the size of each site without its sub-sites. The
total size of a site including its sub-sites must be equal to the size displayed in the Enterprise report.
General idea of Information Portal reports is to display all key metrics for the selected site including its
subsites. However, the Sites report is an exception. This report allows you to understand how the size and
traffic are distributed among sites within the selected site collection.
How to Clear Authorization Cache
Because of the 5 minutes Authorization Cache used in Information Portal, a user whom you have just granted
Site Collection Administrator or Site Owner privileges may not have access to Information Portal reports. To
resolve the issue either wait 5 minutes or clear the cache.
To clear the cache, run the [ProductInstallPath]\SharePoint Information Portal\Scripts\clear_authorization_
cache.cmd file.
All rows in the AutorizationCache table of [ProductInstallPath]\SharePoint Information
Portal\Application\database\model.db will be removed.
NOTE: You do not need to restart the services for the change to take effect.
Site Administrator for SharePoint 5.2.3 User Guide
FAQ
167
How to Move Reporting Database to
Another SQL Server
1. Close Site Administrator Console. Ensure the Data Gathering process is stopped.
2. Use HKEY_LOCAL_MACHINE\SOFTWARE\Quest Software\SharePoint Manager to obtain the current
database name specified in the StorageName and StorageMachineName of the key.
3. Move the database to another SQL server. You can use Tasks>Import Data wizard in SQL
Management Studio.
4. In HKEY_LOCAL_MACHINE\SOFTWARE\Quest Software\SharePoint Manager or HKEY_LOCAL_
MACHINE\SOFTWARE\Wow6432Node\Quest Software\SharePoint Manager in case of 64-bit OS, change
the following values:
l
StorageName - the database name (QSP_Repository, by default).
l
StorageMachineName - the SQL instance name specified in the following format: computer
nameinstance (e.g. satestxpsqlexpress), or computer name for the default SQL instance.
5. In HKEY_LOCAL_MACHINE\SOFTWARE\Quest Software\SharePoint Manager\Statistic Collector or
HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Quest Software\SharePoint Manager\Statistic
Collector in case of 64-bit OS, change the StorageName and StorageMachineName values.
6. Change the ServerName field in the ShgReportingDatabases table in the QSP_Repository database. If
the database name is changed, you can also modify the DBName field. This field is reserved for future
support of separate configuration and reporting databases. The ServerName value must be the same as
StorageMachineName.
7. Change the following values in HKEY_LOCAL_MACHINE\SOFTWARE\Quest Software\SharePoint
Manager\ConfigSetAgent on every computer hosting policy agent:
l
StoreName - the database name (it should be the same as in StorageName).
l
DataHost - the SQL server instance name (it should be the same as in StorageMachineName).
How to View What Users are Using Site
Administrator for SharePoint
For this purpose, the Information Portal web service HTTP calls logging can be used. To enable it, add the
following lines to the end of the apache configuration file (SharePoint Information
Portal\Python25\conf\httpd.conf):
LogFormat "%h; %u; %t" common
CustomLog ../logs/InfoPortalAccess.log common
Restart the Quest.InfoPortal.WebAccess service. In the InfoPortalAccess.log file you will find the user usage
information.
NOTE: Pay attention that the LogFormat string defines format for each logging record.
Site Administrator for SharePoint 5.2.3 User Guide
FAQ
168
How to Override Add Farm Behavior
Site Administrator may not discover SharePoint servers in certain specific advanced configurations (hardware
and software load-balancers, SSL-enabled servers, etc.). Typical symptoms of this issue are the following:
l
SharePoint Farm is not displayed in the Enterprise report and Farms list.
Site Administrator for SharePoint allows you to override the default discovery process by providing correct
bindings for your SharePoint servers. You should perform the following:
1. Create an XML file with correct binding information for SharePoint web applications to be added.
2. Add Farm.
Creating XML File with Correct Binding Information
The binding file (by default PreferredIISSettings.XML) contains binding information for SharePoint-extended IIS
sites, which allows Site Administrator Discovery Wizard to access SharePoint web applications using the right
addresses. When the binding file is configured, the discovery engine uses the file as follows:
1. Performs a search for the NetBIOS computer name in the binding file (Host elements).
2. If the computer name is found in the file, the discovery engine uses the binding settings from the
matched Host element to access SharePoint-extended IIS sites.
3. If the computer name is not found in the file, the discovery engine requests bindings for its IIS sites
directly from the IIS metabase on the computer.
4. Repeats the procedure for each computer in the discovery scope.
The file contains a bunch of the Host elements, each corresponding to a physical SharePoint front-end server
computer. The Name attribute is the computer NetBIOS name. The Host element contains one child IISSRV
element for each SharePoint-extended IIS site. Each IISSRV element defines correct bindings for the
corresponding SharePoint web application:
Attribute
Value
ID
The IIS site ID, i.e. W3SVC/1289790654
Host
Header
Host header string, i.e. extranet.lblab.local
Port
TCP port on which the site listens for HTTP requests, i.e. 80
SSL Port
TCP port on which the site listens for HTTPS requests, i.e. 443
Comment
Optional comment for a site - used as the title of the web application in the Site Administrator
console
It is recommended to create a new file using the EnumIISSites.exe utility. The utility is located in the
C:\Program Files\Common Files\Dell Shared folder.
For each front-end server hosting SharePoint extended sites to be overriden in the binding file, run the
command line utility as follows:
EnumIISSites.exe <computer name>
The command line should return Success!.
NOTE: If errors occurred, make sure you have the local administrator rights on the <computer name>
server, or run the utility locally on this server.
Site Administrator for SharePoint 5.2.3 User Guide
FAQ
169
A new Host element will be added to the PreferredIISSettings.xml file located in the folder with the
EnumIISSites.exe utility.
Next, remove non-SharePoint IISSRV elements in each Host element and specify correct bindings in the
attribute values.
NOTE: Note that Host element for the SharePoint Central Administration site should also be removed.
Adding Farm
Run Site Administrator and add the farm (see the Adding SharePoint Farms section). Specify one of your frontend SharePoint server computers specified in the XML binding file.
To check whether the discovery has applied the bindings, search the discovery log file for the Reading
preferred settings XML file... line.
Information Portal Advanced
Troubleshooting
If some data are missing in Information Portal reports or these reports are not generated, please analyze the
following log files:
NOTE: [ProductInstallPath] is the product installation folder. By default, the product is installed to
C:\Program Files (x86)\Dell\Site Administrator for SharePoint.
1. [ProductInstallPath]\Console\Logs
l
QsSPDiscovery.log - the log file of the Add Farm and Discovery SharePoint operations. If your
farm is not displayed in the search results or in the Enterprise report, try to add a farm and see
this log for details.
2. [ProductInstallPath]\SharePoint Information Portal\Logs
l
setup.log - the log file of the Information Portal installation and un-installation operations.
l
WebReports.log - the log file of the Quest.InfoPortal.WebAccess service. This Apache service
calls Django framework to render html pages displayed for users.
l
httpd.log - the log file of the Quest.InfoPortal.WebAccess service. This Apache log may contain
authentication issues.
l
BrokerWorker.log - the pythonw.exe process created by the Quest.InfoPortal.WebAccess
service to collect the report data. This process calls local Quest.InfoPortal.SPBrowserBroker
service via http and puts results to the .json file in [ProductInstallPath]\SharePoint Information
Portal\cache.
l
SpBrowserBroker.log - the log file of the Quest.InfoPortal.SPBrowserBroker service. This
service works with QSP_Repository, Active Directory and with local or remote
Quest.InfoPortal.SPBrowserAgent via http.
l
SpBrowserAgent.log - the log file of the Quest.InfoPortal.SPBrowserAgent service. This
service works with SharePoint configuration and content database. It also may work with
Active Directory.
l
Quest.InfoPortal.ServiceMonitor.log - the log file of Quest.InfoPortal.ServiceMonitor service.
This service monitors memory and handles consumption of other services. It restarts services if
Site Administrator for SharePoint 5.2.3 User Guide
FAQ
170
they handle more than 2 GB of memory or 15000 handles. If the services crash by some reason,
Quest.InfoPortal.ServiceMonitor automatically restarts them. All these actions are written to
this log file.
3. [ProductInstallPath]\SharePoint Information Portal\Logs
l
JobsManager.log - the log file for python.exe (run by the scheduled task), which handles
policy jobs and one time actions from QSP_Repository and runs external ipy64.exe.
l
SpService.log - the log file for ipy64.exe which is responsible for applying changes to
SharePoint.
In some cases it may be necessary to enable additional logging for more advanced troubleshooting.
1. To enable debug logging for all Information Portal services:
a. Replace ERROR with DEBUG in the [ProductInstallPath]\SharePoint Information
Portal\Logs\logger.conf file.
b. Restart Quest.InfoPortal.SPBrowserAgent, Quest.InfoPortal.SPBrowserBroker and
Quest.InfoPortal.WebAccess services.
c. Confirm the issue with enabled logging and send all logs to developers.
2. To enable logging of all HTTP calls to Information Portal web service, add the following lines to the end
of the apache configuration file (SharePoint Information Portal\Python25\conf\httpd.conf):
LogFormat "%h %l %u %t \"%r\" %>s %b %T" common
CustomLog ../logs/access_log.log common
The log will be written to [ProductInstallPath]\SharePoint Information Portal\Logs\access_log.log.
3. If Information Portal page displays the following error:
perform the following:
a. Replace the following lines in the [ProductInstallPath]\SharePoint Information
Portal\Application\settings.py file:
#DEBUG = True
#TEMPLATE_DEBUG = DEBUG
with:
DEBUG = True
TEMPLATE_DEBUG = DEBUG
b. Restart the Quest.InfoPortal.WebAccess service and refresh the page. The advanced troubleshooting
page should be displayed:
Site Administrator for SharePoint 5.2.3 User Guide
FAQ
171
Send this page to developers if the error message is not helpful.
After troubleshooting, roll all the logging back to the initial state. Otherwise, the size of the logs may grow too
much and affect the product performance.
Site Administrator for SharePoint 5.2.3 User Guide
FAQ
172
A b o u t D e ll
Dell listens to customers and delivers worldwide innovative technology, business solutions and services they
trust and value. For more information, visit www.software.dell.com.
Contacting Dell
For sales or other inquiries, visit http://software.dell.com/company/contact-us.aspx or call +1 949 754-8000.
Technical support resources
Technical support is available to customers who have purchased Dell software with a valid maintenance
contract and to customers who have trial versions. To access the Support Portal, go to
http://support.software.dell.com.
The Support Portal provides self-help tools you can use to solve problems quickly and independently, 24 hours
a day, 365 days a year. In addition, the Support Portal provides direct access to product support engineers
through an online Service Request system.
The Support Portal enables you to:
l
Create, update, and manage Service Requests (cases)
l
View Knowledge Base articles
l
Obtain product notifications
l
Download software. For trial software, go to http://software.dell.com/trials.
l
View how-to videos
l
Engage in community discussions
l
Chat with a support engineer
Site Administrator for SharePoint 5.2.3 User Guide
About Dell
173

Similar documents

×

Report this document