AgreeYa Solutions. Site Administrator for SharePoint User Guide

Transcription

1 AgreeYa Soutions Site Administrator for SharePoint User Guide 2017

2 2017 AgreeYa Soutions Inc. A rights reserved. This product is protected by U.S. and internationa copyright and inteectua property aws. AgreeYa Soutions and the AgreeYa Soutions ogo are trademarks of AgreeYa Soutions Inc. in the United States and/or other jurisdictions. A other marks and names mentioned herein may be trademarks of their respective companies. Legend CAUTION: A CAUTION icon indicates potentia damage to hardware or oss of data if instructions are not foowed. WARNING: A WARNING icon indicates a potentia for property damage, persona injury, or death. IMPORTANT, NOTE, TIP, MOBILE, or VIDEO:An information icon indicates supporting information. Site Administrator for SharePoint User Guide Updated - October 2015 Software Version

3 Contents Genera Information 9 About Site Administrator for SharePoint 9 Key Features 9 Discovery and Reporting 10 Prepare Before You Migrate 10 Comprehensive Security Contro 10 Operationa Auditing 10 Growth Forecasting and Management 10 Depoying 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 Loca Administrator Right 18 Instaation Procedure 19 Instaing Site Administrator for SharePoint 19 Configuring Web Appication Port 20 Instaing Site Administrator for SharePoint - Security Exporer 20 Uninstaing Site Administrator for SharePoint 21 Uninstaing Management Consoe 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 Aiases 24 Information Porta Leves of Access 25 Sign In Under Different User Account 26 Search 26 SharePoint Onine 26 Sign in 26 Buid-in Domain Accounts 26 Federated Domain Accounts 27 3

4 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 Scheduing Report Export to CSV/SQL 59 Managing SharePoint 62 Managing Security 62 Managing User Permissions 62 Appying Security Settingss 64 Restructuring SharePoint Content 64 Copying Sites 65 Copying Lists 65 Configuring Version Settings for Document Libraries 65 Poicies 67 How it works: 67 Site Administrator Settings 67 Access Settings 67 Report Settings 68 Action and Poicy Settings 68 Fie Fiter Settings 68 License 68 How It Works 68 Agent and Broker Web Services 68 Information Porta Front-End 69 Coecting and Showing Report Data 69 Coecting Grid Report Data 69 Site Administrator for SharePoint Security Exporer 71 Managing Objects 71 Managing Your SharePoint 72 Working with SharePoint Web Service 72 Modifying SharePoint Authentication 73 4

5 Managing SharePoint Groups 73 Modifying SharePoint Properties 73 Previewing SharePoint Objects 73 Managing SharePoint Permissions 74 Viewing SharePoint Permissions 74 Granting Permissions 75 Coning Permissions 77 Modifying Permissions 78 Modifying SharePoint Permissions Leves 79 Deeting Permissions 80 Backing Up Permissions 80 Using the Backup Scheduer 81 Restoring Permissions 81 Exporting Permissions 81 Managing Favorites 82 Adding Favorites Whie Browsing 82 Adding Favorites 83 Removing Favorites 83 Managing Enterprise Scope 84 Creating an Enterprise Scope Whie 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 Whie 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 Resuts 89 Saving Search Criteria 89 Customizing Security Exporer 89 Setting Genera Options 89 Setting Advanced Options 90 Setting SharePoint Options 91 Site Administrator for SharePoint REST 93 ReAgreeYa and Response Format 93 REST Resources and URL Structure 93 5

6 REST Resources 93 GET /farms 96 PUT /farms 98 GET /farms/actua_on 98 GET /servers 99 PUT /servers 101 GET /servers/actua_on 101 GET /sitecoections 102 PUT /sitecoections 102 GET /sitecoections/actua_on 103 GET /sites 103 PUT /sites 104 GET /sites/actua_on 105 GET /site/common_info 105 PUT /site/common_info 107 GET /site/common_info/actua_on 107 GET /content/site_info 108 PUT /content/site_info 109 GET /content/site_info/actua_on 109 GET /content/ists 110 PUT /content/ists 111 GET /content/ists/actua_on 111 GET /content/docibs 112 PUT /content/docibs 114 GET /content/docibs/actua_on 114 GET /storage_growth 115 PUT /storage_growth 116 GET /storage_growth/actua_on 116 GET /space_distribution 117 PUT /space_distribution 118 GET /space_distribution/actua_on 118 GET /aerts 119 PUT /aerts 122 GET /aerts/actua_on 123 GET /security/counters/unique_perms 123 PUT /security/counters/unique_perms 124 GET /security/counters/unique_perms/actua_on 124 GET /security/counters/ad_objs 125 PUT /security/counters/ad_objs 126 GET /security/counters/ad_objs/actua_on 126 6

7 GET /security/counters/open_content 126 PUT /security/counters/open_content 127 GET /security/counters/open_content/actua_on 127 GET /security/counters/sp_groups 128 PUT /security/counters/sp_groups 129 GET /security/counters/sp_groups/actua_on 129 GET /usage 130 PUT /usage 131 GET /usage/actua_on 131 GET /usage/counters/unused_pages 132 PUT /usage/counters/unused_pages 133 GET /usage/counters/unused_pages/actua_on 133 GET /document/counters/docs_and_pages 134 PUT /document/counters/docs_and_pages 134 GET /document/counters/docs_and_pages/actua_on 135 GET /activity/changes 135 PUT /activity/changes 136 GET /activity/changes/actua_on 136 GET /activity/users/most_active 137 PUT /activity/users/most_active 137 GET /activity/users/most_active/actua_on 138 GET /schedue/report 138 PUT /schedue/report 140 DELETE /schedue/report 140 POST /job/disaow_everyone 141 DELETE /job/disaow_everyone 141 GET /job/disaow_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 7

8 Cean Up Report Data 150 Synopsis and Usage 151 Cean Up Usage Coector Data 151 Synopsis and Usage 152 Data Gathering for Enterprise Leve Reports 152 FAQ 154 How to Insta Information Porta Using Command Line 154 How to Get the Best Performance for Mutipe Concurrent Users Working with Information Porta 155 How to Insta Information Porta SharePoint Soution (SharePoint Integration Modue) without Instaing Fu Information Porta Setup on a SharePoint Front-end Server 155 How to Uninsta Information Porta SharePoint Soution (SharePoint Integration Modue) 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 Porta 158 Step 1. Configure IIS 7 as Reverse Proxy 159 Step 2. Configure Apache to be Locahost Ony 162 Step 3. Reconfigure Information Porta SharePoint Integration Feature 163 How to Change Port for Information Porta 164 How to Change Ports for Information Porta Services 165 How to Change Password for Insta and Service Accounts 165 What Permissions Are Required for Site Owners 165 Why is the Actua Size of the SharePoint Content Database Shown in the Reports Much Bigger than Size of the Site Coection Located in this Database? 165 Information Porta Reports Show Zero or N/A in Usage Data (e.g. the Number of Views, the Number of Users, Most Used Content) 166 Information Porta Detaied Reports (Site Coections, Sites, Documents, Lists, Document Libraries) Dispay Ony 20 Records. How to View a Resuts 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 Cear 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 Porta Advanced Troubeshooting 170 About AgreeYa Soutions 173 Contacting AgreeYa Soutions 173 Technica support resources 173 8

9 Genera Information In this section: About Site Administrator for SharePoint Key Features Discovery and Reporting Prepare Before You Migrate Operationa Auditing Growth Forecasting and Management About Site Administrator for SharePoint Site Administrator for SharePoint is a web-based too that aows you to monitor, audit and gain vauabe insight from the content, security and activity information within your SharePoint 2007, 2010 or 2013 environment. With Site Administrator you can: Better understand your infrastructure by identifying and reporting on your entire SharePoint environment, incuding farms, servers and those instances you did not know existed. Accuratey pan, scope and prioritize your migration to reduce your migration risk. Protect your SharePoint content by managing and monitoring the users who have access to that content. Empower content owners to access, schedue and export reports, and manage permissions on the content they own. Track user activity and security modifications across sites and site coections. Forecast and manage SharePoint growth. Key Features Site Administrator for SharePoint addresses the imitations of SharePoint and heps you use SharePoint more effectivey in your environment with the foowing features: Discovery and Reporting Prepare Before You Migrate Comprehensive Security Contro Operationa Auditing Growth Forecasting and Management Genera Information 9

10 Discovery and Reporting Site Administrator for SharePoint aows you to better understand your infrastructure by identifying and reporting on your entire SharePoint environment, incuding farms, servers and those instances you did not know existed. Through a security-trimmed, web-based interface, Site Administrator gives content owners the toos and reports they need without compromising your security poicies. Prepare Before You Migrate With Site Administrator you can quicky 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 Contro Site Administrator enabes you to quicky 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 resuts and reports. Security Exporer, shipped with Site Administrator, simpifies SharePoint security with point-and-cick permissions management. Operationa Auditing Site Administrator tracks user activity across sites and site coections, aggregating content and security modifications in easy to read interactive reports for anaysis 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-contro growth and content spraw and pan for future expansions. Site Administrator enabes you to run a report and then within that same dashboard act on and enforce content versions and structure across your environment as we as monitor growth trends over time. Genera Information 10

11 Depoying Site Administrator for SharePoint In this section: System Requirements Required Permissions Setting Required Permissions Instaation Procedure Uninstaing Site Administrator for SharePoint Upgrading Site Administrator System Requirements Before instaing Site Administrator for SharePoint, make sure that your system meets the foowing minimum hardware and software requirements: Requirement Description Patform Memory Disk space Operating System Additiona Software & Services Inte Pentium 1 GHz processor (x86, x64) or equivaent 512MB of RAM 1 GB of avaiabe hard disk space for instaation and og fies Site Administrator database is used ony for configuration information. It requires up to 100 MB of space. One of the foowing: Windows Server 2003 (x86 or x64) SP1 or higher Windows Server 2008 (x86 or x64) Windows Server 2008 R2 (x64) Windows Server 2012 (x64) Windows Server 2012 R2 (x64) Microsoft.Net Framework 3.0 SP2 Microsoft.Net Framework 4.0 (for Security Exporer) One of the foowing: Microsoft Internet Exporer 8/9/10/11 Googe Chrome (atest) Depoying Site Administrator for SharePoint 11

12 Requirement Description Mozia Firefox Supported SharePoint Versions (atest) One of the foowing: Microsoft SQL Server 2005 (Express, Standard or Enterprise edition) Microsoft SQL Server 2008 (Express, Standard or Enterprise edition) Microsoft SQL Server 2012 (Express, Standard or Enterprise edition) Site Administrator supports the foowing SharePoint versions: SharePoint 2007 (MOSS and WSS 3.0) SharePoint 2010 (Server and Foundation) SharePoint 2013 (Server and Foundation) SharePoint Onine (Office 365 Enterprise) NOTE: Before instaing Site Administrator on a SharePoint front-end server running Windows 2008, it is required to insta IIS 6 WMI compatibiity component. NOTE: Site Administrator for SharePoint does not support Azure High Avaiabiity scenarios at the moment. Port Requirements The foowing ports shoud be opened for correct Information Porta operation: 3141: incoming (Apache Web Server istens on this port) 3142: incoming (the agent service impemented as the cherrypy web server istens on this port) 3143: incoming (ocahost ONLY. This port shoud not be opened outside the server). Fie sharing on the Site Administrator server for the reports exported on a schedue or 139. A reports require SQL ports to be opened on the SharePoint back-end server , SQL ports must be aso 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 a SharePoint and SQL servers. WMI uses RPC. RPC dynamicay seects a free port above 1024 and uses 135 for binding. You can configure custom port range (for more information, pease refer to Required Permissions The account under which you insta Site Administrator for SharePoint shoud have the foowing rights: Depoying Site Administrator for SharePoint 12

13 Loca Administrator rights on the computer where Site Administrator for SharePoint is instaed either of the foowing: dbcreator roe on the SQL server where the AgreeYa Soutions repository database wi be created and securityadmin roe as Site Administrator for SharePoint setup grants db_owner roe for the created AgreeYa Soutions repository database to the service account db_owner roe for the existing database to be used as AgreeYa Soutions repository database. NOTE: If the instaation account does not have SQL Server eve permissions (dbcreator and securityadmin roes), ask your SQL Server administrator to create a new empty database and to grant the db_owner roe on this database to both the instaation and service accounts. Site Administrator for SharePoint setup popuates this database with a the necessary tabes. If Site Administrator for SharePoint is instaed on a SharePoint front-end server, the SharePoint integration feature wi be depoyed. The instaation account must aso have the foowing permissions: db_owner roe for the SharePoint configuration database Farm Administrator granted in SharePoint Centra Administration NOTE: If the account does not have these permissions, Site Administrator for SharePoint setup wi compete without errors, but the SharePoint integration feature wi not be instaed. The SharePoint integration feature can be instaed ater. For detaied information, pease see How to Insta Information Porta SharePoint Soution (SharePoint Integration Modue). The Site Administrator for SharePoint service account shoud have at east the foowing permissions: Loca Administrator rights on the computer where the product is instaed db_owner roe for the AgreeYa Soutions repository database db_datareader roe for configuration and content SharePoint databases the execute permission for the fn_escapeforlike function in SharePoint content database TIP: To appy the execute permission, run the foowing script: USE [SHAREPOINT_CONTENT_DB]; GRANT EXECUTE ON dbo.fn_escapeforlike TO [INFOPORTAL_SERVICE_ACCOUNT]; GO db_datareader roe for web anaytics reporting database (SharePoint 2010 Server ony) Logon as Service priviege is automaticay granted by Site Administrator for SharePoint setup For system information in the Servers report: Loca Administrator rights on the SharePoint server Loca Administrator rights on the SharePoint back-end server NOTE: If oca administrator cannot be provided for some servers, the servers report wi show partia data. The information about disk free space, RAM, OS version and service pack wi not be dispayed. For the account used to run the SASP_Usage_Coector_task schedued task (SharePoint 2013): db_datareader roe for configuration and content SharePoint databases db_owner roe for the existing database to be used as AgreeYa Soutions repository database Depoying Site Administrator for SharePoint 13

14 db_datareader roe for Logging database (SharePoint 2013 Server or Foundation ony) For information about the Heath Anayzer aerts: db_datareader roe for the SharePoint administration content database (SharePoint_ AdminContent_{GUID}) For SharePoint management toos such as permission revoke, reassignment, dupicate, site and ist copy: Fu contro permissions granted via the web appication poicy db_owner roe for the SharePoint content database db_owner roe for the SharePoint configuration database. NOTE: Site Administrator for SharePoint needs to be instaed on a front-end server in each SharePoint farm where you want to manage permissions and content. By defaut, the account under which you insta Site Administrator for SharePoint is aowed to view a Site Administrator reports. SharePoint Site Coection Administrators and site owners can aso view Site Administrator reports for the sites where they have permissions. For detais, pease see the Information Porta Leves of Access section. Adding Farms The Site Administrator for SharePoint service account must have the foowing rights: be a member of the Loca Administrator group on the SharePoint server being discovered. The permission is required to read the registry on the server to get information about the instaed SharePoint and read IIS metabase to get the web appication configuration db_datareader roe for the configuration database of the SharePoint farm being discovered db_owner for the AgreeYa Soutions Repository database. The permission is required to write SharePoint farm configuration to the Repository database. NOTE: Firewa may prevent discovery of the farm. Whie 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 foowing ports shoud be opened for the farm: SQL ports. The defaut instance of the Database Engine uses port Refer to the foowing artice for more detais: Configure a Firewa for SQL Server Access. WMI/RPC ports. Services typicay use 135 and 445 ports to communicate using Remote Procedure Cas (RPC) and Distributed Component Object Mode (DCOM). In addition, RPC uses the port range of 1024 to 5000 for aocating ports for endpoints. You can configure custom port range. Refer to the foowing artices for detaied information: How to configure RPC to use certain ports and How to configure RPC dynamic port aocation to work with firewas. If you use Windows firewa, you may enabe the Aow remote administration exception poicy to aow WMI connection. Refer to the Connecting Through Windows Firewa artice for detaied information. Once you have discovered the required farm, you can cose WMI/RPC ports. Depoying Site Administrator for SharePoint 14

15 Setting Required Permissions In this section: Setting Permissions on SQL Databases Granting SharePoint Permissions Granting Loca Administrator Right Setting Permissions on SQL Databases Create a ogin for the user who wi insta the Site Administrator for SharePoint to be abe to ogin to the SQL server. 1. Open MS SQL Server Manager Studio. 2. Expand your SQL instance node. 3. Open the Security node and seect the Logins node. 4. Right-cick the Logins and seect the New Login option. In the new ogin window enter the user name in the domain\user format. Depoying Site Administrator for SharePoint 15

16 Figure 1: Login-New Window 5. Cick OK. The ogin appears in the ist of the Logins node. 6. Locate the ogin in the ist and right-cick it. The Login Properties page is dispayed. 7. Seect the database in the upper pane and set the permissions for the database in the ower pane. Depoying Site Administrator for SharePoint 16

17 Figure 2: Set Permissions Repository 8. Cick OK. Aternativey, you can set permissions for a database as foows: 1. Expand your SQL instance node. 2. Expand the Databases node. Locate the required database. 3. Go to Security. 4. Right-cick the Users node and seect a new user. The Database User-New window is dispayed. 5. Specify the ogin name and find it in the AD. 6. Seect the appropriate permission in the Database roe membership pane. Cick OK. Repeat these steps to grant permissions to the Site Administrator account for the content and configuration SharePoint databases. Depoying Site Administrator for SharePoint 17

18 Granting SharePoint Permissions 1. Go to Start SharePoint Centra Administration. 2. In the Centra Administration window seect the Appication Management tab. 3. In the Appication Management window go to the Appication Security section and seect Poicy for Web appication. The Poicy for Web Appication window appears. 4. At the top bar of the Poicy for Web Appication window seect the Web Appication from the dropdown ist and cick the Add Users icon. The Add Users window appears. 5. In the right part of the Add Users window seect the user in the Users fied and check the appropriate permissions in the Permissions section. Setting SharePoint Permissions 6. Cick Finish. 7. The Poicy for Web Appication window dispays the new user permissions. Granting Loca Administrator Right On every computer where Site Administrator for SharePoint is instaed, perform the foowing: 1. Right-cick My Computer and seect Manage from the short-cut menu. The Computer Management window appears. 2. Go to System Toos Loca Users and Groups Groups. 3. In the right pane seect Administrators. The Administrators Properties window appears. 4. Cick Add. The Seect Users, Computers, or Groups diaog appears. Depoying Site Administrator for SharePoint 18

19 5. In the Seect Users, Computers, or Groups diaog, enter the user name you want to grant administrators rights to. 6. Cick OK. 1. Go to Start Contro Pane. 2. In the Contro Pane window, seect User Accounts. The User Accounts diaog appears. 3. In the User Accounts diaog, seect the Add... button. The Add New User window appears. 4. Enter the domain and name of a user you want to grant permissions. Cick Next. 5. Seect the Other radio button and then Administrators from the drop-down ist. 6. Cick Finish. Instaation Procedure In this section: Instaing Site Administrator for SharePoint Instaing Site Administrator for SharePoint - Security Exporer Instaing Site Administrator for SharePoint NOTE: If you insta Site Administrator for SharePoint on Windows Server 2008, it is required to disabe the Network access: Do not aow storage of passwords and credentias for network authentication poicy (Security Settings > Loca Poicies > Security Options) in the Loca Group Poicy editor. Otherwise, Site Administrator wi fai to create schedued tasks. To insta Site Administrator for SharePoint, run the autorun.exe fie and seect Insta Site Administrator for SharePoint. The Instaation Wizard starts. Compete the instaation wizard as foows: 1. On the Wecome page, cick Next. 2. On the License Agreement page, read and accept the icense agreement. Cick 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 defaut). TIP: You shoud have permissions to create a database on the specified SQL server for the first instaation to a new database. NOTE: If Site Administrator for SharePoint is instaed on a SharePoint server, the farm is automaticay added to the configuration database during setup. TIP: The account used to run Site Administrator for SharePoint services shoud have Read permissions on the SharePoint configuration and content databases. Depoying Site Administrator for SharePoint 19

20 4. On the Additiona Parameters page, specify the account to run Site Administrator for SharePoint services. 5. On the Ready to Insta Appication page, cick Next to begin instaation. 6. Cick Finish. The Site Administrator for SharePoint Wecome page is automaticay opened. NOTE: During the instaation, the Getting Started and Information Porta shortcuts are created in Start Programs AgreeYa Soutions Site Administrator for SharePoint. By seecting the Getting Started shortcut, you are taken to the Wecome page of the too. Seecting the Information Porta shortcut opens the Enterprise report. NOTE: To access Site Administrator for SharePoint remotey, the port used by Site Administrator shoud be opened in Windows Firewa. To get the port number, run the Site Administrator for SharePoint shortcut. The port number is dispayed in the URL of your browser. NOTE: Site Administrator for SharePoint is instaed with the Try Me icense vaid for 30 days. After instaation, it is required to update the icense using the Site Administrator settings. NOTE: If mutipe users are supposed to work with Site Administrator for SharePoint simutaneousy, insta the product on severa front-end servers, and then configure oad-baancing between them. It is aso recommended to depoy mutipe instances configuration using the baancer.cmd script. Pease see How to Get the Best Performance for Mutipe Concurrent Users Working with Information Porta Configuring Web Appication Port By defaut, Site Administrator for SharePoint uses port To change it to 80, perform the foowing steps: 1. Open the httpd.conf fie ocated in the Site Administrator for SharePoint\SharePoint Information Porta\Python25\conf foder. NOTE: It is recommended to backup this fie before configuring it. 2. Repace the 3141 vaue (5 occurrences) with Restart the AgreeYa.InfoPorta.WebAccess service. NOTE: If the service does not start, the port is not free and cannot be used by Site Administrator. Instaing Site Administrator for SharePoint - Security Exporer To insta Security Exporer, run the autorun.exe fie, seect Insta Site Administrator - Security Exporer and foow the steps of the Instaation Wizard. Depoying Site Administrator for SharePoint 20

21 Uninstaing Site Administrator for SharePoint To uninsta Site Administrator for SharePoint, perform the foowing steps: 1. Remove the foowing products from Site Administrator server using the Add or Remove Programs too: Site Administrator for SharePoint Security Exporer 7 for SharePoint 2. Remove the Reporting (QSP_Repository by defaut) database if needed. 3. Deete the og fies written to the product instaation foder (the defaut path is C:\Program Fies\AgreeYa Soutions\ProductName]) during the uninstaation process if needed. Uninstaing Management Consoe If you want to remove Management Consoe from your computer, perform the foowing steps: 1. Backup the registry key: 32 bit: HKEY_LOCAL_MACHINE\SOFTWARE\AgreeYa Software\SharePoint Manager 64 bit: HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\AgreeYa Software\SharePoint Manager 2. Remove Site Administrator for SharePoint Restore the registry key. If the registry key is ost, you must create the STRING vaues manuay: 32 bit: [HKEY_LOCAL_MACHINE\SOFTWARE\AgreeYa Software\SharePoint Manager] 64 bit: [HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\AgreeYa Software\Sharepoint Manager] "StorageProvider"="SQL" "StorageName"="QSP_Repository" "StorageMachineName"="sqserver" Here: QSP_Repository - the database name (assuming that it was created by Site Administrator instaation); sqserver - SQ server where the repository is ocated. Upgrading Site Administrator To upgrade Site Administrator from an earier version to 5.2.4, run the Site Administrator for SharePoint setup. Depoying Site Administrator for SharePoint 21

22 The new version of Site Administrator for SharePoint requires new icense 5.X. After the upgrade, the product wi use the Try Me icense 5.X for 30 days. When the 30-day period expires, you wi need to update the icense. To upgrade Site Administrator - Security Exporer, uninsta the oder version, and then insta the new version of Security Exporer. Depoying Site Administrator for SharePoint 22

23 Working with Site Administrator for SharePoint In this section: Getting Started Information Porta Leves of Access Search SharePoint Onine Reporting Managing SharePoint Poicies Site Administrator Settings How It Works Getting Started Site Administrator for SharePoint is a web-based too that aows you to monitor, audit and gain vauabe insight from the content, security and activity information within your SharePoint 2007, 2010 or 2013 environment. A Wecome page opens at the end of the product instaation. Cick the ties on the start page to view the required dashboard report or the product tour. NOTE: : In case the too is instaed on a separate server or no farms were added to the product scope during instaation, you wi be redirected to the Search SharePoint Farms page. For more information, pease refer to the Adding SharePoint Farms section. NOTE: If you access the too as site coection administrator, the Site Coection Administrator page is dispayed. If you access the too as site owner, the Site Owner page is dispayed. For more information, pease refer to the Information Porta Leves of Access section. Aternativey, you can open the start page by seecting Start Programs AgreeYa Soutions Software Site Administrator for SharePoint Getting Started. You can aso access Site Administrator for SharePoint with a Start menu shortcut: Programs AgreeYa Soutions Site Administrator for SharePoint Information Porta. Adding SharePoint Farms If no farms were added to the product scope during instaation, 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 Working with Site Administrator for SharePoint 23

24 dashboard reports on the start page. On the Search SharePoint Farms you can see the ist of SharePoint servers discovered in your environment: Figure 3: Avaiabe SharePoint Servers After the discovery process competes, you can add a SharePoint farm to the product scope by cicking the Add farm ink, which appears when pointing to the required server. When the farm is successfuy added, the Enterprise report opens. You can aso add a SharePoint farm as foows: seect add yours, specify NETBIOS or DNS name or IP address of the server in the farm you want to add and cick Add. NOTE: Site Administrator may not discover SharePoint servers in certain specific advanced configurations (hardware and software oad-baancers, SSL-enabed servers, etc.). For more information, pease see How to Override Add Farm Behavior. To update the ist of discovered SharePoint servers, seect Update. To fiter servers by SharePoint version, cick the appropriate coumn header. To export the data to a PDF fie, cick the PDF ink in the right upper corner of the page. Adding SharePoint Server with Configured SQL Aiases Site Administrator is on 32 bit Server If Site Administrator is instaed on the SharePoint server being added, the Add Farm wizard starts to work immediatey. If Information Porta is instaed on a separate server, it is required to configure SQL aiases on the machine hosting Site Administrator the same way they were configured on a front-end server. Run C:\Windows\System32\ciconfg.exe both on the SharePoint and Site Administrator servers, and then add a SharePoint server aiases to the Site Administrator server. Working with Site Administrator for SharePoint 24

25 Site Administrator is on 64 bit Server Regardess of the fact whether Site Administrator is instaed on the SharePoint front-end server being added or not, it is required to copy 64-bit SQL aiases of the SharePoint server to 32-bit aiases of the Site Administrator server. To do that, perform the foowing: 1. On the SharePoint server, run C:\Windows\System32\ciconfg.exe. 2. On the Site Administrator server, run C:\Windows\SysWOW64\ciconfg.exe. 3. Copy the SharePoint server aiases to the Site Administrator server. For information on how to configure SQL aiases, pease refer to Information Porta Leves of Access To use Site Administrator web UI (Information Porta), access to SharePoint servers is not required. Web UI is security trimmed and provides the foowing eves of access: Information Porta Administrator Information Porta administrators have fu access to a Site Administrator reports and actions. Fu access can be granted to individua administrators using the Information Porta settings. Users are not required to have administrator rights on any of the servers. By defaut, the Enterprise report dispays an overview of a SharePoint farms, content databases and web appications. SharePoint Site Coection Administrator Users with site coection administrator privieges can access reports and perform actions within their management scope (i.e. within the sites and site coections where they have rights in SharePoint). No additiona configuration is required. Information Porta checks the user permissions in SharePoint and automaticay trims user access based on the SharePoint security. When running Information Porta, site coection administrators are redirected to a page which dispays a sites from a site coections the user has the administrator access to. User can run reports or perform actions on this page. Reports are aso avaiabe on the SharePoint site settings page which is extended with the corresponding inks after Site Administrator instaation. SharePoint Site Owner Users with fu contro access to individua sites/sub-sites can view reports for these sites. NOTE: Reports dispay information about a document ibraries, ists, ist items and documents in a site even if some of them have unique permissions with no access to a site owner. When running Information Porta, site owners are redirected to a page which dispays a sites they have fu contro access to. On this page, users can search across a these sites by any part of site URL or view reports for the seected site. Reports are aso avaiabe from the SharePoint site settings page which is extended with the corresponding inks after Site Administrator instaation. Working with Site Administrator for SharePoint 25

26 Sign In Under Different User Account Information Porta users can sign in to the too under different user account for evauation and troubeshooting purposes. Perform the foowing: 1. Cick the current account you are ogged in. 2. Provide the user name in the domain\user format and password and cick OK. Search The search option aows you to search for any SharePoint site you need to review in more detai across a your SharePoint storage using a URL or a part of the URL. Widcard search is supported. To start the search, cick and press Enter. Search in the Information Porta menu. In the dispayed fied, specify the site URL You can imit your search to ooking in Farms, Web Appications, Site Coections and Sites by seecting the corresponding from the Information Porta menu. To imit the search resuts number to dispay, specify the foowing in the URL: search_imit=n, where N is the search resuts number to dispay. SharePoint Onine In the Information Porta menu you can see the SharePoint Onine ink, which aows you to view Information Porta reports for SharePoint Onine within Microsoft Office 365 coud. NOTE: Note that the SharePoint Onine ink is avaiabe ony for Information Porta administrators. Sign in Buid-in Domain Accounts The accounts of buit-in or non-federated domains ike Admin@<TenantName>.onmicrosoft.com shoud be used to og in to IPO 365. The ogin account shoud have the Goba Administrator roe. Ony the Goba Administrator account can access administrative site coection and is abe to get site coections ist. The account shoud be the site coection administrator for a site coections to gather report data. Working with Site Administrator for SharePoint 26

27 NOTE: In case the provided account does not have permissions to access the site coection, the site coection data wi not be incuded 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 abe to access it. If the ADFS 2.0 service is gobay avaiabe, then it coud be accessed by the IPO 365 server, but it has not been impemented yet. Reporting Site Administrator provides over a dozen of various vauabe reports avaiabe on different scopes. A 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 ro up aggregated data, give users a quick summary view and expose one-step dri down to a reports reevant to the area. A Site Administrator reports and dashboards are security trimmed. Depending on your security eve, you can view the foowing dashboards and reports: Tabe 1: Security Leves and Avaiabe Reports Reports Information Site Coection administrator Site Porta owner administrator IT + - Infrastructure Content Management Security Enterprise Servers Farm metrics Web Appications Content Databases Site Coections Site Metrics Sites Document and Pages Lists Document Working with Site Administrator for SharePoint 27

28 Reports Information Site Coection administrator Site Porta owner administrator Libraries Site Permissions User Permissions Security Changes Usage Activity Daiy Usage Content Changes Information Porta reports and dashboards are supported for SharePoint 2007, SharePoint 2010 and SharePoint Dashboards Viewing Dashboards To view a dashboard, seect the desired item from the Dashboards menu. NOTE: If your current scope is enterprise, farm or web appication, you wi see the Seect site window when trying to view the dashboard for a site. Specify the desired site for which you want to view the dashboard and cick OK. Dashboard Descriptions This section contains detaied description of the Site Administrator dashboards: IT Infrastructure Content Management Security Activity IT Infrastructure The IT Infrastructure dashboard provides summary information about your SharePoint infrastructure across the enterprise. The dashboard aows you to dri down into detais on farms, servers, web appications, content databases and sites as we as to quicky assess storage used by SharePoint content and heath of the SharePoint environment. Working with Site Administrator for SharePoint 28

29 The dashboard contains the foowing information: the tota content size of mutipe farms and the tota number of servers and farms. Cick View more to see the Enterprise report. the Information Growth graph dispaying the tota growth of a SharePoint farms content. Cick View more to see the Enterprise report. the number of content databases, web appications, site coections, and sites. Cick View more to see the Enterprise report. the Storage Space Distribution chart dispaying the ratio of tota sizes for content, versions, user and administrator recyce bins. Cick View more to see the Documents and Pages report for the enterprise scope the number of servers in each roe NOTE: Each server can have severa roes. the number of aerts in each category. Seecting any aert category opens a diaog dispaying detaied information on each aert in the seected category. A aerts are sorted by severity and marked with particuar coor. NOTE: Heath aerts are not supported for SharePoint If ony 2007 SharePoint farms are avaiabe in your SharePoint environment, the "Not avaiabe" message wi be dispayed. top 10 farms, servers, web appications, content databases, site coections and sites. NOTE: Top 10 farms are dispayed ony if the dashboard is opened for the enterprise scope. Seecting the farm tite in the farms ist opens the IT Infrastructure report for this farm. Working with Site Administrator for SharePoint 29

30 To add a farm to the product scope, cick the Add another farm ink. For more information, pease refer to the Adding SharePoint Farms section. To view a farms, web appications, content databases, site coections and sites avaiabe in your enterprise, cick the View more ink. Content Management The Content Management dashboard provides information that aows you to understand how much storage is used by the site or site coection, whether this storage space is used efficienty, and identify opportunities for ceanup. The report aows you to modify and propagate version settings for document ibraries, and enforce these settings as an ongoing poicy. Figure 4: Content Management Dashboard The dashboard contains the foowing information: Tota Content - dispays the tota content size of the current site, imit of the site coection size (if set) and avaiabe space (if set). The foowing formua is used to cacuate the avaiabe space: Site Coection Quota - Space Aready Used by Site Coection. Cicking the tie opens the Site metrics report for the current site. the Information Growth graph dispaying the tota growth of the site content. Cicking the tie opens the Site metrics report for the current site. the number of sub-sites, ists, ist items, document ibraries, documents, document versions, attachments and the tota size of a documents. NOTE: The number of sub-sites is not avaiabe for site owners. Cicking the tie opens the Site metrics report for the current site. Working with Site Administrator for SharePoint 30

31 the top used document types. Cicking the tie opens the Documents and Pages report for the current site. the Space Distribution pie-chart, dispaying the ratio of tota sizes for content, versions, user and administrator recyce bins. Cicking the tie opens the Documents and Pages report for the current site. Version Poicy - aows you to enforce version settings for document ibraries in the current site scope. For more information, pease refer to Configuring Version Settings for Document Libraries. 10 top sized sub-sites, ists, document ibraries, document types, documents. NOTE: The top sized sub-sites are not avaiabe for site owners. To view a sub-sites, ists, document ibraries, document types, documents for the current site, cick the View more ink. To seect another site for the dashboard cick using the search option in the Seect site window. next to the report tite, and then seect the desired site Security The Security dashboard provides access to the key permission-reated indicators and detaied security reports. It uncovers potentia security issues, such as broken permission inheritance and content open to a users. Figure 5: Security Dashboard The dashboard contains the foowing information: Working with Site Administrator for SharePoint 31

32 Authorized Users - the tota number users having permissions within the current site; the number of SharePoint and Active Directory groups used to grant permissions to the current scope. Cicking the tie opens the Site Permissions report for the current scope. Broken Inheritance - the tota number of SharePoint objects with unique permissions; the number of sites, ists and document ibraries, ist items and pages with unique permissions. Cicking the tie opens the Site Permissions report for the current scope. Open Content - the tota number of SharePoint objects (i.e. sites, ists, document ibraries, pages, documents, and items) where NT Authority\Authenticated Users have permissions. Cicking the tie opens the User Permissions report for NT Authority\Authenticated Users. User Permissions - aows you to search for permissions that a specific user has within the current scope. Cicking the tie aows you to view the User Permissions report for the current site. Inheritance Poicy - aows you to enforce permission inheritance for the current site. For more information, pease see Appying Security Settings. Authenticated Users Poicy - aows you to remove permissions granted to NT Authority\Authenticated Users within the current site scope. For more information, pease see Appying Security Settings. Recent Security Changes - the ist of recent security changes. Cicking View more opens the Security Changes report for the current site. To seect another site for the dashboard cick next to the dashboard tite, and then seect the desired site using the search option in the Seect site window. Activity It is essentia 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 heps IT and site owners to assess user adoption of a particuar site/project, quicky identify unused and staed content, assess how current is the site content; see most active users and contributors. NOTE: For SharePoint 2007, the dashboard dispays information over two weeks' period. For SharePoint 2010 and SharePoint 2013, the report dispays information over a month's period. Working with Site Administrator for SharePoint 32

33 Figure 6: Activity Dashboard The dashboard contains the foowing information: Page Views - dispays the tota number of page hits over the reported period, average number of page views per day and when the site was ast accessed. The bar chart dispays the usage of the site over the reported period daiy. Cicking the tie opens the Usage report for the current site. Visitors - dispays the tota number of users who accessed the site pages over the reported period and ists 3 most active visitors. Cicking the tie opens the Daiy Usage report for the current site. Unused - dispays the percentage of unused content. The foowing formua is used to cacuate the percentage: 100% (Tota Number of Documents and Pages - Number of Accessed Pages over Last month) / Tota Number of Documents and Pages. Cicking the tie opens the Documents and Pages report for the current site. Content Changes - dispays the tota number of content and security changes made within the current site, average number of content changes per day and when the content was ast modified. The bar chart dispays the number of changes over the reported period daiy. Cicking the tie opens the Activity report for the current site. Contributors - dispays the tota number of users who modified the site content over the reported period and ists 3 most active contributors. Cicking the tie opens the Content Changes report for the current site. Unchanged - dispays the percentage of unchanged content. The foowing formua is used to cacuate the percentage: 100% Number of Documents and Pages Modified over a month's period / Tota Number of Documents and Pages. Cicking the tie opens the Documents and Pages report for the current site. Recent Content Changes - dispays 10 recent content changes. Cicking View more opens the Content Changes report for the current site. Working with Site Administrator for SharePoint 33

34 NOTE: The usage data dispayed in the dashboard for SharePoint 2013 wi be incompete unti the data has been accumuated in the QSP_Repository database for one month. The dashboard wi dispay current data that affects monthy aggregated vaues, such as tota views and users. After initia synchronization the data coected for two weeks wi be dispayed since SharePoint stores this history. Two weeks after a farm was added to the product scope, the dashboard wi dispay the data coected for one month. To seect another site for the dashboard cick next to the dashboard tite, and then seect the desired site using the search option in the Seect site window. Reports In this section: Viewing Reports Report Descriptions IT Infrastructure Reports Content Management Reports Security Reports Activity Reports Viewing Reports To view a report, seect the desired item from the Reports menu. To view a report on the farm or web appication scope, seect Farms or Web Appications from the upper menu. Navigate to the object you want to view the report for, and then seect the required report ink. Report Descriptions Site Administrator for SharePoint provides the foowing reports: IT Infrastructure reports: Enterprise Servers Farm Metrics Web Appications Content Databases Site Coections Content Management reports: Site Metrics Sites Documents and Pages Working with Site Administrator for SharePoint 34

35 Lists Document Libraries Security reports: Site Permissions User Permissions Security Changes Activity reports: Usage Activity Daiy Usage Content Changes IT Infrastructure Reports Enterprise Report This report provides detaied information about your SharePoint environment: Figure 7: Enterprise Report The report contains the foowing information: Enterprise - This section provides information on the number of: Web appications, Content databases, Site Coections, Sites, Document Libraries, Documents, List Items and Lists. The Enterprise Information Growth graph dispays the tota growth of a SharePoint farms content over a year s period. To construct the graph, the document creation dates stored in the SharePoint content Working with Site Administrator for SharePoint 35

36 database are used. The Y axis shows the tota size of the documents created by the date marked on the X axis. You can seect the period you want to view the graph for. Top Sizes - This section provides the data on five biggest web appications, content databases, site coections, sites and documents. When navigating to a web appication or site/site coection, inks to specific reports and dashboards appear. Seecting any of the given inks opens the corresponding dashboard or report for the seected web appication or site scope. Seecting View more in the Web Appication/ Content Database/ Site Coections/ Sites/ Documents bock opens a report dispaying information on a web appications/content databases/site coections/sites/documents within your whoe enterprise. You can specify the fie types to be dispayed in the Documents bock by using the Fie Fiter Settings. To do this, cick the icon next to the bock tite. Farms - This section dispays the ist of farms within your SharePoint. Seecting the Add another farm ink, which appears when navigating to the tota farms' size, opens a page, dispaying a avaiabe SharePoint servers within your environment. Pease refer to Adding SharePoint Farms for more information. When navigating to a farm, the Farm metrics and Remove inks appear. Seecting the Farm metrics ink opens the Farm Metrics report. Seecting the Remove ink removes the farm from your SharePoint. Storage Space Distribution - This section is a pie-chart, dispaying the ratio of tota sizes for content, versions, user and administrator recyce bins. Document Types - This section provides the ist of a document types avaiabe in your environment, incuding the document extensions, the number and size for documents of each type. Cick View more to view the Documents and Pages report for your whoe enterprise. Servers Report This report provides the key metrics for a servers within the enterprise or farm scope. Working with Site Administrator for SharePoint 36

37 Figure 8: Servers Report The report provides the foowing information for each server: the name of the SharePoint server the SharePoint version the operating system the server is running the name of the host server farm the disk free space the amount of memory used by the server the ist of roes and services Farm Metrics Report This report provides detaied information on the seected SharePoint farm. Working with Site Administrator for SharePoint 37

38 Figure 9: Farm Metrics Report The report contains the foowing information: Farm Metrics - This section provides information on the number of: Web appications, Content databases, Site Coections, Sites, Document Libraries, Documents, List Items and Lists. The Farm Information Growth graph dispays the tota growth of a 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 tota size of the documents created by the date marked on the X axis. Top Sizes - This section provides the data on five biggest web appications, content databases, site coections, sites and documents. When navigating to a web appication or site/site coection, inks to specific reports and dashboards appear. Seecting any of the given inks opens the corresponding dashboard or report for the seected web appication or site scope. Seecting View more in the Web Appication/ Content Database/ Site Coections/ Sites/ Documents bock opens a report dispaying information on a web appications/content databases/site coections/sites/documents within your farm. You can specify the fie types to be dispayed in the Documents bock by using Fie Fiter Settings. To do this, cick the icon next to the bock tite. Farm Information - This section dispays information on the farm. Storage Space Distribution - This section is a pie-chart, dispaying the ratio of tota sizes for content, versions, user and administrator recyce bins. Document Types - This section provides the ist of a document types avaiabe within the seected farm, incuding the document extensions, the number and size for documents of each type. Cick View more to view the Documents and Pages report for the seected farm. Working with Site Administrator for SharePoint 38

39 Web Appications Report This report presented as a grid provides the key metrics for a web appications within the enterprise or farm scope. NOTE: Pease note that the report wi not contain any data unti it is coected by the data gathering task. NOTE: The ist of web appications is taken from the SharePoint configuration database. Each time a user opens the report, the web appication ist is refreshed, i.e. the report dispays a the web appications incuding those created after the farm was discovered. If for some reason the SharePoint configuration database is unavaiabe, the ist of web appications is taken from the QMC repository. Figure 10: Web Appications Report By defaut, the report dispays the foowing information: the name of the farm hosting the web appication the number of a site coections within the web appication the number of a sites within the web appication the number of a content databases within the web appication the tota number of users. The users number vaue is taken from the Users tabe in every content database the tota size of a site coections within the web appication You can fiter and sort the report contents as we as add or deete coumns to/from the report using the options from the drop-down menu. Content Databases Report This report provides the key metrics for a content databases within the enterprise or farm scope. NOTE: Pease note that the report wi not contain any data unti it is coected by the data gathering task. Working with Site Administrator for SharePoint 39

40 Figure 11: Content Databases Report By defaut, the report dispays the foowing information: the name of the database the number of a site coections in the content database the number of a sites in the content database the tota size of a fies in the content database incuding transaction ogs the tota size of a the content such as documents, ists, and ist items in the content database the maximum number of sites that the content database can contain the number of sites that can be created before a warning event is generated and sent to the site coection owner You can fiter and sort the report contents as we as add or deete coumns to/from the report using the options from the drop-down menu. Site Coections Report This report provides you with the key metrics for a site coections within the web appication, farm or the enterprise scope. Working with Site Administrator for SharePoint 40

41 Figure 12: Site Coections Report The report provides the foowing information for each site coection: the name of the site coection; the path to the site coection; the inks to the Activity, Content Management, and Security dashboards. The inks appear when navigating to the required site coection. the date when the site coection was created; the name of the user who created the site coection; the name of the site coection administrator; the date when any content, page or document within the site or site coection was ast accessed; the date when the site coection was ast modified; the number of sites within the site coection; the tota number of the document/page views within the scope over the past 30 days; the number of unique users who accessed any content within the site coection scope over the past 30 days; the tota size of the site coection. NOTE: For SharePoint 2010 Foundation, the usage information (the number of views and the ast access date) is dispayed ony for pages. The documents usage information is not dispayed. Working with Site Administrator for SharePoint 41

42 The usage data dispayed in the report for SharePoint 2013 wi be incompete unti the data has been accumuated in the QSP_Repository database for one month. The report wi dispay current data that affects monthy aggregated vaues, such as tota views and users. After initia synchronization the data coected for two weeks wi be dispayed since SharePoint stores this history. Two weeks after a farm was added to the product scope, the report wi dispay the data coected for one month. By defaut, the report dispays ony 20 site coections. To adjust the scope, change the report setting on the Information Porta Settings page. For more information, pease refer to Report Settings. NOTE: Each site can generate 5-10 seconds. If, for exampe, you change the defaut vaue 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, pease refer to Exporting Reports. NOTE: If any issues occur when running the report, you wi see them at the top of the page. Content Management Reports Content Management Reports Site Metrics Report The Site Metrics report provides detaied information on the seected SharePoint site. Figure 13: Site Metrics Report The report contains the foowing information: Working with Site Administrator for SharePoint 42

43 Metrics for {Site name (URL)} - This section provides information on the site tota content size, the number of Sub-sites, Lists, List Items, Document Libraries, Documents, and the tota size of a documents, the number of their versions and attachments. The Site Information Growth graph dispays the tota growth of the site content with a its sub-sites over a month s period. If you work with Information Porta as site owner, the graph dispays the tota growth of the site content ony. To construct the graph, the document creation dates stored in the SharePoint content database are used. The Y axis shows the tota size of the documents created by the date marked on the X axis. To seect another site for the report, cick the search option in the Seect site window. icon and then seect the desired site using the Top Sizes - This section provides the data on five biggest sub-sites, document ibraries, ists and documents on the site. When navigating to a site/site coection, inks to specific dashboards appear. Seecting any of the given inks opens the corresponding dashboard for the seected scope. Seecting View more in the Sites/ Documents/ List/ Doc ibrary bock opens a report dispaying information on a sub-sites/documents/ists/ document ibraries within the current site scope. NOTE: The View more ink in the Sites bock is not avaiabe for site owners. You can specify the fie types to be dispayed in this section by using Fie Fiter Settings. To do this, cick the icon next to the section tite. NOTE: The fiter option is avaiabe ony for Information Porta administrators. Site Information - This section dispays the site creation information. Site Coection Information provides the URLs of the web appication and site coection, site administrators, size quota and content database. Storage Space Distribution - This section is a pie-chart, dispaying the ratio of tota sizes for content, versions, user and administrator recyce bins. Document Types - This section provides the ist of a document types avaiabe in your environment, incuding the document extensions, the number and size for documents of each type. Cick View more to view the Documents and Pages report for the site. Sites Report This report provides you with the key metrics for a sites and sub-sites within the site coection, site, farm or enterprise scope. Working with Site Administrator for SharePoint 43

44 Figure 14: Sites Report The report provides the foowing information for each site: the name of the site; the path to the site; the inks to the Activity, Content Management, and Security dashboards. The inks appear when navigating to the required site coection. the date when the site was created; the name of the user who created the site; the name of the site administrator; the date when the site was ast accessed; the date when the site content was ast modified; the number of sub-sites within the site; the number of the site views over the past month; the number of site unique users over the past month; the site size excuding its sub-sites. NOTE: For SharePoint 2010 Foundation, the usage information (the number of views and the ast access date) is dispayed ony for pages. The documents usage information is not dispayed. The usage data dispayed in the report for SharePoint 2013 wi be incompete unti the data has Working with Site Administrator for SharePoint 44

45 been accumuated in the QSP_Repository database for one month. The report wi dispay current data that affects monthy aggregated vaues, such as tota views and users. After initia synchronization the data coected for two weeks wi be dispayed since SharePoint stores this history. Two weeks after a farm was added to the product scope, the report wi dispay the data coected for one month. Site properties are dispayed for each site individuay, i.e. the Views property dispays the number of views ony for this particuar site, etc. By defaut, the report dispays ony 20 sites. To adjust the scope, change the report settings on the Information Porta Settings page. For more information, pease refer to Report Settings. NOTE: Each site can generate 5-10 seconds. If, for exampe, you change the defaut vaue 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, pease refer to Exporting Reports. NOTE: If any issues occur when running the report, you wi see them at the top of the page. Documents and Pages Report This report aows you to view the key metrics for a documents and pages within the enterprise, farm, web appication, site coection or site scope incuding its subsites. NOTE: For site owners the report dispays information for the site scope excuding its sub-sites. A site owner wi see a documents and pages in the report even if documents and pages are in the ibrary with broken permissions inheritance and the site owner s access to this ibrary is revoked. Figure 15: Documents and Pages Report Working with Site Administrator for SharePoint 45

46 The report provides the foowing information for each document and page: the name of the document/page; the path to the document/page. Dispayed ony for documents in document ibraries; the type of the document/page. Dispayed ony in CSV report; the time when the document/page was created; the time when the document/page was ast modified; the name of the user who created the document/page; the name of the user who modified the document/page; the date when the document/page was ast accessed; the tota number of the document/page views within the scope over the past 30 days; the number of the document versions; the tota size of the document/page; the size of the ast document/page version. NOTE: For SharePoint 2010 Foundation, the usage information (the number of views and the ast access date) is dispayed ony for pages. The documents usage information is not dispayed. The usage data dispayed in the report for SharePoint 2013 wi be incompete unti the data has been accumuated in the QSP_Repository database for one month. The report wi dispay current data that affects monthy aggregated vaues, such as tota views and users. After initia synchronization the data coected for two weeks wi be dispayed since SharePoint stores this history. Two weeks after a farm was added to the product scope, the report wi dispay the data coected for one month. By defaut, the report dispays a document and page types. You can specify the fie types to be dispayed in the report by using Fie Fiter Settings. To do this, cick the icon next to the report tite. To fiter the contents of the grid report, use the fiter option from the drop-down. NOTE: The fiter option is avaiabe ony for Information Porta administrators. Note that fiter settings are not appied to CSV version of the report. Therefore, it wi contain unfitered data. By defaut, the report dispays ony 20 sites. To adjust the scope, change the report settings on the Information Porta Settings page. For more information, pease refer to Report Settings. You can export the report to CSV or SQL format. For more information, pease refer to Exporting Reports. To change the site scope for the report, cick the icon next to the report tite, and then seect the desired site using the search option in the Seect site window. Lists Report NOTE: If any issues occur when running the report, you wi see them at the top of the page. This report provides the key metrics for a ists within the site coection or site scope incuding its sub-sites. NOTE: For site owners the report dispays information for the site scope excuding its sub-sites. Working with Site Administrator for SharePoint 46

47 System ists are dispayed ony in the CSV report. Lists from the Recyce Bin are not dispayed. Figure 16: Lists Report The report provides the foowing information for each ist: the type of the ist; the name of the ist; the path to its parent site; the date when the ist was created; the date when the ist was ast modified; the number of a ist items; the number of a ist attachments; the tota size of the ist; the number of a item versions. By defaut, the report dispays ony 20 ists. To adjust the scope, change the report settings. For more information, pease refer to the Site Administrator Settings section. To change the site scope for the report, cick the icon next to the report tite, and then seect the desired site using the search option in the Seect site window. Document Libraries Report This report provides the key metrics for a document ibraries within the site coection or site scope incuding its sub-sites. Working with Site Administrator for SharePoint 47

48 NOTE: For site owners the report dispays information for the site scope excuding its sub-sites. System document ibraries are dispayed ony in the CSV report. Document ibraries from the Recyce Bin are not dispayed. Figure 17: Document Libraries Report The report provides the foowing information for each document ibrary: the type of the document ibrary the name of the document ibrary the path to its parent site the date when the document ibrary was created the date when the document ibrary was ast modified the number of documents in the document ibrary the tota size of the document ibrary the number of a documents versions By defaut, the report dispays ony 20 document ibraries. To adjust the scope, change the report settings. For more information, pease refer to the Site Administrator Settings section. To change the site scope for the report, cick the icon next to the report tite, and then seect the desired site using the search option in the Seect site window. Working with Site Administrator for SharePoint 48

49 Security Reports Site Permissions Report The site permissions report aows you to view the ist of users having access to a specific site, its sub-sites, ists, document ibraries, foders and documents and their permission eves, with expanded SharePoint and Active Directory group membership. You can aso see how each permission eve has been granted to a user. NOTE: User permissions for system ists are not dispayed. The report dispays permissions of the groups and users from externa forests even with one-way trusts. Groups (except for the we-known groups ike Authenticated users) are automaticay expanded to the ist of users. Figure 18: Site Permissions Report The report contains the foowing information: the name of the user who has access to the site the user name (received from Active Directory) the eve of user access and how it is granted NOTE: The report dispays ony the eading and traiing groups through which permissions were granted. Cick the traiing group to view the compete ist of groups. Note that the number of unique permissions dispayed in the report is imited to 500. Working with Site Administrator for SharePoint 49

50 To change the site scope for the report, cick the icon next to the report tite, and then seect the desired site using the search option in the Seect 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 appication, site coection or site scope. You can aso see how each permission eve has been granted to a user or group. The report: Dispays a sites/sub-sites a user or group has permissions for within the current farm/web appication/site coection/site, permission eve for each site/ sub-site and how it is granted Dispays any ists and ibraries that do not inherit site permissions Dispays any document, foder and ist item with expicit permissions Supports compex muti-domain and muti-forest environments NOTE: For Active Directory groups the report dispays ony permissions granted expicity or via SharePoint groups. Permissions granted via another Active Directory group are not dispayed. In muti-forest environments, make sure the Information Porta service account has a required permissions and sufficient trusts for the domains invoved. To view the report, seect User Permissions from the Reports menu, specify the account you want to view permissions for and cick Show Permissions. Figure 19: User Permissions Report NOTE: The report dispays ony the eading and traiing groups through which permission were granted. Cick the traiing group to view the compete ist of groups. Note that the number of unique permissions dispayed in the report is imited to 500. Working with Site Administrator for SharePoint 50

51 To change the site scope for the report, cick the icon next to the report tite, and then seect the desired site using the search option in the Seect site window. NOTE: Both the User Permissions and Site Permissions reports have management options aowing you to perform a number of actions on permissions. For more information, pease refer to the Managing Security section. Security Changes Report This report dispays a the security changes within the site scope incuding its sub-sites and when the changes were made. NOTE: The foowing site coection eve security changes are dispayed for site owners: create/deete a SharePoint group add/remove a member to/from a SharePoint group create site coection event Figure 20: Security Changes Report By defaut, the report dispays ony 20 changes. To adjust the scope, change the report settings. For more information, pease refer to the Site Administrator Settings section. To change the site scope for the report, cick the icon next to the report tite, and then seect the desired site using the search option in the Seect site window. Working with Site Administrator for SharePoint 51

52 Activity Reports Usage Report This report provides you with the site usage statistics over a month's period. NOTE: The usage report dispays the data coected by SharePoint. SharePoint coects data ony if the Usage Anaysis Processing option is enabed. In WSS 3.0 and MOSS 2007, the Usage Anaysis Processing option is disabed by defaut. You must enabe it manuay from Centra Administration. For information on how to enabe the option, pease refer to After the Usage Anaysis Processing option is enabed, the SharePoint usage anaysis job operates daiy on each front-end server and gathers yesterday ogs. This process is not supposed to be very resource intensive as the job coects information for one day ony. The data is accumuated, and then moved to the SharePoint content database. It is not required to configure MOSS 2007 Shared Services provider. The Information Porta data is based on the SharePoint Services usage anaysis job ony. In SharePoint 2010 Foundation, the Usage Anaysis Processing option is enabed by defaut. In case it was disabed, enabe it manuay. SharePoint has a new mechanism which coects usage information from text ogs and moves it to the WSS_Logging database every 30 minutes. Then the usage anaysis processing job processes the database and moves the usage data to content database (the same ocation and format as in SharePoint 2007). Information Porta dispays the data the same way as in SharePoint SharePoint 2010 Server has the Web anaytics feature, which is configured by defaut and incudes the Web Anaytics services, the Web Anaytics staging and reporting databases. The usage data is coected from text ogs and moved to the staging database by the SharePoint job every 30 minutes. Every day the Web Anaytics service coects and aggregates data from the staging to the reporting database. The data format is different from the one in SharePoint 2010 Foundation. Information Porta uses the web anaytics reporting database to dispay usage statistics. For SharePoint 2013, the usage data gathering process is initiated by the SASP_Usage_Coector_task schedued task (usage coector) at 2 a.m every day. The usage data is coected from the WSS_Logging database and stored in the QSP_Repository database. The usage data coection may resut in growth of the QSP_Repository database as a resut of the usage coector work. To prevent unimited growth and impact on the report performance, od data is removed from the database at 1 a.m. every day (the process is initiated by the SASP_Repository_Ceanup_task schedued task). The scheduing can be modified by updating the SASP_Usage_Coector_task and SASP_Repository_Ceanup_task properties using the Windows Task Scheduer. IMPORTANT: The usage data dispayed in the report for SharePoint 2013 wi be incompete unti the data has been accumuated in the QSP_Repository database for one month. The report wi dispay current data that affects monthy aggregated vaues, such as tota views and users. After initia synchronization the data coected for two weeks wi be dispayed since SharePoint stores this history. Two weeks after a farm was added to the product scope, the report wi dispay the data coected for one month. Working with Site Administrator for SharePoint 52

53 Figure 21: Usage Report The report contains the foowing information: Monthy Usage for {Site name (URL)} - This section provides summary information on the: average number of daiy views, number of users accessing the site, number of sub-sites, tota content size, date when the site was ast accessed and modified. NOTE: For SharePoint 2010 Foundation, the information is dispayed ony for pages. The documents usage information is not dispayed. Number of Page Views is a graph dispaying the number of page views per month. 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 dispayed ony for pages. The documents information is not dispayed. When navigating to a sub-site, inks to specific dashboards appear. Seecting any of the given inks opens the corresponding dashboards for the seected sub-site scope. Seecting View more in one of the dispayed bocks opens a report dispaying information on a subsites or documents within the current site scope. You can specify the fie types to be dispayed in the Most used documents and pages bock of the section by using Fie Fiter Settings. To do this, cick the icon next to the bock tite. NOTE: Ony Information Porta administrators can use the fitering option. Top Unused Content - This section provides the data on five east visited sites and five ong unused sites. Long unused sites are top five sites sorted by the ast access date in the foowing order: from Working with Site Administrator for SharePoint 53

54 east to most recenty accessed. Note that the access date is the date when a page in the sub-site tree was ast accessed. When navigating to a sub-site, inks to specific dashboards appear. Seecting any of the given inks opens the corresponding dashboards for the seected sub-site scope. Seecting View more in one of the dispayed bocks opens a report dispaying information on a subsites within the current site scope. For more information, see the Sites report section. Site Information - This section dispays the site creation information. Site Coection Information provides the URLs of the web appication and site coection, site administrators, size quota and content database. Most Active Users - This section ists five most active users and indicates the number of hits in the scope of the seected site incuding its sub-sites. Seecting View more opens the Daiy Usage report for the current site. To change the site scope for the report, cick the icon next to the report tite, and then seect the desired site using the search option in the Seect site window. Activity Report This report provides summary information about users' activity within the site scope. NOTE: The report dispays information in the SharePoint change og. By defaut, the change og retains data for 15 (SharePoint 2007) or 60 (SharePoint 2010, SharePoint 2013) days. You can configure this setting in Centra Administration. For more information, pease refer to the foowing artice: Figure 22: Activity Report The report contains the foowing information: Working with Site Administrator for SharePoint 54

55 {Site name (URL)} - This section dispays the tota number of changes made within the seected site incuding its sub-sites, number of users who made the changes and period over which the changes were made. The graph dispays the number of changes within the seected site incuding its sub-sites daiy. Most Recent Changes - This section contains information on 5 recent content and security changes within the seected site incuding its sub-sites. NOTE: The foowing site coection eve security changes are dispayed for site owners: create/deete a SharePoint group add/remove a member to/from a SharePoint group create site coection event Seecting View more in the Content or Security bock opens the Content Changes or Security Changes report. Modification Types - This section is a bar chart aowing you to compare how many updates, deetions and additions are made within the seected site incuding its sub-sites. Modification Ratio - This section is a pie-chart, dispaying the ratio of changed and unchanged content of the seected site incuding its sub-sites. Site Information - This section dispays the site creation information. Site Coection Information provides the URLs of the web appication and site coection, site administrators, size quota and content database. NOTE:The Site Coection Information is not avaiabe for site owners. To change the site scope for the report, cick the icon next to the report tite, and then seect the desired site using the search option in the Seect site window. Daiy Usage Report This report provides you with the activity detais of the 5 most active users on a site/site coection over a month's period. Working with Site Administrator for SharePoint 55

56 Figure 23: Active Users Report The report dispays the foowing information: the date when the site was visited; the site visitors number; the site views number; the user dispay name (received from Active Directory) or user ogin; the user tite (received from Active Directory); the user e-mai (received from Active Directory). To change the site scope for the report, cick the icon next to the report tite, and then seect the desired site using the search option in the Seect site window. Content Changes Report This report dispays a content changes made within the site scope incuding its sub-sites and when the changes were made. Working with Site Administrator for SharePoint 56

57 Figure 24: Content Changes Report By defaut, the report dispays ony 20 changes. To adjust the scope, change the report. For more information, pease refer to the Site Administrator Settings section. To change the site scope for the report, cick the icon next to the report tite, and then seect the desired site using the search option in the Seect site window. Exporting Reports The Export feature aows Information Porta administrators to export report data to the foowing formats: PDF, CSV, SQL. NOTE: Export to PDF is supported for the foowing reports: Enterprise, Farm Metrics, Site Metrics, Usage, Activity. Export to CSV is supported for the foowing reports: Servers, Web Appications, Content Databases, Site Coections, Sites, Documents and Pages, Lists, Document Libraries, Site Permissions, User Permissions, Security Changes, Daiy Usage, Content Changes. Export to SQL is supported for the foowing reports: Servers, Site Coections, Sites, Documents and Pages, Lists, Document Libraries, Site Permissions, User Permissions, Security Changes, Daiy Usage, Content Changes. To export report data to PDF format, cick the PDF ink. To export report data to CSV format, cick the CSV or Create CSV report ink. You can aso configure the report to be exported to CSV automaticay at specific times using scheduing options. To export report data to SQL format, configure the report export using scheduing options. NOTE: Scheduing options are avaiabe ony for Information Porta administrators. Working with Site Administrator for SharePoint 57

58 NOTE: You can aso export report data to CSV or SQL programmaticay. For more information, pease refer to the Exporting Reports Programmaticay section. In CSV fie format, the information is stored as comma separated vaues. For each report, a CSV fie wi be generated. The name of the CSV fie wi be the name of the report. In SQL export format, the information is stored as SQL tabes in the QSP_Repository database. For each report, a separate tabe with fieds same as in the report wi be created: Servers - dbo.sa4sp_repdata1_servers Documents and Pages - dbo.sa4sp_repdata1_documents_and_pages Lists - dbo.sa4sp_repdata1_ists Document Libraries - dbo.sa4sp_repdata1_document_ibraries Site Permissions - dbo.sa4sp_repdata1_site_permissions User Permissions - dbo.sa4sp_repdata1_user_permissions Security Changes - dbo.sa4sp_repdata1_activity_more_security Daiy Usage - dbo.sa4sp_repdata1_daiy_active_users Content Changes - dbo.sa4sp_repdata1_activity_more_content Report data is accumuated in the tabe with each data coection. NOTE: The names and schema of the tabes have been changed in this version of Site Administrator. You can use SQL Views that dupicate the names and schema of SQL tabes in previous version: Servers - dbo.sa4sp_repdata_servers Web Appications - dbo.sa4sp_repdata_webapps Content Databases - dbo.sa4sp_repdata_contentdbs Site Coections - dbo.sa4sp_repdata_site_coections Sites - dbo.sa4sp_repdata_sites Documents and Pages - dbo.sa4sp_repdata_documents_and_pages Lists - dbo.sa4sp_repdata_ists Document Libraries - dbo.sa4sp_repdata_document_ibraries Site Permissions - dbo.sa4sp_repdata_site_permissions User Permissions - dbo.sa4sp_repdata_user_permissions Security Changes - dbo.sa4sp_repdata_activity_more_security Daiy Usage - dbo.sa4sp_repdata_daiy_active_users Content Changes - dbo.sa4sp_repdata_activity_more_content NOTE: You can export data from a generated CSV fie to any SQL database tabe using a script incuded with the product. For more information, pease refer to CSV to SQL Export. Export of report data to CSV/SQL can be run for any individua site as we as for enterprise, web appication or farm if the report is avaiabe on these scopes. For information on the supported report scopes, pease refer to Report Descriptions. Working with Site Administrator for SharePoint 58

59 If you want to export report data on your whoe enterprise and the report is not avaiabe on the enterprise scope, it is recommended to write a script using the Site Administrator for SharePoint REST API. Scheduing Report Export to CSV/SQL Information Porta administrators are aowed to schedue reports to be exported to CSV or SQL automaticay at specific times. To set a schedue: for the report export to CSV, cick the icon next to the report tite. for the report export to SQL, cick the icon next to the report tite. From the drop-down menu seect either of the foowing: run the report export according to one of the predefined schedues (weeky, monthy, or quartery). customize you own schedue. By defaut, schedued task for the Custom option is disabed. Therefore, it is required to enabe it and then configure the required schedue using the Schedued Task contro pane. disabe the report schedue. If any issues occur when scheduing the report export, you wi see an error message at the top of the page. Cicking the detais ink dispays more information about the occurred error. NOTE: If Information Porta is instaed on severa front-end servers, note that: First Information Porta instaation is considered as a master server. Ony Windows Schedued Tasks executed on this server run the report export. The export resuts are stored ony on this master server. Any scheduing adjustments using Windows Task Scheduer must be made on this master server. If Information Porta was removed from the master server, scheduing wi be broken. In this case, you can either reinsta Information Porta on the master server or change the master server by editing the NetBiosHostName coumn of the QMasterAgent SQL tabe in the Information Porta configuration database. NOTE: Schedued tasks to initiate the report export to SQL and CSV are shared, i.e. if you modify custom schedue for the report export to CSV, the report export to SQL wi aso run in accordance with the new schedue. How It Works The process of exporting report data to CSV/SQL is initiated by the Site Administrator schedued task on a front-end server in accordance with the specified schedue. The task executes the job which is created in the QSP_ Repository database tabe after you enabe the report scheduing. When exporting data to SQL, the data is first exported to CSV and then the schedued task runs a script that transfers CSV data to SQL server database (for more information on the script, see CSV to SQL Export). CSV fies are not deeted after report data is exported to SQL. Working with Site Administrator for SharePoint 59

60 Export to SQL Performance Test Resuts Performance tests were run for Documents and Pages and Site Permissions reports. Test Resuts: Documents and Pages report: Content: documents 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) Ratio: 92 documents/sec or 15 KB/sec Size: 387 MB in 13 csv fies (12 MB in zip archive). SQL Tabe size: 587 MB Site Permissions report: Content: permissions Tota time: 27 minutes Ratio: 93 permissions/sec or 23 KB/sec Size: 36 MB (700 KB in zip archive) Memory Usage: services: each up to 100 MB of working set. python32 import process: <78 MB ipy64 import process: <124 MB Hardware and Software used in test: Virtua Machine: 16 GM RAM, 4 processors X GHz SharePoint SQL 2008 R2 Exporting Reports Programmaticay To export report data to CSV or SQL format using API cas, perform the foowing: 1. Ca the PUT method to start the export operation. Starting the export operation initiates either the CSV/SQL update for the reports with sow performance or cache update for the reports with fast performance. here server is the server name of Information Porta web access, port is the port number of Information Porta web access (defaut port is 3141), <fietype> is the fie type to which report data wi be exported: sq or csv. [scope] can be either of the foowing: without scope - Enterprise eve <report_name> is one of the foowing: contentdbs webapps Working with Site Administrator for SharePoint 60

61 site_coections sites documents_and_pages farm=<sharepointconfig db> - Farm eve <report_name> is one of the foowing: site_coections documents_and_pages user_permissions webapp=<webapp ur> - Web Appication eve <report_name> is one of the foowing: site_coections documents_and_pages user_permissions ur=<site_ur> - Site and Site Coection eve <report_name> is one of the foowing: sites document_and_pages user_permissions site_permissions ists documents_ibraries daiy_active_users [user] parameter: user=domain\name user_permissions Some exampes of API methods: config db> app ur> config db>&user=<user_ name> 2. Wait unti the operation is finished. To check the progress, ca the GET method with interva 5-10 seconds unti it returns 100%. Parameters of this method are the same as in the PUT method (see above). Working with Site Administrator for SharePoint 61

62 Response returns in JSON format: {"progress": 100, "actua_on": " :50", "error": "message"} "progress" is the percentage of the export progress. Sow reports have ony 0%, 50% and 100%. "actua_on" is the date and time of the ast exported fie. "error" dispays a message if an error occurred, otherwise - empty string. 3. Downoad the resut fie using the foowing method: GET The fie can be downoaded severa times without executing the operation which shoud be used to update the fie. Parameters of this method are the same as in the PUT method (see above). Managing SharePoint In this section: Managing Security Restructuring SharePoint Content Configuring Version Settings for Document Libraries Managing Security Information Porta aows you to contro access to site and site content (foders, documents and ist items) by adjusting users' permissions with permission management options and appying security settings. Managing User Permissions With permission management options you can: revoke permissions grant permissions dupicate permissions reassign permissions NOTE: Site coection administrators can ony revoke and grant permissions in the scope of the site coections they manage. Site owners are not aowed to manage permissions. NOTE: Information Porta needs to be instaed on a front-end server in each SharePoint farm you want to manage permissions. Otherwise, management options wi fai to work. NOTE: Make sure that scripting is enabed in your browser. Otherwise, permission management options wi fai to work. Permission management options are avaiabe on the User Permissions or Site Permissions report page. Working with Site Administrator for SharePoint 62

63 Aternativey you can access the options by seecting either the Farms, Web Appications, Site Coections or Sites ink in the Information Porta menu, and then seecting the required entity you want to manage permissions for. Revoking Permissions To revoke user permissions: 1. Cick the Revoke button. Aternativey, on the Site Permissions report, navigate to the desired user record, cick seect Revoke from the drop-down menu., and then 2. On the Confirmation diaog, cick Yes to revoke user permissions. Granting Permissions To grant user permissions: 1. Cick the Grant button. The Grant Permissions diaog appears: Aternativey, on the Site Permissions report, navigate to the desired user record, cick seect Grant from the drop-down menu., and then 2. In the Seect Users area, specify the users to appy the permissions. In the Seect Permissions area, seect the desired permission eve. NOTE: The Edit permission eve introduced in SharePoint 2013 and supported by Site Administrator cannot be granted to SharePoint 2007 and SharePoint 2010 sites. The Edit check box wi be dispayed in the diaog ony if you grant permissions to a SharePoint 2013 site. However, when you use the Grant option avaiabe on the search page, the Edit check box wi be dispayed regardess of the site SharePoint version. If you appy this permission eve to a SharePoint 2007 or SharePoint 2010 site, it wi appear in the resuting report but the appied roe wi show bank space instead of Edit. 3. Cick Grant. NOTE: Permissions granted on a web appication are spread to a sub-sites and ists with unique permissions. Dupicating Permissions To dupicate user permissions: 1. Cick the Dupicate button. The Dupicate Permissions diaog appears. Aternativey, on the Site Permissions report, navigate to the desired user record, cick, and then seect Dupicate from the drop-down menu. 2. Specify a user whose permissions you want to copy, and then the users to appy the copied permissions. Cick Dupicate. NOTE: User permissions granted via AD group cannot be copied. But you can copy the AD group permissions granted directy. Working with Site Administrator for SharePoint 63

64 Reassigning Permissions To reassign user permissions: 1. Cick the Reassign button. The Reassign Permissions diaog appears Aternativey, on the Site Permissions report, navigate to the desired user record, cick, and then seect Reassign from the drop-down menu. 2. Specify a user whose permissions you want to reassign, and then the users to appy the permissions. Cick Reassign. Appying Security Settingss Site Administrator for SharePoint aows you to appy the foowing security settings to your sites: restore broken inheritance permissions for a specific site incuding its sub-sites and items. remove access granted to the NT Authority\Authenticated Users group within the current site incuding its sub-sites. NOTE: Ony Information Porta administrators and site coection administrators can appy security settings. To appy security settings, open the Security dashboard for the desired site, cick the Inheritance Poicy or Authenticated Users Poicy tie and seect either of the foowing: Appy Once - the security setting wi be appied to the site ony once. Set as Poicy - the security setting wi be appied to the site houry. For more information, pease refer to the Poicies section. Restructuring SharePoint Content Information Porta provides options which aow you to reorganize your SharePoint content structure within the same farm. NOTE: Information Porta needs to be instaed on a front-end server in each SharePoint farm you want to manage permissions. Otherwise, management options wi fai to work. NOTE: Make sure that scripting is enabed in your browser. Otherwise, permission management options wi fai to work. NOTE: Content management options are not avaiabe for site owners. Content management options are not avaiabe for site owners. You can restructure you SharePoint content in the foowing ways: copy sites copy ists Working with Site Administrator for SharePoint 64

65 Copying Sites This action can be performed on any site, incuding the root site of a site-coection. Its entire content wi be copied to the specified destination. 1. Cick the Site Coections or Sites ink from the top menu of Information Porta. On the dispayed page, use check-boxes to seect the sites that you want to copy. NOTE: Sites being copied must beong to the same site coection. 2. Cick the Copy Site button, and then seect the destination under which you want to copy seected sites. Use search to ease finding of the destination site. NOTE: Note that destination sites must beong to the same farm as the source. 3. Cick Copy. As a resut the content of the source site wi be appended to the existing hierarchy of the destination site. Copying Lists 1. Go to the Site Coections or Sites ink from the top menu of Information Porta. Seect sites whose ists you want to copy. NOTE: Sites you seect shoud be from the same site coection. 2. Cick the Copy List button. Seect ists you want to move in the Seect ists window. Cick Next. 3. Seect the target site you want to move the copied ists to using URL search in the Seect target site window. 4. Cick Copy. Configuring Version Settings for Document Libraries Versioning in document ibraries enabes you to track and manage information as it evoves and to view and recover earier versions if necessary. With Site Administrator for SharePoint you can configure version settings for a document ibrary within a specific site coection or site depending on your requirements. You can specify whether to track a versions in the same way or specify that some versions are major and some are minor as we as contro how many versions are stored in a document ibrary, which can hep you to preserve server space and prevent the version history from becoming too excessive. NOTE: Ony Information Porta administrators and site coection administrators can configure and appy version settings. To configure and appy version settings for a document ibrary: 1. Go to the Content Management dashboard for the desired site and cick the Version Poicy tie. The Propagate versioning settings and cean up diaog appears: Working with Site Administrator for SharePoint 65

66 Figure 25: Versioning 2. Specify the required settings. The foowing version settings are provided: No Versioning - specifies that no previous versions of documents are saved. This option is seected by defaut. Create major versions - specifies that numbered versions of documents are retained by using a simpe versioning scheme. Create major and minor (draft) versions - specifies that numbered versions of documents are retained by using a major and minor versioning scheme. Keep the foowing number of major versions - specifies how many previous major versions to keep, counting back from the current version. Keep drafts for the foowing number of major versions - specifies how many major versions being kept shoud incude their respective minor versions. 3. Seect either of the foowing: Appy Once - the version settings wi be appied to the site ony once. Set as Poicy - the version settings wi be appied to the site houry. For more information, pease refer to the Poicies section. Working with Site Administrator for SharePoint 66

67 Poicies Site Administrator for SharePoint introduces a new way of appying a certain number of predefined rues to the production SharePoint environment. The poicies aow you to manage: Open content - prevents the use of the "NT Authority\Authenticated Users" permissions in order to restrict access to the SharePoint items so that ony the users with expicit permissions coud access them. Broken inheritance - restores broken inheritance permissions for a specific site. The action invoves sub-sites and items in the given site. Version settings - sets version settings for document ibraries within the specified site or site coection. How it works: The poicy appication process is run on the front-end server of every farm and initiated by the SASP_Poicy_ task schedued task on reguar basis (every hour). The scheduing can be modified by updating the SASP_ Poicy_task properties using Windows Task Scheduer. NOTE: The changes in the SharePoint environment that do not match the current poicy settings are not prevented to happen when they are appied; the poicy engine tracks the changes and robacks or updates the settings each time the SASP_Poicy_task task is run. Site Administrator Settings The Settings page aows you to grant additiona users rights to view a Site Administrator Information Porta reports, set the number of items to be dispayed in the reports and hide management options in Site Administrator. To open the settings page, cick the icon in the appication bar. NOTE: The settings are not avaiabe for site owners. Access Settings By defaut, site coections administrators have access to the reports on the sites they manage. In addition, the user account used to insta Site Administrator Information Porta can access reports for the entire environments. Information Porta aows you to grant a user fu access to view a Information Porta reports. Perform the foowing: 1. Open the settings page. 2. In the Access Settings section, specify the account you want to grant fu access, and then cick Add. The account appears in the ist beow. To deete the account from the ist, cick the icon. NOTE: You cannot deete the ast user account with fu access to Site Administrator for SharePoint - Information Porta reports from the ist. Working with Site Administrator for SharePoint 67

68 Report Settings You can adjust the number of the items (sites, documents, etc.) to be dispayed in Site Administrator reports. Perform the foowing: 1. Open the settings page. 2. In the Report Settings section, seect the number of the items you want to be dispayed in Site Administrator reports from the drop-down ist (maximum 200) and cick Set. Action and Poicy Settings Action settings aow you to contro whether users can access management options, security and content poicies from Site Administrator for SharePoint. If you want to hide management options and security and content poicies in Site Administrator, uncheck the Show action buttons in Site Administrator reports box. Fie Fiter Settings Fie fiter settings aows you to specify the fie types to be dispayed in the Documents and Pages, Usage, Site Metrics and Enterprise reports. Use a semicoon (;) to separate fie extensions. NOTE: Note that fiter settings are not appied to CSV version of the report. Therefore, it wi contain unfitered data. If you want to ro back fiter settings, cick the Set Defaut button. License Site Administrator for SharePoint is instaed with the Try Me icense vaid for 30 days. To update the icense, cick Browse, seect the path where the new icense fie is ocated, and then cick Upoad. NOTE: Ony Information Porta Administrators are aowed to upoad a new icense. How It Works The Information Porta workabiity is based on the foowing components: Agent service Broker service Information Porta front-end Agent and Broker Web Services These services reagreeya SharePoint configuration and content databases for information about a server farm. The AgreeYa SharePoint Broker service searches AgreeYa Soutions repository database for the registered agents and reagreeyas information about the existing SharePoint structure from them. The Agent and Broker services are buit on CherryPy web server. Working with Site Administrator for SharePoint 68

69 NOTE: Mutipe agents instaed on the farms aow you to distribute the oad over the network more efficienty. However, if one agent depoyment is used, the agent sti coects information on the structure of the farms discovered by Management Consoe or Site Administrator for SharePoint. Each agent can have different sets of permissions. If the enterprise instaation incudes severa farms and no account has administrator rights on a of them, separate administrative accounts can be used for each farm assigned to the corresponding agent. Information Porta Front-End Information Porta Front-End is a user interface used to access Information Porta web services. It is buit on the highy customizabe Django web server and uses tempates. For integrated NTLM authentication, the Apache service is used as an entry point to the Django web server. Information Porta uses a sef-contained Apache web server instance that does not interfere with IIS in any way. Apache web service is designed to be used by individua appications, so you can have mutipe Apache instances running on the same box together with other web servers such as IIS with no conficts. You just need to make sure each IP + port number combination is ony used by one web server. Information Porta setup takes care of this: it generates a random port number and verifies it is not in use by IIS aready to avoid any possibe confict. Coecting and Showing Report Data As soon as you open report, the process is initiated on the Information Porta server side to coect the data for the reagreeyaed report from the SharePoint content database. This process is not ong and resource-intensive as it reagreeyas ony the data needed for this particuar report. After the process is finished (expected time is from severa seconds to severa minutes), the page wi be refreshed with the information coected. The report data is cached on the Information Porta web server to [ProductInstaPath]\SharePoint Information Porta\Appication\database\mode.db fie. The cache aows dispaying the report immediatey when opening it next time. There is no heavyweight data gathering job. Information Porta works with the SharePoint production using ony SQL queries to the configuration and content databases. Coecting Grid Report Data Site Administrator data gathering is a mechanism to export SharePoint data to SQL tabes in the Site Administrator repository. When gathering data for grid reports SQL queries span each SharePoint content database, web appication, site and site coection and retrieve a 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 schedued to run every night at 3 AM. This scheduing takes into account that the SharePoint Usage Data job usuay runs from 1 AM to 3 AM, and therefore the atest SharePoint usage information is gathered by Site Administrator. It takes about 6 hours for SharePoint environments with 6 miion documents to compete data gathering. For bigger SharePoint environments the data gathering process wi take more time. Working with Site Administrator for SharePoint 69

70 The data gathering process is initiated by the SASP_Data_Gathering_Grid_Reports_task schedued task. Using Windows Task Scheduer you can easiy reconfigure the defaut scheduing to start earier and compete data gathering before working hours. Working with Site Administrator for SharePoint 70

71 Site Administrator for SharePoint Security Exporer Security Exporer for SharePoint is a feature of AgreeYa Soutions Site Administrator for SharePoint that searches for and modifies security on SharePoint servers. Security Exporer's graphica interface increases administrator productivity and provides centraized contro, simpifying and standardizing the management of the security resources. Comprehensive backup, restore, search, grant, cone and export functions take management of permissions to new eves. Tasks that were previousy either impossibe or extremey difficut are now as simpe as Point, Cick, Done! NOTE: Security Exporer works with SharePoint 2007, SharePoint 2010 and SharePoint With Security Exporer you can: Manage Permissions Instant Access to Security and Permissions - No more navigating through fies, foders and registry keys seecting Properties and trying to find the Advanced button to see a compete security ist! Security Exporer's interface aows for easy navigation of SharePoint servers, and instanty shows both assigned and inherited permissions. Comprehensive Security Management - Security Exporer ists the current security settings, and aows fu granting, modifying as we as coning permissions on SharePoint servers. Search Finding security weaknesses and over-privieged users as Security Exporer ets administrators search SharePoint Servers for specific assignments to a types of user and group, incuding permissions received through inheritance, or where a user or group does not have a specific permission. Manage Security Backup and Restore Permissions - Recovery from accidenta changes to security settings has never been easier! Security Exporer can backup compete sets of permissions for fies and foders, without having to backup the data they contain. Administrators can then seect any combination of fies and foders to recover those permissions, without affecting the underying data or resources. Export Security Settings in Mutipe Formats - Security Exporer can export a database or spreadsheet isting the permissions on fies or foders anywhere in the directory tree. To run Security Exporer, seect Start Programs AgreeYa Soutions Site Administrator for SharePoint Security Exporer. Managing Objects AgreeYa Soutions Site Administrator for SharePoint - Security Exporer aows you to: Site Administrator for SharePoint Security Exporer 71

72 Manage your SharePoint Manage SharePoint Permissions Manage Favorites Managing Your SharePoint To use AgreeYa Soutions Site Administrator for SharePoint - Security Exporer's functionaity you need to insta SharePoint Web Service on your target server. You can then perform the foowing: Modify SharePoint authentication Manage SharePoint groups Modify SharePoint properties Preview SharePoint objects Working with SharePoint Web Service To access the security for a seected SharePoint site, you must insta the Web Service on the target server. The first time you seect a SharePoint server in the Navigation pane, you are prompted to insta a web service. To insta the service, perform the foowing: 1. Seect a SharePoint server in the Navigation pane. 2. The SharePoint Web Service Instaation box dispays the name of the seected server in the Server Name box. Figure 26: SharePoint Web Service 1. Cick Insta. The Remote Setup box dispays the instaation progress. 2. Cick Cose. Site Administrator for SharePoint Security Exporer 72

73 To remove the SharePoint Web Service, right-cick the SharePoint server in the Navigation pane, and then choose Remove SharePoint Web Service. Modifying SharePoint Authentication If SharePoint Authentication fais, the SharePoint Authentication box dispays an error message, and provides the opportunity to view the detais of the error, to change and save credentias, and to edit the base URL. To edit the base URL, perform the foowing: 1. Cick Edit URL. The base URL dispays at the top of the box. 2. In the box, type text to add to the end of the URL that dispays. To view the new URL, cick Preview. NOTE: The foowing options are avaiabe: Connect securey (using https) - Seect this option to use https in the URL instead of http. Incude port number - Seect this option to incude the port number in the URL. To change the port, cick Change Port, type the port number, and then cick OK. Managing SharePoint Groups Seect a group in the Permissions pane, and then cick. The SharePoint Groups box dispays the currenty seected group name, description, the owner, and members. You aso can seect a group from the drop-down ist, or cick Tabe 2: Manage SharePoint Groups Options to ocate a SharePoint group. Button New Group Deete Group New Member Deete Member Description Create a new SharePoint group. Deete the dispayed SharePoint group. Add a new member to the dispayed SharePoint group. Deete a member from the dispayed SharePoint group. Modifying SharePoint Properties To modify SharePoint properties, perform the foowing: 1. Seect a SharePoint server in the Navigation pane. The items for the SharePoint server dispay in the Objects pane. 2. Seect an item in the Objects pane, and then cick Aternativey, choose Properties from the Toos menu, or right-cick the item, and then choose Properties from the shortcut menu. The Properties window for the seected item appears. Previewing SharePoint Objects For SharePoint sites/webs and ists, you can dispay a web browser in pace of the Objects pane. Site Administrator for SharePoint Security Exporer 73

74 Perform the foowing: 1. Seect a SharePoint site/web or ist in the Navigation pane. 2. Cick The Objects pane is repaced by a web browser and the SharePoint page for the seected object dispays. To hide the preview and redispay the Objects pane, cick the Preview icon again. Managing SharePoint Permissions AgreeYa Soutions Site Administrator for SharePoint - Security Exporer aows you to manage your SharePoint permissions in the foowing ways: view permissions grant permissions cone permissions modify permissions modify permission eves deete permissions backup permissions restore permissions export permissions Viewing SharePoint Permissions There are three ways to seect a SharePoint server. NOTE: The first time you seect a SharePoint server, you are prompted to insta the SharePoint Web Services. See the *Working with SharePoint Web Service* section. NOTE: If the Aways open authentication diaog check box is seected on the SharePoint tab of the Options diaog box, the SharePoint Authentication box appears. Enter the necessary credentias, and then cick OK. Expand Network Neighborhood in the Navigation pane to view a ist of a sites for a seected server, incuding the Centra Administration site. Type a URL in the Path fied, and then cick Set. A new root node is created in the Navigation pane. Type a URL in the Path fied, and then cick Go. The site is added automaticay to the Favorites ist. NOTE: Ony root SharePoint sites can be added to the Favorites ist. If you want to dispay subsites, ists, or other items, use one of the other two methods. The Objects pane dispays the sites, subsites, ists, and items, such as documents, caendar items, and events, for the seected server. Seect an object to view its permissions in the Permissions pane. Site Administrator for SharePoint Security Exporer 74

75 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 seect a user or group. You can grant different permissions for severa users and groups with one operation. To grant permissions, perform the foowing steps: 1. Seect an item in the Navigation pane. Aternativey, type a path in the Path box, and then cick Go. NOTE: Typing a URL in the Path box, and then cicking Go, adds the URL to the Favorites ist. 2. Seect an object in the Objects pane or a permission in the Permissions pane, and then cick or. Aternativey, choose Grant Permissions from the Security menu, or right-cick the object or permission, and then choose Grant Permissions from the shortcut menu. The Grant SharePoint Permissions diaog box dispays the path, and the associated groups and users for the current object. 3. Seect the groups and users to appy the permission. There are a variety of ways to seect groups and users. To seect a group or user, you can choose from the Groups and Users ist in the eft pane, or from the ist in the right pane. The seected group or user dispays in the Group/User box and the currenty appied permission dispays in the Permission box. NOTE: If you want to appy the same permission to severa groups and users, seect the permission settings first, and then doube-cick the groups and users in the eft pane. The groups and users are added to the List of users and groups to grant ist with the seected permission settings. NOTE: During oading the Reoad button becomes a Stop button. If oading is taking too ong, you can cick Stop. You can show or hide the Stop button on the View menu. NOTE: To fiter the ist in the eft pane, you can type a server name or base path in the box, and then cick Set. To return the fu ist to view, cick Reset. The ist returns to fu view the next time you open Grant Permissions. To change to another domain or to the oca computer, seect the domain or the oca computer from the List Names From ist. To dispay users in the ist, cick Show Users. To return the ist to show ony groups, cick Refresh. To add a group or user not incuded in the current Names ist, cick Advanced User Seection. To seect a group/user who is not dispayed, type a name or cick Advanced User Seection. 4. From the Permission ist, seect the permissions to grant. The options are: Fu Contro Design Manage Hierarchy Site Administrator for SharePoint Security Exporer 75

76 Approve Contribute Read View Ony Limited Access 5. From the Action ist, seect whether to repace or add to the group/user's current permissions. 6. To add the group/user to the List of users and groups to grant ist, cick Add. The seection is added to the ist. Figure 27: Granting Permissions NOTE: To add a seected group or user automaticay to the List of users and groups to grant ist with the seected permission settings, you can hod down CTRL or SHIFT, and then cick a group or user in the top pane; or doube-cick a group or user in the eft pane. To remove a seected user or group from the ist, cick Remove. NOTE: Ony users and groups in the List of users and groups to grant ist are affected by the grant action. You can sort each coumn by cicking the coumn heading. To remove a seected user or group from the ist, cick Remove. 7. Cick OK. The Granting Permissions box dispays the progress. Site Administrator for SharePoint Security Exporer 76

77 Coning Permissions The Cone feature aows you to copy individua permissions. To cone an existing permission, perform the foowing: 1. Seect an object in the Objects pane or a permission in the Permissions pane, and then cick or. Aternativey, choose Cone Permissions from the Security menu, or right-cick the object, and then choose Cone Permissions. The Cone SharePoint Permissions diaog box opens to the Manua User/Group Seection tab and dispays the path to the seected object and the associated groups and users. 2. In the Source Group or User area, seect the domain or object from which to pu the permissions. The defaut is the current object, whose path dispays in the top box. In the Destination Group or User area, seect the domain or object to receive the coned permissions. The defaut is the current object, whose path dispays in the top box. 3. Cick Add. The seected pair dispays in the List of users and groups to cone ist. Figure 28: Coning Permissions NOTE: The foowing options are avaiabe: Site Administrator for SharePoint Security Exporer 77

78 Repace source permissions with destination permissions - Seect this option to change the source permissions to match the destination permissions. Incude protected foders and fies when coning (fies and foders with 'Inherit Permissions from Parent' disabed) - Seect this option to incude those fies and foders for which the Aow inheritabe permissions from parent to propagate to this object check box is unavaiabe. NOTE: Ony users and groups in the List of users and groups to cone ist are affected by the cone action. You can sort each coumn by cicking the coumn heading. 4. Cick OK. The Coning Permissions box dispays the progress. Modifying Permissions You can modify the permissions of a group or user on the seected foder or fie. Use for quick changes to someone who is aready in the ist. Use the Grant feature to give permissions to accounts that are not in the permissions ist aready. NOTE: You cannot modify inherited permissions directy. Inherited permissions are indicated by permissions in the Type coumn. To modify these permissions, you must modify the parent object. To modify permissions, perform the foowing steps: 1. In the Permissions pane, seect a permission, and then cick or. Aternativey, you can right-cick the permission, and then choose Modify Permissions; or choose Modify Permissions from the Security menu. The SharePoint Permission diaog box dispays the current permission settings. 2. From the Permissions ist, seect the permission. Permissions in bod cannot be modified. Site Administrator for SharePoint Security Exporer 78

79 Figure 29: Modifying Permissions NOTE: To modify the permission eves, cick Permissions Leves. 3. Cick OK. Modifying SharePoint Permissions Leves 1. In the Objects pane, seect a SharePoint object, and then cick. The SharePoint Permission Leves diaog dispays the seected object, its owner, and the current permissions. Figure 30: SharePoint Permissions Leves Button New Deete Seect A Cear A Description Create a new Permission Leve Deete seected Permissions Leves Seect a dispayed check boxes Cear a the dispayed check boxes Site Administrator for SharePoint Security Exporer 79

80 Deeting Permissions NOTE: You cannot deete inherited permissions, which are indicated by permissions in the Type coumn of the Permissions pane. Navigate up the directory tree to ocate the parent, and then continue with the deete process. To deete permissions, perform the foowing: 1. In the Permissions pane, seect the permission(s), and then cick or. Aternativey, you can right-cick the seected permission(s), and then choose Deete Permission; or choose Deete Permission from the Security menu. NOTE: If a permission is not seected when you cick or deete button, the currenty seected object (foders, fies, registry keys, or services) is deeted. A warning box appears. NOTE: Seecting the Force deetion down entire tree (incuding protected objects) option aows you to deete the seected permission(s) down the directory tree even if a fie or foder is protected. 2. To deete the permission(s), cick Yes. Backing Up Permissions Before modifying any security permissions, make a backup in case you need to restore the permissions to their origina state. You aso can back up permissions on fies for which you don't have access. As ong as you are an administrator, or have the Backup fies and directories user right, you can back up and restore permissions on a fies, which is hepfu when backing up and restoring a user's home directories. You can backup your permissions manuay, or use a backup scheduer to run the backup at a set time. Perform the foowing steps to backup manuay: 1. From the Navigation or Object pane, seect an object to back up, and then cick. Aternativey, seect Backup Security from the Security menu, or right-cick an object, and then seect Backup Security. NOTE: Acceptabe objects are voumes, foders, or shares. Fies cannot be backed up individuay, but can be backed up within the parent foder. The Backup Security diaog box appears with the seected objects dispayed in the Path ist box. 2. In the Backup Fie Name box, cick to ocate a path and name the backup fie (Security Exporer SharePoint Backup Fie has the *.spb extension). 3. To back up the seected paths, cick Backup Security. The Backing Up Permissions box dispays the progress. Perform the foowing steps to schedue a backup: 1. From the Backup Security diaog box, use the Backup Scheduer section and type a name for the job in the Job Name box, and then cick Schedue. 2. The Schedue a Backup box opens. If the backup paths are oca, Create singe schedued task on oca machine is seected. The Job Name, Widcard, and Backup Name carry over from the previous screen. Site Administrator for SharePoint Security Exporer 80

81 3. In the Account box, cick dots to ocate an account under which to run the backup. If you do not enter an account, the backup runs under the oca system account. 4. To schedue the task, cick Schedue. The task is assigned the defaut run time of Weeky, every Monday at midnight. NOTE: To change the run time, edit the backup using the Backup Scheduer. Errors that occur during the task are captured in the Windows Event Log. Using the Backup Scheduer The Backup Scheduer provides a convenient pace in which to create, edit, and deete backup jobs. 1. Cick. Aternativey, seect Backup Scheduer from the Security menu, or right-cick an object, and then seect Backup Scheduer from the shortcut menu. The Backup Scheduer Task List box ists the currenty defined backup jobs in ascending aphabetica order by computer name. 2. To sort the coumns, cick the coumn heading once for ascending order and again for descending order. 3. To create a new backup job, cick New. The Backup Security diaog box opens where you can create a new backup job. 4. To edit a seected backup job, cick Edit. The Backup Security diaog box opens where you can make changes to the backup job 5. To deete a seected backup job, cick Deete. A warning message appears. To continue with the deetion, cick Yes. Restoring Permissions You can restore your permissions from a backup fie created by using the Backup function. You can restore some or a of the backup fies. Prior to initiating the restore process, you can verify the permissions against the current permissions. To restore security, perform the foowing: 1. Cick. Aternativey, choose Restore Security from the Security menu, or right-cick an object, and then choose Restore Security from the shortcut menu. 2. In the Backup Fie Name box, type the fu path and name for the backup fie, or cick Load to ocate a backup fie. The contents of the backup fie dispay in the eft pane. 3. Expand the backup fie and examine the contents. You can choose specific objects to restore by seecting the box next to the object. 4. Cick Restore. The Restoring Permissions box dispays the progress. Exporting Permissions To export SharePoint permissions, perform the foowing: 1. Seect the type of group or user in the Navigation pane, or seect a singe group or user in the Objects pane, and then cick. Site Administrator for SharePoint Security Exporer 81

82 Aternativey, right-cick 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 dispays the seected type of group or user. By defaut, the Save to Microsoft Exce(R) Spreadsheet radio box is checked. Group and user information can be saved ony to a deimited fie for use with Microsoft Exce. Seect either Comma-deimited fie (.CSV) or Tab-deimited fie (.TXT). 2. Cick to ocate a destination for the fie. 3. To export the data in the specified format, cick OK. Managing Favorites You can add frequenty-accessed sites (prefixed with or and computers (prefixed with \) to a ist of favorites. You can add an object to the Favorites ist as you are browsing, or, if you know what objects you want in your Favorites ist, you can use the Manage Favorites function to add them a at once. Simiary, you can remove Favorites one at a time or in batches. Removing an object from the Favorites ist does not remove the object from the system. Adding Favorites Whie Browsing Whie you are browsing, you can add objects quicky to the Favorites ist: 1. Seect the object, and then cick. Aternativey, choose Add to Favorites from the Toos menu, or right-cick an object, and then choose Add to Favorites from the shortcut menu. The Add to Favorites box opens showing the seected path in the New Favorites ist. To add additiona paths to the New Favorites ist, cick Browse, and then seect a path; or type a path in the Path box, and then cick Add. To remove a seected path from the New Favorites ist, cick De. To remove a paths from the New Favorites ist, cick Cear. Site Administrator for SharePoint Security Exporer 82

83 Figure 31: Adding Favorites Adding Favorites You can add Favorites using the Manage Favorites option: 1. Cick or choose Manage Favorites from the Toos menu. The Manage Favorites (A types) box ists the objects in the Favorites ist. 2. Cick 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 cicking Add. Repeat as many times as necessary. To add mutipe objects whie browsing, cick Browse. The Add (A Types) box appears. Seect the objects, and then cick OK. To remove a seected path from the New Favorites ist, cick De. To remove a paths from the New Favorites ist, cick Cear. 4. Cick OK. The object[s] appears under the Favorites heading in the Navigation pane. Removing Favorites NOTE: Removing an object from the Favorites ist does not deete the object from the system. To remove an object from the Favorites, perform one of the foowing: Site Administrator for SharePoint Security Exporer 83

84 Right-cick the object in the Navigation pane, and then choose Remove from Favorites from the shortcut menu. Cick or choose Manage Favorites from the Toos menu. The Manage Favorites (A types) box ists the objects in the Favorites ist. Seect the object, and then cick Remove. A warning message wi appear. To remove the object, cick Yes. Managing Enterprise Scope An Enterprise Scope is grouping of sites, simiar to a foder that contains mutipe fies, on which you can manipuate permissions. Use Enterprise Scopes to organize sites into ogica groups so that you can more easiy 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 seect an object and add it to an Enterprise Scope. You aso can create Enterprise Scopes through the Manage Enterprise Scopes feature, which is an efficient method for creating mutipe scopes in an organized manner. Creating an Enterprise Scope Whie Browsing When you are navigating through the Navigation and Object panes, you can create an Enterprise Scope quicky by seecting an object and then adding it to a scope. 1. Seect a site in the Navigation or Objects pane, and then cick. Aternativey, choose Add to Enterprise Scope from the Toos menu, or right-cick a site object, and then choose Add to Enterprise Scope. The Enterprise Scope box dispays the path to the seected site in the Paths box. Seect one of the foowing options: 2. Cick OK. Add to existing Enterprise Scope - Seect to add the URL dispayed in the Paths box to an existing Enterprise Scope, and then seect an Enterprise Scope from the Name ist. Avaiabe ony if at east one Enterprise Scope exists. Create and add to existing Enterprise Scope - Seect to create a new Enterprise Scope for the URL dispayed in the Paths box, and then type a name for the scope in the Name box. Edit contents of enterprise scope - Seect to open the Manage Enterprise Scope diaog box where you can edit or remove URLs from the Enterprise scope. If you did not seect the Edit contents of enterprise scope check box, the scope appears under Enterprise Scope in the Navigation pane. If you seected 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 severa Enterprise Scopes to define, creating the scopes through the Manage Enterprise Scope feature is efficient. Site Administrator for SharePoint Security Exporer 84

85 1. Cick. Aternativey, choose Manage Enterprise Scope from the Toos menu. The Manage Enterprise Scope diaog box ists the existing Enterprise Scopes for the seected modue. 2. Cick New. The Create Enterprise Scope box opens. 3. In the Name box, type a name for the Enterprise Scope, and then cick OK. The Enterprise Scope is isted in the Manage Enterprise Scope box. 4. Seect the Enterprise Scope, and then cick Edit. The Edit Enterprise Scope ist box appears. 5. To add a URL, cick Browse, and then seect a URL; or type a URL in the Path box, and then cick Add. Repeat as many times as necessary. 6. Cick OK. Editing an Enterprise Scope 1. Cick. Aternativey, choose Manage Enterprise Scope from the Toos menu. 2. Seect an Enterprise Scope, and then cick Edit. The Edit Enterprise Scope box dispays the paths currenty assigned to the seected Enterprise Scope. 3. To add a URL, cick Browse, and then seect a URL; or type a URL in the Path box, and then cick Add. 4. To remove a seected URL from the Name ist, cick De. 5. To remove a paths from the Name ist, cick Cear. 6. When you are finished editing, cick OK to appy the changes. Removing an Enterprise Scope 1. Cick. Aternativey, choose Manage Enterprise Scope from the Toos menu. 2. Seect the Enterprise Scope[s] to remove, and then cick Remove. A confirmation message appears. To remove the seected Enterprise Scope[s], cick Yes. Searching For Permissions Searching is a very powerfu too to anayze your user's permissions and cose hard-to-find security hoes. Simpy choose a group or user, and a set of permissions to search for, and begin your search. When the search resuts dispay, you can cick on any fies or directories in your search resuts to modify their permissions immediatey. 1. In the Navigation pane, open the Search tab. Aternativey, you coud open a new Search window by choosing Add Search Scope from the Search menu. 2. Seect a Search Scope. For more information pease refer to Adding a Search Scope. Adding a Search Scope Whie Browsing Whie you are browsing in the Navigation or Objects pane, you can seect a path, and then add it automaticay to a Search Scope. Site Administrator for SharePoint Security Exporer 85

86 NOTE: If you want to create a more compex Search Scope with mutipe paths, use the Add Search Scope function. To add an object to a Search Scope, right cick an object in the Navigation or Objects pane, and then choose Search in a New Window from the shortcut menu. The seected object is added automaticay to a Search Scope. Adding a Search Scope Use this process when you want to create compex Search Scopes that may have mutipe paths. NOTE: You can quicky add a singe path to a Search Scope whie you are browsing in the Navigation and Objects pane. Perform the foowing steps: 1. In the Navigation pane, open the Search tab. Aternativey, you coud open a new Search window by choosing New Search Window from the Search menu. 2. Cick Add Search Scope. The Add Search Scope box appears. 3. Seect from the tree, or type a ocation in the box. If you enter a ocation, you must seect a type: Domain, Computer, AD Forest, AD OU. Figure 32: Adding Search Scope 4. Cick OK. The scope dispays in the Search tab. Site Administrator for SharePoint Security Exporer 86

87 Searching for SharePoint Objects To search for SharePoint objects, compete the foowing steps: 1. In the Navigation pane, open the Search tab. Aternativey, you can open a new Search window by choosing New Search Window from the Search menu. 2. Seect a Search Scope. 3. Type a group or user name in the Group/User box, or cick or Advanced User Seection to browse for a group or user. The seected group or user dispays in the Group/User box. Figure 33: Group/User Search Criteria Setting Permission Search Criteria By defaut, inherited and expicit permissions are incuded in the search. 1. From the Search diaog box, open the Permission Search Criteria tab. 2. Choose what permissions to search. Figure 34: Permission Search Criteria Site Administrator for SharePoint Security Exporer 87

88 NOTE: The foowing options are avaiabe: Inherited Permissions - Seect this option to incude inherited permissions in the search resuts. Inherited permissions are indicated by (I) in the Type coumn. Expicit Permissions - Seect this option to incude expicit permissions in the search resuts. Setting SharePoint Search Criteria By defaut, a search incudes site, ist, and item permissions for a contents. 1. Cick to scro right, if necessary. Open the SharePoint Search Criteria tab. 2. Choose whether to search sites, ists, and/or item permissions. You can choose to recurse across a contents or to a specific depth. Figure 35: SharePoint Search Criteria NOTE: The foowing options are avaiabe: Search for site permissions - By defaut, site permissions are incuded in the search. To remove site permissions from the search, cear the check box. Search for ist permissions - By defaut, ist permissions are incuded in the search. To remove ist permissions from the search, cear the check box. Search for item permissions - By defaut, item permissions are incuded in the search. To remove item permissions from the search, cear the check box. Recurse a contents - By defaut, a contents are incuded in the search resuts. Recurse to Depth - Seect this radio button to incude contents to the depth specified in the box. The defaut depth is 1, which is one eve beow the seected object. Starting the Search Now that you defined the search scope and criteria, you can start the search. To start the search, cick Start Search. The resuts wi be dispayed in the Search Resuts area. The status bar dispays the number of objects searched and permissions/services/tasks found. Site Administrator for SharePoint Security Exporer 88

89 NOTE: To stop the search, cick Stop. To cear the resuts, cick Cear Resuts. Within the Search Resuts area when searching for permissions, you can use the buttons aong the bottom, the toobar icons, or the menus to grant, revoke, cone, modify, deete, or print the permissions. NOTE: The Automaticay update resuts option aows you to automaticay update the search resuts after you seect to grant, revoke, cone, repace, modify, or deete a permission. Saving Search Resuts You can save the resuts of a search to a Security Exporer Search Resuts (*.txt) fie. The search criteria and scope are not saved. To save search criteria and scope, see Saving Search Criteria. To save search resuts, perform the foowing steps: 1. Right-cick in the Search Resuts area, and then choose Save Search Resuts from the shortcut menu. 2. In the Save As box, ocate a foder, type a name for the fie, and then cick Save. You can open the Security Exporer Search Resuts (*.txt) fie in any word processing appication. Saving Search Criteria You can save search criteria and scope for use at a ater time. The actua search resuts are not saved. To save search resuts, see Saving Search Resuts. To save search criteria, perform the foowing steps: 1. After defining the search criteria and search scope, cick Save. The Save Search box appears. 2. In the Name box, type a name for the search. In the Description box, type an optiona description which may be hepfu if you have mutipe user searches. 3. Cick OK. The search appears under User Searches in the Saved Searches area. Customizing Security Exporer You can use the foowing to customize Security Exporer: Genera options Advanced options SharePoint options Setting Genera Options To set Genera options, seect Options from the Toos menu, or cick. The Options diaog box opens to the Genera tab. Seect the options you want and cick OK. In the Reoad at Startup area the foowing options are avaiabe: Window state (size and view menu entries) - Seect this option to restore the size of the Security Exporer window and view the menu entries. Cear to use the standard size and center the Security Site Administrator for SharePoint Security Exporer 89

90 Exporer window on your dispay (defaut). In the Modifying Permissions area the foowing options are avaiabe: Aways dispay progress diaog Dispay progress diaog for ong operations ony Never dispay progress diaog Seect one of these options to manage the dispay of the progress diaog when you modify permissions Choosing to dispay the progress diaog for ong operations ony (defaut) or to never dispay the progress diaog may hep with memory management. Auto-cose progress diaog on competion - Seect this option to aways cose the progress diaog box upon competion of a process, such as granting or coning. Perform an inheritance check after creating new foders - Seect this option to aways perform an inheritance check and repair after creating new foders, seect the. In the Logging area the foowing options are avaiabe: Log a security changes - Seect this option to og a permission changes to the seected root path dispayed in the Foder box. Cick to ocate the root foder. Ony information about the seected root path is ogged; no information about changes to sub-items is ogged. Show detaied error messages - Seect this option to show detai for error messages in the og fie. Setting Advanced Options To set Advanced options, seect Options from the Toos menu, or cick. The Options diaog box opens to the Genera tab. Go to the Advanced tab, seect the options you want and cick OK. In the Domains and Computers area the foowing options are avaiabe: Load domain computers, groups and users using Active Directory - By defaut, Security Exporer oads domain computers, groups and users using Active Directory. Incude unknown computers when browsing/searching domains - Seect this option to incude unknown computers in the Navigation pane. Highight domain controers when browsing domains - Seect this option to dispay domain controer next to domain controers. Highight workstations and servers when browsing domains - By defaut, the servers are identified by next to the server name, and workstations are identified by next to the workstation name. If you cear the Highight workstations and servers when browsing domains check box, both servers and workstations are identified by. Auto-detect computers which are members of a custer - Seect this option to automaticay seect the Show Custer Fie Shares check box when browsing computers that are members of a custer. If seected, a warning message dispays when you cick OK. Cick Yes to verify the seection. Check connection before oading (Ping) - Seect this option to ping computers before oading. If a computer is unavaiabe, a warning message appears. The defaut time-out is set to 1,500 ms. By defaut, Security Exporer does not check the connection, which coud cause a response deay if that computer is unavaiabe. In the Cache Options (Browsing) area the foowing options are avaiabe: Site Administrator for SharePoint Security Exporer 90

91 Use cache when browsing - By defaut, 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. Cear the Use cache when browsing check box to aways reoad information from the disk. Do not use cached entries oder than - By defaut, the age of the cache entry is examined prior to oading a path. By defaut, entries oder than 3 hours are reoaded from the disk. You can set the vaue 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 oaded from the cache or disk. If the age of the cache entry is ess (younger) than the vaue set in the Period (hours) box, the entry is reoaded from the cache. If the age of the cache entry is greater (oder) than the vaue set in the Period (hours) box, then the cache entry is removed and the entry is reoaded from disk. To oad the contents of c:\windows from the disk regardess of the age of the entry in the cache, cick Reoad. View indicator when items oaded from cache - By defaut, dispays next to items oaded from the cache. CACHE dispays in the status bar. Cear to remove the indicator from dispay. In the Thread Count area, enter a vaue in the type box to modify the number of searches and process operations that wi run concurrenty (by defaut, up to 10 searches and some process operations can run concurrenty). Setting SharePoint Options To set SharePoint options, seect Options from the Toos menu, or cick. The Options diaog box opens to the Genera tab. Go to the SharePoint tab, seect the options you want and cick OK. In the SharePoint Options area the foowing options are avaiabe: Downoad SharePoint Icons when Browsing - By defaut, icons representing each SharePoint object dispaynext to each item. These icons are downoaded automaticay from the SharePoint site. To remove the icons and use simper defaut icons, cear the check box. In the Defaut SharePoint Credentias area the foowing options are avaiabe: Use Windows Authentication - By defaut, Security Exporer uses Windows Authentication when connecting to a SharePoint server. Aways open authentication diaog - Seect this option to dispay the open authentication diaog box when connecting to a SharePoint server. Use aternate credentias ist - Seect this option to use the aternate credentias ist when connecting to a SharePoint server. Security Exporer tries each account in the order they appear in the ist unti an account is found with sufficient privieges. If no account is found, Access Denied is dispayed. To add aternate credentias: 1. In the Account box, type an account name, or cick to seect an account. 2. In the Password and Confirm boxes, type the password. 3. Cick Add. Security Exporer uses the accounts in the order isted in the Aternate Credentias ist. To deete a name from the ist, cick De. Site Administrator for SharePoint Security Exporer 91

92 To cear a names from the ist, cick Cear. To remove a saved and aternate SharePoint credentias, cick Reset A. A message box asks for confirmation. Site Administrator for SharePoint Security Exporer 92

93 Site Administrator for SharePoint REST Site Administrator for SharePoint REST API aows you to programmaticay access and update your SharePoint 2007 and 2010 data with an easy to use JSON API over HTTPS. ReAgreeYa and Response Format The reagreeya and response format for a reagreeyas and responses is a JSON object. REST Resources and URL Structure Urs for a Site Administrator for SharePoint REST API resource have the foowing structure: Here [SERVER] is the Information Porta web access server, [Port] is the port number and resource_name identifies the required resource. For more information on the REST resources, pease refer to REST Resources. REST Resources This section describes every REST resources of the Site Administrator for SharePoint API: GET /farms PUT /farms GET /farms/actua_on GET /servers PUT /servers GET /servers/actua_on GET /sitecoections PUT /sitecoections GET /sitecoections/actua_on GET /sites PUT /sites GET /sites/actua_on Site Administrator for SharePoint REST 93

94 GET /site/common_info PUT /site/common_info GET /site/common_info/actua_on GET /content/site_info PUT /content/site_info GET /content/site_info/actua_on GET /content/ists PUT /content/ists GET /content/ists/actua_on GET /content/docibs PUT /content/docibs GET /content/docibs/actua_on GET /storage_growth PUT /storage_growth GET /storage_growth/actua_on GET /space_distribution PUT /space_distribution GET /space_distribution/actua_on GET /aerts PUT /aerts GET /aerts/actua_on GET /security/counters/unique_perms PUT /security/counters/unique_perms GET /security/counters/unique_perms/actua_on GET /security/counters/ad_objs PUT /security/counters/ad_objs GET /security/counters/ad_objs/actua_on GET /security/counters/open_content PUT /security/counters/open_content GET /security/counters/open_content/actua_on GET /security/counters/sp_groups PUT /security/counters/sp_groups GET /security/counters/sp_groups/actua_on GET /usage PUT /usage GET /usage/actua_on Site Administrator for SharePoint REST 94

95 GET /usage/counters/unused_pages PUT /usage/counters/unused_pages GET /usage/counters/unused_pages/actua_on GET /document/counters/docs_and_pages PUT /document/counters/docs_and_pages GET /document/counters/docs_and_pages/actua_on GET /activity/changes PUT /activity/changes GET /activity/changes/actua_on GET /activity/users/most_active PUT /activity/users/most_active GET /activity/users/most_active/actua_on GET /schedue/report PUT /schedue/report DELETE /schedue/report POST /job/disaow_everyone DELETE /job/disaow_everyone GET /job/disaow_everyone POST /job/propagate_version_settings DELETE /job/propagate_version_settings GET /job/propagate_version_settings POST /job/restore_broken_inheritance DELETE /job/restore_broken_inheritance GET /job/restore_broken_inheritance Site Administrator for SharePoint REST 95

96 GET /farms NOTE: This method is avaiabe ony for Information Porta administrators. Tabe 3: GET /farms Description Query String Returns returns information on farms incuding top biggest web appications and content databases within the enterprise or farm scope. farm=[farm_id], where [FARM_ID] is the farm URL. If this parameter is not specified, you wi get information about a farms within your whoe enterprise scope. imit=[limit], where [LIMIT] is a parameter, which specifies how many records shoud be returned. By defaut, it is set to OK Unauthorized Interna Server Error. Error detais are in response body Exampe: cur --user satestab\\administrator 1 // enterprise cur --user satestab\\administrator 1 Config@SATESTLAB // farm Response body exampe { "actua_on": "08/07/ :06:39 AM", // time when data was cached "estimation_time": 0, // estimated time(in seconds) to update the cache data": { "SitesCount": 30, // tota Sites count for a farms "TLSCount": 10, // tota Site Coections count for a farms "WebAppCount": 2, // tota Web Appications count for a farms "FarmCount": 1, // farms number "Size": , // tota size of the farm content "Farms": [ { "CentrAdminUr": " // SharePoint Centra Administration URL "SQLConfigDB": "SharePoint_Config", // SQL Config database name "Created": "Dec ", // date when the farm was created "SQLHost": "ARTHUR10", // Database Server host name "SPVersion": " ", // SharePoint version Site Administrator for SharePoint REST 96

97 "LastContentChange": "12,08,03,02,44", // date and time when farm content was ast modified "SitesCount": 30, // tota Sites count for the current farm "TLSCount": 10, // tota Site Coections count for the current farm "WebAppCount": 2, // tota Web Appications count for the current farm "ContentDBCount": 3, // tota Content Databases count for the current farm "Size": // tota Content size of the current farm } ], "WebApps": [ { "CentrAdminUr": " // SharePoint Centra Administration URL "TLSCount": 2, // number of site coections in the web appication "FarmHost": "ARTHUR10", // farm host name "Ur": " // web appication URL "SitesCount": 2, // number of sites in web appication "FarmConfigDB": "SharePoint_Config", // config database name of the farm "LastContentChange": "12,06,11,09,18", // date and time when the web appication content was ast modified "Size": // web appication size, in bytes } ], "ContentDBs": [ { "ContentDBName": "WSS_Content_3716", // content database name "PhysicaSize": "31.31 MB", // tota size of a fies in the content database, incuding trasation ogs "webapp": " // web appication URL reated to the Content Database "Size": , // tota size of a fies in the content database, incuding trasation ogs, in bytes "ContentDBServer": "ARTHUR10" // content database server } ], } } Site Administrator for SharePoint REST 97

98 PUT /farms NOTE: This method is avaiabe ony for Information Porta administrators. Tabe 4: Put/farms Description Query String Returns updates information either about a farms or about the specified farm farm=[farm_id], where [FARM_ID] is the farm URL. If this parameter is not specified, you wi get information about a farms within your whoe enterprise scope. imit=[limit], where [LIMIT] is a parameter, which specifies how many records shoud be returned. By defaut, it is set to OK Unauthorized Interna Server Error. Error detais are in response body Exampe: cur --user satestab\\administrator 1 -X PUT // enterprise cur --user satestab\\administrator 1 -X PUT // farm GET /farms/actua_on NOTE: This method is avaiabe ony for Information Porta administrators. Tabe 5: GET /farms/actua_on Description Query String Returns retrieves date and time when farms information was ast updated farm=[farm_id], where [FARM_ID] is the farm URL. imit=[limit], where [LIMIT] is a parameter, which specifies how many records shoud be returned. By defaut, it is set to OK Unauthorized Interna Server Error. Error detais are in response body Exampe: cur --user satestab\\administrator 1 // enterprise cur --user satestab\\administrator 1 on?id=sharepoint_config@satestlab // farm Response body exampe: "05/31/2012 1:01 PM" Site Administrator for SharePoint REST 98

99 GET /servers NOTE: This method is avaiabe ony for Information Porta administrators. Tabe 6: Insert Description Query String Returns returns a ist of farm=[farm_id], where [FARM_ID] is OK. servers the farm URL Unauthorized. Exampe: cur --user satestab\\administrator 1 // enterprise Interna Server Error. Error detais are in response body cur --user satestab\\administrator 1 on?id=sharepoint_config@satestlab // farm The foowing parameters are returned for a servers: ServerName, Roe and Version. The server Roe can be one of the foowing: Front-End, Appication, Database, Search. Each server can have severa roes. The foowing roes shoud be assigned to the server if one of the services is running on that server: Tabe 7: Roes and Services Roe Services Running Appication Access, Business Data Connectivity, Exce Services Appication, Managed Metadata, PerformancePoint Service Appication, Visio Graphics, Web Anaytics, Word Automation, Secure Store, User Profie, Subscription Settings, Lotus Notes Connector, Appication Registry, Document Conversions Launcher, Document Conversions Load Baancer. Front-End Database Search Foundation Web Appication Database Service SharePoint Server Search Service Exampe: cur --ntm --user administrator@veaskec.spb.qsft:1 // enterprise cur --ntm --user administrator@veaskec.spb.qsft:1 // farm Response body exampe: { "estimation_time": 0, // estimated time(seconds) to update the cache "actua_on": "08/07/ :06:39 AM", // time when data was cached "data":{ "ServerServices": [ Site Administrator for SharePoint REST 99

100 { "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.Exce.Server.ExceServerSharedWebServiceInstance", "ServiceStatus": "1"}, {"ServerName": "WSS3FERMSP", "ServiceName": "Microsoft.Office.Server.Search.Administration.SearchServiceInstance", "ServiceStatus": "0"}, {"ServerName": "WSS3FERMSP", "ServiceName": "Microsoft.Office.Exce.Server.ExceServerSharedWebServiceInstance", "ServiceStatus": "0"}, {"ServerName": "WSS3FERMSP", "ServiceName": "Microsoft.SharePoint.Administration.SPAdministrationServiceInstance", "ServiceStatus": "0"} ], "ServersInfo": [ { "Status": "0", // (0 - running, 1 - stopped) "ServerName": "WSS3BE", "Version": " ", // the atest version instaed "ServerRoe": "SQL" // (FrontEnd, Appication, SQL, SingeServer) }, {"Status": "0", "ServerName": "WSS3FE", "Version": " ", "ServerRoe": "Appication"}, {"Status": "0", "ServerName": "WSS3FERMSP", "Version": " ", "ServerRoe": "Appication"} ] }, "errors": [] // ist of errors (if any occur) } Site Administrator for SharePoint REST 100

101 PUT /servers NOTE: This method is avaiabe ony for Information Porta administrators. Tabe 8: PUT /servers Description Query String Returns updates topoogy 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 wi get information for the whoe enterprise scope OK Unauthorized Interna Server Error. Error detais are in response body Exampe: cur --ntm --user administrator@veaskec.spb.qsft:1 -X PUT // enterprise cur --ntm --user administrator@veaskec.spb.qsft:1 -X PUT // farm GET /servers/actua_on NOTE: This method is avaiabe ony for Information Porta administrators. Tabe 9: Get/servers/actua_on Description Query String Returns retrieves date and time id=[farm_id], where [FARM_ID] is the farm URL. If 200- OK. when topoogy information this parameter is not specified, information wii be was ast updated returned for the whoe enterprise 401- Unauthorized. Exampe: cur --ntm --user administrator@veaskec.spb.qsft:1 // enterprise cur --ntm --user administrator@veaskec.spb.qsft: Interna Server Error. Error detais are in response body // farm Response body exampe: "05/31/2012 1:01 PM" Site Administrator for SharePoint REST 101

102 GET /sitecoections NOTE: This method is avaiabe ony for Information Porta administrators. Tabe 10: GET /sitecoections Description Query String Returns returns information on site coections within the enterprise or farm scope farm=[farm_id], where [FARM_ID] is the farm URL in the format. Note that if this parameter is not specified, you wi get information about site coections within your whoe enterprise scope. imit=[limit], where [LIMIT] is a parameter, which specifies how many records shoud be returned. By defaut, it is set to OK Unauthorized Interna Server Error. Error detais are in response body Exampe: cur --ntm --user warrior\\administrator:1 Response body exampe: { "estimation_time": 0, // estimated time (in seconds) to update the cache "actua_on": "08/07/ :06:39 AM", // time when data was cached "data": [ { "tite": "Test Bank123", // site coection tite "quota": 0, // disk quota size, in bytes "size": , // site coection size, in bytes "fuur": " // fu ur of the site coection "database": "WORKSP07@WSS_Content" // content database name with which the site coection is associated },,,, ] "errors": [] // ist of errors (if any occur) } PUT /sitecoections NOTE: This method is avaiabe ony for Information Porta administrators. Site Administrator for SharePoint REST 102

103 Tabe 11: PUT /sitecoections Description Query String Returns updates information about site coections within the enterprise or farm scope farm=[farm_id], where [FARM_ID] is the farm URL in the format. imit=[limit], where [LIMIT] is a parameter, which specifies how many records shoud be returned. By defaut, it is set to OK Unauthorized Interna Server Error. Error detais are in response body Exampe: cur --ntm --user warrior\\administrator:1 -X PUT GET /sitecoections/actua_on NOTE: This method is avaiabe ony for Information Porta administrators. Tabe 12: GET /sitecoections/actua_on Description Query String Returns retrieves date and time when site coections information was ast updated farm=[farm_id], where [FARM_ID] is the farm URL in the configdbname@servername format. imit=[limit], where [LIMIT] is a parameter, which specifies how many records shoud be returned. By defaut, it is set to OK Unauthorized Interna Server Error. Error detais are in response body Exampe: cur --ntm --user warrior\\administrator:1 Response body exampe: "2/18/2012 1:01 PM" GET /sites NOTE: This method is avaiabe ony for Information Porta administrators. Site Administrator for SharePoint REST 103

104 Tabe 13: GET /sites Description Query String Returns returns information on sites within the enterprise or farm scope farm=[farm_id], where [FARM_ID] is the farm URL in the format. Note that if this parameter is not specified, you wi get information about sites within your whoe enterprise scope. imit=[limit], where [LIMIT] is a parameter, which specifies how many records shoud be returned. By defaut, it is set to OK Unauthorized Interna Server Error. Error detais are in response body Exampe: cur --ntm --user warrior\\administrator:1 Response body exampe: { "estimation_time": 0, // estimated time(in seconds) to update the cache "actua_on": "08/07/ :06:39 AM", // time when data was cached "data": [ { "tite": "removeuserfromsite", // site tite "type": "Site", // site type "size": , // site size, in bytes "fuur": " // fu ur of the site "database": "WORKSP07@WSS_Content" // content database name with which the site is associated },,,, ] "errors": [] // ist of errors (if any occur) PUT /sites NOTE: This method is avaiabe ony for Information Porta administrators. Site Administrator for SharePoint REST 104

105 Tabe 14: PUT /sites Description Query String Returns updates information about sites within the enterprise or farm scope farm=[farm_id], where [FARM_ID] is the farm URL in the format. imit=[limit], where [LIMIT] is a parameter, which specifies how many records shoud be returned. By defaut, it is set to OK Unauthorized Interna Server Error. Error detais are in response body Exampe: cur --ntm --user warrior\\administrator:1 -X PUT GET /sites/actua_on NOTE: This method is avaiabe ony for Information Porta administrators. Tabe 15: GET /sites/actua_on Description Query String Returns retrieves date and time when sites information was ast updated farm=[farm_id], where [FARM_ID] is the farm URL in the configdbname@servername format. Note that if this parameter is not specified, you wi get information about sites within your whoe enterprise scope. imit=[limit], where [LIMIT] is a parameter, which specifies how many records shoud be returned. By defaut, it is set to OK Unauthorized Interna Server Error. Error detais are in response body Exampe: cur --ntm --user warrior\\administrator:1 on?farm=sharepoint_config&imit=10 Response body exampe: "2/18/2012 1:01 PM" GET /site/common_info NOTE: This method is avaiabe ony for Information Porta administrators. Site Administrator for SharePoint REST 105

106 Tabe 16: GET /site/common_info Description Query String Returns returns common information on the specified site coection or site ur=[site_url], where [SITE_URL] is the site coection or site URL used to retrieve information OK Unauthorized Interna Server Error. Error detais are in response body Exampe: cur --ntm --user warrior\\administrator:1 info?ur= Response body exampe: { "estimation_time": 0, // estimated time(in seconds) to update the cache "actua_on": "08/07/ :06:39 AM", // time when data was cached "data": { "FirstAdminLogin": "WARRIOR\\administrator", // ogin of the first site coection administrator "Errors": [], // ist of errors "FirstAdminTite": "WARRIOR\\administrator", // tite of the first site coection administrator "Database": "WSS_Content", // content database name with which the site coection/site is associated "diskquota": 0, // diskquota size, in bytes "SqServer": "WORKSP07", // sq sever name "seftite": "Test Bank123", // site tite "CreatorTite": "WARRIOR\\administrator", // site coection/site author tite "SecondAdminLogin": "WARRIOR\\shedon", // ogin of the second site coection administrator "SecondAdminTite": "Shedon", // tite of the second site coection administrator "CreatorLogin": "WARRIOR\\administrator", // site coection/site author ogin "CreatedDate": "09/02/ :34", // time (mm/dd/yyyy HH:MM) when the site coection/site was created "tsur": " // site coection ur with which the site is associated "WebAppUr": " // web appication ur with which the site is associated }, Site Administrator for SharePoint REST 106

107 "errors": [] // ist of errors (if any occur) } NOTE: The foowing parameters are not avaiabe for site owners: "Database", "SqServer" and "tsur". PUT /site/common_info Tabe 17: PUT /site/common_info Description Query String Returns updates information about the specified site coection or site ur=[site_url], where [SITE_URL] is the site coection or site URL used to retrieve information OK Unauthorized Interna Server Error. Error detais are in response body Exampe: cur --ntm --user warrior\\administrator:1 -X PUT GET /site/common_info/actua_on Tabe 18: GET /site/common_info/actua_on Description Query String Returns retrieves date and time when information on the specified site coection or site was ast updated ur=[site_url], where [SITE_URL] is the site coection or site URL used to retrieve information OK Unauthorized Interna Server Error. Error detais are in response body Exampe: cur --ntm --user warrior\\administrator:1 info/actua_on?ur= Response body exampe: "2/18/2012 1:01 PM" Site Administrator for SharePoint REST 107

108 GET /content/site_info Tabe 19: GET /content/site_info Description Query String Returns returns information on the specified site (incuding top sites, site overview, top fies and document extension information) ur=[site_url], where [SITE_ URL] is the site coection or site URL used to retrieve information OK Unauthorized Interna Server Error. Error detais are in response body Exampe: cur --ntm --user warrior\\administrator:1 info?ur= Response body exampe: { "actua_on": "5/23/ :23 PM", // time when data was cached "estimation_time": 23, // estimated time to update the cache "data":{"firstadminlogin": "WARRIOR\\administrator", "Errors": [], "DocumentsCount": 392, "tsur": " "WebAppUr": " "AttachmentsCount": 0, "ADocExtensionsWithSize": [{"Count": 4, "Name": "zip", "Size": },...], "diskquota": , "CreatorTite": "Peter Ng", "ListsCount": 206, "SitesInfo": [{"Ur": " "Type": "Site Coection", "SiteSize": , "Tite": "mysite"},...], "ASiteSize": , "ADocVesrionsCount": 400, "FirstAdminTite": "WARRIOR\administrator", "Database": "WSS_Content", "SubSitesCount": 34, "SqServer": "JIMMYMOSS2010", "SecondAdminLogin": "", Site Administrator for SharePoint REST 108

109 "TopDocsBySize": [{"dir_name": " "eaf_name": "Appication.zip", "d_id": "D FDBE FB1-CEEA52C91421", "w_id": "1256E444- B2C AB4C-FD0A234AAF1A", "RowNum": 1, "size": , "count_ver": 1, "curr_ size": },...], "ListItemsCount": 602, "ADocumentsSize": , "DocLibsCount": 161, "seftite": "mysite", "SecondAdminTite": "", "CreatorLogin": "WARRIOR\peter", "CreatedDate": "10,09,21,09,09"} } PUT /content/site_info Tabe 20: PUT /content/site_info Description Query String Returns updates information ur=[site_url], where [SITE_URL] is the site about the specified coection or site URL used to retrieve information site OK Unauthorized Interna Server Error. Error detais are in response body Exampe: cur --ntm --user warrior\\administrator:1 -X PUT GET /content/site_info/actua_on Tabe 21: GET /content/site_info/actua_on Description Query String Returns retrieves date and time when the tota content size was ast updated ur=[site_url], where [SITE_URL] is the site coection or site URL used to retrieve information OK Unauthorized Interna Server Error. Error detais are in response body Exampe: cur --ntm --user warrior\\administrator:1 info/actua_on?ur= Site Administrator for SharePoint REST 109

110 Response body exampe: "2/18/2012 1:01 PM" GET /content/ists Tabe 22: GET /content/ists Description Query String Returns retrieves information on the argest ists within the specified site coection or site ur=[site_url], where [SITE_URL] is the site coection or site URL used to retrieve information imit=[limit], where [LIMIT] is a parameter, which specifies how many records shoud be returned. By defaut, it is set to OK Unauthorized Interna Server Error. Error detais are in response body Exampe: cur --ntm --user warrior\\administrator:1 Response body exampe: { "actua_on": "5/23/ :23 PM", // time when data was cached "estimation_time": 23, // estimated time(seconds) to update the cache "data": { "totacount": 1995, // tota count of ists in the scope of the given site ur.(system ists are hidden, and hidden ists wi be counted in) "Errors": [], // ist of errors (if any occur) "ists": [ // ist of SharePoint ists { "EditorLogin": "SHAREPOINT\\system", // ogin of the atest editor "AuthorLogin": "SHAREPOINT\\system", // ogin of the ist author "ListSize": , // ist size, in bytes "WebTite": "subsite1", // site tite with which the ist is associated "attachments": 0, // attachments number "Tite": "Shared Documents", // ist tite "Ur": " // ist ur "AuthorDispName": "System Account", // author name "WebUr": " // site ur with which the ist is associated Site Administrator for SharePoint REST 110

111 "Modified": "11,11,14,07,27", // time (yy,mm,dd,hh,mm) when ist items were ast modified "EditorDispName": "System Account", // dispay name of the atest editor "ListId": "F81AC49B-810D-4A42-B934-B19E3974ED94", // ist id "VerCount": 0, // ist versions number, current version wi not be counted in "UniquePerms": 0, // ist unique psermissions number "Fags": , // ist fags "ItemCount": 1, // ist items number "ServerTempate": 101, // server tempates number "Created": "11,11,14,07,27" // time (yy,mm,dd,hh,mm) when the ist was created,,,, } ] } } PUT /content/ists Tabe 23: PUT /content/ists Description Query String Returns updates information on the argest ists within the specified site coection or site ur=[site_url], where [SITE_URL] is the site coection or site URL used to retrieve information imit=[limit], where [LIMIT] is a parameter, which specifies how many records shoud be returned. By defaut, it is set to OK Unauthorized Interna Server Error. Error detais are in response body Exampe: cur --ntm --user warrior\\administrator:1 -X PUT GET /content/ists/actua_on NOTE: This method is avaiabe ony for Information Porta administrators. Site Administrator for SharePoint REST 111

112 Tabe 24: GET /content/ists/actua_on Description Query String Returns retrieves date and time when information on the ists within the specified site was ast updated ur=[site_url], where [SITE_URL] is the site coection or site URL used to retrieve information imit=[limit], where [LIMIT] is a parameter, which specifies how many records shoud be returned. By defaut, it is set to OK Unauthorized Interna Server Error. Error detais are in response body Exampe: cur --ntm --user warrior\\administrator:1 Response body exampe: "2/18/2012 1:01 PM" GET /content/docibs Tabe 25: GET /content/docibs Description Query String Returns retrieves information on the argest document ibraries within the specified site coection or site ur=[site_url], where [SITE_URL] is the site coection or site URL used to retrieve information imit=[limit], where [LIMIT] is a parameter, which specifies how many records shoud be returned. By defaut, it is set to OK Unauthorized Interna Server Error. Error detais are in response body Exampe: cur --ntm --user warrior\\administrator:1 Response body exampe: { "actua_on": "5/23/ :23 PM", // time when data was cached "estimation_time": 23, // estimated time(seconds) to update the cache "data": { Site Administrator for SharePoint REST 112

113 "totacount": 1995, // tota count of ists in the scope of given site ur.(system ists are hidden, and hidden ists wi be counted in) "Errors": [], // ist of errors (if any ocur) "ists": [ // document ibraries ist { "EditorLogin": "SHAREPOINT\\system", // ogin of the atest editor "AuthorLogin": "SHAREPOINT\\system", // ogin of the document ibrary author "ListSize": 51084, // ist size, in bytes "WebTite": "Test Tite of Web", // site tite with which the document ibrary is associated "attachments": 0, // attachments number "Tite": "Shared Documents", // document ibrary tite "Ur": " Documents", // document ibrary ur "AuthorDispName": "System Account", // author name "WebUr": " // site ur with which the document ibrary is associated "Modified": "12,06,04,07,28", // time (yy,mm,dd,hh,mm) when documents in the document ibrary were ast modified "EditorDispName": "System Account", // dispay name of the atest editor "ListId": "61A121DE-445B-47EB-B71A A49B", // document ibrary id "VerCount": 0, // document ibrary versions number, current version wi not be counted in "UniquePerms": 1, // document ibrary unique psermissions number "Fags": , // document ibrary fags "ItemCount": 1, // documents number in the document ibrary "ServerTempate": 101, // server tempate number "Created": "12,06,04,07,28" // time (yy,mm,dd,hh,mm) when the document ibrary was created,,,, } ] } } Site Administrator for SharePoint REST 113

114 PUT /content/docibs Tabe 26: PUT /content/docibs Description Query String Returns updates information on the document ibraries within the specified site coection or site ur=[site_url], where [SITE_URL] is the site coection or site URL used to retrieve information imit=[limit], where [LIMIT] is a parameter, which specifies how many records shoud be returned. By defaut, it is set to OK Unauthorized Interna Server Error. Error detais are in response body Exampe: cur --ntm --user warrior\\administrator:1 -X PUT GET /content/docibs/actua_on Tabe 27: GET /content/docibs/actua_on Description Query String Returns retrieves date and time when information on the documents ibraries within the specified site was ast updated ur=[site_url], where [SITE_ URL] is the site coection or site URL used to retrieve information imit=[limit], where [LIMIT] is a parameter, which specifies how many records shoud be returned. By defaut, it is set to OK Unauthorized Interna Server Error. Error detais are in response body Exampe: cur --ntm --user warrior\\administrator:1 Response body exampe: "2/18/2012 1:01 PM" Site Administrator for SharePoint REST 114

115 GET /storage_growth Tabe 28: GET /storage_growth Description Query String Returns this method returns storage growth trend data for enterprise, farm or site scope depending on the query parameter. Note that site coections administrators and site owners can use this method ony to retrieve data for the site scope farm=[farm_id], where [FARM_ID] is the farm ID for which you want to retrieve storage growth trend data ur=[site_url], where [SITE_URL] is the site coection or site URL used to retrieve storage growth trend data period=[period], where [PERIOD] is the period (in days) for which you want to retrieve storage growth trend data. The defaut vaue is 365. This parameter is required to be specified for a scopes OK Unauthorized Interna Server Error. Error detais are in response body Exampe: cur --user satestab\\administrator 1 growth?period=30 // enterprise cur --user satestab\\administrator 1 growth?farm=sharepoint_config@satestlab&period=30 // farm cur --user satestab\\administrator 1 growth?ur= // site Response body exampe: { "actua_on": "12/28/ :14 PM", // time when data was cached "time_estimation": 80, // estimated time (in seconds) to update the cache "data": [ {"date": " ", // date in the "yyyy.mm.dd" format when the site content size was modified "size": // content size, in bytes }, {"date": " ", "size": }, {"date": " ", "size": } ], "errors": [] } Site Administrator for SharePoint REST 115

116 PUT /storage_growth Tabe 29: PUT /storage_growth Description Query String Returns this method updates storage growth trend data for enterprise, farm or site scope depending on the query parameter. Note that site coections administrators and site owners can use this method ony to retrieve data for the site scope farm=[farm_id], where [FARM_ID] is the farm ID for which you want to update storage growth trend data ur=[site_url], where [SITE_URL] is the site coection or site URL used to update storage growth trend data period=[period], where [PERIOD] is the period (in days) for which you want to update storage growth trend data. The defaut vaue is 365. This parameter is required to be specified for a scopes OK Unauthorized Interna Server Error. Error detais are in response body Exampe: cur -X PUT --user satestab\\administrator 1 growth?period=30 // enterprise cur -X PUT --user satestab\\administrator 1 growth?farm=sharepoint_config@satestlab&period=30 // farm cur -X PUT --user satestab\\administrator 1 growth?ur= // site GET /storage_growth/actua_on Tabe 30: GET /storage_growth/actua_on Description Query String Returns this method retrieves the date and time when storage growth trend data for enterprise, farm or site scope was ast updated farm=[farm_id], where [FARM_ID] is the farm ID for which you want to retrieve data ur=[site_url], where [SITE_URL] is the site coection or site URL used to retrieve data period=[period], where [PERIOD] is the period (in days) for which you want to retrieve data OK Unauthorized Interna Server Error. Error detais are in response body Site Administrator for SharePoint REST 116

117 Exampe: cur --user satestab\\administrator 1 growth/actua_on?period=30 // enterprise cur --user satestab\\administrator 1 growth/actua_on?farm=sharepoint_config@satestlab&period=30 // farm cur --user satestab\\administrator 1 growth/actua_on?ur= // site Response body exampe: "05/31/2012 1:01 PM" GET /space_distribution Tabe 31: GET /space_distribution Description Query String Returns this method returns storage space distribution data for enterprise, farm or site scope depending on the query parameter. Note that site coections administrators and site owners can use this method ony to retrieve data for the site scope farm=[farm_id], OK. where [FARM_ID] is the farm ID for Unauthorized. which you want to retrieve storage space distribution Interna data Server Error. Error detais ur=[site_url], are in where [SITE_URL] response body is the site coection or site URL used to retrieve storage space distribution data Exampe: cur --user satestab\\administrator 1 // enterprise cur --user satestab\\administrator 1 distribution?farm=sharepoint_config@satestlab // farm cur --user satestab\\administrator 1 distribution?ur= // site Response body exampe: { "actua_on": "12/28/ :14 PM", // time when data was cached "time_estimation": 80, // estimated time (in seconds) to update the cache "data":{ "content": , // content size, in bytes Site Administrator for SharePoint REST 117

118 "userrecbin": , // size of the user recyce bin content, in bytes "adminrecbin": 0, // content size of the sharepoint centra administration recyce bin, in bytes "versions": 0 // version size, in bytes }, "errors": [] } PUT /space_distribution Tabe 32: PUT /space_distribution Description Query String Returns this method updates storage space distribution data for enterprise, farm or site scope depending on the query parameter. Note that site coections administrators and site owners can use this method ony to retrieve data for the site scope farm=[farm_id], OK. where [FARM_ID] is the farm ID for which you want to Unauthorized. update storage space distribution Interna data Server Error. ur=[site_url], Error detais are in where [SITE_URL] response body is the site coection or site URL used to update storage space distribution data Exampe: cur -X PUT --user satestab\\administrator 1 distribution //enterprise cur -X PUT --user satestab\\administrator 1 distribution?farm=sharepoint_config@satestlab //farm cur -X PUT --user satestab\\administrator 1 distribution?ur= //site GET /space_distribution/actua_on Tabe 33: GET /space_distribution/actua_on Description Query String Returns this method retrieves the date and time when storage space distribution data for enterprise, farm or site scope was ast updated farm=[farm_id], where OK. [FARM_ID] is the farm ID for which you want to Site Administrator for SharePoint REST 118

119 Description Query String Returns retrieve data ur=[site_url], where [SITE_URL] is the site coection or site URL used to retrieve data Unauthorized Interna Server Error. Error detais are in response body Exampe: cur --user satestab\\administrator 1 distribution/actua_on //enterprise cur --user satestab\\administrator 1 distribution/actua_on?farm=sharepoint_config@satestlab //farm cur --user satestab\\administrator 1 distribution/actua_on?ur= //site Response body exampe: "05/31/2012 1:01 PM" GET /aerts Tabe 34: GET /aerts Description Query String Returns returns a ist of Heath Anayzer aerts farm=[farm_id], where [FARM_ID] is the farm ID for which you want to retrieve data. If this parameter is not specified, you wi get information for a farms within your enterprise OK Unauthorized Interna Server Error. Error detais are in response body Tabe 35: List Aert Attributes Attribute Category Attribute Description Specifies the category for the heath anayzer: System - identifies a probem with the SharePoint Heath Anayzer Security - identifies a probem that coud affect the security of the system Performance - identifies a probem that coud affect how we the system performs Configuration - identifies a probem with SharePoint Foundation configuration Avaiabiity - identifies a probem that coud reduce avaiabiity Site Administrator for SharePoint REST 119

120 Attribute Attribute Description Custom - identifies a probem in a custom category 0 - Rue Execution Faiure 1- Error 2- Warning 3- Information 4- Success AertType Tite The fu type name, e.g. Microsoft.SharePoint.Administration.Heath.ServiceIsNotRunning, Microsoft.SharePoint.Heath, Version= , Cuture=neutra, PubicKeyToken=71e9bce111e9429c The aert tite dispayed in the Centra Administration LastModified The time when the aert has been ast updated Servers Services Expanation Remedy FarmName Either NULL or the string of \r\n-separated servers where aert has occurred The service name that aert has executed. Can be: SPTimerService (SPTimerV4), SPWebService, SPWebService (WSS_Administration), OfficeServerService, SPSecurityTokenService (SecurityTokenService), etc. The description dispayed in the Centra Administration Describes what needs to be done The farm name of the SharePoint_Config@sp14-be type Exampe: cur --ntm --user administrator@veaskec.spb.qsft:1 // enterprise cur --ntm --user administrator@veaskec.spb.qsft:1 // farm Response body exampe: { "estimation_time": 0, "actua_on": "10/04/ :36:04 AM", "data": [ { "ItemId": 39, "Category": "Security", "AertType": "Microsoft.SharePoint.Administration.Heath.FarmAccountIsSharedWithUserServices, Microsoft.SharePoint.Heath, Version= , Cuture=neutra, PubicKeyToken=71e9bce111e9429c", "Severity": "1 - Error", Site Administrator for SharePoint REST 120

121 "Tite": "The server farm account shoud not be used for other services.", "LastModified": " :00:40", "Expanation": "VELASKEC\\SPAdmin, the account used for the SharePoint timer service and the centra administration site, is highy privieged and shoud not be used for any other services on any machines in the server farm. The foowing services were found to use this account: \tsharepoint - 80 (Appication Poo)\r\n\tSharePoint (Appication Poo)\r\n", "Servers": nu, "Remedy": "Browse to and change the account used for the services isted in the expanation. For more information about this rue, see \" "Services": "SPTimerService (SPTimerV4)", "FarmName": "SharePoint_Config@sp14-be" }, { "ItemId": 40, "Category": "Configuration", "AertType": "Microsoft.SharePoint.Administration.Heath.OutgoingEmaiIsNotConfigured, Microsoft.SharePoint.Heath, Version= , Cuture=neutra, PubicKeyToken=71e9bce111e9429c", "Severity": "1 - Error", "Tite": "Outbound e-mai has not been configured.", "LastModified": " :00:40", "Expanation": "A defaut SMTP server has not been configured. One or more web appications do not have SMTP servers configured. Because of this, features such as aerts wi not function propery.", "Servers": nu, "Remedy": "Configure an outgoing e-mai server from the centra administration site or execute the foowing command: C:\\Program Fies\\Common Fies\\Microsoft Shared\\Web Server Extensions\\14\\bin\\stsadm.exe-o emai -outsmtpserver <SMTP server> - fromaddress <someone@exampe.com> -repytoaddress <someone@exampe.com> - codepage <codepage> For more information about this rue, see \" "Services": "SPTimerService (SPTimerV4)" "FarmName": "SharePoint_Config@sp14-be" }, { "ItemId": 7, "Category": "Avaiabiity", "AertType": "Microsoft.SharePoint.Administration.Heath.ServiceIsNotRunning, Microsoft.SharePoint.Heath, Version= , Cuture=neutra, PubicKeyToken=71e9bce111e9429c", Site Administrator for SharePoint REST 121

122 "Severity": "1 - Error", "Tite": "One or more services have started or stopped unexpectedy.", "LastModified": " :00:02", "Expanation": "The foowing 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 wi be unabe to correcty distribute work to the service.", "Servers": "SP \r\n", "Remedy": "To stop or start a service managed by SharePoint, use the SharePoint service management interface in the SharePoint Centra Administration Site. If a service has crashed, restart the service manuay on the affected servers by running \"net start [service name]\" from a command prompt. For more information about this rue, see \" "Services": "SPTimerService (SPTimerV4)", "FarmName": "SharePoint_Config@SP " } ], "errors": [] } PUT /aerts Tabe 36: PUT /aerts Description Query String Returns updates the Heath Anayzer Aerts information for a 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 wi get information for a farms within your enterprise OK Unauthorized Interna Server Error. Error detais are in response body Exampe: cur --ntm --user administrator@veaskec.spb.qsft:1 -X PUT // enterprise cur --ntm --user administrator@veaskec.spb.qsft:1 -X PUT // farm Site Administrator for SharePoint REST 122

123 GET /aerts/actua_on Tabe 37: GET /aerts/actua_on Description Query String Returns retrieves date and time when the Heath Anayzer Aerts information was ast updated id=[farm_id] is the farm ID for which you want to retrieve data. If this parameter is not specified, you wi get information for a farms within your enterprise OK Unauthorized Interna Server Error. Error detais are in response body Exampe: cur --ntm --user administrator@veaskec.spb.qsft:1 // enterprise cur --ntm --user administrator@veaskec.spb.qsft:1 // farm Response body exampe: "05/31/2012 1:01 PM" GET /security/counters/unique_perms Tabe 38: GET /security/counters/unique_perms Description Query String Returns returns the number of unique permissions on sites, ists/ document ibraries and ist items/ documents with unique permissions within the specified site coection or site ur=[site_url], where [SITE_URL] is the site coection or site URL used to retrieve the permissions number OK Unauthorized Interna Server Error. Error detais are in response body Exampe: cur --ntm --user warrior\\administrator:1 Response body exampe: { "actua_on": "5/23/ :23 PM", // time when data was cached Site Administrator for SharePoint REST 123

124 "time_estimation": 23, // estimated time to update the cache "data": { "number": // number of unique permissions { "sites": 32, "ists": 251, "items": 3541 }, "errors": [] } } PUT /security/counters/unique_perms Tabe 39: PUT /security/counters/unique_perms Description Query String Returns updates the number of unique permissions for the specified site ur=[site_url], where [SITE_URL] is the site coection or site URL used to update the permissions number OK Unauthorized Interna Server Error. Error detais are in response body Exampe: cur --ntm --user warrior\\administrator:1 -X PUT GET /security/counters/unique_perms/actua_on Tabe 40: GET /security/counters/unique_perms/actua_on Description Query String Returns retrieves the date and time when the unique permissions number was ast updated ur=[site_url], where [SITE_URL] is the site coection or site URL used to retrieve information OK Unauthorized Interna Server Error. Error detais are in response body Site Administrator for SharePoint REST 124

125 Exampe: cur --ntm --user warrior\\administrator:1 Response body exampe: "2/18/2012 1:01 PM" GET /security/counters/ad_objs Tabe 41: GET /security/counters/ad_objs Description Query String Returns returns the number of AD users and groups which have the Limit Access permission eve on the specified SharePoint site ur=[site_url], where [SITE_URL] is the site coection or site URL used to retrieve the number of AD objects OK Unauthorized Interna Server Error. Error detais are in response body Exampe: cur --user satestab\\administrator 1 Response body exampe: { "actua_on": "12/28/ :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": [ ] // ist of errors (if any occur) } } Site Administrator for SharePoint REST 125

126 PUT /security/counters/ad_objs Tabe 42: PUT /security/counters/ad_objs Description Query String Returns updates the number of AD objects within the specified site ur=[site_url], where [SITE_URL] is the site coection or site URL used to update the number of AD objects OK Unauthorized Interna Server Error. Error detais are in response body Exampe: cur --user satestab\\administrator 1 -X PUT GET /security/counters/ad_objs/actua_on Tabe 43: GET /security/counters/ad_objs/actua_on Description Query String Returns retrieves date and time when the AD objects number was ast updated ur=[site_url], where [SITE_URL] is the site coection or site URL used to retrieve the number of AD objects OK Unauthorized Interna Server Error. Error detais are in response body Exampe: cur --user satestab\\administrator 1 on?ur= Response body exampe: "05/31/2012 1:01 PM" GET /security/counters/open_content Tabe 44: GET /security/counters/open_content Description Query String Returns retrieves the Open Content counter (the tota number of ur=[site_url], OK. Site Administrator for SharePoint REST 126

127 Description Query String Returns sites, ists, document ibraries, ist 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 coection or site URL used to retrieve information Unauthorized Interna Server Error. Error detais are in response body Exampe: cur --user satestab\\administrator 1 Response body exampe: { "actua_on": "12/28/ :14 PM", // time when data was cached "time_estimation": 60, // estimated time to update the cache "data":{"vaue": 20, "errors": [ ] } } PUT /security/counters/open_content Tabe 45: PUT /security/counters/open_content Description Query String Returns updates the Open Content counter for the specified SharePoint site ur=[site_url], where [SITE_URL] is the site coection or site URL used to update information OK Unauthorized Interna Server Error. Error detais are in response body Exampe: cur --user satestab\\administrator 1 -X PUT GET /security/counters/open_content/actua_on Tabe 46: GET /security/counters/open_content/actua_on Description Query String Returns retrieves the date and time when ur=[site_url], where [SITE_URL] is OK. Site Administrator for SharePoint REST 127

128 Description Query String Returns the Open Content counter was ast updated the site coection or site URL used to retrieve information Unauthorized Interna Server Error. Error detais are in response body Exampe: cur --user satestab\\administrator 1 on?ur= Response body exampe: "05/31/2012 1:01 PM" GET /security/counters/sp_groups Tabe 47: GET /security/counters/sp_groups Description Query String Returns returns the number of SharePoint groups created on a site coection within the specified SharePoint site ur=[site_url], where [SITE_URL] is the site URL used to retrieve the number of SharePoint groups OK Unauthorized Interna Server Error. Error detais are in response body Exampe: cur --user satestab\\administrator 1 Response body exampe: { "actua_on": "12/28/ :14 PM", // time when data was cached "time_estimation": 60, // estimated time to update the cache "data":{ "vaue": 20, // SharePoint groups number "errors": [] // ist of errors (if any occur) } } Response body exampe if an error occurs: Site Administrator for SharePoint REST 128

129 { "actua_on": "12/28/ :14 PM", // time when data was cached "time_estimation": 60, // estimated time to update the cache "data":{ "vaue": 20, // SharePoint groups number "errors": [{ "errors": "errors": "(ProgrammingError) ('42000', '[42000] [Microsoft][ODBC SQL Server Driver][SQL Server]Cannot open database...invaid connection string attribute (0) ') None None" }] } } PUT /security/counters/sp_groups Tabe 48: PUT /security/counters/sp_groups Description Query String Returns updates the number of SharePoint groups for the specified site ur=[site_url], where [SITE_URL] is the site URL used to update the number of unique permissions OK Unauthorized Interna Server Error. Error detais are in response body Exampe: cur --user satestab\\administrator 1 -X PUT GET /security/counters/sp_groups/actua_on Tabe 49: GET /security/counters/sp_groups/actua_on Description Query String Returns retrieves the date and time when the number of SharePoint groups was ast updated ur=[site_url], where [SITE_URL] is the site URL used to retrieve information OK Unauthorized Interna Server Error. Error detais are in response body Exampe: Site Administrator for SharePoint REST 129

130 cur --user satestab\\administrator 1 on?ur= Response body exampe: "2/18/2012 1:01 PM" GET /usage Tabe 50: GET /usage Description Query String Returns retrieves the usage statistics for the specified site incuding its sub-sites ur=[site_url][&period][&imit=data_limit] [&extensions=data_extension] [SITE_URL] - the site coection or site URL used to retrieve the usage information. [&period] - if this parameter is specified, the retrieved information wi be imited by SharePoint defauts. [&extensions=data_extension] - the ist of fie extensions to be dispayed in the most_ active_pages tabe. Use a comma (, ) to separate fie extensions OK Unauthorized Interna Server Error. Error detais are in response body Exampe: cur --ntm --user satestab\\administrator:1 pdf,doc,aspx Response body exampe: { "actua_on": "06/25/ :46:03 AM", // time when data was cached "estimation_time": 12, // estimated time to update the cache "data": { "page views": [{"date": " ", "views": 10},...], // ist of views by date "most_ong_visited_sites": [{"ur": " "is_ts": fase, "ast_ accessed_dates": "May 22, 2012", "visits": 0, "tite": "web1"},...], // top 5 ong unused sites "visitors": [{"dispay_name": "administrator", "name": "satestab\\administrator", "visits": 18},... ], // top 5 most active visitors "most_active_pages": [{"name": "page", "ur": " "visits": 5, "site_ur": " "ast_access_date": , "site_tite": "RootTs"},... ], "summary": {"day_ast_accessed": "Ju 05, 2012", // date when site was ast accessed Site Administrator for SharePoint REST 130

131 "avg_views": 0, // average views by period "subsites": 2, // subsites number "tota_views": 23, // tota number of views "day_ast_modified": "Ju 05, 2012", // date of ast modification "unique_users": 2, // unique users number "unique_pages": 12,}, // number of pages and documents accessed over a month's period "east_visited_sites": [{"ur":" "is_ts": fase, "visits": 0, "tite": "web1"},... ], // top 5 east visited sites "most_visited_sites": [{"ur": " "is_ts": fase, "visits": 21, "tite": "Root Ts"},... ] // top 5 most visited sites } } PUT /usage Tabe 51: PUT /usage Description Query String Returns updates the usage statistics for the specified site incuding its sub-sites ur=[site_url][&period][&imit=data_limit] [&extensions=data_extension] [SITE_URL] - the site coection or site URL used to retrieve the usage information. [&period] - if this parameter is specified, the retrieved information wi be imited by SharePoint defauts. [&extensions=data_extension] - the ist of fie extensions to be dispayed in the most_ active_pages tabe. Use a comma (, ) to separate fie extensions OK Unauthorized Interna Server Error. Error detais are in response body Exampe: cur --ntm --user satestab\\administrator:1 -X PUT GET /usage/actua_on Tabe 52: GET /usage/actua_on Description Query String Returns retrieves the date and time when the usage information was ast updated ur=[site_url][&period][&imit=data_limit] [&extensions=data_extension] [SITE_URL]- the site coection or site URL OK Unauthorized. Site Administrator for SharePoint REST 131

132 Description Query String Returns used to retrieve the usage information. [&period] - if this parameter is specified, the retrieved information wi be imited by SharePoint defauts. [&extensions=data_extension] - the ist of fie extensions to be dispayed in the most_ active_pages tabe. Use a comma (, ) to separate fie extensions Interna Server Error. Error detais are in response body Exampe: cur --ntm --user satestab\\administrator:1 on?ur= Response body exampe: "2/18/2012 1:01 PM" GET /usage/counters/unused_pages Tabe 53: GET /usage/counters/unused_pages Description Query String Returns returns the tota number of unused documents (incuding attachments and.aspx pages) over a month's period within the specified site coection or site ur=[site_url], where [SITE_ URL] is the site coection or site URL used to cacuate the number of unused documents OK Unauthorized Interna Server Error. Error detais are in response body Exampe: cur --ntm --user satestab\\administrator:1 Response body exampe: { "actua_on": "5/23/ :23 PM", // time when data was cached "time_estimation": 23, // estimated time to update the cache "data":157 } Site Administrator for SharePoint REST 132

133 PUT /usage/counters/unused_pages Tabe 54: PUT /usage/counters/unused_pages Description Query String Returns updates the number of unused documents for the specified site coection or site ur=[site_url], where [SITE_URL] is the site coection or site URL used to cacuate the number of unused documents OK Unauthorized Interna Server Error. Error detais are in response body Exampe: cur --ntm --user satestab\\administrator:1 -X PUT GET /usage/counters/unused_pages/actua_on Tabe 55: GET /usage/counters/unused_pages/actua_on Description Query String Returns retrieves the date and time when the tota number of unused documents was ast updated ur=[site_url], where [SITE_URL] is the site coection or site URL used to cacuate the number of unused documents OK Unauthorized Interna Server Error. Error detais are in response body Exampe: cur --ntm --user satestab\\administrator:1 on?ur= Response body exampe: "2/18/2012 1:01 PM" Site Administrator for SharePoint REST 133

134 GET /document/counters/docs_and_pages Tabe 56: GET /document/counters/docs_and_pages Description Query String Returns retrieves the tota number of documents (incuding attachments and.aspx pages) for the specified site coection or site. Documents, attachments and pages shoud not have size = 0 and shoud have aowed extension (the ist of aowed extensions can be modified on the Settings page) ur=[site_url], where [SITE_URL] is the site coection or site URL used to cacuate the documents number OK Unauthorized Interna Server Error. Error detais are in response body Exampe: cur --ntm --user satestab\\administrator:1 Response body exampe: { "actua_on": "5/23/ :23 PM", // time when data was cached "time_estimation": 23, // estimated time to update the cache "data":157 } PUT /document/counters/docs_and_pages Tabe 57: PUT /document/counters/docs_and_pages Description Query String Returns updates the number of documents for the specified site ur=[site_url], where [SITE_URL] is the site coection or site URL used to cacuate the documents number OK Unauthorized Interna Server Error. Error detais are in response body Exampe: cur --ntm --user satestab\\administrator:1 -X PUT Site Administrator for SharePoint REST 134

135 GET /document/counters/docs_and_pages/actua_on Tabe 58: GET /document/counters/docs_and_pages/actua_on Description Query String Returns retrieves the date and time when the documents number was ast updated ur=[site_url], where [SITE_URL] is the site coection or site URL used to cacuate the documents number OK Unauthorized Interna Server Error. Error detais are in response body Exampe: cur --ntm --user satestab\\administrator:1 on?ur= Response body exampe: "2/18/2012 1:01 PM" GET /activity/changes Tabe 59: GET /activity/changes Description Query String Returns retrieves information on the content changes made within the seected site ur=[site_url][&period], where [SITE_URL] is the site coection or site URL used to retrieve information on the content changes, [&period] is an optiona parameter that specifies whether the retrieved data is imited by date or not. If the parameter is not set, a data wi be retrieved. If it is set (and no vaue is specified), the data over past 15 days for SharePoint 2007 and 30 days for SharePoint 2010 wi be retrieved OK Unauthorized Interna Server Error. Error detais are in response body Exampe: cur --ntm --user satestab\\administrator:1 cur --ntm --user satestab\\administrator:1 Response body exampe: { "actua_on": "06/25/ :46:03 AM", // time when data was cached "estimation_time": 12, // estimated time to update the cache Site Administrator for SharePoint REST 135

136 "data": {"users":2,"changes":45,"days":80}, "errors": [] // ist of errors (if any occur) } PUT /activity/changes Tabe 60: PUT /activity/changes Description Query String Returns updates information on the content changes made within the seected site ur=[site_url][&period], where [SITE_URL] is the site coection or site URL used to retrieve information on the content changes, [&period] is an optiona parameter that specifies whether the retrieved data is imited by date or not. If the parameter is not set, a data wi be retrieved. If it is set (and no vaue is specified), the data over past 15 days for SharePoint 2007 and 30 days for SharePoint 2010 wi be retrieved OK Unauthorized Interna Server Error. Error detais are in response body Exampe: cur --ntm --user satestab\\administrator:1 -X PUT cur --ntm --user satestab\\administrator:1 -X PUT GET /activity/changes/actua_on Tabe 61: GET /activity/changes/actua_on Description Query String Returns retrieves the date and time when information on the content changes was updated ur=[site_url][&period], where [SITE_URL] is the site coection or site URL used to retrieve information on the content changes, [&period] is an optiona parameter that specifies whether the retrieved data is imited by date or not. If the parameter is not set, a data wi be retrieved. If it is set (and no vaue is specified), the data over past 15 days for SharePoint 2007 and 30 days for SharePoint 2010 wi be retrieved OK Unauthorized Interna Server Error. Error detais are in response body Exampe: cur --ntm --user satestab\\administrator:1 Response body exampe: "2/18/2012 1:01 PM" Site Administrator for SharePoint REST 136

137 GET /activity/users/most_active Tabe 62: GET /activity/users/most_active Description Query String Returns retrieves the ist of most active editors of SharePoint content or security within the specified site ur=[site_url][&period], where [SITE_URL] is the site coection or site URL used to retrieve information on the active users, [&period] is an optiona parameter that specifies whether the retrieved data is imited by date or not. If the parameter is not set, a data wi be retrieved. If it is set (and no vaue is specified), the data over past 15 days for SharePoint 2007 and 30 days for SharePoint 2010 wi be retrieved OK Unauthorized Interna Server Error. Error detais are in response body Exampe: cur --ntm --user satestab\\administrator:1 cur --ntm --user satestab\\administrator:1 active?ur= Response body exampe: { "actua_on": "06/25/ :46:03 AM", // time when data was cached "estimation_time": 12 // estimated time to update the cache "data": // ist of most active editors [ {"name":"john Smith", "changes":45}, {"name":"ben Johnson", "changes":23} ], "errors": [] // ist of errors } PUT /activity/users/most_active Tabe 63: PUT /activity/users/most_active Description Query String Returns updates the ist of active users for the specified site ur=[site_url], where [SITE_URL] is the site coection or site URL used to retrieve the ist of active users OK Unauthorized. Site Administrator for SharePoint REST 137

138 Description Query String Returns Interna Server Error. Error detais are in response body Exampe: cur --ntm --user satestab\\administrator:1 -X PUT GET /activity/users/most_active/actua_on Tabe 64: GET /activity/users/most_active/actua_on Description Query String Returns retrieves the date and time when the ist of most active editors was ast updated ur=[site_url], where [SITE_URL] is the site coection or site URL used to retrieve the ist of the most active users OK Unauthorized Interna Server Error. Error detais are in response body Exampe: cur --ntm --user satestab\\administrator:1 on?ur= Response body exampe: "2/18/2012 1:01 PM" GET /schedue/report NOTE: This method is avaiabe ony for Information Porta administrators. Tabe 65: GET /schedue/report Description Query String Returns returns a schedue information for the given scope, report name and target parameters report_name:[reportname]-the name of the report to be schedued for export ur:[url] - the scope URL (Enterprise, Farms, Web Appications and Sites) target: [TARGET] - can be either csv or sq. By defaut, the vaue is set to csv. Pease note that the vaue is case-sensitive OK Unauthorized Interna Server Error. Error detais are in response body Site Administrator for SharePoint REST 138

139 Exampe: cur --user satestab\administrator:1 name=sites&ur= Response body exampe: [ { "TaskToRun": "\"C:\\Program Fies (x86)\\agreeya Soutions\\Site Administrator for SharePoint\\SharePoint Information Porta\\Appication\\scheduer\\runner.bat\" SASP_ Reports_Monthy_task", // specify the task action "seected": true, // the fag indicating which scheduer type is set "occurrence": "2", "Author": "Administrator", // the task author "ShareLocaPath": "C:\\Program Fies (x86)\\agreeya Soutions\\Site Administrator for SharePoint\\SharePoint Information Porta\\Exports", // the oca directory to share "NetbiosName": "INFOPORTAL", // Network Basic Input/ Output System name "NextRunTime": "2/1/2013 2:00:00 AM", // indicates when the task wi run next time "SchedueType": "Monthy", // the schedue type vaue "Status": "Ready", // the task status vaue "StartDate": "12/19/2012", // the date when the task wi be started "Repeat": "Stop If Sti Running: Disabed", "EndDate": "N/A", "Description": "Monthy", // the description text "Schedue": "Scheduing data is not avaiabe in this format.", "IdeTime": "Disabed", "HostName": "INFOPORTAL", // the host name where the task is running "ScheduedTaskState": "Enabed", "LastResut": "1", "ShareNetworkPath": "\\\\INFOPORTAL\\SASP_Exports", // the network path to share "DeeteTaskIfNotReschedued": "Enabed", "StartIn": "N/A", "RunAsUser": "satestab\\administrator", // the user running the task "Months": ["Every month"], // months to run the task "Days": ["01"], // indicates what day of the month the task wi be run "PowerManagement": "Stop On Battery Mode, No Start On Batteries", "LastRunTime": "N/A", "TaskName": "SASP_Reports_Monthy_task", // the task name "Comment": "N/A", Site Administrator for SharePoint REST 139

140 "FieName": "sites_%timestamp%", // the report fie name format "StopTaskIfRunsXHoursandXMins": "72:00:00", "StartTime": "2:00:00 AM", "LogonMode": "Interactive/Background" // these two vaues are returned for export to SQL. "SqServer": "SqServerHostName", // the sq server host name "Database": "dbname" // the database name }, {...}, {...} ] PUT /schedue/report NOTE: This method is avaiabe ony for Information Porta administrators. Tabe 66: PUT /schedue/report Description Query String Returns enabes scheduing for the report export task_id: [TASKID] - the scheduer task type (SASP_Reports_ Custom_task, SASP_Reports_Monthy_task, SASP_Reports_ Quartery_task and SASP_Reports_Weeky_task) report_name: [REPORTNAME] - the name of the report to be schedued for export ur: [URL] - the scope URL (Enterprise, Farms, Web Appications and Sites) target: [TARGET] - can be either csv or sq. By defaut, the vaue is set to csv. Pease note that the vaue is casesensitive OK Unauthorized Interna Server Error. Error detais are in response body Exampe: cur --user satestab\administrator:1 -X PUT -d "task_id=sasp_reports_monthy_ task&report_name=sites&ur= DELETE /schedue/report NOTE: This method is avaiabe ony for Information Porta administrators. Tabe 67: DELETE /schedue/report Description Query String Returns disabes scheduing for the report task_id: [TASKID] - the scheduer task type (SASP_Reports_ OK. Custom_task, SASP_Reports_Monthy_task, SASP_Reports_ Quartery_task and SASP_Reports_Weeky_task) Site Administrator for SharePoint REST 140

141 Description Query String Returns export report_name: [REPORTNAME] - the name of the report to be schedued for export ur: [URL] - the scope URL (Enterprise, Farms, Web Appications and Sites) target: [TARGET] - can be either csv or sq. By defaut, the vaue is set to csv. Pease note that the vaue is casesensitive Unauthorized Interna Server Error. Error detais are in response body Exampe: cur --user satestab\administrator:1 -X DELETE -d "task_id=sasp_reports_monthy_ task&report_name=sites&ur= POST /job/disaow_everyone Tabe 68: POST /job/disaow_everyone Description Query String Returns creates a poicy to prevent NT AUTHORITY\authenticated users from being used for permissioning and appies it to the specified site coection or web appication siteur=[site_url], where [SITE_URL] is the site coection or web appication URL to which you want to appy the poicy run_type=poicy OK Unauthorized Interna Server Error. Error detais are in response body Exampe: cur --ntm --user administrator@veaskec.spb.qsft:1 -X POST -d ' {"siteur":" "run_type":"poicy"}' DELETE /job/disaow_everyone Tabe 69: DELETE /job/disaow_everyone Description Query String Returns deetes the poicy for the specified site coection or web appication siteur=[site_url], where [SITE_URL] is the site coection or web appication URL for which you want to deete the poicy OK Unauthorized Interna Site Administrator for SharePoint REST 141

142 Description Query String Returns Server Error. Error detais are in response body Exampe: cur --ntm --user -X DELETE -d ' {"siteur":" at:3141/api/job/disaow_ everyone GET /job/disaow_everyone Tabe 70: GET /job/disaow_everyone Description Query String Returns returns poicy detais for the specified site coection or web appication siteur=[site_url], where [SITE_URL] is the site coection or web appication URL used to retrieve the poicy detais OK Unauthorized Interna Server Error. Error detais are in response body Exampe: cur --ntm --user administrator@veaskec.spb.qsft:1 -X GET at:3141/api/job/disaow_everyone?siteur= Response body exampe: { "job_type": "disaow_everyone", "sch_type": "poicy", "agent": "sp14-at", "scope": " "user_name": "VELASKEC\Administrator", "create_time": , "status": -1, "args": {"with_subsites": true, "run_type": "poicy", "siteur":" "id":15 } here: Site Administrator for SharePoint REST 142

143 job_type - the job name, const = disaow_everyone sch_type - execution type, const = poicy agent - the netbios name of the InfoPora agent running the job scope- the site coection or web appication ur to which the poicy is appied user_name - the user name who created the task create_time - the time when the poicy was created in numeric format status - the task status: NULL - the job execution has not started yet 1 - the job is in progress the job is competed -1 - an error has occurred during the job execution args - poicy settings siteur - the site coection or web ur to which the poicy is appied with_subsites - appies the poicy to a subsites recursivey POST /job/propagate_version_settings Tabe 71: POST /job/propagate_version_settings Description Query String Returns creates a poicy to set version settings for document ibraries within the specified site coection or site { OK. siteur:[site_url] // site ur to propagate settings Unauthorized. keep_major: [TRUE / FALSE] // imit the number of major versions fag keep_draft: [TRUE / FALSE] // imit the number of minor versions fag major: [NUMBER] // number of major versions to keep minor: [NUMBER] // number of minor versions to keep do_ceanup: [TRUE/FALSE] // ceanup fag for the first appy time run_type=poicy } Interna Server Error. Error detais are in response body Exampe: cur --ntm --user caissa\\administrator:1 -X POST -d {"siteur":" major":true,"major":5,"minor":3,"run_type":"poicy","do_ceanup":true} Site Administrator for SharePoint REST 143

144 DELETE /job/propagate_version_settings Tabe 72: DELETE /job/propagate_version_settings Description Query String Returns deetes the poicy for the specified site coection or site siteur=[site_url], where [SITE_URL] is the site coection or site URL for which you want to disabe the poicy OK Unauthorized Interna Server Error. Error detais are in response body Exampe: cur --ntm --user administrator@veaskec.spb.qsft:1 -X DELETE -d ' {"siteur":" at:3141/api/job/propagate_ version_settings GET /job/propagate_version_settings Tabe 73: GET /job/propagate_version_settings Description Query String Returns returns poicy detais for the specified site coection or site siteur=[site_url], where [SITE_URL] is the site coection or site URL for which you want to retrieve the poicy detais OK Unauthorized Interna Server Error. Error detais are in response body Exampe: cur --ntm --user caissa\administrator:1 -X GET settings?siteur= Response body exampe: { "job_type": "propagate_version_settings", // job name "sch_type": "poicy", // execution type "agent": "sp2007singe", // netbios name of the InfoPora agent running the job "scope": " // site ur to propagate settings "user_name": "UTAH\administrator", // user name who created the task "create_time": , // creation time (UTC) in numeric format "status": 100, // task status: Site Administrator for SharePoint REST 144

145 // NULL has not been executed yet // 1 is in progress // 100 done // -1 an error occurred "args": { // version settings to propagate: "siteur": " // site ur to propagate settings "keep_major": true, // imit number of major versions fag "keep_draft": fase, // imit number of minor versions fag "major": 5, // number of major versions to keep "minor": 0, // number of minor versions to keep } } POST /job/restore_broken_inheritance Tabe 74: POST /job/restore_broken_inheritance Description Query String Returns creates a poicy to restore broken permissions inheritance for a site incuding its subsites and items siteur=[site_url], where [SITE_ URL] is the site coection or web URL the poicy is to be appied to run_type=poicy OK Unauthorized Interna Server Error. Error detais are in response body Exampe: cur --ntm --user warrior\administrator:1 -X POST -d '{"siteur":" "run_type":"poicy"}' inheritance DELETE /job/restore_broken_inheritance Tabe 75: DELETE /job/restore_broken_inheritance Description Query String Returns disabes the poicy for the specified site siteur=[site_url], where [SITE_URL] is the site coection or web URL for which you want to disabe the poicy run_type=poicy OK Unauthorized Interna Server Error. Error detais are in response body Site Administrator for SharePoint REST 145

146 Exampe: cur --ntm --user warrior\administrator:1 -X DELETE type=poicy GET /job/restore_broken_inheritance Tabe 76: GET /job/restore_broken_inheritance Description Query String Returns returns poicy detais for the specified site siteur=[site_url], where [SITE_URL] is the site coection or web URL used to retrieve the poicy detais run_type=poicy OK Unauthorized Interna Server Error. Error detais are in response body Exampe: cur --ntm --user warrior\administrator:1 -X GET Response body exampe: { "job_type": "restore_broken_inheritance", "sch_type": "poicy", "agent": "warrior10-1", "scope": " "user_name": "warrior\administrator", "create_time": , "status": -1, "args": {"with_subsites": true, "run_type": "poicy", "siteur":" "id":15 } here: job_type - the job name, const = restore_broken_inheritance sch_type - execution type, const = poicy agent - the netbios name of the InfoPora agent running the job scope - the site coection or web ur to which the poicy is appied user_name - the user name who is created the task create_time - the time when the poicy was created Site Administrator for SharePoint REST 146

147 status - the task status: NULL - the job execution has not started yet 1 - the job is in progress the job is competed -1 - an error has occurred during the job execution args - poicy settings siteur - the site coection or web ur to which the poicy is appied with_subsites - appies the poicy to a subsites recursivey Site Administrator for SharePoint REST 147

148 Site Administrator for SharePoint Scripts In this section: CSV to SQL Export Export Grid Reports to PDF Cean Up Report Data Cean Up Usage Coector Data Data Gathering for Enterprise Leve Reports CSV to SQL Export You can export report data from a generated CSV fie to any SQL database tabe using a script ocated in the {SA4SP instaation foder}/sharepoint Information Porta/Scripts/CSV2SQL foder. If the target tabe exists, the too appends new data without modifying existing data. NOTE: The foowing fie formats are supported for export:.csv and.zip (CSV fies compressed using zip). Prerequisites Before you run the script, make sure the foowing software is instaed on the machine:.net 2.0 or ater. One of the foowing: SQL Server 2005 SQL Server 2008 SQL SERVER 2012 Synopsis and Usage To export report data from CSV to SQL, run python.exe csv2sq.py [options] or csv2sq.cmd [options]. Options: -h, --hep - shows this hep message and exits -p CSVPATH, --csvpath=csvpath - the path to the csv fie Site Administrator for SharePoint Scripts 148

149 -s DBSERVER, --dbserver=dbserver - the database server host -d DBNAME, --dbname=dbname - the name of the database to be used for csv to sq export -t TABLENAME, --tabename=tablename - the tabe name (same as the report name) The -p, -s, -d, -t options are required to be specified. If they are not specified or incorrect, the usage information wi be dispayed. Exit Code Description: 1 An exception occurred 2 -- No input parameters are specified 3 -- The parameter is incompete Exampe: python.exe csv2sq.py -p "c:\documentreport\documentreport.csv" -s "Warrior10-1" -d "QSP_Repository" -t "DocumentDetais" Command ine exampes: csv2sq.cmd "c:\documentreport\documentreport.zip" "Warrior10-1" "QSP_Repository" "DocumentDetais" csv2sq.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 ocated in the {SA4SP instaation foder}/ SharePoint Information Porta\OData2PDF foder. Synopsis and Usage To export report data to PDF, run OData2PDF.cmd [options]. Options: -h, --hep - shows this hep message and exits -u, --URL - the ODataService URL in the ODataService port]/[name of the data tabe]?[odata fiter] format -t, --tempate - the tempate name The -u, -t options are required to be specified. If they are not specified or incorrect, the usage information wi be dispayed. Exit Code Description: 2 An error occurred when retrieving data from the OData service Site Administrator for SharePoint Scripts 149

150 1 An exception occurred 0 The operation competed successfuy -1 BIRT error occurred The foowing exampe wi generate a PDF fie with 10 sites created after December 9, 2012 and number of views not equa to 0. $top=10&$fiter=(created gt datetime' ' and (Views ne 0)) is the ODATA fiter. For more information refer to and NOTE: By defaut port 3147 is used by ODataService. In case it is busy, use the port specified in the Site Administrator for SharePoint\SharePoint Information Porta\OData4SQL\OdataProvider\WebSettings.conf (server.socket_port variabe vaue). NOTE: PDF fies wi be stored in the {SA4SP instaation foder}/ SharePoint Information Porta\OData2PDF\exportFies foder. 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 insta the 32 bit Java version. In this case, you wi need to modify the JAVA_HOME and JAVACMD variabes in the Site Administrator for SharePoint\SharePoint Information Porta\birtruntime\ReportEngine\genReport.bat fie. NOTE: When exporting a arge amount of data to PDF, the Java process for BIRT requires sufficient physica memory, otherwise, there wi be errors when generating PDF fies and data wi be incompete. As a workaround, set the maximum Java heap size. Tabe 77: Tempate Names for Grid Reports Report Tempate Name Data Tabe Documents and Pages documents_and_pages_report sa4sp_repdata2_documents_and_pages Sites sites_report sa4sp_repdata2_sites Site Coections site_coections_report sa4sp_repdata2_site_coections Content Databases contentdbs_report sa4sp_repdata2_contentdbs Web Appications webapps_report sa4sp_repdata2_webapps Exampe: OData2PDF.cmd -u gt datetime' ') -t "sites_report" Cean Up Report Data To cean up od report data exported to SQL by the CSV to SQL command ine too or by schedue, use a script ocated in the {SA4SP instaation foder}/sharepoint Information Porta/Scripts/CeanUpReporting foder. Site Administrator for SharePoint Scripts 150

151 Synopsis and Usage To cean up report data, run python.exe ceanup_reporting.py [options] or ceanup_ reporting.cmd [options]. Options: -h, --hep - shows this hep message and exits -s DBSERVER, --dbserver=dbserver - the database server host -d DBNAME, --dbname=dbname - the name of the database to be ceaned up -n NUMBEROFDAY, --numberofday=numberofday - specifies the cutoff date for deeting report data. A report data that was coected the specified number of days ago and earier wi be deeted. The -s, -d, -n options are required to be specified. If they are not specified or incorrect, the usage information wi be dispayed. Exit Code Description: 1 -- Exception occurred 2 -- No input parameters are specified 3 -- The parameter is incompete Exampe: python.exe ceanup_reporting.py Warrior10-1 QSP_Reporsitory 12 Command ine exampes: ceanup_reporting.cmd Warrior10-1 QSP_Reporsitory 12 Cean Up Usage Coector Data Site Administrator for SharePoint stores the usage report data in the QSP_Repository database. Over time, the usage data coection resuts in growth of the database as a resut of the usage coector work. To prevent unimited growth and impact on the report performance, Site Administrator provides a script aowing users to purge od data from the database. The script removes data oder 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 dispayed 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] tabes of the QSP_Repository database. Site Administrator for SharePoint Scripts 151

152 Synopsis and Usage To purge the usage coector data, run Python.exe ceanup_usage_data [option] or ceanup_usage_ data.cmd [option] ocated in the {SA4SP instaation foder}/sharepoint Information Porta/UsageCoector foder. Options: -h, --hep - shows this hep message and exits -n NUMBEROFDAY, --numberofday=numberofday - specifies the cutoff date for deeting the usage coector data. A data that was coected the specified number of days ago and earier wi be deeted. The -n option is required to be specified. Exit Code Description: 1 An exception occurred 2 -- No input parameters are specified Exampe: python.exe ceanup_usage_data.py -n 31 Command ine exampes: ceanup_usage_data.cmd 31 Data Gathering for Enterprise Leve Reports Information Porta administrators can gather the enterprise eve report data to the QSP_Repository database by running data_gathering.cmd ocated in the {SA4SP instaation foder}/sharepoint Information Porta/DataGathering foder. data_gathering.cmd run by Python 2.7 starts the data gathering process. NOTE: Before data gathering, the too wi discover a SharePoint farms avaiabe in your environment to make sure a changes on the farms are up-to-date. NOTE: A od data wi be ceaned up before writing report data to the database. The foowing tabe ists a enterprise eve reports and QSP_Repository database tabes to which the report data is gathered: Site Administrator for SharePoint Scripts 152

153 Tabe 78: Data Tabes Report Documents and Pages Lists Document Libraries Sites Site Coections Site Permissions Security Changes Content Changes Daiy Usage Content Databases Web Appications Servers Data Tabe sa4sp_repdata_documents_and_pages sa4sp_repdata_ists sa4sp_repdata_document_ibraries sa4sp_repdata_sites sa4sp_repdata_site_coections sa4sp_repdata_site_permissions sa4sp_repdata_activity_security sa4sp_repdata_activity_content sa4sp_repdata_daiy_active_users sa4sp_repdata_contentdbs sa4sp_repdata_webapps sa4sp_repdata_servers Site Administrator for SharePoint Scripts 153

154 FAQ How to Insta Information Porta Using Command Line How to Get the Best Performance for Mutipe Concurrent Users Working with Information Porta How to Insta Information Porta SharePoint Soution (SharePoint Integration Modue) without Instaing Fu Information Porta Setup on a SharePoint Front-end Server How to Uninsta Information Porta SharePoint Soution (SharePoint Integration Modue) How to Automate PDF Export of Site Metrics Report for Specific Site How to Configure IIS 7 as Web Front-end Server for Information Porta How to Change Port for Information Porta How to Change Ports for Information Porta Services How to Change Password for Insta and Service Accounts What Permissions Are Required for Site Owners Why is the Actua Size of the SharePoint Content Database Shown in the Reports Much Bigger than Size of the Site Coection Located in this Database? Information Porta Reports Show Zero or N/A in Usage Data (e.g. the Number of Views, the Number of Users, Most Used Content) Information Porta Detaied Reports (Site Coections, Sites, Documents, Lists, Document Libraries) Dispay Ony 20 Records. How to View a Resuts if the Number of Objects Exceeds this Limit? Why Is the Site Size Different in Enterprise/Site Metrics and Sites Reports? How to Cear Authorization Cache How to Move Reporting Database to Another SQL Server How to View What Users are Using Site Administrator for SharePoint How to Override Add Farm Behavior Information Porta Advanced Troubeshooting How to Insta Information Porta Using Command Line To insta Information Porta using the command ine, run the foowing command: msiexec /i qsinfoporta.msi /quiet AGENT_ACCOUNT=%1 AGENT_PASSWORD=%2 SQLSERVER=%3 DBNAME=%4 /v! ipsetup.og. FAQ 154

155 How to Get the Best Performance for Mutipe Concurrent Users Working with Information Porta If hundred of users work with Information Porta reports, it is recommended to depoy mutipe instances configuration. Perform the foowing steps: 1. Run cmd.exe as Administrator. 2. Change directory to [Product Insta Path]\SharePoint Information Porta\Scripts. 3. Run baancer.cmd "[domainuser]" "[password]", where [domainuser] and [password] is the service account used for the Web Access service. By defaut, 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 foowing command ine in baancer.py "%1" "%2" [ApacheInstances] [BrowserServicesInstances], where [ApacheInstances] is the number of Apache instances (8 by defaut) and [BrowserServicesInstances] is the number of BrowserAgent and BrowserBroker instances (4 by defaut). To uninsta mutipe instances, run remove_baancer.cmd. NOTE: When uninstaing or upgrading the product, mutipe instances are automaticay removed. You shoud depoy mutipe instances configuration using the baancer.cmd script each time you upgrade the product. It is aso recommended to insta Information Porta on severa SharePoint front-end servers and configure oad-baancing between them. Instaing Information Porta on severa front-ends improves the too performance and provides faut toerance. NOTE: Each Information Porta instaation has its own Settings database. So, each setting shoud be configured individuay on each Information Porta server. The foowing settings are affected: Information Porta Administrators, Number of items shown in reports, Show action buttons, License settings. How to Insta Information Porta SharePoint Soution (SharePoint Integration Modue) without Instaing Fu Information Porta Setup on a SharePoint Front-end Server NOTE: Pease note that a Information Porta actions (such as permissions grant, revoke, site or copy) FAQ 155

156 are avaiabe ony if Information Porta is instaed on a front-end within the farm. The actions wi not work in the described scenario. For more information about action capabiities, see Manage Security. Appied both for SharePoint 2007, SharePoint 2010 and SharePoint Perform the foowing steps: 1. Insta Information Porta on the server where you pan to use it. Save Information Porta Enterprise Report URL. It shoud be ike: 2. Create a temporary foder on a SharePoint front-end server to depoy the soution. For exampe: C:\AgreeYaSPSoution. 3. Copy the [ProductInstaPath]\SharePoint Information Porta\SPIntegration and [ProductInstaPath] \SharePoint Information Porta\IronPython26 for SharePoint 2007 and 2010 or [ProductInstaPath] \SharePoint Information Porta\IronPython27 for SharePoint 2013 foders from the server hosting Information Porta to the AgreeYaSPSoution foder on a front-end server. 4. Run cmd.exe on a front-end server. 5. Make the AgreeYaSPSoutionSPIntegration foder current: cd c:agreeyaspsoutionspintegration 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 foowing command: For SharePoint 2007 and 2010:..\IronPython26\ipy64.exe wsp_insta.py porta_server:3141 For SharePoint 2013:..\IronPython27\ipy64.exe wsp_insta.py server: Make sure the output does not contain errors. The process successfuy competed shoud ook ike: 1/28/2011 8:57:50 PM: Sharepoint Integration insta [ wsp_insta.py, ] 1/28/2011 8:57:53 PM: Generating wsp soution in.\\spintegrationfeature for 1/28/2011 8:57:55 PM: setup soution:.\\spintegrationfeature\spintegrationfeature.wsp 1/28/2011 8:57:55 PM: stop running jobs 1/28/2011 8:57:56 PM: remove od soution 1/28/2011 8:57:59 PM: add soution 1/28/2011 8:58:09 PM: depoy soution 9. Ensure that SharePoint sites have the Site Administrator Reports section containing the inks to the Information Porta reports in the Site Settings. In SharePoint 2010, it ooks as foows: 10. Now the AgreeYaSPSoution foder can be deeted. FAQ 156

157 How to Uninsta Information Porta SharePoint Soution (SharePoint Integration Modue) To uninsta Information Porta SharePoint soution from a farm, run the foowing commands on the SharePoint front-end server where Information Porta is instaed: cd C:\\Program Fies (x86)\\agreeya Soutions\\Site Administrator for SharePoint\\SharePoint Information Porta\\SPIntegration..\\IronPython26\\ipy64.exe wsp_uninsta.py where C:\Program Fies (x86)\agreeya Soutions\Site Administrator for SharePoint is the foder where Information Porta is instaed. The foowing ines indicate that Information Porta SharePoint soution is successfuy uninstaed: Removing soution SharePoint Integration uninsta soution: a96ccaa2-44fe e3-756c6ab95697 stop running jobs retracting soution a96ccaa2-44fe e3-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 foowing PowerShe script: ### the foowing part shoud be configured according to you environment $siteadmin = " # site administrator reports URL $site = " # generate PDF for this Sharepoint site $pdf_path = "c:\site_metrics.pdf" # resut PDF fie path # report specific: $pdf_ur = '/site_metrics/pdf' # URL of PDF export for this report $report = "/site_coection" ### $wc = New-Object System.Net.WebCient $wc.credentias = [System.Net.CredentiaCache]::DefautCredentias $act = $wc.downoadstring( $siteadmin + $report + "?ur=" + $site ) %{ if ($_ - match '&diagrams_actua_on=.*esgt_actua_on=(none \d*.\d*)') {$matches[0]} } $act FAQ 157

158 $pat = '{"sgtbusy": fase, "istsbusy": fase, "docsbusy": fase, "docextbusy": fase, "docibsbusy": fase, "esgt_busy": fase, "siteinfobusy": fase, "ssdbusy": fase}' $st = '' whie ( $st -ne $pat) { seep 5 $st = $wc.downoadstring( $siteadmin + "/site/state" + "?ur=" + $site + $act ) $st } $wc.downoadfie( $siteadmin + $pdf_ur + "?ur=" + $site, $pdf_path ) To run the script: 1. Provide vaues specific for your environment for the $siteadmin, $site and $pdf_path variabes. 2. Save the fie with.ps1 extension. 3. Open the PowerShe consoe and run the script. How to Configure IIS 7 as Web Frontend Server for Information Porta By defaut, Information Porta uses Apache ( as a web server. It is incuded in the Information Porta instaation package and automaticay configured to be accessed by the URL ike: You can configure IIS 7 to work as a web server for Information Porta if it is required to use IIS for a web appications by the company poicy. The foowing are additiona options avaiabe in IIS 7: Configure SSL encryption Configure a host-header with the defaut port Configure oad distribution Use automatic Windows updates to aways have IIS in the most secured state. Configuration incudes three steps: 1. Configure IIS 7 as a reverse proxy ( This means that a reagreeyas from users are sent to IIS 7 site and then redirected to the Porta Apache server. The response from Apache goes back to IIS, and then IIS sends it back to the user. We use Appication ReAgreeYa Routing Modue to impement this process. 2. To avoid the direct access to Information Porta via Apache server, disabe istening externa reagreeyas. Apache is hidden for a users since istening externa reagreeyas are disabed. 3. Reconfigure the Information Porta SharePoint Integration feature to point to a new IIS site. FAQ 158

159 Step 1. Configure IIS 7 as Reverse Proxy The soution is based on the standard IIS extension - the Appication ReAgreeYa Routing modue. Insta it on the server hosting Information Porta and IIS 7. The Appication ReAgreeYa Routing modue can be downoaded at 1. After the Appication ReAgreeYa Routing (ARR) modue has been instaed, it shoud be configured to act as a proxy server (this functionaity is not enabed by defaut). In IIS Manager, highight the Appication ReAgreeYa Routing Cache feature and cick Open Feature in the Actions pane. 2. Cick Server Proxy Settings in the Actions pane. FAQ 159

160 3. Tick the Enabe proxy checkbox, and then cick Appy. Leave a the defaut vaues in pace. 4. Next, configure the URL Rewrite rue, so that IIS knows what to do with reagreeyas which you want to forward to Information Porta Apache. Cick a site which is supposed to be used for Information Porta. If you do not have any site, create it. In our exampe, a test site ( is used. Highight the URL Rewrite icon, and then cick Open Feature in the Actions pane. FAQ 160

161 5. In the URL Rewrite feature, cick Add Rues in the Actions pane. 6. In the Add Rue(s) diaog box, seect Bank rue and cick OK. 7. In the Edit Inbound Rue feature, specify the new rue name and type.* in the Pattern diaog box. The new rue shoud defaut to using Reguar Expressions (if it does not, ensure that you seect this option). In the Action section of the Edit Inbound Rue feature, ensure that the Action type is set to Rewrite and then enter in the Rewrite URL diaog box as shown beow. Cick Appy to create the new rue. We assume that Information Porta is instaed on port 3141 (defaut), so is the Information Porta Apache server URL. FAQ 161

162 8. Now you can test the URL: It dispays the Information Porta Enterprise report in the same way as the URL. 9. SSL can be configured on this IIS site. For more information, see the foowing artice: Step 2. Configure Apache to be Locahost Ony Now disabe the direct access to Information Porta via Apache server. Perform the foowing: 1. Open C:\Program Fies (x86)\agreeya Soutions\Site Administrator for SharePoint\SharePoint Information Porta\Python25\conf\httpd.conf in notepad. (here we assume that the product is instaed in the defaut path on x64 OS). 2. Change ServerName atsp2010:3141 to ServerName :3141 (assuming that atsp2010 is the name of this server). 3. Change Listen 3141 to Listen :3141. The modified httpd.config fie wi ook as foows: ServerRoot "C:\Program Fies (x86)\agreeya Soutions\Site Administrator for SharePoint\SharePoint Information Porta\Python25" ServerName :3141 ServerSignature Off ServerTokens Prod FAQ 162

163 DocumentRoot "C:\Program Fies (x86)\agreeya Soutions\Site Administrator for SharePoint\SharePoint Information Porta\Python25" Listen : Restart the AgreeYa.InfoPorta.WebAccess service. Verify that does not work from other servers (atsp2010 is the name of the server hosting Information Porta. Repace it with your server name). Verify that works. Now you have Information Porta instaed with the IIS web front-end server. Step 3. Reconfigure Information Porta SharePoint Integration Feature As the Information Porta URL has been changed to it is required to reconfigure the SharePoint Integration feature. Perform the foowing: 1. Run cmd.exe on the server hosting Information Porta. 2. Make the C:\Program Fies (x86)\agreeya Soutions\Site Administrator for SharePoint\SharePoint Information Porta\SPIntegration foder 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 foowing command:..\ironpython26\ipy64.exe wsp_insta.py 5. Make sure the output does not contain errors. The process successfuy competed shoud ook ike: 1/28/2011 8:57:50 PM: Sharepoint Integration insta ['wsp_insta.py', ' 1/28/2011 8:57:53 PM: Generating wsp soution in.\\spintegrationfeature for 1/28/2011 8:57:55 PM: setup soution:.\\spintegrationfeature\spintegrationfeature.wsp 1/28/2011 8:57:55 PM: stop running jobs 1/28/2011 8:57:56 PM: remove od soution 1/28/2011 8:57:59 PM: add soution 1/28/2011 8:58:09 PM: depoy soution 6. Ensure that SharePoint sites have the Site Administrator Reports section containing the inks to the Information Porta reports in the Site Settings. Try to open these inks. In SharePoint 2010, it ooks as foows: FAQ 163

164 How to Change Port for Information Porta By defaut, Information Porta is instaed on port To change it, perform the foowing steps: 1. Open the Apache configuration fie: [ProductInstaDir]\SharePoint Information Porta\Python25\conf\httpd.conf. It contains the foowing: ServerRoot c:\program Fies\AgreeYa Soutions\Site Administrator for SharePoint\SharePoint Information Porta\Python25 ServerName hostname:3141 ServerSignature Off ServerTokens Prod DocumentRoot c:\program Fies\AgreeYa Soutions\Site Administrator for SharePoint\SharePoint Information Porta\Python25 Listen Repace 3141 port number with the one you need both in the ServerName and Listen properties. For exampe, if you change the defaut port to 8080, the httpd.conf fie wi ook as foows: ServerRoot c:\program Fies\AgreeYa Soutions\Site Administrator for SharePoint\SharePoint Information Porta\Python25 ServerName hostname:8080 ServerSignature Off ServerTokens Prod DocumentRoot c:\program Fies\AgreeYa Soutions\Site Administrator for SharePoint\SharePoint Information Porta\Python25 Listen 8080 If you appy port 80, the httpd.conf fie wi ook as foows: ServerRoot c:\program Fies\AgreeYa Soutions\Site Administrator for SharePoint\SharePoint Information Porta\Python25 ServerName hostname ServerSignature Off ServerTokens Prod DocumentRoot c:\program Fies\AgreeYa Soutions\Site Administrator for SharePoint\SharePoint Information Porta\Python25 Listen 80 NOTE: Ensure that the port you appy is free. No IIS site or other appication shoud use this port. You can verify that the port is free by the netstat utiity. 3. Restart the AgreeYa.InfoPorta.WebAccess service. 4. Check the new URL in your browser: or 5. Reinsta Information Porta SharePoint Soution (SharePoint Integration Modue) on any front-end server of each discovered farm as described in the foowing artice. The new port wi be preserved in future upgrades. FAQ 164

165 How to Change Ports for Information Porta Services NOTE: The defaut port numbers used by the Information Porta services are 3142 and However, in some cases they may be different. To change the defaut ports, perform the foowing: 1. Open the SPInfo.conf fie to change 3142 port and SPInfoBroker.conf to change 3143 port. The fies are ocated in the [ProductInstaDir]\SharePoint Information Porta\SharePoint Browser foder. 2. Repace the defaut port number with the one you need in server.socket_port. 3. Restart a the services, incuding AgreeYa.InfoPorta.WebAccess. How to Change Password for Insta and Service Accounts Credentias shoud be changed for a AgreeYa.InfoPorta.* services and SASP_* schedued tasks in a Site Administrator instaations. What Permissions Are Required for Site Owners A reagreeyas are performed by Information Porta services under service account that shoud have the db_ reader acess to content databases. Information porta restricts access for Site Coection Administrators/Site Owners and they can see reports about any content beow the site they have access to. Why is the Actua Size of the SharePoint Content Database Shown in the Reports Much Bigger than Size of the Site Coection Located in this Database? The database size is the physica size of the database fies (mdf and df). It is queried by the sp_hepdb stored procedure. This size incudes a SQL data reated to the database: transactions ogs, indexes, SQL database schema, permissions and tabes metadata. Depending on SQL administration it may incude pre-aocated space for future growth - around 10-25%. FAQ 165

166 The site coection size in our reports is the tota size of the foowing data: documents doc versions ist items account personaization info webparts document metadata. Content size does not incude SharePoint permissions structures, audit and events data. The same approach is used by the SharePoint Storage Space Aocation page. If a user upoads 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 aready been aocated for these data; or the change wi be greater as SQL needs to keep auxiiary structures such as transactions ogs, indexes, document properties in order to store these documents. So, there wi be storage overhead added by the SharePoint and possiby by SQL auxiiary data. Using Information Porta reports, you can identify this overhead as we show both the database size and the site coection content size. If the overhead is too big (30% or more), you can cean up the space by the SQL database defragmentation and shrink operations. Information Porta Reports Show Zero or N/A in Usage Data (e.g. the Number of Views, the Number of Users, Most Used Content) Verify the foowing: 1. Usage Anaysis Processing is enabed in Centra Administration > Operations > Usage Anaysis Processing. 2. The usage anaysis job is successfuy executed. You can check the job status in Centra Administration > Operations > Timer Job Status. Make sure the job is schedued to run daiy. 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 foder (specified in Centra Administration > Operations > Usage Anaysis Processing). To do that: To verify that the account used in Windows SharePoint Services Timer has read and write permissions for the SharePoint Logs foder, perform the foowing: 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 og in Centra Administration > Operations > Usage Anaysis Processing. 3. Make sure the account can create and edit a fie in the ogs foder. FAQ 166

167 Information Porta Detaied Reports (Site Coections, Sites, Documents, Lists, Document Libraries) Dispay Ony 20 Records. How to View a Resuts if the Number of Objects Exceeds this Limit? You can increase the number of the objects dispayed up to 200 on the Settings page. To view a compete ist of objects, export the report to a CSV fie. Then you can anayze, sort and fiter the report data in Exce. 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 dispay the size of a site incuding its sub-sites. The Sites report dispays the size of each site without its sub-sites. The tota size of a site incuding its sub-sites must be equa to the size dispayed in the Enterprise report. Genera idea of Information Porta reports is to dispay a key metrics for the seected site incuding its subsites. However, the Sites report is an exception. This report aows you to understand how the size and traffic are distributed among sites within the seected site coection. How to Cear Authorization Cache Because of the 5 minutes Authorization Cache used in Information Porta, a user whom you have just granted Site Coection Administrator or Site Owner privieges may not have access to Information Porta reports. To resove the issue either wait 5 minutes or cear the cache. To cear the cache, run the [ProductInstaPath]\SharePoint Information Porta\Scripts\cear_authorization_ cache.cmd fie. A rows in the AutorizationCache tabe of [ProductInstaPath]\SharePoint Information Porta\Appication\database\mode.db wi be removed. NOTE: You do not need to restart the services for the change to take effect. FAQ 167

168 How to Move Reporting Database to Another SQL Server 1. Cose Site Administrator Consoe. Ensure the Data Gathering process is stopped. 2. Use HKEY_LOCAL_MACHINE\SOFTWARE\AgreeYa 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\AgreeYa Software\SharePoint Manager or HKEY_LOCAL_ MACHINE\SOFTWARE\Wow6432Node\AgreeYa Software\SharePoint Manager in case of 64-bit OS, change the foowing vaues: StorageName - the database name (QSP_Repository, by defaut). StorageMachineName - the SQL instance name specified in the foowing format: computer nameinstance (e.g. satestxpsqexpress), or computer name for the defaut SQL instance. 5. In HKEY_LOCAL_MACHINE\SOFTWARE\AgreeYa Software\SharePoint Manager\Statistic Coector or HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\AgreeYa Software\SharePoint Manager\Statistic Coector in case of 64-bit OS, change the StorageName and StorageMachineName vaues. 6. Change the ServerName fied in the ShgReportingDatabases tabe in the QSP_Repository database. If the database name is changed, you can aso modify the DBName fied. This fied is reserved for future support of separate configuration and reporting databases. The ServerName vaue must be the same as StorageMachineName. 7. Change the foowing vaues in HKEY_LOCAL_MACHINE\SOFTWARE\AgreeYa Software\SharePoint Manager\ConfigSetAgent on every computer hosting poicy agent: StoreName - the database name (it shoud be the same as in StorageName). DataHost - the SQL server instance name (it shoud be the same as in StorageMachineName). How to View What Users are Using Site Administrator for SharePoint For this purpose, the Information Porta web service HTTP cas ogging can be used. To enabe it, add the foowing ines to the end of the apache configuration fie (SharePoint Information Porta\Python25\conf\httpd.conf): LogFormat "%h; %u; %t" common CustomLog../ogs/InfoPortaAccess.og common Restart the AgreeYa.InfoPorta.WebAccess service. In the InfoPortaAccess.og fie you wi find the user usage information. NOTE: Pay attention that the LogFormat string defines format for each ogging record. FAQ 168

169 How to Override Add Farm Behavior Site Administrator may not discover SharePoint servers in certain specific advanced configurations (hardware and software oad-baancers, SSL-enabed servers, etc.). Typica symptoms of this issue are the foowing: SharePoint Farm is not dispayed in the Enterprise report and Farms ist. Site Administrator for SharePoint aows you to override the defaut discovery process by providing correct bindings for your SharePoint servers. You shoud perform the foowing: 1. Create an XML fie with correct binding information for SharePoint web appications to be added. 2. Add Farm. Creating XML Fie with Correct Binding Information The binding fie (by defaut PreferredIISSettings.XML) contains binding information for SharePoint-extended IIS sites, which aows Site Administrator Discovery Wizard to access SharePoint web appications using the right addresses. When the binding fie is configured, the discovery engine uses the fie as foows: 1. Performs a search for the NetBIOS computer name in the binding fie (Host eements). 2. If the computer name is found in the fie, the discovery engine uses the binding settings from the matched Host eement to access SharePoint-extended IIS sites. 3. If the computer name is not found in the fie, the discovery engine reagreeyas bindings for its IIS sites directy from the IIS metabase on the computer. 4. Repeats the procedure for each computer in the discovery scope. The fie contains a bunch of the Host eements, each corresponding to a physica SharePoint front-end server computer. The Name attribute is the computer NetBIOS name. The Host eement contains one chid IISSRV eement for each SharePoint-extended IIS site. Each IISSRV eement defines correct bindings for the corresponding SharePoint web appication: Attribute ID Host Header Vaue The IIS site ID, i.e. W3SVC/ Host header string, i.e. extranet.bab.oca Port TCP port on which the site istens for HTTP reagreeyas, i.e. 80 SSL Port TCP port on which the site istens for HTTPS reagreeyas, i.e. 443 Comment Optiona comment for a site - used as the tite of the web appication in the Site Administrator consoe It is recommended to create a new fie using the EnumIISSites.exe utiity. The utiity is ocated in the C:\Program Fies\Common Fies\AgreeYa Soutions Shared foder. For each front-end server hosting SharePoint extended sites to be overriden in the binding fie, run the command ine utiity as foows: EnumIISSites.exe <computer name> The command ine shoud return Success!. NOTE: If errors occurred, make sure you have the oca administrator rights on the <computer name> server, or run the utiity ocay on this server. FAQ 169

170 A new Host eement wi be added to the PreferredIISSettings.xm fie ocated in the foder with the EnumIISSites.exe utiity. Next, remove non-sharepoint IISSRV eements in each Host eement and specify correct bindings in the attribute vaues. NOTE: Note that Host eement for the SharePoint Centra Administration site shoud aso be removed. Adding Farm Run Site Administrator and add the farm (see the Adding SharePoint Farms section). Specify one of your front-end SharePoint server computers specified in the XML binding fie. To check whether the discovery has appied the bindings, search the discovery og fie for the Reading preferred settings XML fie... ine. Information Porta Advanced Troubeshooting If some data are missing in Information Porta reports or these reports are not generated, pease anayze the foowing og fies: NOTE: [ProductInstaPath] is the product instaation foder. By defaut, the product is instaed to C:\Program Fies (x86)\agreeya Soutions\Site Administrator for SharePoint. 1. [ProductInstaPath]\Consoe\Logs QsSPDiscovery.og - the og fie of the Add Farm and Discovery SharePoint operations. If your farm is not dispayed in the search resuts or in the Enterprise report, try to add a farm and see this og for detais. 2. [ProductInstaPath]\SharePoint Information Porta\Logs setup.og - the og fie of the Information Porta instaation and un-instaation operations. WebReports.og - the og fie of the AgreeYa.InfoPorta.WebAccess service. This Apache service cas Django framework to render htm pages dispayed for users. httpd.og - the og fie of the AgreeYa.InfoPorta.WebAccess service. This Apache og may contain authentication issues. BrokerWorker.og - the pythonw.exe process created by the AgreeYa.InfoPorta.WebAccess service to coect the report data. This process cas oca AgreeYa.InfoPorta.SPBrowserBroker service via http and puts resuts to the.json fie in [ProductInstaPath]\SharePoint Information Porta\cache. SpBrowserBroker.og - the og fie of the AgreeYa.InfoPorta.SPBrowserBroker service. This service works with QSP_Repository, Active Directory and with oca or remote AgreeYa.InfoPorta.SPBrowserAgent via http. SpBrowserAgent.og - the og fie of the AgreeYa.InfoPorta.SPBrowserAgent service. This service works with SharePoint configuration and content database. It aso may work with Active Directory. AgreeYa.InfoPorta.ServiceMonitor.og - the og fie of AgreeYa.InfoPorta.ServiceMonitor service. This service monitors memory and handes consumption of other services. It restarts services if FAQ 170

171 they hande more than 2 GB of memory or handes. If the services crash by some reason, AgreeYa.InfoPorta.ServiceMonitor automaticay restarts them. A these actions are written to this og fie. 3. [ProductInstaPath]\SharePoint Information Porta\Logs JobsManager.og - the og fie for python.exe (run by the schedued task), which handes poicy jobs and one time actions from QSP_Repository and runs externa ipy64.exe. SpService.og - the og fie for ipy64.exe which is responsibe for appying changes to SharePoint. In some cases it may be necessary to enabe additiona ogging for more advanced troubeshooting. 1. To enabe debug ogging for a Information Porta services: a. Repace ERROR with DEBUG in the [ProductInstaPath]\SharePoint Information Porta\Logs\ogger.conf fie. b. Restart AgreeYa.InfoPorta.SPBrowserAgent, AgreeYa.InfoPorta.SPBrowserBroker and AgreeYa.InfoPorta.WebAccess services. c. Confirm the issue with enabed ogging and send a ogs to deveopers. 2. To enabe ogging of a HTTP cas to Information Porta web service, add the foowing ines to the end of the apache configuration fie (SharePoint Information Porta\Python25\conf\httpd.conf): LogFormat "%h % %u %t \"%r\" %>s %b %T" common CustomLog../ogs/access_og.og common The og wi be written to [ProductInstaPath]\SharePoint Information Porta\Logs\access_og.og. 3. If Information Porta page dispays the foowing error: perform the foowing: a. Repace the foowing ines in the [ProductInstaPath]\SharePoint Information Porta\Appication\settings.py fie: #DEBUG = True #TEMPLATE_DEBUG = DEBUG with: DEBUG = True TEMPLATE_DEBUG = DEBUG b. Restart the AgreeYa.InfoPorta.WebAccess service and refresh the page. The advanced troubeshooting page shoud be dispayed: FAQ 171

172 Send this page to deveopers if the error message is not hepfu. After troubeshooting, ro a the ogging back to the initia state. Otherwise, the size of the ogs may grow too much and affect the product performance. FAQ 172