Updates from: 06/07/2022 01:26:54
Service Microsoft Docs article Related commit history on GitHub Change details
SharePoint Sharepoint Azureb2b Integration https://github.com/MicrosoftDocs/OfficeDocs-SharePoint/commits/public/SharePoint/SharePointOnline/sharepoint-azureb2b-integration.md
To enable SharePoint and OneDrive integration with Azure AD B2B
## Disabling the integration
-You can disable the integration by running `Set-SPOTenant -EnableAzureADB2BIntegration $false`.
-Content that was shared externally while the integration was enabled will need to be shared again with those people.
+You can disable the integration by running '[Set-SPOTenant](/powershell/module/sharepoint-online/Set-SPOTenant?view=sharepoint-ps) -EnableAzureADB2BIntegration $false'.
+
+>[!Important]
+>Once disabled, users who were shared to while the integration was enabled will always be an AAD Guest User for future shares. To convert a user from an AAD Guest User back to a SharePoint OTP user, you will need to [delete the guest](/sharepoint/remove-users#delete-a-guest-from-the-microsoft-365-admin-center) in AAD and remove all SPUser objects in your organization that reference that guest user.
+>
## See also
SharePoint Best Practices For Backup And Restore https://github.com/MicrosoftDocs/OfficeDocs-SharePoint/commits/public/SharePoint/SharePointServer/administration/best-practices-for-backup-and-restore.md
Title: "Backup and restore best practices in SharePoint Server"-+
description: "Learn how to implement best practices before you back up and resto
# Backup and restore best practices in SharePoint Server [!INCLUDE[appliesto-2013-2016-2019-SUB-xxx-md](../includes/appliesto-2013-2016-2019-SUB-xxx-md.md)]
-
+ Best practices for backup and restore help make sure that backup and restore operations in SharePoint Server are successful and that the environment is protected against data loss or continuity gaps.
-
-
+ ## Performance best practices for SharePoint backup and restore operations <a name="section_perf"> </a> Backup and restore operations consume server resources and limit server performance while the operations are running. Follow these recommended practices to help reduce resource usage and increase the performance of servers and the backup or restore task.
-
+ ### Minimize latency between SQL Server and the backup location In general, it is efficient to back up to a local disk on the database server instead of a network drive. You can then copy the data later to a shared folder on the network. Network drives with 1 millisecond or less latency between them and the database server perform well.
-
+ > [!NOTE] > If you cannot back up to local drives, use network drives with similar latency. Because network backups are subject to network errors, verify the backup action after it finishes. For more information, see "Backing Up to a File on a Network Share" in [Backup Devices (SQL Server)](/sql/relational-databases/backup-restore/backup-devices-sql-server?viewFallbackFrom=sql-server-2014).
-
+ To avoid I/O bottlenecks, perform the main backup to a separate disk from the disk running SQL Servers 2017 RTM, 2016, 2014, 2012, or 2008 R2 with Service Pack 1 (SP1). For more information, see [Define a Logical Backup Device for a Disk File (SQL Server)](/sql/relational-databases/backup-restore/define-a-logical-backup-device-for-a-disk-file-sql-server?viewFallbackFrom=sql-server-2014).
-
+ By design, most backup jobs consume all available I/O resources to complete the job. Therefore, you might see disk queuing, which can result in greater than usual latency for I/O requests. This is typical and should not be considered a problem. For more information, see [Monitor Disk Usage](/sql/relational-databases/performance-monitor/monitor-disk-usage?viewFallbackFrom=sql-server-2014).
-
+ ### Avoid processing conflicts Do not run backup jobs during times when users need access to the system. Typically, systems run 24 hours a day, seven days a week. A best practice is to always run incremental backups to safeguard against server failure. Consider staggering backups so that all databases are not backed up at the same time.
-
+ ### Keep databases small for faster recovery times
-Keep databases small to speed both backup and restore. For example, use multiple content databases for a web application instead of one large content database. For more information, see [Database types and descriptions in SharePoint Server](../technical-reference/database-types-and-descriptions.md).
-
-For a graphical overview of the databases that support SharePoint Server 2016, see [Quick reference guide: SharePoint Server 2016 and 2019 databases](../technical-reference/technical-diagrams.md#sharepoint-servers-2016-and-2019-databases).
-
+Keep databases small to speed both backup and restore. For example, use multiple content databases for a web application instead of one large content database. For more information, see [Database types and descriptions in SharePoint Server](../technical-reference/database-types-and-descriptions.md).
+
+For a graphical overview of the databases that support SharePoint Server 2016, see [Quick reference guide: SharePoint Server 2016 and 2019 databases](../technical-reference/technical-diagrams.md#sharepoint-servers-2016-and-2019-databases).
+ ### Use incremental backups for large databases Use incremental backups for large databases because you can make them quickly and maintain performance of the environment. Although you can restore full backups faster than incremental backups, continuous incremental backups minimize data loss. For more information about types of backups, see [Backup Overview (SQL Server)](/sql/relational-databases/backup-restore/backup-overview-sql-server?viewFallbackFrom=sql-server-2014).
-
+ ### Use compression during backup In some circumstances, you can use compression to decrease the size of backups and the time to complete each backup. Backup compression was introduced in SQL Server 2008 Enterprise. Backup compression increases CPU usage and this can affect SQL Server concurrent operations.
-
+ > [!IMPORTANT]
-> SharePoint Server supports SQL Server backup compression. SQL Server data compression is not supported for SharePoint Server databases.
-
+> SharePoint Server supports SQL Server backup compression. SQL Server data compression is not supported for SharePoint Server databases.
+ For more information about how backup compression affects performance in SQL Server, see [Backup Compression (SQL Server)](/sql/relational-databases/backup-restore/backup-compression-sql-server?viewFallbackFrom=sql-server-2014).
-
+ ### Follow SQL Server backup and restore optimization recommendations SQL Server backups use a combination of full, differential, and transaction log backups (for the full or bulk-logged recovery model) to minimize recovery time. Differential database backups are usually faster to create than full database backups and reduce the number of transaction logs required to recover the database.
-
-If you are using the full recovery model, we recommend that you periodically truncate the transaction log files to avoid maintenance issues.
-
+
+If you are using the full recovery model, we recommend that you periodically truncate the transaction log files to avoid maintenance issues.
+ For detailed recommendations about how to optimize SQL Server backup and restore performance, see [Optimizing Backup and Restore Performance in SQL Server](/previous-versions/sql/sql-server-2008-r2/ms190954(v=sql.105)).
-
+ ### Use RAID 10 if you use RAID Carefully consider whether to use redundant array of independent disks (RAID) on the device to which you back up data. For example, RAID 5 has slow write performance, approximately the same speed as for a single disk. This is because RAID 5 has to maintain parity information. RAID 10 can provide faster backups because it doesn't need to manage parity. Therefore, it reads and writes data faster. For more information about how to use RAID with backups, see [Configure RAID for maximum SQL Server I/O throughput](https://go.microsoft.com/fwlink/p/?LinkId=126632 ) and [RAID Levels and SQL Server](/previous-versions/sql/sql-server-2008-r2/ms190764(v=sql.105)).
-
+ ### Configure SharePoint settings to improve backup or restore performance You can only configure file compression and log file settings in PowerShell. You can configure backup and restore threads in both the SharePoint Central Administration website and PowerShell to increase backup or restore efficiency and performance.
-
-If you use the `Export-SPWeb` PowerShell cmdlet, you can use the `NoFileCompression` parameter. By default, SharePoint Server uses file compression while exporting web applications, site collection, lists, or document libraries. You can use this parameter to suppress file compression while exporting and importing. File compression can use up to 30% more resources. However, the exported file uses approximately 25% less disk space. If you use the `NoFileCompression` parameter when you export, you have to also use it when you import the same content.
-
-You can also use the `NoLogFile` parameter. By default, SharePoint Server always creates a log file when you export content. Although you can use this parameter to suppress log file creation to save resources, we recommend that you always create logs. Logs are important for troubleshooting and log creation does not use many resources such as CPU or memory.
-
-When you use the `Backup-SPFarm` cmdlet, you can also use the `BackupThreads` parameter to specify how many threads SharePoint Server will use during the backup process. A higher number of threads will consume more resources during backup. But the overall time to make the backup is decreased. Because each thread is recorded in the log files, the number of threads does affect log file interpretation. By default, three threads are used. The maximum number of available threads is 10.
-
+
+If you use the `Export-SPWeb` PowerShell cmdlet, you can use the `NoFileCompression` parameter. By default, SharePoint Server uses file compression while exporting web applications, site collection, lists, or document libraries. You can use this parameter to suppress file compression while exporting and importing. File compression can use up to 30% more resources. However, the exported file uses approximately 25% less disk space. If you use the `NoFileCompression` parameter when you export, you have to also use it when you import the same content.
+
+You can also use the `NoLogFile` parameter. By default, SharePoint Server always creates a log file when you export content. Although you can use this parameter to suppress log file creation to save resources, we recommend that you always create logs. Logs are important for troubleshooting and log creation does not use many resources such as CPU or memory.
+
+When you use the `Backup-SPFarm` cmdlet, you can also use the `BackupThreads` parameter to specify how many threads SharePoint Server will use during the backup process. A higher number of threads will consume more resources during backup. But the overall time to make the backup is decreased. Because each thread is recorded in the log files, the number of threads does affect log file interpretation. By default, three threads are used. The maximum number of available threads is 10.
+ > [!NOTE]
-> The backup threads setting is also available through Central Administration on the **Default Backup and Restore Settings** page in the **Backup and Restore** section.
-
+> The backup threads setting is also available through Central Administration on the **Default Backup and Restore Settings** page in the **Backup and Restore** section.
+ ### Consider site collection size when you determine the tools to use If the business requires site collection backups in addition to farm-level or database-level backups, choose a backup tool that is based on the size of the site collection.
-
-- **15-100 GB**: Usethe `Backup-SPSite`, a SharePoint Server tool, a SQL Server tool, or other database backup tool to protect the content database that contains the site collection. For more information, see [Back up site collections in SharePoint Server](back-up-site-collections.md).
-
-- **Larger than 100 GB**: Use a differential backup solution, such as SQL Server or System Center Data Protection Manager R2, instead of the built-in backup and recovery tools.
-
+
+- **15-100 GB**: Use the `Backup-SPSite`, a SharePoint Server tool, a SQL Server tool, or other database backup tool to protect the content database that contains the site collection. For more information, see [Back up site collections in SharePoint Server](back-up-site-collections.md).
+
+- **Larger than 100 GB**: Use a differential backup solution, such as SQL Server or System Center Data Protection Manager R2, instead of the built-in backup and recovery tools.
+ ## Quality assurance best practices to back up a SharePoint farm <a name="section_QA"> </a> Follow these best practices to help ensure the quality of the backups of the farm environment and reduce the chances of data loss.
-
+ ### Ensure you have enough storage space Be certain that the system has enough disk space to accommodate the backup. Configure a backup job in Central Administration to verify the required disk space.
-
+ ### Routinely test backup quality Routinely test backups and validate their consistency. Run practice recovery operations to validate the contents of the backup and to make sure that you can restore the complete environment. To prepare for disaster recovery of geographically dispersed environments, set up a remote farm. Then you can restore the environment by using the database-attach method to upload a copy of the database to the remote farm and redirect users. Periodically perform a trial data recovery action to verify that the process correctly backs up files. A trial restoration can expose hardware problems that do not come up with software verifications and can also to make sure that the recovery time objectives (RTO) are met.
-
+ ### Back up ULS trace logs The SharePoint Server backup process doesn't back up the Unified Logging Service (ULS) trace logs. Data in ULS trace logs can be useful for performance analysis, troubleshooting, and monitoring compliance with service level agreements. Therefore, protect this data as part of the routine maintenance.
-
+ By default, SharePoint log files are at C:\Program files\Common Files\Microsoft Shared\Web Server Extensions\\<16 or 15\>\Logs. The files are named with the server name followed by the date and time stamp. The SharePoint trace logs are created at set intervals and when you use the IISRESET command.
-
+ ### Store a copy of backup files off-site To safeguard against loss from a natural disaster that destroys the primary data center, maintain duplicate copies of backups in separate locations from the servers. Duplicate copies can help prevent the loss of critical data. As a best practice, keep three copies of the backup media, and keep at least one copy offsite in a controlled environment. This should include all backup and recovery materials, documents, database and transaction log backups, and usage and trace log backups.
-
+ ## Procedural best practices to back up and restore SharePoint Server <a name="section_PROC"> </a> Use the following procedural best practices to plan and perform backup and restore operations.
-
+ ### Use FQDN server names When you refer to servers in a different domain, always use fully qualified domain names (FQDN).
-
+ ### Keep accurate records
-When you deploy SharePoint Server, record the accounts that you create, the computer names, passwords, and setup options. Keep this information in a safe and secure location. Possibly, keep multiple records to make sure this information is always available.
-
+When you deploy SharePoint Server, record the accounts that you create, the computer names, passwords, and setup options. Keep this information in a safe and secure location. Possibly, keep multiple records to make sure this information is always available.
+ ### Have a recovery environment ready Use a farm in a secondary location to validate the success of restore operations as part of your disaster recovery strategy. For more information, see [Choose a disaster recovery strategy for SharePoint Server](plan-for-disaster-recovery.md). In a disaster recovery situation, you can then restore the environment by using the database-attach method to upload a copy of the database to the remote farm and redirect users. For more information, review and follow the steps in [Restore farms in SharePoint Server](restore-a-farm.md). Also for a high availability solution, you can set up a standby environment that runs the same version of software as the production environment so that you can restore the databases and recover documents quickly. For more information, see [Describing high availability](high-availability-and-disaster-recovery-concepts.md#DescHA).
-
+ ### Schedule backup operations Use PowerShell backup and recovery cmdlets to create a script file (\*.ps1) and then schedule it to run with Windows Task Scheduler. This makes sure that all backup operations are run at the best time when the system is least busy and users are not accessing it. For more information, see the following:
-
+ - [Running Scripts](/previous-versions//bb613481(v=vs.85))
-
+ - [Backup and recovery cmdlets in SharePoint Server 2016](/powershell/module/sharepoint-server/?view=sharepoint-ps&preserve-view=true)
-
+ ### Use the SQL FILESTREAM provider with BLOB storage Remote BLOB Storage (RBS) is supported in a SharePoint Server farm. There are both pros and cons associated with using RBS in SharePoint Server. One related limitation of RBS with a SharePoint farm is that System Center Data Protection Manager cannot use the FILESTREAM provider to back up or restore RBS. SharePoint Server supports the FILESTREAM provider for backup and restore operations. A benefit of RBS with a SharePoint farm is that you can use either SharePoint tools or SQL Server tools to back up and restore the content database with the Remote BLOB Store (RBS) defined. This backs up and restores both the RBS and the content database. We do not recommend that you use RBS with other restore methods. For more information about the benefits and limitations of using RBS, see [Deciding to use RBS in SharePoint Server](rbs-planning.md). Download [Microsoft SQL Server 2014 Feature Pack](https://go.microsoft.com/fwlink/p/?LinkID=733635&amp;clcid=0x409)that includes RBS.
-
-> [!NOTE]
-> SharePoint Server 2019 supports the FILESTREAM provider that is included with SQL Server 2017. SharePoint Server 2016 supports the FILESTREAM provider that is included with SQL Server 2014. For more information, see [Enable and Configure FILESTREAM](/sql/relational-databases/blob/enable-and-configure-filestream?viewFallbackFrom=sql-server-2014).
-
+ > [!NOTE]
-> SharePoint Server 2013 supports the FILESTREAM provider that is included in the [Microsoft® SQL Server® 2008 R2 Feature Pack](https://go.microsoft.com/fwlink/p/?LinkID=177388). The SQL Server 2012 and SQL Server 2014 installation media includes RBS as an optional add-on component.
-
+> SharePoint Server 2019 supports the FILESTREAM provider that is included with SQL Server 2017. SharePoint Server 2016 supports the FILESTREAM provider that is included with SQL Server 2014. For more information, see [Enable and Configure FILESTREAM](/sql/relational-databases/blob/enable-and-configure-filestream?viewFallbackFrom=sql-server-2014).
+>
+> SharePoint Server 2013 supports the FILESTREAM provider that is included in the [Microsoft® SQL Server® 2008 R2 Feature Pack](https://go.microsoft.com/fwlink/p/?LinkID=177388). The SQL Server 2012 and SQL Server 2014 installation media includes RBS as an optional add-on component.
+ ## See also <a name="section_PROC"> </a>
-#### Concepts
+### Concepts
[Overview of backup and recovery in SharePoint Server](backup-and-recovery-overview.md)
-
+ [Plan for backup and recovery in SharePoint Server](backup-and-recovery-planning.md)
-
+ [Prepare to back up and restore farms in SharePoint Server](prepare-to-back-up-and-restore.md)
-#### Other Resources
-[Transparent Data Encryption](https://social.technet.microsoft.com/wiki/contents/articles/34201.configuring-tde-in-sharepoint-content-databases.aspx)
+### Other Resources
+
+[Transparent Data Encryption](https://social.technet.microsoft.com/wiki/contents/articles/34201.configuring-tde-in-sharepoint-content-databases.aspx)
SharePoint Best Practices For Sql Server In A Sharepoint Server Farm https://github.com/MicrosoftDocs/OfficeDocs-SharePoint/commits/public/SharePoint/SharePointServer/administration/best-practices-for-sql-server-in-a-sharepoint-server-farm.md
Title: "Best practices for SQL Server in a SharePoint Server farm"-+
description: "Learn how to implement best practices for SQL Server in a SharePoi
# Best practices for SQL Server in a SharePoint Server farm
-
+ When you configure and maintain SharePoint Server 2016 and 2019 relational databases on SQL Server 2014 with Service Pack 1 (SP1), SQL Server 2016, or SQL Server 2017 RTM, you have to choose options that promote performance and security. Likewise, you have to choose options that promote performance and security when you configure and maintain SharePoint Server 2013 relational databases on SQL Server 2008 R2 with Service Pack 1 (SP1), SQL Server 2012, and SQL Server 2014.
-
-The best practices in this article are ordered based on the sequence in which they would apply, from installing and configuring SQL Server, to deploying SharePoint Server, and then maintaining the farm. Most of the practices apply to all versions of SQL Server. Practices that are unique to SQL Server versions are shown in separate sections.
-
+
+The best practices in this article are ordered based on the sequence in which they would apply, from installing and configuring SQL Server, to deploying SharePoint Server, and then maintaining the farm. Most of the practices apply to all versions of SQL Server. Practices that are unique to SQL Server versions are shown in separate sections.
+ > [!NOTE]
-> If you plan to use SQL Server Business Intelligence components in a SharePoint Server 2016 farm you must use SQL Server 2016 CTP 3.1 or later. You can now download SQL Server 2016 CTP 3.1 or later to use the SQL Server Power Pivot for SharePoint add-in. You can also use Power View by installing SQL Server Reporting Services (SSRS) in SharePoint-integrated mode and the SSRS front-end add-in from the SQL Server installation media.
-
+> If you plan to use SQL Server Business Intelligence components in a SharePoint Server 2016 farm you must use SQL Server 2016 CTP 3.1 or later. You can now download SQL Server 2016 CTP 3.1 or later to use the SQL Server Power Pivot for SharePoint add-in. You can also use Power View by installing SQL Server Reporting Services (SSRS) in SharePoint-integrated mode and the SSRS front-end add-in from the SQL Server installation media.
+ For more information, download the new [Deploying SQL Server 2016 PowerPivot and Power View in SharePoint 2016](https://go.microsoft.com/fwlink/p/?LinkID=717977&amp;clcid=0x409) white paper. For details about configuring and deploying business intelligence in a multiple server SharePoint Server 2016 farm, download [Deploying SQL Server 2016 PowerPivot and Power View in a Multi-Tier SharePoint 2016 Farm](/sql/sql-server/install/install-sql-server-business-intelligence-features).
-
+ > [!NOTE]
-> If you plan to use SQL Server Business Intelligence components in a SharePoint Server 2013 farm you must use SQL Server 2012 with Service Pack 1 (SP1) or SQL Server 2014. For information about SQL Server 2012 with SP1 BI and SharePoint Server 2013, see [Install SQL Server BI Features with SharePoint 2013 (SQL Server 2012 SP1)](/previous-versions/sql/sql-server-2012/jj218795(v=sql.110)). For more information about SQL Server 2014 and SharePoint Server 2013, see [Install SQL Server 2014 Business Intelligence Features](/sql/sql-server/install/install-sql-server-business-intelligence-features).
-
+> If you plan to use SQL Server Business Intelligence components in a SharePoint Server 2013 farm you must use SQL Server 2012 with Service Pack 1 (SP1) or SQL Server 2014. For information about SQL Server 2012 with SP1 BI and SharePoint Server 2013, see [Install SQL Server BI Features with SharePoint 2013 (SQL Server 2012 SP1)](/previous-versions/sql/sql-server-2012/jj218795(v=sql.110)). For more information about SQL Server 2014 and SharePoint Server 2013, see [Install SQL Server 2014 Business Intelligence Features](/sql/sql-server/install/install-sql-server-business-intelligence-features).
+ > [!IMPORTANT]
-> Best practices in this article apply to the Relational Database Management System (RDBMS) of SQL Server with SharePoint Server.
-
+> Best practices in this article apply to the Relational Database Management System (RDBMS) of SQL Server with SharePoint Server.
+ ## Use a dedicated server for SQL Server To ensure optimal performance for farm operations, we recommend that you install SQL Server on a dedicated server that does not run other farm roles and does not host databases for other applications. The only exception is deployment of SharePoint Server 2016 or 2019 in a Single-Server farm role or SharePoint 2013 on a stand-alone server, which is meant for development or testing, and is not recommended for production use. For more information, see [Description of MinRole and associated services in SharePoint Servers 2016 and 2019](description-of-minrole-and-associated-services-in-sharepoint-server-2016.md) and [Install SharePoint Servers 2016 or 2019 on one server](../install/install-sharepoint-server-2016-on-one-server.md).
-
+ > [!NOTE]
-> The recommendation to use a dedicated server for relational databases also applies to deploying SQL Server in virtual environments.
-
+> The recommendation to use a dedicated server for relational databases also applies to deploying SQL Server in virtual environments.
+ ## Configure specific SQL Server settings before you deploy SharePoint Server
-To ensure consistent behavior and performance, configure the following options and settings before you deploy SharePoint Server.
+To ensure consistent behavior and performance, configure the following options and settings before you deploy SharePoint Server.
- Due to potential performance issues with maintaining multiple SQL instances, we recommend that you use a single instance of SQL Server per deployed database server.
-
+ - Do not enable auto-create statistics on SharePoint content databases. Enabling auto-create statistics is not supported for SharePoint Server. SharePoint Server configures the required settings during provisioning and upgrade. Manually enabling auto-create statistics on a SharePoint database can significantly change the execution plan of a query. The SharePoint databases either use a stored procedure that maintains the statistics (proc_UpdateStatistics) or rely on SQL Server to do this. - For SharePoint Server 2013, Maintenance Plans are managed by SharePoint:
- - SQL statistics are managed by the health rule ΓÇ£Databases used by SharePoint have outdated index statisticsΓÇ¥ that calls proc_updatestatics
- - Content databases have the Auto Update Statistics property set to **False**
-
+ - SQL statistics are managed by the health rule "Databases used by SharePoint have outdated index statistics" that calls proc_updatestatics
+ - Content databases have the Auto Update Statistics property set to **False**
+ - For SharePoint Servers 2016 and 2019, SQL administrator must create [Maintenance Plans](/sql/relational-databases/maintenance-plans/maintenance-plans?view=sql-server-2017&preserve-view=true) for SharePoint content databases:
- - SQL statistics are not managed by the health rule ΓÇ£Databases used by SharePoint have outdated index statisticsΓÇ¥
- - Content databases have the Auto Update Statistics property set to **True** `
+ - SQL statistics are not managed by the health rule "Databases used by SharePoint have outdated index statistics"
+ - Content databases have the Auto Update Statistics property set to **True** `
+
+- Set max degree of parallelism (MAXDOP) to 1 for instances of SQL Server that host SharePoint databases to make sure that a single SQL Server process serves each request.
-- Set max degree of parallelism (MAXDOP) to 1 for instances of SQL Server that host SharePoint databases to make sure that a single SQL Server process serves each request.
-
> [!IMPORTANT]
- > Setting the max degree of parallelism to any other number can cause a less optimal query plan to be used that will decrease SharePoint Server performance.
-
+ > Setting the max degree of parallelism to any other number can cause a less optimal query plan to be used that will decrease SharePoint Server performance.
+ - To help simplify maintenance, such as to make it easier to move databases to another server, create DNS aliases that point to the IP address for all instances of SQL Server. For more information about DNS or Hostname aliases, see [How to Add a Hostname Alias for a SQL Server Instance](https://go.microsoft.com/fwlink/p/?LinkID=279159).
-
-For more information about these SQL Server settings and options, see [Set SQL Server options](storage-and-sql-server-capacity-planning-and-configuration.md#Section6_3).
+For more information about these SQL Server settings and options, see [Set SQL Server options](storage-and-sql-server-capacity-planning-and-configuration.md#Section6_3).
-
## Harden the database server before you deploy SharePoint Server We recommend that you plan for, and harden the database server before you deploy SharePoint Server. For more information, see:
-
+ - [Securing SQL Server](/sql/relational-databases/security/securing-sql-server)
-
+ - [Configure SQL Server security for SharePoint Server](../security-for-sharepoint-server/configure-sql-server-security-for-sharepoint-environments.md)
-
+ - [Securing SharePoint: Harden SQL Server in SharePoint Environments](/archive/blogs/rycampbe/securing-sharepoint-harden-sql-server-in-sharepoint-environments)
-
+ - [Security Center for SQL Server Database Engine and Azure SQL Database](/sql/relational-databases/security/security-center-for-sql-server-database-engine-and-azure-sql-database)
-
+ ## Configure database servers for performance and availability As is the case with front-end servers and application servers, the configuration for database servers affects how well SharePoint Server performs. Some databases have to be on the same server as other databases. Conversely, some databases cannot be on the same server as other databases. For more information, see [Description of MinRole and associated services in SharePoint Servers 2016 and 2019](description-of-minrole-and-associated-services-in-sharepoint-server-2016.md) and [Storage and SQL Server capacity planning and configuration (SharePoint Server)](storage-and-sql-server-capacity-planning-and-configuration.md).
-
+ For guidance about highly available databases that use mirroring, see [Database Mirroring (SQL Server)](/sql/database-engine/database-mirroring/database-mirroring-sql-server?viewFallbackFrom=sql-server-2014).
-
+ ### SQL Server Failover Clustering and Always On Availability Groups SQL Server 2012 introduced the AlwaysOn Availability Groups feature. This feature is a high availability and disaster recovery solution that's an alternative to database mirroring and log shipping solutions. AlwaysOn Availability Groups now support up to nine availability replicas.
-
+ > [!NOTE]
-> Database mirroring will be deprecated in future versions of SQL Server. We recommend using Always On Availability Groups.
-
+> Database mirroring will be deprecated in future versions of SQL Server. We recommend using Always On Availability Groups.
+ AlwaysOn Availability Groups require a Windows Server Failover Clustering (WSFC) cluster. A WSFC resource group is created for every availability group that is created. For more information, see the following resources:
-
+ - [AlwaysOn Availability Groups (SQL Server)](/sql/database-engine/availability-groups/windows/always-on-availability-groups-sql-server?viewFallbackFrom=sql-server-2014)
-
+ - [Overview of AlwaysOn Availability Groups (SQL Server)](/sql/database-engine/availability-groups/windows/overview-of-always-on-availability-groups-sql-server)
-
+ - [Failover Clustering and Always On Availability Groups (SQL Server)](/sql/database-engine/availability-groups/windows/failover-clustering-and-always-on-availability-groups-sql-server)
-
+ - [Configure SQL Server AlwaysOn Availability Groups for SharePoint Server](configure-an-alwayson-availability-group.md)
-
+ ## Design storage for optimal throughput and manageability We recommend that you separate, and prioritize your data among the drives on the database server. Ideally, you should place the tempdb database, content databases, usage database, search databases, and transaction logs on separate physical hard disks. The following list provides some guidance. For more information, see [Configure databases](storage-and-sql-server-capacity-planning-and-configuration.md#Section6_5).
-
+ - For collaboration or update-intensive sites, use the following ranking for storage distribution.
-
- The highest ranked item should be in the fastest drives.
-
- | Rank | Item |
-| :-- | :-- |
-| 1 | tempdb data files and transaction logs |
-| 2 | Content database transaction log files |
-| 3 | Search databases, except for the Search administration database |
-| 4 |Content database data files |
-
+
+ The highest ranked item should be in the fastest drives.
+
+ |Rank|Item|
+ |||
+ |1|tempdb data files and transaction logs|
+ |2|Content database transaction log files|
+ |3|Search databases, except for the Search administration database|
+ |4|Content database data files|
+ - In a heavily read-oriented portal site, prioritize data and search over transaction logs as follows.
-
+ The highest ranked item should be in the fastest drives.
-
- | Rank | Item |
-| :-- | :-- |
-| 1 | tempdb data files and transaction logs |
-| 2 | Content database data files |
-| 3 | Search databases, except for the Search administration database |
-| 4 | Content database transaction log files |
-
-
+
+ |Rank|Item|
+ |||
+ |1|tempdb data files and transaction logs|
+ |2|Content database data files|
+ |3|Search databases, except for the Search administration database|
+ |4|Content database transaction log files|
+ - Testing and user data shows that insufficient disk I/O for tempdb can significantly impede overall farm performance. To avoid this issue, allocate dedicated disks for the drive that stores tempdb data files.
-
+ - For best performance, use a RAID 10 array for the drive that stores tempdb data files. The number of tempdb data files should equal the number of CPU cores, and each tempdb data file should be set to the same size.
-
+ - Separate database data and transaction log files across different disks. If data and log files must share disks due to space limitations, put files that have different usage patterns on the same disk to minimize concurrent access requests.
-
+ - Use multiple data files for heavy-use content databases, and put each on its own disk
-
+ - To improve manageability, monitor and make adjustments as needed to keep content databases below 200 GB, rather than restrict the database size.
-
+ > [!NOTE]
- > If you manually restrict database size in SQL Server, you can cause unexpected system downtime when the capacity is exceeded.
-
+ > If you manually restrict database size in SQL Server, you can cause unexpected system downtime when the capacity is exceeded.
+ Proper configuration of I/O subsystems is very important to the optimal performance and operation of SQL Server systems. For more information, see [Monitoring Disk Usage](https://social.technet.microsoft.com/wiki/contents/articles/3214.monitoring-disk-usage.aspx)
-
+ > [!TIP]
-> Consider that how you measure disk speed varies between data files and log files. The fastest drives for database data may not be the fastest for log files. Consider usage patterns, I/O, and file size.
-
+> Consider that how you measure disk speed varies between data files and log files. The fastest drives for database data may not be the fastest for log files. Consider usage patterns, I/O, and file size.
+ ## Proactively manage the growth of data and log files Following are recommendations to proactively manage the growth of data and log files:
-
-- When possible, increase all data files and log files to their expected final size, or periodically increase these at set periods, for example, every month or every six months, or before rollout of a new storage-intensive site such as during file migrations.
-
-- Enable database autogrowth as a protective measure to make sure that you do not run out of space in data and log files. Consider the following:
-
+
+- When possible, increase all data files and log files to their expected final size, or periodically increase these at set periods, for example, every month or every six months, or before rollout of a new storage-intensive site such as during file migrations.
+
+- Enable database autogrowth as a protective measure to make sure that you do not run out of space in data and log files. Consider the following:
+ > [!IMPORTANT]
- > You must factor in the performance and operations issues associated with using autogrowth. For more information, see [Considerations for the "autogrow" and "autoshrink" settings in SQL Server](/troubleshoot/sql/admin/considerations-autogrow-autoshrink).
-
+ > You must factor in the performance and operations issues associated with using autogrowth. For more information, see [Considerations for the "autogrow" and "autoshrink" settings in SQL Server](/troubleshoot/sql/admin/considerations-autogrow-autoshrink).
+ - The default settings for a new database are to grow by 1 MB increments. Because this default setting for autogrowth results in increases in the size of the database, do not rely on the default setting. Instead, use the guidance provided in [Set SQL Server options](storage-and-sql-server-capacity-planning-and-configuration.md#Section6_3).
-
- - Set autogrowth values to a fixed number of megabytes instead of to a percentage. The bigger the database, the bigger the growth increment should be.
-
+
+ - Set autogrowth values to a fixed number of megabytes instead of to a percentage. The bigger the database, the bigger the growth increment should be.
+ > [!NOTE]
- > Use care when you set the autogrowth feature for SharePoint databases. If you set a database to autogrow as a percentage, for example at a 10-percent (%) growth rate, a database that is 5 GB grows by 500MB every time that a data file has to be expanded. In this scenario, you could run out of disk space.
-
- Consider for example, a scenario where content is gradually increased, say at 100MB increments, and autogrowth is set at 10MB. Then suddenly a new document management site requires a very large amount of data storage, perhaps with initial size of 50 GB. For this large addition, growth at 500 MB increments is more appropriate than 10MB increments.
-
+ > Use care when you set the autogrowth feature for SharePoint databases. If you set a database to autogrow as a percentage, for example at a 10-percent (%) growth rate, a database that is 5 GB grows by 500MB every time that a data file has to be expanded. In this scenario, you could run out of disk space.
+
+ Consider for example, a scenario where content is gradually increased, say at 100MB increments, and autogrowth is set at 10MB. Then suddenly a new document management site requires a very large amount of data storage, perhaps with initial size of 50 GB. For this large addition, growth at 500 MB increments is more appropriate than 10MB increments.
+ - For a managed production system, consider autogrowth to be merely a contingency for unexpected growth. Do not use the autogrow option to manage your data and log growth on a day-to-day basis. Instead, set the autogrowth to allow for an approximate size in one year and then add a 20 percent margin for error. Also set an alert to notify you when the database runs low on space or approaches a maximum size.
-
+ - Maintain a level of at least 25 percent available space across drives to accommodate growth and peak usage patterns. If you add drives to a RAID array or allocate more storage to manage, monitor capacity closely to avoid running out of space.
-
+ ## Continuously monitor SQL Server storage and performance
-We recommend that you continuously monitor SQL Server storage and performance to make sure that each production database server is adequately handling the load put on it. Additionally, continuous monitoring enables you to establish benchmarks that you can use for resource planning.
-
+We recommend that you continuously monitor SQL Server storage and performance to make sure that each production database server is adequately handling the load put on it. Additionally, continuous monitoring enables you to establish benchmarks that you can use for resource planning.
+ Take a comprehensive view of resource monitoring. Do not limit monitoring to resources that are specific to SQL Server. It is equally important to track the following resources on computers that are running SQL Server: CPU, memory, cache/hit ratio, and the I/O subsystem.
-
+ When one or more of the server resources seems slow or overburdened, consider the following performance guidelines based on the current and projected workload.
-
+ - [Monitor and Tune for Performance](/sql/relational-databases/performance/monitor-and-tune-for-performance?viewFallbackFrom=sql-server-2014)
-
+ - [Performance Monitoring and Tuning Tools](/sql/relational-databases/performance/performance-monitoring-and-tuning-tools)
-
+ - [Server Performance and Activity Monitoring](/sql/relational-databases/performance/server-performance-and-activity-monitoring)
-
+ - [Windows Performance Monitor](/previous-versions/windows/it-pro/windows-server-2008-R2-and-2008/cc749249(v=ws.11))
-
+ ## Use backup compression to speed up backups and reduce file sizes Backup compression can speed up SharePoint backup operations. It is available in SQL Server Standard and Enterprise Edition. If you set the compression option in your backup script or configure SQL Server to compress by default, you can significantly reduce the size of your database backups and shipped logs. For more information, see [Backup Compression (SQL Server)](/sql/relational-databases/backup-restore/backup-compression-sql-server?viewFallbackFrom=sql-server-2014) and [Data Compression](/sql/relational-databases/data-compression/data-compression?viewFallbackFrom=sql-server-2014), or [Enable Compression on a Table or Index](/sql/relational-databases/data-compression/enable-compression-on-a-table-or-index?viewFallbackFrom=sql-server-2014)
-
+ ## Acknowledgements The SharePoint Server Content Publishing team thanks the following contributors to this article:
-
+ - Kay Unkroth, Senior Program Manager, SQL Server
-
+ - Chuck Heinzelman, Senior Program Manager, SQL Server
-
+ ## See also
-#### Concepts
+### Concepts
[Overview of SQL Server in SharePoint Server 2016 and 2019 environments](overview-of-sql-server-in-sharepoint-server-2016-and-2019-environments.md)
-
+ [Storage and SQL Server capacity planning and configuration (SharePoint Server)](storage-and-sql-server-capacity-planning-and-configuration.md)
-#### Other Resources
+### Other Resources
-[Securing SharePoint: Harden SQL Server in SharePoint Environments](/archive/blogs/rycampbe/securing-sharepoint-harden-sql-server-in-sharepoint-environments)
+[Securing SharePoint: Harden SQL Server in SharePoint Environments](/archive/blogs/rycampbe/securing-sharepoint-harden-sql-server-in-sharepoint-environments)
SharePoint Configure Search Web Parts https://github.com/MicrosoftDocs/OfficeDocs-SharePoint/commits/public/SharePoint/SharePointServer/administration/configure-search-web-parts.md
Title: "Configure Search Web Parts in SharePoint Server"-+
description: "Learn how to configure the different Web Parts that use search tec
# Configure Search Web Parts in SharePoint Server [!INCLUDE[appliesto-2013-2016-2019-xxx-md](../includes/appliesto-2013-2016-2019-xxx-md.md)]
-
-Web Parts that use search technology to show content in a publishing environment (referred to in this article as Search Web Parts) show content that was crawled and added to the search index, as described in "Understanding how content is added to and managed in the search index" in [Overview of cross-site publishing in SharePoint Server](overview-of-cross-site-publishing.md). These Web Parts have queries defined in them, and when users browse to a page that contains a Web Part that uses search technology, the Web Part issues the query automatically. The query result is then displayed in the Web Part. You can modify the query in the search Web Part to fit your content needs.
-
-
+
+Web Parts that use search technology to show content in a publishing environment (referred to in this article as Search Web Parts) show content that was crawled and added to the search index, as described in "Understanding how content is added to and managed in the search index" in [Overview of cross-site publishing in SharePoint Server](overview-of-cross-site-publishing.md). These Web Parts have queries defined in them, and when users browse to a page that contains a Web Part that uses search technology, the Web Part issues the query automatically. The query result is then displayed in the Web Part. You can modify the query in the search Web Part to fit your content needs.
+ ## Before you begin <a name="BKMK_AvailableOOTRefiners"> </a> > [!NOTE]
-> Because SharePoint Server runs as websites in Internet Information Services (IIS), administrators and users depend on the accessibility features that browsers provide. SharePoint Server supports the accessibility features of supported browsers. For more information, see the following resources: > [Plan browser support](../install/browser-support-planning-2016-2019.md)> [Accessibility guidelines in SharePoint](../accessibility-guidelines.md)> [Accessibility in SharePoint](/sharepoint/dev/general-development/accessibility-in-sharepoint)> [Keyboard shortcuts](https://support.office.com/article/466e33ee-613b-4f47-96bb-1c20f20b1015)> [Touch](/windows/win32/wintouch/windows-touch-gestures-overview).
-
+> Because SharePoint Server runs as websites in Internet Information Services (IIS), administrators and users depend on the accessibility features that browsers provide. SharePoint Server supports the accessibility features of supported browsers. For more information, see the following resources: > [Plan browser support](../install/browser-support-planning-2016-2019.md)> [Accessibility guidelines in SharePoint](../accessibility-guidelines.md)> [Accessibility in SharePoint](/sharepoint/dev/general-development/accessibility-in-sharepoint)> [Keyboard shortcuts](https://support.office.com/article/466e33ee-613b-4f47-96bb-1c20f20b1015)> [Touch](/windows/win32/wintouch/windows-touch-gestures-overview).
+ There are many Search Web Parts available in SharePoint Server. These Web Parts have predefined queries, such as what type of content to search for, where to search for content, and how to show content. For information about different Search Web Parts, see "Plan to add search Web Parts to pages" in [Plan publishing sites for cross-site publishing in SharePoint Server](plan-sharepoint-publishing-sites-for-cross-site-publishing.md). Many of the Search Web Parts use result sources and have query rules that are applied to them. Result sources narrow the scope of search results that are retrieved. A query rule is a set of conditions that will cause the query to be changed in a specific way. For more information about result sources and query rules, see [Plan result sources and query rules](plan-search-for-sharepoint-cross-site-publishing-sites.md#BKMK_PlanResultSourcesAndQueryRules).
-
+ To customize how search results appear in Search Web Parts ΓÇö for example, to show an image followed by a title in bold to the right of the image ΓÇö you modify display templates. The two types of display templates that are most relevant to Search Web Parts are control display templates and item display templates. For more information about the default display templates, see [Display template reference in SharePoint Server](../technical-reference/display-template-reference-in-sharepoint-server.md).
-
+ ## Add a Content Search Web Part to a page <a name="BKMK_AddContentWP"> </a>
- **To add a Content Search Web Part to a page**
-
+**To add a Content Search Web Part to a page**:
+ 1. Verify that the user account that performs this procedure is a member of the Designers SharePoint group on the publishing site collection.
-
+ 2. Browse to the page where you want to add the Web Part.
-
-3. Click the **Settings** menu, and then click **Edit page**.
-
+
+3. Click the **Settings** menu, and then click **Edit page**.
+ 4. In the Web Part Zone where you want to add the Web Part, click **Add a Web Part**.
-
+ 5. In the **Categories** list, click **Content Rollup**.
-
+ 6. In the **Parts** list, click **Content Search**, and then click **Add**.
-
+ ## Configure the query for a Content Search Web Part <a name="BKMK_ConfigureWP"> </a> You can use the Content Search Web Part in Quick Mode and create a query by selecting options from a list of existing result sources, or you can switch to Advanced Mode to create your own custom query by using Keyword Query Language (KQL). Use the Advanced Mode only if you know KQL and the functionality that is enabled for the managed properties.
-
- **To configure the query for a Content Search Web Part**
-
-1. Verify that the user account that performs this procedure is a member of the Designers SharePoint group on the publishing site collection.
-
+
+**To configure the query for a Content Search Web Part**:
+
+1. Verify that the user account that performs this procedure is a member of the Designers SharePoint group on the publishing site collection.
+ 2. Browse to the page that contains the Content Search Web Part that you want to configure.
-
+ 3. Click the **Settings** menu, and then click **Edit Page**.
-
+ 4. In the Web Part, click the **Content Search Web Part Menu** arrow, and then click **Edit Web Part**.
-
+ 5. In the Web Part tool pane, in the **Properties** section, in the **Search Criteria** section, click **Change query**.
-
-6. On the **BASICS** tab, do one of the following:
-
- - To define your query by using Quick Mode, select options as described in the following table:
-
- **Quick Mode (default)**
-
-|Value|Description|
-|:--|:--|
-|Select a query <br/> |Select a result source to specify which content should be searched. If you have shared a document library or list as catalog, the catalog result source will be displayed in this drop-down list. By default, this is set to **Recently changed items (System).** <br/> |
-|Restrict results by app <br/> |Select an option from the list to restrict results to a specific site, library, list, or URL. By default, this is set to **Current site**. <br/> |
-|Restrict by tag <br/> |You can limit results to content that is tagged with a term from a term set. <br/> |
-
-Select one of the following options:
-
-|Option|Description|
-|:--|:--|
-|Don't restrict by any tag <br/> |Search results will not be limited based on tags (default). <br/> |
-|Restrict by navigation term of current page <br/> |Search results will be limited to content that is tagged with the term of the current page. The current tag is displayed as the last part of the friendly URL. This option is only meaningful for sites that use managed navigation. <br/> |
-|Restrict by current and child navigation <br/> |Search results will be limited to content that is tagged with the term of the current page (displayed as the last part of the friendly URL), and content that is tagged with sub-terms of the current page. This option is only meaningful for sites that use managed navigation. <br/> Note that in a cross-site publishing scenario, this selection will only work when the result source selected in the **Select a query** section is the catalog result source that is created when a publishing site is connected to a catalog.|
-|Restrict on this tag <br/> |Search results will be limited to content that is tagged with the tag that you type inside the box. <br/> |
-
-
-
- - To create your own query by using Keyword Query Language (KQL), click **Switch to Advanced Mode**. For information about KQL, see [Keyword Query Language (KQL) syntax reference](/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference). When you configure the query in Advanced Mode, you can also use query variables. Query variables are placeholders for values that change dynamically depending on the context of the page when the page that contains the Content Search Web Part is being displayed. The correct information is inserted dynamically from the context the query is sent to the index. Examples of query variables are {User.Name}, which represents the name of the user who is viewing the page, or {searchBoxQuery}, which represents the query that a user typed in a search box. Select options as described in the following table:
-
+
+6. On the **BASICS** tab, do one of the following:
+
+ - To define your query by using Quick Mode, select options as described in the following table:
+
+ **Quick Mode (default)**:
+
+ |Value|Description|
+ |||
+ |Select a query|Select a result source to specify which content should be searched. If you have shared a document library or list as catalog, the catalog result source will be displayed in this drop-down list. By default, this is set to **Recently changed items (System).**|
+ |Restrict results by app|Select an option from the list to restrict results to a specific site, library, list, or URL. By default, this is set to **Current site**.|
+ |Restrict by tag|You can limit results to content that is tagged with a term from a term set.|
+
+ Select one of the following options:
+
+ |Option|Description|
+ |||
+ |Don't restrict by any tag|Search results will not be limited based on tags (default).|
+ |Restrict by navigation term of current page|Search results will be limited to content that is tagged with the term of the current page. The current tag is displayed as the last part of the friendly URL. This option is only meaningful for sites that use managed navigation.|
+ |Restrict by current and child navigation|Search results will be limited to content that is tagged with the term of the current page (displayed as the last part of the friendly URL), and content that is tagged with sub-terms of the current page. This option is only meaningful for sites that use managed navigation. <br/> Note that in a cross-site publishing scenario, this selection will only work when the result source selected in the **Select a query** section is the catalog result source that is created when a publishing site is connected to a catalog.|
+ |Restrict on this tag|Search results will be limited to content that is tagged with the tag that you type inside the box.|
+
+ - To create your own query by using Keyword Query Language (KQL), click **Switch to Advanced Mode**. For information about KQL, see [Keyword Query Language (KQL) syntax reference](/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference). When you configure the query in Advanced Mode, you can also use query variables. Query variables are placeholders for values that change dynamically depending on the context of the page when the page that contains the Content Search Web Part is being displayed. The correct information is inserted dynamically from the context the query is sent to the index. Examples of query variables are {User.Name}, which represents the name of the user who is viewing the page, or {searchBoxQuery}, which represents the query that a user typed in a search box. Select options as described in the following table:
+ > [!NOTE] > When you switch to Advanced Mode, the result source that you selected from **Select a query** is replaced by a different result source. This result source could affect the search results. Therefore, make sure that you check the search results that are displayed in the **SEARCH RESULT PREVIEW** section, and add query configuration in the **Query text** field if you need to.
-
- **Advanced Mode**
-
-|Value|Description|
-|:--|:--|
-|Select a query <br/> |Select a result source to specify which content should be searched. <br/> Default result source is Local SharePoint Results (System). <br/> |
-|Keyword filter <br/> |You can use keyword filters to add query variables to your query. See [Query variables in SharePoint Server](../technical-reference/query-variables.md) for a list of available query variables. <br/> You can select pre-defined query variables from the drop-down list, and then add them to the query by clicking **Add keyword filter**. <br/> |
-|Property filter <br/> |You can use property filters to query the content of managed properties that are set to queryable in the search schema. <br/> You can select managed properties from the **Property filter** drop-down list. Click **Add property filter** to add the filter to the query. <br/> |
-|Query text <br/> |Type your query by using Keyword Query Language (KQL), or use the **Keyword filter** and **Property filter** lists to build the query. <br/> The keyword query can consist of free-text keywords, property filters, or operators. Use braces to enclose query variables. The query variables will be replaced with an actual value when the query is run. <br/> Keyword queries have a maximum length of 2,048 characters. <br/> |
-
-7. The **REFINERS** tab lists the managed properties that are enabled as refiners in the search schema. You can specify that the search results returned in the Content Search Web Part should be limited to one or more values from the refiners. Click a refiner in the list, and then click **Apply** to add it to the query.
-
+
+ **Advanced Mode**:
+
+ |Value|Description|
+ |||
+ |Select a query|Select a result source to specify which content should be searched. <br/> Default result source is Local SharePoint Results (System).|
+ |Keyword filter|You can use keyword filters to add query variables to your query. See [Query variables in SharePoint Server](../technical-reference/query-variables.md) for a list of available query variables. <br/> You can select pre-defined query variables from the drop-down list, and then add them to the query by clicking **Add keyword filter**.|
+ |Property filter|You can use property filters to query the content of managed properties that are set to queryable in the search schema. <br/> You can select managed properties from the **Property filter** drop-down list. Click **Add property filter** to add the filter to the query.|
+ |Query text|Type your query by using Keyword Query Language (KQL), or use the **Keyword filter** and **Property filter** lists to build the query. <br/> The keyword query can consist of free-text keywords, property filters, or operators. Use braces to enclose query variables. The query variables will be replaced with an actual value when the query is run. <br/> Keyword queries have a maximum length of 2,048 characters.|
+
+7. The **REFINERS** tab lists the managed properties that are enabled as refiners in the search schema. You can specify that the search results returned in the Content Search Web Part should be limited to one or more values from the refiners. Click a refiner in the list, and then click **Apply** to add it to the query.
+ Click **Show more** if you want to define grouping of results. Under **Group results**, you can specify that the results should be grouped based on one or more managed properties. This is useful when you are displaying several variants for a given item, and want to group them under a single result.
-
-8. On the **SORTING** tab, you can specify how search results should be sorted.
-
+
+8. On the **SORTING** tab, you can specify how search results should be sorted.
+ This tab is available only if you use **Advanced Mode**. If you use **Quick Mode**, you can define sorting options in the result source.
-
- In the **Sort by** drop-down list, select a managed property from the list of managed properties that are set as sortable in the search schema, and then select **Descending** or **Ascending**. For example, to sort by relevance (that is, to use a ranking model) select **Rank**.
-
+
+ In the **Sort by** drop-down list, select a managed property from the list of managed properties that are set as sortable in the search schema, and then select **Descending** or **Ascending**. For example, to sort by relevance (that is, to use a ranking model) select **Rank**.
+ To add more sorting levels, click **Add sort level**.
-
+ > [!NOTE]
- > Sorting of search results is case sensitive.
-
+ > Sorting of search results is case sensitive.
+ > [!IMPORTANT]
- > If your result source contains sorting, you should not specify sorting in the Content Search Web Part. This is because the sorting in the result source overrides the sorting that you specify in the Content Search Web Part.
-
- If you selected **Rank** from the **Sort by** list, you can select which ranking model to use for sorting in the **Ranking Model** list.
-
- Under **Dynamic ordering**, you can specify additional ranking by adding rules that will change the order of results when certain conditions apply. Click **Add dynamic ordering rule**, and then specify conditional rules.
-
-9. On the **SETTINGS** tab, specify the settings that are listed in the following table.
-
-| Value | Description |
-|:--|:--|
-|Query Rules <br/> |Select whether to use Query Rules or not. <br/> |
-|URL Rewriting <br/> |Select if the URL rewrite to the item details page should continue to be relative for each catalog item as defined when you set up the catalog connection. If you select **Don't rewrite URLs**, the URLs for catalog items are pointed directly to the library item of the connected catalog. <br/> |
-|Loading Behavior <br/> |Select when the search results returned by the Content Search Web Part appear on the web page. The default option is **Sync option: Issue query from the server**. By using this loading behavior, queries are issued from the server, and the search results are included in the page response that is sent back from SharePoint Server. If you select **Async option: Issue query from the browser**, the queries will be issued from the end-users browser after the complete page is received. This option may be considered for secondary content on a page ΓÇö for example Recommendations or Popular Items. <br/> |
-|Priority <br/> |Select the level that best describes the relative importance of content that is displayed by this Web Part in relation to other Search Web Parts. If SharePoint Server is running under heavy load, the queries will be run according to their priority. <br/> |
-|Caching <br/> |Select one Active Directory security group if you want search results to be cached for users in the group. By caching search results for a security group, you can reduce page reload time. <br/> > [!NOTE]> You should only select a security group where search results are identical for all users in the group. For more information, see [this article](/archive/blogs/technet/helgesolheim/new-group-cache-for-the-content-search-web-part).|
-
-10. On the **TEST** tab, you can preview the query that is sent by the Content Search Web Part.
-
-|Value|Description|
-|:--|:--|
-|**Query text** <br/> | Shows the final query that will be run by the Content Search Web Part. It is based on the original query template where dynamic variables are substituted with current values. Other changes to the query may have to be made as part of query rules. <br/> |
-
-Click **Show more** to display additional information.
-
-|Value|Description|
-|:--|:--|
-|Query template <br/> |Shows the content of the query template that is applied to the query. <br/> |
-|Refined by <br/> |Shows the refiners applied to the query as defined on the **REFINERS** tab. <br/> |
-|Grouped by <br/> |Shows the managed property on which search results should be grouped as defined on the **REFINERS** tab. <br/> |
-|Applied query rules <br/> |Shows which query rules are applied to the query. <br/> |
-
-The **Query template variables** section shows the query variables that will be applied to the query, and the values of the variables that apply to the current page. You can type other values to test the effect they will have on the query. Click the **Test Query** button to preview the search results.
-
-You can also test how the query works for different user segment terms. Click **Add user segment term** to add terms to be added to the query. Click the **Test query** button to preview the search results.
-
-|Value|Description|
-|:--|:--|
-|Query text <br/> |Shows the final query that will be run by the Content Search Web Part. It is based on the original query template where dynamic variables are substituted with current values. Other changes to the query may have to be made as part of query rules. <br/> |
-
+ > If your result source contains sorting, you should not specify sorting in the Content Search Web Part. This is because the sorting in the result source overrides the sorting that you specify in the Content Search Web Part.
+
+ If you selected **Rank** from the **Sort by** list, you can select which ranking model to use for sorting in the **Ranking Model** list.
+
+ Under **Dynamic ordering**, you can specify additional ranking by adding rules that will change the order of results when certain conditions apply. Click **Add dynamic ordering rule**, and then specify conditional rules.
+
+9. On the **SETTINGS** tab, specify the settings that are listed in the following table.
+
+ |Value|Description|
+ |||
+ |Query Rules|Select whether to use Query Rules or not.|
+ |URL Rewriting|Select if the URL rewrite to the item details page should continue to be relative for each catalog item as defined when you set up the catalog connection. If you select **Don't rewrite URLs**, the URLs for catalog items are pointed directly to the library item of the connected catalog.|
+ |Loading Behavior|Select when the search results returned by the Content Search Web Part appear on the web page. The default option is **Sync option: Issue query from the server**. By using this loading behavior, queries are issued from the server, and the search results are included in the page response that is sent back from SharePoint Server. If you select **Async option: Issue query from the browser**, the queries will be issued from the end-users browser after the complete page is received. This option may be considered for secondary content on a page ΓÇö for example Recommendations or Popular Items.|
+ |Priority|Select the level that best describes the relative importance of content that is displayed by this Web Part in relation to other Search Web Parts. If SharePoint Server is running under heavy load, the queries will be run according to their priority.|
+ |Caching|Select one Active Directory security group if you want search results to be cached for users in the group. By caching search results for a security group, you can reduce page reload time. <br/> > **Note**: You should only select a security group where search results are identical for all users in the group. For more information, see [this article](/archive/blogs/technet/helgesolheim/new-group-cache-for-the-content-search-web-part).|
+
+10. On the **TEST** tab, you can preview the query that is sent by the Content Search Web Part.
+
+ |Value|Description|
+ |||
+ |**Query text**|Shows the final query that will be run by the Content Search Web Part. It is based on the original query template where dynamic variables are substituted with current values. Other changes to the query may have to be made as part of query rules.|
+
+ Click **Show more** to display additional information.
+
+ |Value|Description|
+ |||
+ |Query template|Shows the content of the query template that is applied to the query.|
+ |Refined by|Shows the refiners applied to the query as defined on the **REFINERS** tab.|
+ |Grouped by|Shows the managed property on which search results should be grouped as defined on the **REFINERS** tab.|
+ |Applied query rules|Shows which query rules are applied to the query.|
+
+ The **Query template variables** section shows the query variables that will be applied to the query, and the values of the variables that apply to the current page. You can type other values to test the effect they will have on the query. Click the **Test Query** button to preview the search results.
+
+ You can also test how the query works for different user segment terms. Click **Add user segment term** to add terms to be added to the query. Click the **Test query** button to preview the search results.
+
+ |Value|Description|
+ |||
+ |Query text|Shows the final query that will be run by the Content Search Web Part. It is based on the original query template where dynamic variables are substituted with current values. Other changes to the query may have to be made as part of query rules.|
+ ## Configure the display templates for the Content Search Web Part <a name="BKMK_ConfigureDisplayTemplates"> </a> When you connect a publishing site to a catalog, the default control display template for the Content Search Web Part on your category page is List with Paging (named Control_ListWithPaging in the Master Page Gallery).
-
+ The default item display template for the Content Search Web Part is Picture on top, 3 lines on bottom (named Item_Picture3Lines in the Master Page Gallery). If you want to use other display templates on your category page, you can change them by changing the settings for the Content Search Web Part.
-
+ For information on how to customize and create your own display templates, see [SharePoint 2013 Design Manager display templates](/sharepoint/dev/general-development/sharepoint-design-manager-design-packages). For information about JavaScript methods that you can use when you customize your display templates, see [Srch.U object (DisplayTemplatesSrch)](/previous-versions/office/sharepoint-visio/dn768292(v=office.15)).
-
+ ## Add a Refinement Web Part to a page <a name="BKMK_AddRefinementPanel"> </a> You can add refiners to a page to narrow the items that are shown in a Content Search Web Part, and help users quickly browse to specific content. Refiners are based on managed properties from the search index. To display refiners on a page, you must first enable the managed property that you want to use as a refiner, and then add a Refinement Web Part to the page where you want the refiners to appear. You can configure the Refinement Web Part for two types of refiners: **Stand-alone refiners** and **Refiners for faceted navigation**. For more information about the different refiner types, see [Plan refiners and faceted navigation](plan-search-for-sharepoint-cross-site-publishing-sites.md#BKMK_PlanRefinersAndFacetedNavigation) in [Plan search for cross-site publishing sites in SharePoint Server 2016](plan-search-for-sharepoint-cross-site-publishing-sites.md).
-
+ Before you begin this procedure, verify the following:
-
+ - The managed properties that you want to use as refiners are enabled as refinable managed properties as described in "Map a crawled property to a refinable managed property in SharePoint site collection administration" or "Enable automatically created managed properties as refiners in SharePoint Central Administration " in [Configure refiners and faceted navigation in SharePoint Server](configure-refiners-and-faceted-navigation.md).
-
+ - You have done a full crawl of the content source that contains the managed properties that are enabled as refiners, or indicated that your catalog should be fully reindexed during the next scheduled crawl of the catalog as described in "Configure search for cross-site publishing" in [Configure cross-site publishing in SharePoint Server](configure-cross-site-publishing.md).
-
+ - If you are using refiners for faceted navigation, you have configured the refiners as described in "Add refiners to a term set" in [Configure refiners and faceted navigation in SharePoint Server](configure-refiners-and-faceted-navigation.md).
-
- **To add a Refinement Web Part to a page**
-
-1. Verify that the user account that performs this procedure is a member of the Designers SharePoint group on the publishing site collection.
-
+
+**To add a Refinement Web Part to a page**:
+
+1. Verify that the user account that performs this procedure is a member of the Designers SharePoint group on the publishing site collection.
+ 2. Browse to the page where you want to add the Web Part.
-
-3. Click the **Settings** menu, and then click **Edit Page**.
-
+
+3. Click the **Settings** menu, and then click **Edit Page**.
+ 4. In the Web Part Zone where you want to add the Web Part, click **Add a Web Part**.
-
+ 5. In the **Categories** list, select **Search**.
-
+ 6. In the **Parts** list, select **Refinement**, and then click **Add**.
-
+ ## Configure the Refinement Web Part <a name="BKMK_ConfigureRPWP"> </a>
- **To configure the Refinement Part**
-
+**To configure the Refinement Part**:
+ 1. Verify that the user account that performs this procedure is a member of the Designers SharePoint group on the publishing site collection.
-
+ 2. Browse to the page that contains the Refinement Web Part that you want to configure.
-
+ 3. Click the **Settings** menu, and then click **Edit Page**.
-
-4. In the Web Part, click the **Refinement Web Part Menu** arrow, and then click **Edit Web Part**.
-
+
+4. In the Web Part, click the **Refinement Web Part Menu** arrow, and then click **Edit Web Part**.
+ 5. You can configure the Web Part for stand-alone refiners or for refiners for faceted navigation by using the following procedures,
-
- - To configure the Web Part for stand-alone refiners:
-
-1. In the Web Part tool pane, in the **Properties for Search Refinement** section, verify that the **Choose Refiners in this Web Part** is selected.
-
-2. Click **Choose Refiners…**
-
-3. On the **Refinement configuration** page, from the **Available refiners** section, use the buttons to select which refiners should be added to the term set, and also in which order that they should be displayed. If you have specified an alias for a refinable managed property, this alias is displayed in the **Configuration for** section.
-
-4. In the **Configuration for** section, set the configuration for how every refiner appears.
-
+
+ - To configure the Web Part for stand-alone refiners:
+
+ 1. In the Web Part tool pane, in the **Properties for Search Refinement** section, verify that the **Choose Refiners in this Web Part** is selected.
+
+ 2. Click **Choose Refiners...**
+
+ 3. On the **Refinement configuration** page, from the **Available refiners** section, use the buttons to select which refiners should be added to the term set, and also in which order that they should be displayed. If you have specified an alias for a refinable managed property, this alias is displayed in the **Configuration for** section.
+
+ 4. In the **Configuration for** section, set the configuration for how every refiner appears.
+ > [!NOTE]
- > If you have a single language site, you can change the refiner display name in the **Display name** section. For multilingual sites, you have to change the refiner display language as described in [Change the refiner display name](configure-search-web-parts.md#BKMK_ChangeDisplayName).
-
- - To configure the Web Part for refiners for faceted navigation:
-
-1. In the Web Part tool pane, in the **Properties for Search Refinement** section, select the option **Use the refinement configuration defined in the Managed Navigation term set**.
-
+ > If you have a single language site, you can change the refiner display name in the **Display name** section. For multilingual sites, you have to change the refiner display language as described in [Change the refiner display name](configure-search-web-parts.md#BKMK_ChangeDisplayName).
+
+ - To configure the Web Part for refiners for faceted navigation:
+
+ In the Web Part tool pane, in the **Properties for Search Refinement** section, select the option **Use the refinement configuration defined in the Managed Navigation term set**.
+ ## Change the refiner display name <a name="BKMK_ChangeDisplayName"> </a> When you add a Refinement Web Part, the name of the managed property that is enabled as a refiner will be used as display name for the refiner. In many cases, the managed property name is not user-friendly ΓÇö for example, RefinableString00 or ColorOWSTEXT. You can change the display name of the refiner by changing a java script file in the master page gallery.
-
- **To change the refiner display name**
-
-1. Verify that the user account that performs this procedure is a member of the Designers SharePoint group on the publishing site collection.
-
+
+**To change the refiner display name**:
+
+1. Verify that the user account that performs this procedure is a member of the Designers SharePoint group on the publishing site collection.
+ 2. On the **Settings** menu, click **Site Settings**.
-
-3. On the **Site Settings** page, in the **Web Designer Galleries** section, click **Master pages and page layouts**.
-
+
+3. On the **Site Settings** page, in the **Web Designer Galleries** section, click **Master pages and page layouts**.
+ 4. On the **Master Page Gallery** page, click **Display Templates**.
-
+ 5. On the **Display Templates** page, click **Language Files**.
-
-6. On the **Language Files** page, click the folder that contains the language that you want to change the refiner display name for.
-
-7. Open the **CustomStrings.js** file.
-
-8. Add one line to the file for each managed property that is enabled as a refiner for which you want to change the display name by using the following syntax:
-
+
+6. On the **Language Files** page, click the folder that contains the language that you want to change the refiner display name for.
+
+7. Open the **CustomStrings.js** file.
+
+8. Add one line to the file for each managed property that is enabled as a refiner for which you want to change the display name by using the following syntax:
+ `"rf_RefinementTitle_ManagedPropertyName": "Sample Refinement Title for ManagedPropertyName"`
-
- For example, you can add the following line to change the display name for the managed property RefinableInt00 to Price:
-
+
+ For example, you can add the following line to change the display name for the managed property RefinableInt00 to Price:
+ `"rf_RefinementTitle_RefinableInt00": "Price"`.
-
+ ## Display refiner counts in a Refinement Web Part <a name="BKMK_DisplayRefinerCounts"> </a>
-When you add a Refinement Web Part to a page, by default, the Web Part will not show refiner counts ΓÇö that is, the number of items for each refiner value. For example, if you have enabled the managed property Color as a refiner, the refiner values will only show colors such as Red, Green, and Blue. You can add refiner counts by changing a value in an HTML file so that the refiner values are shown as Red (10), Green (12), and Blue (8).
-
- **To add refiner counts to the Refinement Web Part**
-
-1. Verify that the user account that performs this procedure is a member of the Designers SharePoint group on the publishing site collection.
-
+When you add a Refinement Web Part to a page, by default, the Web Part will not show refiner counts ΓÇö that is, the number of items for each refiner value. For example, if you have enabled the managed property Color as a refiner, the refiner values will only show colors such as Red, Green, and Blue. You can add refiner counts by changing a value in an HTML file so that the refiner values are shown as Red (10), Green (12), and Blue (8).
+
+**To add refiner counts to the Refinement Web Part**:
+
+1. Verify that the user account that performs this procedure is a member of the Designers SharePoint group on the publishing site collection.
+ 2. On the **Settings** menu, click **Site Settings**.
-
-3. On the **Site Settings** page, in the **Web Designer Galleries** section, click **Master pages and page layouts**.
-
+
+3. On the **Site Settings** page, in the **Web Designer Galleries** section, click **Master pages and page layouts**.
+ 4. On the **Master Page Gallery** page, click **Display Templates**.
-
+ 5. On the **Display Templates** page, click **Filters**.
-
-6. Open the **Filter_Default.html** file.
-
+
+6. Open the **Filter_Default.html** file.
+ 7. Change the value for **ShowCounts** to **true**.
-
+ ## Configure the display templates for the Refinement Web Part <a name="BKMK_ConfigureRefinementDisplayTemplates"> </a> The display templates for the Refinement Web Part can be found in the Master Page Gallery.
-
- **To view display templates for the Refinement Web Part**
-
+
+**To view display templates for the Refinement Web Part**:
+ 1. Verify that the user account that performs this procedure is a member of the Designers SharePoint group on the publishing site collection.
-
+ 2. On the **Settings** menu, click **Site Settings**.
-
-3. On the **Site Settings** page, in the **Web Designer Galleries** section, click **Master pages and page layouts**.
-
+
+3. On the **Site Settings** page, in the **Web Designer Galleries** section, click **Master pages and page layouts**.
+ 4. On the **Master Page Gallery** page, click **Display Templates**.
-
+ 5. On the **Display Templates** page, click **Filters**.
-
+ For information on how to customize and create your own display templates, see [SharePoint 2013 Design Manager display templates](/sharepoint/dev/general-development/sharepoint-design-manager-design-packages).
-
+ ## Add a Taxonomy Refinement Panel Web Part to a page <a name="BKMK_AddTaxonomyRefinementPanel"> </a>
-Before you begin this procedure, verify the following:
-
+Before you begin this procedure, verify the following:
+ - The managed properties that you want to use as refiners are refiner-enabled as described in "Map a crawled property to a refinable managed property in SharePoint site collection administration" or "Enable automatically created managed properties as refiners in SharePoint Central Administration " in [Configure refiners and faceted navigation in SharePoint Server](configure-refiners-and-faceted-navigation.md).
-
+ - You have done a full crawl of the content source that contains the managed properties that are enabled as refiners as described in "Configure search for cross-site publishing" in [Configure cross-site publishing in SharePoint Server](configure-cross-site-publishing.md).
-
+ - If you are using refiners for faceted navigation, you have configured the refiners as described in [Configure refiners and faceted navigation in SharePoint Server](configure-refiners-and-faceted-navigation.md).
-
- **To add a Taxonomy Refinement Panel Web Part to a page**
-
+
+**To add a Taxonomy Refinement Panel Web Part to a page**:
+ 1. Verify that the user account that performs this procedure is a member of the Designers SharePoint group on the publishing site collection.
-
+ 2. Browse to the page where you want to add the Web Part.
-
-3. Click the **Settings** menu, and then click **Edit Page**.
-
+
+3. Click the **Settings** menu, and then click **Edit Page**.
+ 4. In the Web Part Zone where you want to add the Web Part, click **Add a Web Part**.
-
+ 5. In the **Categories** list, select **Search**.
-
+ 6. In the **Parts**, select **Taxonomy Refinement Panel**, and then click **Add**.
-
+ ## Configure the Taxonomy Refinement Panel Web Part <a name="BKMK_ConfigureTaxonomyRefinementPanelWP"> </a>
- **To configure the Taxonomy Refinement Panel Web Part**
-
+**To configure the Taxonomy Refinement Panel Web Part**:
+ 1. Verify that the user account that performs this procedure is a member of the Designers SharePoint group on the publishing site collection.
-
+ 2. Browse to the page where you have the Taxonomy Refinement Panel Web Part that you want to configure.
-
+ 3. On the **Settings** menu, click **Edit Page**.
-
-4. In the Web Part, click the **Taxonomy Refinement Panel Web Part Menu** arrow, and then click **Edit Web Part**.
-
-5. In the Web Part tool pane, in the **Properties** section, in the **Query** section, on the **Refinement Target** menu, select the Web Part you want to associate with the Taxonomy Refinement Panel Web Part.
-
-6. In the Web Part tool pane, in the **Properties** section, in the **Query** section, on the **Refiner** menu, select the managed property that you have specified for Managed Navigation.
-
+
+4. In the Web Part, click the **Taxonomy Refinement Panel Web Part Menu** arrow, and then click **Edit Web Part**.
+
+5. In the Web Part tool pane, in the **Properties** section, in the **Query** section, on the **Refinement Target** menu, select the Web Part you want to associate with the Taxonomy Refinement Panel Web Part.
+
+6. In the Web Part tool pane, in the **Properties** section, in the **Query** section, on the **Refiner** menu, select the managed property that you have specified for Managed Navigation.
+ ## Add a Recommended Items Web Part to a page <a name="BKMK_AddRecs"> </a>
-You can use the Recommended Items Web Part to show content recommendations based how users have previously interacted with the site. For example, you can add this Web Part to a Catalog Item page. If a user views a specific item, this Web Part will display other items that users have previously viewed, such as "Users who viewed this item also viewed these items." For more information about recommendations, see [Plan usage analytics, usage events and recommendations](plan-search-for-sharepoint-cross-site-publishing-sites.md#BKMK_PlanAnalytics) in [Plan search for cross-site publishing sites in SharePoint Server 2016](plan-search-for-sharepoint-cross-site-publishing-sites.md).
-
- **To add a Recommended Items Web Part to a page**
-
+You can use the Recommended Items Web Part to show content recommendations based how users have previously interacted with the site. For example, you can add this Web Part to a Catalog Item page. If a user views a specific item, this Web Part will display other items that users have previously viewed, such as "Users who viewed this item also viewed these items." For more information about recommendations, see [Plan usage analytics, usage events and recommendations](plan-search-for-sharepoint-cross-site-publishing-sites.md#BKMK_PlanAnalytics) in [Plan search for cross-site publishing sites in SharePoint Server 2016](plan-search-for-sharepoint-cross-site-publishing-sites.md).
+
+**To add a Recommended Items Web Part to a page**:
+ 1. Verify that the user account that performs this procedure is a member of the Designers SharePoint group on the publishing site collection.
-
+ 2. Browse to the page where you want to add the Web Part.
-
+ 3. Click the Settings menu, and then click **Edit Page**.
-
+ 4. In the Web Part Zone where you want to add the Web Part, click **Add a Web Part**.
-
+ 5. In the **Categories** list, click **Search-Driven Content**.
-
+ 6. In the **Parts** list, click **Recommended Items**, and then click **Add**.
-
+ ## Configure the Recommended Items Web Part <a name="BKMK_ConfigureRecs"> </a>
- **To configure the query for a Recommended Items Web Part**
-
+**To configure the query for a Recommended Items Web Part**:
+ 1. Verify that the user account that performs this procedure is a member of the Designers SharePoint group on the publishing site collection.
-
+ 2. Browse to the page where you have the Recommended Items Web Part that you want to configure.
-
+ 3. On the **Settings** menu, click **Edit Page**.
-
-4. In the Web Part, click the **Recommended Items Web Part Menu** arrow, and then click **Edit Web Part**.
-
+
+4. In the Web Part, click the **Recommended Items Web Part Menu** arrow, and then click **Edit Web Part**.
+ 5. In the Web Part tool pane, in the **Properties** section, in the **Search Criteria** section, click **Change query**.
-
-6. On the **BASICS** tab, define your query by selecting options described in the following table.
-
-|Value|Description|
-|:--|:--|
-|Get recommended items for <br/> |From the drop-down list, select from which value recommendations should be displayed. In a catalog scenario, this will often be **A token from a URL**. If you select this option, you will also have to select which URL token you want to obtain recommendations for. <br/> For example, let's say that you want to obtain recommendations for items in your catalog. You have a catalog item page where you display your catalog items, and the item number is part of your friendly URL ΓÇö for example, www.contoso/audio/mp3/4010101. (4010101 represents the item number.) When you want to obtain recommendations for a token from the URL, you should select {URLToken.1} (4010101) from the second drop-down list. <br/> |
-|Restrict results by app <br/> |Use this drop-down list to specify a scope for the search results. <br/> |
-|Restrict results by content type <br/> |Use this drop-down list to limit the search results to a specific content type. <br/> |
-|If there are too few recommended items <br/> |If you don't have much usage data ΓÇö for example, if your site is fairly new, or if the items do not have recommendations to display ΓÇö this Web Part will not display any search results. In order for the Web Part to display recommendations even though not enough user data has cumulated, you can select the option to **Select a query to fill in with additional results**. <br/> |
-
-7. The **REFINERS** tab lists the managed properties that are set as refiner-enabled in the search schema. You can specify that the search results returned in the Recommended Items Search Web Part should be limited to one or more values from the refiners. Click a refiner in the list, and then click **Apply** to add it to the query.
-
+
+6. On the **BASICS** tab, define your query by selecting options described in the following table.
+
+ |Value|Description|
+ |||
+ |Get recommended items for|From the drop-down list, select from which value recommendations should be displayed. In a catalog scenario, this will often be **A token from a URL**. If you select this option, you will also have to select which URL token you want to obtain recommendations for. <br/> For example, let's say that you want to obtain recommendations for items in your catalog. You have a catalog item page where you display your catalog items, and the item number is part of your friendly URL ΓÇö for example, www.contoso/audio/mp3/4010101. (4010101 represents the item number.) When you want to obtain recommendations for a token from the URL, you should select {URLToken.1} (4010101) from the second drop-down list.|
+ |Restrict results by app|Use this drop-down list to specify a scope for the search results.|
+ |Restrict results by content type|Use this drop-down list to limit the search results to a specific content type.|
+ |If there are too few recommended items|If you don't have much usage data ΓÇö for example, if your site is fairly new, or if the items do not have recommendations to display ΓÇö this Web Part will not display any search results. In order for the Web Part to display recommendations even though not enough user data has cumulated, you can select the option to **Select a query to fill in with additional results**.|
+
+7. The **REFINERS** tab lists the managed properties that are set as refiner-enabled in the search schema. You can specify that the search results returned in the Recommended Items Search Web Part should be limited to one or more values from the refiners. Click a refiner in the list, and then click **Apply** to add it to the query.
+ Click **Show more** if you want to define grouping of results. Under **Group results**, you can specify that the results should be grouped based on one or more managed properties.
-
-8. On the **SETTINGS** tab, specify the following:
-
-|Value|Description|
-|:--|:--|
-|Query Rules| Select whether to use Query Rules or not. |
-|URL Rewriting|Select if the URL rewrite to the item details page should continue to be relative for each catalog item as defined when you set up the catalog connection. If you select **Don't rewrite URLs**, the URLs for your catalog items are pointed directly to the library item of the connected catalog.|
-|Loading Behavior|Select when the search results returned by the Recommended Items Web Part should be displayed on the web page. The default option is **Display the page and web party simultaneously**. By using this loading behavior, queries are issued from the server, and the search results are included in the page response that is sent back from SharePoint Server. If you select **Display the page and web part independently**, the queries will be issued from the end-users browser after the complete page is received. This option may be considered for secondary content on a page ΓÇö for example, Recommendations or Popular Items|
-|Priority|Select the level that best describes the relative importance of content that is displayed by this Web Part in relation to other Search Web Parts. If SharePoint Server is running under heavy load, the queries will be run according to their priority.|
-|Caching|Select one Active Directory security group if you want search results to be cached for users in the group. By caching search results for a security group, you can reduce page reload time.> [!NOTE]> You should only select a security group where search results are identical for all users in the group. For more information, see [this article](/archive/blogs/technet/helgesolheim/new-group-cache-for-the-content-search-web-part).|
-
-9. On the **TEST** tab, you can preview the query that is sent by the Recommended Items Web Part.
-
-|Value|Description|
-|:--|:--|
-|Query text <br/> |Shows the content of the query template that is applied to the query. <br/> |
-
-Click **Show more** to display additional information.
-
-|Value|Description|
-|:--|:--|
-|Refined by <br/> |Shows the refiners applied to the query as defined in the **REFINERS** tab. <br/> |
-|Grouped by <br/> |Shows the managed property on which search results should be grouped as defined in the **REFINERS** tab. <br/> |
-|Applied query rules <br/> |Shows which query rules are applied to the query. <br/> |
-
-In the **Query template variables** section, the selections that you made on the BASIC tab are displayed. In addition, you can type additional values for testing as outlined in the following table. Click the **Test query** button to preview the search results.
-
-|Value|Description|
-|:--|:--|
-|{RecsURL}\* <br/> |Shows the token you selected when specifying for which value recommendations should be displayed. <br/> |
-|{Scope}\* <br/> |Shows the scope that you selected for the search results. <br/> |
-|{ContentTypeID}\* <br/> |Shows the content type that you selected for the search results. <br/> |
-
-You can also test how the query works for different user segment terms. Click **Add user segment term for testing** to add terms to be added to the query. Click the **Test query** button to preview the search results.
-
-|Value|Description|
-|:--|:--|
-|Query text <br/> |Shows the final query that will be run by the Recommended Items Web Part. It is based on the original query template where dynamic variables are substituted with current values. Other changes to the query may have be made as part of query rules. <br/> |
-
+
+8. On the **SETTINGS** tab, specify the following:
+
+ |Value|Description|
+ |||
+ |Query Rules|Select whether to use Query Rules or not.|
+ |URL Rewriting|Select if the URL rewrite to the item details page should continue to be relative for each catalog item as defined when you set up the catalog connection. If you select **Don't rewrite URLs**, the URLs for your catalog items are pointed directly to the library item of the connected catalog.|
+ |Loading Behavior|Select when the search results returned by the Recommended Items Web Part should be displayed on the web page. The default option is **Display the page and web party simultaneously**. By using this loading behavior, queries are issued from the server, and the search results are included in the page response that is sent back from SharePoint Server. If you select **Display the page and web part independently**, the queries will be issued from the end-users browser after the complete page is received. This option may be considered for secondary content on a page ΓÇö for example, Recommendations or Popular Items|
+ |Priority|Select the level that best describes the relative importance of content that is displayed by this Web Part in relation to other Search Web Parts. If SharePoint Server is running under heavy load, the queries will be run according to their priority.|
+ |Caching|Select one Active Directory security group if you want search results to be cached for users in the group. By caching search results for a security group, you can reduce page reload time.> [!NOTE]> You should only select a security group where search results are identical for all users in the group. For more information, see [this article](/archive/blogs/technet/helgesolheim/new-group-cache-for-the-content-search-web-part).|
+
+9. On the **TEST** tab, you can preview the query that is sent by the Recommended Items Web Part.
+
+ |Value|Description|
+ |||
+ |Query text|Shows the content of the query template that is applied to the query.|
+
+ Click **Show more** to display additional information.
+
+ |Value|Description|
+ |||
+ |Refined by|Shows the refiners applied to the query as defined in the **REFINERS** tab.|
+ |Grouped by|Shows the managed property on which search results should be grouped as defined in the **REFINERS** tab.|
+ |Applied query rules|Shows which query rules are applied to the query.|
+
+ In the **Query template variables** section, the selections that you made on the BASIC tab are displayed. In addition, you can type additional values for testing as outlined in the following table. Click the **Test query** button to preview the search results.
+
+ |Value|Description|
+ |||
+ |{RecsURL}\*|Shows the token you selected when specifying for which value recommendations should be displayed.|
+ |{Scope}\*|Shows the scope that you selected for the search results.|
+ |{ContentTypeID}\*|Shows the content type that you selected for the search results.|
+
+ You can also test how the query works for different user segment terms. Click **Add user segment term for testing** to add terms to be added to the query. Click the **Test query** button to preview the search results.
+
+ |Value|Description|
+ |||
+ |Query text|Shows the final query that will be run by the Recommended Items Web Part. It is based on the original query template where dynamic variables are substituted with current values. Other changes to the query may have be made as part of query rules.|
+ ## Configure the display templates for the Recommended Items Web Part <a name="BKMK_ConfigureRecsDisplayTemplates"> </a> The default control display template for the Recommended Items Search Web Part is List (known as Control_List in the Master Page Gallery).
-
+ The default item display template for the Recommended Items Web Part is Recommended Items: Picture on top, 3 lines (known as Item_RecommendationsClickLogging in the Master Page Gallery). When a user clicks a link that is displayed in the Recommended Items Web Part, the default display template logs a Recommendations Clicked usage event.
-
+ For information on how to customize and create your own display templates, see [SharePoint 2013 Design Manager display templates](/sharepoint/dev/general-development/sharepoint-design-manager-design-packages). For information about JavaScript methods that you can use when you customize your display templates, see [Srch.U object (DisplayTemplatesSrch)](/previous-versions/office/sharepoint-visio/dn768292(v=office.15)).
-
+ ## See also <a name="BKMK_ConfigureRecsDisplayTemplates"> </a>
-#### Concepts
+### Concepts
[Query variables in SharePoint Server](../technical-reference/query-variables.md)
-#### Other Resources
+### Other Resources
-[Blog series: How to set up a product-centric website in SharePoint Server 2013](https://blogs.technet.com/b/tothesharepoint/archive/2013/02/14/how-to-set-up-a-product-centric-web-site-in-sharepoint-2013.aspx)
+[Blog series: How to set up a product-centric website in SharePoint Server 2013](https://blogs.technet.com/b/tothesharepoint/archive/2013/02/14/how-to-set-up-a-product-centric-web-site-in-sharepoint-2013.aspx)
SharePoint Create An Excel Services Dashboard Using Sql Server Analysis Services Data https://github.com/MicrosoftDocs/OfficeDocs-SharePoint/commits/public/SharePoint/SharePointServer/administration/create-an-excel-services-dashboard-using-sql-server-analysis-services-data.md
We begin by creating the ProductSales report.
The **Select field** dialog appears.
-2. To open the **Sort (Category)** dialog, select **More Sort Options…**.
+2. To open the **Sort (Category)** dialog, select **More Sort Options...**.
3. In the **Sort options** section, select the **Descending (Z to A) by** option, and then use the list to select **Sales Amount**.
The workbook we created uses an external data connection that we want to keep ac
2. Select **Properties**.
-3. In the **Connection Properties** dialog, on the **Definition** tab, next to **Excel Services**, select **Authentication Settings…**.
+3. In the **Connection Properties** dialog, on the **Definition** tab, next to **Excel Services**, select **Authentication Settings...**.
4. In the **Excel Services Authentication Settings** dialog, take one of the following steps:
SharePoint Data Authentication For Excel Services https://github.com/MicrosoftDocs/OfficeDocs-SharePoint/commits/public/SharePoint/SharePointServer/administration/data-authentication-for-excel-services.md
The authentication method to choose depends on various factors as outlined in th
|**Data connection credentials** <br/> |The Windows credentials of the workbook viewer. <br/> |The credentials specified in the Secure Store target application. <br/> |The credentials of the Unattended Service Account. <br/> |The credentials of the Excel Services process identity. <br/> | |**Advantages** <br/> | The Kerberos protocol is an industry standard in credentials management. <br/> Kerberos ties into the existing Active Directory infrastructure. <br/> Kerberos delegation permits auditing of individual accesses to a data source. <br/> Given that the workbook viewer's identity is known, workbook creators can embed personalized database queries into workbooks. <br/> | The Secure Store Service is part of SharePoint Server and is easier to configure than Kerberos. <br/> Mappings are flexible: a user can be mapped either 1-to-1 or many-to-1. <br/> Non-Windows credentials can be used to connect to data sources that do not accept Windows credentials. (Requires the Unattended Service Account to be configured also.) <br/> Mappings created for Excel Services can be re-used by other business intelligence applications such as Visio Services. <br/> | The Unattended Service Account is easy to deploy and setup. <br/> The Unattended Service Account does not require much administrative overhead. <br/> | Per-user data security without the need to configure Kerberos delegation. <br/> Minimal configuration and administrative overhead. <br/> | |**Drawbacks** <br/> | Additional administrative effort required to configure SharePoint Server 2013 and Excel Services. <br/> | Establishing and managing mapping tables requires some administrative overhead. <br/> Secure Store permits limited auditing. In the many-to-1 scenario, individual incoming users are mapped into the same credentials through a target application, effectively blending them into one user. <br/> | Given that everyone is mapped to the same credentials, an administrator cannot distinguish who accessed a data source. <br/> | Only works with Analysis Services data sources. <br/> |
-|**For the authentication operation to succeed …** <br/> | Kerberos delegation must be set up on the SharePoint Server 2013. <br/> | The Secure Store Service must be provisioned and configured on the farm. It must also contain appropriate mapping information for a particular incoming user. Additionally the mapping information may need to be updated periodically to reflect password changes on the mapped account. <br/> | The Secure Store Service must be provisioned and configured on the farm. It must also contain the credentials for the Unattended Service Account. Additionally the mapping information may need to be updated periodically to reflect password changes on the mapped account. <br/> Excel Services Global Settings must be configured to use the Unattended Service Account. <br/> | The **EffectiveUserName** option must be enabled in Excel Services Global Settings. <br/> The user must be a member of the appropriate Analysis Services role. <br/> |
+|**For the authentication operation to succeed ...** <br/> | Kerberos delegation must be set up on the SharePoint Server 2013. <br/> | The Secure Store Service must be provisioned and configured on the farm. It must also contain appropriate mapping information for a particular incoming user. Additionally the mapping information may need to be updated periodically to reflect password changes on the mapped account. <br/> | The Secure Store Service must be provisioned and configured on the farm. It must also contain the credentials for the Unattended Service Account. Additionally the mapping information may need to be updated periodically to reflect password changes on the mapped account. <br/> Excel Services Global Settings must be configured to use the Unattended Service Account. <br/> | The **EffectiveUserName** option must be enabled in Excel Services Global Settings. <br/> The user must be a member of the appropriate Analysis Services role. <br/> |
#### Kerberos delegation
SharePoint Data Authentication For Visio Services https://github.com/MicrosoftDocs/OfficeDocs-SharePoint/commits/public/SharePoint/SharePointServer/administration/data-authentication-for-visio-services.md
Windows authentication requires that Visio Services present to SQL Server a set
|Data connection credentials <br/> |The Windows credentials of the diagram viewer. <br/> |The credentials specified in the Secure Store target application. <br/> |The credentials of the Unattended Service Account. <br/> | |Advantages <br/> | The Kerberos protocol is an industry standard in credentials management. <br/> Kerberos ties into the existing Active Directory infrastructure. <br/> Kerberos delegation enables auditing of individual accesses to a data source. <br/> Given that the diagram viewer's identity is known, diagram creators can embed personalized database queries into diagrams. <br/> | Secure Store is part of SharePoint Server and is easier to configure than Kerberos authentication. <br/> Mappings are flexible: a user can be mapped either 1-to-1 or many-to-1. <br/> Non-Windows credentials can be used to connect to data sources that do not accept Windows credentials. <br/> Mappings created for Visio can be re-used by other business intelligence applications such as Excel Online. <br/> | The Unattended Service Account is the easiest authentication method to deploy and setup. <br/> The Unattended Service Account does not require much administrative overhead. <br/> | |Drawbacks <br/> | Additional administrative effort required to configure for SharePoint Server and Visio Services. <br/> | Establishing and managing mapping tables requires some administrative overhead. <br/> Secure Store allows limited auditing. In the many-to-1 scenario, individual incoming users are mapped into the same credentials through a target application, effectively blending them into one user. <br/> | Given that everyone is mapped to the same credentials, an administrator cannot distinguish who accessed a data source. <br/> |
-|For the authentication operation to succeed … <br/> | Kerberos constrained delegation must be set up on the SharePoint farm. <br/> | Secure Store must be provisioned and configured on the farm. It must also contain appropriate mapping information for a particular incoming user. Additionally the mapping information may need to be updated periodically to reflect password changes on the mapped account. <br/> | Secure Store must be provisioned and configured on the farm. It must also contain the credentials for the Unattended Service Account. Additionally the mapping information may need to be updated periodically to reflect password changes on the mapped account. <br/> The Unattended Service Account must be configured in Visio Services Global Settings. <br/> |
+|For the authentication operation to succeed ... <br/> | Kerberos constrained delegation must be set up on the SharePoint farm. <br/> | Secure Store must be provisioned and configured on the farm. It must also contain appropriate mapping information for a particular incoming user. Additionally the mapping information may need to be updated periodically to reflect password changes on the mapped account. <br/> | Secure Store must be provisioned and configured on the farm. It must also contain the credentials for the Unattended Service Account. Additionally the mapping information may need to be updated periodically to reflect password changes on the mapped account. <br/> The Unattended Service Account must be configured in Visio Services Global Settings. <br/> |
#### Kerberos constrained delegation
SharePoint Enhanced People Picker For Trusted Authentication Method https://github.com/MicrosoftDocs/OfficeDocs-SharePoint/commits/public/SharePoint/SharePointServer/administration/enhanced-people-picker-for-trusted-authentication-method.md
description: "In SharePoint Server Subscription Edition, People Picker is enhanc
[!INCLUDE[appliesto-xxx-xxx-xxx-SUB-xxx-md](../includes/appliesto-xxx-xxx-xxx-SUB-xxx-md.md)]
-When modern authentication (a trusted identity provider) such as SAML 1.1 or OIDC 1.0 is used, the People Picker control canΓÇÖt search, resolve, and validate users and groups without writing a custom claim provider through C#.
+When modern authentication (a trusted identity provider) such as SAML 1.1 or OIDC 1.0 is used, the People Picker control can't search, resolve, and validate users and groups without writing a custom claim provider through C#.
In SharePoint Server Subscription Edition, the People Picker has been enhanced to allow resolving users and groups based on their profiles in the User Profile Application (UPA). UPA must be configured to synchronize users and groups from the trusted identity provider membership store. This allows the People Picker to only resolve valid users and groups without requiring a custom claims provider.
The `IdentifierClaim` parameter specifies which claim type from the trusted STS
- **UseUPABackedClaimProvider** <br/> This switch parameter enables the People Picker to search and select users and groups from the User Profile Application service. And it creates a `SPClaimProvider`, which has the same name as `SPTrustedIdentityTokenIssuer`. > [!NOTE]
- > This parameter canΓÇÖt be used to create an OIDC SPTrustedTokenIssuer.
+ > This parameter can't be used to create an OIDC SPTrustedTokenIssuer.
### Example
Following are the two ways to synchronize user profiles into the SharePoint User
![Add new synchronization connection.](../media/add-new-sync-connection.png) - Use Microsoft Identity Manager (MIM). To use MIM, see [Microsoft Identity Manager in SharePoint Servers 2016 and 2019](/sharepoint/administration/microsoft-identity-manager-in-sharepoint-server-2016).
- - There should be two agents inside the MIM synchronization Manager UX after MIM is set up. One agent is used to import user profiles from the source IDP to the MIM database. And another agent is used to export user profiles from the MIM database to the SharePoint User Profile service application.
+- There should be two agents inside the MIM synchronization Manager UX after MIM is set up. One agent is used to import user profiles from the source IDP to the MIM database. And another agent is used to export user profiles from the MIM database to the SharePoint User Profile service application.
During the synchronization, provide the following properties to the User Profile service application:
During the synchronization, provide the following properties to the User Profile
For AD Import synchronization, the **Central Administration -> Application Management -> Manage service applications -> User Profile Service Application -> Manage User Properties** UX will allow administrators to edit the **SPS-ClaimID** to indicate which property in the source identity provider should be synchronized to **SPS-ClaimID**. For example, if the **SPS-ClaimID** is email, set **Claim User Identifier** as **Email** in this UX.
-> [!Note]
+> [!NOTE]
> The display name of **SPS-ClaimID** is **Claim User Identifier** in the UX and administrator can customize the display names. ![Claim User Identifier.](../media/claim-user-identifier.png)
To enable the People Picker control to work with groups, run the following steps
```powershell $sidClaimMap = New-SPClaimTypeMapping -IncomingClaimType "http://schemas.microsoft.com/ws/2008/06/identity/claims/groupsid" -IncomingClaimTypeDisplayName "SID" -SameAsIncoming
- $tokenissuer = New-SPTrustedIdentityTokenIssuer -ClaimsMappings $sidClaimMap, $emailClaimMap …
+ $tokenissuer = New-SPTrustedIdentityTokenIssuer -ClaimsMappings $sidClaimMap, $emailClaimMap ...
``` This sample cmdlets creates a `claimmap` object of type `groupsid` and indicates that it works with the **SID** property of the group. Then it creates a new identity issuer, which can understand this mapping.
To enable the People Picker control to work with groups, run the following steps
2. Synchronize **SID** property of groups from the identity provider to the **SID** property in User Profile service application. - For AD Import synchronization, SID will synchronize automatically from the source identity provider to the SharePoint User Profile service application.
- - For MIM synchronization, take the property mapping from the identity provider to MIM and then from MIM to the SharePoint User Profile service application so that MIM can synchronize the group **SID** from the identity provider to the SharePoint User Profile service application. ItΓÇÖs like how we do user profile synchronization for the **SPS-ClaimID** property for user profiles.
+ - For MIM synchronization, take the property mapping from the identity provider to MIM and then from MIM to the SharePoint User Profile service application so that MIM can synchronize the group **SID** from the identity provider to the SharePoint User Profile service application. It's like how we do user profile synchronization for the **SPS-ClaimID** property for user profiles.
> [!Note] > For MIM synchronization, map **sAMAccountName** to **accountName** from MIM to the SharePoint User Profile service application.
SharePoint Excel Services Overview https://github.com/MicrosoftDocs/OfficeDocs-SharePoint/commits/public/SharePoint/SharePointServer/administration/excel-services-overview.md
Title: "Overview of Excel Services in SharePoint Server 2013"-+
description: "Excel Services is a business intelligence tool in SharePoint Serve
# Overview of Excel Services in SharePoint Server 2013 [!INCLUDE[appliesto-2013-xxx-xxx-xxx-xxx-md](../includes/appliesto-2013-xxx-xxx-xxx-xxx-md.md)]
-
+ Excel Services is a shared service that you can use to publish Excel workbooks on SharePoint Server 2013. The published workbooks can be managed and secured according to your organizational needs and shared among SharePoint Server 2013 users, who can render the workbooks in a browser. Excel Services is available only in the Enterprise edition of SharePoint Server 2013.
-
+ Excel Services is used primarily for business intelligence scenarios. Excel workbooks can be connected to external data sources, reports created, and then the workbook can be published to a SharePoint document library. When a user opens the workbook from the the document library, it is rendered in the browser by using Excel Services. The external data connection is maintained and the data is refreshed if necessary. This allows broad sharing of reports throughout an organization.
-
-Excel Services consists of Excel Calculation Services, the Excel Web Access Web Part, and Excel Web Services for programmatic access. It supports sharing, securing, managing, and using Excel workbooks in a browser by providing the following:
-
+
+Excel Services consists of Excel Calculation Services, the Excel Web Access Web Part, and Excel Web Services for programmatic access. It supports sharing, securing, managing, and using Excel workbooks in a browser by providing the following:
+ - Global settings for managing workbooks, which include settings for security, load balancing, session management, memory utilization, workbook caches, and external data connections.
-
+ - Trusted file locations (which allow you to define which document libraries are trusted by Excel Services) together with session management, workbook size, calculation behavior, and external data settings of workbooks stored in those locations.
-
+ - An extensive list of trusted data providers for connecting to your data, plus the ability to add your own trusted data provider.
-
+ - Trusted data connection libraries, which allow you to define which data connection libraries in your farm are trusted by Excel Services.
-
+ - The ability to add your own user-defined function assemblies.
-
+ While users can interact with Excel workbooks in a browser through Excel Services, the workbooks cannot be edited in the browser by using Excel Services. Programmatic options are available.
-
+ Looking at several specific scenarios can help you understand how best to take advantage of Excel
-
-- **Sharing workbooks** Users can save Excel workbooks to a SharePoint Server document library to give other users browser-based access to the server-calculated version of the workbook. When the workbook is accessed, Excel Services loads the workbook, refreshes the external data if it is necessary, calculates it if it is necessary, and sends the resulting output view back through the browser. A user can interact with Excel-based data by sorting, filtering, expanding, or collapsing PivotTables, and by passing in parameters. This provides the ability to perform analysis on published workbooks. A user does not have to have Excel installed to view the workbook. Users will always view the latest version of a workbook, and they can interact with it in a browser. Security permissions can be set to limit what access is provided to which user.
-
-- **Building business intelligence (BI) dashboards** Browser-based dashboards can be created by using Excel and Excel Services together with the Excel Web Access Web Part. PerformancePoint Services can also use Excel Services workbooks as a data source.
-
-- **Reuse of logic encapsulated in Excel workbooks in custom applications** Besides a browser-based interface with the server, Excel Services provides a Web-service-based interface so that a published workbook can be accessed programmatically by any application that uses Web services. The Web service applications can change values, calculate the workbook, and retrieve some or all of the updated workbook by using that interface according to what security permissions are set for the published workbook.
-
-- **Report Building** One of the most useful features of Excel Services is report building. By publishing data-connected workbooks to a SharePoint document library and making them available through Excel Services, you can make reports that you have created in Excel available to others in your organization. Instead of multiple users having separate copies of the workbooks on their computers, the workbooks can be created and changed by a trusted author in a central location that is trusted by Excel Services. The correct version of the worksheet is easier to find, share, and use from Excel, SharePoint Server, and other applications.
-
+
+- **Sharing workbooks** Users can save Excel workbooks to a SharePoint Server document library to give other users browser-based access to the server-calculated version of the workbook. When the workbook is accessed, Excel Services loads the workbook, refreshes the external data if it is necessary, calculates it if it is necessary, and sends the resulting output view back through the browser. A user can interact with Excel-based data by sorting, filtering, expanding, or collapsing PivotTables, and by passing in parameters. This provides the ability to perform analysis on published workbooks. A user does not have to have Excel installed to view the workbook. Users will always view the latest version of a workbook, and they can interact with it in a browser. Security permissions can be set to limit what access is provided to which user.
+
+- **Building business intelligence (BI) dashboards** Browser-based dashboards can be created by using Excel and Excel Services together with the Excel Web Access Web Part. PerformancePoint Services can also use Excel Services workbooks as a data source.
+
+- **Reuse of logic encapsulated in Excel workbooks in custom applications** Besides a browser-based interface with the server, Excel Services provides a Web-service-based interface so that a published workbook can be accessed programmatically by any application that uses Web services. The Web service applications can change values, calculate the workbook, and retrieve some or all of the updated workbook by using that interface according to what security permissions are set for the published workbook.
+
+- **Report Building** One of the most useful features of Excel Services is report building. By publishing data-connected workbooks to a SharePoint document library and making them available through Excel Services, you can make reports that you have created in Excel available to others in your organization. Instead of multiple users having separate copies of the workbooks on their computers, the workbooks can be created and changed by a trusted author in a central location that is trusted by Excel Services. The correct version of the worksheet is easier to find, share, and use from Excel, SharePoint Server, and other applications.
+ ## Farms using Office Web Apps Server If your SharePoint Server farm has been integrated with Office Web Apps Server and Excel Web App, the features available in Excel Services will depend on how Excel Web App has been configured.
-
+ Excel Web App runs in one of two modes:
-
-- **SharePoint view mode** In this mode, Excel Services is used to view workbooks in the browser.
-
-- **Office Web Apps Server view mode** In this mode, Excel Web App is used to view workbooks in the browser.
-
+
+- **SharePoint view mode** In this mode, Excel Services is used to view workbooks in the browser.
+
+- **Office Web Apps Server view mode** In this mode, Excel Web App is used to view workbooks in the browser.
+ The following table lists the business intelligence features available in Excel Services in each mode.
-
+ **BI features in Excel Services, by mode**
-|&nbsp;|**SharePoint Server only**|**SharePoint Server with Excel Web App (SharePoint view mode)**|**SharePoint Server with Excel Web App (Office Web Apps Server view mode)**|
+|&nbsp;|SharePoint Server only|SharePoint Server with Excel Web App (SharePoint view mode)|SharePoint Server with Excel Web App (Office Web Apps Server view mode)|
|:--|:--|:--|:--|
-|Excel Web Access Web Part <br/> |× <br/> |× <br/> ||
-|Refresh OData connections <br/> |× <br/> |× <br/> ||
-|View and interact with Power View reports <br/> |× <br/> |× <br/> ||
-|View and interact with Power Pivot data models <br/> |× <br/> |× <br/> ||
-|Refresh Power Pivot data models <br/> |× <br/> |× <br/> ||
-|Refresh data by using the Excel Services unattended service account <br/> |× <br/> |× <br/> ||
-|Refresh data by using Secure Store and Windows credentials <br/> |× <br/> |× <br/> |× <br/> |
-|Refresh data by using Effective User Name connections <br/> |× <br/> |× <br/> ||
-|Kerberos delegation <br/> |× <br/> |× <br/> ||
-
+|Excel Web Access Web Part|x|x||
+|Refresh OData connections|x|x||
+|View and interact with Power View reports|x|x||
+|View and interact with Power Pivot data models|x|x||
+|Refresh Power Pivot data models|x|x||
+|Refresh data by using the Excel Services unattended service account|x|x||
+|Refresh data by using Secure Store and Windows credentials|x|x|x|
+|Refresh data by using Effective User Name connections|x|x||
+|Kerberos delegation|x|x||
+ ## See also
-#### Concepts
+### Concepts
-
[Business intelligence capabilities in Excel Service (SharePoint Server 2013)](bi-capabilities-in-excel-and-excel-services.md)-
SharePoint From Site Column To Managed Propertywhat S Up With That https://github.com/MicrosoftDocs/OfficeDocs-SharePoint/commits/public/SharePoint/SharePointServer/administration/from-site-column-to-managed-propertywhat-s-up-with-that.md
For creating an automatically **managed property** name, the following conventio
If you want more information, there is an overview table with examples for all site column types in [Automatically created managed properties in SharePoint Server](../technical-reference/automatically-created-managed-properties-in-sharepoint.md).
-That might not have been as straightforward as our simple example, and there is one exception to the rule…
+That might not have been as straightforward as our simple example, and there is one exception to the rule...
### Naming convention for the default site columns in the Products list <a name="BKMK_NamingConventionfortheDefaultSiteColumnsintheProductsList"> </a>
SharePoint Hide Sharepoint Server Social Features https://github.com/MicrosoftDocs/OfficeDocs-SharePoint/commits/public/SharePoint/SharePointServer/administration/hide-sharepoint-server-social-features.md
Title: "Hide SharePoint Server social features"-+
description: "Learn how to remove Web Parts and hide user interface controls tha
# Hide SharePoint Server social features [!INCLUDE[appliesto-2013-2016-2019-SUB-xxx-md](../includes/appliesto-2013-2016-2019-SUB-xxx-md.md)]
-
+ The Yammer Embed widget for SharePoint lets you embed Yammer feeds into on-premises SharePoint Server sites to make them more social and engaging. Before you can do that, you have to do the following steps:
-
+ - Remove the Newsfeed Web Parts from My Sites and Team Sites.
-
+ - Hide the user interface controls that provide social features.
-
+ - Install the Yammer Embed widget for SharePoint.
-
+ - Add the Yammer feeds to your sites.
-
+ This article takes you through the steps required to do the first two steps: removing the Newsfeed Web Parts and hiding the user interface controls.
-
+ For information about how to add a Yammer feed on your sites, see [Add the Yammer Embed widget to a SharePoint page](add-the-yammer-embed-widget-to-a-sharepoint-page.md).
-
-
+ ## Which SharePoint Server enterprise social features are removed? When you follow the steps in this article, the following enterprise social features are removed:
-
+ - Viewing or posting to conversations in newsfeeds on My Sites and team sites.
-
+ - Viewing activities in the Newsfeed.
-
+ - Viewing activities on profile pages.
-
-- Viewing the **I'm Following** Web Part on My Sites.
-
+
+- Viewing the **I'm Following** Web Part on My Sites.
+ - Mentioning users from their profile page.
-
+ > [!NOTE]
- > This is shown on users' profile page when they fill in the **Ask Me About** field on their profile.
-
+ > This is shown on users' profile page when they fill in the **Ask Me About** field on their profile.
+ - Following people.
-
+ - Following tags.
-
-- Viewing **Trending #tags** on users' **Newsfeed** page.
-
+
+- Viewing **Trending #tags** on users' **Newsfeed** page.
+ > [!NOTE]
-> None of the procedures in this article remove the SharePoint Server enterprise social features and functionality permanently. The features are kept to let future upgrades of SharePoint Server finish successfully.
-
+> None of the procedures in this article remove the SharePoint Server enterprise social features and functionality permanently. The features are kept to let future upgrades of SharePoint Server finish successfully.
+ ## Which SharePoint Server enterprise social features stay the same? When you follow the steps in this article, the following enterprise social features do not change:
-
+ - Following documents. Users can follow documents to bookmark the ones they are interested in. Users can follow documents from the hover panel in OneDrive, the hover panel in the library list view, the ribbon in a document library, and so on. Users can see their followed documents by choosing **OneDrive**, then choosing **Followed Documents**.
-
-- Following sites. Users can follow sites to bookmark the ones they are interested in. Users can follow sites by choosing **Sites** on the top navigation bar.
-
-- Updating information on the **Edit Details** page, as shown in the following screenshot.
-
+
+- Following sites. Users can follow sites to bookmark the ones they are interested in. Users can follow sites by choosing **Sites** on the top navigation bar.
+
+- Updating information on the **Edit Details** page, as shown in the following screenshot.
+ ![The Basic Information screen for the Edit Details page](../media/EditDetailsBasicInformation.GIF)
-
+ - Posting on a note board.
-
+ - Liking or rating documents in a document library, and a video from the asset library.
-
+ - Using community sites.
-
-- Changing activity settings on the **Newsfeed Settings** page. The following screenshot shows the **Newsfeed Settings** page.
-
+
+- Changing activity settings on the **Newsfeed Settings** page. The following screenshot shows the **Newsfeed Settings** page.
+ ![Newsfeed Settings for the Edit Details page](../media/EditDetailsNewsfeedSettings.GIF)
-
+ > [!IMPORTANT]
- > When the changes in this article are deployed, users can continue to use and fill in fields in the **Newsfeed Settings** page. But the information is no longer shown on My Site. However, information in the **Basic Information** and **Contact Information** pages are still shown on My Site.
-
-##SharePoint Server 2016
+ > When the changes in this article are deployed, users can continue to use and fill in fields in the **Newsfeed Settings** page. But the information is no longer shown on My Site. However, information in the **Basic Information** and **Contact Information** pages are still shown on My Site.
+
+## SharePoint Server 2016
Remove Newsfeed Web Parts in team sites and My Sites.
-###Remove Newsfeed Web Parts from Team Sites in SharePoint Server 2016
+### Remove Newsfeed Web Parts from Team Sites in SharePoint Server 2016
Each site admin must apply the following steps to their site.
-1. From any site in SharePoint Server 2016 that has a Newsfeed web part, select **Edit**.
+1. From any site in SharePoint Server 2016 that has a Newsfeed web part, select **Edit**.
2. Move the pointer over the **Site Feed** Web Part, and select the box that appears on the right side of the Web Part.
-3. On the ribbon, chose the **Web Part** tab, and then select **Delete**.
-
+3. On the ribbon, chose the **Web Part** tab, and then select **Delete**.
+ 4. Select **OK**.
-5. On the ribbon, select the **Page** tab, and then select **Stop Editing**, and to save your changes, select **Save**.
-
+5. On the ribbon, select the **Page** tab, and then select **Stop Editing**, and to save your changes, select **Save**.
+ 6. Check that the Team Site does not show the removed Web Parts.
-###Remove Newsfeed Web Parts from My Sites in SharePoint Server 2016
+### Remove Newsfeed Web Parts from My Sites in SharePoint Server 2016
If you have configured My Site for SharePoint Server 2016, you need to remove the Newseed web part from each My Site. A My Site host admin has to apply the following steps to each server in the server farm.
-1. Move the pointer over the **Newsfeed** Web Part, and select the box that appears on the right side of the Web Part.
-
+1. Move the pointer over the **Newsfeed** Web Part, and select the box that appears on the right side of the Web Part.
+ 2. On the ribbon, select the **Web Part** tab, and then select **Delete**.
-
+ 3. Select **OK**.
-
-4. Repeat steps 2-4 for the **Followed Counts** and **Trending Hashtags** Web Parts.
+
+4. Repeat steps 2-4 for the **Followed Counts** and **Trending Hashtags** Web Parts.
## SharePoint Server 2013 Remove Newsfeed Web Parts in team sites and My Sites, and hide user interface controls that provide social features.
Remove Newsfeed Web Parts in team sites and My Sites, and hide user interface co
<a name="proc2"> </a> As the site collection admin, you have to follow these steps on each team site that you want to remove the site feed from.
-
+ 1. Browse to the team site from which you want to remove the site feed, select **Settings**, and then select **Edit Page**.
-
-2. Hover over the **Site Feed** Web Part, and select the box that appears to the right of the Web Part.
-
+
+2. Hover over the **Site Feed** Web Part, and select the box that appears to the right of the Web Part.
+ 3. On the ribbon, select the **Web Part** tab, and then select **Delete**.
-
+ 4. Select **OK**.
-
+ 5. On the ribbon, select **Save**.
-
-6. Check that the team site no longer shows the **Site Feed** Web Part.
-
+
+6. Check that the team site no longer shows the **Site Feed** Web Part.
+ ![Team sites home page with Newsfeed removed](../media/TeamsiteshomepagewithNewsfeedremoved.GIF) ### Remove Newsfeed Web Parts from My Sites in SharePoint Server 2013 <a name="proc1"> </a> A My Site host admin has to apply the following steps to each web server in the server farm.
-
-1. From any site in SharePoint Server 2013, to browse to a user's My Site, select **Newsfeed**.
-
+
+1. From any site in SharePoint Server 2013, to browse to a user's My Site, select **Newsfeed**.
+ 2. On the **Newsfeed** page, select **Settings**, and then select **Edit Page**.
-
-3. Move the pointer over the **Newsfeed** Web Part, and select the box that appears on the right side of the Web Part.
-
+
+3. Move the pointer over the **Newsfeed** Web Part, and select the box that appears on the right side of the Web Part.
+ 4. On the ribbon, select the **Web Part** tab, and then select **Delete**.
-
+ 5. Select **OK**.
-
-6. Repeat steps 3-5 for the **Followed Counts** and **Trending Hashtags** Web Parts.
-
+
+6. Repeat steps 3-5 for the **Followed Counts** and **Trending Hashtags** Web Parts.
+ > [!NOTE]
- > It's a good idea to remove all social Web Parts, hidden or not hidden, to improve performance.
-
-7. On the ribbon, to save your changes, select **Stop Editing**.
-
+ > It's a good idea to remove all social Web Parts, hidden or not hidden, to improve performance.
+
+7. On the ribbon, to save your changes, select **Stop Editing**.
+ 8. Check that the My Site does not show the removed Web Parts.
-
+ ![Newsfeed page with Newsfeed removed](../media/NewsfeedpagewithNewsfeedremoved.GIF)
-
-9. To open the user's profile page, select **About me**.
-
+
+9. To open the user's profile page, select **About me**.
+ 10. Select **Settings**, and then select **Edit Page**.
-
-11. Move the pointer over the **Activity Feed** Web Part, and select the box that appears on the right side of the Web Part.
-
+
+11. Move the pointer over the **Activity Feed** Web Part, and select the box that appears on the right side of the Web Part.
+ 12. On the ribbon, select the **Web Part** tab, and then select **Delete**.
-
+ 13. Select **OK**.
-
-14. On the ribbon, to save your changes, select **Stop Editing**.
-
-15. Check that the user's profile page no longer shows the **Activity Feed** Web Part.
-
+
+14. On the ribbon, to save your changes, select **Stop Editing**.
+
+15. Check that the user's profile page no longer shows the **Activity Feed** Web Part.
+ ![The "About Me" page with Newsfeed removed](../media/AboutMepagewithNewsfeedremoved.GIF)
-
-
### Hide user interface controls that provide social features in SharePoint Server 2013 <a name="proc3"> </a> To hide the user interface controls that provide the SharePoint Server 2013 social features, you'll create a custom cascading style sheet (CSS) file and add it to a Master Page. This removes SharePoint Server 2013 social features and replaces them with equivalent Yammer features. First, you create a custom CSS file and upload it to the Style Library for your My Site. Then, based on the type of Master Page your site uses, you reference the CSS file in your Master Page by using one of the following methods described in this article:
-
+ - Register the CSS file for a custom Master Page
-
+ - Register the CSS file for an out-of-box Master Page
-
+ > [!NOTE]
-> To register the CSS file for a custom Master Page, you have to have Contribute permission on the My Site host site. To register the CSS file for an out-of-box Master Page, you have to be a farm admin to install the required custom delegate control, and you also need Site Owner permissions on the My Site to enable the control for that site.
-
+> To register the CSS file for a custom Master Page, you have to have Contribute permission on the My Site host site. To register the CSS file for an out-of-box Master Page, you have to be a farm admin to install the required custom delegate control, and you also need Site Owner permissions on the My Site to enable the control for that site.
+ After you complete these steps, the following changes are applied to the SharePoint Server 2013 social features:
-
-- Removal of the **follow this person** link on another user's **About Me** page.
-
-- Mentioning a user from the profile page ( **About Me**) after the user has filled in the **Ask Me About** field on the user's profile page.
-
-- Following tags from the **#tags I'm Following** page.
-
-- Removal of the **follow multiple people** link from the **People I'm Following page** (mypeople.aspx).
-
- **Create the HideNewsfeed.css file**
-
+
+- Removal of the **follow this person** link on another user's **About Me** page.
+
+- Mentioning a user from the profile page ( **About Me**) after the user has filled in the **Ask Me About** field on the user's profile page.
+
+- Following tags from the **#tags I'm Following** page.
+
+- Removal of the **follow multiple people** link from the **People I'm Following page** (mypeople.aspx).
+
+#### Create the HideNewsfeed.css file
+ 1. On your computer, open Notepad.
-
+ 2. Select **File** > **Save As**.
-
+ 3. In the **File name** box, enter HideNewsfeed.css.
-
+ 4. Copy and paste the following code into HideNewsfeed.css:
-
- ```
- /* Hide the following SP Social features */
- /* Hide the microfeed div in MySite and team sites */
- #ms-microfeeddiv,
- /* Hide the Followed counts div in MySite */
- .ms-profile-followedCountDiv,
- /* Hide the trending tags div in MySite */
- .ms-mysite-contentBox .ms-mpSearchBox+.ms-webpart-zone,
- /* Hide the follow button on others' About Me page */
- /* Hide the ask me about option on the About Me page */
- #ms-profile-followLinkDiv, .ms-askMeAbout-valuesMoreThanFive, .ms-askMeAbout-valuesFooter,
- .ms-askMeAbout-bulletImage, .ms-askMeAbout-valuesFiveOrLess,
- /* Hide the follow tag option from the landing page */
- .ms-followedTags-followTag,
- /* Hide the follow people option from the landing page */
- .ms-people-followMultiplePeople{
- display:none!important;
- }
- ```
+
+ ```css
+ /* Hide the following SP Social features */
+ /* Hide the microfeed div in MySite and team sites */
+ #ms-microfeeddiv,
+ /* Hide the Followed counts div in MySite */
+ .ms-profile-followedCountDiv,
+ /* Hide the trending tags div in MySite */
+ .ms-mysite-contentBox .ms-mpSearchBox+.ms-webpart-zone,
+ /* Hide the follow button on others' About Me page */
+ /* Hide the ask me about option on the About Me page */
+ #ms-profile-followLinkDiv, .ms-askMeAbout-valuesMoreThanFive, .ms-askMeAbout-valuesFooter,
+ .ms-askMeAbout-bulletImage, .ms-askMeAbout-valuesFiveOrLess,
+ /* Hide the follow tag option from the landing page */
+ .ms-followedTags-followTag,
+ /* Hide the follow people option from the landing page */
+ .ms-people-followMultiplePeople{
+ display:none!important;
+ }
+ ```
5. Save and close the file.
-
+ 6. Browse to your My Site Host, then select **Settings** > **Site Contents**.
-
+ 7. Select **Style Library**.
-
+ 8. On the ribbon, select the **Files** tab, and then select **Upload Document**.
-
+ 9. Select **Browse**, locate the HideNewsfeed.css file, and then select **Open**.
-
+ 10. Select **OK**.
-
+ If your My Site uses a custom Master Page, follow the steps in _Register the CSS file for a custom Master Page_. If your My Site uses an out-of-box Master Page, follow the steps in _Register the CSS file for an out-of-box Master Page_.
-
- **Register the CSS file for a custom Master Page**
-
+
+#### Register the CSS file for a custom Master Page
+ 1. Using a text editor, open the custom Master Page.
-
-2. Copy and paste the following code into the Master Page immediately before the `</head>` tag:
-
- ```
- <SharePoint:CssRegistration ID="HideNewsfeedCssRegistration" Name="<% $SPUrl:~SiteCollection/Style Library/HideNewsfeed.css %>" runat="server" After="corev15.css" />
- ```
+
+2. Copy and paste the following code into the Master Page immediately before the `</head>` tag:
+
+ ```css
+ <SharePoint:CssRegistration ID="HideNewsfeedCssRegistration" Name="<% $SPUrl:~SiteCollection/Style Library/HideNewsfeed.css %>" runat="server" After="corev15.css" />
+ ```
3. Save and close the Master Page.
-
+ 4. Refresh your site to see the changes.
-
- **Register the CSS file for an out-of-box Master Page**
-
+
+#### Register the CSS file for an out-of-box Master Page
+ 1. Start Visual Studio 2013 with Office Developers Tools for Visual Studio.
-
+ 2. Select **File** > **New** > **Project**.
-
+ 3. In the **Installed** pane, expand **Visual C#** > **Office/SharePoint**, then select **SharePoint Solutions**.
-
+ 4. Select **SharePoint 2013 - Empty Project**.
-
+ 5. In the **Name** box, enter HideNewsfeed.
-
+ 6. Select **OK**.
-
+ 7. In the **SharePoint Customization Wizard**, select the My Site Host site collection to use for debugging.
-
+ 8. Select **Deploy as a farm solution**, then select **Finish**.
-
+ 9. Select **Project** > **Add New Item**.
-
+ 10. In the **Add New Item - HideNewsfeed** dialog box, select **User Control**.
-
+ 11. In the **Name** box, enter HideNewsfeed.ascx, then select **Add**.
-
+ 12. Copy and paste the following line at the end of HideNewsfeed.ascx
-
- ```
- <SharePoint:CssRegistration ID="HideNewsfeedCssRegistration" Name="<% $SPUrl:~SiteCollection/Style Library/HideNewsfeed.css %>" runat="server" After="corev15.css" />
- ```
+
+ ```css
+ <SharePoint:CssRegistration ID="HideNewsfeedCssRegistration" Name="<% $SPUrl:~SiteCollection/Style Library/HideNewsfeed.css %>" runat="server" After="corev15.css" />
+ ```
13. Save the HideNewsfeed.ascx file.
-
+ 14. Select **Project** > **Add New Item**.
-
+ 15. In the **Add New Item - HideNewsfeed** dialog, select **Empty Element**.
-
+ 16. In the **Name** box, enter HideNewsfeed, then select **Add**.
-
+ 17. In the Elements.xml file, press Ctrl+A, then press Delete.
-
+ 18. Copy and paste the following XML in the Elements.xml file:
-
- ```
- <?xml version="1.0" encoding="utf-8"?>
- <Elements xmlns="http://schemas.microsoft.com/sharepoint/">
- <Control Id="AdditionalPageHead" ControlSrc="~/_CONTROLTEMPLATES/15/HideNewsfeed/HideNewsfeed.ascx"ΓÇ»/>
- </Elements>
- ```
+
+ ```css
+ <?xml version="1.0" encoding="utf-8"?>
+ <Elements xmlns="http://schemas.microsoft.com/sharepoint/">
+ <Control Id="AdditionalPageHead" ControlSrc="~/_CONTROLTEMPLATES/15/HideNewsfeed/HideNewsfeed.ascx" />
+ </Elements>
+ ```
19. Save the Elements.xml file.
-
+ 20. Select **Build** > **Deploy Solution**.
-
+ The control has to be deployed on each web server in the farm. For information about how to deploy and install a solution to the farm, see [Add-SPSolution](/powershell/module/sharepoint-server/Add-SPSolution?view=sharepoint-ps&preserve-view=true) and [Install-SPSolution](/powershell/module/sharepoint-server/Install-SPSolution?view=sharepoint-ps&preserve-view=true).
-
- The result is a SharePoint solution package that can be deployed and activated on the My Site Host site.
-
+
+ The result is a SharePoint solution package that can be deployed and activated on the My Site Host site.
+ 21. To activate the feature, browse to your My Site Host site, select **Settings** > **Site Settings**.
-
+ 22. On the **Site Settings** page, in the **Site Actions** section, select **Manage site features**.
-
+ 23. Locate the **HideNewsfeed Feature1**, and select **Activate**.
-
+ > [!NOTE]
- > Instead of uploading the HideNewsfeed.css to the Style Library, you can create the CSS file in the SharePoint Solution package so that it is deployed together with the solution.
-
-24. Browse to the **Newsfeed** page to check that the controls are no longer shown on the page.
-
+ > Instead of uploading the HideNewsfeed.css to the Style Library, you can create the CSS file in the SharePoint Solution package so that it is deployed together with the solution.
+
+24. Browse to the **Newsfeed** page to check that the controls are no longer shown on the page.
+ ## Additional steps <a name="more"> </a> To finish the integration of Yammer into your on-premises SharePoint Server environment, you have to install the Yammer Embed widget for SharePoint. For more information, see [Add the Yammer Embed widget to a SharePoint page](add-the-yammer-embed-widget-to-a-sharepoint-page.md).
-
+ ## Acknowledgements <a name="more"> </a> The SharePoint Server 2013 Content Publishing team thanks Vidya Srinivasan and Ben Rinaca from the Microsoft SharePoint Server Product team for their contribution to this article.
-
+ ## See also <a name="more"> </a> #### Concepts [Integrate Yammer with on-premises SharePoint Server environments](integrate-yammer-with-on-premises-sharepoint-server-environments.md)-
SharePoint Integrating Social Media With Public Facing Websites https://github.com/MicrosoftDocs/OfficeDocs-SharePoint/commits/public/SharePoint/SharePointServer/administration/integrating-social-media-with-public-facing-websites.md
Title: "Integrating social media with public-facing websites in SharePoint"-+
description: "Learn how to integrate social media with public-facing websites in
# Integrating social media with public-facing websites in SharePoint
-
-Integrating social media within your organization can help you reach your organization's goals. The integration can be done on your organization's intranet to increase transparency, but you can also make social networks a part of your public-facing website to expand reach and increase conversion of your website.
-
+
+Integrating social media within your organization can help you reach your organization's goals. You can do the integration on your intranet to increase transparency. But, you can also integrate social networks on your public-facing website to expand reach and increase conversion.
+ ## Social media integration Integration with social media has become hype in the last several years. Many organizations want social networks to be integrated with their public-facing website without a good understanding of what such integration means, and how it should support the organization's goals. This article is not about helping you form a vision for using social networks within your organization. Instead it presents several different integration scenarios, and shows how you can benefit from them. Eventually you must make an educated choice about which of these integration techniques will work for your scenario, and how the integration should look.
-
+ From the communication perspective you can integrate with social media in two ways:
-
-- Publish information from your website to social networks, which can be as easy as adding a Facebook Like button. This will allow you to expand the reach of the content on your website beyond its boundaries and reach your visitors' friends and colleagues.
-
-- Leverage the information about the current visitor from his social networks to control which content on your website would be the most relevant to her. By using this approach you can help your visitors discover new content on your website that they are not aware of. Once again this can help you expand your reach and increase conversion on your website.
-
+
+- Publish information from your website to social networks, which can be as easy as adding a Facebook Like button. This action will allow you to expand the reach of the content on your website beyond its boundaries and reach your visitors' friends and colleagues.
+
+- Use the current visitor's information from social networks to control which content on your website would be the most relevant. Using this approach will help your visitors discover new content on your website. This action can help you expand your reach and increase conversion on your website.
+ This article describes the first option.
-
+ ## The basics of social media integration in SharePoint 2013
-Integrating with social media is all about reaching as many people as possible. Information about the content on your website, whether it is articles, blog posts or products, when discovered and found valuable, it can be shared by your visitors with their friends, who again might share it with their friends. Before you know it, your content will reach people who otherwise might not have even known about your website. But, for this to occur, you have to to make sure that that when your content is shared on social networks, it looks exactly the way that you want it to look.
-
-Just as you can optimize your web content for Internet search engines, you can provide some meta information about your content to social networks. Many social networks such as Facebook or Yammer use [the Open Graph protocol](https://go.microsoft.com/fwlink/p/?LinkId=400785) to retrieve information about your content. To control how your content is displayed when it is shared on social networks, you have to integrate Open Graph metadata into your website. The metadata should describe the essence of your content so that anyone who sees your content on a social network will want to click on it.
-
+Integrating with social media is all about reaching as many people as possible. When visitors discover the content of your website, the can share it with their friends, who again might share it with their friends. Before you know it, your content will reach people who otherwise might not have even known about your website. But, for this action to occur, you need to verify your content appears exactly the way you want it to look on social networks.
+
+Just as you can optimize your web content for Internet search engines, you can provide meta information about your content to social networks. Many social networks (for example, Facebook or Yammer) use [the Open Graph protocol](https://go.microsoft.com/fwlink/p/?LinkId=400785) to retrieve information about your content. To control how your content is displayed when it's shared on social networks, you need to integrate Open Graph metadata into your website. The metadata should describe the essence of your content so that anyone who sees your content on a social network will want to click on it.
+ ## Integrating Open Graph into a public-facing website built with SharePoint 2013
-Publishing Open Graph metadata for a website that is built with SharePoint Server 2016 isn't complex. But there are several things that you should consider. First of all Open Graph defines different types of web content - similar to what you can achieve with Content Types in SharePoint. Before you start integrating Open Graph into your website, you should have a good understanding of what types of content that you have on your website, and how it can be described most effectively by using Open Graph.
-
-Next to the different types of content that you can publish on your website, there are also differences in how that content is published. SharePoint Server 2016 offers two content publishing models:
-
-- The classic content publishing model, that you might have known from SharePoint 2007 and 2010 and where the physical location of pages determined their location in the hierarchy and navigation of the website
-
-- The new search-driven publishing model that uses SharePoint Server 2016 Search to publish content from one or more sources
-
-These publishing models have two ways of publishing content and, depending on which one that you are using on your website, you should plan for publishing the information according to your content publishing model.
-
-Open Graph information is published using HTML meta tags. Those tags must be located in the head section of your website. To support publishing different Open Graph information for different types of pages and content publishing models, you should define a Content Place Holder in your Master Page. This will allow you to fill that placeholder with the appropriate metadata from the different Page Layouts.. The following code example shows a Content Place Holder added to the standard seattle.master Master Page to support publishing Open Graph information:
-
-```
+Publishing Open Graph metadata for a website that's built with SharePoint Server 2016 isn't complex. But, there are several things that you should consider.
+
+First of all Open Graph defines different types of web content, similar to what you can achieve with Content Types in SharePoint. Before you integrate Open Graph into your website, you need a good understanding of your types of content and how to describe it effectively.
+
+There are also differences in how content is published. SharePoint Server 2016 offers two content publishing models:
+
+- The classic content publishing model from SharePoint 2007 and 2010 where the physical location of pages determines their location in the hierarchy and navigation of the website.
+
+- The new search-driven publishing model that uses SharePoint Server 2016 Search to publish content from one or more sources.
+
+These publishing models have two ways of publishing content. Plan for publishing the information according to your content publishing model.
+
+Open Graph information is published using HTML meta tags. Those tags must be located in the head section of your website. To support publishing different Open Graph information, you should define a Content Place Holder in your Master Page. This action will allow you to fill that placeholder with the appropriate metadata from the different Page Layouts. The following code example shows a Content Place Holder added to the standard seattle.master Master Page to support publishing Open Graph information:
+
+```HTML
<head>
-…
+...
<!--MS:<asp:ContentPlaceHolder id="OpenGraphPlaceHolder" runat="server">--> <!--ME:</asp:ContentPlaceHolder>-->
-…
+...
</head> ```
-According to the Open Graph protocol there are four properties that are required for every web page: *title* , *type* , *image* , and *URL* . Although Open Graph defines several content types, if you are not publishing information about video or audio, the odds are high that you'll be using the *article* type for most your web pages. Because not every page is an article, you might want to use the website type. The website type is the default type if no type is specified. To simplify working with Open Graph we could expand the code example above by adding the information about the title, URL and type. This would prevent us from repeating the same code example within each Page Layout.
-
-Although the basic Open Graph information is a part of the SEO information published by SharePoint Server 2016, standard SharePoint Server 2016 SEO controls cannot be used directly to display this information on Master Pages and Page Layouts as Open Graph meta tags. To use those controls for publishing Open Graph metadata, we have built a set of wrapper controls and them published together with this article to explain how you can build similar wrapper controls.
-
-By using Search Engine Optimization capabilities of SharePoint Server 2016 we can retrieve the information about the page as follows:
-
-```
+According to the Open Graph protocol, there are four properties that are required for every web page:
+
+- *title*
+- *type*
+- *image*
+- *URL*
+
+f you aren't publishing information about video or audio, you'll likely use the *article* type for most of your web pages. Because not every page is an article, you might want to use the *website* type. The *website* type is the default type if no type is specified. To simplify working with Open Graph, you could expand the previous code example by adding information about the title, URL, and type. This action would prevent us from repeating the same code example within each Page Layout.
+
+Although the basic Open Graph information is a part of the SEO information published by SharePoint Server 2016, you can't directly use standard SharePoint Server 2016 SEO controls to display this information on Master Pages and Page Layouts as Open Graph meta tags. To use those controls for publishing Open Graph metadata, we have built a set of wrapper controls and published them together with this article to explain how you can build similar wrapper controls.
+
+By using Search Engine Optimization capabilities of SharePoint Server 2016, we can retrieve the information about the page as follows:
+
+```HTML
<head>
-…
+...
<!--SPM:<%@Register Tagprefix="Contoso" Namespace="Contoso.SharePoint.Seo.Controls" Assembly="Contoso.SharePoint.Seo, Version=1.0.0.0, Culture=neutral,
content="$Url$"/></ContentTemplate>
<!--MS:<asp:ContentPlaceHolder id="OpenGraphPlaceHolder" runat="server">--> <!--ME:</asp:ContentPlaceHolder>-->
-…
+...
</head>- ```
-This approach assumes that you want the title of your page to be published on social networks exactly like it is displayed in the title bar of a web browser. Should your scenario differ, you can replace the contents of the title property with a suitable alternative, or remove it, and then have it filled from the *OpenGraphPlaceHolder* content placeholder.
-
-The great benefit of using the standard SharePoint Server 2016 Search Engine Optimization controls, as shown above, is that they work for both classic in addition to search-driven content publishing model and will automatically retrieve the necessary content by using the necessary approach.
-
-The next step is to provide the page-type specific information according to the Open Graph protocol. For pages using the classic publishing model, you can use Publishing controls to retrieve the content, for example:
-
-```
+This approach assumes that you want the title of your page to be published on social networks exactly like it's displayed in the title bar of a web browser. For a different approach, you can do one of the following options:
+
+- Replace the contents of the title property with a suitable alternative.
+- Remove it, and then have it filled from the *OpenGraphPlaceHolder* content placeholder.
+
+The great benefit of using the standard SharePoint Server 2016 Search Engine Optimization controls is they work for the classic and search-driven content publishing models. They will automatically retrieve the necessary content by using the necessary approach.
+
+The next step is to provide the page-type specific information according to the Open Graph protocol. For pages using the classic publishing model, you can use Publishing controls to retrieve the content. For example:
+
+```HTML
<!--MS:<asp:ContentPlaceHolder id="OpenGraphPlaceHolder" runat="server">--> <!--SPM:<%@Register
property="article:author"
content="$Value$"/></ContentTemplate> <!--ME:</Contoso:TemplatedControlWrapper>--> <!--ME:</asp:ContentPlaceHolder>-->- ```
-When using search-driven publishing you would use Catalog Item Reuse Web Parts instead:
-
-```
+When using search-driven publishing, you would use Catalog Item Reuse Web Parts instead:
+
+```HTML
<!--MS:<asp:ContentPlaceHolder id="OpenGraphPlaceHolder" runat="server">--> <!--SPM:<%@Register
SelectedPropertiesJson="[&amp;quot;PublishingContactProfileUrlOWSTEXT&amp;quot;]
property="article:author" content="$Value$"/></ContentTemplate> <!--ME:</Contoso:TemplatedControlWrapper>--> <!--ME:</asp:ContentPlaceHolder>-->- ```
-When using cross-site publishing, in most scenarios the content of the detail pages, which is named catalog item page, is surfaced from the search index and can be retrieved as shown above.The content of overview pages, which are named category pages, is determined by the information coming from the Managed Metadata Service. Should you have to retrieve information from your taxonomy to display it as part of your Open Graph manifest, you can do so by using the *TermProperty* control:
-
-```
+In most scenarios where you use cross-site publishing, the content of the detail pages (which are named catalog item pages) can be retrieved from the search index and as shown previously. The content of overview pages (which are named category pages), is determined by the information from the Managed Metadata Service. If you need to retrieve information to display as part of your Open Graph manifest, use the *TermProperty* control:
+
+```HTML
<!--MS:<asp:ContentPlaceHolder id="OpenGraphPlaceHolder" runat="server">--> <!--SPM:<%@Register
property="article:section"
content="$Value$"/></ContentTemplate> <!--ME:</Contoso:TemplatedControlWrapper>--> <!--ME:</asp:ContentPlaceHolder>-->- ```
-Different social networks support different metadata. Depending on which social network that you want to integrate with your website, you should verify the relevant API. By using the techniques showed above, you can provide relevant information about your web pages, and to make sure that good presentation of your content on social networks.
-
-Having configured the basic information about our web pages, let's explore the different integration capabilities offered by social networks. For brevity we'll focus on Facebook, but presented mechanisms could apply to other social networks also.
-
+Different social networks support different metadata. Verify the API that's needed to integrate your website with the specific social network. By using the previous examples, you can provide relevant information about your web pages, and verify good presentation of your content on social networks.
+
+Having configured the basic information about our web pages, let's explore the different integration capabilities offered by social networks. For brevity, we'll focus on Facebook, but the presented mechanisms could apply to other social networks.
+ ## Overview of Facebook social plugins and how they can help you integrate social in your SharePoint 2013 website Facebook offers several standard plugins that you can use to integrate with Facebook on your website. The overview of all available plugins is published at [Facebook Social Plugins](https://go.microsoft.com/fwlink/p/?LinkId=400786). The following is an overview of some plugins and how you can integrate them with your website.
-
+ ### Before you start: Insights When integrating with Facebook, you can add one or more widgets to your website. Although this will allow your visitors to interact with your website using Facebook plugins, it will give you very little feedback about how your visitors use the social media capabilities that you have provided them with. The great news is that if you want to learn more information about the usage of Facebook social plugins on your website, you can benefit from the Insights capability that Facebook offers you. After registering your website as a Facebook application and including the application ID in your website, you'll be able to access analytics information about the usage of Facebook on your website from all the widgets.
-
+ More information, see [Facebook Insights](https://www.facebook.com/business/news/audience-insights).
-
+ ## Like Button The Facebook Like button is probably the most popular Facebook social plugin. By using a single mouse click your visitors can let their friends know that they like a page on your website. As a result your page and even your whole website might get some additional attention.
-
+ Although you might want to include the Like Button on every page on your web page, it might be most effective on detail pages that contain the important content your visitors are looking for. Integrating the Facebook Like Button on your website is easy and comes down to including two HTML snippets in your websites.
-
-First there is the Facebook SDK call that should be included one time per page directly after the *body* tag:
-
-```
+
+First there is the Facebook SDK call that should be included one time per page directly after the *body* tag:
+
+```HTML
<div id="fb-root"></div> <script>(function(d, s, id) { var js, fjs = d.getElementsByTagName(s)[0];
First there is the Facebook SDK call that should be included one time per page d
``` If you have registered your website as a Facebook application, you should include your application ID (underlined) in this snippit:
-
-```
+
+```HTML
<div id="fb-root"></div> <script>(function(d, s, id) { var js, fjs = d.getElementsByTagName(s)[0];
If you have registered your website as a Facebook application, you should includ
``` Because this HTML snippet is shared between all pages on your website, the way to include it in your SharePoint website is to make it a part of your Master Page, as shown in the following figure.
-
+ ![Fig 1 Code](../media/OTCSP_Fig1_FacebookCode.png)
-
+ The second code example that you have to include is the Like Button itself:
-
-```
+
+```HTML
<div class="fb-like" data-href="http://www.contoso.com" data-send="true" data-width="450" data-show-faces="true"></div> ``` Because the placement of the Like Button might vary per page, the best way to integrate it on your website is to include it in the Page Layout.
-
-According to the Like Button guidelines, the Like Button has to contain the absolute URL of the page on which it is integrated. In the code sample that was mentioned earlier the absolute URL is included in the *data-href* attribute. Because we want to place the code on the Page Layout we don't want to include a fixed URL. Instead we want to insert the URL of the current page rendered using the Page Layout. Considering that SharePoint Server 2016 offers support for physical and Friendly URLs, the best way to get the URL of the current page is to use the SharePoint Server 2016 Canonical URL control. Combined with the Like Button HTML code example, it would look as follows:
-
-```
+
+According to the Like Button guidelines, the Like Button has to contain the absolute URL of the page on which it's integrated. In the code sample that was mentioned earlier the absolute URL is included in the *data-href* attribute. Because we want to place the code on the Page Layout we don't want to include a fixed URL. Instead we want to insert the URL of the current page rendered using the Page Layout. Considering that SharePoint Server 2016 offers support for physical and Friendly URLs, the best way to get the URL of the current page is to use the SharePoint Server 2016 Canonical URL control. Combined with the Like Button HTML code example, it would look as follows:
+
+```HTML
<!--SPM:<%@Register Tagprefix="Contoso" Namespace="Contoso.SharePoint.Seo.Controls" Assembly="Contoso.SharePoint.Seo, Version=1.0.0.0, Culture=neutral, PublicKeyToken=a285ef6967f781d3"%>--> <!--MS:<Contoso:HyperlinkControlWrapper runat="server">--> <Control>
According to the Like Button guidelines, the Like Button has to contain the abso
``` ![Building a Like Button Plugin](../media/OTCSP_Fig2_Camera_Like.png)
-
+ When building the Like Button social plugin an interesting option worth considering is including the Send option.
-
+ Although designed by using a very simple idea, integrating the Like Button on your website can help you expand the reach of your content. An additional benefit that you get from using the Like Button on your website is that combined with the SharePoint Server 2016 Search Analytics capabilities, you can use the event of someone liking a web page on your website. By using this information, you can for example present content that was liked on a prominent place on your website, which again increasing your chances for conversion.
-
+ ## Send Button When building the Like Button social plugin an interesting option worth considering is including the Send option. While clicking the Like option gives your visitors to share your web page with everyone, they can use the Send button to choose with whom they want to share your web page. This offers them more flexibility and additionally reduces the bar for sharing the contents of your website.
-
+ ![Send Button](../media/OTCSP_Fig3_Camera_Send.png)
-
+ ## Comments Publishing original content is a great way for gaining popularity and improving the ranking of your website in search engines. Furthermore, allowing your visitors to give you feedback, can help you improve your website to be even more user-friendly and become better tailored to your audience's interests. Facebook offers the Comments plugin that you can integrate with your website to allow your visitors to comment on your website.
-
+ ![Comments Box](../media/OTCSP_Fig4_Camera_Comments.png)
-
-Giving your visitors the ability to use Facebook to comment on your content, can be of great benefit both to you and your visitors. Although it might depend on the audience of your website, many people have a Facebook account nowadays. It is easier for them to use their existing Facebook profile to leave a comment on your website instead of in following another registration process.
-
+
+Giving your visitors the ability to use Facebook to comment on your content, can be of great benefit both to you and your visitors. Although it might depend on the audience of your website, many people have a Facebook account nowadays. It's easier for them to use their existing Facebook profile to leave a comment on your website instead of in following another registration process.
+ Another benefit of using Facebook for comments is that when someone comments on your content, that comment will be shared with their friends. Theoretically this allows you to expand your reach even more. But, remember that if the comment isn't flattering everyone will know it as well.
-
+ The process for integrating the Facebook Comments plugin resembles integrating the Facebook Like Button. In most scenarios, you want the Facebook Comment plugin to appear underneath the content of every page. To do this, you can include it in the content of each Page Layout used within your website.
-
+ Similarly to the Facebook Like button, the Comments plugins consists of two code examples. The first one is identical to for the Facebook Like button. Therefore, if you plan to integrate both plugins, you only have to include it one time.
-
+ The second snippet is the Comments plugin itself. It should be positioned where you want it to be displayed in your Page Layout:
-
-```
+
+```HTML
<div class="fb-comments" data-href="http://www.contoso.com" data-width="470" data-num-posts="10"></div> ```
-Similarly to the Facebook Like button, the *data-href* attribute should contain the absolute URL of the page for which you want to provide the commenting capability. As this is very likely to be the current page, you could again benefit of the *SeoCanonicalLink* control to retrieve the URL of the current page:
-
-```
+Similarly to the Facebook Like button, the *data-href* attribute should contain the absolute URL of the page for which you want to provide the commenting capability. As this is very likely to be the current page, you could again benefit of the *SeoCanonicalLink* control to retrieve the URL of the current page:
+
+```HTML
<!--SPM:<%@Register Tagprefix="Contoso" Namespace="Contoso.SharePoint.Seo.Controls" Assembly="Contoso.SharePoint.Seo, Version=1.0.0.0, Culture=neutral, PublicKeyToken=a285ef6967f781d3"%>--> <!--MS:<Contoso:HyperlinkControlWrapper runat="server">--> <Control>
Similarly to the Facebook Like button, the *data-href* attribute should contai
## Activity Feed Another interesting plugin that Facebook offers for integrating its capabilities on public-facing websites is the Activity Feed plugin.
-
+ The Activity Feed plugin shows the recent activity on your website. Whenever someone likes a page within your website, the Activity Feed plugin is used to display the Like in the Activity Feed. Other custom actions custom can also be recorded, stored and presented in the Activity Feed.
-
-Using the Activity Plugin can help your visitors discover new content and with that help you expand the reach of your website. When your visitors are logged in with Facebook, the Activity Feed will show activities that your visitors' friends have made. As most of the time those are all people who your visitors know and trust. Therefore, the odds are high that they will follow their recommendations and discover new content on your website. If they are not logged in on the other hand, the Activity Feed plugin will show recommendations from across your site and of course suggest logging in to Facebook to show more relevant content.
-
+
+Using the Activity Plugin can help your visitors discover new content and with that help you expand the reach of your website. When your visitors are logged in with Facebook, the Activity Feed will show activities that your visitors' friends have made. As most of the time those are all people who your visitors know and trust. Therefore, the odds are high that they will follow their recommendations and discover new content on your website. If they aren't logged in on the other hand, the Activity Feed plugin will show recommendations from across your site and of course suggest logging in to Facebook to show more relevant content.
+ As with other Facebook plugins, the Activity Feed plugin consists of two HTML code examples required to integrate it with the website. The first one is the Facebook JavaScript SDK snippet that we have seen previously. The second one is the Activity Feed itself:
-
-```
+
+```HTML
<div class="fb-activity" data-site="contoso.com" data-width="300" data-height="300" data-header="true" data-recommendations="false"></div> ``` The configuration of the Activity Feed is straight-forward. By using the data-site attribute, you have to specify the domain of your website, and which activity information should be displayed. By using other data attributes, you can control the user experience of the Activity Feed on your website, and whether you want to explicitly include recommendations or not.
-
-Although you could place the Activity Feed on every page on your website, there is a chance that this would work against you and distract your visitors from your content. Because the Activity Feed allows you to expand the reach of your website, it might be a better idea to analyze your web analytics data and place the Activity Feed somewhat more strategically, for example on the frequent exit pages and landing pages such as the home page.
-
+
+Although you could place the Activity Feed on every page on your website, there is a chance that this would work against you and distract your visitors from your content. Because the Activity Feed allows you to expand the reach of your website, it might be a better idea to analyze your web analytics data and place the Activity Feed somewhat more strategically, for example on the frequent exit pages and landing pages such as the home page.
+ Because in most scenarios, you will embed the Activity Feed on specific pages, the best way to integrate it with your website is not to include it in the Master Page or Page Layouts, but to add it to the specific pages. The best way to do this is to embed the Activity Feed code example in the page using the Script Editor Web Part.
-
+ ![Embed Code](../media/OTCSP_Fig5_Embed.png)
-
+ ## Recommendations Bar
-A slightly different, nevertheless very interesting, plugin is the Recommendations Bar. This plugin can also help you expand the reach of your website by displaying recommended content. What's different about the Recommendations Bar is its usage scenario.
-
+A slightly different, nevertheless very interesting, plugin is the Recommendations Bar. This plugin can also help you expand the reach of your website by displaying recommended content. What's different about the Recommendations Bar is its usage scenario.
+ The Recommendations Bar is located at the bottom of the browser window. Depending on its configuration it might become visible after some time, for example after users have scrolled past a certain point of the page. This plugin can be very useful because it provides your visitors with suggestions of additional content they might find interesting.
-
+ When integrating the Recommendations Bar on your website, you should consider integrating it with the detail pages. That way, when your visitors have finish using the current content, they are offered a next step. Once again this plugin requires the reference to the Facebook JavaScript SDK to work. The plugin itself is represented by the following markup:
-
-```
+
+```HTML
<div class="fb-recommendations-bar" data-href="http://contoso.com/articles/my-article/"></div> ```
-Because you want recommendations to be visible on every page, you should add it to the Page Layouts used by your detail pages. The following is the markup that you should add to your Page Layouts to to make sure that that the Recommendations Bar will work for every page. Notice how the contents of the *data-href* attribute are being set dynamically by using the SeoCanonicalLink control we discussed previously:
-
-```
+Because you want recommendations to be visible on every page, you should add it to the Page Layouts used by your detail pages. The following is the markup that you should add to your Page Layouts to to make sure that that the Recommendations Bar will work for every page. Notice how the contents of the *data-href* attribute are being set dynamically by using the SeoCanonicalLink control we discussed previously:
+
+```HTML
<!--SPM:<%@Register Tagprefix="Contoso" Namespace="Contoso.SharePoint.Seo.Controls" Assembly="Contoso.SharePoint.Seo, Version=1.0.0.0, Culture=neutral, PublicKeyToken=a285ef6967f781d3"%>--> <!--MS:<Contoso:HyperlinkControlWrapper runat="server">--> <Control>
Because you want recommendations to be visible on every page, you should add it
``` Like all other content, the recommendations that are displayed by the Recommendations Bar are controlled by the activity on your website, and recorded by Facebook. Although the Recommendations Bar will display personalized content suggestions, it doesn't offer you any control about what content will be displayed where. Although the differences in which items are suggested as recommendations might be subtle, they could decide whether your visitors will remain on your website.
-
-An alternative to integrating the Facebook Recommendations Bar that is worth considering is using the content recommendations capability that was provided with SharePoint Server 2016. Although it would require some customizations to achieve similar user experience as the one that Facebook Recommendations Bar has, the great advantage is that you can control which content is displayed as recommendations. Because content recommendations are based on SharePoint Server 2016 Search, you can use all its capabilities to to make sure that that the most relevant recommendations are displayed to your visitors.
-
-## Bonus:Yamming it!
+
+An alternative to integrating the Facebook Recommendations Bar that's worth considering is using the content recommendations capability that was provided with SharePoint Server 2016. Although it would require some customizations to achieve similar user experience as the one that Facebook Recommendations Bar has, the great advantage is that you can control which content is displayed as recommendations. Because content recommendations are based on SharePoint Server 2016 Search, you can use all its capabilities to to make sure that that the most relevant recommendations are displayed to your visitors.
+
+## Bonus: Yamming it!
If your organization offers products or services to consumers, integrating with Facebook might be a wise choice. If your business is more based on knowledge and is targeted at other businesses, it might be worth the effort to integrate with Yammer also. To put it simple: Yammer is Facebook for enterprises. It helps organizations share their knowledge by allowing them to communicate within the boundaries of their organization. Making it easier for your visitors to share the content from your website with their Yammer networks might help you reach more of your business customers.
-
-Although Yammer doesn't offer as many plugins as Facebook does, one thing that you could easily include in your website is a *Yam it* button. The Yam it button gives your visitors to share the page that they are currently visiting with their Yammer network with a single mouse click. The following is sample code of a *Yam it* button:
-
-```
+
+Although Yammer doesn't offer as many plugins as Facebook does, one thing that you could easily include in your website is a *Yam it* button. The Yam it button gives your visitors to share the page that they are currently visiting with their Yammer network with a single mouse click. The following is sample code of a *Yam it* button:
+
+```HTML
<a href="javascript:var d=document,w=window,e=w.getSelection,k=d.getSelection,x=d.selection,s=(e?e():(k)?k():(x?x.createRange().text:0)),f= 'https://www.yammer.com/home/bookmarklet',l=d.location,e=encodeURIComponent,p='?bookmarklet_pop=1&amp;amp;v=1&amp;amp;u='+e(l.href)%20+'&amp;amp;t='+e(d.title.replace(/^ *| *$/g,''))%20+'&amp;amp;s='+e(s),u=f+p;a=function()%20{if%20(!window.open(u,'sharer','toolbar=0,status=0,resizeable=1,width=650,height=550'))l.href=f+p};if%20(/Firefox/.test(navigator.userAgent))setTimeout(a,0);else{a()}void(0);">Yam it!</a> ```
-The *Yam it* button is completely based on JavaScript so you can include the previous snippet directly in SharePoint without changing it. From the integration perspective the *Yam it* button can be best compared with the Facebook Like button. So wherever you feel it is right to include the Facebook Like button, it is probably a good place to include the *Yam it* button also.
-
+The *Yam it* button is completely based on JavaScript so you can include the previous snippet directly in SharePoint without changing it. From the integration perspective the *Yam it* button can be best compared with the Facebook Like button. So wherever you feel it's right to include the Facebook Like button, it's probably a good place to include the *Yam it* button also.
+ ![Yam It Button](../media/OTCSP_Fig6_YamIt.png)
-
+ ## Summary Integrating social networks together with your website can help you expand the reach of your website and help your visitors discover new content. Most social networks offer standard plugins that can be easily integrated within your content management system. SharePoint is no exception here. No matter if you want to integrate social media only on some specific pages or all pages of a particular type, SharePoint offers you the flexibility to do this effortlessly.
-
-
SharePoint Mobile Security And Authentication https://github.com/MicrosoftDocs/OfficeDocs-SharePoint/commits/public/SharePoint/SharePointServer/administration/mobile-security-and-authentication.md
Title: "Mobile security and authentication in SharePoint 2013"-+
description: "Learn how to help secure a SharePoint mobile infrastructure, and l
# Mobile security and authentication in SharePoint 2013 [!INCLUDE[appliesto-2013-xxx-xxx-xxx-xxx-md](../includes/appliesto-2013-xxx-xxx-xxx-xxx-md.md)]
-
-This article provides security guidance and recommendations to help ensure that access to SharePoint Server 2013 and specific data in SharePoint is not compromised on a mobile device. This article also details the supported authentication types for select devices, and authentication specifics for the SharePoint Newsfeed App.
-
-
+
+This article provides security guidance and recommendations to help ensure that access to SharePoint Server 2013 and specific data in SharePoint is not compromised on a mobile device. This article also details the supported authentication types for select devices, and authentication specifics for the SharePoint Newsfeed App.
+ ## Security for mobile devices <a name="section1"> </a> This section provides security recommendations for using devices that are external to your corporate network. A lost or stolen device could be devastating to an organization on many levels. Therefore, necessary measures must be put in place if one were to be compromised.
-
+ General security considerations include the following:
-
-- Mobile devices can contain sensitive data or documents. Because mobile devices can be lost or stolen, we recommend that you set policies around mobile devices to help protect sensitive data and documents. This can include securing the mobile device by using a PIN or lock, and ensuring that you can remotely wipe the data on the mobile device. Available programs and features vary by mobile device. For more information about a possible method to implement these policies in your organization, see [Exchange ActiveSync](mobile-security-and-authentication.md#activesync) later in this article.
-
+
+- Mobile devices can contain sensitive data or documents. Because mobile devices can be lost or stolen, we recommend that you set policies around mobile devices to help protect sensitive data and documents. This can include securing the mobile device by using a PIN or lock, and ensuring that you can remotely wipe the data on the mobile device. Available programs and features vary by mobile device. For more information about a possible method to implement these policies in your organization, see [Exchange ActiveSync](mobile-security-and-authentication.md#activesync) later in this article.
+ - You can educate users about how they can help protect their user credentials. This can include signing out of sites when they have finished, not enabling any option that keeps them signed in or remembers their password, and frequently deleting cookies in the mobile browser. This can help prevent others from using their user credentials to log on to a SharePoint site if their mobile device is lost or stolen.
-
-- We recommend that you enable SSL to help secure communication between mobile browsers and the computer that is running SharePoint Server 2013. For more information about how to use a reverse proxy server, such as Forefront Unified Access Gateway (UAG), to help secure communication, see [Forefront Unified Access Gateway (UAG)](https://go.microsoft.com/fwlink/p/?LinkID=196384) in the Forefront Technical Library.
-
+
+- We recommend that you enable SSL to help secure communication between mobile browsers and the computer that is running SharePoint Server 2013. For more information about how to use a reverse proxy server, such as Forefront Unified Access Gateway (UAG), to help secure communication, see [Forefront Unified Access Gateway (UAG)](https://go.microsoft.com/fwlink/p/?LinkID=196384) in the Forefront Technical Library.
+ ### Exchange ActiveSync <a name="activesync"> </a> Microsoft Exchange ActiveSync is a communications protocol that enables mobile access, over the air, to e-mail messages, scheduling data, contacts, and tasks. Exchange ActiveSync is available on Windows Phone and third-party phones and slates that are enabled for Exchange ActiveSync such as the Apple iPhone. One of the benefits of implementing Exchange ActiveSync in your organization is device-side security, and administration through policy enforcement. If SharePoint Server 2013 is deployed in an extranet topology, mobile devices access the computer that is running SharePoint Server 2013 via a public-facing URL. If the mobile device were to become lost or stolen, it is necessary to ensure that SharePoint data is not compromised. For example, by using Exchange ActiveSync you can wipe data contents from the device remotely, such as SharePoint configurations, or enforce a complex password at the lock screen to help prevent unauthorized access.
-
+ The following table lists a selection of Exchange ActiveSync features and policies that you can apply to some devices.
-
+ **Table: Exchange ActiveSync policies for mobile devices**
-| Exchange ActiveSync policy | Description |
-|:--|:--|
-|Remote wipe (this is a feature and not an Exchange ActiveSync policy) <br/> |If a mobile phone is lost, stolen, or otherwise compromised, you can issue a remote wipe command from the Exchange computer or from any web browser by using Outlook Web App. This command restores the device to factory defaults. <br/> > [!IMPORTANT]> After a remote device wipe has occurred, data recovery is very difficult. However, no data removal process leaves a device as free from residual data as when it is new. Recovery of data from a device may still be possible using sophisticated tools. |
-|Enforce password on device (DevicePasswordEnabled) <br/> |This setting enables the mobile phone password. <br/> |
-|Minimum password length (MinDevicePasswordLength) <br/> |This option specifies the length of the password for the mobile phone. The default length is 4 characters, but as many as 18 can be included. <br/> |
-|Require alphanumeric password (AlphanumericDevicePasswordRequired) <br/> |This setting requires that a password contains numeric and non-numeric characters. <br/> |
-|Allow simple password (AllowSimpleDevicePassword) <br/> |This setting enables or disables the ability to use a simple password such as 1234. <br/> |
-|Maximum inactivity time lock (MaxInactivityTimeDeviceLock) <br/> |This option determines how long the mobile phone must be inactive before the user is prompted for a password to unlock the mobile phone. <br/> |
-
+|Exchange ActiveSync policy |Description |
+|||
+|Remote wipe (this is a feature and not an Exchange ActiveSync policy)|If a mobile phone is lost, stolen, or otherwise compromised, you can issue a remote wipe command from the Exchange computer or from any web browser by using Outlook Web App. This command restores the device to factory defaults. <p> **Important**: After a remote device wipe has occurred, data recovery is very difficult. However, no data removal process leaves a device as free from residual data as when it is new. Recovery of data from a device may still be possible using sophisticated tools. |
+|Enforce password on device (DevicePasswordEnabled)|This setting enables the mobile phone password.|
+|Minimum password length (MinDevicePasswordLength)|This option specifies the length of the password for the mobile phone. The default length is 4 characters, but as many as 18 can be included.|
+|Require alphanumeric password (AlphanumericDevicePasswordRequired)|This setting requires that a password contains numeric and non-numeric characters.|
+|Allow simple password (AllowSimpleDevicePassword)|This setting enables or disables the ability to use a simple password such as 1234.|
+|Maximum inactivity time lock (MaxInactivityTimeDeviceLock)|This option determines how long the mobile phone must be inactive before the user is prompted for a password to unlock the mobile phone.|
+ > [!IMPORTANT] > The selection of Exchange ActiveSync policies that can be used might differ on a device-by-device basis. For more information about which policies are supported on a specific device platform, such as Windows Phone and Apple iPhone, see [Understanding Exchange ActiveSync Mailbox Policies](/exchange/exchange-activesync-exchange-2013-help).
-
+ ### Finding a lost device <a name="lostdevice"> </a> When a device is lost or stolen it may be useful to find the location of that device, and be able to wipe all data contents if it is necessary. There are various third-party services and solutions that can provide this functionality. An example is the Windows Phone Find My Phone service that can make it easier to recover your mobile device by locating it, or prevent someone from using it without your consent.
-
+ The functionality this service can provide includes the following:
-
+ - Map your mobile device location.
-
+ - Make your mobile device ring.
-
+ - Lock your mobile device and show a message.
-
+ - Wipe your mobile device data.
-
+ > [!NOTE]
-> To learn more about the Find My Phone service for Windows Phone, see [Find a lost phone](https://support.microsoft.com/help/17240/windows-10-mobile-find-phone).
-
+> To learn more about the Find My Phone service for Windows Phone, see [Find a lost phone](https://support.microsoft.com/help/17240/windows-10-mobile-find-phone).
+ ## Authentication for mobile devices <a name="section2"> </a> SharePoint Server 2013 supports multiple authentication methods and authentication modes. Not all mobile browsers and devices work with all the available authentication methods. When you plan for mobile device access, you must do the following:
-
+ - Determine the mobile devices that you must support. Then, learn the authentication methods that are supported by the mobile devices. This information varies by manufacturer.
-
+ - Determine the sites that you want to make available to your mobile device users.
-
+ - Determine whether you want to make SharePoint sites available for mobile devices when the devices are used outside the corporate firewall. If you do, the method that you use to enable external access can also affect mobile device authentication.
-
-The following tables detail the authentication types supported for browsers, OneDrive, and the Office Hub Windows Phone experience in SharePoint Server 2013. For the below, OrgID refers to Microsoft Online Services ID, the identity provider for Microsoft 365. Also, MSOFBA refers to Microsoft Office Forms Based Authentication.
-
+
+The following tables detail the authentication types supported for browsers, OneDrive, and the Office Hub Windows Phone experience in SharePoint Server 2013. For the below, OrgID refers to Microsoft Online Services ID, the identity provider for Microsoft 365. Also, MSOFBA refers to Microsoft Office Forms Based Authentication.
+ **Table: Mobile authentication support for SharePoint browsers**
-| SharePoint Infrastructure | Mobile Devices |
-|--|--|
-|**Authentication Type** <br/> |**Authentication Protocol** <br/> |**ID Provider** <br/> |**SharePoint deployment** <br/> |**Windows Phone 7.5 (Internet Explorer Mobile)** <br/> |**Windows Phone 8 (Internet Explorer Mobile)** <br/> |**Windows 8 (Internet Explorer)** <br/> |**iOS 5.x or later versions (Safari Browser)** <br/> |**Android 4.x or later versions (Android Browser** ) <br/> |
-|**Windows Authentication** <br/> |NTLM <br/> |Active Directory <br/> |On-premises <br/> |Yes <br/> |Yes <br/> |Yes <br/> |Yes <br/> |Yes <br/> |
-|Basic Authentication <br/> |Active Directory <br/> |On-premises, extranet <br/> |Yes <br/> |Yes <br/> |Yes <br/> |Yes <br/> |Yes <br/> |
-|**Forms-Based Authentication (FBA)** <br/> |FBA <br/> |Active Directory, LDAP, SQL <br/> |On-premises, extranet <br/> |Yes <br/> |Yes <br/> |Yes <br/> |Yes <br/> |Yes <br/> |
-|FBA <br/> |OrgID <br/> |SharePoint in Microsoft 365, hybrid-based scenarios <br/> |Yes <br/> |Yes <br/> |Yes <br/> |Yes <br/> |Yes <br/> |
-|**SAML (Token-based)** <br/> |SAML <br/> |WS-Federation 1.1 compatible Identity Provider <br/> |On-Premises, SharePoint in Microsoft 365, hybrid-based scenarios <br/> |Yes <br/> |Yes <br/> |Yes <br/> |Yes <br/> |Yes <br/> |
-
+|SharePoint Infrastructure|Mobile Devices|&nbsp;|&nbsp;|&nbsp;|&nbsp;|&nbsp;|&nbsp;|&nbsp;|
+||||||||||
+|**Authentication Type**|**Authentication Protocol**|**ID Provider**|**SharePoint deployment**|**Windows Phone 7.5 (Internet Explorer Mobile)**|**Windows Phone 8 (Internet Explorer Mobile)**|**Windows 8 (Internet Explorer)**|**iOS 5.x or later versions (Safari Browser)**|**Android 4.x or later versions (Android Browser)**|
+|**Windows Authentication**|NTLM|Active Directory|On-premises|Yes|Yes|Yes|Yes|Yes|
+|**Basic Authentication**||Active Directory|On-premises, extranet|Yes|Yes|Yes|Yes|Yes|
+|**Forms-Based Authentication (FBA)**|FBA|Active Directory, LDAP, SQL|On-premises, extranet|Yes|Yes|Yes|Yes|Yes|
+||FBA|OrgID|SharePoint in Microsoft 365, hybrid-based scenarios|Yes|Yes|Yes|Yes|Yes|
+|**SAML (Token-based)**|SAML|WS-Federation 1.1 compatible Identity Provider|On-Premises, SharePoint in Microsoft 365, hybrid-based scenarios|Yes|Yes|Yes|Yes|Yes|
+ **Table: Supported authentication types for the OneDrive app**
-| Authentication type | Description | Supported | Administrator type required for configuration |
-|:--|:--|:--|:--|
-|**Org-ID** <br/> |Organizations with a Microsoft 365 or SharePoint organization without any federation. <br/> |Yes <br/> |Global admin <br/> |
-|**ADFS and Org-ID federation** <br/> |Organizations with a hybrid Microsoft 365 or SharePoint organization with users federated from an on-premises directory. <br/> |Yes <br/> |Global admin plus the on-premises network administrator plus the SharePoint admin <br/> |
-|**Windows authentication (NTLM)** <br/> |Organizations with a SharePoint environment configured to allow NTLM claims-based Windows authentication. <br/> |Yes <br/> |SharePoint admin <br/> |
-|**Forms-based authentication (FBA)** <br/> |Organizations with a SharePoint environment configured to allow Forms-based authentication or other compatible claims-based authentication via a standard web control. <br/> |Yes <br/> |SharePoint admin <br/> |
-|**Qualified non-ADFS identity providers** <br/> |Organizations with a Microsoft 365 or SharePoint environment configured to allow user sign-in that is federated with an identity provider qualified for rich clients in the [Works with Microsoft 365 - Identity program](https://go.microsoft.com/fwlink/p/?LinkId=511982). <br/> |Yes <br/> |SharePoint admin plus the on-premises Network administrator or Global admin (in some organizations the Global admin is a requirement, not an option.) <br/> |
-|**All other non-ADFS identity providers** <br/> |Organizations with a SharePoint environment configured to allow a non-ADFS identity provider. <br/> |No <br/> |SharePoint admin plus the on-premises network administrator <br/> |
-|**Kerberos authentication** <br/> |Organizations with a SharePoint environment configured to support Kerberos authentication. <br/> |No <br/> |SharePoint admin plus the on-premises network administrator <br/> |
-|**Basic authentication** <br/> |Organizations with a SharePoint environment configured to support Basic authentication. <br/> |No <br/> |SharePoint admin plus the on-premises network administrator <br/> |
-
+|Authentication type|Description|Supported|Administrator type required for configuration|
+|||||
+|**Org-ID**|Organizations with a Microsoft 365 or SharePoint organization without any federation.|Yes|Global admin|
+|**ADFS and Org-ID federation**|Organizations with a hybrid Microsoft 365 or SharePoint organization with users federated from an on-premises directory.|Yes|Global admin plus the on-premises network administrator plus the SharePoint admin|
+|**Windows authentication (NTLM)**|Organizations with a SharePoint environment configured to allow NTLM claims-based Windows authentication.|Yes|SharePoint admin|
+|**Forms-based authentication (FBA)**|Organizations with a SharePoint environment configured to allow Forms-based authentication or other compatible claims-based authentication via a standard web control.|Yes|SharePoint admin|
+|**Qualified non-ADFS identity providers**|Organizations with a Microsoft 365 or SharePoint environment configured to allow user sign-in that is federated with an identity provider qualified for rich clients in the [Works with Microsoft 365 - Identity program](https://go.microsoft.com/fwlink/p/?LinkId=511982).|Yes|SharePoint admin plus the on-premises Network administrator or Global admin (in some organizations the Global admin is a requirement, not an option.)|
+|**All other non-ADFS identity providers**|Organizations with a SharePoint environment configured to allow a non-ADFS identity provider.|No|SharePoint admin plus the on-premises network administrator|
+|**Kerberos authentication**|Organizations with a SharePoint environment configured to support Kerberos authentication.|No|SharePoint admin plus the on-premises network administrator|
+|**Basic authentication**|Organizations with a SharePoint environment configured to support Basic authentication.|No|SharePoint admin plus the on-premises network administrator|
+ > [!NOTE]
-> If you're a Microsoft 365 multi-organization user, you can connect from the OneDrive app in any network environment, including Wi-Fi and cellular data. If you're not a Microsoft 365 multi-organization user, you can connect only when using your organization's on-site Wi-Fi network. If you're unsure which user you are, contact your SharePoint admin.
-
+> If you're a Microsoft 365 multi-organization user, you can connect from the OneDrive app in any network environment, including Wi-Fi and cellular data. If you're not a Microsoft 365 multi-organization user, you can connect only when using your organization's on-site Wi-Fi network. If you're unsure which user you are, contact your SharePoint admin.
+ **Table: Mobile authentication support matrix for Office Hub**
-| SharePoint Infrastructure | Client side | Mobile devices |
-|--|--|--|
-|**Authentication Type** <br/> |**Authentication Protocol** <br/> |**ID Provider** <br/> |**SharePoint deployment** <br/> |**Handled through:** <br/> |**Windows Phone 7.5 (Internet Explorer Mobile)** <br/> |**Windows Phone 8 (Internet Explorer Mobile)** <br/> |
-|**Windows Authentication** <br/> |NTLM <br/> |Active Directory <br/> |On-premises <br/> |NTLM <br/> |Yes <br/> |Yes <br/> |
-|Basic Authentication <br/> |Active Directory <br/> |On-premises, extranet <br/> |Basic Authentication <br/> |No <br/> |Yes (https) <br/> |
-|**Forms-Based Authentication (FBA)** <br/> |FBA <br/> |Active Directory, LDAP, SQL <br/> |On-premises, extranet <br/> |MSOFBA <br/> |Yes <br/> |Yes <br/> |
-|FBA <br/> |OrgID <br/> |SharePoint, hybrid-based scenarios <br/> |MSOFBA <br/> |Yes <br/> |Yes <br/> |
-|FBA <br/> |OrgID <br/> |SharePoint, hybrid-based scenarios <br/> |Active Authentication(IDCRL) <br/> |No <br/> |Yes <br/> |
-|**SAML (token-based)** <br/> |SAML <br/> |WS-Federation 1.1 compatible Identity Provider <br/> |On-premises, SharePoint, hybrid -based scenarios <br/> |MSOFBA <br/> |Yes <br/> |Yes <br/> |
-|SAML <br/> |WS-Federation 1.1 compatible Identity Provider <br/> |On-premises, SharePoint in Microsoft 365, hybrid-based scenarios <br/> |Active Authentication(IDCRL) <br/> |No <br/> |Yes <br/> |
-
+|SharePoint Infrastructure|Client side|Mobile devices|&nbsp;|&nbsp;|&nbsp;|&nbsp;|
+||||||||
+|**Authentication Type**|**Authentication Protocol**|**ID Provider**|**SharePoint deployment**|**Handled through:**|**Windows Phone 7.5 (Internet Explorer Mobile)**|**Windows Phone 8 (Internet Explorer Mobile)**|
+|**Windows Authentication**|NTLM|Active Directory|On-premises|NTLM|Yes|Yes|
+|**Basic Authentication**||Active Directory|On-premises, extranet|Basic Authentication|No|Yes (https)|
+|**Forms-Based Authentication (FBA)**|FBA|Active Directory, LDAP, SQL|On-premises, extranet|MSOFBA|Yes|Yes|
+||FBA|OrgID|SharePoint, hybrid-based scenarios|MSOFBA|Yes|Yes|
+||FBA|OrgID|SharePoint, hybrid-based scenarios|Active Authentication(IDCRL)|No|Yes|
+|**SAML (token-based)**|SAML|WS-Federation 1.1 compatible Identity Provider|On-premises, SharePoint, hybrid -based scenarios|MSOFBA|Yes|Yes|
+||SAML|WS-Federation 1.1 compatible Identity Provider|On-premises, SharePoint in Microsoft 365, hybrid-based scenarios|Active Authentication(IDCRL)|No|Yes|
+ > [!NOTE]
-> For mobile devices to communicate with SharePoint servers, Internet Protocol Security (IPSec) must be disabled on the servers. The reason this must be done is that mobile devices are not domain-joined.
-
+> For mobile devices to communicate with SharePoint servers, Internet Protocol Security (IPSec) must be disabled on the servers. The reason this must be done is that mobile devices are not domain-joined.
+ ### Authentication for the SharePoint Newsfeed App <a name="News"> </a>
-This section provides authentication guidance and considerations for the SharePoint Newsfeed app. This includes information for on-premises based deployments, and using SharePoint in Microsoft 365.
-
- **Authentication support for the SharePoint Newsfeed App**
-
+This section provides authentication guidance and considerations for the SharePoint Newsfeed app. This includes information for on-premises based deployments, and using SharePoint in Microsoft 365.
+ The following table details the authentication types supported for the SharePoint Newsfeed App in SharePoint Server 2013. For the following, OrgID refers to Microsoft Online Services ID, the identity provider for Microsoft 365. Also, MSOFBA refers to Microsoft Office Forms Based Authentication.
-
-**Table: Mobile authentication support matrix for the SharePoint Newsfeed App**\
-
-| SharePoint Infrastructure | Client side | Mobile devices |
-|--|--|--|
-|**Authentication Type** <br/> |**Authentication Protocol** <br/> |**ID Provider** <br/> |**SharePoint deployment** <br/> |**Handled through:** <br/> |**Windows Phone 7.5 Apps** <br/> |**Windows Phone 8 Apps** <br/> |**Windows 8 Apps** <br/> |**iOS 6.x or later versions Apps** <br/> |
-|**Windows Authentication** <br/> |NTLM <br/> |Active Directory <br/> |On-premises <br/> |NTLM <br/> |No <br/> |No <br/> |Yes <br/> |Yes <br/> |
-|Basic Authentication <br/> |Active Directory <br/> |On-premises, extranet <br/> |Basic Authentication <br/> |Yes <br/> |Yes <br/> |No <br/> |Yes (https) <br/> |
-|**Forms-Based Authentication (FBA)** <br/> |FBA <br/> |Active Directory, LDAP, SQL <br/> |On-premises, extranet <br/> |MSOFBA <br/> |Yes <br/> |Yes <br/> |No <br/> |Yes <br/> |
-|FBA <br/> |OrgID <br/> |SharePoint, hybrid-based scenarios <br/> |MSOFBA <br/> |Yes <br/> |Yes <br/> |No <br/> |Yes <br/> |
-|FBA <br/> |OrgID <br/> |SharePoint, hybrid-based scenarios <br/> |Active Authentication(IDCRL) <br/> |No <br/> |No <br/> |Yes <br/> |Yes <br/> |
-|**SAML (token-based)** <br/> |SAML <br/> |WS-Federation 1.1 compatible Identity Provider <br/> |On-premises, SharePoint in Microsoft 365, hybrid-based scenarios <br/> |MSOFBA <br/> |Yes <br/> |Yes <br/> |No <br/> |Yes <br/> |
-|SAML <br/> |WS-Federation 1.1 compatible Identity Provider <br/> |On-premises, SharePoint in Microsoft 365, hybrid -based scenarios <br/> |Active Authentication(IDCRL) <br/> |No <br/> |No <br/> |Yes <br/> |Yes <br/> |
-
+
+**Table: Mobile authentication support matrix for the SharePoint Newsfeed App**
+
+|SharePoint Infrastructure|Client side|Mobile devices|&nbsp;|&nbsp;|&nbsp;|&nbsp;|&nbsp;|&nbsp;|
+||||||||||
+|**Authentication Type**|**Authentication Protocol**|**ID Provider**|**SharePoint deployment**|**Handled through:**|**Windows Phone 7.5 Apps**|**Windows Phone 8 Apps**|**Windows 8 Apps**|**iOS 6.x or later versions Apps**|
+|**Windows Authentication**|NTLM|Active Directory|On-premises|NTLM|No|No|Yes|Yes|
+|**Basic Authentication**||Active Directory|On-premises, extranet|Basic Authentication|Yes|Yes|No|Yes (https)|
+|**Forms-Based Authentication (FBA)**|FBA|Active Directory, LDAP, SQL|On-premises, extranet|MSOFBA|Yes|Yes|No|Yes|
+||FBA|OrgID|SharePoint, hybrid-based scenarios|MSOFBA|Yes|Yes|No|Yes|
+||FBA|OrgID|SharePoint, hybrid-based scenarios|Active Authentication(IDCRL)|No|No|Yes|Yes|
+|**SAML (token-based)**|SAML|WS-Federation 1.1 compatible Identity Provider|On-premises, SharePoint in Microsoft 365, hybrid-based scenarios|MSOFBA|Yes|Yes|No|Yes|
+||SAML|WS-Federation 1.1 compatible Identity Provider|On-premises, SharePoint in Microsoft 365, hybrid -based scenarios|Active Authentication(IDCRL)|No|No|Yes|Yes|
+ > [!IMPORTANT]
-> For federated scenarios in SharePoint in Microsoft 365, only Active Directory Federation Services (ADFS) 2.0 is supported. During the setup process it is necessary to support a passive federation authentication URI of: *"urn:oasis:names:tc:SAML:2.0:ac:classes:Password"* .
-
- **Authentication Workflows**
-
-The SharePoint Newsfeed App is supported for both on-premises and SharePoint in Microsoft 365 use. Each option can present differences with end user authentication workflow. For example, this table provides sample authentication experiences for each type of implementation.
-
-| Deployment | Workflow | Details |
-|:--|:--|:--|
-|**On-premises** <br/> |![SharePoint Newsfeed On-premises](../media/SP15Mobile_SPNewsOnPrem.jpg)| Supported Authentication Types <br/> Windows Authentication <br/> Forms Based Authentication <br/> SAML <br/> |
-|**SharePoint in Microsoft 365** <br/> |![Newsfeed in SharePoint in Microsoft 365](../media/SP15Mobile_SPNewsSPO.jpg)| Supported Authentication Types <br/> Forms-based Authentication <br/> SAML <br/> |
-
+> For federated scenarios in SharePoint in Microsoft 365, only Active Directory Federation Services (ADFS) 2.0 is supported. During the setup process it is necessary to support a passive federation authentication URI of: *"urn:oasis:names:tc:SAML:2.0:ac:classes:Password"* .
+
+#### Authentication Workflows
+
+The SharePoint Newsfeed App is supported for both on-premises and SharePoint in Microsoft 365 use. Each option can present differences with end user authentication workflow. For example, this table provides sample authentication experiences for each type of implementation.
+
+|Deployment|Workflow|Details|
+||||
+|**On-premises**|![SharePoint Newsfeed On-premises](../media/SP15Mobile_SPNewsOnPrem.jpg)|Supported Authentication Types <br/> Windows Authentication <br/> Forms Based Authentication <br/> SAML|
+|**SharePoint in Microsoft 365**|![Newsfeed in SharePoint in Microsoft 365](../media/SP15Mobile_SPNewsSPO.jpg)|Supported Authentication Types <br/> Forms-based Authentication <br/> SAML|
+ For more info about how to deploy the SharePoint Newsfeed App in your network, including configuring cross-firewall access, see [Configure external access for mobile devices in SharePoint Server](/previous-versions/office/sharepoint-server-2010/ff393835(v=office.14)).
-
+ ## See also <a name="section2"> </a>
-#### Concepts
+### Concepts
[Overview of mobile devices and SharePoint Server 2013](mobile-devices-overview.md)
SharePoint Monitoring Planning https://github.com/MicrosoftDocs/OfficeDocs-SharePoint/commits/public/SharePoint/SharePointServer/administration/monitoring-planning.md
Title: "Plan for monitoring in SharePoint Server"-+
description: "Learn about SharePoint Server monitoring tools and scenarios. Plan
# Plan for monitoring in SharePoint Server [!INCLUDE[appliesto-2013-2016-2019-SUB-xxx-md](../includes/appliesto-2013-2016-2019-SUB-xxx-md.md)]
-
+ To make sure that SharePoint Server is running smoothly, IT professionals must monitor farms, servers, applications, services, and performance closely. You should do preventive maintenance regularly to prevent problems from happening, and create a plan that will minimize damage when a problem occurs.
-
+ Microsoft provides many tools that help you monitor the overall health status of the SharePoint Server environment. If anything goes wrong, you can find plenty of resources and use the monitoring tools to analyze logs, identify the cause, and then take correct actions to solve the problems.
-
+ You also need to plan how many people you want to monitor the SharePoint Server environment. Then create a response plan to cover actions that you should take when a problem occurs.
-
-
++ ## Overview of monitoring tools <a name="section1"> </a> There are many tools that you can use to monitor SharePoint Server and troubleshoot problems. Each tool covers different parts of the SharePoint environment, and some tools may overlap areas. Consider which tools can maximize your monitoring actions. The following monitoring tools are available:
-
+ - SharePoint Health Analyzer
-
+ On the Central Administration home page, click **Monitoring**, **Health Analyzer**. You can use this built-in feature to analyze and resolve problems in the following areas: security, performance, configuration, and availability. Health Analyzer rules are predefined and run at scheduled intervals, such as hourly, daily, weekly, and monthly. If an error is detected, the corresponding rule is triggered. Each rule has a brief explanation about why the error occurs and provides you with a link to a detailed article that contains step-by-step help to resolve the problem. When you follow the help process, you can re-run the rule to verify resolution. If the error does not appear in the list, the problem is resolved.
-
+ - Timer Jobs
-
- On the Central Administration home page, click **Monitoring**, **Timer Jobs**. SharePoint Server uses configurable timer jobs to collect health data and then writes the data to the logging folder and to the Logging database. The data is then used in reports to display the health status of the farm servers.
-
+
+ On the Central Administration home page, click **Monitoring**, **Timer Jobs**. SharePoint Server uses configurable timer jobs to collect health data and then writes the data to the logging folder and to the Logging database. The data is then used in reports to display the health status of the farm servers.
+ You can reschedule a timer job, enable or disable it, and run it on demand. Daily, weekly, and monthly schedules also include a window of execution. The timer service will select a random time within this interval to start running the timer job on each applicable server. This feature is appropriate for high-load jobs that run on multiple servers on the farm.
-
+ > [!NOTE]
- > Running timer jobs at the same time on all servers on the farm can affect system performance. You should plan timer jobs carefully to avoid overlap with other timer jobs.
-
+ > Running timer jobs at the same time on all servers on the farm can affect system performance. You should plan timer jobs carefully to avoid overlap with other timer jobs.
+ - Reporting
-
+ On the Central Administration home page, click **Monitoring**, **Reporting**. This feature lets you configure diagnostic logging and data collection, and view administrative and health reports. Because some configurations will use up drive space and adversely affect system performance you must carefully plan what configurations to set.
-
+ - Microsoft PowerShell
-
+ PowerShell is a powerful tool for monitoring SharePoint Server. You can run commands to obtain the exact logs that you want to view. For more information, see [View diagnostic logs in SharePoint Server](view-diagnostic-logs.md).
-
+ - System Center - Operations Manager with System Center Management Pack for SharePoint Server
-
+ System Center - Operations Manager is a powerful monitoring platform that lets you monitor services, devices, and operations for many computers in a single console. By using Operations Manager, you can view status, health, performance information, and alerts generated for availability, performance, configuration and security situations. For more information, see [Operations Manager](/previous-versions/system-center/system-center-2012-R2/hh205987(v=sc.12)).
-
+ To use Operations Manager to monitor SharePoint Server, you must install System Center Management Pack for SharePoint Server. You can use this tool to monitor events, collect SharePoint component-specific performance counters in one central location, and raise alerts for operator intervention as necessary. Download and install [System Center Management Pack for SharePoint Server 2016](https://www.microsoft.com/download/details.aspx?id=52043).
-
+ - Event Viewer
-
+ Event Viewer is a Microsoft Management Console (MMC) snap-in. It lets you browse and manage event logs. It is a very handy tool for troubleshooting problems. You can filter for specific events across multiple logs, and reuse useful event filters as custom views. For more information, see [Event Viewer](/previous-versions/windows/it-pro/windows-server-2008-R2-and-2008/cc766042(v=ws.11)).
-
+ - SharePoint Developer Dashboard
-
+ This tool provides diagnostic information that can help a developer or system administrator analyze performance of SharePoint Web pages. This utility can help if a page is loading slowly, a Web Part is not performing, or if a database query on the page is not performing. The SharePoint Developer Dashboard is disabled by default. You can enable it by using PowerShell. For more information, see [SharePoint Developer Dashboard](/previous-versions/office/developer/sharepoint-2010/ff512745(v=office.14)).
-
+ - Windows Management Instrumentation (WMI)
-
+ WMI provides many classes for you to monitor the SharePoint Server environment. For each manageable resource, there is a corresponding WMI class. For more information, see [Windows Management Instrumentation (WMI) Overview](/previous-versions/windows/it-pro/windows-server-2012-R2-and-2012/dn265977(v=ws.11)).
-
+ - SQL Server Reporting Services (SSRS)
-
- SQL Server Reporting Services provides a full range of ready-to-use tools and services to help you create, deploy, and manage reports for your organization. It also has programming features that let you extend and customize reporting functionality. By using SQL Server Reporting Services, you can create interactive, tabular, graphical, or free-form reports from relational, multidimensional, or XML-based data sources. You can publish reports, schedule report processing, or access reports on-demand. You can use SQL Server Reporting Services to create reports based on predefined models, and to interactively explore data within the model. You can select from a variety of viewing formats, export reports to other applications, and subscribe to published reports. The reports that you create can be viewed over a Web-based connection or as part of a Windows application or SharePoint site. For more information, see [Reporting Services (SSRS)](/sql/reporting-services/create-deploy-and-manage-mobile-and-paginated-reports?view=sql-server-2014).
-
-SharePoint Health Analyzer, Timer Jobs, Reporting, and PowerShell are built-in features, whereas System Center, System Center Management Pack for SharePoint Server 2016, and SQL Server Reporting Services are independent tools. SharePoint Developer Dashboard and WMI are built-in tools and intended for developers or system administrators. These tools are complementary and apply to different scenarios.
-
+
+ SQL Server Reporting Services provides a full range of ready-to-use tools and services to help you create, deploy, and manage reports for your organization. It also has programming features that let you extend and customize reporting functionality. By using SQL Server Reporting Services, you can create interactive, tabular, graphical, or free-form reports from relational, multidimensional, or XML-based data sources. You can publish reports, schedule report processing, or access reports on-demand. You can use SQL Server Reporting Services to create reports based on predefined models, and to interactively explore data within the model. You can select from a variety of viewing formats, export reports to other applications, and subscribe to published reports. The reports that you create can be viewed over a Web-based connection or as part of a Windows application or SharePoint site. For more information, see [Reporting Services (SSRS)](/sql/reporting-services/create-deploy-and-manage-mobile-and-paginated-reports).
+
+SharePoint Health Analyzer, Timer Jobs, Reporting, and PowerShell are built-in features, whereas System Center, System Center Management Pack for SharePoint Server 2016, and SQL Server Reporting Services are independent tools. SharePoint Developer Dashboard and WMI are built-in tools and intended for developers or system administrators. These tools are complementary and apply to different scenarios.
+ The following table shows a summary of these tools. You must balance the pros and cons of the monitoring tools when you determine which tools to use under certain scenarios.
-
+ **Summary of monitoring tools**
-|**Tool**|**Optional or built-in**|**Skill level required**|**Pros**|**Cons**|**Resources**|
-|:--|:--|:--|:--|:--|:--|
-|SharePoint Health Analyzer <br/> |Built-in <br/> |Basic <br/> | Gives step-by-step instructions for resolving a problem. <br/> Customizable. You can disable some rules if you don't need them. <br/> | Does not cover all possible problems. <br/> A rule is triggered only after a problem has already happened. <br/> |[Configure SharePoint Health Analyzer rules in SharePoint Server](configure-sharepoint-health-analyzer-rules.md) <br/> [View and resolve SharePoint Health Analyzer alerts in SharePoint Server](/previous-versions/office/sharepoint-server-2010/ee663488(v=office.14)) <br/> [SharePoint Health Analyzer rules reference for SharePoint Server 2016](../technical-reference/sharepoint-health-analyzer-rules-reference.md) <br/> |
-|Timer jobs <br/> |Built-in <br/> |Advanced: You have to consider the implications of enabling or disabling a timer job and changing schedules. <br/> | Wide range of monitoring items. <br/> Easy to reschedule. <br/> Customizable. You can create new timer jobs to meet your specific requirements. <br/> |Can affect system performance and conflict with one another. <br/> |[Configure SharePoint Health Analyzer timer jobs in SharePoint Server 2016](configure-sharepoint-health-analyzer-timer-jobs.md) <br/> [Timer job reference for SharePoint Server](../technical-reference/timer-job-reference-for-sharepoint-server.md) <br/> |
-|Reporting <br/> |Built-in <br/> |Viewing skill level: Basic <br/> |Flexible. Lets you configure the severity of events to log, enable event log flood protection, and configure trace logs. <br/> | Only shows administrative and health statistics, without any suggested solutions. <br/> You have to interpret the logging data. <br/> Can affect performance and disk usage. <br/> |[View reports and logs in SharePoint Server 2016](view-reports-and-logs.md) <br/> |
-|PowerShell <br/> |Built-in <br/> |Advanced: you have to know what to look for, and you have to run PowerShell commands. <br/> |Filters data, displays it in various ways, and outputs data to a grid with which you can filter, sort, group, and export the data to Excel 2016. <br/> |You have to know which PowerShell commands to run. <br/> |[View diagnostic logs in SharePoint Server](view-diagnostic-logs.md) <br/> |
-|System Center with System Center Management Pack for SharePoint Server <br/> |Optional but recommended <br/> |Advanced: you need to know what to look for and how to interpret data. <br/> |The tool can detect, diagnose, and alert you about software and hardware incidents, and refer you to knowledge articles. It helps you to do more monitoring with fewer people by monitoring many key scenarios. <br/> |Requires additional servers to deploy. <br/> |[System Center Management Pack for SharePoint Server 2016](https://www.microsoft.com/download/details.aspx?id=52043) <br/> |
-|Event Viewer <br/> |Built-in <br/> |Basic <br/> |You can view events from multiple event logs, save useful event filters as custom views that can be reused, schedule a task to run in response to an event, and create and manage event subscriptions. <br/> |Does not suggest resolutions. <br/> |[Event Viewer](/previous-versions/windows/it-pro/windows-server-2008-R2-and-2008/cc766042(v=ws.11)) <br/> |
-|SharePoint Developer Dashboard <br/> |Built-in <br/> |Advanced: you have to know what to look for and how to interpret data. <br/> |Easy to analyze performance of SharePoint pages. <br/> |Limited to monitoring performance of SharePoint pages. <br/> |[SharePoint Developer Dashboard](/previous-versions/office/developer/sharepoint-2010/ff512745(v=office.14)) <br/> |
-|Windows Management Instrumentation (WMI) <br/> |Built-in <br/> |Advanced: you have to know what to look for and how to write WMI scripts for the managed objects. <br/> |Can monitor, track, and control system events that are related to software applications, hardware components, and networks. <br/> | You have to identify which managed objects to monitor. <br/> You have to write WMI scripts. <br/> |[Windows Management Instrumentation (WMI) Overview](/previous-versions/windows/it-pro/windows-server-2012-R2-and-2012/dn265977(v=ws.11)) <br/> |
-|SQL Server Reporting Services <br/> |Optional but recommended. <br/> |Advanced: you have to design and manage reports. <br/> |Comprehensive platform to create and manage reports. <br/> |Advanced skills required to create and develop solutions. You have to know PerformancePoint Dashboard Designer and Visual Studio. <br/> |[Reporting Services (SSRS)](/sql/reporting-services/create-deploy-and-manage-mobile-and-paginated-reports?view=sql-server-2014) <br/> |
-
+|Tool|Optional or built-in|Skill level required|Pros|Cons|Resources|
+|||||||
+|SharePoint Health Analyzer|Built-in|Basic| Gives step-by-step instructions for resolving a problem. <br/> Customizable. You can disable some rules if you don't need them.| Does not cover all possible problems. <br/> A rule is triggered only after a problem has already happened.|[Configure SharePoint Health Analyzer rules in SharePoint Server](configure-sharepoint-health-analyzer-rules.md) <br/> [View and resolve SharePoint Health Analyzer alerts in SharePoint Server](/previous-versions/office/sharepoint-server-2010/ee663488(v=office.14)) <br/> [SharePoint Health Analyzer rules reference for SharePoint Server 2016](../technical-reference/sharepoint-health-analyzer-rules-reference.md)|
+|Timer jobs|Built-in|Advanced: You have to consider the implications of enabling or disabling a timer job and changing schedules.| Wide range of monitoring items. <br/> Easy to reschedule. <br/> Customizable. You can create new timer jobs to meet your specific requirements.|Can affect system performance and conflict with one another.|[Configure SharePoint Health Analyzer timer jobs in SharePoint Server 2016](configure-sharepoint-health-analyzer-timer-jobs.md) <br/> [Timer job reference for SharePoint Server](../technical-reference/timer-job-reference-for-sharepoint-server.md)|
+|Reporting|Built-in|Viewing skill level: Basic|Flexible. Lets you configure the severity of events to log, enable event log flood protection, and configure trace logs.| Only shows administrative and health statistics, without any suggested solutions. <br/> You have to interpret the logging data. <br/> Can affect performance and disk usage.|[View reports and logs in SharePoint Server 2016](view-reports-and-logs.md)|
+|PowerShell|Built-in|Advanced: you have to know what to look for, and you have to run PowerShell commands.|Filters data, displays it in various ways, and outputs data to a grid with which you can filter, sort, group, and export the data to Excel 2016.|You have to know which PowerShell commands to run.|[View diagnostic logs in SharePoint Server](view-diagnostic-logs.md)|
+|System Center with System Center Management Pack for SharePoint Server|Optional but recommended|Advanced: you need to know what to look for and how to interpret data.|The tool can detect, diagnose, and alert you about software and hardware incidents, and refer you to knowledge articles. It helps you to do more monitoring with fewer people by monitoring many key scenarios.|Requires additional servers to deploy.|[System Center Management Pack for SharePoint Server 2016](https://www.microsoft.com/download/details.aspx?id=52043)|
+|Event Viewer|Built-in|Basic|You can view events from multiple event logs, save useful event filters as custom views that can be reused, schedule a task to run in response to an event, and create and manage event subscriptions.|Does not suggest resolutions.|[Event Viewer](/previous-versions/windows/it-pro/windows-server-2008-R2-and-2008/cc766042(v=ws.11))|
+|SharePoint Developer Dashboard|Built-in|Advanced: you have to know what to look for and how to interpret data.|Easy to analyze performance of SharePoint pages.|Limited to monitoring performance of SharePoint pages.|[SharePoint Developer Dashboard](/previous-versions/office/developer/sharepoint-2010/ff512745(v=office.14))|
+|Windows Management Instrumentation (WMI)|Built-in|Advanced: you have to know what to look for and how to write WMI scripts for the managed objects.|Can monitor, track, and control system events that are related to software applications, hardware components, and networks.| You have to identify which managed objects to monitor. <br/> You have to write WMI scripts.|[Windows Management Instrumentation (WMI) Overview](/previous-versions/windows/it-pro/windows-server-2012-R2-and-2012/dn265977(v=ws.11))|
+|SQL Server Reporting Services|Optional but recommended.|Advanced: you have to design and manage reports.|Comprehensive platform to create and manage reports.|Advanced skills required to create and develop solutions. You have to know PerformancePoint Dashboard Designer and Visual Studio.|[Reporting Services (SSRS)](/sql/reporting-services/create-deploy-and-manage-mobile-and-paginated-reports)|
+ For a SharePoint farm with no more than 10 servers, we recommend that you at least install the following independent tools:
-
+ - System Center 2012 - Operations Manager with System Center Management Pack for SharePoint Server 2013
-
+ Monitors the health status of SharePoint products.
-
+ - SQL Server Reporting Services
-
+ Deploy it if you use the Reporting Services to view Report Definition Language (RDL) files, and design reports by Visual Studio and PerformancePoint Dashboard Designer.
-
+ ## Identify monitoring scenarios <a name="section2"> </a>
-Identify the scenarios that you want to monitor ΓÇöfor example, health, workflows, search, SQL Server, virtual environments, and performance. The following table shows some key scenarios and the monitoring tools that you can use to monitor those scenarios.
-
+Identify the scenarios that you want to monitor ΓÇöfor example, health, workflows, search, SQL Server, virtual environments, and performance. The following table shows some key scenarios and the monitoring tools that you can use to monitor those scenarios.
+ **Scenarios and monitoring tools**
-|**Tool\Scenario**|**Health**|**Search**|**Databases**|**Performance**|**Workflows**|**Virtual environments**|**Business Data Connectivity**|**Business Intelligence**|**Access Services**|**Farms**|**Servers**|**Service applications**|**Web applications**|
-|:--|:--|:--|:--|:--|:--|:--|:--|:--|:--|:--|:--|:--|:--|
-|SharePoint Health Analyzer <br/> |√ <br/> |√ <br/> |√ <br/> |√ <br/> |X <br/> |X <br/> |√ <br/> |√ <br/> |√ <br/> |√ <br/> |√ <br/> |√ <br/> |X <br/> |
-|Timer jobs <br/> |√ <br/> |√ <br/> |√ <br/> |√ <br/> |√ <br/> |X <br/> |X <br/> |√ <br/> |X <br/> |X <br/> |X <br/> |√ <br/> |√ <br/> |
-|Reporting <br/> |√ <br/> |√ <br/> |√ <br/> |√ <br/> |√ <br/> |X <br/> |√ <br/> |√ <br/> |√ <br/> |√ <br/> |√ <br/> |√ <br/> |X <br/> |
-|PowerShell <br/> |√ <br/> |√ <br/> |√ <br/> |√ <br/> |√ <br/> |X <br/> |√ <br/> |√ <br/> |√ <br/> |√ <br/> |√ <br/> |√ <br/> |√ <br/> |
-|System Center with System Center Management Pack for SharePoint Server <br/> |√ <br/> |√ <br/> |√ <br/> |√ <br/> |X <br/> |√ <br/> |√ <br/> |√ <br/> |√ <br/> |√ <br/> |√ <br/> |√ <br/> |X <br/> |
-|Event Viewer <br/> |√ <br/> |√ <br/> |√ <br/> |√ <br/> |√ <br/> |X <br/> |√ <br/> |√ <br/> |√ <br/> |√ <br/> |√ <br/> |√ <br/> |√ <br/> |
-|SharePoint Developer Dashboard <br/> |X <br/> |X <br/> |X <br/> |√\* <br/> |X <br/> |X <br/> |X <br/> |X <br/> |X <br/> |X <br/> |X <br/> |X <br/> |X <br/> |
-|Windows Management Instrumentation (WMI) <br/> |√ <br/> |√ <br/> |√ <br/> |√ <br/> |X <br/> |√\*\* <br/> |X <br/> |√ <br/> |X <br/> |X <br/> |√ <br/> |X <br/> |X <br/> |
-|SQL Server Reporting Services <br/> |√ <br/> |√ <br/> |√ <br/> |√ <br/> |√ <br/> |X <br/> |√ <br/> |√ <br/> |√ <br/> |√ <br/> |√ <br/> |√ <br/> |√ <br/> |
-
+|Tool\Scenario|Health|Search|Databases|Performance|Workflows|Virtual environments|Business Data Connectivity|Business Intelligence|Access Services|Farms|Servers|Service applications|Web applications|
+|||||||||||||||
+|SharePoint Health Analyzer|√|√|√|√|X|X|√|√|√|√|√|√|X|
+|Timer jobs|√|√|√|√|√|X|X|√|X|X|X|√|√|
+|Reporting|√|√|√|√|√|X|√|√|√|√|√|√|X|
+|PowerShell|√|√|√|√|√|X|√|√|√|√|√|√|√|
+|System Center with System Center Management Pack for SharePoint Server|√|√|√|√|X|√|√|√|√|√|√|√|X|
+|Event Viewer|√|√|√|√|√|X|√|√|√|√|√|√|√|
+|SharePoint Developer Dashboard|X|X|X|√\*|X|X|X|X|X|X|X|X|X|
+|Windows Management Instrumentation (WMI)|√|√|√|√|X|√\*\*|X|√|X|X|√|X|X|
+|SQL Server Reporting Services|√|√|√|√|√|X|√|√|√|√|√|√|√|
+ **Note:**
-
+ \*: SharePoint Developer Dashboard only monitors performance of web pages.
-
+ \*\*: The WMI interfaces can manage the Hyper-V services.
-
+ ## Determine daily, weekly, and monthly monitoring items <a name="section3"> </a> You can decide which items to monitor daily, weekly and monthly based on the "Daily Tasks" section (on page 45), the "Weekly Tasks" section (on page 53), the "Monthly Tasks" section (on page 54), and the "Impromptu Tasks" section (on page 54) in the [SharePoint Server 2013: Operations Framework and Checklists](https://www.microsoft.com/download/details.aspx?id=42531)white paper.
-
+ > [!NOTE] > While this white paper addresses SharePoint 2013, you can still use this information to help plan monitoring schedules for SharePoint Server.
-
+ ## Plan monitoring personnel <a name="section4"> </a> You have to estimate how many people you will require to monitor the SharePoint Server environment. Depending on the size of the SharePoint environment, you might assign dedicated people to monitor the SharePoint environment. For very large enterprise farms, you might require that one or two people are dedicated to each farm.
-
+ When planning for monitoring personnel, consider the following:
-
+ - Small farm (Small user base, or line of business (LOB) applications)
-
+ - Medium farm (Enterprise, Service Applications, etc.)
-
+ - Large enterprise farm (Large Enterprise, Many Service Applications, Self-Provisioning, etc.)
-
+ - High availability requirements (Service level agreements, SLAs)
-
+ - High performance requirements (Page render times)
-
+ - User base size (how many unique users)
-
+ - Concurrent users (how many users actively hitting the portal at once)
-
+ - Requests per second (also during peak hours)
-
+ - Operational maturity
-
+ - Management tools
-
-The following table shows approximately how many people of different skill levels are required to monitor the SharePoint environment depending on the number of servers. Note that this table only provides a very rough estimate.
-
+
+The following table shows approximately how many people of different skill levels are required to monitor the SharePoint environment depending on the number of servers. Note that this table only provides a very rough estimate.
+ **Monitoring personnel required**
-|**Number of servers**|**Personnel required**|**Skill level required**|
-|:--|:--|:--|
-|1~4 <br/> |1 <br/> |Basic <br/> |
-|4~10 <br/> |1~2 <br/> |Advanced <br/> |
-|10~40 <br/> |3~4 <br/> |Basic and Advanced <br/> |
-|40~100 <br/> |5+ <br/> |Basic and Advanced <br/> |
-|100+ <br/> |10+ <br/> |Basic and Advanced <br/> |
-
+|Number of servers|Personnel required|Skill level required|
+||||
+|1~4|1|Basic|
+|4~10|1~2|Advanced|
+|10~40|3~4|Basic and Advanced|
+|40~100|5+|Basic and Advanced|
+|100+|10+|Basic and Advanced|
+ ## Create a response plan <a name="section5"> </a> We recommend that you create a response plan to help prepare for potential problems and to specify what actions to take when a problem does occur.
-
+ The response plan should exclude SharePoint Health Analyzer rules that provide workable solutions already. For a problem that has no immediate solutions, you must investigate the logs by using monitoring tools such as the Event Viewer to find a solution.
-
+ The following table shows some factors that you should consider when you develop a response plan.
-
+ **Suggested items in a response plan**
-|**Item**|**Description**|
-|:--|:--|
-|Alert/Event/Problem <br/> |The verbatim message, the verbatim event, or description of the problem. <br/> |
-|Affected services/applications <br/> |Services or applications that will be affected by the problem. <br/> |
-|Symptom <br/> |Symptom of the problem. <br/> |
-|Severity <br/> |Severity of the problem. Problems with high severity must have high priority. <br/> |
-|Problem must be resolved in (minutes or hours) <br/> |Acceptable lapse time of service. <br/> |
-|Possible causes <br/> |Possible causes of the problem. <br/> |
-|Resolutions <br/> |Resolutions of the problem. <br/> |
-|Contacts <br/> |People who should be contacted when this problem occurs. <br/> |
-|Escalation <br/> |People or teams that should be contacted if the resolutions did not successfully resolve the problem. <br/> |
-|Related resources <br/> |Any resources that may help resolve the problem, such as articles on docs.microsoft.com for SharePoint Server. <br/> |
-|Note <br/> |Any issues that you want to highlight. <br/> |
-
+|Item|Description|
+|||
+|Alert/Event/Problem|The verbatim message, the verbatim event, or description of the problem.|
+|Affected services/applications|Services or applications that will be affected by the problem.|
+|Symptom|Symptom of the problem.|
+|Severity|Severity of the problem. Problems with high severity must have high priority.|
+|Problem must be resolved in (minutes or hours)|Acceptable lapse time of service.|
+|Possible causes|Possible causes of the problem.|
+|Resolutions|Resolutions of the problem.|
+|Contacts|People who should be contacted when this problem occurs.|
+|Escalation|People or teams that should be contacted if the resolutions did not successfully resolve the problem.|
+|Related resources|Any resources that may help resolve the problem, such as articles on docs.microsoft.com for SharePoint Server.|
+|Note|Any issues that you want to highlight.|
+ ## See also <a name="section5"> </a> #### Concepts [Overview of monitoring in SharePoint Server](monitoring-overview.md)
-
+ [Monitor apps for SharePoint for SharePoint Server](monitor-apps-for-sharepoint.md)
-
+ [Storage and SQL Server capacity planning and configuration (SharePoint Server)](storage-and-sql-server-capacity-planning-and-configuration.md)
-
+ [Monitor cache performance in SharePoint Server 2016](monitor-cache-performance.md) #### Other Resources
SharePoint Move Content Databases https://github.com/MicrosoftDocs/OfficeDocs-SharePoint/commits/public/SharePoint/SharePointServer/administration/move-content-databases.md
Title: "Move content databases in SharePoint Server"-+
description: "Learn how to move content databases in SharePoint Server."
# Move content databases in SharePoint Server
-
+ This article describes how to move content databases between servers that are running SQL Server, between instances of SQL Server, or from one SharePoint Server web application to another.
-
+ > [!IMPORTANT]
-> This article only describes how to move content databases. For information about how to move other kinds of databases that are associated with SharePoint Server, see [Move or rename service application databases in SharePoint Server](move-or-rename-service-application-databases.md) and [Move all databases in SharePoint Server](move-all-databases.md).
-
+> This article only describes how to move content databases. For information about how to move other kinds of databases that are associated with SharePoint Server, see [Move or rename service application databases in SharePoint Server](move-or-rename-service-application-databases.md) and [Move all databases in SharePoint Server](move-all-databases.md).
+ You can move content databases by using the SharePoint Central Administration website or Microsoft PowerShell, and SQL Server tools. Which tool that you use depends on what kind of environment you have deployed, what your schedule requires, and what service level agreements that you have made with your organization.
-
-
+ ## Before you begin <a name="begin"> </a> Before you begin this operation, moving a content database, review the following tasks. Each task is a procedure that must be done in the order in which it is listed. Note that when you move content databases, you must use both SharePoint Server tools and SQL Server tools. You can use either Central Administration or Windows PowerShell 3.0 for this operation.
-
+ 1. Record the content database name and the web application it is associated with.
-
+ 2. Pause any service applications and services that might run against the content database, including timer jobs and search crawls.
-
+ 3. Remove the SharePoint Server content database from the web application.
-
+ 4. Detach the content database from the current SQL Server instance.
-
+ > [!IMPORTANT]
- > To move the content database file within the same instance SQL Server we recommend that you use the **FILENAME** clause of the **ALTER DATABASE** statement. For more information, see [Move User Databases](/sql/relational-databases/databases/move-user-databases?viewFallbackFrom=sql-server-2014).
-
+ > To move the content database file within the same instance SQL Server we recommend that you use the **FILENAME** clause of the **ALTER DATABASE** statement. For more information, see [Move User Databases](/sql/relational-databases/databases/move-user-databases?viewFallbackFrom=sql-server-2014).
+ > [!IMPORTANT]
- > To move a content database to another instance of SQL Server or to another server, we recommend that you use procedures found in [Database Detach and Attach (SQL Server)](/sql/relational-databases/databases/database-detach-and-attach-sql-server?viewFallbackFrom=sql-server-2014) or [Back Up and Restore of SQL Server Databases](/sql/relational-databases/backup-restore/back-up-and-restore-of-sql-server-databases?viewFallbackFrom=sql-server-2014).
-
+ > To move a content database to another instance of SQL Server or to another server, we recommend that you use procedures found in [Database Detach and Attach (SQL Server)](/sql/relational-databases/databases/database-detach-and-attach-sql-server?viewFallbackFrom=sql-server-2014) or [Back Up and Restore of SQL Server Databases](/sql/relational-databases/backup-restore/back-up-and-restore-of-sql-server-databases?viewFallbackFrom=sql-server-2014).
+ 5. Copy or move the content database .mdf, .ndf, and .ldf files from the source location to the destination location using File Explorer.
-
+ 6. Attach the content database to the new SQL Server instance.
-
+ 7. Add the content database to the destination web application in SharePoint Server.
-
+ > [!IMPORTANT]
- > Use the identical name when you add the content database or SharePoint Server creates a new content database.
-
+ > Use the identical name when you add the content database or SharePoint Server creates a new content database.
+ 8. Restart all service applications and services that you paused in step 2.
-
+ ## Moving content databases by using Central Administration <a name="proc1"> </a>
-Use the following procedure to move the content databases in your SharePoint Server farm by using Central Administration.
-
+Use the following procedure to move the content databases in your SharePoint Server farm by using Central Administration.
+ The procedures in this section use Central Administration to move content databases. However when you perform the following procedures, you must use the correct tool:
-
-1. To record which content databases are associated with each web application ΓöÇ PowerShell
-
-4. To detach the content databases from SQL Server ΓöÇ SQL Server tools
-
-5. To move the content databases to a new location ΓöÇ File Explorer or Windows Explorer
-
-6. To attach the content databases to the new instance of SQL Server ΓöÇ SQL Server tools
-
-> [!NOTE]
-> The procedures in this section use Central Administration to move content databases. However, the first procedure, must be performed by using PowerShell.
-
+
+1. To record which content databases are associated with each web application - PowerShell
+
+2. To detach the content databases from SQL Server - SQL Server tools
+
+3. To move the content databases to a new location - File Explorer or Windows Explorer
+
+4. To attach the content databases to the new instance of SQL Server - SQL Server tools
+ > [!NOTE]
-> If you are moving a content database to a different farm, you must make the server farm account a member of the Administrators group on the database server during the restore process. This enables the account to replicate the security setting for the databases. This access level can be removed after the content database is moved. For more information, see [Account permissions and security settings in SharePoint Server 2016](../install/account-permissions-and-security-settings-in-sharepoint-server-2016.md).
-
-The destination farm must be running the same version or a later version of SharePoint Server than the source farm is running.
-
+> The procedures in this section use Central Administration to move content databases. However, the first procedure, must be performed by using PowerShell.
+>
+> If you are moving a content database to a different farm, you must make the server farm account a member of the Administrators group on the database server during the restore process. This enables the account to replicate the security setting for the databases. This access level can be removed after the content database is moved. For more information, see [Account permissions and security settings in SharePoint Server 2016](../install/account-permissions-and-security-settings-in-sharepoint-server-2016.md).
+
+The destination farm must be running the same version or a later version of SharePoint Server than the source farm is running.
+ ### 1. To record which content databases are associated with each web application 1. Verify that you have the following memberships:
-
- - **securityadmin** fixed server role on the SQL Server instance.
-
- - **db_owner** fixed database role on all databases that are to be updated.
-
- - Administrators group on the server on which you are running the PowerShell cmdlets.
-
- - The **dbcreator** and **securityadmin** fixed server roles on the destination server, in order to attach the database and configure SQL Server logins.
-
- An administrator can use the **Add-SPShellAdmin** cmdlet to grant permissions to use SharePoint Server cmdlets.
-
+
+ - **securityadmin** fixed server role on the SQL Server instance.
+
+ - **db_owner** fixed database role on all databases that are to be updated.
+
+ - Administrators group on the server on which you are running the PowerShell cmdlets.
+
+ - The **dbcreator** and **securityadmin** fixed server roles on the destination server, in order to attach the database and configure SQL Server logins.
+
+ An administrator can use the **Add-SPShellAdmin** cmdlet to grant permissions to use SharePoint Server cmdlets.
+ > [!NOTE]
- > If you do not have permissions, contact your Setup administrator or SQL Server administrator to request permissions. For additional information about PowerShell permissions, see [Add-SPShellAdmin](/powershell/module/sharepoint-server/Add-SPShellAdmin).
-
+ > If you do not have permissions, contact your Setup administrator or SQL Server administrator to request permissions. For additional information about PowerShell permissions, see [Add-SPShellAdmin](/powershell/module/sharepoint-server/Add-SPShellAdmin).
+ 2. Start the SharePoint Management Shell.
-
+ 3. At the PowerShell command prompt, type the following command:
-
- ```
- Get-SPContentDatabase -WebApplication <http://SiteName>
- ```
- Where: _\<http://SiteName\>_ is the URL of the web application.
-
+ ```powershell
+ Get-SPContentDatabase -WebApplication <http://SiteName>
+ ```
+
+ Where: _\<http://SiteName\>_ is the URL of the web application.
+ > [!NOTE]
- > We recommend that you use Microsoft PowerShell when performing command-line administrative tasks. The Stsadm command-line tool has been deprecated, but is included to support compatibility with previous product versions.
-
+ > We recommend that you use Microsoft PowerShell when performing command-line administrative tasks. The Stsadm command-line tool has been deprecated, but is included to support compatibility with previous product versions.
+ ### 2. To pause timer jobs by using Central Administration 1. Verify that the user account that is performing this procedure is a member of the Farm Administrators SharePoint group.
-
+ 2. In Central Administration, in the **Monitoring** section, click **Check Job Status**.
-
+ 3. For each scheduled job that runs against the content database that you are moving, click the job to open the **Edit Timer Job** page, click **Disable**, and then click **OK**.
-
+ ### 3. To detach the content databases from a web application by using Central Administration 1. Verify that the user account that is performing this procedure is a member of the Farm Administrators SharePoint group.
-
+ 2. In Central Administration, in the **Application Management** section, click **Manage Content databases**.
-
-3. On the **Manage Content Databases** page, click the content database that you want to move.
-
- The **Manage Content Database Settings** page opens.
-
+
+3. On the **Manage Content Databases** page, click the content database that you want to move.
+
+ The **Manage Content Database Settings** page opens.
+ > [!NOTE]
- > If the content database does not appear in the list, it might be associated with another web application. To select another web application, on the **Web Application** menu, click **Change Web Application**.
-
+ > If the content database does not appear in the list, it might be associated with another web application. To select another web application, on the **Web Application** menu, click **Change Web Application**.
+ 4. On the **Manage Content Database Settings** page, in the **Remove Content Database** section, select the **Remove content database** check box, and then click **OK**.
-
+ > [!NOTE]
- > Removing the content database does not delete the database. It only removes the association of the database with the web application.
-
+ > Removing the content database does not delete the database. It only removes the association of the database with the web application.
+ 5. Repeat steps 3 and 4 for each content database that you want to move.
-
+ ### 4. To detach the content databases from SQL Server
-1. Verify that the user account that is performing this procedure is a member of the **db_owner** fixed database role on the database server where each database is stored.
-
-2. In SQL Server Management Studio, open the source SQL Server instance, and then expand the **Databases** node.
-
+1. Verify that the user account that is performing this procedure is a member of the **db_owner** fixed database role on the database server where each database is stored.
+
+2. In SQL Server Management Studio, open the source SQL Server instance, and then expand the **Databases** node.
+ 3. Right-click the content database, point to **Tasks**, and then click **Detach**. Repeat this step for each content database that you want to move.
-
+ > [!NOTE]
- > Use this procedure to move only content databases. Do not detach any other kinds of databases.
-
+ > Use this procedure to move only content databases. Do not detach any other kinds of databases.
+ ### 5. To move the content databases to a new location 1. Verify that the user account that is performing this procedure has Write access to both the source and destination folders.
-
+ 2. Using File Explorer, locate the .mdf, .ldf, and .ndf files for the content databases.
-
+ 3. Select the .mdf, .ldf, and .ndf files for the database that you want to move and either copy or move them to the destination directory.
-
+ ### 6. To attach the content databases to the new instance of SQL Server
-1. Verify that the user account that is performing this procedure is a member of the **dbcreator** fixed server role on the database server where each database is stored.
-
+1. Verify that the user account that is performing this procedure is a member of the **dbcreator** fixed server role on the database server where each database is stored.
+ 2. In Management Studio, open the destination SQL Server instance.
-
+ 3. Right-click the **Databases** node, point to **Tasks**, and then click **Attach**.
-
+ 4. In the **Attach Database** dialog, browse to where you transferred the .mdf, .ldf, and .ndf files, select the .mdf file for the database that you want to attach, and then click **OK**.
-
+ 5. Repeat for each content database that you are moving.
-
+ ### 7. To attach the content databases to the web application by using Central Administration 1. Verify that the user account that is performing this procedure is a member of the Farm Administrators group.
-
+ 2. In Central Administration, in the **Application Management** section, click **Manage Content databases**.
-
+ 3. On the **Manage Content Databases** page, click **Add a content database**.
-
-4. On the **Add Content Database** page, verify that the **Web Application** menu displays the correct web application.
-
-5. In the **Server** box, specify the database server that hosts the database.
-
-6. In the **Database Name** box, type the exact name of the transferred content database.
-
+
+4. On the **Add Content Database** page, verify that the **Web Application** menu displays the correct web application.
+
+5. In the **Server** box, specify the database server that hosts the database.
+
+6. In the **Database Name** box, type the exact name of the transferred content database.
+ > [!NOTE]
- > Verify that the name is correct. If it is not, a new database will be created.
-
+ > Verify that the name is correct. If it is not, a new database will be created.
+ 7. Specify the authentication method for the database, and then click **OK**.
-
-8. Repeat these steps for each database that you are adding. Be sure that you select the correct web application from the **Web Application** menu for each database.
-
+
+8. Repeat these steps for each database that you are adding. Be sure that you select the correct web application from the **Web Application** menu for each database.
+ ### 8. To restart timer jobs by using Central Administration 1. Verify that the user account that is performing this procedure is a member of the Farm Administrators group.
-
+ 2. In Central Administration, in the **Monitoring** section, click **Check Job Status**.
-
+ 3. For each scheduled job that you disabled previously, click the job to open the **Edit Timer Job** page, click **Enable**, and then click **OK**.
-
+ ## Moving content databases by using PowerShell <a name="proc2"> </a> Use the following procedure to move the content databases in your SharePoint Server farm by using PowerShell
-
+ The procedures in this section use PowerShell to move content databases. However when you perform the following procedures, you must use the correct tool:
-
-4. To detach the content databases from SQL Server ΓöÇ SQL Server tools
-
-5. To move the content databases to a new location ΓöÇ File Explorer
-
-6. To attach the content databases to the new instance of SQL Server ΓöÇ SQL Server tools
-
+
+- To detach the content databases from SQL Server - SQL Server tools
+
+- To move the content databases to a new location - File Explorer
+
+- To attach the content databases to the new instance of SQL Server - SQL Server tools
+ > [!NOTE]
-> If you are moving a content database to a different farm, you must make the server farm account a member of the Administrators group on the database server during the restore process. This enables the account to replicate the security setting for the databases. This access level can be removed after the content database is moved.
-
-The destination farm must be running the same version or a later version of SharePoint Server than the source farm is running.
-
+> If you are moving a content database to a different farm, you must make the server farm account a member of the Administrators group on the database server during the restore process. This enables the account to replicate the security setting for the databases. This access level can be removed after the content database is moved.
+
+The destination farm must be running the same version or a later version of SharePoint Server than the source farm is running.
+ ### 1. To record which content databases are associated with each web application 1. Verify that you have the following memberships:
-
- - **securityadmin** fixed server role on the SQL Server instance.
-
- - **db_owner** fixed database role on all databases that are to be updated.
-
- - Administrators group on the server on which you are running the PowerShell cmdlets.
-
- - The **dbcreator** and **securityadmin** fixed server roles on the destination server, in order to attach the database and configure SQL Server logins.
-
- An administrator can use the **Add-SPShellAdmin** cmdlet to grant permissions to use SharePoint Server cmdlets.
-
+
+ - **securityadmin** fixed server role on the SQL Server instance.
+
+ - **db_owner** fixed database role on all databases that are to be updated.
+
+ - Administrators group on the server on which you are running the PowerShell cmdlets.
+
+ - The **dbcreator** and **securityadmin** fixed server roles on the destination server, in order to attach the database and configure SQL Server logins.
+
+ An administrator can use the **Add-SPShellAdmin** cmdlet to grant permissions to use SharePoint Server cmdlets.
+ > [!NOTE]
- > If you do not have permissions, contact your Setup administrator or SQL Server administrator to request permissions. For additional information about PowerShell permissions, see [Add-SPShellAdmin](/powershell/module/sharepoint-server/Add-SPShellAdmin).
-
+ > If you do not have permissions, contact your Setup administrator or SQL Server administrator to request permissions. For additional information about PowerShell permissions, see [Add-SPShellAdmin](/powershell/module/sharepoint-server/Add-SPShellAdmin).
+ 2. Start the SharePoint Management Shell.
-
+ 3. At the PowerShell command prompt, type the following command:
-
- ```
- Get-SPContentDatabase -WebApplication <http://SiteName>
- ```
- Where: _\<http://SiteName\>_ is the URL of the web application.
-
+ ```powershell
+ Get-SPContentDatabase -WebApplication <http://SiteName>
+ ```
+
+ Where: _\<http://SiteName\>_ is the URL of the web application.
+ For more information, see [Get-SPContentDatabase](/powershell/module/sharepoint-server/Get-SPContentDatabase)
-
+ > [!NOTE]
-> We recommend that you use Microsoft PowerShell when performing command-line administrative tasks. The Stsadm command-line tool has been deprecated, but is included to support compatibility with previous product versions.
-
+> We recommend that you use Microsoft PowerShell when performing command-line administrative tasks. The Stsadm command-line tool has been deprecated, but is included to support compatibility with previous product versions.
+ ### 2. To pause timer jobs by using PowerShell 1. Verify that you have the following memberships:
-
- - **securityadmin** fixed server role on the SQL Server instance.
-
- - **db_owner** fixed database role on all databases that are to be updated.
-
- - Administrators group on the server on which you are running the PowerShell cmdlets.
-
- - The **dbcreator** and **securityadmin** fixed server roles on the destination server, in order to attach the database and configure SQL Server logins.
-
- An administrator can use the **Add-SPShellAdmin** cmdlet to grant permissions to use SharePoint Server cmdlets.
-
+
+ - **securityadmin** fixed server role on the SQL Server instance.
+
+ - **db_owner** fixed database role on all databases that are to be updated.
+
+ - Administrators group on the server on which you are running the PowerShell cmdlets.
+
+ - The **dbcreator** and **securityadmin** fixed server roles on the destination server, in order to attach the database and configure SQL Server logins.
+
+ An administrator can use the **Add-SPShellAdmin** cmdlet to grant permissions to use SharePoint Server cmdlets.
+ > [!NOTE]
- > If you do not have permissions, contact your Setup administrator or SQL Server administrator to request permissions. For additional information about PowerShell permissions, see [Add-SPShellAdmin](/powershell/module/sharepoint-server/Add-SPShellAdmin).
-
+ > If you do not have permissions, contact your Setup administrator or SQL Server administrator to request permissions. For additional information about PowerShell permissions, see [Add-SPShellAdmin](/powershell/module/sharepoint-server/Add-SPShellAdmin).
+ 2. Start the SharePoint Management Shell.
-
+ 3. At the PowerShell command prompt, type the following command:
-
- ```
- Get-SPTimerJob -webapplication <http://WebApplicationURL> | select name | Out-File <c:\timerjobfile.txt> -Append -Encoding ascii
- ForEach($tmrjob in (Get-Content <c:\timerjobfile.txt>)) { Get-SPTimerJob -Identity $tmrjob | Disable-SPTimerjob }
-
- ```
-
- Where:
-
- - _\<http://WebApplicationURL\>_ is the Web application associated with the content database that you are moving.
-
- - _\<c:\timerjobfile.txt\>_ is the location of the file that you are creating that lists all timer jobs associated with the Web application.
-
+
+ ```powershell
+ Get-SPTimerJob -webapplication <http://WebApplicationURL> | select name | Out-File <c:\timerjobfile.txt> -Append -Encoding ascii
+ ForEach($tmrjob in (Get-Content <c:\timerjobfile.txt>)) { Get-SPTimerJob -Identity $tmrjob | Disable-SPTimerjob }
+ ```
+
+ Where:
+
+ - _\<http://WebApplicationURL\>_ is the Web application associated with the content database that you are moving.
+
+ - _\<c:\timerjobfile.txt\>_ is the location of the file that you are creating that lists all timer jobs associated with the Web application.
+ For more information, see [Get-SPTimerJob](/powershell/module/sharepoint-server/Get-SPTimerJob), [Out-File](/powershell/module/microsoft.powershell.utility/out-file), [ForEach-Object](/powershell/module/microsoft.powershell.core/foreach-object), [Get-Content](/powershell/module/microsoft.powershell.management/get-content), and [Disable-SPTimerJob](/powershell/module/sharepoint-server/Disable-SPTimerJob).
-
+ > [!NOTE]
-> We recommend that you use Microsoft PowerShell when performing command-line administrative tasks. The Stsadm command-line tool has been deprecated, but is included to support compatibility with previous product versions.
-
+> We recommend that you use Microsoft PowerShell when performing command-line administrative tasks. The Stsadm command-line tool has been deprecated, but is included to support compatibility with previous product versions.
+ ### 3. To detach content databases from a web application by using PowerShell 1. Verify that you have the following memberships:
-
- - **securityadmin** fixed server role on the SQL Server instance.
-
- - **db_owner** fixed database role on all databases that are to be updated.
-
- - Administrators group on the server on which you are running the PowerShell cmdlets.
-
- - The **dbcreator** and **securityadmin** fixed server roles on the destination server, in order to attach the database and configure SQL Server logins.
-
- An administrator can use the **Add-SPShellAdmin** cmdlet to grant permissions to use SharePoint Server cmdlets.
-
+
+ - **securityadmin** fixed server role on the SQL Server instance.
+
+ - **db_owner** fixed database role on all databases that are to be updated.
+
+ - Administrators group on the server on which you are running the PowerShell cmdlets.
+
+ - The **dbcreator** and **securityadmin** fixed server roles on the destination server, in order to attach the database and configure SQL Server logins.
+
+ An administrator can use the **Add-SPShellAdmin** cmdlet to grant permissions to use SharePoint Server cmdlets.
+ > [!NOTE]
- > If you do not have permissions, contact your Setup administrator or SQL Server administrator to request permissions. For additional information about PowerShell permissions, see [Add-SPShellAdmin](/powershell/module/sharepoint-server/Add-SPShellAdmin).
-
+ > If you do not have permissions, contact your Setup administrator or SQL Server administrator to request permissions. For additional information about PowerShell permissions, see [Add-SPShellAdmin](/powershell/module/sharepoint-server/Add-SPShellAdmin).
+ 2. Start the SharePoint Management Shell.
-
+ 3. At the PowerShell command prompt, type the following command:
-
- ```
- Dismount-SPContentDatabase "<ContentDB>"
- ```
- Where: _\<ContentDB\>_ is the name of the content database.
-
- > [!NOTE]
- > If you have multiple content databases that have the same name, you must use the content database GUID in this command instead of using the content database name. To retrieve the GUID of the content database, run the **Get-SPContentDatabase** cmdlet without arguments.
-
- For more information, see [Dismount-SPContentDatabase](/powershell/module/sharepoint-server/Dismount-SPContentDatabase) and [Get-SPContentDatabase](/powershell/module/sharepoint-server/Get-SPContentDatabase).
-
- > [!NOTE]
- > We recommend that you use Microsoft PowerShell when performing command-line administrative tasks. The Stsadm command-line tool has been deprecated, but is included to support compatibility with previous product versions.
-
+ ```powershell
+ Dismount-SPContentDatabase "<ContentDB>"
+ ```
+
+ Where: _\<ContentDB\>_ is the name of the content database.
+
+ > [!NOTE]
+ > If you have multiple content databases that have the same name, you must use the content database GUID in this command instead of using the content database name. To retrieve the GUID of the content database, run the **Get-SPContentDatabase** cmdlet without arguments.
+
+ For more information, see [Dismount-SPContentDatabase](/powershell/module/sharepoint-server/Dismount-SPContentDatabase) and [Get-SPContentDatabase](/powershell/module/sharepoint-server/Get-SPContentDatabase).
+
+ > [!NOTE]
+ > We recommend that you use Microsoft PowerShell when performing command-line administrative tasks. The Stsadm command-line tool has been deprecated, but is included to support compatibility with previous product versions.
+ ### 4. To detach the content databases from SQL Server
-1. Verify that the user account that is performing this procedure is a member of the **db_owner** fixed database role on the database server where each database is stored.
-
-2. In Management Studio, open the source SQL Server instance, and then expand the **Databases** node.
-
+1. Verify that the user account that is performing this procedure is a member of the **db_owner** fixed database role on the database server where each database is stored.
+
+2. In Management Studio, open the source SQL Server instance, and then expand the **Databases** node.
+ 3. Right-click the content database, point to **Tasks**, and then click **Detach**. Repeat this step for each content database that you want to move.
-
+ > [!NOTE]
-> Use this procedure to move only content databases. Do not detach any other kinds of databases.
-
+> Use this procedure to move only content databases. Do not detach any other kinds of databases.
+ ### 5. To move the content databases to a new location 1. Verify that the user account that is performing this procedure has Write access to both the source and destination folders.
-
+ 2. Using File Explorer, locate the .mdf, .ldf, and .ndf files for the content databases.
-
+ 3. Select the .mdf, .ldf, and .ndf files for the database that you want to move and either copy or move them to the destination directory.
-
+ ### 6. To attach the content databases to the new instance of SQL Server
-1. Verify that the user account that is performing this procedure is a member of the **dbcreator** fixed server role on the database server where each database is stored.
-
+1. Verify that the user account that is performing this procedure is a member of the **dbcreator** fixed server role on the database server where each database is stored.
+ 2. In Management Studio, open the destination SQL Server instance.
-
+ 3. Right-click the **Databases** node, point to **Tasks**, and then click **Attach**.
-
+ 4. In the **Attach Database** dialog, browse to where you transferred the .mdf, .ldf, and .ndf files, select the .mdf file for the database that you want to attach, and then click **OK**.
-
+ 5. Repeat for each content database that you are moving.
-
+ ### 7. To attach content databases from a web application by using PowerShell 1. Verify that you have the following memberships:
-
- - **securityadmin** fixed server role on the SQL Server instance.
-
- - **db_owner** fixed database role on all databases that are to be updated.
-
- - Administrators group on the server on which you are running the PowerShell cmdlets.
-
- - The **dbcreator** and **securityadmin** fixed server roles on the destination server, in order to attach the database and configure SQL Server logins.
-
- An administrator can use the **Add-SPShellAdmin** cmdlet to grant permissions to use SharePoint Server cmdlets.
-
- > [!NOTE]
- > If you do not have permissions, contact your Setup administrator or SQL Server administrator to request permissions. For additional information about PowerShell permissions, see [Add-SPShellAdmin](/powershell/module/sharepoint-server/Add-SPShellAdmin).
-
+
+ - **securityadmin** fixed server role on the SQL Server instance.
+
+ - **db_owner** fixed database role on all databases that are to be updated.
+
+ - Administrators group on the server on which you are running the PowerShell cmdlets.
+
+ - The **dbcreator** and **securityadmin** fixed server roles on the destination server, in order to attach the database and configure SQL Server logins.
+
+ An administrator can use the **Add-SPShellAdmin** cmdlet to grant permissions to use SharePoint Server cmdlets.
+
+ > [!NOTE]
+ > If you do not have permissions, contact your Setup administrator or SQL Server administrator to request permissions. For additional information about PowerShell permissions, see [Add-SPShellAdmin](/powershell/module/sharepoint-server/Add-SPShellAdmin).
+ 2. Start the SharePoint Management Shell.
-
+ 3. At the PowerShell command prompt, type the following command:
-
- ```
- Mount-SPContentDatabase "<ContentDB>" -DatabaseServer "<DBServer>" -WebApplication <http://SiteName>
- ```
-
- Where:
-
- - _\<ContentDB\>_ is the name of the content database to be attached.
-
- - _\<DBServer\>_ is the name of the database server.
-
- - _\<http://SiteName\>_ is the URL of the Web application to which the content database is being attached.
-
+
+ ```powershell
+ Mount-SPContentDatabase "<ContentDB>" -DatabaseServer "<DBServer>" -WebApplication <http://SiteName>
+ ```
+
+ Where:
+
+ - _\<ContentDB\>_ is the name of the content database to be attached.
+
+ - _\<DBServer\>_ is the name of the database server.
+
+ - _\<http://SiteName\>_ is the URL of the Web application to which the content database is being attached.
+ For more information, see [Mount-SPContentDatabase](/powershell/module/sharepoint-server/Dismount-SPContentDatabase).
-
+ > [!NOTE]
- > We recommend that you use Microsoft PowerShell when performing command-line administrative tasks. The Stsadm command-line tool has been deprecated, but is included to support compatibility with previous product versions.
-
+ > We recommend that you use Microsoft PowerShell when performing command-line administrative tasks. The Stsadm command-line tool has been deprecated, but is included to support compatibility with previous product versions.
+ ### 8. To restart timer jobs by using PowerShell 1. Verify that you have the following memberships:
-
- - **securityadmin** fixed server role on the SQL Server instance.
-
- - **db_owner** fixed database role on all databases that are to be updated.
-
- - Administrators group on the server on which you are running the PowerShell cmdlets.
-
- - The **dbcreator** and **securityadmin** fixed server roles on the destination server, in order to attach the database and configure SQL Server logins.
-
- An administrator can use the **Add-SPShellAdmin** cmdlet to grant permissions to use SharePoint Server cmdlets.
-
- > [!NOTE]
- > If you do not have permissions, contact your Setup administrator or SQL Server administrator to request permissions. For additional information about PowerShell permissions, see [Add-SPShellAdmin](/powershell/module/sharepoint-server/Add-SPShellAdmin).
-
+
+ - **securityadmin** fixed server role on the SQL Server instance.
+
+ - **db_owner** fixed database role on all databases that are to be updated.
+
+ - Administrators group on the server on which you are running the PowerShell cmdlets.
+
+ - The **dbcreator** and **securityadmin** fixed server roles on the destination server, in order to attach the database and configure SQL Server logins.
+
+ An administrator can use the **Add-SPShellAdmin** cmdlet to grant permissions to use SharePoint Server cmdlets.
+
+ > [!NOTE]
+ > If you do not have permissions, contact your Setup administrator or SQL Server administrator to request permissions. For additional information about PowerShell permissions, see [Add-SPShellAdmin](/powershell/module/sharepoint-server/Add-SPShellAdmin).
+ 2. Start the SharePoint Management Shell.
-
+ 3. At the PowerShell command prompt, type the following command:
-
- ```
- ForEach($tmrjob in (Get-Content <c:\timerjobfile.txt>)) {Get-SPTimerJob -Identity $tmrjob | Enable-SPTimerjob}
-
- ```
-
- Where: _\<c:\timerjobfile.txt\>_ is the location of the file that you created that lists all of the timer jobs associated with the Web application.
-
+
+ ```powershell
+ ForEach($tmrjob in (Get-Content <c:\timerjobfile.txt>)) {Get-SPTimerJob -Identity $tmrjob | Enable-SPTimerjob}
+ ```
+
+ Where: _\<c:\timerjobfile.txt\>_ is the location of the file that you created that lists all of the timer jobs associated with the Web application.
+ For more information, see [Get-SPTimerJob](/powershell/module/sharepoint-server/Get-SPTimerJob), [ForEach-Object](/powershell/module/microsoft.powershell.core/foreach-object), [Get-Content](/powershell/module/microsoft.powershell.management/get-content), and [Enable-SPTimerJob](/powershell/module/sharepoint-server/Enable-SPTimerJob).
-
+ > [!NOTE]
- > We recommend that you use Microsoft PowerShell when performing command-line administrative tasks. The Stsadm command-line tool has been deprecated, but is included to support compatibility with previous product versions.
-
+ > We recommend that you use Microsoft PowerShell when performing command-line administrative tasks. The Stsadm command-line tool has been deprecated, but is included to support compatibility with previous product versions.
+ ## See also <a name="proc2"> </a> #### Concepts
-[Move all databases in SharePoint Server](move-all-databases.md)
+[Move all databases in SharePoint Server](move-all-databases.md)
SharePoint Move Or Rename Service Application Databases https://github.com/MicrosoftDocs/OfficeDocs-SharePoint/commits/public/SharePoint/SharePointServer/administration/move-or-rename-service-application-databases.md
Title: "Move or rename service application databases in SharePoint Server"-+
description: "Learn how to move or rename service application databases in Share
[!INCLUDE[appliesto-2013-2016-2019-SUB-xxx-md](../includes/appliesto-2013-2016-2019-SUB-xxx-md.md)] Learn how to move or rename service application databases in SharePoint Server.
-
+ The main reason to move service application databases to another farm database server is to load balance the farm. Or you might need to move it to newer hardware.
-
-Renaming service application databases is often done to remove the GUID from the database name after you've used SharePoint Products Configuration Wizard and SharePoint Server Product Configuration Wizard to create the service application databases in your farm. You might also need to align the database names with your organization's naming standards.
-
+
+Renaming service application databases is often done to remove the GUID from the database name after you've used SharePoint Products Configuration Wizard and SharePoint Server Product Configuration Wizard to create the service application databases in your farm. You might also need to align the database names with your organization's naming standards.
+ Both moving and renaming service application databases follow the same basic process, but there are a few more steps when you are moving service application databases.
-
+ 1. Move or rename SharePoint Server service application databases using Microsoft SQL Server Management Studio or Microsoft PowerShell.
-
+ 2. Point the SharePoint service application to the moved or renamed database using either the SharePoint Central Administration website or PowerShell.
-
+ Depending on how many service application databases you move or rename, pointing the service application to the database can be complex. Different service applications require different methods to point to the moved or renamed database.
-
+ These service application databases use the following steps:
-
+ - App Management Service
-
+ - Managed Metadata Service
-
+ - PerformancePoint Service
-
+ - Secure Store Service
-
+ - SharePoint Translation Service
-
+ - State Service
-
+ - Subscription Settings Service
-
+ - Word Automation Services
-
+ 1. Stop or disable the service application.
-
+ 2. Detach the database.
-
+ 3. Move or rename the database.
-
+ 4. Attach the database.
-
+ 5. Point the service application to the moved or renamed database.
-
+ 6. Restart the service application.
-
+ The Business Data Connectivity Service and User Profile Service applications databases require the following steps to move or rename the databases:
-
+ 1. Stop or disable the service application.
-
+ 2. Detach the database.
-
+ 3. Move or rename the database.
-
+ 4. Attach the database.
-
+ 5. Point the service application to the moved or renamed database.
-
+ 6. Delete the service application.
-
+ 7. Recreate the service application.
-
+ 8. Restart the service application.
-
+ The Search Service application databases require the following steps:
-
+ 1. Pause the service application.
-
+ 2. Set the Search service application to Read-Only.
-
+ 3. Backup the service application.
-
+ 4. Set the max degree of parallelism to 1 in the new server that hosts SQL Server.
-
+ 5. Restore the Search service application to a new database server.
-
+ 6. Set the Search Service application to read/write.
-
+ 7. Start the service application.
-
+ 8. Point the Search service application to the moved or renamed databases.
-
-
+ ## General steps to move or rename service application databases by using SQL Server <a name="General"> </a> To move a service application database, you must use SQL Server. To rename a service application database, you must use SQL Server and File Explorer.
-
+ > [!CAUTION]
-> Don't attempt to move and rename a database in one procedure. You should either move a database or rename a database, not perform both actions at the same time.
-
+> Don't attempt to move and rename a database in one procedure. You should either move a database or rename a database, not perform both actions at the same time.
+ When you move or rename service application databases, the first step is to stop the service application for the database that you are changing. You can stop or start services by using Central Administration or PowerShell.
-
+ ### Step 1: To stop the service application by using Central Administration 1. Use an account that is a member of the Farm Administrators SharePoint group.
-
+ 2. In Central Administration click **System Settings**.
-
+ 3. On the System Settings page, in the **Servers** section, click **Manage services on server**.
-
+ 4. Find the service application that you want to stop, click **Stop** or **Disable** in the **Action** column for the service, and then click **OK**.
-
+ ### To stop a service by using PowerShell 1. Use an account with these memberships:
-
- - **securityadmin** fixed server role on the SQL Server instance.
-
- - **db_owner** fixed database role on all databases that are to be updated.
-
- - Administrators group on the server on which you are running the PowerShell cmdlets.
-
+
+ - **securityadmin** fixed server role on the SQL Server instance.
+
+ - **db_owner** fixed database role on all databases that are to be updated.
+
+ - Administrators group on the server on which you are running the PowerShell cmdlets.
+ > [!NOTE]
- > For additional information about Microsoft PowerShell permissions, see [Permissions](/powershell/module/sharepoint-server/add-spshelladmin?view=sharepoint-ps&preserve-view=true).
-
+ > For additional information about Microsoft PowerShell permissions, see [Permissions](/powershell/module/sharepoint-server/add-spshelladmin?view=sharepoint-ps&preserve-view=true).
+ 2. Start the SharePoint Management Shell.
-
-3. You need to know the service GUID for the next step. Use the **Get-SPServiceInstance** cmdlet to retrieve a list of all services in the farm together with their GUIDs.
-
+
+3. You need to know the service GUID for the next step. Use the **Get-SPServiceInstance** cmdlet to retrieve a list of all services in the farm together with their GUIDs.
+ 4. At the PowerShell command prompt, type the following command:
-
+ ```powershell Stop-SPServiceInstance -Identity <ServiceGUID> ```
- Where _\<ServiceGUID\>_ is the GUID of the service.
-
+ Where _\<ServiceGUID\>_ is the GUID of the service.
+ For more information, see [Stop-SPServiceInstance](/powershell/module/sharepoint-server/Stop-SPServiceInstance?view=sharepoint-ps&preserve-view=true).
-
+ ### Move a database by using SQL Server Management Studio and File Explorer <a name="MoveFull"> </a> Moving a database requires that you first detach the database from the SQL Server, move the files to the new location by using File Explorer, and then attach the database to the new instance of SQL Server.
-
+ #### Step 2: To detach a database from SQL Server
-1. Use an account that has the **db_owner** fixed database role for all of the databases that you're moving.
-
-2. In SQL Server Management Studio, connect to the SQL Server instance that the service application database is attached to, and then expand the **Databases** node.
-
+1. Use an account that has the **db_owner** fixed database role for all of the databases that you're moving.
+
+2. In SQL Server Management Studio, connect to the SQL Server instance that the service application database is attached to, and then expand the **Databases** node.
+ 3. Right-click the database, point to **Tasks**, and then click **Detach**. Repeat this step for each database that you want to move.
-
+ #### Step 3: To move the database files to a new location by using File Explorer 1. Use an account that has read permission on the source location and write permission on the target location.
-
+ 2. In File Explorer, find the .mdf, .ndf, and .ldf files for the service application databases and select the ones you want to move. The database files are typically found here, `C:\Program Files\Microsoft SQL Server\MSSQL12.MSSQLServer\MSSQL\Data`
-
+ 3. Either copy or move the database files to the new location.
-
+ #### Step 4: To attach a database to a new instance of SQL Server
-1. Use an account that has the **db_owner** fixed database role for all of the databases that you're moving.
-
+1. Use an account that has the **db_owner** fixed database role for all of the databases that you're moving.
+ 2. In SQL Server Management Studio, open the destination SQL Server instance.
-
+ 3. Right-click the **Databases** node, point to **Tasks**, and then click **Attach**.
-
+ 4. In the **Attach Database** dialog, browse to where you moved the .mdf, .ndf, and .ldf files, select the .mdf file for the database that you want to attach, and then click **OK**. Repeat this step for each database that you're moving.
-
+ ### Rename a database by using SQL Server Management Studio <a name="MoveFull"> </a> Renaming a service application database is a two step process, first stop the service, just as if you were going to move the database. You then rename the database by using SQL Server Management Studio.
-
+ **Step 3: To rename a database by using SQL Server**
-
-1. In SQL Server Management Studio, connect to the source SQL Server instance, and then expand the **Databases** node.
-
+
+1. In SQL Server Management Studio, connect to the source SQL Server instance, and then expand the **Databases** node.
+ 2. Right-click the database that you want to rename, click **Rename**, and then type the new name. Repeat this step for each database that you're renaming.
-
+ ### Point a SharePoint Server service application to a moved or renamed database <a name="MoveFull"> </a> Pointing to the moved or renamed database is the next step. You can do this with either Central Administration or PowerShell. Using Central Administration to point service applications to the moved or renamed databases is the same for most of the SharePoint Server service applications. Using PowerShell to point service applications to the moved or renamed databases differs for each service application. This section provides guidance for each service application and database.
-
+ #### Step 5: To point the service application to a moved or renamed database by using Central Administration 1. Use an account that is a member of the Farm Administrators SharePoint group.
-
+ 2. In Central Administration, under **Application Management**, click **Manage service applications**.
-
-3. On the Manage Service application page, click the empty area in the row next to the service application name. The ribbon becomes active, click **Properties** and the **Edit Service Application** dialog appears.
-
+
+3. On the Manage Service application page, click the empty area in the row next to the service application name. The ribbon becomes active, click **Properties** and the **Edit Service Application** dialog appears.
+ 4. Change the database server or database name, and then click **OK**.
-
+ #### To point the Managed Metadata service application to a moved or renamed database by using PowerShell 1. Use an account with these memberships:
-
- - **securityadmin** fixed server role on the SQL Server instance.
-
- - **db_owner** fixed database role on all databases that are to be updated.
-
- - Administrators group on the server on which you are running the PowerShell cmdlets.
-
+
+ - **securityadmin** fixed server role on the SQL Server instance.
+
+ - **db_owner** fixed database role on all databases that are to be updated.
+
+ - Administrators group on the server on which you are running the PowerShell cmdlets.
+ > [!NOTE]
- > For additional information about Microsoft PowerShell permissions, see [Permissions](/powershell/module/sharepoint-server/add-spshelladmin?view=sharepoint-ps&preserve-view=true).
-
+ > For additional information about Microsoft PowerShell permissions, see [Permissions](/powershell/module/sharepoint-server/add-spshelladmin?view=sharepoint-ps&preserve-view=true).
+ 2. Start the SharePoint Management Shell.
-
+ 3. At the PowerShell command prompt, type the following command:
-
+ ```powershell $app = Get-SPServiceApplication -Name "<ServiceApplicationName>" Set-SPMetadataServiceApplication -Identity "<Name/GUID of service application>" $app -DatabaseName "<DatabaseName>" -DatabaseCredentials PSCredential object> ``` Where:
-
- - _\<ServiceApplicationName\>_ is the name of the Managed Metadata service application.
-
- - _\<DatabaseName\>_ is the name of the renamed database.
-
+
+ - _\<ServiceApplicationName\>_ is the name of the Managed Metadata service application.
+
+ - _\<DatabaseName\>_ is the name of the renamed database.
+ #### To point the PerformancePoint service application to a renamed or moved database by using PowerShell 1. Use an account with these memberships:
-
- - **securityadmin** fixed server role on the SQL Server instance.
-
- - **db_owner** fixed database role on all databases that are to be updated.
-
- - Administrators group on the server on which you are running the PowerShell cmdlets.
-
+
+ - **securityadmin** fixed server role on the SQL Server instance.
+
+ - **db_owner** fixed database role on all databases that are to be updated.
+
+ - Administrators group on the server on which you are running the PowerShell cmdlets.
+ > [!NOTE]
- > For additional information about Microsoft PowerShell permissions, see [Permissions](/powershell/module/sharepoint-server/add-spshelladmin?view=sharepoint-ps&preserve-view=true).
-
+ > For additional information about Microsoft PowerShell permissions, see [Permissions](/powershell/module/sharepoint-server/add-spshelladmin?view=sharepoint-ps&preserve-view=true).
+ 2. Start the SharePoint Management Shell.
-
+ 3. At the PowerShell command prompt, type the following command:
-
+ ```powershell Set-SPPerformancePointServiceApplication -Identity "<ServiceApplicationName>" -SettingsDatabase "<DatabaseServerName\DatabaseName>" ``` Where:
-
- - _\<ServiceApplicationName\>_ is the name of the PerformancePoint service application.
-
- - _\<DatabaseServerName\DatabaseName\>_ is the location of and the name of the renamed or moved database. Do not include the location if you are just renaming the database.
-
-The State Service database stores temporary state information data. You can use PowerShell to point the State Service service application to a moved database by performing one of the following procedures:
-
+
+ - _\<ServiceApplicationName\>_ is the name of the PerformancePoint service application.
+
+ - _\<DatabaseServerName\DatabaseName\>_ is the location of and the name of the renamed or moved database. Do not include the location if you are just renaming the database.
+
+The State Service database stores temporary state information data. You can use PowerShell to point the State Service service application to a moved database by performing one of the following procedures:
+ - Add a new database in the new location, or create a database with a new name. Then add the new database to the service application, and delete the old database. For details, see [To add a new database to the State service application, and remove an old database by using Microsoft PowerShell](#NewDB).
-
+ - Dismount the old database, move it by using SQL Server, and then remount the State Service database. For details, see [To point the State service application to a moved database by using Microsoft PowerShell](#PS).
-
+ The following procedures all include the steps shown in the bullet list. So, they do not require that these steps are already performed:
-
- - Stopping a service application
-
+
+ - Stopping a service application
+ - Moving a database by using SQL Server Management Studio and Windows
-
+ #### <a name="NewDB"></a>To add a new database to the State Service service application and remove an old database by using PowerShell 1. Use an account with these memberships:
-
- - **securityadmin** fixed server role on the SQL Server instance.
-
- - **db_owner** fixed database role on all databases that are to be updated.
-
- - Administrators group on the server on which you are running the PowerShell cmdlets.
-
+
+ - **securityadmin** fixed server role on the SQL Server instance.
+
+ - **db_owner** fixed database role on all databases that are to be updated.
+
+ - Administrators group on the server on which you are running the PowerShell cmdlets.
+ > [!NOTE]
- > For additional information about Microsoft PowerShell permissions, see [Permissions](/powershell/module/sharepoint-server/add-spshelladmin?view=sharepoint-ps&preserve-view=true).
-
+ > For additional information about Microsoft PowerShell permissions, see [Permissions](/powershell/module/sharepoint-server/add-spshelladmin?view=sharepoint-ps&preserve-view=true).
+ 2. Start the SharePoint Management Shell.
-
+ 3. At the PowerShell command prompt, type the following command to create a new database:
-
+ ```powershell
- New-SPStateServiceDatabase -Name "<NewDatabaseName>"
+ New-SPStateServiceDatabase -Name "<NewDatabaseName>"
``` Then type the following command to remove the old database:
-
+ ```powershell Remove-SPStateServiceDatabase -Name "<OldDatabaseName>" ``` Where:
-
- - _\<NewDatabaseName\>_ is the name of the new database that you want to create.
-
- - _\<OldDatabaseName\>_ is the name of the old database that you want to disassociate with the State service and detach from SQL Server.
-
+
+ - _\<NewDatabaseName\>_ is the name of the new database that you want to create.
+
+ - _\<OldDatabaseName\>_ is the name of the old database that you want to disassociate with the State service and detach from SQL Server.
+ #### <a name="PS"></a>To point the State Service service application to a moved database by using PowerShell 1. Start the SharePoint Management Shell.
-
+ 2. At the PowerShell command prompt, type the following command to dismount the database:
-
+ ```powershell Dismount-SPStateServiceDatabase -Identity <DatabaseID> ```
- Where _\<DatabaseID\>_ is the State Service database to remove from the service application. The type must be a valid GUID in the form 12345678-90ab-cdef-1234-567890bcdefgh, a valid name of a state database, or an instance of a valid **SPStateServiceDatabase** object.
-
+ Where _\<DatabaseID\>_ is the State Service database to remove from the service application. The type must be a valid GUID in the form 12345678-90ab-cdef-1234-567890bcdefgh, a valid name of a state database, or an instance of a valid **SPStateServiceDatabase** object.
+ For more information, see [Dismount-SPStateServiceDatabase](/powershell/module/sharepoint-server/Dismount-SPStateServiceDatabase?view=sharepoint-ps&preserve-view=true).
-
+ 3. Move the database. For details, see [Move a database by using SQL Server Management Studio and File Explorer](#MoveFull).
-
+ 4. At the PowerShell command prompt, type the following command to mount the renamed or moved database:
-
+ ```powershell Mount-SPStateServiceDatabase -Name "<DatabaseName>" -DatabaseServer "<ServerName>" ``` Where:
-
- - _\<DatabaseName\>_ is the name of the database to associate with the State service.
-
- - _\<ServerName\>_ is the name of the SQL Server that hosts the State service database.
-
+
+ - _\<DatabaseName\>_ is the name of the database to associate with the State service.
+
+ - _\<ServerName\>_ is the name of the SQL Server that hosts the State service database.
+ #### To point the Usage and Health data collection service application to a moved database by using PowerShell 1. Use an account with these memberships:
-
- - **securityadmin** fixed server role on the SQL Server instance.
-
- - **db_owner** fixed database role on all databases that are to be updated.
-
+
+ - **securityadmin** fixed server role on the SQL Server instance.
+
+ - **db_owner** fixed database role on all databases that are to be updated.
+ - Administrators group on the server on which you are running the PowerShell cmdlets.
-
+ > [!NOTE]
- > For additional information about Microsoft PowerShell permissions, see [Permissions](/powershell/module/sharepoint-server/add-spshelladmin?view=sharepoint-ps&preserve-view=true).
-
+ > For additional information about Microsoft PowerShell permissions, see [Permissions](/powershell/module/sharepoint-server/add-spshelladmin?view=sharepoint-ps&preserve-view=true).
+ 2. Start the SharePoint Management Shell.
-
+ 3. At the PowerShell command prompt, type the following command:
-
+ ```powershell Set-SPUsageApplication -Identity "<ServiceApplicationName>" -DatabaseName "<DbName>" -DatabaseServer "<SQLServerName>"
-
``` Where:
-
- - _\<ServiceApplicationName\>_ is the name of the usage and health data collection service application.
-
- - _\<DatabaseName\>_ is the name of the database.
-
- - _\<SQLServerName\>_ is the name of the database server.
-
+
+ - _\<ServiceApplicationName\>_ is the name of the usage and health data collection service application.
+
+ - _\<DatabaseName\>_ is the name of the database.
+
+ - _\<SQLServerName\>_ is the name of the database server.
+ #### To point the Word Automation service application to a renamed or moved database by using PowerShell 1. Use an account with these memberships:
-
- - **securityadmin** fixed server role on the SQL Server instance.
-
- - **db_owner** fixed database role on all databases that are to be updated.
-
+
+ - **securityadmin** fixed server role on the SQL Server instance.
+
+ - **db_owner** fixed database role on all databases that are to be updated.
+ - Administrators group on the server on which you are running the PowerShell cmdlets.
-
+ > [!NOTE]
- > For additional information about Microsoft PowerShell permissions, see [Permissions](/powershell/module/sharepoint-server/add-spshelladmin?view=sharepoint-ps&preserve-view=true).
-
+ > For additional information about Microsoft PowerShell permissions, see [Permissions](/powershell/module/sharepoint-server/add-spshelladmin?view=sharepoint-ps&preserve-view=true).
+ 2. Start the SharePoint Management Shell.
-
+ 3. At the PowerShell command prompt, type the following command:
-
+ ```powershell $app = Get-SPServiceApplication -Name "<ServiceApplicationName>" Set-SPWordConversionServiceApplication -Identity $app -DatabaseName "<DatabaseName>" -DatabaseServer "<DatabaseServer>" ``` Where:
-
- - _\<ServiceApplicationName\>_ is the name of the Word Automation service application.
-
- - _\<DatabaseName\>_ is the name of the renamed or moved database.
-
- - _\<DatabaseServer\>_ is the location of the renamed or moved database. Do not include this parameter if you are pointing to a renamed database in the same location.
-
+
+ - _\<ServiceApplicationName\>_ is the name of the Word Automation service application.
+
+ - _\<DatabaseName\>_ is the name of the renamed or moved database.
+
+ - _\<DatabaseServer\>_ is the location of the renamed or moved database. Do not include this parameter if you are pointing to a renamed database in the same location.
+ #### To point the Subscription Settings Services service application to a moved database by using PowerShell 1. Use an account with these memberships:
-
- - **securityadmin** fixed server role on the SQL Server instance.
-
- - **db_owner** fixed database role on all databases that are to be updated.
-
+
+ - **securityadmin** fixed server role on the SQL Server instance.
+
+ - **db_owner** fixed database role on all databases that are to be updated.
+ - Administrators group on the server on which you are running the PowerShell cmdlets.
-
+ > [!NOTE]
- > For additional information about Microsoft PowerShell permissions, see [Permissions](/powershell/module/sharepoint-server/add-spshelladmin?view=sharepoint-ps&preserve-view=true).
-
+ > For additional information about Microsoft PowerShell permissions, see [Permissions](/powershell/module/sharepoint-server/add-spshelladmin?view=sharepoint-ps&preserve-view=true).
+ 2. Start the SharePoint Management Shell.
-
+ 3. At the PowerShell command prompt, type the following command:
-
+ ```powershell Set-SPSubscriptionSettingsServiceApplication -Identity "<ServiceApplicationName>" -DatabaseName "<DatabaseName>" -DatabaseServer "<DatabaseServer>" ``` Where:
-
- - _\<ServiceApplicationName\>_ is the name of the Subscription Settings service application.
-
- - _\<DatabaseName\>_ is the name of the renamed database.
-
- - _\<DatabaseServer\>_ is the name of the renamed database.
-
-
+
+ - _\<ServiceApplicationName\>_ is the name of the Subscription Settings service application.
+
+ - _\<DatabaseName\>_ is the name of the renamed database.
+
+ - _\<DatabaseServer\>_ is the name of the renamed database.
+ #### Step 6: To start the service application by using Central Administration 1. Use an account that is a member of the Farm Administrators SharePoint group.
-
+ 2. In Central Administration click **System Settings**.
-
+ 3. On the System Settings page, in the **Servers** section, click **Manage services on server**.
-
+ 4. Find the service application that you want and click **Start** in the **Action** column for the service, and then click **OK**.
-
+ ## Steps to move or rename the Business Data Connectivity Service and User Profile Service application databases <a name="BdcUps"> </a>
-When moving or renaming the Business Data Connectivity service application and User Profile service application databases requires extra steps. The extra steps required for both service application databases is that after you move or rename the databases we recommend that you delete the service application and then re-create it.
-
+When moving or renaming the Business Data Connectivity service application and User Profile service application databases requires extra steps. The extra steps required for both service application databases is that after you move or rename the databases we recommend that you delete the service application and then re-create it.
+ The following procedures show how to move or delete the Business Data Connectivity service application.
-
+ ### To stop the Business Data Connectivity service application 1. Use an account that is a member of the Farm Administrators SharePoint group.
-
+ 2. In Central Administration click **System Settings**.
-
+ 3. On the System Settings page, in the **Servers** section, click **Manage services on server**.
-
+ 4. Find the service application that you want to stop, click **Stop** or **Disable** in the **Action** column for the service, and then click **OK**.
-
+ ### To stop a service by using PowerShell 1. Start the SharePoint Management Shell.
-
+ 2. At the PowerShell command prompt, type the following command:
-
+ ```powershell Stop-SPServiceInstance -Identity <ServiceGUID> ```
- Where _\<ServiceGUID\>_ is the GUID of the service. If you don't know the service GUID, you can retrieve a list of all services in the farm together with their GUIDs by using the **Get-SPServiceInstance** cmdlet.
-
+ Where _\<ServiceGUID\>_ is the GUID of the service. If you don't know the service GUID, you can retrieve a list of all services in the farm together with their GUIDs by using the **Get-SPServiceInstance** cmdlet.
+ For more information, see [Stop-SPServiceInstance](/powershell/module/sharepoint-server/Stop-SPServiceInstance?view=sharepoint-ps&preserve-view=true) and [Get-SPServiceInstance](/powershell/module/sharepoint-server/Get-SPServiceInstance?view=sharepoint-ps&preserve-view=true).
-
+ ### Step 2: To detach a database from SQL Server
-1. Use an account that has the **db_owner** fixed database role for all of the databases that you're moving.
-
-2. In SQL Server Management Studio, connect to the source SQL Server instance, and then expand the **Databases** node.
-
+1. Use an account that has the **db_owner** fixed database role for all of the databases that you're moving.
+
+2. In SQL Server Management Studio, connect to the source SQL Server instance, and then expand the **Databases** node.
+ 3. Right-click the database, point to **Tasks**, and then click **Detach**. Repeat this step for each database that you want to move.
-
+ ### Step 3: To move the database files to a new location by using File Explorer or Windows Explorer 1. Use an account that has read permission on the source location and write permission on the target location.
-
+ 2. In File Explorer, find the .mdf, .ndf, and .ldf files for the service application databases and select the ones you want to move. The database files are typically found here, `C:\Program Files\Microsoft SQL Server\MSSQL12.MSSQLServer\MSSQL\Data`
-
+ 3. Either copy or move the database files to the new location.
-
+ ### Step 4: To attach a database to a new instance of SQL Server
-1. Use an account that has the **db_owner** fixed database role for all of the databases that you're moving.
-
+1. Use an account that has the **db_owner** fixed database role for all of the databases that you're moving.
+ 2. In SQL Server Management Studio, open the destination SQL Server instance.
-
+ 3. Right-click the **Databases** node, point to **Tasks**, and then click **Attach**.
-
+ 4. In the **Attach Database** dialog, browse to where you moved the .mdf, .ndf, and .ldf files, select the .mdf file for the database that you want to attach, and then click **OK**. Repeat this step for each database that you're moving.
-
+ ### Point the Business Data Connectivity service application to a moved database <a name="Point"> </a>
-The method for pointing a service application to a moved database that works for most service applications is to delete the service application and then re-create the service application. When you re-create the service application, use the new name or new location.
-
+The method for pointing a service application to a moved database that works for most service applications is to delete the service application and then re-create the service application. When you re-create the service application, use the new name or new location.
+ ### To document service application settings <a name="Point"> </a> Before you delete and re-create a service application, document the settings for the service application. To do this, use the recommended PowerShell cmdlets that are described in the article [Document farm configuration settings in SharePoint Server](document-farm-configuration-settings.md).
-
+ ### To delete the service application by using Central Administration <a name="Point"> </a> 1. Use an account that is a member of the Farm Administrators SharePoint group.
-
+ 2. In Central Administration, click **Application Management**, and then, click **Manage service applications**.
-
-3. On the **Service Applications** page, place your cursor next to Business Data Connectivity service and then click the empty row.
-
+
+3. On the **Service Applications** page, place your cursor next to Business Data Connectivity service and then click the empty row.
+ The ribbon becomes active.
-
+ 4. On the ribbon, click **Delete**.
-
-5. In the Delete Service Application dialog, select the check box next to **Delete data associated with the Service Applications** if you want to delete the service application database. If you want to retain the database, leave this check box cleared.
-
-6. Click **OK** to delete the service application, or click **Cancel** to stop the operation.
-
+
+5. In the Delete Service Application dialog, select the check box next to **Delete data associated with the Service Applications** if you want to delete the service application database. If you want to retain the database, leave this check box cleared.
+
+6. Click **OK** to delete the service application, or click **Cancel** to stop the operation.
+ ### To create the service application <a name="Point"> </a> To create a Business Data Connectivity service application, follow the procedure in [Configure a Business Data Connectivity service application in SharePoint Server](configure-a-business-data-connectivity-service-application.md).
-
+ ### To start the service application <a name="Point"> </a>
To create a Business Data Connectivity service application, follow the procedure
<a name="Search20132016"> </a> To move the Search service application databases, you must use SQL Server, SQL Server Management Studio, and Windows Explorer. To point to the moved databases, you must use PowerShell. Complete the following steps in the listed order.
-
+ **Important:**
-
+ The account, or accounts, that you use to do the operations must have these memberships and permissions:
-
+ - Member of the Farm Administrators SharePoint group.
-
+ - Member of the Administrators group on the local server.
-
+ - Read permission on the source location and write permission on the target location.
-
-- **db_owner** fixed database role for all of the databases that you are moving.
-
-- **db_creator** and **securityadmin** roles for all of the databases that you are moving.
-
+
+- **db_owner** fixed database role for all of the databases that you are moving.
+
+- **db_creator** and **securityadmin** roles for all of the databases that you are moving.
+ The Search Service account must have the following roles:
-
-- **db_owner** fixed database role on the Administration, Link, and Crawl databases.
-
-- **SPSearchDBAdmin** database role on the Analytics Reporting database.
-
+
+- **db_owner** fixed database role on the Administration, Link, and Crawl databases.
+
+- **SPSearchDBAdmin** database role on the Analytics Reporting database.
+ In some environments, you must coordinate the rename and move procedures with the database administrator. Be sure to follow applicable policies and guidelines for managing databases.
-
+ ### To pause the Search service application by using PowerShell 1. Start the SharePoint Management Shell.
-
+ 2. At the PowerShell command prompt, type the following command:
-
+ ```powershell $ssa = Get-SPEnterpriseSearchServiceApplication <SearchServiceApplicationName> Suspend-SPEnterpriseSearchServiceApplication -Identity $ssa ```
- Where _\<SearchServiceApplicationName\>_ is the name of the Search service application associated with the database move.
-
+ Where _\<SearchServiceApplicationName\>_ is the name of the Search service application associated with the database move.
+ ### <a name="ReadOnly"></a>To change the read-only mode for Search service application databases
-1. Use an account that is a member of the **db_owner** fixed database role for the content database.
-
+1. Use an account that is a member of the **db_owner** fixed database role for the content database.
+ 2. Open SQL Server Management Studio and connect to the database server.
-
+ 3. In Object Explorer, expand **Databases**.
-
+ 4. Set the following databases to read-only mode:
-
+ - Search Administration
-
+ - Analytics Reporting
-
+ - Crawl
-
+ - Link
-
+ - Right-click the database that you want to set to read/write or read-only, and then click **Properties**.
-
+ - In the **Database Properties** dialog, on the **Options** properties page, in the **State** section, select **True** or **False** in the list next to Database Read-Only, and then click **OK**.
-
+ - Click **Yes**.
-
+ ### To back up the Search service application databases
-1. Use an account that is a member of the SQL Server **db_backupoperator** fixed database role on the database server where each database is stored.
-
+1. Use an account that is a member of the SQL Server **db_backupoperator** fixed database role on the database server where each database is stored.
+ 2. Start SQL Server Management Studio and connect to the database server where the Search service application databases are stored.
-
+ 3. In Object Explorer, expand **Databases**.
-
+ 4. Right-click the database that you want to back up, point to **Tasks**, and then click **Back Up**.
-
-5. In the **Back Up Database** dialog, in the **Source** area, select the kind of backup that you want to perform from the **Backup type** list.
-
+
+5. In the **Back Up Database** dialog, in the **Source** area, select the kind of backup that you want to perform from the **Backup type** list.
+ For more information about the type of backup to use, see [Recovery Models (SQL Server)](/sql/relational-databases/backup-restore/recovery-models-sql-server?viewFallbackFrom=sql-server-2014).
-
+ 6. In the **Backup component** area, click **Database**.
-
-7. Either use the default name or specify a name for the backup set in the **Name** box.
-
+
+7. Either use the default name or specify a name for the backup set in the **Name** box.
+ 8. Specify the expiration date for the backup set.
-
+ This date determines when the backup set can be overwritten by subsequent backups that have the same name. By default, the backup set is set to never expire (0 days).
-
-9. In the **Destination** area, specify where you want to store the backup.
-
-10. Click **OK** to back up the database.
-
+
+9. In the **Destination** area, specify where you want to store the backup.
+
+10. Click **OK** to back up the database.
+ 11. Repeat steps 1-10 for the following databases:
-
+ - Search Administration
-
+ - Analytics Reporting
-
+ - Crawl
-
+ - Link
-
+ ### To set the value of max degree of parallelism to 1 in the new server that hosts SQL Server 1. Start SQL Server Management Studio and connect to the new server that hosts SQL Server where you'll move the Search service application databases.
-
+ 2. In **Object Explorer**, right-click the database server and then click **Properties**.
-
+ 3. Click **Advanced**.
-
-4. In the **Max Degree of Parallelism** box, select **1** to limit the number of processors to use in parallel plan execution.
-
+
+4. In the **Max Degree of Parallelism** box, select **1** to limit the number of processors to use in parallel plan execution.
+ For more information, see [Configure the max degree of parallelism Server Configuration Option](/sql/database-engine/configure-windows/configure-the-max-degree-of-parallelism-server-configuration-option?viewFallbackFrom=sql-server-2014).
-
+ ### To restore the Search service application databases to a new database server
-1. Use an account that is a member of the SQL Server **sysadmin** fixed server role on the database server where each database is stored.
-
+1. Use an account that is a member of the SQL Server **sysadmin** fixed server role on the database server where each database is stored.
+ 2. Start SQL Server Management Studio and connect to the database server.
-
+ 3. In **Object Explorer**, expand **Databases**.
-
-4. Right-click the database that you want to restore, point to **Tasks**, point to **Restore**, and then click **Database**.
-
-5. In the **Restore Database** dialog, on the **General** page, select the database to restore to from the **To database** list.
-
-6. Select the restore source from the **From database** list.
-
-7. In the **Select the backup sets to restore section** area, select the check box next to the database.
-
-8. On the **Options** tab, select the recovery state from the **Recover state** section.
-
+
+4. Right-click the database that you want to restore, point to **Tasks**, point to **Restore**, and then click **Database**.
+
+5. In the **Restore Database** dialog, on the **General** page, select the database to restore to from the **To database** list.
+
+6. Select the restore source from the **From database** list.
+
+7. In the **Select the backup sets to restore section** area, select the check box next to the database.
+
+8. On the **Options** tab, select the recovery state from the **Recover state** section.
+ For more information about which recovery type to use, see [Recovery Models (SQL Server)](/sql/relational-databases/backup-restore/recovery-models-sql-server?viewFallbackFrom=sql-server-2014) in SQL Server Books Online.
-
-9. Click **OK** to restore the database.
-
+
+9. Click **OK** to restore the database.
+ 10. Repeat steps 1-9 for each database that is associated with the service application.
-
+ ### To set the Search service application databases to read/write 1. Follow the steps in [To change the read-only mode for Search service application databases](#ReadOnly).
-
+ ### To point the Search service application to moved databases by using PowerShell 1. Start the SharePoint Management Shell.
-
+ 2. Point the Search Service Application database to the new location. At the PowerShell command prompt, type the following commands:
-
+ ```powershell $ssa = Get-SPEnterpriseSearchServiceApplication <SearchServiceApplicationName> $ssa | Set-SPEnterpriseSearchServiceApplication [-DatabaseName "<NewDbName>"] -DatabaseServer "<NewServerName>" ``` Where:
-
- - _\<NewDbName\>_ is the name of the database.
-
- - _\<NewServerName\>_ is the new database location.
-
+
+ - _\<NewDbName\>_ is the name of the database.
+
+ - _\<NewServerName\>_ is the new database location.
+ 3. Point the Analytics Reporting database to the new location. At the PowerShell command prompt, type the following commands:
- ```powershell
- Add-SPServerScaleOutDatabase -ServiceApplication $ssa -DatabaseServer <OriginalServerName> [-DatabaseName <NewDbName>]
- $temp = Get-SPServerScaleOutDatabase -ServiceApplication $ssa
- Remove-SPServerScaleOutDatabase -Database $temp[0] -ServiceApplication $ssa
- ```
-
- Where:
-
- - _\<OriginalServerName\>_ is the name of the original SQL server.
-
+ ```powershell
+ Add-SPServerScaleOutDatabase -ServiceApplication $ssa -DatabaseServer <OriginalServerName> [-DatabaseName <NewDbName>]
+ $temp = Get-SPServerScaleOutDatabase -ServiceApplication $ssa
+ Remove-SPServerScaleOutDatabase -Database $temp[0] -ServiceApplication $ssa
+ ```
+
+ Where:
+
+ - _\<OriginalServerName\>_ is the name of the original SQL server.
+ 4. Point the CrawlStore database to the new location. At the PowerShell command prompt, type the following commands:
-
+ ```powershell
- $CrawlDatabase0 = ([array]($ssa | Get-SPEnterpriseSearchCrawlDatabase))[0]
+ $CrawlDatabase0 = ([array]($ssa | Get-SPEnterpriseSearchCrawlDatabase))[0]
$CrawlDatabase0 | Set-SPEnterpriseSearchCrawlDatabase [-DatabaseName "<NewDbName>"] -DatabaseServer "<NewServerName>" ``` 5. Point the LinkStore database to the new location. At the PowerShell command prompt, type the following commands:
-
+ ```powershell
- $LinksDatabase0 = ([array]($ssa | Get-SPEnterpriseSearchLinksDatabase))[0]
+ $LinksDatabase0 = ([array]($ssa | Get-SPEnterpriseSearchLinksDatabase))[0]
$LinksDatabase0 | Set-SPEnterpriseSearchLinksDatabase [-DatabaseName "<NewDbName>"] -DatabaseServer "<NewServerName>" ``` 6. Set all Search service instances to Online. Run the following commands for each search service in the farm, until the Search service instance is reported as Online. At the PowerShell command prompt, type the following commands:
-
+ ```powershell Get-SPEnterpriseSearchServiceInstance -Identity <Search Server> Do {write-host -NoNewline .;Sleep 10; $searchInstance = Get-SPEnterpriseSearchServiceInstance -Identity <Search Server>} while ($searchInstance.Status -ne "Online") ```
- Where _\<Search Server\>_ is the name of the server that hosts the search components.
-
+ Where _\<Search Server\>_ is the name of the server that hosts the search components.
+ 7. Resume the Search service application. At the PowerShell command prompt, type the following commands:
-
+ ```powershell $ssa = Get-SPEnterpriseSearchServiceApplication <SearchServiceApplicationName> Resume-SPEnterpriseSearchServiceApplication -Identity $ssa ```
- Where _\<SearchServiceApplicationName\>_ is the name of the Search service application associated with the database move.
-
+ Where _\<SearchServiceApplicationName\>_ is the name of the Search service application associated with the database move.
+ 8. Restart each server that hosts a search component. ## Steps to move or rename the Search Service application databases in SharePoint Server 2019
In some environments, you must coordinate the rename and move procedures with th
To move the Search service application databases, you must use SQL Server, SQL Server Management Studio, and Windows Explorer. To point to the moved databases, you must use PowerShell. Complete the following steps in the listed order. **Important:**
-
+ The account, or accounts, that you use to do the operations must have these memberships and permissions:
-
+ - Member of the Farm Administrators SharePoint group.
-
+ - Member of the Administrators group on the local server.
-
+ - Read permission on the source location and write permission on the target location.
-
-- **db_owner** fixed database role for all of the databases that you are moving.
-
-- **db_creator** and **securityadmin** roles for all of the databases that you are moving.
-
+
+- **db_owner** fixed database role for all of the databases that you are moving.
+
+- **db_creator** and **securityadmin** roles for all of the databases that you are moving.
+ The Search Service account must have the following roles:
-
-- **db_owner** fixed database role on the Administration, Link, and Crawl databases.
-
-- **SPSearchDBAdmin** database role on the Analytics Reporting database.
-
+
+- **db_owner** fixed database role on the Administration, Link, and Crawl databases.
+
+- **SPSearchDBAdmin** database role on the Analytics Reporting database.
+ In some environments, you must coordinate the rename and move procedures with the database administrator. Be sure to follow applicable policies and guidelines for managing databases.
-
+ ### To pause the Search service application by using PowerShell 1. Start the SharePoint Management Shell.
-
+ 2. At the PowerShell command prompt, type the following command:
-
+ ```powershell $ssa = Get-SPEnterpriseSearchServiceApplication <SearchServiceApplicationName> Suspend-SPEnterpriseSearchServiceApplication -Identity $ssa ```
- Where _\<SearchServiceApplicationName\>_ is the name of the Search service application associated with the database move.
-
+ Where _\<SearchServiceApplicationName\>_ is the name of the Search service application associated with the database move.
+ ### <a name="ReadOnly"></a>To change the read-only mode for Search service application databases
-1. Use an account that is a member of the **db_owner** fixed database role for the content database.
-
+1. Use an account that is a member of the **db_owner** fixed database role for the content database.
+ 2. Open SQL Server Management Studio and connect to the database server.
-
+ 3. In Object Explorer, expand **Databases**.
-
+ 4. Set the following databases to read-only mode:
-
+ - Search Administration
-
+ - Analytics Reporting
-
+ - Crawl
-
+ - Link
-
+ - Right-click the database that you want to set to read/write or read-only, and then click **Properties**.
-
+ - In the **Database Properties** dialog, on the **Options** properties page, in the **State** section, select **True** or **False** in the list next to Database Read-Only, and then click **OK**.
-
+ - Click **Yes**.
-
+ ### To back up the Search service application databases
-1. Use an account that is a member of the SQL Server **db_backupoperator** fixed database role on the database server where each database is stored.
-
+1. Use an account that is a member of the SQL Server **db_backupoperator** fixed database role on the database server where each database is stored.
+ 2. Start SQL Server Management Studio and connect to the database server where the Search service application databases are stored.
-
+ 3. In Object Explorer, expand **Databases**.
-
+ 4. Right-click the database that you want to back up, point to **Tasks**, and then click **Back Up**.
-
-5. In the **Back Up Database** dialog, in the **Source** area, select the kind of backup that you want to perform from the **Backup type** list.
-
+
+5. In the **Back Up Database** dialog, in the **Source** area, select the kind of backup that you want to perform from the **Backup type** list.
+ For more information about the type of backup to use, see [Recovery Models (SQL Server)](/sql/relational-databases/backup-restore/recovery-models-sql-server?viewFallbackFrom=sql-server-2014).
-
+ 6. In the **Backup component** area, click **Database**.
-
-7. Either use the default name or specify a name for the backup set in the **Name** box.
-
+
+7. Either use the default name or specify a name for the backup set in the **Name** box.
+ 8. Specify the expiration date for the backup set.
-
+ This date determines when the backup set can be overwritten by subsequent backups that have the same name. By default, the backup set is set to never expire (0 days).
-
-9. In the **Destination** area, specify where you want to store the backup.
-
-10. Click **OK** to back up the database.
-
+
+9. In the **Destination** area, specify where you want to store the backup.
+
+10. Click **OK** to back up the database.
+ 11. Repeat steps 1-10 for the following databases:
-
+ - Search Administration
-
+ - Analytics Reporting
-
+ - Crawl
-
+ - Link
-
+ ### To set the value of max degree of parallelism to 1 in the new server that hosts SQL Server 1. Start SQL Server Management Studio and connect to the new server that hosts SQL Server where you'll move the Search service application databases.
-
+ 2. In **Object Explorer**, right-click the database server and then click **Properties**.
-
+ 3. Click **Advanced**.
-
-4. In the **Max Degree of Parallelism** box, select **1** to limit the number of processors to use in parallel plan execution.
-
+
+4. In the **Max Degree of Parallelism** box, select **1** to limit the number of processors to use in parallel plan execution.
+ For more information, see [Configure the max degree of parallelism Server Configuration Option](/sql/database-engine/configure-windows/configure-the-max-degree-of-parallelism-server-configuration-option?viewFallbackFrom=sql-server-2014).
-
+ ### To restore the Search service application databases to a new database server
-1. Use an account that is a member of the SQL Server **sysadmin** fixed server role on the database server where each database is stored.
-
+1. Use an account that is a member of the SQL Server **sysadmin** fixed server role on the database server where each database is stored.
+ 2. Start SQL Server Management Studio and connect to the database server.
-
+ 3. In **Object Explorer**, expand **Databases**.
-
-4. Right-click the database that you want to restore, point to **Tasks**, point to **Restore**, and then click **Database**.
-
-5. In the **Restore Database** dialog, on the **General** page, select the database to restore to from the **To database** list.
-
-6. Select the restore source from the **From database** list.
-
-7. In the **Select the backup sets to restore section** area, select the check box next to the database.
-
-8. On the **Options** tab, select the recovery state from the **Recover state** section.
-
+
+4. Right-click the database that you want to restore, point to **Tasks**, point to **Restore**, and then click **Database**.
+
+5. In the **Restore Database** dialog, on the **General** page, select the database to restore to from the **To database** list.
+
+6. Select the restore source from the **From database** list.
+
+7. In the **Select the backup sets to restore section** area, select the check box next to the database.
+
+8. On the **Options** tab, select the recovery state from the **Recover state** section.
+ For more information about which recovery type to use, see [Recovery Models (SQL Server)](/sql/relational-databases/backup-restore/recovery-models-sql-server?viewFallbackFrom=sql-server-2014) in SQL Server Books Online.
-
-9. Click **OK** to restore the database.
-
+
+9. Click **OK** to restore the database.
+ 10. Repeat steps 1-9 for each database that is associated with the service application.
-
+ ### To set the Search service application databases to read/write 1. Follow the steps in [To change the read-only mode for Search service application databases](#ReadOnly).
-
+ ### To point the Search service application to moved databases by using PowerShell 1. Start the SharePoint Management Shell.
-> [!NOTE]
-> These instructions assume you will use the same PowerShell session for all commands.
+ > [!NOTE]
+ > These instructions assume you will use the same PowerShell session for all commands.
2. At the PowerShell command prompt, type the following command to associate the Search Administration database with the Search service.
-
+ ```powershell $ssa = Get-SPEnterpriseSearchServiceApplication <SearchServiceApplication> $ssa | Set-SPEnterpriseSearchServiceApplication -DatabaseName <SearchAdministrationServiceDatabase> -DatabaseServer <SearchServiceDatabaseServer>
In some environments, you must coordinate the rename and move procedures with th
Where:
- - _\<SearchServiceApplication\>_ is the name of the Search service application associated with the database.
+ - _\<SearchServiceApplication\>_ is the name of the Search service application associated with the database.
- - _\<SearchAdministrationServiceDatabase\>_ is the name of the Search service application Administration database.
+ - _\<SearchAdministrationServiceDatabase\>_ is the name of the Search service application Administration database.
- - _\<SearchServiceDatabaseServer\>_ is the name of the new databse server hosting the Search service application databases.
+ - _\<SearchServiceDatabaseServer\>_ is the name of the new databse server hosting the Search service application databases.
3. At the PowerShell command prompt, type the following command to associate the Search Analytics database with the Search service.
In some environments, you must coordinate the rename and move procedures with th
Where:
- - _\<SearchServiceAnalyticsDatabase\>_ is the name of the Search service application Analytics database.
+ - _\<SearchServiceAnalyticsDatabase\>_ is the name of the Search service application Analytics database.
- - _\<SearchServiceDatabaseServer\>_ is the name of the new databse server hosting the Search service application databases.
+ - _\<SearchServiceDatabaseServer\>_ is the name of the new databse server hosting the Search service application databases.
4. At the PowerShell command prompt, type the following command to associate the Search Crawl database with the Search service.
In some environments, you must coordinate the rename and move procedures with th
Where:
- - _\<SearchServiceCrawlDatabase\>_ is the name of the Search service application Crawl database.
+ - _\<SearchServiceCrawlDatabase\>_ is the name of the Search service application Crawl database.
- - _\<SearchServiceDatabaseServer\>_ is the name of the new databse server hosting the Search service application databases.
+ - _\<SearchServiceDatabaseServer\>_ is the name of the new databse server hosting the Search service application databases.
- - _\<OldCrawlStoreDatabase\>_ is the name of the old Search service application Crawl database.
+ - _\<OldCrawlStoreDatabase\>_ is the name of the old Search service application Crawl database.
5. At the PowerShell command prompt, type the following command to associate the Search Links database with the Search service. ```powershell
- New-SPEnterpriseSearchLinksDatabase -DatabaseName <SearchServiceLinksDatabase> ΓÇôSearchApplication $ssa -DatabaseServer <SearchServiceDatabaseServer>
+ New-SPEnterpriseSearchLinksDatabase -DatabaseName <SearchServiceLinksDatabase> -SearchApplication $ssa -DatabaseServer <SearchServiceDatabaseServer>
$oldLinksStoreDB = ([array]($ssa | Get-SPEnterpriseSearchLinksDatabase))[0] $newLinksStoreDB = ([array]($ssa | Get-SPEnterpriseSearchLinksDatabase))[1] Move-SPEnterpriseSearchLinksDatabases -SearchApplication $ssa -TargetStores @($newLinksStoreDB) -Confirm:$false
In some environments, you must coordinate the rename and move procedures with th
Where:
- - _\<SearchServiceLinksDatabase\>_ is the name of the Search service application Links database.
+ - _\<SearchServiceLinksDatabase\>_ is the name of the Search service application Links database.
- - _\<SearchServiceDatabaseServer\>_ is the name of the new databse server hosting the Search service application databases.
+ - _\<SearchServiceDatabaseServer\>_ is the name of the new database server hosting the Search service application databases.
6. At the PowerShell command prompt, type the following command to resume the Search Service application.
In some environments, you must coordinate the rename and move procedures with th
```powershell Remove-SPEnterpriseSearchLinksDatabase -Identity $oldLinksStoreDB -SearchApplication $ssa -Confirm:$false ```+ Where: - `$oldLinksStoreDB` is the variable from step 5.
In some environments, you must coordinate the rename and move procedures with th
#### Concepts
-[Move all databases in SharePoint Server](move-all-databases.md)
+[Move all databases in SharePoint Server](move-all-databases.md)
SharePoint Outgoing Email Planning https://github.com/MicrosoftDocs/OfficeDocs-SharePoint/commits/public/SharePoint/SharePointServer/administration/outgoing-email-planning.md
Set **Use TLS connection encryption** to Yes to require SharePoint to establish
> [!NOTE] > This Use client certificate authentication with an SMTP server feature is available only in SharePoint Server Subscription Edition.
-Client certificate authentication over SMTP is an optional, advanced authentication configuration that allows the ΓÇ£clientΓÇ¥ (in this scenario, SharePoint) to authenticate to the SMTP server using an X.509 certificate that the client presents to the server. This authentication is either ΓÇ£instead ofΓÇ¥ or ΓÇ£in addition toΓÇ¥ the username/password credentials. This configuration isnΓÇÖt common, but it can be used in high security environments where standard username/password authentication isnΓÇÖt considered sufficient.
+Client certificate authentication over SMTP is an optional, advanced authentication configuration that allows the "client" (in this scenario, SharePoint) to authenticate to the SMTP server using an X.509 certificate that the client presents to the server. This authentication is either "instead of" or "in addition to" the username/password credentials. This configuration isn't common, but it can be used in high security environments where standard username/password authentication isn't considered sufficient.
> [!NOTE]
-> You donΓÇÖt have to use client certificate authentication to use TLS connection encryption to the SMTP server.
+> You don't have to use client certificate authentication to use TLS connection encryption to the SMTP server.
Following are the requirements for SharePoint to use client certificate authentication with an SMTP server:
-1. The SMTP server must be configured to support STARTTLS for TLS connection encryption.
-2. The SMTP server must be configured to either accept or require client certificates when establishing TLS connections using STARTTLS.
-3. SharePoint must be configured to use TLS connection encryption to the SMTP server.
-4. SharePoint must be configured to use a client certificate when connecting to the SMTP server.
-5. SharePoint process accounts that send emails (which may include the SharePoint farm service account and the web application service account) must have permission to read the private key of the X.509 certificate.
-6. The X.509 certificate must meet the following requirements:
- - The X.509 certificate must be in the ΓÇ£End EntityΓÇ¥ certificate store in SharePoint.
+1. The SMTP server must be configured to support STARTTLS for TLS connection encryption.
+2. The SMTP server must be configured to either accept or require client certificates when establishing TLS connections using STARTTLS.
+3. SharePoint must be configured to use TLS connection encryption to the SMTP server.
+4. SharePoint must be configured to use a client certificate when connecting to the SMTP server.
+5. SharePoint process accounts that send emails (which may include the SharePoint farm service account and the web application service account) must have permission to read the private key of the X.509 certificate.
+6. The X.509 certificate must meet the following requirements:
+ - The X.509 certificate must be in the "End Entity" certificate store in SharePoint.
- The X.509 certificate must use RSA or ECC (ECDSA) keys. DSA keys are not supported. - The X.509 certificate must have a private key. - If the X.509 certificate has a Key Usage extension, the extension must contain the "Digital Signature" usage.
You can configure each SharePoint web application to disable email impersonation
Microsoft Exchange Server receive connectors can be configured to automatically trust all emails as authenticated, even if no authentication is performed. SharePoint will then send emails to this receive connector anonymously. Follow these steps to create an externally secured receive connector:
-1. Create a dedicated "Custom" receive connector for the SharePoint farm.
-2. Set the receive connector's permission group to "Exchange Servers".
-3. Set the receive connector's authentication type to "externally secured".
+1. Create a dedicated "Custom" receive connector for the SharePoint farm.
+2. Set the receive connector's permission group to "Exchange Servers".
+3. Set the receive connector's authentication type to "externally secured".
Due to the risk of spoofing in this configuration, it's recommended to restrict the IP addresses this receive connector will accept email messages from to just the servers in your SharePoint farm.
SharePoint Overview Of Profile Synchronization In Sharepoint Server 2013 https://github.com/MicrosoftDocs/OfficeDocs-SharePoint/commits/public/SharePoint/SharePointServer/administration/overview-of-profile-synchronization-in-sharepoint-server-2013.md
You can also import data directly from Active Directory Domain Services (AD DS).
[Administer the User Profile service in SharePoint Server](user-profile-service-administration.md)
-[Overview of Business Connectivity Services in SharePoint Server](business-connectivity-services-overview.md) 
+[Overview of Business Connectivity Services in SharePoint Server](business-connectivity-services-overview.md)
[Configure a managed domain to support profile synchronization for SharePoint Server](/azure/active-directory-domain-services/active-directory-ds-enable-sharepoint-profile-sync)
SharePoint Plan A Business Connectivity Services Solution https://github.com/MicrosoftDocs/OfficeDocs-SharePoint/commits/public/SharePoint/SharePointServer/administration/plan-a-business-connectivity-services-solution.md
Title: "Plan a Business Connectivity Services solution in SharePoint Server"-+
description: "Create a plan for your Microsoft Business Connectivity Services so
# Plan a Business Connectivity Services solution in SharePoint Server [!INCLUDE[appliesto-2013-2016-2019-SUB-xxx-md](../includes/appliesto-2013-2016-2019-SUB-xxx-md.md)]
-
+ Microsoft Business Connectivity Services solutions integrate external data deeply into SharePoint Server and Office. Each Business Connectivity Services solution is custom-built using Visual Studio. There are no out-of-the-box Business Connectivity Services configurations or templates that you can use.
-
+ This article takes you through five questions that you must answer before you can design your Business Connectivity Services solution. Be sure to collect all this information and communicate it to all the key stakeholders to review and approve. When you do this, you will help ensure that everyone involved has the same understanding of the needs of the project and how the solution will work.
-
-
+ ## Where is the data? <a name="section1"> </a> Your first step in planning your Business Connectivity Services solution is to understand where the external data that you want is. You need to understand this from three perspectives.
-
-You will need to know who has daily administrative responsibility over the external data source. This is the group that you will need to work with to help set up connectivity to the external data. They will be able to tell you how the data is made available for external consumption, how it is secured, and so on. You might need them to create credentials in the external system for you to use. Be prepared to answer their questions on the impact of your Business Connectivity Services solution on their data and their external system.
-
+
+You will need to know who has daily administrative responsibility over the external data source. This is the group that you will need to work with to help set up connectivity to the external data. They will be able to tell you how the data is made available for external consumption, how it is secured, and so on. You might need them to create credentials in the external system for you to use. Be prepared to answer their questions on the impact of your Business Connectivity Services solution on their data and their external system.
+ ### Network considerations You also need to consider where the external data source is in relation to the network that Business Connectivity Services and your users will be on. To help you figure this out, draw a diagram of the three components on your network and see where they lie. For example, you can see whether they are all on your internal network and inside your firewall. Or, you could see that the Business Connectivity Services infrastructure and the external data source are separated by a firewall or boundary network and that they are on completely separate networks. Here are some basic rules that you can use to guide your design:
-
+ - If the external data source is outside of your network, such as on the Internet, Business Connectivity Services will need to communicate with the external data source through your corporate firewall and you need to plan for that traffic.
-
+ - Look at where the users will be accessing the Business Connectivity Services solution from. Be sure to consider if the data communications between the client and the Business Connectivity Services solution need to be encrypted and whether the underlying network infrastructure can support the added load. Also, make sure that the browsers and Office clients support the functionality that the solution provides.
-
+ ## How is the data surfaced? <a name="section2"> </a> Business Connectivity Services solutions can connect to an external data source through OData, SQL Server, Windows Communication Foundation (WCF) service, and .NET Assemblies. You need to know (and you can find this out from the external system administrators) how the data is surfaced for external consumption. How the external data is surfaced determines what development tools you will use to create the external content type. The following table shows you which tools to use based on the external data source.
-
+ ## How is the data secured? <a name="section3"> </a> Business Connectivity Services handles all authentications for communications between itself and the external system. Basically, Business Connectivity Services presents the external system with information that allows the external system to authenticate (determine whether you are who you say you are) the request and then authorize access to data in the external system. Business Connectivity Services supports many types of authentication.
-
+ For your Business Connectivity Services solution design, you have to know what authentication mechanism the external system requires. This way, you will know how to configure Business Connectivity Services so that it presents the authentication information in the manner that the external system requires. Business Connectivity Services supports three authentication models:
-
-- **Credentials-based authentication** In credentials-based authentication models, credentials are passed from Business Connectivity Services to the external system. Credentials are a combination of a user name and some form of password. Business Connectivity Services has a number of ways of doing this, including passing the credentials of the user who is logged on, passing the credentials of the service that is making the request, or mapping the credentials of the user who is logged on to a different set of credentials that the external system recognizes.
-
-- **Claims-based authentication** In some authentication scenarios, the external system will not accept credentials directly from Business Connectivity Services. However, the external system will accept them from a third-party authentication service that it trusts. The third-party authentication service (a security token provider) accepts a grouping of information (known as assertions) about the requestor. The whole grouping is known as a claim, and a claim can contain more info about the requestor than just the user name and password. For example, a claim can contain metadata about the requestor, such as the requestor's email address or the security groups to which the requestor belongs. The third-party authentication service performs the authentication of the requestor based on the assertions in the claim and creates a security token for the requestor to use. The requestor (Business Connectivity Services) then presents the security token to the external system, and the external system looks to see what data the requestor has been authorized to access.
-
-- **Custom authentication** If the external system that you are working with does not support credentials-based or claims-based authentication, then you will have to develop, test, and implement a custom solution that takes the credentials that Business Connectivity Services can produce and translates them into a format that the external system will accept. You can implement a custom authentication solution for OData data sources that are secured either by OAuth or a custom ASP.NET HTTP module and are on premises.
-
+
+- **Credentials-based authentication** In credentials-based authentication models, credentials are passed from Business Connectivity Services to the external system. Credentials are a combination of a user name and some form of password. Business Connectivity Services has a number of ways of doing this, including passing the credentials of the user who is logged on, passing the credentials of the service that is making the request, or mapping the credentials of the user who is logged on to a different set of credentials that the external system recognizes.
+
+- **Claims-based authentication** In some authentication scenarios, the external system will not accept credentials directly from Business Connectivity Services. However, the external system will accept them from a third-party authentication service that it trusts. The third-party authentication service (a security token provider) accepts a grouping of information (known as assertions) about the requestor. The whole grouping is known as a claim, and a claim can contain more info about the requestor than just the user name and password. For example, a claim can contain metadata about the requestor, such as the requestor's email address or the security groups to which the requestor belongs. The third-party authentication service performs the authentication of the requestor based on the assertions in the claim and creates a security token for the requestor to use. The requestor (Business Connectivity Services) then presents the security token to the external system, and the external system looks to see what data the requestor has been authorized to access.
+
+- **Custom authentication** If the external system that you are working with does not support credentials-based or claims-based authentication, then you will have to develop, test, and implement a custom solution that takes the credentials that Business Connectivity Services can produce and translates them into a format that the external system will accept. You can implement a custom authentication solution for OData data sources that are secured either by OAuth or a custom ASP.NET HTTP module and are on premises.
+ ## How will the data be consumed? <a name="section4"> </a>
-As part of your requirement gathering, you need to find out from your business stakeholders what they need the solution to do and how they need users to interact with it. They might need the users to interact with the data in SharePoint Server, via external lists, and external web parts and Office apps. Or, they might need the solution to surface data through Office apps and SharePoint applications. For more info about apps for Office and SharePoint, see [(OLD) Overview of apps for SharePoint 2016](./plan-for-apps-for-sharepoint.md). Or, the solution might require some other combination of browser, client, and application access to the external data.
-
+As part of your requirement gathering, you need to find out from your business stakeholders what they need the solution to do and how they need users to interact with it. They might need the users to interact with the data in SharePoint Server, via external lists, and external web parts and Office apps. Or, they might need the solution to surface data through Office apps and SharePoint applications. For more info about apps for Office and SharePoint, see [(OLD) Overview of apps for SharePoint 2016](./plan-for-apps-for-sharepoint.md). Or, the solution might require some other combination of browser, client, and application access to the external data.
+ How users access the data affects how you will scope the external content type that Business Connectivity Services uses to access the external data. If your Business Connectivity Services solution requires an apps for Office and SharePoint application, then the external content type must be scoped to that application. If your Business Connectivity Services solution will not use apps for Office and SharePoint to access external data, then the external content type must be scoped to the Business Data Connectivity service application.
-
- **Business Connectivity Services-scoped external content types** are stored centrally in the BDC Metadata Store and a farm administrator manages security on them. You can share these external content types with multiple Business Connectivity Services web applications.
-
- **The apps for Office and SharePoint-scoped external content types** are stored as an XML file in the app for Office and SharePoint application itself. They cannot be used by any other apps for Office and SharePoint applications.
-
- **Connection settings objects** can only be used with OData data sources. They contain connection information, such as a service address for the service that surfaces the external data, the type of authentication to use, the Internet-facing URL, and the names of any required certificates. Connection settings objects are separate objects from an external content type. When a Business Connectivity Services solution needs to connect to an external system, it uses the information in a connection settings object. You would typically choose to define the connection information separately from the external content type when the external content type developer doesn't know, or doesn't have access to, the necessary connection information when the external content type is developed. Both app-scoped external content types and service-scoped external content types can use connection settings objects. Connection settings objects can be used by multiple Business Connectivity Services solutions. Each solution must be granted permissions to use a connection settings object.
-
+
+ **Business Connectivity Services-scoped external content types** are stored centrally in the BDC Metadata Store and a farm administrator manages security on them. You can share these external content types with multiple Business Connectivity Services web applications.
+
+ **The apps for Office and SharePoint-scoped external content types** are stored as an XML file in the app for Office and SharePoint application itself. They cannot be used by any other apps for Office and SharePoint applications.
+
+ **Connection settings objects** can only be used with OData data sources. They contain connection information, such as a service address for the service that surfaces the external data, the type of authentication to use, the Internet-facing URL, and the names of any required certificates. Connection settings objects are separate objects from an external content type. When a Business Connectivity Services solution needs to connect to an external system, it uses the information in a connection settings object. You would typically choose to define the connection information separately from the external content type when the external content type developer doesn't know, or doesn't have access to, the necessary connection information when the external content type is developed. Both app-scoped external content types and service-scoped external content types can use connection settings objects. Connection settings objects can be used by multiple Business Connectivity Services solutions. Each solution must be granted permissions to use a connection settings object.
+ ## How will you assign permissions to the solution? <a name="section5"> </a> In every Business Connectivity Services solution, you must plan who will have which permissions on which objects. This is how you both restrict and grant access to the solution to the appropriate users in the appropriate way. You will have to work with the external system administrator and the SharePoint Server farm administrators, site collection administrators, and site administrators to configure permissions. At the most fundamental level however, here is what you must consider during your planning.
-
+ There are three fundamental roles that are involved with every Business Connectivity Services solution:
-
-- **Administrative roles** These roles are responsible for managing permissions on the external system, creating and managing the Business Data Connectivity service application, importing Business Data Connectivity (BDC) models into the BDC Metadata Store, and managing permissions on the BDC Metadata Store and all the objects in it. If apps for SharePoint are using Business Connectivity Services, then the SharePoint Server farm administrators will also be involved with publishing the application and creating and managing connection objects. Generally, these duties are performed by people who are SharePoint Server farm administrators, people who are administrators of the external system, and anyone who has delegated administrative rights.
-
-- **Developer or designer roles** These roles are responsible for creating the external content types, the BDC models, and the apps for SharePoint that use Business Connectivity Services. They are the ones who are primarily responsible for understanding all the business needs for the solution.
-
-- **User roles** People in these roles consume and manipulate the external data in the Business Connectivity Services solution. There can be multiple user roles in your solution, each with different levels of permissions. For example, in a support-ticketing system scenario that uses Business Connectivity Services to integrate external information into the solution, the Tier I Help Desk technicians might be granted only the ability to read and start workflows on a ticket, while Tier II and Tier III technicians have the ability to update tickets.
-
+
+- **Administrative roles** These roles are responsible for managing permissions on the external system, creating and managing the Business Data Connectivity service application, importing Business Data Connectivity (BDC) models into the BDC Metadata Store, and managing permissions on the BDC Metadata Store and all the objects in it. If apps for SharePoint are using Business Connectivity Services, then the SharePoint Server farm administrators will also be involved with publishing the application and creating and managing connection objects. Generally, these duties are performed by people who are SharePoint Server farm administrators, people who are administrators of the external system, and anyone who has delegated administrative rights.
+
+- **Developer or designer roles** These roles are responsible for creating the external content types, the BDC models, and the apps for SharePoint that use Business Connectivity Services. They are the ones who are primarily responsible for understanding all the business needs for the solution.
+
+- **User roles** People in these roles consume and manipulate the external data in the Business Connectivity Services solution. There can be multiple user roles in your solution, each with different levels of permissions. For example, in a support-ticketing system scenario that uses Business Connectivity Services to integrate external information into the solution, the Tier I Help Desk technicians might be granted only the ability to read and start workflows on a ticket, while Tier II and Tier III technicians have the ability to update tickets.
+ There are also four main aspects to every Business Connectivity Services solution for which you will manage permissions:
-
+ - **External system** Every external system will have a method for performing authentication and authorization. (For more information, see [How is the data secured?](plan-a-business-connectivity-services-solution.md#section3) earlier in this article.) You need to work with the external system administrator to identify how to grant access to the solution users according to the principle of least privileges. In general, you will map a group of users from the Business Connectivity Services side to a single account on the external system side and use the single external system account to restrict access. Another way is to do a 1:1 mapping between individual accounts on each system. In either case, unless the external system can directly accept the credentials with which the user authenticates to SharePoint Server, you will need to use the [Secure Store Service](/previous-versions/office/sharepoint-server-2010/ee806889(v=office.14)). For more in-depth information about the authentication models that Business Connectivity Services supports, see [Business Connectivity Services security overview (SharePoint 2010)](/previous-versions/office/sharepoint-server-2010/ee661743(v=office.14)).
-
-- **Business Connectivity Services central infrastructure** In Central Administration, you manage the assignment of permissions to the BDC Metadata Store. In the BDC Metadata Store, you manage BDC models, external systems, and external content types. You must assign execute permissions on an external content type to all users who will be using the Business Connectivity Services solution. The following tables provide a detailed mapping of abilities, permissions, and objects.
-
- **The BDC Metadata Store** This SQL Server database that stores the model definitions, external content types, and external system definitions.
-
+
+- **Business Connectivity Services central infrastructure** In Central Administration, you manage the assignment of permissions to the BDC Metadata Store. In the BDC Metadata Store, you manage BDC models, external systems, and external content types. You must assign execute permissions on an external content type to all users who will be using the Business Connectivity Services solution. The following tables provide a detailed mapping of abilities, permissions, and objects.
+
+ **The BDC Metadata Store** This SQL Server database that stores the model definitions, external content types, and external system definitions.
+ **Table: Mapping permissions on the BDC Metadata Store**
-|**To allow a user or group to…**|**Give them the following permissions…**|**On…**|
-|:--|:--|:--|
-|Set permissions on any object contained in the BDC Metadata Store via propagation <br/> |SetPermissions <br/> |The BDC Metadata Store <br/> |
-
-**The model** A model is a XML file that contains sets of descriptions of one or more external content types, the related external systems, and information that is specific to the environment, such as authentication properties.
-
- **Table: Mapping permissions on the model**
-
-|**To allow a user or group to…**|**Give them the following permissions…**|**On…**|
-|:--|:--|:--|
-|Create new models <br/> |Edit <br/> |The BDC Metadata Store <br/> |
-|Edit a model <br/> |Edit <br/> |The model <br/> |
-|Set permissions on a model <br/> |SetPermissions <br/> |The model <br/> |
-|Import a model <br/> |Edit <br/> |The BDC Metadata Store <br/> |
-|Export a model <br/> |Edit <br/> |The model and all external systems in the model <br/> |
-
-**The external system in the BDC Metadata Store** An external system is the metadata definition of a supported source of data that can be modeled, such as a database, web service, or .NET connectivity assembly.
-
- **Table: Mapping permissions on the external system in the BDC Metadata Store**
-
-|**To allow a user or group to…**|**Give them the following permissions…**|**On…**|
-|:--|:--|:--|
-|Create new external systems <br/> |Edit <br/> |The BDC Metadata Store <br/> |
-|Edit an external system <br/> |Edit <br/> |The external system object <br/> |
-|Set permissions on the external system <br/> |SetPermissions <br/> |The external system object <br/> |
-
-**External content type** An external content type is a reusable collection of metadata that defines a set of data from one or more external systems, the operations available on that data, and connectivity information related to that data.
-
- **Table: Mapping permissions on the external content type**
-
-|**To allow a user or group to …**|**Give them the following permissions …**|**On …**|
-|:--|:--|:--|
-|Create new external content types <br/> |Edit <br/> |The external system <br/> |
-|Execute operations on an external content type <br/> |Execute <br/> |The external content type (method instances of the operation) <br/> |
-|Create lists of the external content type <br/> |Selectable in clients <br/> |The external content type <br/> |
-|Set permissions on the external content type <br/> |SetPermissions <br/> |The external content type <br/> |
-
-**The method** A Business Data Connectivity method is an XML definition of how Business Connectivity Services can interact with an external data source.
-
- **Table: Mapping permissions on the method**
-
-|**To allow a user or group to …**|**Give them the following permissions …**|**On …**|
-|:--|:--|:--|
-|Edit a method <br/> |Edit <br/> |The method <br/> |
-|Set permissions on a method <br/> |SetPermissions <br/> |The method <br/> |
-
-**The method instance** A method instance describes, for a particular method, how to use a method by using a specific set of default values.
-
- **Table: Mapping permissions on the method instance**
-
-|**To allow a user or group to…**|**Give them the following permissions…**|**On…**|
-|:--|:--|:--|
-|Edit a method instance <br/> |Edit <br/> |The method instance <br/> |
-|Execute a method instance <br/> |Execute <br/> |The method instance <br/> |
-|Set permissions on a method instance <br/> |SetPermissions <br/> |The method instance <br/> |
-
-- **The development environment** When you are developing a Business Connectivity Services solution, including the external content type, and any apps for SharePoint and connection settings objects, it is a best practice to use a development environment that is separate from your production environment. In the development environment, you can grant higher levels of permissions to the developers than you would usually do in your production environment.
-
-- **The user environment** All external data will be accessed through external lists, external data columns, Business Data Web Parts, apps for SharePoint, or Office. For apps for SharePoint, you can choose to let the app for Office and SharePoint enforce permissions. In this case, if the users can access the app for Office and SharePoint, then they can access all the external data that is surfaced in the app for Office and SharePoint. You will have to work with site and site collection administrators to plan and implement permissions to the external data in your solution.
-
+|To allow a user or group to...|Give them the following permissions...|On...|
+||||
+|Set permissions on any object contained in the BDC Metadata Store via propagation|SetPermissions|The BDC Metadata Store|
+
+**The model** A model is a XML file that contains sets of descriptions of one or more external content types, the related external systems, and information that is specific to the environment, such as authentication properties.
+
+**Table: Mapping permissions on the model**
+
+|To allow a user or group to...|Give them the following permissions...|On...|
+||||
+|Create new models|Edit|The BDC Metadata Store|
+|Edit a model|Edit|The model|
+|Set permissions on a model|SetPermissions|The model|
+|Import a model|Edit|The BDC Metadata Store|
+|Export a model|Edit|The model and all external systems in the model|
+
+**The external system in the BDC Metadata Store** An external system is the metadata definition of a supported source of data that can be modeled, such as a database, web service, or .NET connectivity assembly.
+
+**Table: Mapping permissions on the external system in the BDC Metadata Store**
+
+|To allow a user or group to...|Give them the following permissions...|On...|
+||||
+|Create new external systems|Edit|The BDC Metadata Store|
+|Edit an external system|Edit|The external system object|
+|Set permissions on the external system|SetPermissions|The external system object|
+
+**External content type** An external content type is a reusable collection of metadata that defines a set of data from one or more external systems, the operations available on that data, and connectivity information related to that data.
+
+**Table: Mapping permissions on the external content type**
+
+|To allow a user or group to ...|Give them the following permissions ...|On ...|
+||||
+|Create new external content types|Edit|The external system|
+|Execute operations on an external content type|Execute|The external content type (method instances of the operation)|
+|Create lists of the external content type|Selectable in clients|The external content type|
+|Set permissions on the external content type|SetPermissions|The external content type|
+
+**The method** A Business Data Connectivity method is an XML definition of how Business Connectivity Services can interact with an external data source.
+
+**Table: Mapping permissions on the method**
+
+|To allow a user or group to ...|Give them the following permissions ...|On ...|
+||||
+|Edit a method|Edit|The method|
+|Set permissions on a method|SetPermissions|The method|
+
+**The method instance** A method instance describes, for a particular method, how to use a method by using a specific set of default values.
+
+**Table: Mapping permissions on the method instance**
+
+|To allow a user or group to...|Give them the following permissions...|On...|
+||||
+|Edit a method instance|Edit|The method instance|
+|Execute a method instance|Execute|The method instance|
+|Set permissions on a method instance|SetPermissions|The method instance|
+
+- **The development environment** When you are developing a Business Connectivity Services solution, including the external content type, and any apps for SharePoint and connection settings objects, it is a best practice to use a development environment that is separate from your production environment. In the development environment, you can grant higher levels of permissions to the developers than you would usually do in your production environment.
+
+- **The user environment** All external data will be accessed through external lists, external data columns, Business Data Web Parts, apps for SharePoint, or Office. For apps for SharePoint, you can choose to let the app for Office and SharePoint enforce permissions. In this case, if the users can access the app for Office and SharePoint, then they can access all the external data that is surfaced in the app for Office and SharePoint. You will have to work with site and site collection administrators to plan and implement permissions to the external data in your solution.
+ ## See also <a name="section5"> </a>
SharePoint Remote Share Provider https://github.com/MicrosoftDocs/OfficeDocs-SharePoint/commits/public/SharePoint/SharePointServer/administration/remote-share-provider.md
In SharePoint 2013, Remote BLOB Storage (RBS) technology was created in SQL serv
In SharePoint Server Subscription Edition, we provide a new RBS provider **Remote Share Provider**. Following are the key features of Remote Share Provider:+ - This provider supports Binary Large Object (BLOB) storage offload to remote SMB system and totally enables content database storage in SQL server side. Therefore, with the same amount of limitation of content database, as in 200-GB size, more file volumes can be stored in one content database. Hence, it helps not only to reduce the cost for storage but also for the maintenance. - There is a PowerShell Cmdlet to check the data completeness to figure out storage problem. - By applying the existing backup and restore methodology of SMB system, it provides relatively reasonable disaster recovery.
Following are the key features of Remote Share Provider:
## Limitations of Remote Share Provider Remote Share Provider introduces the new storage system into SharePoint. Any other system can introduce complexity and reliability downgrade in some circumstances. As it is based on RBS, following are some of the limitations that are also applicable to Remote Share Provider:+ - Encryption is not supported on BLOBs, even if transparent data encryption is enabled. - RBS does not support using data compression. - As content database and BLOB storages are separated, backup and restore from farm and content database level are not enough for disaster recovering. BLOB storages need to be backed up and recovered at the same time when performing farm and content database level backup and recovery.
Remote Share Provider introduces the new storage system into SharePoint. Any oth
When compared with storing BLOBs inside SQL server, there are advantages and disadvantages to use Remote Share Provider.
-**Advantages**
+**Advantages**:
+ - Improve SQL performance by moving unstructured data outside of SQL. - Lower down storage cost by using low-cost SMB storage. - Stores large number of files.
-**Disadvantages**
+**Disadvantages**:
+ - Requires other backup and restore step for remote storage (SMB). - Requires separate configuration of security and data protection in the remote storage (SMB). - Another storage layer reduces availability and reliability of the overall system that is High availability and Disaster Recovery (HADR) will not work by default until you set up HADR for SMB storage.
When compared with storing BLOBs inside SQL server, there are advantages and dis
## Planning Remote Share Provider Remote Share Provider is suitable for the scenarios when you need:+ - Huge volume of contents in site collection, which can cause a problem in storage cost and system performance. - Site collection is not for time-critical business. If the site collection is down, you can take time to restore content database and remote BLOB storage. Service downtime for this specific site collection will not have significant impact to organization business. - More READ operations than WRITE operations on that site collection.
Remote Share Provider does not provide encryption to ensure the data security. I
## Setting up Remote Share Provider
-#### Install RBS library to evert SharePoint front end and application server
+### Install RBS library to evert SharePoint front end and application server
Install RBS library to every SharePoint frontend and Application server in SharePoint farm using the following command line: ```PowerShell- Msiexec /qn /lvx* rbs_install_log.txt /I RBS.msi ADDLOCAL="Client"- ``` > [!NOTE] > Do not install RBS library through the GUI.
-#### Enable RBS feature in specific content database
+### Enable RBS feature in specific content database
RBS is applied to specific content database. Hence, every time when a new content database needs to use RBS, it needs to be set up. Then RBS providers can be registered on the content database. Ensure that there is a master key for this content database for which you want to apply RBS. If the master key does not exist, create a new one for the content database. To create master key for specific content database:+ 1. Confirm that the user account performing these steps is a member of the `db_owner` fixed database role on each database that you are configuring for RBS. 2. Open **SQL Server Management Studio**. 3. Connect to the instance of SQL Server that hosts the content database.
To create master key for specific content database:
6. Paste the following SQL queries in **Query** pane, and then run them in the sequence listed. In each case, replace `[WSS_Content]` with the content database name, and replace `c:\BlobStore` with the `volume\directory` in which you want the BLOB store created. The provisioning process creates a folder in the location that you specify. You can provision a BLOB store only once. If you attempt to provision the same BLOB store multiple times, you will receive an error. ```SQL- #Replace with <your content database> use [<Your content database>]
To create master key for specific content database:
where name = N'##MS_DatabaseMasterKey##') create master key encryption by password = N'<Admin Key Password>'- ``` You can set up RBS for each content database by using below command line. Replace DBNAME and DBINSTANCE with your specific content database name and database instance name. - ```PowerShell- msiexec /qn /lvc* rbs.log /i rbs.msi TRUSTSERVERCERTIFICATE=true DBNAME="Your content database" ADDLOCAL="ServerScript,EnableRBS" DBINSTANCE="Your SQL database instance"- ```
-#### Setting up credentials for Remote Share Provider
+### Setting up credentials for Remote Share Provider
To access restricted SMB storage, it is recommended that specific domain account is assigned to Remote Share Provider to READ/WRITE BLOB files in SMB storage. The provider is using PSCredential object to sign-in remote RBS storage with this specific account credential. See [Get-Credential](/powershell/module/microsoft.powershell.security/get-credential) to get PSCredential object for the RBS provider.
-#### Registering BLOB store with Remote Share Provider
+### Registering BLOB store with Remote Share Provider
To offload BLOB storage from content database to SMB storage, you need to create and register a new remote share BLOB store by using Remote Share Provider to a given content database. You can use `Register-SPRemoteShareBlobStore` cmdlet to register a new BLOB store for specific content database. ```PowerShell- Register-SPRemoteShareBlobStore -ContentDatabase <SPContentDatabasePipeBind> -Name <BlobStoreName[ValidateLength(8, 128)]> -Location <UNCPath> [-BlobStoreCredential <PSCredential>][- PoolCapacity <Int>]- ``` The cmdlet parameters are: - **`-ContentDatabase <SPContentDatabasePipeBind>`** The content database, the new BLOB store will be applied to, can either be the content database object or the content database name.
The content database, the new BLOB store will be applied to, can either be the c
The name of new created BLOB store. - **`-Location<UNCPath[ValidateLength(5, 256)]>`** The UNC path of the SMB storage this BLOB store will use. - **`[-BlobStoreCredential] <PSCredential>`** The PSCredential object, which is used to access the SMB storage. If this parameter is not specified, it will use the service account, which is applied to the current web application.
The PSCredential object, which is used to access the SMB storage. If this parame
The number of BLOB trunks in each BLOB pool. If this parameter is not specified, it will be set to 1000. -- Example cmdlet syntax: - ```PowerShell- Register-SPRemoteShareBlobStore -ContentDatabase $db -Name "RemoteBlob" -Location "\\SPVNEXT\blobstore"- ```
-#### Switching and activating BLOB store
+### Switching and activating BLOB store
The registered remote share BLOB store will not take effect until it is activated. `Switch-SPBlobStorage` cmdlet needs to be run after `Register-SPRemoteShareBlobStore`, so that new contents to the content database will be routed to the newly created remote share BLOB store. - ```PowerShell- Switch-SPBlobStorage -RemoteShareBlobStore <SPRemoteShareBlobStorePipeBind>- ``` This cmdlet will switch default BLOB storage of the content database to the given remote share BLOB store. Since BLOB store is unique in farm and linked to specific content database, there is no need to specify the content database in this cmdlet.
The remote share BLOB store, which will be active, can either be a remote share
Syntax example: - ```PowerShell- $blobstore = Register-SPRemoteShareBlobStore -ContentDatabase $db -Name "RemoteBlob" -Location \\SPVNEXT\blobstore Switch-SPBlobStorage -RemoteShareBlobStore $blobstore Switch-SPBlobStorage -ContentDatabase <SPContentDatabasePipeBind> -SQL- ``` This cmdlet will switch default BLOB storage back to content database in SQL. - **`-ContentDatabase <SPContentDatabasePipeBind`** The content database, which will need to set back to SQL. It can either be a content database object or content database name.
Indicates that the content database will use SQL for BLOB storage for new conten
Syntax example: ```PowerShell- Switch-SPBlobStorage -ContentDatabase $db -SQL- ```
-#### Grant permission to web application pool account and SharePoint service application pool account
+### Grant permission to web application pool account and SharePoint service application pool account
After the RBS setup, new schema `mssqlrbs` is created in the content database. Hence, the access permission for this new schema must be granted to Web Application Pool Account and SharePoint Service Application Pool Account, so that the web application and the service application can access RBS in the content database. Use the below sample SQL command in SQL server to grant the permission. - ```SQL- ALTER AUTHORIZATION ON SCHEMA::mssqlrbs to [web_app_pool_account]; ALTER AUTHORIZATION ON SCHEMA::mssqlrbs to [service app_pool_account];- ```
-#### Resetting IIS
+### Resetting IIS
After remote share BLOB store becomes the default BLOB storage to the content database, you need to run `iisreset` in every SharePoint front-end server and SharePoint application server. Then any new content will be written to the external SMB storage using Remote Share Provider.
-### Managing and configuring remote share BLOB store
+## Managing and configuring remote share BLOB store
You can use `Get-SPRemoteShareBlobStore` cmdlet to get the remote share BLOB stores in the farm. ```PowerShell-
-Get-SPRemoteShareBlobStore ΓÇôRemoteShareBlobStore <SPRemoteShareBlobStorePipeBind>
-
+Get-SPRemoteShareBlobStore -RemoteShareBlobStore <SPRemoteShareBlobStorePipeBind>
``` - This cmdlet will get a remote share BLOB store object by remote share BLOB store name. ```PowerShell- Get-SPRemoteShareBlobStore -ContentDatabase <SPContentDatabasePipeBind>- ``` - This cmdlet will get all the remote share BLOB store objects for the given content database. ```PowerShell- Get-SPRemoteShareBlobStore- ``` - This cmdlet will get all the remote share BLOB store objects for the current farm. You can change the configuration of remote share BLOB store at any time. ```PowerShell- Set-SPRemoteShareBlobStore -RemoteShareBlobStore <SPRemoteShareBlobStorePipeBind> [-Location <String>] [-BlobStoreCredential <PSCredential>] [-PoolCapacity <int>]- ``` - The cmdlet parameters are: - **`-RemoteShareBlobStore <SPRemoteShareBlobStorePipeBind>`** The remote share BLOB store needs to be changed. It can either be the remote share BLOB store object or be the remote share BLOB store name.
The remote share BLOB store needs to be changed. It can either be the remote sha
The UNC path, which the BLOB storage needs to switch to. This parameter changes the UNC path of the SMB storage used. It will not move the BLOBs from the old SMB storage to the new SMB storage. - **`[-BlobStoreCredential <PSCredential>]`** The PSCredential object, which the BLOB storage needs to switch to apply. - **`[-PoolCapacity <int>]`** The capacity of each pool that is used in the BLOB store.
One content database can have several BLOB stores, and at any time only one of t
By following the below sample, you can migrate your BLOBs from old BLOB storage to a new active BLOB store created by committing Migrate(). ```PowerShell- $db = Get-SPContentDatabase $YourDatabaseName $rbss = $db.RemoteBlobStorageSettings $rbss.SetActiveProviderName($YourBlobStoreName) $rbss.Migrate()- ``` - If you want to migrate your BLOBs from BLOB stores back to SQL content database, you can follow below example by setting active provider to empty. ```PowerShell- $db = Get-SPContentDatabase $YourDatabaseName $rbss = $db.RemoteBlobStorageSettings $rbss.SetActiveProviderName() $rbss.Migrate()- ``` - ### Unregistering remote share BLOB store You can unregister remote share BLOB store by using cmdlet `Unregister-SPRemoteShareBlobStore`. - ```PowerShell- Unregister-SPRemoteShareBlobStore -RemoteShareBlobStore <SPRemoteShareBlobStorePipeBind> [-Force]- ``` The cmdlet parameters are:
We do not recommend using this **-Force** switch because it will leave BLOBs in
You can validate remote share BLOB store used by the content database by cmdlet `Test-SPRemoteShareBlobStore`. ```PowerShell- Test-SPRemoteShareBlobSotore -ContentDatabase <SPContentDatabasePipeBind> [-LogPath <String>]- ``` - The cmdlet parameters are: - **`-ContentDatabase <SPContentDatabasePipeBind>`** The content database needs to be validated against
The content database needs to be validated against
**`[-LogPath <String>]`** The path of the validation log.-
SharePoint Remove App For Sharepoint Instances From A Sharepoint Site https://github.com/MicrosoftDocs/OfficeDocs-SharePoint/commits/public/SharePoint/SharePointServer/administration/remove-app-for-sharepoint-instances-from-a-sharepoint-site.md
Use the following procedure to remove an app from a SharePoint site.
2. On the site, on the **Settings** menu, click **View Site Contents**.
-3. In the **Apps** section, point to the app that you want to remove, click **…**, and then click **Remove**.
+3. In the **Apps** section, point to the app that you want to remove, click **...**, and then click **Remove**.
4. Click **OK** to confirm that you want to remove the app.
SharePoint Security Tasks Overview https://github.com/MicrosoftDocs/OfficeDocs-SharePoint/commits/public/SharePoint/SharePointServer/administration/security-tasks-overview.md
Title: "Overview of Business Connectivity Services security tasks in SharePoint Server"-+
description: "Understand Microsoft Business Connectivity Services security in Sh
# Overview of Business Connectivity Services security tasks in SharePoint Server [!INCLUDE[appliesto-2013-2016-2019-SUB-xxx-md](../includes/appliesto-2013-2016-2019-SUB-xxx-md.md)]
-
+ Providing security for the data that you work with through Microsoft Business Connectivity Services (BCS) is a critical part of every BCS solution. Unlike regular SharePoint data, which is stored in a SharePoint content database, the data that BCS solutions make visible live outside of SharePoint in external systems. BCS provides the channel that SharePoint uses to get to the external data. In addition to working within the usual SharePoint Server security controls such as site access permissions and list permissions, BCS solutions have to deal with additional communication and security layers. For example, the external system might use a different authentication mechanism or provider, and require different credentials than the ones your users use to access SharePoint Server with. Because there are more security layers in a BCS solution, there are more security configuration tasks involved.
-
+ The Business Connectivity Services security tasks fall to three different roles: the IT professional; the site collection administrator, or site owner; and the developer. The following examples describe what each role is responsible for.
-
+ - IT professionals have the responsibility of managing the security on the Metadata Store and its contents. They also handle account and group administration and credential mapping in the Secure Store Service.
-
+ - Site collection administrators and site owners are responsible for understanding the kind of security the external system uses and how to configure no-code, or declarative, external content types to communicate with it. They are also responsible for planning and applying security to external lists and business data Web Parts.
-
+ - BCS solution developers are responsible for understanding the kind of security that the external system uses and how to configure the BDC model to communicate with it, and security around development and deployment of apps for Office and SharePoint.
-
+ ## Business Connectivity Services security <a name="section1"> </a>
- **Delegation of administration to the **Business Data Connectivity service****
-
+### Delegation of administration to the **Business Data Connectivity service
+ The first task that the farm administrator should perform after creating an instance of the Business Data Connectivity service is to delegate administration of the service to a different account, preferably one without farm administrator rights. This best practice follows the principle of least-privilege. The delegated account will be granted the necessary permissions to open the SharePoint Central Administration website and access to the Business Data Connectivity service service application. This should be the primary account that is used to administer the service. The only permission that can be granted or revoked is **Full Control**.
-
- **Managing permission on the Metadata Store and its contents**
-
+
+### Managing permission on the Metadata Store and its contents
+ The Metadata Store holds the external content type, the external system, and the BDC model definitions that the Business Data Connectivity service application uses. One of the main jobs of the BCS Services administrator is to manage security of the Metadata Store and all the items it contains. Items in the Metadata Store get their permissions in two ways. First you can directly apply the permissions to the Metadata Store, BDC models, external systems, or external content types. The second way is by inheriting them from a higher level item. Both methods are shown in the following figure.
-
-**Figure: Metadata Store permissions**
+
+### Figure: Metadata Store permissions
![Diagram of metadata store permissions](../media/MetadataStorePermissions.jpg)
-
-- **Inheritance** Inheritance happens in two ways. First when any item is added to the Metadata Store, it inherits the permissions configuration of the Metadata Store itself. Second, the Metadata Store, external system, and external content type items can forcibly overwrite the permissions of items that are below them in the hierarchy. This happens when you select the **Propagate permissions to all…** and click **OK** when you are setting permissions on the parent item.
-
-- **Direct Application** If the permissions that an item do not meet your needs, you can manually adjust them.
-
+
+- **Inheritance** Inheritance happens in two ways. First when any item is added to the Metadata Store, it inherits the permissions configuration of the Metadata Store itself. Second, the Metadata Store, external system, and external content type items can forcibly overwrite the permissions of items that are below them in the hierarchy. This happens when you select the **Propagate permissions to all...** and click **OK** when you are setting permissions on the parent item.
+
+- **Direct Application** If the permissions that an item do not meet your needs, you can manually adjust them.
+ You can directly apply four permissions:
-
-- **Edit** This allows the user or group to edit the item
-
-- **Execute** This allows the user or group to execute the operations (create, read, update, delete, query) of external content types in the Metadata Store. All users of a BCS solution must have execute permission on the associated external content type.
-
-- **Selectable in Clients** This allows the user or group to use the External Content Type for External Lists, and apps for SharePoint by making them available in the external item picker
-
-- **Set Permissions** This allows the user or group to set permissions on the item. Every item must have at least one user or group that has the Set Permissions permission.
-
- **Recommendations for managing Metadata Store permissions**
-
-1. Pick one account, probably your Business Connectivity Services administrator account, and grant it **Set Permissions** permissions at the Metadata Store level. This will satisfy the requirement that every item has one user or group that has **Set Permissions** permissions with a securely managed administrative account. If you don't explicitly set an account, the farm account is used by default. Do not select the **Propagate permissions to all** option. You don't have to select the **Propagate permissions to all** option because every item will inherit this configuration when it is added to the Metadata Store. This also prevents unnecessary accounts from gaining access to any external systems, BDC models, or external content types that they shouldn't have.
-
-2. Use the direct application method, configure the permissions on the individual items, again not selecting the **Propagate permissions to all** option. This will allow you to maintain unique permissions configuration on each object.
-
+
+- **Edit** This allows the user or group to edit the item
+
+- **Execute** This allows the user or group to execute the operations (create, read, update, delete, query) of external content types in the Metadata Store. All users of a BCS solution must have execute permission on the associated external content type.
+
+- **Selectable in Clients** This allows the user or group to use the External Content Type for External Lists, and apps for SharePoint by making them available in the external item picker
+
+- **Set Permissions** This allows the user or group to set permissions on the item. Every item must have at least one user or group that has the Set Permissions permission.
+
+#### Recommendations for managing Metadata Store permissions
+
+1. Pick one account, probably your Business Connectivity Services administrator account, and grant it **Set Permissions** permissions at the Metadata Store level. This will satisfy the requirement that every item has one user or group that has **Set Permissions** permissions with a securely managed administrative account. If you don't explicitly set an account, the farm account is used by default. Do not select the **Propagate permissions to all** option. You don't have to select the **Propagate permissions to all** option because every item will inherit this configuration when it is added to the Metadata Store. This also prevents unnecessary accounts from gaining access to any external systems, BDC models, or external content types that they shouldn't have.
+
+2. Use the direct application method, configure the permissions on the individual items, again not selecting the **Propagate permissions to all** option. This will allow you to maintain unique permissions configuration on each object.
+ 3. Periodically, as part of your maintenance and operational plans, review the permissions configuration starting from the Metadata Store level and moving down the hierarchy to ensure that each item has the correct permissions configuration. If the permissions configuration has drifted from what it should be you should manually reconfigure them.
-
-4. You should only use the **Propagate all permissions** option when you must completely reset all the permissions on the parent item and all its children. Note that this is a destructive process and all custom permissions on child items are lost. This action can break BCS solutions for users or groups that lose their permissions.
-
- **Mapping accounts and groups in Secure Store Service**
-
+
+4. You should only use the **Propagate all permissions** option when you must completely reset all the permissions on the parent item and all its children. Note that this is a destructive process and all custom permissions on child items are lost. This action can break BCS solutions for users or groups that lose their permissions.
+
+### Mapping accounts and groups in Secure Store Service**
+ BCS cannot pass a user's credentials outside of the SharePoint Server farm to the external system where the data resides unless you've configured Kerberos Constrained Delegation. Kerberos Constrained Delegation can be challenging to configure and maintain. As an alternative, you can use the [Secure Store Service](/previous-versions/office/sharepoint-server-2010/ee806889(v=office.14)). With Secure Store, you can map a group of users to a set of credentials that BCS can use to access the external system.
-
+ There are two ways to configure your mappings:
-
-- **Group mapping** In group mapping target application, you add AD DS user accounts and security groups to Secure Store and then map them to a single set of credentials for the external system. This is the easiest way to manage access to a BCS solution.
-
-- **Individual mapping** In an individual mapping target application you can only map a single AD DS user account to a single set of credentials for the external system. Basically, this is a 1:1 mapping. You would generally do this if you have very few accounts to manage or if you want to track access and activity on the external system.
-
- **Managing permissions on the Business Data Connectivity Service application**
-
+
+- **Group mapping** In group mapping target application, you add AD DS user accounts and security groups to Secure Store and then map them to a single set of credentials for the external system. This is the easiest way to manage access to a BCS solution.
+
+- **Individual mapping** In an individual mapping target application you can only map a single AD DS user account to a single set of credentials for the external system. Basically, this is a 1:1 mapping. You would generally do this if you have very few accounts to manage or if you want to track access and activity on the external system.
+
+### Managing permissions on the Business Data Connectivity Service application
+ By default, every Web Application in your farm is granted access to the Business Data Connectivity Service application through the server farm account. If you want to restrict access to only certain web applications, you can change this by removing the server farm account and then adding the Application Pool Identity account of desired the web applications. By doing this you control which web applications have access to the Business Data Connectivity Service application. For more information, see [Set permissions to published service applications in SharePoint Server](set-permission-to-a-published-service-application.md).
-
+ If you are publishing the Business Data Connectivity Service Application to other farms, you have to add the Farm IDs of the consuming farms. For more information, see [Share service applications across farms in SharePoint Server](share-service-applications-across-farms.md).
-
+ ## See also <a name="section1"> </a>
-#### Concepts
+### Concepts
[Overview of Business Connectivity Services in SharePoint Server](business-connectivity-services-overview.md)-
SharePoint Share A Sql Server Analysis Services Data Connection Using Excel Services Sharep https://github.com/MicrosoftDocs/OfficeDocs-SharePoint/commits/public/SharePoint/SharePointServer/administration/share-a-sql-server-analysis-services-data-connection-using-excel-services-sharep.md
You can use Excel to create a connection a cube that is stored in Analysis Servi
4. In the **Search Keywords** box, type some words or phrases that will help users find the data connection when it is published to SharePoint Server 2013.
-5. Next to **Excel Services**, click **Authentication Settings…**, and then take one of the following steps:
+5. Next to **Excel Services**, click **Authentication Settings...**, and then take one of the following steps:
- If you want this connection to use Windows Authentication or the Effective User Name feature, select **Use the authenticated user's account**, and then click **OK**.
SharePoint Share A Sql Server Data Connection Using Excel Services Sharepoint Server 2013 https://github.com/MicrosoftDocs/OfficeDocs-SharePoint/commits/public/SharePoint/SharePointServer/administration/share-a-sql-server-data-connection-using-excel-services-sharepoint-server-2013.md
You can use Excel to create a connection one or more tables that are stored in S
4. In the **Search Keywords** box, type some words or phrases that will help users find the data connection when it is published to SharePoint Server 2013.
-5. Next to **Excel Services**, click **Authentication Settings…**, and then take one of the following steps:
+5. Next to **Excel Services**, click **Authentication Settings...**, and then take one of the following steps:
- If you want this connection to use Windows Authentication or the Effective User Name feature, select **Use the authenticated user's account**, and then click **OK**.
SharePoint Share An Ole Db Or Odbc Connection Using Excel Services Sharepoint Server 2013 https://github.com/MicrosoftDocs/OfficeDocs-SharePoint/commits/public/SharePoint/SharePointServer/administration/share-an-ole-db-or-odbc-connection-using-excel-services-sharepoint-server-2013.md
Use the following procedures to create OLE DB or ODBC data connections
4. In the **Search Keywords** box, enter some words or phrases that will help users find the data connection when it is published to SharePoint Server 2013.
-5. Next to **Excel Services**, select **Authentication Settings…**.
+5. Next to **Excel Services**, select **Authentication Settings...**.
6. Select **None**, and then select **OK**.
SharePoint Sharepoint Intranet Farm In Azure Phase 5 Create The Availability Group And Add https://github.com/MicrosoftDocs/OfficeDocs-SharePoint/commits/public/SharePoint/SharePointServer/administration/sharepoint-intranet-farm-in-azure-phase-5-create-the-availability-group-and-add.md
Keep the Remote Desktop session to the first SQL Server virtual machine open.
4. In the left pane, right-click **Databases**, and then click **Restore Database**.
-5. In the **Source** section, select **Device**, and then click the ellipsis ( **…**) button.
+5. In the **Source** section, select **Device**, and then click the ellipsis ( **...**) button.
6. In **Select backup devices**, click **Add**.
SharePoint Storage And Sql Server Capacity Planning And Configuration https://github.com/MicrosoftDocs/OfficeDocs-SharePoint/commits/public/SharePoint/SharePointServer/administration/storage-and-sql-server-capacity-planning-and-configuration.md
Title: Storage and SQL Server capacity planning and configuration (SharePoint Server)-+
- IT_Sharepoint_Server - IT_Sharepoint_Server_Top - Strat_SP_server-+ ms.assetid: a96075c6-d315-40a8-a739-49b91c61978f description: Learn how to plan and configure the storage and database tier for SQL Server in SharePoint Server.
description: Learn how to plan and configure the storage and database tier for S
# Storage and SQL Server capacity planning and configuration (SharePoint Server) [!INCLUDE[appliesto-2013-2016-2019-SUB-xxx-md](../includes/appliesto-2013-2016-2019-SUB-xxx-md.md)]
-
+ The capacity planning information that we provide contains guidelines to help you plan and configure the storage and SQL Server database tier in a SharePoint Server environment. This information is based on testing performed at Microsoft on live properties. However, your results may vary based on the equipment you use and the features and functionality that you implement for your sites. Learn about [Managing site storage limits for SharePoint in Microsoft 365](../../SharePointOnline/manage-site-collection-storage-limits.md).
-
-Although tests were not run on SQL Server 2014 (SP1), SQL Server 2016, SQL Server 2017 RTM, or SQL Server 2019 you can use these test results as a guide to help you plan for and configure the storage and SQL Server database tier in SharePoint Server Subscription Edition, 2019, or 2016 environments. For training about how to configure and tune SQL Server 2012, see [SQL Server 2012 for SharePoint Server 2013](#Section8A). The test results are the same as in SharePoint 2013.
-
+
+Although tests were not run on SQL Server 2014 (SP1), SQL Server 2016, SQL Server 2017 RTM, or SQL Server 2019 you can use these test results as a guide to help you plan for and configure the storage and SQL Server database tier in SharePoint Server Subscription Edition, 2019, or 2016 environments. For training about how to configure and tune SQL Server 2012, see [SQL Server 2012 for SharePoint Server 2013](#Section8A). The test results are the same as in SharePoint 2013.
+ This document is intended for joint use by SharePoint Server farm implementers and SQL Server database administrators as SharePoint Server often runs in environments in which databases are managed by separate SQL Server database administrators. It assumes significant understanding of both SharePoint Server and SQL Server.
-
+ This article assumes that you are familiar with the concepts that are presented in [Capacity management and sizing for SharePoint Server 2013](capacity-management-and-sizing-for-sharepoint-server-2013.md).
-
+ ## Storage and database tier design and configuration process for SharePoint Server 2016 and newer We recommend that you break the storage and database tier design process into the following steps. These sections provide detailed information about each design step, including storage requirements and best practices:
-
+ 1. [Gather storage and SQL Server space and I/O requirements](#Section1)
-
+ 2. [Choose SQL Server version and edition](#Section2)
-
+ 3. [Design storage architecture based on capacity and I/O requirements](#Section3)
-
+ 4. [Estimate memory requirements](#Section4)
-
+ 5. [Understand network topology requirements](#Section5)
-
+ 6. [Configure SQL Server](#Section6)
-
+ 7. [Validate and monitor storage and SQL Server performance ](#Section7)
-
<a name="Section1"> </a> ## Gather storage and SQL Server space and I/O requirements Several SharePoint Server architectural factors influence storage design. The key factors are: the amount of content, enabled features, deployed service applications, number of farms, and availability requirements.
-
-Before you start to plan storage, you should understand the databases that SharePoint Server can use.
-
+
+Before you start to plan storage, you should understand the databases that SharePoint Server can use.
+ In this section:
-
+ - [Databases used by SharePoint Server](#section1a)
-
+ - [Understand SQL Server and IOPS](#Section1_5a)
-
+ - [Estimate core storage and IOPS needs](#sectoin1b)
-
+ - [Estimate service application storage needs and IOPS](#section1c)
-
+ - [Determine availability needs](#Section1d)
-
<a name="section1a"> </a> ### Databases used by SharePoint Server The databases that are installed with SharePoint Servers (Subscription Edition, 2019, or 2016) depend on the service applications that are used in the environment. All SharePoint Server environments rely on the SQL Server system databases. This section provides a summary of the databases installed with SharePoint Servers. For detailed database information, see [Database types and descriptions in SharePoint Server](../technical-reference/database-types-and-descriptions.md).
-
-Some SharePoint Server, SQL Server Database Engine, and SQL Server Reporting Services (SSRS) databases have specific location recommendations or requirements. For information about these database locations, see [Database types and descriptions in SharePoint Server](../technical-reference/database-types-and-descriptions.md). The **Quick reference guide: SharePoint Servers 2016 and 2019 Databases**, is available to download as either a [PDF](https://download.microsoft.com/download/7/9/7/79700E8E-9896-4657-B9E6-4940B295B71A/DBrefguideSPS2019_tabloid.pdf) or [Visio](https://download.microsoft.com/download/7/9/7/79700E8E-9896-4657-B9E6-4940B295B71A/DBrefguideSPS2019_tabloid.vsdx) file.
-
+
+Some SharePoint Server, SQL Server Database Engine, and SQL Server Reporting Services (SSRS) databases have specific location recommendations or requirements. For information about these database locations, see [Database types and descriptions in SharePoint Server](../technical-reference/database-types-and-descriptions.md). The **Quick reference guide: SharePoint Servers 2016 and 2019 Databases**, is available to download as either a [PDF](https://download.microsoft.com/download/7/9/7/79700E8E-9896-4657-B9E6-4940B295B71A/DBrefguideSPS2019_tabloid.pdf) or [Visio](https://download.microsoft.com/download/7/9/7/79700E8E-9896-4657-B9E6-4940B295B71A/DBrefguideSPS2019_tabloid.vsdx) file.
+ The following databases are the SharePoint Server system databases and are installed automatically.
-
+ - Configuration
-
+ - Central Administration content
-
+ - Content (one or more)
-
+ The following list shows the SharePoint Server service applications that have databases:
-
+ - App Management Service
-
+ - Apps for SharePoint
-
+ - Business Data Connectivity
-
+ - Managed Metadata
-
+ - PerformancePoint Services
-
+ - Project Server (SharePoint Server 2013 only)
-
+ - Search Service
-
+ - Search Administration
-
+ - Analytics Reporting
-
+ - Crawl
-
+ - Link
-
+ - Secure Store Service
-
+ - SharePoint Translation Service
-
+ - SQL Server Power Pivot Service
-
+ - State Service
-
+ - Subscription Settings Service
-
+ - Usage and Health data collection
-
+ - User Profile Service
-
+ - Profile
-
+ - Social Tagging
-
+ - Synchronization
-
+ - Word Automation Services
-
+ The following list shows the SharePoint Foundation 2013 databases:
-
+ - Configuration
-
+ - Central Administration content
-
+ - Content (one or more)
-
+ - App Management Service
-
+ - Search service application:
-
+ - Search administration
-
+ - Analytics Reporting (one or more)
-
+ - Crawl (one or more)
-
+ - Link (one or more)
-
+ - Secure Store Service
-
+ - Subscription Settings Service Application (if enabled through Windows PowerShell)
-
+ - Usage and Health Data Collection Service
-
+ - Word Conversion Service
-
+ If you are integrating further with SQL Server, your environment may also include more databases, as in the following scenario. SQL Server Power Pivot for SharePoint can be used in a SharePoint Server 2016 environment only if you use SQL Server 2016 RTM Enterprise Edition and SQL Server 2016 SQL Server Analysis Services (SSAS). If in use, you must also plan to support the Power Pivot application database, and the extra load on the system. For more information, download the new [Deploying SQL Server 2016 PowerPivot and Power View in SharePoint 2016](https://go.microsoft.com/fwlink/p/?LinkID=717977&amp;clcid=0x409) white paper. For details about configuring and deploying business intelligence in a multiple server SharePoint Server 2016 farm, download [Deploying SQL Server 2016 PowerPivot and Power View in a Multi-Tier SharePoint 2016 Farm](/sql/sql-server/install/install-sql-server-business-intelligence-features).
-
+ The SQL Server 2016 Reporting Services (SSRS) add-in can be used with any SharePoint Server 2016 environment. If you are using the add-in, plan to support the two SQL Server Reporting Services databases and the extra load that is required for SQL Server Reporting Services.
-
+ - SQL Server 2012 Power Pivot for SharePoint 2013 can be used in a SharePoint 2013 environment that includes SQL Server 2008 R2 Enterprise Edition and SQL Server Analysis Services. If in use, you must also plan to support the Power Pivot application database, and the extra load on the system. For more information, see [Plan a PowerPivot deployment in a SharePoint farm](/previous-versions/sql/sql-server-2008-r2/ee210603(v=sql.105)), [Power Pivot - Overview and Learning](https://support.office.com/article/f9001958-7901-4caa-ad80-028a6d2432ed) and [Power View - Overview and Learning](https://support.office.com/article/5380e429-3ee0-4be2-97b7-64d7930020b6).
-
+ - The SQL Server 2008 R2 Reporting Services (SSRS) plug-in can be used with any SharePoint 2013 environment. If you are using the plug-in, plan to support the two SQL Server 2008 R2 Reporting Services databases and the extra load that is required for SQL Server 2008 R2 Reporting Services.
-
+ > [!NOTE] > SQL Server Reporting Services integration with SharePoint Server 2019 is no longer supported. For more information, see [Reporting Services Report Server (SharePoint Mode)](/sql/reporting-services/report-server-sharepoint/reporting-services-report-server-sharepoint-mode) and [Supported combinations of SharePoint and Reporting Services server](/sql/reporting-services/install-windows/supported-combinations-of-sharepoint-and-reporting-services-server).
-
<a name="Section1_5a"> </a> ### Understand SQL Server and IOPS On any server that hosts a SQL Server instance, it is important that the server achieves the fastest response possible from the I/O subsystem.
-
+ More and faster disks or arrays provide sufficient I/O operations per second (IOPS) while maintaining low latency and queuing on all disks.
-
+ You cannot add other types of resources, such as CPU or memory, to compensate for slow response from the I/O subsystem. However, it can influence and cause issues throughout the farm. Plan for minimal latency before deployment, and monitor your existing systems.
-
+ Before you deploy a new farm, we recommend that you benchmark the I/O subsystem by using the Diskspd Utility. This tool works on all Windows Server versions with all versions of SQL Server. For more information, see [Diskspd Utility: A Robust Storage Testing Tool](/samples/browse/?redirectedfrom=TechNet-Gallery).
-
+ Stress testing also provides valuable information for SQL Server. For information, see [Storage Benchmarking with DiskSpd](https://go.microsoft.com/fwlink/?LinkID=797804&amp;clcid=0x409).
-
+ For detailed information about how to analyze IOPS requirements from a SQL Server perspective, see [Analyzing I/O Characteristics and Sizing Storage Systems for SQL Server Database Applications](https://go.microsoft.com/fwlink/p/?LinkId=317242).
-
<a name="sectoin1b"> </a> ### Estimate core storage and IOPS needs
-Configuration and content storage and IOPS are the base layer that you must plan for in every SharePoint Server deployment.
-
+Configuration and content storage and IOPS are the base layer that you must plan for in every SharePoint Server deployment.
<a name="Section1b1"> </a> #### Configuration storage and IOPS
-Storage requirements for the Configuration database and the Central Administration content database are not large. We recommend that you allocate 2 GB for the Configuration database and 1 GB for the Central Administration content database. Over time, the configuration database may grow beyond 1 GB. It does not grow quickly ΓÇö it grows by approximately 40 MB for each 50,000 site collections.
-
+Storage requirements for the Configuration database and the Central Administration content database are not large. We recommend that you allocate 2 GB for the Configuration database and 1 GB for the Central Administration content database. Over time, the configuration database may grow beyond 1 GB. It does not grow quickly ΓÇö it grows by approximately 40 MB for each 50,000 site collections.
+ Transaction logs for the configuration database can be large. We recommend that you back up the transaction log for the configuration database regularly to force truncation. If you are using SQL Server Always On availability groups or database mirroring, you should also keep the database running in full recovery mode. For more information, see [The Transaction Log (SQL Server)](/sql/relational-databases/logs/the-transaction-log-sql-server).
-
+ > [!TIP] > If you are not using a SQL Server high availability solution which requires the use of the full recovery model, you may consider changing the configuration database to the simple recovery model.
-
+ IOPS requirements for the configuration database and Central Administration content database are minimal.
-
+ #### Content storage and IOPS <a name="Section1b2"> </a>
-Estimating the storage and IOPS required for content databases is not a precise activity. In testing and explaining the following information, we intend to help you derive estimates to use to determine the initial size of your deployment. However, when your environment is running, we expect that you'll revisit your capacity needs based on the data from your live environment.
-
+Estimating the storage and IOPS required for content databases is not a precise activity. In testing and explaining the following information, we intend to help you derive estimates to use to determine the initial size of your deployment. However, when your environment is running, we expect that you'll revisit your capacity needs based on the data from your live environment.
+ For more information about our overall capacity planning methodology, see [Capacity management and sizing for SharePoint Server 2013](capacity-management-and-sizing-for-sharepoint-server-2013.md).
-
+ #### Formula to estimate content database storage The following process describes how to approximately estimate the storage required for content databases, without considering log files:
-
+ 1. Use the following formula to estimate the size of your content databases:
-
- Database size = ((D × V) × S) + (10 KB × (L + (V × D)))
-
+
+ Database size = ((D x V) x S) + (10 KB x (L + (V x D)))
+ > [!NOTE]
- > The value, 10 KB, in the formula is a constant that approximately estimates the amount of metadata required by SharePoint Server. If your system requires significant use of metadata, you may want to increase this constant.
-
-2. Calculate the expected number of documents. This value is known as D in the formula.
-
- How you calculate the number of documents will be determined by the features that you are using. For example, for My Sites or collaboration sites, we recommend that you calculate the expected number of documents per user and multiply by the number of users. For records management or content publishing sites, you may calculate the number of documents that are managed and generated by a process.
-
+ > The value, 10 KB, in the formula is a constant that approximately estimates the amount of metadata required by SharePoint Server. If your system requires significant use of metadata, you may want to increase this constant.
+
+2. Calculate the expected number of documents. This value is known as D in the formula.
+
+ How you calculate the number of documents will be determined by the features that you are using. For example, for My Sites or collaboration sites, we recommend that you calculate the expected number of documents per user and multiply by the number of users. For records management or content publishing sites, you may calculate the number of documents that are managed and generated by a process.
+ If you are migrating from a current system, it may be easier to extrapolate your current growth rate and usage. If you are creating a new system, review your existing file shares or other repositories and estimate based on that usage rate.
-
-3. Estimate the average size of the documents that you'll be storing. This value is known as S in the formula. It may be worthwhile to estimate averages for different types or groups of sites. The average file size for My Sites, media repositories, and different department portals can vary significantly.
-
-4. Estimate the number of list items in the environment. This value is known as L in the formula.
-
- List items are more difficult to estimate than documents. We generally use an estimate of three times the number of documents (D), but estimation formula this will vary based on how you expect to use your sites.
-
-5. Determine the approximate number of versions. Estimate the average number of versions any document in a library will have. This value will usually be much lower than the maximum allowed number of versions. This value is known as V in the formula.
-
- The value of V must be above zero.
-
+
+3. Estimate the average size of the documents that you'll be storing. This value is known as S in the formula. It may be worthwhile to estimate averages for different types or groups of sites. The average file size for My Sites, media repositories, and different department portals can vary significantly.
+
+4. Estimate the number of list items in the environment. This value is known as L in the formula.
+
+ List items are more difficult to estimate than documents. We generally use an estimate of three times the number of documents (D), but estimation formula this will vary based on how you expect to use your sites.
+
+5. Determine the approximate number of versions. Estimate the average number of versions any document in a library will have. This value will usually be much lower than the maximum allowed number of versions. This value is known as V in the formula.
+
+ The value of V must be above zero.
+ As an example, use this formula and the characteristics in the following table to estimate the required storage space for data files in a content database for a collaboration environment. The result is that you need approximately 105 GB.
-
-|**Input**|**Value**|
-|:--|:--|
-|Number of documents (D) <br/> |200,000 <br/> Calculated by assuming 10,000 users times 20 documents <br/> |
-|Average size of documents (S) <br/> |250 KB <br/> |
-|List items (L) <br/> |600,000 <br/> |
-|Number of non-current versions (V) <br/> |2 <br/> Assuming that the maximum versions allowed is 10 <br/> |
-
-Database size = (((200,000 x 2)) × 250) + ((10 KB × (600,000 + (200,000 x 2))) = 110,000,000 KB or 105 GB
-
+
+|Input|Value|
+|||
+|Number of documents (D)|200,000 <br/> Calculated by assuming 10,000 users times 20 documents|
+|Average size of documents (S)|250 KB|
+|List items (L)|600,000|
+|Number of non-current versions (V)|2 <br/> Assuming that the maximum versions allowed is 10|
+
+Database size = (((200,000 x 2)) x 250) + ((10 KB x (600,000 + (200,000 x 2))) = 110,000,000 KB or 105 GB
+ > [!NOTE]
-> Efficient File I/O in SharePoint Server is a storage method in which a file is split into pieces that are stored and updated separately. These pieces are streamed together when a user requests the file. This increases the I/O performance but it normally does not increase the file size. However, small files can see a small increase in the disk storage that is required.
-
+> Efficient File I/O in SharePoint Server is a storage method in which a file is split into pieces that are stored and updated separately. These pieces are streamed together when a user requests the file. This increases the I/O performance but it normally does not increase the file size. However, small files can see a small increase in the disk storage that is required.
+ #### Features that influence the size of content databases The following SharePoint Server features can affect the size of content databases:
-
-- **Recycle bins** Until a document is fully deleted from both the first stage and second stage recycle bin, it occupies space in a content database. Calculate how many documents are deleted each month to determine the effect of recycle bins on the size of content databases.
-
-- **Auditing** Audit data can quickly compound and use large amounts of space in a content database, especially if view auditing is turned on. Rather than letting audit data grow without constraint, we recommend that you enable auditing only on the events that are important to meet regulatory needs or internal controls. Use the following guidelines to estimate the space that you must reserve for auditing data:
-
+
+- **Recycle bins** Until a document is fully deleted from both the first stage and second stage recycle bin, it occupies space in a content database. Calculate how many documents are deleted each month to determine the effect of recycle bins on the size of content databases.
+
+- **Auditing** Audit data can quickly compound and use large amounts of space in a content database, especially if view auditing is turned on. Rather than letting audit data grow without constraint, we recommend that you enable auditing only on the events that are important to meet regulatory needs or internal controls. Use the following guidelines to estimate the space that you must reserve for auditing data:
+ - Estimate the number of new auditing entries for a site, and multiply this number by 2 KB (entries generally are limited to 4 KB, with an average size of about 1 KB).
-
+ - Based on the space that you want to allocate, determine the number of days of audit logs you want to keep.
-
+ > [!NOTE]
-> Office Online Server is the next version of Office Web Apps Server. Using Office Online Server with SharePoint Servers 2016, 2019, Subscription Edition doesn't affect the size of the content database. To deploy Office Online Server in your SharePoint Server 2016 farm, see [Deploy Office Online Server](/officeonlineserver/deploy-office-online-server).
-
+> Office Online Server is the next version of Office Web Apps Server. Using Office Online Server with SharePoint Servers 2016, 2019, Subscription Edition doesn't affect the size of the content database. To deploy Office Online Server in your SharePoint Server 2016 farm, see [Deploy Office Online Server](/officeonlineserver/deploy-office-online-server).
+ #### Estimate content database IOPS requirements IOPS requirements for content databases vary based on how your environment is being used, available disk space, and the number of servers that you have. In general, we recommend that you compare the predicted workload in your environment to one of the solutions that we tested. For more information and can be applied to newer version of SharePoint, see [Performance and capacity test results and recommendations (SharePoint Server 2013)](performance-and-capacity-test-results-and-recommendations-for-sharepoint-2013.md).
-
+ In tests, we found that the content databases tend to range from 0.05 IOPS/GB to around 0.2 IOPS/GB. We also found that a best practice is to increase the top-end to 0.5 IOPS/GB. This increased proportion is more than necessary and can be much more than you'll need in your environment. If you use mirroring, this increased proportion results in much more IO than the primary content databases. Be aware that the mirrored content databases are never lightweight.
-
<a name="section1c"> </a> ### Estimate service application storage needs and IOPS
-After you estimate content storage and IOPS needs, you must determine the storage and IOPS required by the service applications that are being used in your environment.
-
+After you estimate content storage and IOPS needs, you must determine the storage and IOPS required by the service applications that are being used in your environment.
+ #### SharePoint Server service application storage and IOPS requirements <a name="Section1c2"> </a> To estimate the storage requirements for the service applications in the system, you must first be aware of the service applications and how you'll use them. Service applications that are available in SharePoint Server 2016 and that have databases are listed in the following tables. The storage and IOPS data for all of the service applications in SharePoint Server Subscription Edition, 2019, or 2016 remains the same as in SharePoint Servers 2010 and 2013.
-
+ **Search service application storage and IOPS requirements**
-|**Database**|**Scaling**|**Disk IOPS**|**Disk size**|**10M items**|**100M items**|
-|:--|:--|:--|:--|:--|:--|
-|Crawl <br/> |One DB per 20M items <br/> SQL IOPS: 10 per a DPS <br/> |Medium/High <br/> |Medium <br/> |15 GB <br/> 2 GB log <br/> |110 GB <br/> 50 GB log <br/> |
-|Link <br/> |One DB per 60M items <br/> SQL IOPS: 10 per 1M items <br/> |Medium <br/> |Medium <br/> |10 GB <br/> 0.1 GB log <br/> |80 GB <br/> 5 GB log <br/> |
-|Analytics Reporting <br/> |Split when reaching 100-300 GB <br/> |Medium <br/> |Medium <br/> |Usage dependent <br/> |Usage dependent <br/> |
-|Search Administration <br/> |One DB <br/> |Low <br/> |Low <br/> |0.4 GB <br/> 1 GB log <br/> |1 GB data <br/> 2 GB log <br/> |
-
+|Database|Scaling|Disk IOPS|Disk size|10M items|100M items|
+|||||||
+|Crawl|One DB per 20M items <br/> SQL IOPS: 10 per a DPS|Medium/High|Medium|15 GB <br/> 2 GB log|110 GB <br/> 50 GB log|
+|Link|One DB per 60M items <br/> SQL IOPS: 10 per 1M items|Medium|Medium|10 GB <br/> 0.1 GB log|80 GB <br/> 5 GB log|
+|Analytics Reporting|Split when reaching 100-300 GB|Medium|Medium|Usage dependent|Usage dependent|
+|Search Administration|One DB|Low|Low|0.4 GB <br/> 1 GB log|1 GB data <br/> 2 GB log|
+ **Service application storage requirements and IOPS recommendations**
-|**Service application**|**Size estimation recommendation**|
-|:--|:--|
-|User Profile <br/> |The User Profile service application is associated with three databases: Profile, Synchronization, and Social Tagging. <br/> **Note**: The testing for the User Profile database storage requirements and IOPS recommendations is not yet complete. Check back for additional information. <br/> For User Profile database information, see [Database types and descriptions in SharePoint Server](../technical-reference/database-types-and-descriptions.md). <br/> |
-|Managed Metadata Service <br/> |The Managed Metadata service application has one database. The size of the database is affected by the number of content types and keywords used in the system. Many environments will include multiple instances of the Managed Metadata service application. <br/> |
-|Secure Store Service <br/> |The size of the Secure Store service application database is determined by the number of credentials in the store and the number of entries in the audit table. We recommend that you allocate 5 MB for every 1,000 credentials for it. It has minimal IOPS. <br/> |
-|State Service <br/> |The State service application has one database. We recommend that you allocate 1 GB for it. It has minimal IOPS. <br/> |
-|Word Automation Services <br/> |The Word Automation service application has one database. We recommend that you allocate 1 GB for it. It has minimal IOPS. <br/> |
-|PerformancePoint Services <br/> |The PerformancePoint service application has one database. We recommend that you allocate 1 GB for it. It has minimal IOPS. <br/> |
-|Business Data Connectivity service <br/> |The Business Data Connectivity service application has one database. This database is small and significant growth is unlikely. It has minimal IOPS. The PerformancePoint Services is not applicable for Subscription Edition. <br/> |
-|App Management <br/> |The App Management service application has one database. This database is small and significant growth is unlikely. It has minimal IOPS. <br/> |
-|Power Pivot <br/> |The Power Pivot Service application has one database. This database is small and has no significant I/O impact. We recommend that you use the same IOPS as the SharePoint content database. Content databases have significantly higher I/O requirements than the Power Pivot service application database. <br/> |
-
+|Service application|Size estimation recommendation|
+|||
+|User Profile|The User Profile service application is associated with three databases: Profile, Synchronization, and Social Tagging. <br/> **Note**: The testing for the User Profile database storage requirements and IOPS recommendations is not yet complete. Check back for additional information. <br/> For User Profile database information, see [Database types and descriptions in SharePoint Server](../technical-reference/database-types-and-descriptions.md).|
+|Managed Metadata Service|The Managed Metadata service application has one database. The size of the database is affected by the number of content types and keywords used in the system. Many environments will include multiple instances of the Managed Metadata service application.|
+|Secure Store Service|The size of the Secure Store service application database is determined by the number of credentials in the store and the number of entries in the audit table. We recommend that you allocate 5 MB for every 1,000 credentials for it. It has minimal IOPS.|
+|State Service|The State service application has one database. We recommend that you allocate 1 GB for it. It has minimal IOPS.|
+|Word Automation Services|The Word Automation service application has one database. We recommend that you allocate 1 GB for it. It has minimal IOPS.|
+|PerformancePoint Services|The PerformancePoint service application has one database. We recommend that you allocate 1 GB for it. It has minimal IOPS.|
+|Business Data Connectivity service|The Business Data Connectivity service application has one database. This database is small and significant growth is unlikely. It has minimal IOPS. The PerformancePoint Services is not applicable for Subscription Edition.|
+|App Management|The App Management service application has one database. This database is small and significant growth is unlikely. It has minimal IOPS.|
+|Power Pivot|The Power Pivot Service application has one database. This database is small and has no significant I/O impact. We recommend that you use the same IOPS as the SharePoint content database. Content databases have significantly higher I/O requirements than the Power Pivot service application database.|
<a name="Section1d"> </a> ### Determine availability needs
-Availability is how much a SharePoint Server environment is perceived by users to be available. An available system is a system that is resilient ΓÇö that is, incidents that affect service occur infrequently, and timely and effective action is taken when they do occur.
-
+Availability is how much a SharePoint Server environment is perceived by users to be available. An available system is a system that is resilient ΓÇö that is, incidents that affect service occur infrequently, and timely and effective action is taken when they do occur.
+ Availability requirements can significantly increase your storage needs. For detailed information, see [Create a high availability architecture and strategy for SharePoint Server](plan-for-high-availability.md). Also, see the SQL Server 2012 white paper [AlwaysOn Architecture Guide: Building a High Availability and Disaster Recovery Solutions by Using AlwaysOn Availability Groups](/previous-versions/sql/sql-server-2012/jj191711(v=msdn.10)).
-
+ <a name="Section2"> </a> ## Choose SQL Server version and edition
-We recommend that for SharePoint Server Subscription Edition, 2019, or 2016 you consider running your environment on the Enterprise Edition of the following SQL Servers to take advantage of the other performance, availability, security, and management capabilities that these versions provide.
+We recommend that for SharePoint Server Subscription Edition, 2019, or 2016 you consider running your environment on the Enterprise Edition of the following SQL Servers to take advantage of the other performance, availability, security, and management capabilities that these versions provide.
- SQL Server 2019 (SharePoint Subscription Edition, 2019, and 2016)
-
+ - SQL Server 2017 RTM (SharePoint Servers 2016 and 2019)
-
+ - SQL Server 2016 (SharePoint Servers 2016 and 2019) - SQL Server 2014 with Service Pack 1 (SP1) (SharePoint Server 2016 only)
-
-For more information about the benefits of these versions, see [Features Supported by the Editions of SQL Server 2014](/sql/sql-server/sql-server-2014-release-notes?view=sql-server-2016&preserve-view=true), [Editions and supported features of SQL Server 2016](/sql/sql-server/editions-and-components-of-sql-server-2016), [Editions and supported features of SQL Server 2017](/sql/sql-server/editions-and-components-of-sql-server-2017), and [https://docs.microsoft.com/sql/sql-server/editions-and-components-of-sql-server-version-15?view=sql-server-ver15](/sql/sql-server/editions-and-components-of-sql-server-version-15?view=sql-server-ver15&preserve-view=true)).
+For more information about the benefits of these versions, see [Features Supported by the Editions of SQL Server 2014](/sql/sql-server/sql-server-2014-release-notes?view=sql-server-2016&preserve-view=true), [Editions and supported features of SQL Server 2016](/sql/sql-server/editions-and-components-of-sql-server-2016), [Editions and supported features of SQL Server 2017](/sql/sql-server/editions-and-components-of-sql-server-2017), and [https://docs.microsoft.com/sql/sql-server/editions-and-components-of-sql-server-version-15?view=sql-server-ver15](/sql/sql-server/editions-and-components-of-sql-server-version-15?view=sql-server-ver15&preserve-view=true)).
We recommend that for SharePoint Server 2013 you consider running your environment on the Enterprise Edition of SQL Server 2008 R2 with Service Pack 1 (SP1), SQL Server 2012, or SQL Server 2014 to take advantage of the other performance, availability, security, and management capabilities that these versions provide. For more information about the benefits of SQL Server 2008 R2 with SP1, SQL Server 2012, and SQL Server 2014 Enterprise Edition, see [Features Supported by the Editions of SQL Server 2014](/sql/sql-server/sql-server-2014-release-notes?view=sql-server-2016&preserve-view=true), [Features Supported by the Editions of SQL Server 2012](/previous-versions/sql/sql-server-2012/cc645993(v=sql.110)), and [Features Supported by the Editions of SQL Server 2008 R2](/previous-versions/sql/sql-server-2008-r2/cc645993(v=sql.105)).
-
-In particular, you should consider your need for the following features:
-
-- **Backup compression** Backup compression can speed up any SharePoint backup, and is available in every edition of SQL Server 2008 and later. By setting the compression option in your backup script, or by configuring the server that is running SQL Server to compress by default, you can significantly reduce the size of your database backups and shipped logs. For more information, see [Backup Compression (SQL Server)](/sql/relational-databases/backup-restore/backup-compression-sql-server).
-
+
+In particular, you should consider your need for the following features:
+
+- **Backup compression** Backup compression can speed up any SharePoint backup, and is available in every edition of SQL Server 2008 and later. By setting the compression option in your backup script, or by configuring the server that is running SQL Server to compress by default, you can significantly reduce the size of your database backups and shipped logs. For more information, see [Backup Compression (SQL Server)](/sql/relational-databases/backup-restore/backup-compression-sql-server).
+ > [!NOTE]
- > SQL Server data compression is not supported for SharePoint Server, except for the Search service application databases.
-
-- **Transparent data encryption** If your security requirements include the need for transparent data encryption, you must use SQL Server Enterprise Edition.
-
-- **Content deployment** If you plan to use the content deployment feature, consider SQL Server Enterprise Edition so that the system can take advantage of database snapshots.
-
+ > SQL Server data compression is not supported for SharePoint Server, except for the Search service application databases.
+
+- **Transparent data encryption** If your security requirements include the need for transparent data encryption, you must use SQL Server Enterprise Edition.
+
+- **Content deployment** If you plan to use the content deployment feature, consider SQL Server Enterprise Edition so that the system can take advantage of database snapshots.
+ > [!NOTE]
- > If you are using a Remote BLOB storage provider that does not support database snapshots, you can't use snapshots for content deployment or backup.
-
-- **Remote BLOB storage** If you want to take advantage of remote BLOB storage to a database or location outside the files associated with each content database, you must use the Enterprise Edition of:
+ > If you are using a Remote BLOB storage provider that does not support database snapshots, you can't use snapshots for content deployment or backup.
+- **Remote BLOB storage** If you want to take advantage of remote BLOB storage to a database or location outside the files associated with each content database, you must use the Enterprise Edition of:
- **SharePoint Server Subscription Edition**
+ **SharePoint Server Subscription Edition**:
- SQL Server 2016 - SQL Server 2017 RTM - SQL Server 2019
-
- **SharePoint Server 2019**
+
+ **SharePoint Server 2019**:
- SQL Server 2016 - SQL Server 2017 RTM
- - SQL Server 2019
-
- **SharePoint Server 2016**
+ - SQL Server 2019
+
+ **SharePoint Server 2016**:
+
+ - SQL Server 2014 (SP1)
- - SQL Server 2014 (SP1)
+ - SQL Server 2016
- - SQL Server 2016
-
- SQL Server 2017 RTM - SQL Server 2019
-
- **SharePoint 2013**
+ **SharePoint 2013**:
+
+ - SQL Server 2008 R2 with SP1
+
+ - SQL Server 2012 Enterprise Edition
-
- **Resource governor** Resource Governor is a technology introduced in SQL Server 2008 to enable you to manage SQL Server workloads and resources by specifying limits on resource consumption by incoming requests. Resource Governor enables you to differentiate workloads and allocate CPU and memory as they are requested, based on the limits that you specify. For more information about how to use Resource Governor, see [Resource Governor](/sql/relational-databases/resource-governor/resource-governor).
-
+ We recommend that you use Resource Governor with SharePoint Server to:
-
+ - Limit the amount of SQL Server resources that the web servers targeted by the search crawl component consume. As a best practice, we recommend limiting the crawl component to 10 percent CPU when the system is under load.
-
+ - Monitor how many resources are consumed by each database in the system ΓÇö for example, you can use Resource Governor to help you determine the best placement of databases among computers that are running SQL Server.
-
+ - **Microsoft Power Pivot for SharePoint** Enables users to share and collaborate on user-generated data models and analysis in Excel on the web while automatically refreshing those analyses. You must have Office on the web to use Excel on the web with Power Pivot for SharePoint and SharePoint Server 2016. You can use SQL Server 2014 (SP1) or SQL Server 2016 RTM Enterprise Edition and SQL Server Analysis Services for business intelligence with SharePoint Server 2016. However, you can only use Power Pivot for SharePoint with SQL Server 2016 RTM, not with SQL Server 2014 (SP1).
-
-- **Power Pivot for SharePoint 2013** Enables users to share and collaborate on user-generated data models and analysis in Excel and in the browser while automatically refreshing those analyses. It is part of SQL Server 2008 R2 Analysis Services (SSAS) Datacenter and Enterprise Edition, SQL Server 2012 SP1 Analysis Services (SSAS) Enterprise Edition, and SQL Server 2014 Analysis Services (SSAS) Enterprise and Business Intelligence Edition.
-
+
+- **Power Pivot for SharePoint 2013** Enables users to share and collaborate on user-generated data models and analysis in Excel and in the browser while automatically refreshing those analyses. It is part of SQL Server 2008 R2 Analysis Services (SSAS) Datacenter and Enterprise Edition, SQL Server 2012 SP1 Analysis Services (SSAS) Enterprise Edition, and SQL Server 2014 Analysis Services (SSAS) Enterprise and Business Intelligence Edition.
+ <a name="Section3"> </a> ## Design storage architecture based on capacity and I/O requirements The storage architecture and disk types that you select for your environment can affect system performance.
-
+ In this section:
-
+ - [Choose a storage architecture](#Section31)
-
+ - [Choose disk types](#Section32)
-
+ - [Choose RAID types](#Section33)
-
+ ### Choose a storage architecture <a name="Section31"> </a>
-SharePoint Server supports Direct Attached Storage (DAS), Storage Area Network (SAN), and Network Attached Storage (NAS) storage architectures, although NAS is only supported for use with content databases that are configured to use remote BLOB storage. Your choice depends on factors within your business solution and your existing infrastructure.
-
+SharePoint Server supports Direct Attached Storage (DAS), Storage Area Network (SAN), and Network Attached Storage (NAS) storage architectures, although NAS is only supported for use with content databases that are configured to use remote BLOB storage. Your choice depends on factors within your business solution and your existing infrastructure.
+ Any storage architecture must support your availability needs and perform adequately in IOPS and latency. To be supported, the system must consistently return the first byte of data within 20 milliseconds (ms).
-
+ #### Direct Attached Storage (DAS) DAS is a digital storage system that is directly attached to a server or workstation, without a storage network in between. DAS physical disk types include Serial Attached SCSI (SAS) and Serial Attached ATA (SATA).
-
+ In general, we recommend that you choose a DAS architecture when a shared storage platform can't guarantee a response time of 20 ms and sufficient capacity for average and peak IOPS.
-
+ #### Storage Area Network (SAN)
-SAN is an architecture to attach remote computer storage devices (such as disk arrays and tape libraries) to servers in such a way that the devices appear as locally attached to the operating system (for example, block storage).
-
-In general, we recommend that you choose a SAN when the benefits of shared storage are important to your organization.
-
+SAN is an architecture to attach remote computer storage devices (such as disk arrays and tape libraries) to servers in such a way that the devices appear as locally attached to the operating system (for example, block storage).
+
+In general, we recommend that you choose a SAN when the benefits of shared storage are important to your organization.
+ The benefits of shared storage include:
-
+ - Easier to reallocate disk storage between servers.
-
+ - Can serve multiple servers.
-
+ - No limitations on the number of disks that can be accessed.
-
+ #### Network Attached Storage (NAS)
-A NAS unit is a self-contained computer that is connected to a network. Its sole purpose is to supply file-based data storage services to other devices on the network. The operating system and other software on the NAS unit provide the functionality of data storage, file systems, and access to files, and the management of these functionalities (for example, file storage).
-
+A NAS unit is a self-contained computer that is connected to a network. Its sole purpose is to supply file-based data storage services to other devices on the network. The operating system and other software on the NAS unit provide the functionality of data storage, file systems, and access to files, and the management of these functionalities (for example, file storage).
+ > [!NOTE]
-> NAS is only supported for use with content databases that are configured to use remote BLOB storage (RBS). Any network storage architecture must respond to a ping within 1 ms and must return the first byte of data within 20 ms. This restriction does not apply to the local SQL Server FILESTREAM provider, because it only stores data locally on the same server.
-
+> NAS is only supported for use with content databases that are configured to use remote BLOB storage (RBS). Any network storage architecture must respond to a ping within 1 ms and must return the first byte of data within 20 ms. This restriction does not apply to the local SQL Server FILESTREAM provider, because it only stores data locally on the same server.
+ > [!NOTE]
-> Some confusion exists about if you use the Internet Small Computer System Interface (iSCSI) and assume that it is a NAS protocol. If you access this iSCSI storage through the Common Internet File System (CFIS), it is a NAS protocol. This means that you can't use this storage with content databases if they aren't configured to use RBS. If however, you access this iSCSI storage through a locally attached hard disk, it is considered a SAN architecture. This means that you can use it with NAS.
-
+> Some confusion exists about if you use the Internet Small Computer System Interface (iSCSI) and assume that it is a NAS protocol. If you access this iSCSI storage through the Common Internet File System (CFIS), it is a NAS protocol. This means that you can't use this storage with content databases if they aren't configured to use RBS. If however, you access this iSCSI storage through a locally attached hard disk, it is considered a SAN architecture. This means that you can use it with NAS.
+ ### Choose disk types <a name="Section32"> </a> The disk types that you use in the system can affect reliability and performance. All else being equal, larger drives increase mean seek time. SharePoint Server supports the following types of drives:
-
+ - Small Computer System Interface (SCSI)
-
-- Serial Advanced Technology Attachment (SATA)
-
+
+- Serial Advanced Technology Attachment (SATA)
+ - Serial-attached SCSI (SAS)
-
+ - Fibre Channel (FC)
-
+ - Integrated Device Electronics (IDE)
-
+ - Solid State Drive (SSD) or Flash Disk
-
+ ### Choose RAID types <a name="Section33"> </a> RAID (Redundant Array of Independent Disks) is often used to both improve the performance characteristics of individual disks (by striping data across several disks) and to provide protection from individual disk failures.
-
-All RAID types are supported for SharePoint Server. However, we recommend that you use RAID 10 or a vendor-specific RAID solution that has equivalent performance.
-
+
+All RAID types are supported for SharePoint Server. However, we recommend that you use RAID 10 or a vendor-specific RAID solution that has equivalent performance.
+ When you configure a RAID array, make sure that you align the file system to the offset that is supplied by the vendor.
-
-For more information about provisioning RAID for SQL Server, see [RAID](/previous-versions/sql/sql-server-2008-r2/ms184252(v=sql.105)).
-
+
+For more information about provisioning RAID for SQL Server, see [RAID](/previous-versions/sql/sql-server-2008-r2/ms184252(v=sql.105)).
+ <a name="Section4"> </a> ## Estimate memory requirements
-The memory that is required for SharePoint Server is directly related to the size of the content databases that you are hosting on a server that is running SQL Server.
-
+The memory that is required for SharePoint Server is directly related to the size of the content databases that you are hosting on a server that is running SQL Server.
+ As you add service applications and features, your requirements are likely to increase. The following table gives guidelines for how much memory we recommend.
-
-|**Combined size of content databases**|**RAM recommended for computer running SQL Server**|
-|:--|:--|
-|Minimum for small production deployments <br/> |8 GB <br/> |
-|Minimum for medium production deployments <br/> |16 GB <br/> |
-|Recommendation for up to 2 terabytes <br/> |32 GB <br/> |
-|Recommendation for the range of 2 terabytes to 5 terabytes <br/> |64 GB <br/> |
-|Recommendation for more than 5 terabytes <br/> |Extra RAM over 64 GB can improve SQL Server caching speed <br/> |
-
+
+|Combined size of content databases|RAM recommended for computer running SQL Server|
+|||
+|Minimum for small production deployments|8 GB|
+|Minimum for medium production deployments|16 GB|
+|Recommendation for up to 2 terabytes|32 GB|
+|Recommendation for the range of 2 terabytes to 5 terabytes|64 GB|
+|Recommendation for more than 5 terabytes|Extra RAM over 64 GB can improve SQL Server caching speed|
+ > [!NOTE]
-> These values are higher than those recommended as the minimum values for SQL Server because of the distribution of data required for a SharePoint Server environment. For more information about SQL Server system requirements, see [Hardware and Software Requirements for Installing SQL Server 2014](/sql/sql-server/install/hardware-and-software-requirements-for-installing-sql-server) and [Hardware and Software Requirements for Installing SQL Server](/sql/sql-server/install/hardware-and-software-requirements-for-installing-sql-server) for SQL Servers 2016 and 2017.
-
+> These values are higher than those recommended as the minimum values for SQL Server because of the distribution of data required for a SharePoint Server environment. For more information about SQL Server system requirements, see [Hardware and Software Requirements for Installing SQL Server 2014](/sql/sql-server/install/hardware-and-software-requirements-for-installing-sql-server) and [Hardware and Software Requirements for Installing SQL Server](/sql/sql-server/install/hardware-and-software-requirements-for-installing-sql-server) for SQL Servers 2016 and 2017.
+ For information about SQL Server capacity limits and specifications, see [Compute Capacity Limits by Edition of SQL Server](/sql/sql-server/compute-capacity-limits-by-edition-of-sql-server) and [Maximum Capacity Specifications for SQL Server](/sql/sql-server/maximum-capacity-specifications-for-sql-server).
-
+ Other factors that may influence the memory that is required include:
-
+ - The use of SQL Server mirroring.
-
+ - The frequent use of files larger than 15 megabytes (MB).
-
+ <a name="Section5"> </a> ## Understand network topology requirements Plan the network connections within and between farms. We recommend that you use a network that has low latency.
-
+ The following list provides some best practices and recommendations:
-
+ - All servers in the farm should have LAN bandwidth and latency to the server that is running SQL Server. Latency should be no greater than 1 millisecond.
-
+ - We do not recommend a wide area network (WAN) topology in which a server that is running SQL Server is deployed remotely from other components of the farm over a network that has latency greater than 1 ms., because this topology has not been tested.
-
+ - Plan for an adequate WAN network if you plan to use SQL Server the AlwaysOn implementation suite, mirroring, log shipping, or Failover Clustering to keep a remote site up to date.
-
+ - We recommend that web servers and application servers have two network adapters: one network adapter to handle user traffic and the other to handle communication with the servers that are running SQL Server.
-
+ > [!NOTE]
- > If you use iSCSI, make sure each network adapter is dedicated to either network communication or iSCI, not both.
-
+ > If you use iSCSI, make sure each network adapter is dedicated to either network communication or iSCI, not both.
+ <a name="Section6"> </a> ## Configure SQL Server - The following sections describe how to plan to configure SQL Server for SharePoint Server.
-
+ In this section:
-
+ - [Estimate how many servers are required](#Section6_1)
-
+ - [Configure storage and memory](#Section6_2)
-
+ - [Set SQL Server options](#Section6_3)
-
+ - [Configure databases](#Section6_5)
-
+ ### Estimate how many servers are required <a name="Section6_1"> </a> In general, SharePoint Server is designed to take advantage of SQL Server scale out. For example, SharePoint Server may perform better with many medium-size servers that are running SQL Server than with only several large servers.
-
+ Always put SQL Server on a dedicated server that is not running any other farm roles or hosting databases for any other application. The only exception to this recommendation is if you deploy the system on a stand-alone server for a development or a non-performance oriented test environment. Although SQL Server can run on the same server as SharePoint, we recommend running SQL Server on a separate server for better performance.
-
-The following instructions are general guidance for when to deploy an extra server that will run a SQL Server instance:
-
-- Add another database server when you have more than four web servers that are running at capacity.
-
+
+The following instructions are general guidance for when to deploy an extra server that will run a SQL Server instance:
+
+- Add another database server when you have more than four web servers that are running at capacity.
+ - Add another database server when your current server has reached its effective resource limits of RAM, CPU, disk IO throughput, disk capacity, or network throughput.
-
+ For more information, see [Compute Capacity Limits by Edition of SQL Server](/sql/sql-server/compute-capacity-limits-by-edition-of-sql-server) and [Maximum Capacity Specifications for SQL Server](/sql/sql-server/maximum-capacity-specifications-for-sql-server).
-
+ To promote secure credential storage when you are running the Secure Store service application, we recommend that the Secure Store database be hosted on a separate database instance where access is limited to one administrator.
-
+ ### Configure storage and memory <a name="Section6_2"> </a> On the server that is running SQL Server, we recommend that the L2 cache per CPU have a minimum of 2 MB to improve memory.
-
+ #### Follow vendor storage configuration recommendations For optimal performance when you configure a physical storage array, adhere to the hardware configuration recommendations supplied by the storage vendor instead of relying on the default values of the operating system.
-
+ If you do not have guidance from your vendor, we recommend using the PowerShell storage cmdlets that are available for Windows Server 2012 R2. For more information, see [Storage Cmdlets in Windows PowerShell](/powershell/module/storage/index).
-
+ #### Provide as many resources as possible Ensure that the SQL Server I/O channels to the disks are not shared by other applications, such as the paging file and Internet Information Services (IIS) logs.
-
+ Provide as much bus bandwidth as possible. Greater bus bandwidth helps improve reliability and performance. Consider that the disk is not the only user of bus bandwidth ΓÇö for example, you must also account for network access.
-
<a name="Section6_3"> </a> ### Set SQL Server options The following SQL Server settings and options should be configured before you deploy SharePoint Server.
-
+ - Do not enable autocreate statistics on a server that hosts SQL Server and supports SharePoint Server. SharePoint Server configures the required settings upon provisioning and upgrade. Autocreate statistics can change the execution plan of a query from one instance of SQL Server to another instance of SQL Server. Therefore, to provide consistent support for all customers, SharePoint Server provides coded hints for queries as needed to provide the best performance across all scenarios.
-
+ - To ensure optimal performance, we strongly recommend that you set **max degree of parallelism (MAXDOP)** to 1 SQL Server instances that host SharePoint Server databases. For more information about how to set **max degree of parallelism**, see [Configure the max degree of parallelism Server Configuration Option](/sql/database-engine/configure-windows/configure-the-max-degree-of-parallelism-server-configuration-option).
-
+ ### Configure databases <a name="Section6_5"> </a> The following guidance describes best practices to plan for as you configure each database in your environment.
-
+ #### Separate and prioritize your data among disks Ideally, you should place the tempdb database, content databases, database, search databases, and SQL Server 2019, SQL Server 2017 RTM, SQL Server 2016, SQL Server 2014 (SP1), SQL Server 2012, and SQL Server 2008 R2 with SP1 transaction logs on separate physical hard disks.
-
+ The following list provides some best practices and recommendations for prioritizing data:
-
+ - When you prioritize data among faster disks, use the following ranking:
-
+ - Tempdb data files and transaction logs
-
+ - Database transaction log files
-
+ - Search databases, except for the Search administration database
-
+ - Database data files
-
+ In a heavily read-oriented portal site, prioritize data over logs.
-
-- Testing and customer data show that SharePoint Server farm performance can be impeded by insufficient disk I/O for tempdb. To avoid this issue, allocate dedicated disks for tempdb. If a high workload is projected or monitored ΓÇö that is, the average read action or the average write action requires more than 20 ms ΓÇö you might have to ease the bottleneck by either separating the files across disks or by replacing the disks with faster disks.
-
+
+- Testing and customer data show that SharePoint Server farm performance can be impeded by insufficient disk I/O for tempdb. To avoid this issue, allocate dedicated disks for tempdb. If a high workload is projected or monitored ΓÇö that is, the average read action or the average write action requires more than 20 ms ΓÇö you might have to ease the bottleneck by either separating the files across disks or by replacing the disks with faster disks.
+ - For best performance, place the tempdb on a RAID 10 array. The number of tempdb data files should equal the number of core CPUs, and the tempdb data files should be set at an equal size. Count dual core processors as two CPUs for this purpose. Count each processor that supports hyper-threading as a single CPU. For more information, see [Optimizing tempdb Performance](/previous-versions/sql/sql-server-2008-r2/ms175527(v=sql.105)).
-
+ - Separate database data and transaction log files across different disks. If files must share disks because the files are too small to warrant a whole disk or stripe, or you have a shortage of disk space, put files that have different usage patterns on the same disk to minimize concurrent access requests.
-
+ - Consult your storage hardware vendor for information about how to configure all logs and the search databases for write optimization for your particular storage solution.
-
+ #### Use multiple data files for content databases Follow these recommendations for best performance:
-
+ - Only create files in the primary filegroup for the database.
-
-- Distribute the files across separate disks.
-
+
+- Distribute the files across separate disks.
+ - The number of data files should be less than or equal to the number of core CPUs. Count dual core processors as two CPUs for this purpose. Count each processor that supports hyper-threading as a single CPU.
-
-- Create data files of equal size.
-
+
+- Create data files of equal size.
+ > [!IMPORTANT]
-> Although you can use the backup and recovery tools that are built in to SharePoint Server to back up and recover multiple data files, if you overwrite in the same location, the tools can't restore multiple data files to a different location. For this reason, we strongly recommend that when you use multiple data files for a content database, you use SQL Server backup and recovery tools. For more information about how to back up and recover SharePoint Server, see [Plan for backup and recovery in SharePoint Server](backup-and-recovery-planning.md).
-
+> Although you can use the backup and recovery tools that are built in to SharePoint Server to back up and recover multiple data files, if you overwrite in the same location, the tools can't restore multiple data files to a different location. For this reason, we strongly recommend that when you use multiple data files for a content database, you use SQL Server backup and recovery tools. For more information about how to back up and recover SharePoint Server, see [Plan for backup and recovery in SharePoint Server](backup-and-recovery-planning.md).
+ For more information about how to create and manage filegroups, see [Physical Database Files and Filegroups](/previous-versions/sql/sql-server-2008-r2/ms179316(v=sql.105)).
-
+ #### Limit content database size to improve manageability
-Plan for database sizing that will improve manageability, performance, and ease of upgrade for your environment.
-
+Plan for database sizing that will improve manageability, performance, and ease of upgrade for your environment.
+ To help ensure system performance, we recommended that you limit the size of content databases to 200 GB, except when specific usage scenarios and conditions support larger sizes. For more information about content database size limits, see the "Content database limits" section in [Software boundaries and limits for SharePoint Servers 2016 and 2019](../install/software-boundaries-limits-2019.md).
-
+ We generally recommend that a site collection should not exceed 100 GB unless it is the only site collection in the database so that you can use the SharePoint Server granular backup tools to move a site collection to another database if you need to.
-
+ #### Proactively manage the growth of data and log files We recommend that you proactively manage the growth of data and log files by considering the following recommendations:
-
+ - As much as possible, pre-grow all data and log files to their expected final size.
-
+ - We recommend that you enable autogrowth for safety reasons. Do not rely on the default autogrowth settings. Consider the following guidelines when you configure autogrowth:
-
+ - When you plan content databases that exceed the recommended size (200 GB), set the database autogrowth value to a fixed number of megabytes instead of to a percentage. This setting reduces the frequency with which SQL Server increases the size of a file. Increasing file size is a blocking action that involves filling the new space with empty pages.
-
- - If the calculated size of the content database is not expected to reach the recommended maximum size of 200 GB within the next year, set it to the maximum size the database is predicted to reach in a year ΓÇö with 20 percent extra margin for error ΓÇö by using the **ALTER DATABASE MAXSIZE** property. Periodically review this setting to make sure that it is still an appropriate value, depending on past growth rates.
-
+
+ - If the calculated size of the content database is not expected to reach the recommended maximum size of 200 GB within the next year, set it to the maximum size the database is predicted to reach in a year ΓÇö with 20 percent extra margin for error ΓÇö by using the **ALTER DATABASE MAXSIZE** property. Periodically review this setting to make sure that it is still an appropriate value, depending on past growth rates.
+ - Maintain a level of at least 25 percent available space across disks to allow for growth and peak usage patterns. If you are managing growth by adding disks to a RAID array or allocating more storage, monitor disk size closely to avoid running out of space.
-
+ <a name="Section7"> </a> ## Validate and monitor storage and SQL Server performance Test that your performance and backup solution on your hardware enables you to meet your service level agreements (SLAs). In particular, test the I/O subsystem of the computer that is running SQL Server to make sure that performance is satisfactory.
-
-Test the backup solution that you are using to make sure that it can back up the system within the available maintenance window. If the backup solution can't meet the SLAs your business requires, consider using an incremental backup solution such as Microsoft System Center Data Protection Manager.
-
-It is important to track the following resource components of a server that is running SQL Server: CPU, memory, cache/hit ratio, and I/O subsystem. When one or more of the components seems slow or overburdened, analyze the appropriate strategy based on the current and projected workload. For more information, see [Monitor and Tune for Performance](/sql/relational-databases/performance/monitor-and-tune-for-performance).
-
+
+Test the backup solution that you are using to make sure that it can back up the system within the available maintenance window. If the backup solution can't meet the SLAs your business requires, consider using an incremental backup solution such as Microsoft System Center Data Protection Manager.
+
+It is important to track the following resource components of a server that is running SQL Server: CPU, memory, cache/hit ratio, and I/O subsystem. When one or more of the components seems slow or overburdened, analyze the appropriate strategy based on the current and projected workload. For more information, see [Monitor and Tune for Performance](/sql/relational-databases/performance/monitor-and-tune-for-performance).
+ The following section lists the performance counters that we recommend that you use to monitor the performance of the SQL Server databases that are running in your SharePoint Server environment. Also listed are approximate healthy values for each counter.
-
+ For details about how to monitor performance and use performance counters, see [Windows Performance Monitor](/previous-versions/windows/it-pro/windows-server-2008-R2-and-2008/cc749249(v=ws.11)) and [Monitoring Performance](/previous-versions/windows/it-pro/windows-server-2012-R2-and-2012/ff627833(v=ws.11)).
-
+ ### SQL Server counters to monitor Monitor the following SQL Server counters to ensure the health of your servers:
-
-- **General statistics** This object provides counters to monitor general server-wide activity, such as the number of current connections and the number of users connecting and disconnecting per second from computers that are running an instance of SQL Server. Consider monitoring the following counter:
-
- - **User connections** This counter shows the number of user connections on your computer that is running SQL Server. If you see this number increase by 500 percent from your baseline, you may see a performance reduction.
-
-- **Databases** This object provides counters to monitor bulk copy operations, backup and restore throughput, and transaction log activities. Monitor transactions and the transaction log to determine how much user activity is occurring in the database and how full the transaction log is becoming. The amount of user activity can determine the performance of the database and affect log size, locking, and replication. Monitoring low-level log activity to gauge user activity and resource usage can help you identify performance bottlenecks. Consider monitoring the following counter:
-
- - **Transactions/sec** This counter shows the number of transactions on a given database or on the entire server per second. This number is more for your baseline and to help you troubleshoot issues.
-
-- **Locks** This object provides information about SQL Server locks on individual resource types. Consider monitoring the following counters:
-
- - **Average Wait Time (ms)** This counter shows the average amount of wait time for each lock request that resulted in a wait.
-
- - **Lock Wait Time (ms)** This counter shows the wait time for locks in the last second.
-
- - **Lock waits/sec** This counter shows the number of locks per second that couldn't be satisfied immediately and had to wait for resources.
-
- - **Number of deadlocks/sec** This counter shows the number of deadlocks on the computer that is running SQL Server per second. This number should not increase above 0.
-
-- **Latches** This object provides counters to monitor internal SQL Server resource locks called latches. Monitoring the latches to determine user activity and resource usage can help you identify performance bottlenecks. Consider monitoring the following counters:
-
- - **Average Latch Wait Time (ms)** This counter shows the average latch wait time for latch requests that had to wait.
-
- - **Latch Waits/sec** This counter shows the number of latch requests that couldn't be granted immediately.
-
-- **SQL Statistics** This object provides counters to monitor compilation and the type of requests sent to an instance of SQL Server. Monitoring the number of query compilations and recompilations and the number of batches received by an instance of SQL Server gives you an indication of how quickly SQL Server is processing user queries and how effectively the query optimizer is processing the queries. Consider monitoring the following counters:
-
- - **SQL Compilations/sec** This counter indicates the number of times the compile code path is entered per second.
-
- - **SQL Re-Compilations/sec** This counter indicates the number statement recompiles per second.
-
-- **Buffer Manager** This object provides counters to monitor how SQL Server uses memory to store data pages, internal data structures, and the procedure cache, and also counters to monitor the physical I/O as SQL Server reads and writes database pages. Consider monitoring the following counter:
-
+
+- **General statistics** This object provides counters to monitor general server-wide activity, such as the number of current connections and the number of users connecting and disconnecting per second from computers that are running an instance of SQL Server. Consider monitoring the following counter:
+
+ - **User connections** This counter shows the number of user connections on your computer that is running SQL Server. If you see this number increase by 500 percent from your baseline, you may see a performance reduction.
+
+- **Databases** This object provides counters to monitor bulk copy operations, backup and restore throughput, and transaction log activities. Monitor transactions and the transaction log to determine how much user activity is occurring in the database and how full the transaction log is becoming. The amount of user activity can determine the performance of the database and affect log size, locking, and replication. Monitoring low-level log activity to gauge user activity and resource usage can help you identify performance bottlenecks. Consider monitoring the following counter:
+
+ - **Transactions/sec** This counter shows the number of transactions on a given database or on the entire server per second. This number is more for your baseline and to help you troubleshoot issues.
+
+- **Locks** This object provides information about SQL Server locks on individual resource types. Consider monitoring the following counters:
+
+ - **Average Wait Time (ms)** This counter shows the average amount of wait time for each lock request that resulted in a wait.
+
+ - **Lock Wait Time (ms)** This counter shows the wait time for locks in the last second.
+
+ - **Lock waits/sec** This counter shows the number of locks per second that couldn't be satisfied immediately and had to wait for resources.
+
+ - **Number of deadlocks/sec** This counter shows the number of deadlocks on the computer that is running SQL Server per second. This number should not increase above 0.
+
+- **Latches** This object provides counters to monitor internal SQL Server resource locks called latches. Monitoring the latches to determine user activity and resource usage can help you identify performance bottlenecks. Consider monitoring the following counters:
+
+ - **Average Latch Wait Time (ms)** This counter shows the average latch wait time for latch requests that had to wait.
+
+ - **Latch Waits/sec** This counter shows the number of latch requests that couldn't be granted immediately.
+
+- **SQL Statistics** This object provides counters to monitor compilation and the type of requests sent to an instance of SQL Server. Monitoring the number of query compilations and recompilations and the number of batches received by an instance of SQL Server gives you an indication of how quickly SQL Server is processing user queries and how effectively the query optimizer is processing the queries. Consider monitoring the following counters:
+
+ - **SQL Compilations/sec** This counter indicates the number of times the compile code path is entered per second.
+
+ - **SQL Re-Compilations/sec** This counter indicates the number statement recompiles per second.
+
+- **Buffer Manager** This object provides counters to monitor how SQL Server uses memory to store data pages, internal data structures, and the procedure cache, and also counters to monitor the physical I/O as SQL Server reads and writes database pages. Consider monitoring the following counter:
+ - **Buffer Cache Hit Ratio**
-
+ - This counter shows the percentage of pages that were found in the buffer cache without having to read from disk. The ratio is the total number of cache hits divided by the total number of cache lookups over the last few thousand page accesses. Because reading from the cache is much less expensive than reading from disk, you want this ratio to be high. Generally, you can increase the buffer cache hit ratio by increasing the memory available to SQL Server.
-
-- **Plan Cache** This object provides counters to monitor how SQL Server uses memory to store objects such as stored procedures, unprepared and prepared Transact-SQL statements, and triggers. Consider monitoring the following counter:
-
+
+- **Plan Cache** This object provides counters to monitor how SQL Server uses memory to store objects such as stored procedures, unprepared and prepared Transact-SQL statements, and triggers. Consider monitoring the following counter:
+ - **Cache Hit Ratio**
-
+ - This counter indicates the ratio between cache hits and lookups for plans.
-
+ ### Physical server counters to monitor Monitor the following counters to ensure the health of your computers that are running SQL Server:
-
-- **Processor: % Processor Time: _Total** This counter shows the percentage of time that the processor is executing application or operating system processes other than Idle. On the computer that is running SQL Server, this counter should be kept between 50 percent and 75 percent. If there is constant overloading, investigate whether there is abnormal process activity or if the server needs more CPUs.
-
-- **System: Processor Queue Length** This counter shows the number of threads in the processor queue. Monitor this counter to make sure that it remains less than two times the number of core CPUs.
-
-- **Memory: Available Mbytes** This counter shows the physical memory, in megabytes, available to processes running on the computer. Monitor this counter to make sure that you maintain a level of at least 20 percent of the total available physical RAM.
-
-- **Memory: Pages/sec** This counter shows the rate at which pages are read from or written to disk to resolve hard page faults. Monitor this counter to make sure that it remains under 100.
-
+
+- **Processor: % Processor Time: _Total** This counter shows the percentage of time that the processor is executing application or operating system processes other than Idle. On the computer that is running SQL Server, this counter should be kept between 50 percent and 75 percent. If there is constant overloading, investigate whether there is abnormal process activity or if the server needs more CPUs.
+
+- **System: Processor Queue Length** This counter shows the number of threads in the processor queue. Monitor this counter to make sure that it remains less than two times the number of core CPUs.
+
+- **Memory: Available Mbytes** This counter shows the physical memory, in megabytes, available to processes running on the computer. Monitor this counter to make sure that you maintain a level of at least 20 percent of the total available physical RAM.
+
+- **Memory: Pages/sec** This counter shows the rate at which pages are read from or written to disk to resolve hard page faults. Monitor this counter to make sure that it remains under 100.
+ For more information and memory troubleshooting methods, see the following resources:
-
+ - **SQL Server 2014 (SP1) -**[Monitor Memory Usage](/sql/relational-databases/performance-monitor/monitor-memory-usage)
-
+ - [Monitor Disk Usage](/sql/relational-databases/performance-monitor/monitor-disk-usage)
-
+ - [Monitor CPU Usage](/sql/relational-databases/performance-monitor/monitor-cpu-usage)
-
+ - **SQL Server 2017, SQL Server 2017, & SQL Server 2019 -**[Monitor Memory Usage](/sql/relational-databases/performance-monitor/monitor-memory-usage)
-
+ - [Monitor Disk Usage](/sql/relational-databases/performance-monitor/monitor-disk-usage)
-
+ - [Monitor CPU Usage](/sql/relational-databases/performance-monitor/monitor-cpu-usage)
-
-For more information and memory troubleshooting methods, see [Monitoring Memory Usage](/previous-versions/sql/sql-server-2008-r2/ms176018(v=sql.105)) for SQL Server 2008 R2 with SP1, [Monitoring Memory Usage](/previous-versions/sql/sql-server-2012/ms176018(v=sql.110)) for SQL Server 2012, and [Monitor Memory Usage](/sql/relational-databases/performance-monitor/monitor-memory-usage) for SQL Server 2014.
-
+
+For more information and memory troubleshooting methods, see [Monitoring Memory Usage](/previous-versions/sql/sql-server-2008-r2/ms176018(v=sql.105)) for SQL Server 2008 R2 with SP1, [Monitoring Memory Usage](/previous-versions/sql/sql-server-2012/ms176018(v=sql.110)) for SQL Server 2012, and [Monitor Memory Usage](/sql/relational-databases/performance-monitor/monitor-memory-usage) for SQL Server 2014.
+ ### Disk counters to monitor Monitor the following counters to ensure the health of disks. The following values represent values measured over time ΓÇö not values that occur during a sudden spike and not values that are based on a single measurement.
-
-- **Physical Disk: % Disk Time: DataDrive** This counter shows the percentage of elapsed time that the selected disk drive is busy servicing read or write requests-it is a general indicator of how busy the disk is. If the **PhysicalDisk: % Disk Time** counter is high (more than 90 percent), check the **PhysicalDisk: Current Disk Queue Length** counter to see how many system requests are waiting for disk access. The number of waiting I/O requests should be sustained at no more than 1.5 to 2 times the number of spindles that make up the physical disk.
-
-- **Logical Disk: Disk Transfers/sec** This counter shows the rate at which read and write operations are performed on the disk. Use this counter to monitor growth trends and forecast appropriately.
-
-- **Logical Disk: Disk Read Bytes/sec** and **Logical Disk: Disk Write Bytes/sec** These counters show the rate at which bytes are transferred from the disk during read or write operations.
-
-- **Logical Disk: Avg. Disk Bytes/Read** This counter shows the average number of bytes transferred from the disk during read operations. This value can reflect disk latency ΓÇö larger read operations can result in slightly increased latency.
-
-- **Logical Disk: Avg. Disk Bytes/Write** This counter shows the average number of bytes transferred to the disk during write operations. This value can reflect disk latency ΓÇö larger write operations can result in slightly increased latency.
-
-- **Logical Disk: Current Disk Queue Length** This counter shows the number of requests outstanding on the disk at the time that the performance data is collected. For this counter, lower values are better. Values greater than 2 per disk may indicate a bottleneck and should be investigated. Therefore, a value of up to 8 is acceptable for a logical unit (LUN) made up of four disks. Bottlenecks can create a backlog that can spread beyond the current server that is accessing the disk and result in long wait times for users. Possible solutions to a bottleneck are to add more disks to the RAID array, replace existing disks with faster disks, or move some data to other disks.
-
-- **Logical Disk: Avg. Disk Queue Length** This counter shows the average number of both read and write requests that were queued for the selected disk during the sample interval. The rule is that there should be two or fewer outstanding read and write requests per spindle. But this request-count can be difficult to measure because of storage virtualization and differences in RAID levels between configurations. Look for larger than average disk queue lengths in combination with larger than average disk latencies. This combination can indicate that the storage array cache is being overused or that spindle sharing with other applications is affecting performance.
-
+
+- **Physical Disk: % Disk Time: DataDrive** This counter shows the percentage of elapsed time that the selected disk drive is busy servicing read or write requests-it is a general indicator of how busy the disk is. If the **PhysicalDisk: % Disk Time** counter is high (more than 90 percent), check the **PhysicalDisk: Current Disk Queue Length** counter to see how many system requests are waiting for disk access. The number of waiting I/O requests should be sustained at no more than 1.5 to 2 times the number of spindles that make up the physical disk.
+
+- **Logical Disk: Disk Transfers/sec** This counter shows the rate at which read and write operations are performed on the disk. Use this counter to monitor growth trends and forecast appropriately.
+
+- **Logical Disk: Disk Read Bytes/sec** and **Logical Disk: Disk Write Bytes/sec** These counters show the rate at which bytes are transferred from the disk during read or write operations.
+
+- **Logical Disk: Avg. Disk Bytes/Read** This counter shows the average number of bytes transferred from the disk during read operations. This value can reflect disk latency ΓÇö larger read operations can result in slightly increased latency.
+
+- **Logical Disk: Avg. Disk Bytes/Write** This counter shows the average number of bytes transferred to the disk during write operations. This value can reflect disk latency ΓÇö larger write operations can result in slightly increased latency.
+
+- **Logical Disk: Current Disk Queue Length** This counter shows the number of requests outstanding on the disk at the time that the performance data is collected. For this counter, lower values are better. Values greater than 2 per disk may indicate a bottleneck and should be investigated. Therefore, a value of up to 8 is acceptable for a logical unit (LUN) made up of four disks. Bottlenecks can create a backlog that can spread beyond the current server that is accessing the disk and result in long wait times for users. Possible solutions to a bottleneck are to add more disks to the RAID array, replace existing disks with faster disks, or move some data to other disks.
+
+- **Logical Disk: Avg. Disk Queue Length** This counter shows the average number of both read and write requests that were queued for the selected disk during the sample interval. The rule is that there should be two or fewer outstanding read and write requests per spindle. But this request-count can be difficult to measure because of storage virtualization and differences in RAID levels between configurations. Look for larger than average disk queue lengths in combination with larger than average disk latencies. This combination can indicate that the storage array cache is being overused or that spindle sharing with other applications is affecting performance.
+ - **Logical Disk: Avg. Disk sec/Read** and **Logical Disk: Avg. Disk sec/Write** These counters show the average time, in seconds, of a read or write operation to the disk. Monitor these counters to make sure that they remain below 85 percent of the disk capacity. Disk access time increases exponentially if read or write operations are more than 85 percent of disk capacity. To determine the specific capacity for your hardware, refer to the vendor documentation or use the Diskspd Utility, storage testing tool to calculate it. For more information, see [Diskspd: A Robust Storage Performance Tool](https://gallery.technet.microsoft.com/DiskSpd-A-Robust-Storage-6ef84e62).
-
- - **Logical Disk: Avg. Disk sec/Read** This counter shows the average time, in seconds, of a read operation from the disk. On a well-tuned system, ideal values are from 1 through 5 ms for logs (ideally 1 ms on a cached array), and from 4 through 20 ms for data (ideally less than 10 ms). Higher latencies can occur during peak times. However, if high values occur regularly, you should investigate the cause.
-
- - **Logical Disk: Avg. Disk sec/Write** This counter shows the average time, in seconds, of a write operation to the disk. On a well-tuned system, ideal values are from 1 through 5 ms for logs (ideally 1 ms on a cached array), and from 4 through 20 ms for data (ideally less than 10 ms). Higher latencies can occur during peak times. However, if high values occur regularly, you should investigate the cause.
-
- When you are using RAID configurations with the **Logical Disk: Avg. Disk Bytes/Read** or **Logical Disk: Avg. Disk Bytes/Write** counters, use the formulas listed in the following table to determine the rate of input and output on the disk.
-
-|**RAID level**|**Formula**|
-|:--|:--|
-|RAID 0 <br/> |I/Os per disk = (reads + writes) / number of disks <br/> |
-|RAID 1 <br/> |I/Os per disk = [reads + (2 × writes)] / 2 <br/> |
-|RAID 5 <br/> |I/Os per disk = [reads + (4 × writes)] / number of disks <br/> |
-|RAID 10 <br/> |I/Os per disk = [reads + (2 × writes)] / number of disks <br/> |
-
+
+ - **Logical Disk: Avg. Disk sec/Read** This counter shows the average time, in seconds, of a read operation from the disk. On a well-tuned system, ideal values are from 1 through 5 ms for logs (ideally 1 ms on a cached array), and from 4 through 20 ms for data (ideally less than 10 ms). Higher latencies can occur during peak times. However, if high values occur regularly, you should investigate the cause.
+
+ - **Logical Disk: Avg. Disk sec/Write** This counter shows the average time, in seconds, of a write operation to the disk. On a well-tuned system, ideal values are from 1 through 5 ms for logs (ideally 1 ms on a cached array), and from 4 through 20 ms for data (ideally less than 10 ms). Higher latencies can occur during peak times. However, if high values occur regularly, you should investigate the cause.
+
+ When you are using RAID configurations with the **Logical Disk: Avg. Disk Bytes/Read** or **Logical Disk: Avg. Disk Bytes/Write** counters, use the formulas listed in the following table to determine the rate of input and output on the disk.
+
+|RAID level|Formula|
+|||
+|RAID 0|I/Os per disk = (reads + writes) / number of disks|
+|RAID 1|I/Os per disk = [reads + (2 x writes)] / 2|
+|RAID 5|I/Os per disk = [reads + (4 x writes)] / number of disks|
+|RAID 10|I/Os per disk = [reads + (2 x writes)] / number of disks|
+ For example, if you have a RAID 1 system that has two physical disks, and your counters are at the values that are shown in the following table.
-
-|**Counter**|**Value**|
-|:--|:--|
-|**Avg. Disk sec/Read** <br/> |80 <br/> |
-|**Logical Disk: Avg. Disk sec/Write** <br/> |70 <br/> |
-|**Avg. Disk Queue Length** <br/> |5 <br/> |
-
-- The **I/O value per disk** can be calculated as follows: (80 + (2 × 70))/2 = 110
-
-- The **disk queue length** can be calculated as follows: 5/2 = 2.5
-
+
+|Counter|Value|
+|||
+|Avg. Disk sec/Read**|80|
+|Logical Disk: Avg. Disk sec/Write**|70|
+|Avg. Disk Queue Length**|5|
+
+- The **I/O value per disk** can be calculated as follows: (80 + (2 x 70))/2 = 110
+
+- The **disk queue length** can be calculated as follows: 5/2 = 2.5
+ - In this situation, you have a borderline I/O bottleneck.
-
+ ### Other monitoring tools You can also monitor disk latency and analyze trends by using the sys.dm_io_virtual_file_stats dynamic management view in SQL Server 2008. For more information, see [sys.dm_io_virtual_file_stats (Transact-SQL)](/sql/relational-databases/system-dynamic-management-views/sys-dm-io-virtual-file-stats-transact-sql).
-
+ ## SQL Server 2012 for SharePoint Server 2013 <a name="Section8A"> </a> Thanks to Bill Baer, Microsoft Senior Product Marketing Manager and Brian Alderman, CEO and Founder of MicroTechPoint for providing a series of online SQL Server 2012 training modules. Special thanks to Channel 9 Microsoft for hosting these online training modules. The following training modules provide details about SQL Server 2012 database settings to help you learn how to improve SharePoint Server 2016 performance, availability, and security.
-
+ - [Tuning SQL Server 2012 for SharePoint 2013: (01) Key SQL Server and SharePoint Server Integration](https://channel9.msdn.com/Series/Tuning-SQL-Server-2012-for-SharePoint-2013/Tuning-SQL-Server-2012-for-SharePoint-2013-01-Key-SQL-Server-and-SharePoint-Server-Integration-Conce)
-
+ - [Tuning SQL Server 2012 for SharePoint 2013: (02) Best Practices for SQL Server Database Settings](https://channel9.msdn.com/Series/Tuning-SQL-Server-2012-for-SharePoint-2013/Tuning-SQL-Server-2012-for-SharePoint-2013-02-Best-Practices-for-SQL-Server-Database-Settings)
-
+ - [Tuning SQL Server 2012 for SharePoint 2013: (03) Server Settings for SQL Server](https://channel9.msdn.com/Series/Tuning-SQL-Server-2012-for-SharePoint-2013/Tuning-SQL-Server-2012-for-SharePoint-2013-03-Server-Settings-for-SQL-Server)
-
+ - [Tuning SQL Server 2012 for SharePoint 2013: (04) SQL Server and SharePoint Availability](https://channel9.msdn.com/Series/Tuning-SQL-Server-2012-for-SharePoint-2013/Tuning-SQL-Server-2012-for-SharePoint-2013-04-SQL-Server-and-SharePoint-Availability)
-
+ ## See also <a name="Section8A"> </a> #### Concepts [Overview of SQL Server in SharePoint Server 2016 and 2019 environments](overview-of-sql-server-in-sharepoint-server-2016-and-2019-environments.md)
-
+ [Optimize performance for SharePoint Server 2013](optimize-performance.md)
-
+ [Best practices for SQL Server in a SharePoint Server farm](best-practices-for-sql-server-in-a-sharepoint-server-farm.md)
-
+ [Performance planning in SharePoint Server 2013](performance-planning-in-sharepoint-server-2013.md)
-
+ [Capacity management and sizing for SharePoint Server 2013](capacity-management-and-sizing-for-sharepoint-server-2013.md)
-
+ [Capacity planning for SharePoint Server 2013](capacity-planning.md) #### Other Resources
SharePoint Understanding Multi Tenancy https://github.com/MicrosoftDocs/OfficeDocs-SharePoint/commits/public/SharePoint/SharePointServer/administration/understanding-multi-tenancy.md
The creation of the User Profile Service by using PowerShell as required when pr
Two scripts are required, the first script creates the UPA and the second script calls the first script.
-The following Microsoft PowerShell script shows how to create the User Profile Service application in Partition Mode and add it to a custom Service Proxy group…
+The following Microsoft PowerShell script shows how to create the User Profile Service application in Partition Mode and add it to a custom Service Proxy group...
> [!NOTE] > This script should **NOT** be run directly otherwise it will be impossible to start the User Profile Synchronization service instance. This script should be saved locally and its location noted.
SharePoint Upgrade Sharepoint 2013 To Sharepoint 2016 Through Workflow Manager https://github.com/MicrosoftDocs/OfficeDocs-SharePoint/commits/public/SharePoint/SharePointServer/administration/upgrade-sharepoint-2013-to-sharepoint-2016-through-workflow-manager.md
Consider the following scenario:
- You have recently connected sites in the farm to a previously existing instance of Workflow Manager.
-In this scenario, workflows that are created after you connect to the Workflow Manager installation finish successfully. However, workflows that are created before you connect to Workflow Manager donΓÇÖt finish. Instead, they get stuck when they try to finish or they remain in a suspended state. For workflows that remain suspended, you receive an HTTP 500 error. Additionally, the following entry is logged in the ULS log: *Cannot get app principal permission information.*
+In this scenario, workflows that are created after you connect to the Workflow Manager installation finish successfully. However, workflows that are created before you connect to Workflow Manager don't finish. Instead, they get stuck when they try to finish or they remain in a suspended state. For workflows that remain suspended, you receive an HTTP 500 error. Additionally, the following entry is logged in the ULS log: *Cannot get app principal permission information.*
### Cause
To get the SPAuthenticationRealm value of ApplicationID that's stored in the sco
Where \<WebID> is the placeholder for the ID of the SPWeb object.
-2. In the query result, click the value in the SecuritySettings column to open the XML on a separate tab in SQL Server Management Studio.
+2. In the query result, click the value in the SecuritySettings column to open the XML on a separate tab in SQL Server Management Studio.
3. In the XML file, located the ApplicationID element that contains the value. For example, locate the following element:
SharePoint Upgrade Sharepoint 2016 To Sharepoint 2019 Through Workflow Manager https://github.com/MicrosoftDocs/OfficeDocs-SharePoint/commits/public/SharePoint/SharePointServer/administration/upgrade-sharepoint-2016-to-sharepoint-2019-through-workflow-manager.md
Consider the following scenario:
- You have recently connected sites in the farm to a previously existing instance of Workflow Manager.
-In this scenario, workflows that are created after you connect to the Workflow Manager installation finish successfully. However, workflows that are created before you connect to Workflow Manager donΓÇÖt finish. Instead, they get stuck when they try to finish or they remain in a suspended state. For workflows that remain suspended, you receive an HTTP 500 error. Additionally, the following entry is logged in the ULS log: *Cannot get app principal permission information.*
+In this scenario, workflows that are created after you connect to the Workflow Manager installation finish successfully. However, workflows that are created before you connect to Workflow Manager don't finish. Instead, they get stuck when they try to finish or they remain in a suspended state. For workflows that remain suspended, you receive an HTTP 500 error. Additionally, the following entry is logged in the ULS log: *Cannot get app principal permission information.*
### Cause
To get the SPAuthenticationRealm value of ApplicationID that's stored in the sco
Where \<WebID> is the placeholder for the ID of the SPWeb object.
-2. In the query result, click the value in the SecuritySettings column to open the XML on a separate tab in SQL Server Management Studio.
+2. In the query result, click the value in the SecuritySettings column to open the XML on a separate tab in SQL Server Management Studio.
3. In the XML file, located the ApplicationID element that contains the value. For example, locate the following element:
SharePoint View Data In The Logging Database https://github.com/MicrosoftDocs/OfficeDocs-SharePoint/commits/public/SharePoint/SharePointServer/administration/view-data-in-the-logging-database.md
If you want to view logs by using tools other than Management Studio, you can ex
3. Expand the **Views** node, right-click the view from which you want to extract data, and then click **Select Top 1000 Rows**.
-4. In the result window, right-click, and then click **Select All**. Then right-click and then click **Save Results As…**.
+4. In the result window, right-click, and then click **Select All**. Then right-click and then click **Save Results As...**.
5. In the **Save Grid Results** window, specify the folder in which you want to save the file, specify the **Save as type** as CSV(Comma delimited), and then specify an appropriate file name.
SharePoint Web Content Management Capacity And Performance https://github.com/MicrosoftDocs/OfficeDocs-SharePoint/commits/public/SharePoint/SharePointServer/administration/web-content-management-capacity-and-performance.md
Title: "Estimate capacity and performance for Web Content Management (SharePoint Server 2013)"-+
description: "Learn how to determine the number and types of computers that you
# Estimate capacity and performance for Web Content Management (SharePoint Server 2013) [!INCLUDE[appliesto-2013-xxx-xxx-xxx-xxx-md](../includes/appliesto-2013-xxx-xxx-xxx-xxx-md.md)]
-
+ Enterprises often use SharePoint Server 2013 to publish content that anonymous users access on an Internet site or that authenticated users access on an intranet site. This article contains capacity and performance data to help plan the number of computers to use and the types of computers that are required to publish content and manage web content in SharePoint Server 2013.
-
-
++ SharePoint publishing includes different types of publishing sites and associated methods that are available for each site. The publishing features of SharePoint Server 2013 are intended to help create branded Internet, intranet, and extranet sites. For more information about SharePoint Server 2013 publishing, see [Overview of publishing to Internet, intranet, and extranet sites in SharePoint Server](overview-of-publishing-to-internet-intranet-and-extranet-sites.md).
-
+ ## Introduction <a name="intro"> </a>
-This article discusses the following scenarios:
-
+This article discusses the following scenarios:
+ - **Internet presence site**
-
+ Provides information to customers, partners, investors, and potential employees. This type of site lets anonymous Internet users find information about a corporation. Typically, these sites are branded and the company tightly controls the content.
-
+ - **Internet business site**
-
+ Promotes products and services that a company offers to customers. These sites can show a catalog of products that the company offers.
-
+ - **Intranet site**
-
+ A company publishes this site internally inside an organization. These sites share information for authenticated users and companies either tightly manage the site to restrict access or open to all jnternal users.
-
+ - **Extranet site**
-
+ Provides access to targeted content to remote employees, partners, and customers. These sites can provide access to knowledge bases that use authored content tagged with metadata to categorize articles. Users can search or browse for specific information such as troubleshooting and support articles.
-
- Cross-Site Collection Publishing and the Content Search Web Part enable content reuse across site collections in these scenarios. These features and functionality affect how you plan for capacity. For more information, see [Overview of cross-site publishing in SharePoint Server](overview-of-cross-site-publishing.md).
-
+
+ Cross-Site Collection Publishing and the Content Search Web Part enable content reuse across site collections in these scenarios. These features and functionality affect how you plan for capacity. For more information, see [Overview of cross-site publishing in SharePoint Server](overview-of-cross-site-publishing.md).
+ > [!NOTE]
-> Cross-Site Collection Publishing is known as cross-site publishing in this article.
-
- Managed navigation in SharePoint Server 2013 provides taxonomy-driven navigation for a publishing site. For more information, see [Overview of managed navigation in SharePoint Server](overview-of-managed-navigation.md).
-
+> Cross-Site Collection Publishing is known as cross-site publishing in this article.
+
+ Managed navigation in SharePoint Server 2013 provides taxonomy-driven navigation for a publishing site. For more information, see [Overview of managed navigation in SharePoint Server](overview-of-managed-navigation.md).
+ The capacity and performance data in this article contain two parts. The first part is the new cross-site publishing method and managed navigation. The second part uses the author-in-place model.
-
+ > [!NOTE]
-> The scenarios that are addressed in this article can be achieved by both cross-site publishing and author-in-place sites. The cross-site publishing and managed navigation features do not depend on one another and can be used independently.
-
+> The scenarios that are addressed in this article can be achieved by both cross-site publishing and author-in-place sites. The cross-site publishing and managed navigation features do not depend on one another and can be used independently.
+ The following two key metrics are addressed in the models that are used in this article:
-
+ - **Throughput**
-
+ The number of page views per second that the site can sustain
-
+ - **Server Response Time**
-
+ The time that is required for the server to process a request, affecting the time it takes for a user to view the page. The server response times that we provide in this document are the 95th and 50th percentile values. These values mean that 95 percent and 50 percent of requests are faster than the value that is provided, respectively. We measure these values by using the "Duration" recorded in the SharePoint Usage database for a given request.
-
+ - **Content freshness**
-
+ The time that is required for an updated item to be reflected in search results is a good metric to consider when you work with cross-site publishing scenarios.
-
+ The scenarios in this article use the following two states:
-
+ - **Green Zone**
-
+ The servers are under 60 percent utilization. This should be the target for most of the time that the servers are running.
-
+ - **Red Zone**
-
+ The servers are close to full utilization. This can be considered a state where the SharePoint site is under more load than usual. In the Red Zone, the server response time values start to increase as the server tries to meet the demand of incoming requests.
-
+ ## Prerequisite information <a name="prereq"> </a> Before you read this article, make sure that you understand the key concepts behind SharePoint Server 2013 capacity management. The following articles help you learn about the recommended approach to capacity management and provide context to help you understand how to make effective use of the information in this article.
-
+ Note that some other new features that affect publishing scenarios functionally do not appear in this article. These scenarios include device channels, SEO optimization, display templates and query rules. Additionally, the functionality and configuration of a cross-site publishing site is not described in detail in this article. For more information, see [Plan for cross-site publishing in SharePoint Server](plan-for-cross-site-publishing.md) and [Configure web content management solutions in SharePoint Server](configure-web-content-management-solutions.md).
-
+ For more information about capacity and performance to help understand the data in this article, see [Performance planning in SharePoint Server 2013](performance-planning-in-sharepoint-server-2013.md).
-
+ ## Cross-site publishing using managed navigation <a name="crosssite"> </a>
-This section provides our test data for two areas: cross-site publishing with anonymous users and author-in-place publishing.
-
+This section provides our test data for two areas: cross-site publishing with anonymous users and author-in-place publishing.
+ ### Cross-site publishing with Anonymous users Test results in this section are based on a basic cross-site publishing site model to provide capacity planning guidance. When you plan a SharePoint deployment for anonymous users to access a web site, use this guidance and adjust your deployment specifications accordingly.
-
+ The test case in our tests uses the cross-site publishing feature. This scenario provides content in multiple site collections that are marked as catalogs, and then crawled by the SharePoint Search Service application. Web Parts that use search technology, for example the Content Search Web Part, and the Catalog-Item Reuse Web Part, display content on pages in another site. For more information, see [Overview of cross-site publishing in SharePoint Server](overview-of-cross-site-publishing.md).
-
+ We used the following characteristics in the model site, which we built to test cross-site publishing:
-
+ - Publishing web site that has approximately 5 million pages or items.
-
+ - The items are associated with about 1,000 categories.
-
+ - The content is located in other site collections in one or more catalogs.
-
+ - The web site uses managed navigation that is linked to the categories that the items are associated with.
-
+ - For the baseline deployment topology described later in this list, the web site receives up to 80 page views per second on average. Peak periods reach up to 100 page views per second. To scale this throughput number up, add computes to the topology. To scale this throughput number down, remove computers from the topology.
-
+ - The Search crawler runs with continuous crawls for a 1-minute interval with five updates per second to the catalog.
-
+ - The web site has the following page and traffic patterns:
-
+ - Home page that has three Content Search Web Parts and a Refinement Panel Web Part (receives 15 percent of the traffic).
-
+ - Category pages that have three Content Search Web Parts, one Taxonomy Refinement Panel Web Part, and one Refinement Panel Web Part receive 45 percent of the traffic.
-
+ - Catalog Item pages that have Catalog-Item Reuse Web Part and two Content Search Web Parts receive 40 percent of the traffic.
-
+ - Each Content Search and Catalog-Item Reuse Web Part issues a synchronous query.
-
+ - The catalog item pages do not use the Anonymous Search Results Cache because they receive a small amount of traffic.
-
-- The farm has the binary large object (BLOB) cache turned on for the computers that are run as the front-end web servers.
-
-The server topology that we used to test this scenario is in the following diagram:
-
+
+- The farm has the binary large object (BLOB) cache turned on for the computers that are run as the front-end web servers.
+
+The server topology that we used to test this scenario is in the following diagram:
+ **Figure 1: Test lab server topology** ![Diagram of the test server topology, 2 computers host SQL and SharePoint Servers; 1 computer hosts Search crawler and content processing (CPC) role; 3 computers host Search index with query processing as front-end web servers.](../media/ECMCapacityTopo.gif)
-
+ - one computer that hosts SQL Server with all of the databases that SharePoint uses
-
+ - one computer that hosts SharePoint service applications, distributed cache service, search analytics processing, and search administration roles
-
+ - one computer that hosts the search crawler and content processing (CPC) roles
-
+ - three computers that host search index nodes with query processing and serve as front-end web servers
-
+ > [!NOTE]
-> The computers in this test are physical computers that run Windows Server 2008 R2. Refer to the Search capacity planning and [Capacity planning for SharePoint Server 2013](capacity-planning.md) for recommendations about how to use virtual machines and Windows Server 2012.
-
+> The computers in this test are physical computers that run Windows Server 2008 R2. Refer to the Search capacity planning and [Capacity planning for SharePoint Server 2013](capacity-planning.md) for recommendations about how to use virtual machines and Windows Server 2012.
+ > [!IMPORTANT]
-> The configuration for our test lab topology is optimized for search-driven publishing scenarios. This configuration is different from collaboration types of SharePoint deployments. For example, our configuration uses the front-end web servers as search index servers to get the best performance. > In our test lab topology we learned that the computer that hosts the application server was underutilized. As a result, we put the Distributed Cache Service on this application server instead of on a dedicated server. You may decide to host the Distributed Cache Service on a dedicated server in your environment. For best performance we do not recommend that you host the Distributed Cache Service on a front-end web server that has the search index server role.
-
+> The configuration for our test lab topology is optimized for search-driven publishing scenarios. This configuration is different from collaboration types of SharePoint deployments. For example, our configuration uses the front-end web servers as search index servers to get the best performance. > In our test lab topology we learned that the computer that hosts the application server was underutilized. As a result, we put the Distributed Cache Service on this application server instead of on a dedicated server. You may decide to host the Distributed Cache Service on a dedicated server in your environment. For best performance we do not recommend that you host the Distributed Cache Service on a front-end web server that has the search index server role.
+ ### Test lab reports We used the topology in figure 1 for our test lab with physical computers and a Visual Studio Team System (VSTS) load test. For more information, see [Visual Studio Team System](/azure/devops/user-guide/devops-alm-overview?toc=%2fazure%2fdevops%2fuser-guide%2ftoc.json&viewFallbackFrom=vsts). Technical specifications for the test computers are in the following tables.
-
+ > [!NOTE]
-> We did not use browser caching or dependent requests, such as images or JavaScript files in our VSTS tests. Depending on how you customize your publishing site, the amount of dependent requests that occur can vary considerably. > The pages that we used in our tests made almost 50 page load time 1 (PLT1) request types (empty browser cache) and about 3 requests for PLT2 request types (subsequent requests with results from the browser cache). Usually, SharePoint BLOB Cache serves requests for these items and will not alter our performance numbers significantly.
-
-|**Server Components**|**Servers running SharePoint Server**|
-|:--|:--|
-|**Processors** <br/> |Intel Xeon CPUs @2.27GHz (2 processors, 8 cores total, 16 threads total) <br/> |
-|**RAM** <br/> |24 GB <br/> |
-|**Operating system** <br/> |Windows Server 2008 R2 Enterprise SP1, 64-bit <br/> |
-|**Size of the SharePoint drive** <br/> |200 GB on internal disk <br/> |
-|**Storage used for Search Index** <br/> |78 GB on an external disk array (2 x Dell PERC H700 SCSI) <br/> |
-|**Number of network adapters** <br/> |2 <br/> |
-|**Network adapter speed** <br/> |1 gigabit <br/> |
-|**Authentication** <br/> |None ΓöÇ Anonymous <br/> |
-|**Software version** <br/> |SharePoint Server 2013 <br/> |
-
-|**Server Components**|**Database servers**|
-|:--|:--|
-|**Processors** <br/> |Intel Xeon CPUs L5520 @2.27GHz (2 processors, 8 cores total, 16 threads total <br/> |
-|**RAM** <br/> |24 GB <br/> |
-|**Operating system** <br/> |Windows Server 2008 R2 Enterprise SP1, 64-bit <br/> |
-|**Disk Array** <br/> |2 x Dell H700 SCSI <br/> |
-|**Number of network adapters** <br/> |2 <br/> |
-|**Network adapter speed** <br/> |1 gigabit <br/> |
-|**Authentication** <br/> |NTLM <br/> |
-|**Software version** <br/> |Microsoft SQL Server 2008 R2 SP1 <br/> |
-
+> We did not use browser caching or dependent requests, such as images or JavaScript files in our VSTS tests. Depending on how you customize your publishing site, the amount of dependent requests that occur can vary considerably. > The pages that we used in our tests made almost 50 page load time 1 (PLT1) request types (empty browser cache) and about 3 requests for PLT2 request types (subsequent requests with results from the browser cache). Usually, SharePoint BLOB Cache serves requests for these items and will not alter our performance numbers significantly.
+
+|Server Components|Servers running SharePoint Server|
+|||
+|**Processors**|Intel Xeon CPUs @2.27GHz (2 processors, 8 cores total, 16 threads total)|
+|**RAM**|24 GB|
+|**Operating system**|Windows Server 2008 R2 Enterprise SP1, 64-bit|
+|**Size of the SharePoint drive**|200 GB on internal disk|
+|**Storage used for Search Index**|78 GB on an external disk array (2 x Dell PERC H700 SCSI)|
+|**Number of network adapters**|2|
+|**Network adapter speed**|1 gigabit|
+|**Authentication**|None - Anonymous|
+|**Software version**|SharePoint Server 2013|
+
+|Server Components|Database servers|
+|||
+|**Processors**|Intel Xeon CPUs L5520 @2.27GHz (2 processors, 8 cores total, 16 threads total|
+|**RAM**|24 GB|
+|**Operating system**|Windows Server 2008 R2 Enterprise SP1, 64-bit|
+|**Disk Array**|2 x Dell H700 SCSI|
+|**Number of network adapters**|2|
+|**Network adapter speed**|1 gigabit|
+|**Authentication**|NTLM|
+|**Software version**|Microsoft SQL Server 2008 R2 SP1|
+ Results from a 10 minute run are as follows:
-
-|**Test Features**|**Green Zone**|**Red Zone**|
-|:--|:--|:--|
-|**Number of VSTS users (simulating concurrent users):** <br/> |60 <br/> |100 <br/> |
-|**Server Response Time 50th percentile\*:** <br/> |219 ms. <br/> |302 ms. <br/> |
-|**Server Response Time 95th percentile\*:** <br/> |412 ms. <br/> |635 ms. <br/> |
-|**Page views per second:** <br/> |78 <br/> |98 <br/> |
-
+
+|Test Features|Green Zone|Red Zone|
+||||
+|**Number of VSTS users (simulating concurrent users):**|60|100|
+|**Server Response Time 50th percentile\*:**|219 ms.|302 ms.|
+|**Server Response Time 95th percentile\*:**|412 ms.|635 ms.|
+|**Page views per second:**|78|98|
+ This is a cross-site publishing scenario that displays content from the search index. It may be interesting to examine the number of queries that the servers that host search queries serve, and the number of queries that the Anonymous Results Cache serves. In this model, the Anonymous Results Cache serves about 60 percent of the queries. The Anonymous Results Cache is discussed later in this article.
-
-|**Test Features**|**Green Zone**|**Red Zone**|
-|:--|:--|:--|
-|**Total queries per second:** <br/> |235 <br/> |294 <br/> |
-|**Queries served from Anonymous Results Cache:** <br/> |145 <br/> |182 <br/> |
-|**Queries served from Search:** <br/> |90 <br/> |112 <br/> |
-
+
+|Test Features|Green Zone|Red Zone|
+||||
+|**Total queries per second:**|235|294|
+|**Queries served from Anonymous Results Cache:**|145|182|
+|**Queries served from Search:**|90|112|
+ The values for the average CPU and peak memory usage for these computers while the tests were running are as follows:
-
-|**Test Features**|**Green Zone**|**Red Zone**|
-|:--|:--|:--|
-|**Average CPU (Search index nodes per front-end web server)** <br/> |59% <br/> |80% <br/> |
-|**Average CPU (application server including Distributed Cache)** <br/> |8% <br/> |9% <br/> |
-|**Average CPU (Search CPC nodes)** <br/> |5% <br/> |5% <br/> |
-|**Average CPU (SQL Server)** <br/> |Not measured <br/> |Not measured <br/> |
-|**Peak Memory usage (Search index nodes per front-end web server)** <br/> |7.5 GB <br/> |7.5 GB <br/> |
-|**Peak memory usage (application server including Distributed Cache)** <br/> |10.1 GB <br/> |10 GB <br/> |
-|**Peak memory usage (Search CPC nodes)** <br/> |6.5 GB <br/> |6.5 GB <br/> |
-
+
+|Test Features|Green Zone|Red Zone|
+||||
+|**Average CPU (Search index nodes per front-end web server)**|59%|80%|
+|**Average CPU (application server including Distributed Cache)**|8%|9%|
+|**Average CPU (Search CPC nodes)**|5%|5%|
+|**Average CPU (SQL Server)**|Not measured|Not measured|
+|**Peak Memory usage (Search index nodes per front-end web server)**|7.5 GB|7.5 GB|
+|**Peak memory usage (application server including Distributed Cache)**|10.1 GB|10 GB|
+|**Peak memory usage (Search CPC nodes)**|6.5 GB|6.5 GB|
+ Note that the memory usage may differ somewhat because various timer jobs run on the server during normal usage. We found that the index/front-end web server nodes were using as much as 12 GB of memory after a two week test run with a sustained load.
-
+ #### How Search Web Parts display content on cross-site publishing pages If a publishing page contains a Search Web Part, such as the Content Search Web Part, the browser starts to process the page before the search query is complete. This improves the perceived latency of the page. After the search query finishes, the complete results of the query are sent to the browser, and the connection to the browser is closed. Users might think that the search results are loaded asynchronously. However, the queries are still issued from the server while the page is being requested.
-
+ Note that there is a separate asynchronous mode for the Content Search Web Part, where the queries are issued from the browser after a page is loaded.
-
+ #### Effect of load changes on your cross-site publishing site We varied the number of VSTS users (similar to the number of concurrent users who access the site) who were used in the load test. The following graph shows that the server response time increases as load increases, and there is some incremental increase in number of pages served per second. We recommend that the server response times are kept under 750 ms. to make sure that users have a responsive experience with the SharePoint deployment.
-
+ **Figure 2: Chart showing throughput and server response times with different loads** ![Excel graph showing the server response time increases when loads are increased with some incremental increase of number of pages served per second.](../media/ECMCapacity_ChangeLoad.gif)
-
+ #### Scaling out your cross-site publishing site If the SharePoint deployment is expected to receive more or less traffic compared to the baseline case described earlier, you may want to change the number of computers that are running with the Index and front-end web server role on the farm to accommodate that traffic. The following graph shows the results for scaling out the same cross-site publishing site that has different load patterns and varying number of computers that are used as front-end web servers with Index nodes, starting with a single computer in the front-end web server role with Index nodes, and going up to six computers:
-
+ **Figure 3: Scaling out your deployment** ![Excel graph showing results of scaling out a cross-site publishing site with different load patterns and varying number of computers used as front-end web servers with Index nodes and starting with a single computer and ending with 6 computers.](../media/ECMCapacityScaleSearch.gif)
-
+ In each of the configurations, we adjusted the load to have server response times at similar values compared to the baseline in the previous section.
-
+ Note that as number of computers increased, the complexity of the topology starts to overtake the gains. Each additional computer has less throughput compared to computers that are already in the environment. These numbers are provided to show the pattern for scaling out. Actual performance will change depending on how the SharePoint deployment is built.
-
+ #### Guidelines to plan your site The majority of our performance testing used the deployment that was described in the earlier sections. The guidelines in the following list are meant to help you make correct capacity planning decisions when your deployments differ from the ones we used in our test lab.
-
-- More items in the search index generally mean higher latency. Each index partition can contain up to 10 million items. Typical websites rarely have more than 10 million items to show. So they only need one partition as in the topology we described earlier. You can use more index partitions to either host more than 10 million items or to have more, smaller, and faster index partitions. If you plan to use multiple index partitions, refer to [Scale search for Internet sites in SharePoint Server](../search/scale-search-for-internet-sites.md) to correctly size your search topology.
-
+
+- More items in the search index generally mean higher latency. Each index partition can contain up to 10 million items. Typical websites rarely have more than 10 million items to show. So they only need one partition as in the topology we described earlier. You can use more index partitions to either host more than 10 million items or to have more, smaller, and faster index partitions. If you plan to use multiple index partitions, refer to [Scale search for Internet sites in SharePoint Server](../search/scale-search-for-internet-sites.md) to correctly size your search topology.
+ - Each control or Web Part that you add to a page (or page layout) will add some overhead to the server response time for the page.
-
+ - Avoid using more than five synchronous Content Search Web Parts or Catalog-Item Reuse Web Parts on a page. While processing a request for a page, SharePoint Server 2013 executes as many as five queries in parallel and returns the results. If more than five queries are on a page, SharePoint Server 2013 executes the first five queries before it starts to execute the next set of five queries. If pages require more than five Content Search Web Parts or Catalog-Item Reuse Web Parts, you might run the additional Content Search Web Parts in asynchronous mode or use query rules and result blocks.
-
+ - Content Search Web Parts and Catalog-Item Reuse Web Parts have an asynchronous mode. The query that is associated with the Web Part is executed after the browser loads the page. Use this mode for slow queries so that the rest of the page appears faster for users. Otherwise, we recommend that you use synchronous queries for best page load times.
-
+ - A Refinement Panel Web Part that has many refiners increases the time to process a query. You can change the number of refiners to show for a managed property. For more information, see [Configure refiners and faceted navigation in SharePoint Server](configure-refiners-and-faceted-navigation.md)
-
+ - If you use the Taxonomy Refinement Panel Web Part when you have a deep hierarchy of navigation nodes, the time to process a query increases. We do not recommend the use of the Taxonomy Refinement Panel Web Part on a page that has more than 200 navigation nodes under it. The large number of navigation nodes may cause slow server response times and decrease throughput.
-
+ - If you must design a SharePoint deployment for high availability, you must add the following:
-
+ - An additional computer that runs with the service applications in distributed cache roles in case the existing computer is not available
-
+ - Additional computers to sustain the load if one or more of the front-end web server computers with Index nodes are not available
-
+ - An additional computer in the CPC roles to make sure updates are still reflected in your site when the computer that has the CPC role is not available
-
+ - A SQL Server topology that continues to serve database queries if one of the database servers is not available
-
+ #### Search crawl speed and content freshness In our testing, we also conducted tests for the process that updates the catalog content that was being published. We then observed the amount of time that elapsed before an updated item appeared in the publishing site. In our experiments, we made five updates per second to the catalog and set the continuous crawls on the catalog to a one minute interval. We observed that the average time for the changes to appear in the publishing site were about two minutes. The minimum time was just under a minute and the maximum time was three minutes. We did not see a significant change from these numbers when we increased the number of computers that were running with the CPC role.
-
+ For the full crawl of the catalog, however, an increase in the number of computers that are running with the CPC role increased the number of items processed per second. The following graph shows the relationship of items processed per second and the number of computers in the farm with the CPC role. Note that this test data was obtained from a SharePoint deployment other than the one used in the baseline tests. The findings should apply to the SharePoint deployments because the addition of more CPC nodes results in improved full crawl times.
-
+ **Figure 4: Effect of content processing (CPC) computers on a full crawl** ![Excel graph shows relationship of items processed per second and the number of computers in the content processing role (CPC). Increasing the number of computers with CPC role increases number of items processed per second and improves full crawl times.](../media/ECMCapacityCPCEffect.gif)
-
+ Therefore, if you require faster full crawls for your catalogs, you can increase the number of computers that use the CPC role in your deployment.
-
+ #### Load on Managed Metadata Service application Our testing shows that publishing scenarios that involve sites that use managed navigation do not have significant memory or CPU requirements on the Managed Metadata service application. For a deployment such as the one we have described earlier, the Managed Metadata service application can be run on a computer that is running other SharePoint service applications. The Managed Navigation feature makes one connection to the service application when it receives the first request for a site. Subsequent requests use values that front-end web servers cache. Therefore there is no load on the Managed Metadata service application while front-end web servers fulfill requests.
-
+ #### Anonymous Search Results Cache <a name="anon"> </a> The Anonymous Search Results Cache stores results of a query, refinement data for the query, and additional result tables that are returned from the SharePoint Distributed Cache Service. Each cache entry depends on the parameters of a query, such as the sort order of the results, the requested refiners, and any dynamic reordering rules. The cache affects all queries that a web application handles including queries from Search Web Parts and the queries from CSOM clients. For more information, see [Overview of search architecture in SharePoint Server](../search/search-architecture-overview.md) and [Scale search for Internet sites in SharePoint Server](../search/scale-search-for-internet-sites.md).
-
+ This cache is not used for queries that are authenticated because of security concerns.
-
+ We recommend that you configure the Distributed Cache Service to run only on the computer that runs the SharePoint service applications for best results. The Distributed Cache Service should not run on the computers that are in the front-end web server roles.
-
+ By default, the Anonymous Search Results Cache refreshes items every 15 minutes. You can use Microsoft PowerShell to configure the cache duration on the web application where the cache is configured:
-
+ ```
-$webapp.Properties["SearchResultsCacheTTL"] = <number of seconds to keep in cache>
+$webapp.Properties["SearchResultsCacheTTL"] = <number of seconds to keep in cache>
$webapp.Update() ``` If you want search results to be fresher than the default value, you lower the value. Note that this increases the number of queries that the Search service will need to serve.
-
+ We recommend that you always use the cache on publishing pages that receive heavy traffic. Some examples for these types of pages are the site home page and category pages that use Search Web Parts. We do not recommend caching for catalog item pages. Because an individual catalog item page would be accessed much less frequently than a home page, and it may not be worthwhile to store the item in cache.
-
+ When we turned off the Anonymous Search Results Cache in our test environment that has the same load patterns, server response times increased significantly and throughput in number of page views per second declined. Here's a graph that shows this relationship:
-
+ **Figure 5: Effect of Anonymous Search Results Cache** ![Excel graph shows that turning off Anonymous Search Results Cache in front-end web servers increases server response times and reduces throughput in terms of number of page views per second.](../media/ECMCapacityAnonSearchEffect.gif)
-
+ By default, Content Search Web Parts are configured to use the Anonymous Search Results Cache. Catalog-Item Reuse Web Parts, which are used on catalog item pages, are not configured to use it due to the sparse access patterns these pages generally exhibit.
-
+ To configure the caching behavior for an individual Web Part to use (or not use) the Anonymous Search Results Cache, set the value of the sub-property "TryCache" in the `DataProviderJSON` property of the Web Part. If the value is "true", the query uses the cache. If the value is "false", the query does not use the cache for Anonymous search queries.
-
+ #### Effect of output cache <a name="anon"> </a> Output caching is an effective way to reduce the load on SharePoint Server 2013 in publishing scenarios. For more details about how Output Cache works in this article, see [Output Caching and Cache Profiles](/previous-versions/office/developer/sharepoint-2010/aa661294(v=office.14)).
-
+ A SharePoint deployment may benefit from Output Caching to reduce the load on SharePoint content databases and the search service application. Here are some example situations:
-
+ - You are receiving lots of traffic on some of your pages.
-
+ - You are receiving lots of traffic on SharePoint content databases,
-
+ - Computers that serve search queries are running with high CPU utilization.
-
+ We recommend that you use Output Caching for very popular pages on your site, such as the site's home page or top level category pages and certain item pages that receive large amounts of traffic.
-
+ > [!IMPORTANT]
-> There is a known issue in SharePoint Server 2013 when pages that have Output Caching enabled also contain Content Search Web Parts. To avoid this issue in your deployment, install [SharePoint Server 2013 update: March 12, 2013](https://go.microsoft.com/fwlink/p/?LinkID=286308).
-
-The following graph shows some results from our test environment where we use Output Caching on the homepage and category pages that receive 60 percent of the site traffic.
-
+> There is a known issue in SharePoint Server 2013 when pages that have Output Caching enabled also contain Content Search Web Parts. To avoid this issue in your deployment, install [SharePoint Server 2013 update: March 12, 2013](https://go.microsoft.com/fwlink/p/?LinkID=286308).
+
+The following graph shows some results from our test environment where we use Output Caching on the homepage and category pages that receive 60 percent of the site traffic.
+ **Figure 6: Effect of output caching for home page and category pages** ![Excel grpah showing the effects of turning off Output Caching for home pages and category pages in both the Green and Red Zones of our test environment.](../media/ECMCapacityOutputCacheEffect.gif)
-
+ > [!NOTE]
-> Content Search Web Parts have a setting to run in asynchronous mode. Output Caching does not apply to the load from asynchronous Content Search Web Parts.
-
+> Content Search Web Parts have a setting to run in asynchronous mode. Output Caching does not apply to the load from asynchronous Content Search Web Parts.
+ #### Usage analytics processing <a name="anon"> </a> To have information about usage analytics ready to use, SharePoint Server 2013 processes information that's in the usage database. In our topology Analytics Processing occurs on the node that contains the Search Admin node, Distributed Cache service and other service applications. For more information, see [Overview of analytics processing in SharePoint Server](../search/overview-of-analytics-processing.md)
-
+ We took some analytics processing time measurements by using the cross-site publishing site that we used in our earlier tests. We measured the time that SharePoint Server 2013 takes to process a large amount of click events on the pages in the site. While these results are from a cross-site publishing site, they also apply to sites that use the author-in-place publishing method.
-
+ For our tests around usage analytics processing, we generated the following mock events, every day for a week:
-
+ - 27.5 million click events spread across 3 million list items and 400,000 users.
-
+ Zipf distribution was used so that some items and users have many events, but others have less.
-
+ This generated a total of 7.5 million events per day, simulating different users generating different traffic patterns for the site.
-
+ We triggered the analysis runs seven times to simulate one week of traffic. We ran the Usage Analytics job every day for the data that we accumulated over six days. Then we measured the time, the seventh day took. The seventh day will be the day that takes longest to process as the complete week's items are processed and the relationship graph is updated. The runtime and disk usage for Day 8 will resemble Day 1.
-
+ The analytics processing did not have a significant impact on the computer that it ran on, and we continued to successfully serve queries and keep content fresh on the search-driven site.
-
+ The results are summarized in the following table:
-
-|**Test Schedule**|**Update Relationship Graph**|**Runtime (hours)**|**Total Peak Disk Usage**|**Usage Analytics Peak Disk Usage**|
-|:--|:--|:--|:--|:--|
-|**Day 1** <br/> |No <br/> |02:35 <br/> ||2.65 GB <br/> |
-|**Day 2** <br/> |No <br/> |02:43 <br/> |||
-|**Day 3** <br/> |No <br/> |03:23 <br/> |||
-|**Day 4** <br/> |No <br/> |04:39 <br/> |||
-|**Day 5** <br/> |No <br/> |06:08 <br/> |||
-|**Day 6** <br/> |No <br/> |07:35 <br/> |||
-|**Day 7** <br/> |Yes <br/> |08:29 <br/> |82.4 GB <br/> |4 GB <br/> |
-
+
+|Test Schedule|Update Relationship Graph|Runtime (hours)|Total Peak Disk Usage|Usage Analytics Peak Disk Usage|
+||||||
+|**Day 1**|No|02:35||2.65 GB|
+|**Day 2**|No|02:43|||
+|**Day 3**|No|03:23|||
+|**Day 4**|No|04:39|||
+|**Day 5**|No|06:08|||
+|**Day 6**|No|07:35|||
+|**Day 7**|Yes|08:29|82.4 GB|4 GB|
+ The following graph displays the runtimes for the different days:
-
+ **Figure 7: Runtime hours per day** ![Excel bar chart showing the 7 different test days and the amount of time that we tested each day. Day 1 we tested for 2 hours and 35 minutes, and ended on day 7 with 8 hours and 29 minutes of testing.](../media/ECMCapacityRuntimeHrs.gif)
-
+ #### Cross-site publishing with authenticated users <a name="anon"> </a>
- SharePoint publishing is used commonly on intranet sites. By using SharePoint Server 2013, these sites can also be powered by cross-site publishing. The following sections show some important distinctions to consider when you plan for a cross-site publishing site that uses authenticated users. Other than the exceptions mentioned in the following sections, the rules that apply to anonymously accessed sites still apply to sites that authenticated users access.
-
+ SharePoint publishing is used commonly on intranet sites. By using SharePoint Server 2013, these sites can also be powered by cross-site publishing. The following sections show some important distinctions to consider when you plan for a cross-site publishing site that uses authenticated users. Other than the exceptions mentioned in the following sections, the rules that apply to anonymously accessed sites still apply to sites that authenticated users access.
+ #### Lack of Anonymous Search Results Cache
-As mentioned in the [Anonymous Search Results Cache](#anon) section earlier, this cache only takes effect for users who are accessing the SharePoint site anonymously. Compared to anonymously accessed sites that use the Anonymous Search Results Cache, the throughput capacity of sites that are accessed by authenticated users will be significantly lower. Typically intranet sites rarely receive loads as high as the ones mentioned in the previous section (up to 100 page views / second). However, this is an important distinction to consider.
-
+As mentioned in the [Anonymous Search Results Cache](#anon) section earlier, this cache only takes effect for users who are accessing the SharePoint site anonymously. Compared to anonymously accessed sites that use the Anonymous Search Results Cache, the throughput capacity of sites that are accessed by authenticated users will be significantly lower. Typically intranet sites rarely receive loads as high as the ones mentioned in the previous section (up to 100 page views / second). However, this is an important distinction to consider.
+ Use of the output cache can ease the lack of Anonymous Search Results Cache to a degree for these scenarios. Cross-site publishing sites that expect multiple page views per second should consider enabling output cache for their sites.
-
+ > [!IMPORTANT]
-> Content Search Web Parts have a setting that, if it is enabled, causes them to run in asynchronous mode. The output cache does not apply to the load from asynchronous Content Search Web Parts.
-
+> Content Search Web Parts have a setting that, if it is enabled, causes them to run in asynchronous mode. The output cache does not apply to the load from asynchronous Content Search Web Parts.
+ #### Larger Search index
-Depending on the size of the enterprise that deploys SharePoint Server 2013, intranet deployments for SharePoint Server 2013 will typically index larger numbers of documents. This means that the required Search topology to index those documents will be different compared to the topology described in the previous section. Refer to [Plan search in SharePoint Server](../search/search-planning.md) to size your SharePoint deployment appropriately.
-
+Depending on the size of the enterprise that deploys SharePoint Server 2013, intranet deployments for SharePoint Server 2013 will typically index larger numbers of documents. This means that the required Search topology to index those documents will be different compared to the topology described in the previous section. Refer to [Plan search in SharePoint Server](../search/search-planning.md) to size your SharePoint deployment appropriately.
+ ## Author-in-place publishing <a name="author"> </a> This section provides guidance and results that use SharePoint Server 2013, but it does not detail the different features that affect capacity planning. For details in this area, see [Web content management in SharePoint Server](web-content-management.md).
-
+ ### Author-in-place publishing with anonymous users For our tests we worked with a website that has the following characteristics:
-
+ - Website with up to 20,000 article pages divided into 20 folders of 1,000 pages each across 50 sites in a single site collection.
-
+ - The site uses structured navigation.
-
+ - The site generally receives a minimum of 50 to 100 page views per second.
-
+ - Traffic patterns hit the following mix of pages:
-
+ - 20 pages that contain a single Content Query Web Part that issues content database queries of varying scopes (20 percent of the traffic)
-
+ - 30 pages that include multiple Content Query Web Parts that issue content database queries of varying scopes (30 percent of the traffic)
-
+ - 1,600 articles with 40k of text and two images (receives 50 percent of the traffic)
-
+ The recommended server topology is in the following diagram:
-
+ **Figure 8: Author-in-place publishing test topology** ![Visio diagram of the test server topology for the author-in-place tests. This test topology includes 1 computer hosting SQL Server and 1 computer hosting SharePoint service applications and running as a front-end web server.](../media/ECMCapacityNonSearchTopol.gif)
-
+ - 1 computer hosting SQL Server
-
+ - 1 computer hosting SharePoint service applications as the front-end web server
-
+ #### Test lab results We used the topology shown in the previous diagram in our test lab by using physical computers and a Visual Studio Team System load test.
-
+ The following table shows the technical specifications that we used in the computers that we tested:
-
-|**Server Components**|**SharePoint Servers**|
-|:--|:--|
-|**Processors** <br/> |Intel Xeon CPUs @2.33GHz (2 processors, 8 cores total, 8 threads total) <br/> |
-|**RAM** <br/> |24 GB <br/> |
-|**Operating system** <br/> |Windows Server 2008 R2 Enterprise, 64-bit <br/> |
-|**Number of network adapters** <br/> |2 <br/> |
-|**Network adapter speed** <br/> |1 Gbps <br/> |
-|**Authentication** <br/> |None ΓöÇ Anonymous <br/> |
-|**Load balancer type** <br/> |Windows software load balancer <br/> |
-|**Software version** <br/> |SharePoint Server 2013 <br/> |
-
-|**Server Components**|**Database server**|
-|:--|:--|
-|**Processors** <br/> |Intel Xeon CPUs MP7130M @2.79GHz (2 processors, 8 cores total, 16 threads total <br/> |
-|**RAM** <br/> |16 GB <br/> |
-|**Operating system** <br/> |Windows Server 2008 R2 Enterprise, 64-bit <br/> |
-|**Disk array** <br/> |2 x Dell PERC 5/E <br/> |
-|**Number of network adapters** <br/> |1 <br/> |
-|**Network adapter speed** <br/> |1 gigabit or Gbps <br/> |
-|**Authentication** <br/> |NTLM <br/> |
-|**Software version** <br/> |Microsoft SQL Server 2008 R2 SP1 <br/> |
-
+
+|Server Components|SharePoint Servers|
+|||
+|**Processors**|Intel Xeon CPUs @2.33GHz (2 processors, 8 cores total, 8 threads total)|
+|**RAM**|24 GB|
+|**Operating system**|Windows Server 2008 R2 Enterprise, 64-bit|
+|**Number of network adapters**|2|
+|**Network adapter speed**|1 Gbps|
+|**Authentication**|None - Anonymous|
+|**Load balancer type**|Windows software load balancer|
+|**Software version**|SharePoint Server 2013|
+
+|Server Components|Database server|
+|||
+|**Processors**|Intel Xeon CPUs MP7130M @2.79GHz (2 processors, 8 cores total, 16 threads total|
+|**RAM**|16 GB|
+|**Operating system**|Windows Server 2008 R2 Enterprise, 64-bit|
+|**Disk array**|2 x Dell PERC 5/E|
+|**Number of network adapters**|1|
+|**Network adapter speed**|1 gigabit or Gbps|
+|**Authentication**|NTLM|
+|**Software version**|Microsoft SQL Server 2008 R2 SP1|
+ The following table shows our results for a 10-minute run:
-
-|**Test Features**|**Green Zone**|**Red Zone**|
-|:--|:--|:--|
-|**Number of VSTS users:** <br/> |5 <br/> |15 <br/> |
-|**Server Response Time 50th percentile:** <br/> |69 ms. <br/> |112 ms. <br/> |
-|**Server Response Time 95th percentile:** <br/> |92 ms. <br/> |221 ms. <br/> |
-|**Page views per second:** <br/> |57 <br/> |93 <br/> |
-|**Average CPU (application server and front-end web server)** <br/> |55 <br/> |97 <br/> |
-|**Average CPU (SQL Server)** <br/> |7 <br/> |9 <br/> |
-|**Peak memory usage (application server and front-end web server)** <br/> |8.9 GB <br/> |8.9 GB <br/> |
-
+
+|Test Features|Green Zone|Red Zone|
+||||
+|**Number of VSTS users:**|5|15|
+|**Server Response Time 50th percentile:**|69 ms.|112 ms.|
+|**Server Response Time 95th percentile:**|92 ms.|221 ms.|
+|**Page views per second:**|57|93|
+|**Average CPU (application server and front-end web server)**|55|97|
+|**Average CPU (SQL Server)**|7|9|
+|**Peak memory usage (application server and front-end web server)**|8.9 GB|8.9 GB|
+ #### Effect of output cache Output caching is an effective way to reduce the load on SharePoint Server 2013 in publishing scenarios. For more information, see [Plan for caching and performance in SharePoint Server](caching-and-performance-planning.md).
-
+ The following table shows our results for a 10-minute run with output cache enabled and a 90 percent hit ratio:
-
-|**Test Features**|**Green Zone**|**Red Zone**|
-|:--|:--|:--|
-|**Number of VSTS users:** <br/> |5 <br/> |15 <br/> |
-|**Server Response Time 50th percentile:** <br/> |2 ms. <br/> |2 ms. <br/> |
-|**Server Response Time 95th percentile:** <br/> |74 ms. <br/> |88 ms. <br/> |
-|**Page views per second:** <br/> |190 <br/> |418 <br/> |
-|**Average CPU (application server and front-end web server)** <br/> |58 <br/> |85 <br/> |
-|**Average CPU (SQL Server)** <br/> |5 <br/> |7 <br/> |
-|**Peak memory usage (application server and front-end web server)** <br/> |9.2 GB <br/> |9.4 GB <br/> |
-
+
+|Test Features|Green Zone|Red Zone|
+||||
+|**Number of VSTS users:**|5|15|
+|**Server Response Time 50th percentile:**|2 ms.|2 ms.|
+|**Server Response Time 95th percentile:**|74 ms.|88 ms.|
+|**Page views per second:**|190|418|
+|**Average CPU (application server and front-end web server)**|58|85|
+|**Average CPU (SQL Server)**|5|7|
+|**Peak memory usage (application server and front-end web server)**|9.2 GB|9.4 GB|
+ The test results show that using output caching can significantly increase the throughput of a SharePoint publishing site and reduce server response times. For requests served from the output cache, the response times are almost instant.
-
+ The following graph shows a summary of our testing results:
-
+ **Figure 9: Effect of output caching with 90% cache hit ratio** ![Excel bar chart shows effect of using output caching in Green and Red Zones. Output caching reduces server response time and increases SharePoint publishing site throughput, when not used the throughput is reduced and server response times increase.](../media/ECMCapacityAnonOutputCacheEffect.gif)
-
+ #### Effect of managed navigation In SharePoint Server 2013, publishing sites can also use managed navigation. For details on how to set this up, see [Overview of managed navigation in SharePoint Server](overview-of-managed-navigation.md).
-
+ We ran the same set of tests for our test site using managed navigation as we used for the structured navigation tests. Our tests show that there is no significant difference in performance when sites use managed navigation or structured navigation.
-
-|**Test Features**|**Green Zone**|**Red Zone**|
-|:--|:--|:--|
-|**Number of VSTS users:** <br/> |5 <br/> |15 <br/> |
-|**Server Response Time 50th percentile:** <br/> |70 ms. <br/> |111 ms. <br/> |
-|**Server Response Time 95th percentile:** <br/> |95 ms. <br/> |215 ms. <br/> |
-|**Page views per second:** <br/> |56 <br/> |94 <br/> |
-|**Average CPU (application server and front-end web server)** <br/> |54 <br/> |97 <br/> |
-|**Average CPU (SQL Server)** <br/> |7 <br/> |9 <br/> |
-|**Peak memory usage (application server and front-end web server)** <br/> |8 GB <br/> |8 GB <br/> |
-
+
+|Test Features|Green Zone|Red Zone|
+||||
+|**Number of VSTS users:**|5|15|
+|**Server Response Time 50th percentile:**|70 ms.|111 ms.|
+|**Server Response Time 95th percentile:**|95 ms.|215 ms.|
+|**Page views per second:**|56|94|
+|**Average CPU (application server and front-end web server)**|54|97|
+|**Average CPU (SQL Server)**|7|9|
+|**Peak memory usage (application server and front-end web server)**|8 GB|8 GB|
+ The following graph shows the different types of navigation for the same site:
-
+ **Figure 10: Managed Navigation versus Structured Navigation** ![Excel bar chart show effects of using managed navigation versus structured navigation in both Green and Red Zones. Comparisons show using managed or sturctured navigation are the same.](../media/ECMCapacityNavigation.gif)
-
+ #### Effect of adding computers (scaling out) If you find that you need more throughput from a SharePoint deployment, scaling out (increasing the number of computers that host SharePoint Server 2013) is an option to consider. The following graph shows how throughput increases as we add more computers to the farm:
-
+ **Figure 11: Effect on throughput by adding front-end web servers** ![Excel chart shows the effect of adding front-end web servers and increasing the load on these servers in both the red and green zones. Starting with one front-end web server and ending with 3, throughput increases at almost the same time in milliseconds.](../media/ECMCapacityAddMachinesEffect.gif)
-
+ In our tests we increased the load on the server running SharePoint Server 2013 for each computer that was added so that the server response times were approximately the same (around 11 milliseconds for the green zone, around 250 milliseconds for the red zone).
-
+ ### Author-in-place publishing sites with authenticated users The SharePoint publishing feature is used commonly in the intranet where users who access a site are authenticated. This section shows our tests that used authenticated users and the effects.
-
+ The following table shows the test results of author-in-place publishing sites that authenticated users accessed by using claims-based authentication with NTLM. Note that these tests use identical hardware as the tests in the previous section.
-
-|**Test Features**|**Green Zone**|**Red Zone**|
-|:--|:--|:--|
-|**Number of VSTS users:** <br/> |5 <br/> |15 <br/> |
-|**Server Response Time 50th percentile:** <br/> |76 ms. <br/> |107 ms. <br/> |
-|**Server Response Time 95th percentile:** <br/> |103 ms. <br/> |194 ms. <br/> |
-|**Page views per second:** <br/> |54 <br/> |100 <br/> |
-|**Average CPU (application server and front-end web server)** <br/> |50 <br/> |97 <br/> |
-|**Average CPU (SQL Server)** <br/> |6 <br/> |9 <br/> |
-|**Peak Memory Usage (application server and front-end web server)** <br/> |9.5 GB <br/> |9.5 GB <br/> |
-
+
+|Test Features|Green Zone|Red Zone|
+||||
+|**Number of VSTS users:**|5|15|
+|**Server Response Time 50th percentile:**|76 ms.|107 ms.|
+|**Server Response Time 95th percentile:**|103 ms.|194 ms.|
+|**Page views per second:**|54|100|
+|**Average CPU (application server and front-end web server)**|50|97|
+|**Average CPU (SQL Server)**|6|9|
+|**Peak Memory Usage (application server and front-end web server)**|9.5 GB|9.5 GB|
+ The numbers show that there is no significant difference between anonymous versus authenticated requests according to the server response times and throughput.
-
+ The following graph shows the different types of requests for the same site:
-
+ **Figure 12: Anonymous requests versus authenticated requests** ![Excel chart shows proportional performance of using anonymous requests versus authenticated requests in both the green and red zones.](../media/ECMCapacityAnonVsAuth.gif)
-
+ #### Effect of Output Cache in authenticated scenarios Authenticated requests to the server require a roundtrip to the content database to make sure that the account that is accessing the content has permissions to view the content. This means that the output caching performance characteristics of authenticated sites are different compared to anonymous sites.
-
+ The following table shows the results we received for a 10 minute run with output cache enabled and a 90 percent cache hit ratio:
-
-|**Test Features**|**Green Zone**|**Red Zone**|
-|:--|:--|:--|
-|**Number of VSTS users:** <br/> |6 <br/> |18 <br/> |
-|**Server Response Time 50th percentile:** <br/> |17 ms. <br/> |29 ms. <br/> |
-|**Server Response Time 95th percentile:** <br/> |87 ms. <br/> |118 ms. <br/> |
-|**Page views per second:** <br/> |114 <br/> |236 <br/> |
-|**Average CPU (application server and front-end web server)** <br/> |50 <br/> |97 <br/> |
-|**Average CPU (SQL Server)** <br/> |7 <br/> |10 <br/> |
-|**Peak Memory Usage (application server and front-end web server)** <br/> |9.9 GB <br/> |10 GB <br/> |
-
+
+|Test Features|Green Zone|Red Zone|
+||||
+|**Number of VSTS users:**|6|18|
+|**Server Response Time 50th percentile:**|17 ms.|29 ms.|
+|**Server Response Time 95th percentile:**|87 ms.|118 ms.|
+|**Page views per second:**|114|236|
+|**Average CPU (application server and front-end web server)**|50|97|
+|**Average CPU (SQL Server)**|7|10|
+|**Peak Memory Usage (application server and front-end web server)**|9.9 GB|10 GB|
+ The following graph shows the summary of these results:
-
+ **Figure 13: Effect of authenticated output caching** ![Excel bar chart shows the effect of using authenticated output caching in both the green and red zones. The roundtrip time in milliseconds increases when using authenticated requests compared to anonymous requests.](../media/ECMCapacityAuthOutputCacheEffect.gif)
-
+ ## See also <a name="author"> </a> #### Concepts [Web content management in SharePoint Server](web-content-management.md)
-
+ [Configure web content management solutions in SharePoint Server](configure-web-content-management-solutions.md)
-
+ [Configure cache settings for a web application in SharePoint Server](cache-settings-configuration-for-a-web-application.md)
-
-[Plan for caching and performance in SharePoint Server](caching-and-performance-planning.md)
+
+[Plan for caching and performance in SharePoint Server](caching-and-performance-planning.md)
SharePoint Delete Odfb Lists https://github.com/MicrosoftDocs/OfficeDocs-SharePoint/commits/public/SharePoint/SharePointServer/delete-odfb-lists.md
Title: "Deleting OneDrive experience settings"-+
f1.keywords:
- NOCSH -+ ms.localizationpriority: medium description: "Learn about deleting OneDrive experience settings."
An admin can delete these lists by using [PowerShell Script](/powershell/module/
You can adapt the script included in this article to meet the your needs. For example, you can extract the information for user1@contoso.com as follows:
-1. Assign yourself permissions to the user's OneDrive account. This can be done in the Microsoft 365 admin center as described here.
+1. Assign yourself permissions to the user's OneDrive account. This can be done in the Microsoft 365 admin center as described here.
2. Install the required Microsoft PowerShell modules:
You can adapt the script included in this article to meet the your needs. For ex
`Install-Module CredentialManager`
-3. Run the DeleteODBLists PowerShell script below (or a customized version of the script); for example:
+3. Run the DeleteODBLists PowerShell script below (or a customized version of the script); for example:
`$ODBSite = "https://contoso-my.sharepoint.com/personal/user1_contoso_com"` `DeleteODBLists -siteUrl $ODBSite`
-The script will permanently delete the hidden lists containing these settings.
-
+The script will permanently delete the hidden lists containing these settings.
+ > [!IMPORTANT]
-> Do not run this script on OneDrive accounts for active users that are still in the organization.
+> Do not run this script on OneDrive accounts for active users that are still in the organization.
## DeleteODBLists script Copy the contents below and paste them into a text file. Save the file as DeleteODBLists.ps1.
try{
$ctx.executeQuery() } catch{
- write-host "$($_.Exception.Message)" -foregroundcolor red
+ write-host "$($_.Exception.Message)" -foregroundcolor red
}
foreach($list in $lists)
$listTitle = [string]$list.Title $listRoot = $list.RootFolder.Name $listTemplateId = $list.TemplateFeatureId
-
+ Write-host ("Processing List: " + $list.Title + " with " + $list.ItemCount + " items").ToUpper() -ForegroundColor Yellow Write-host (">> List Root Folder: " + $listRoot) -ForegroundColor Yellow
foreach($list in $lists)
} #Retrieve web features
-$webFeatures = $ctx.Web.Features
+$webFeatures = $ctx.Web.Features
$ctx.Load($webFeatures) $ctx.ExecuteQuery()
function deleteList
$ctx.executeQuery() #Set the list to allow deletion
- $list = $lists.GetByTitle($listTitle)
+ $list = $lists.GetByTitle($listTitle)
$list.AllowDeletion = $true $list.Update() $ctx.executeQuery()
-
- #Delete the list
+
+ #Delete the list
$list.DeleteObject() $ctx.executeQuery() }
SharePoint Export Odfb Lists https://github.com/MicrosoftDocs/OfficeDocs-SharePoint/commits/public/SharePoint/SharePointServer/export-odfb-lists.md
A user's Microsoft OneDrive experience stores information to help the user find
An admin can export these lists by using [PnP PowerShell](/powershell/sharepoint/sharepoint-pnp/sharepoint-pnp-cmdlets) and [SharePoint Client-Side Object Model (CSOM)](/sharepoint/dev/sp-add-ins/complete-basic-operations-using-sharepoint-client-library-code) commands in this article. All of the needed CSOM assemblies are included in the SharePointPnPPowerShellOnline Microsoft PowerShell module.
-This is a sample script and can be adapted to meet your organizationΓÇÖs needs. For example, an admin can extract the information for user1@contoso.com by using the following procedure.
+This is a sample script and can be adapted to meet your organization's needs. For example, an admin can extract the information for user1@contoso.com by using the following procedure.
-1. Assign yourself admin permissions to the user's OneDrive account. This can be done [in the Microsoft 365 admin center](/office365/admin/add-users/get-access-to-and-back-up-a-former-user-s-data).
+1. Assign yourself admin permissions to the user's OneDrive account. This can be done [in the Microsoft 365 admin center](/office365/admin/add-users/get-access-to-and-back-up-a-former-user-s-data).
2. Install the required Microsoft PowerShell modules:
This is a sample script and can be adapted to meet your organizationΓÇÖs needs.
`Install-Module CredentialManager`
-3. Run the ExportODBLists PowerShell script below (or a customize version of the script):
+3. Run the ExportODBLists PowerShell script below (or a customize version of the script):
`$ODBSite = "https://contoso-my.sharepoint.com/personal/user1_contoso_com"`
try{
$ctx.executeQuery() } catch{
- write-host "$($_.Exception.Message)" -foregroundcolor red
+ write-host "$($_.Exception.Message)" -foregroundcolor red
}
foreach($list in $lists)
$ctx.executeQuery() $listTitle = [string]$list.Title $listRoot = $list.RootFolder.Name
-
+ Write-host ("Processing List: " + $list.Title + " with " + $list.ItemCount + " items").ToUpper() -ForegroundColor Yellow Write-host (">> List Root Folder: " + $listRoot) -ForegroundColor Yellow
function exportList
Write-Host (">> File location: $exportFile") -ForegroundColor Green #Get the list items
- $list = $lists.GetByTitle($listTitle)
- $listItems = $list.GetItems([Microsoft.SharePoint.Client.CamlQuery]::CreateAllItemsQuery())
+ $list = $lists.GetByTitle($listTitle)
+ $listItems = $list.GetItems([Microsoft.SharePoint.Client.CamlQuery]::CreateAllItemsQuery())
$fieldColl = $list.Fields
- $ctx.load($listItems)
+ $ctx.load($listItems)
$ctx.load($fieldColl)
- $ctx.executeQuery()
-
+ $ctx.executeQuery()
+ if ($listFields) #if you're passing a specific set of fields, in a specific order, process those {
- #Array to Hold List Items
- $listItemCollection = @()
+ #Array to Hold List Items
+ $listItemCollection = @()
#Fetch each list item value to export to excel foreach($item in $listItems) {
- $exportItem = New-Object PSObject
+ $exportItem = New-Object PSObject
Foreach ($field in $listFields) {
function exportList
} else {
- $fieldValue = $item[$field]
+ $fieldValue = $item[$field]
} } $exportItem | Add-Member -MemberType NoteProperty -name $field -value $fieldValue
function exportList
} else #export all fields for the list {
- #Array to Hold List Items
- $listItemCollection = @()
+ #Array to Hold List Items
+ $listItemCollection = @()
#Fetch each list item value to export to excel foreach($item in $listItems) {
- $exportItem = New-Object PSObject
+ $exportItem = New-Object PSObject
Foreach($field in $fieldColl) { if($NULL -ne $item[$field.InternalName])
function exportList
} else {
- $fieldValue = $item[$field.InternalName]
+ $fieldValue = $item[$field.InternalName]
} } $exportItem | Add-Member -MemberType NoteProperty -name $field.InternalName -value $fieldValue
function exportList
#Export the result Array to CSV file $listItemCollection | Export-CSV $exportFile -NoTypeInformation }
-
+ } #export the lists
foreach ($list in $listsToExport)
{ exportList -listTitle $list["listTitle"] -listFields $list["listFields"] -exportFile $filepath }
-}
+}
```
SharePoint Add Content To A Case And Place Sources On Hold In The Ediscovery Center https://github.com/MicrosoftDocs/OfficeDocs-SharePoint/commits/public/SharePoint/SharePointServer/governance/add-content-to-a-case-and-place-sources-on-hold-in-the-ediscovery-center.md
This procedure creates an eDiscovery Set and adds content sources to it. To also
2. Click to the left of the eDiscovery Set to select it, so that a check mark appears besides its name.
-3. Click the three dots **…** to display the **Open Menu**.
+3. Click the three dots **...** to display the **Open Menu**.
4. Click **Delete Item**.
SharePoint Information Management And Governance In Sharepoint https://github.com/MicrosoftDocs/OfficeDocs-SharePoint/commits/public/SharePoint/SharePointServer/governance/information-management-and-governance-in-sharepoint.md
The following table presents resources that are available to help information ar
**Information architecture resources**
-|**To plan …**|**See …**|
+|**To plan ...**|**See ...**|
|:--|:--| |The structure of sites and subsites <br/> |[Plan sites and site collections in SharePoint Server](../sites/plan-sites-and-site-collections.md) <br/> | |Document libraries <br/> |[Plan document libraries in SharePoint 2013](/previous-versions/office/sharepoint-server-2010/cc262215(v=office.14)) <br/> |
SharePoint Cloud Hybrid Search Faq https://github.com/MicrosoftDocs/OfficeDocs-SharePoint/commits/public/SharePoint/SharePointServer/hybrid/cloud-hybrid-search-faq.md
The Hybrid picker automates certain configuration steps to configure hybrid betw
***I plan to configure Cloud hybrid search with high availability (HA) topologies. Is there a script available to configure the same?***
-If you plan to configure Cloud hybrid search with HA topologies in SharePoint Server, you can configure it with Hybrid picker. Hybrid picker has automated certain configuration steps needed to connect your on-premises SharePoint Server environment with SharePoint in Microsoft 365 for Cloud hybrid search. [Learn more](./configure-cloud-hybrid-searchroadmap.md).
+If you plan to configure Cloud hybrid search with HA topologies in SharePoint Server, you can configure it with Hybrid picker. Hybrid picker has automated certain configuration steps needed to connect your on-premises SharePoint Server environment with SharePoint in Microsoft 365 for Cloud hybrid search. [Learn more](./configure-cloud-hybrid-searchroadmap.md).
***What is hybrid federated search and how is it different from Cloud hybrid search?***
In hybrid federated search, the reverse proxy must be able to:
[Configure a reverse proxy device for SharePoint Server hybrid](./configure-a-reverse-proxy-device-for-sharepoint-server-hybrid.md) article outlines the tested reverse proxy solutions.
-***When should I deploy Cloud hybrid search or hybrid federated search?  Are there any recommendations ?***
+***When should I deploy Cloud hybrid search or hybrid federated search? Are there any recommendations ?***
The recommendation is to choose Cloud hybrid search for the following benefits.
For disaster recovery, a second Cloud hybrid search service application can be b
***Can users query for items secured with SAML claims if crawled by a Cloud search service application?***
-Items secured with SAML claims when crawled using Cloud Search Service application will not show up in search results. This does not work as those identities cannot be interpreted during the ACL mapping process in the Cloud search service application. As of today, we do not have a way to map an on-premises SAML identity to a Microsoft 365 user, which is a core requirement for ACL mapping to work. This is by design. For such supportability questions, a request can be submitted at [SharePoint Feedback portal](https://feedbackportal.microsoft.com/feedback/forum/06735c62-321c-ec11-b6e7-0022481f8472) for evaluation.
+Items secured with SAML claims when crawled using Cloud Search Service application will not show up in search results. This does not work as those identities cannot be interpreted during the ACL mapping process in the Cloud search service application. As of today, we do not have a way to map an on-premises SAML identity to a Microsoft 365 user, which is a core requirement for ACL mapping to work. This is by design. For such supportability questions, a request can be submitted at [SharePoint Feedback portal](https://feedbackportal.microsoft.com/feedback/forum/06735c62-321c-ec11-b6e7-0022481f8472) for evaluation.
***On-premises environment Cloud search service application crawls site collection secured with NT Authority\\Authenticated users. How does this translate to ACL mapping in SharePoint in Microsoft 365?***
Popularity trends works based out of analytics. Usage Analytics reporting isn't
***Cloud hybrid search service application is crawling a SharePoint farm that has http:// prefix in the default zone, extranet zone is https://. Query from SharePoint in Microsoft 365 ends up showing http in the search result is this expected behavior?***
-Yes, this is expected. Users will see http:// prefix in the search results. As my friend Brian explains it very nicely [here](/archive/blogs/sharepoint_strategery/beware-crawling-the-non-default-zone-for-a-sharepoint-2013-web-application), SharePoint Server URL-related managed properties including Path, ParentURL and SPSiteUrl all store values relative to the URL that was crawled. The crawler simply passes what it can gather to the Search Content Services in the cloud. SharePoint in Microsoft 365 search has no knowledge of the Alternate Access Mappings on your on-premises farm and so is unable to correctly set the mappings you would expect to see. Thus, it's recommended to crawl the Default zone for a SharePoint Server Web Application.
+Yes, this is expected. Users will see http:// prefix in the search results. As my friend Brian explains it very nicely [here](/archive/blogs/sharepoint_strategery/beware-crawling-the-non-default-zone-for-a-sharepoint-2013-web-application), SharePoint Server URL-related managed properties including Path, ParentURL and SPSiteUrl all store values relative to the URL that was crawled. The crawler simply passes what it can gather to the Search Content Services in the cloud. SharePoint in Microsoft 365 search has no knowledge of the Alternate Access Mappings on your on-premises farm and so is unable to correctly set the mappings you would expect to see. Thus, it's recommended to crawl the Default zone for a SharePoint Server Web Application.
***Cloud search service application is crawling my on-premises content. Can I remove on-premises items from SharePoint in Microsoft 365?***
SharePoint Configure Server To Server Authentication https://github.com/MicrosoftDocs/OfficeDocs-SharePoint/commits/public/SharePoint/SharePointServer/hybrid/configure-server-to-server-authentication.md
- Ent_O365_Hybrid - Strat_SP_gtc - SPO_Content-+ ms.assetid: 9cd888dc-9104-422e-8d8a-d795f0b1c0d0 description: Learn how to build a server-to server trust between SharePoint Server and SharePoint in Microsoft 365. # Configure server-to-server authentication from SharePoint Server to SharePoint in Microsoft 365
-
+ This article is part of a roadmap of procedures for configuring SharePoint hybrid solutions. Be sure you're [following a roadmap](configuration-roadmaps.md) when you do the procedures in this article. > [!NOTE]
This article is part of a roadmap of procedures for configuring SharePoint hybri
## Configure server-to-server authentication This article provides guidance for the SharePoint hybrid environment deployment process, which integrates SharePoint Server and SharePoint in Microsoft 365.
-
+ > [!TIP]
-> For the most reliable outcome, complete the procedures in the order they are shown in this article.
-
+> For the most reliable outcome, complete the procedures in the order they are shown in this article.
+ ## Verify web application settings <a name="verifywebapp"> </a> In SharePoint hybrid, federated users can send requests to SharePoint in Microsoft 365 from any SharePoint Server web application that's configured to use Integrated Windows authentication with NTLM.
-
+ For example, you have to make sure that the on-premises search center site(s) that you want to use in your solution are configured to use Integrated Windows authentication with NTLM. If they're not, you have to either reconfigure the web application to use Windows authentication with NTLM or use a search center site on a web application that meets this requirement. You also have to make sure that the users who expect search results to be returned from SharePoint in Microsoft 365 are federated users.
-
-**To verify that a web application meets the requirement**
-
+
+### To verify that a web application meets the requirement
+ 1. Confirm that the user account that will do this procedure is a member of the Farm Admins SharePoint group.
-
+ 2. In Central Administration, select **Application Management**, and then select **Manage web applications**.
-
+ 3. In the **Name** column, select the web application that you want to verify, and on the ribbon, select **Authentication Providers**.
-
-4. In the **Authentication Providers** dialog box, in the **Zone** column, select the zone the search center site is associated with.
-
-5. In the **Edit Authentication** dialog box, verify that Integrated Windows authentication and NTLM are selected as shown in the following picture.
-
+
+4. In the **Authentication Providers** dialog box, in the **Zone** column, select the zone the search center site is associated with.
+
+5. In the **Edit Authentication** dialog box, verify that Integrated Windows authentication and NTLM are selected as shown in the following picture.
+ :::image type="content" alt-text="Authentication type setting for a web application." source="../media/ClaimType.jpg":::
-
+ ## Configure OAuth over HTTP (if it is required) <a name="configOAuth"> </a>
-By default, OAuth in SharePoint Server requires **HTTPS**. If you configured your primary web application to use **HTTP** instead of SSL, you have to enable OAuth over **HTTP** on every web server in your SharePoint Server farm.
-
+By default, OAuth in SharePoint Server requires **HTTPS**. If you configured your primary web application to use **HTTP** instead of SSL, you have to enable OAuth over **HTTP** on every web server in your SharePoint Server farm.
+ > [!NOTE]
-> If you configured your primary web application to use SSL, this step is not required.
-
+> If you configured your primary web application to use SSL, this step is not required.
+ To enable OAuth over HTTP, run the following commands as a farm administrator account from the SharePoint 2016 Management Shell command prompt on each web server in your SharePoint Server farm.
-
+ ```powershell $serviceConfig = Get-SPSecurityTokenServiceConfig $serviceConfig.AllowOAuthOverHttp = $true
$serviceConfig.Update()
``` If you have enabled OAuth over HTTP for testing but want to reconfigure your environment to use SSL, you can disable OAuth over HTTP by running the following commands as a farm administrator account from the SharePoint 2016 Management Shell command prompt on each web server in your SharePoint Server farm.
-
+ ```powershell $serviceConfig = Get-SPSecurityTokenServiceConfig $serviceConfig.AllowOAuthOverHttp = $false
$serviceConfig.Update()
<a name="s2s"> </a> This section will help you set up server-to-server authentication among:
-
-- SharePoint Server
-
-- SharePoint in Microsoft 365
-
-- Azure Active Directory
-
-When you set up server-to-server authentication for hybrid environments, you create a **trust relationship** between your **on-premises SharePoint farm** and your **SharePoint in Microsoft 365** **tenant**, which uses Azure Active Directory as a trusted token signing service. By adding the required PowerShell modules and snap-ins, this process can occur in a single PowerShell window on an on-premises SharePoint web server.
-
+
+- SharePoint Server
+
+- SharePoint in Microsoft 365
+
+- Azure Active Directory
+
+When you set up server-to-server authentication for hybrid environments, you create a **trust relationship** between your **on-premises SharePoint farm** and your **SharePoint in Microsoft 365** **tenant**, which uses Azure Active Directory as a trusted token signing service. By adding the required PowerShell modules and snap-ins, this process can occur in a single PowerShell window on an on-premises SharePoint web server.
+ > [!TIP]
-> You'll want to keep a record of your steps, the PowerShell cmdlets you run, and any errors that you might encounter. You should capture all the contents of the PowerShell buffer when you have finished and before you close the window. This will give you a history of the steps that you took, which will be helpful if you have to troubleshoot or explain the process to others. This can also be useful to refresh your memory if the setup happens in stages.
-
+> You'll want to keep a record of your steps, the PowerShell cmdlets you run, and any errors that you might encounter. You should capture all the contents of the PowerShell buffer when you have finished and before you close the window. This will give you a history of the steps that you took, which will be helpful if you have to troubleshoot or explain the process to others. This can also be useful to refresh your memory if the setup happens in stages.
+ Here's a high-level view of the procedures you have to complete in this section:
-
-
+ 1. Install online service management tools on a web server in your SharePoint Server farm. 2. Configure server-to-server authentication:
-
+ - Set variables you'll be using in later steps.
-
+ - Upload the built-in SharePoint Server STS certificate to SharePoint in Microsoft 365.
-
+ - Add a Service Principal Name (SPN) to Azure.
-
+ - Register the SharePoint in Microsoft 365 application principal object ID with on-premises SharePoint Server.
-
+ - Configure a common authentication realm between your on-premises SharePoint Server farm and SharePoint in Microsoft 365.
-
+ - Configure an Azure Active Directory application proxy on-premises.
-
+ ### Install online service management tools and configure the Windows PowerShell window <a name="step2"> </a> To continue, you need to install these tools on an on-premises SharePoint Server web server:
-
+ - Azure Active Directory Module for Windows PowerShell
-
+ - SharePoint in Microsoft 365 Management Shell
-
-This is most easily accomplished on a web server in your SharePoint farm because it's easier to load the *Microsoft.SharePoint.PowerShell* snap-in on the web servers than on servers that don't have SharePoint Server installed.
-
+
+This is most easily accomplished on a web server in your SharePoint farm because it's easier to load the *Microsoft.SharePoint.PowerShell* snap-in on the web servers than on servers that don't have SharePoint Server installed.
+ Authentication to SharePoint Server, SharePoint in Microsoft 365, and Azure Active Directory requires different user accounts. For information about how to determine which account to use, see [Accounts needed for hybrid configuration and testing](accounts-needed-for-hybrid-configuration-and-testing.md).
-
+ > [!NOTE]
-> To make it easier to complete the steps in this section, we'll open a PowerShell Command Prompt window on a SharePoint Server web server and add the modules and snap-ins that let you connect to SharePoint Server, SharePoint in Microsoft 365, and Azure Active Directory. (We'll give you detailed steps on how to do this later in this article.) We'll then keep this window open to use for all the remaining PowerShell steps in this article.
-
+> To make it easier to complete the steps in this section, we'll open a PowerShell Command Prompt window on a SharePoint Server web server and add the modules and snap-ins that let you connect to SharePoint Server, SharePoint in Microsoft 365, and Azure Active Directory. (We'll give you detailed steps on how to do this later in this article.) We'll then keep this window open to use for all the remaining PowerShell steps in this article.
+ To install the online service management tools and configure the PowerShell window:
-
+ 1. Install the [latest version of the Azure Active Directory Module for Windows PowerShell](https://social.technet.microsoft.com/wiki/contents/articles/28552.microsoft-azure-active-directory-powershell-module-version-release-history.aspx)
-
+ 2. Install the SharePoint in Microsoft 365 Management Shell:
-
+ [SharePoint in Microsoft 365 Management Shell (64 bit version)](https://go.microsoft.com/fwlink/?LinkId=392323)
-
- For additional info, see [Introduction to the SharePoint in Microsoft 365 Management Shell](/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell).
-
+
+ For additional info, see [Introduction to the SharePoint in Microsoft 365 Management Shell](/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell).
+ 3. Open a PowerShell window.
-
+ 4. To help ensure that you don't fill the buffer and lose any of your command history, increase the buffer size of the PowerShell window:
-
+ 5. Select the upper-left corner of the PowerShell window, and then select **Properties**.
-
-6. In the PowerShell Properties window, select the **Layout** tab.
-
+
+6. In the PowerShell Properties window, select the **Layout** tab.
+ 7. Under Screen Buffer Size, set the **Height** field to **9999**, and then select **OK**.
-
-8. This step loads the modules you downloaded so you can use them in your PowerShell session. Copy the following commands into your PowerShell session, and press **Enter**.
-
+
+8. This step loads the modules you downloaded so you can use them in your PowerShell session. Copy the following commands into your PowerShell session, and press **Enter**.
+ ```powershell Add-PSSnapin Microsoft.SharePoint.PowerShell Import-Module Microsoft.PowerShell.Utility
To install the online service management tools and configure the PowerShell wind
``` If you need to run any of the configuration steps again later, remember to run these commands again to load the required modules and snap-ins in PowerShell.
-
+ 9. Enter the following commands to sign in to SharePoint in Microsoft 365, from the PowerShell command prompt:
-
+ ```powershell $cred=Get-Credential Connect-MsolService -Credential $cred ``` You are prompted to sign in. You need to sign in using a Microsoft 365 global admin account.
-
+ Leave the PowerShell window open until you've completed all the steps in this article. You need it for a variety of procedures in the following sections.
-
+ ### Configure server-to-server (S2S) authentication <a name="step2"> </a> Now that you installed the tools to enable you to remotely administer Azure Active Directory and SharePoint in Microsoft 365, you're ready to set up server-to-server authentication.
-
+ #### About the variables you'll create
-This section describes the variables you will set in the procedure that follows. These variables contain important information used in many of the remaining configuration steps.
-
-| Variable | Comments |
+This section describes the variables you will set in the procedure that follows. These variables contain important information used in many of the remaining configuration steps.
+
+|Variable|Comments|
|:--|:--|
-|$spcn |The root domain name of your public domain. This value should not be in the form of a URL; it should be the **domain name only**, with **no protocol**. <br/> An example is adventureworks.com. |
-|$spsite |The internal URL of your on-premises primary web application, such as **http://sharepoint** or **`https://sharepoint.adventureworks.com`**. This value is a full URL using the proper protocol (either **http:** // or **https://** ). <br/> This is the internal URL of the web application that you are using for hybrid functionality. <br/> An example is http://sharepoint or `https://sharepoint.adventureworks.com`. |
-|$site |The object of your on-premises primary web application. The command that populates this variable gets the object of the site you specified in the **$spsite** variable. <br/> This variable is automatically populated. |
-|$spoappid |The SharePoint in Microsoft 365 application principal ID is always 00000003-0000-0ff1-ce00-000000000000. This generic value identifies SharePoint in Microsoft 365 objects in a Microsoft 365 organization. |
-|$spocontextID |The context ID (ObjectID) of your SharePoint in Microsoft 365 tenant. This value is a unique GUID that identifies your SharePoint in Microsoft 365 tenant. <br/> This value is automatically detected when you run the command to set the variable. |
-|$metadataEndpoint |The URL that is used by your Azure Active Directory proxy to connect to your Azure Active Directory tenancy. <br/> You don't need to input a value for this variable. |
-
+|$spcn|The root domain name of your public domain. This value should not be in the form of a URL; it should be the **domain name only**, with **no protocol**. <br/> An example is adventureworks.com.|
+|$spsite|The internal URL of your on-premises primary web application, such as **http://sharepoint** or **`https://sharepoint.adventureworks.com`**. This value is a full URL using the proper protocol (either **http:** // or **https://** ). <br/> This is the internal URL of the web application that you are using for hybrid functionality. <br/> An example is http://sharepoint or `https://sharepoint.adventureworks.com`.|
+|$site|The object of your on-premises primary web application. The command that populates this variable gets the object of the site you specified in the **$spsite** variable. <br/> This variable is automatically populated.|
+|$spoappid|The SharePoint in Microsoft 365 application principal ID is always 00000003-0000-0ff1-ce00-000000000000. This generic value identifies SharePoint in Microsoft 365 objects in a Microsoft 365 organization.|
+|$spocontextID|The context ID (ObjectID) of your SharePoint in Microsoft 365 tenant. This value is a unique GUID that identifies your SharePoint in Microsoft 365 tenant. <br/> This value is automatically detected when you run the command to set the variable.|
+|$metadataEndpoint|The URL that is used by your Azure Active Directory proxy to connect to your Azure Active Directory tenancy. <br/> You don't need to input a value for this variable.|
+ #### Step 1: Set variables <a name="step3"> </a>
-Now that you identified the variables that you need to set, use these instructions to set them. Pre-populating the most commonly used variables should help you do the remaining steps faster. These variables remain populated as long as you don't close the PowerShell session. Be careful to provide accurate information wherever you see angle brackets (< >), and always remove the angle brackets before you run the command. Don't alter the code *outside* of the angle brackets.
-
+Now that you identified the variables that you need to set, use these instructions to set them. Pre-populating the most commonly used variables should help you do the remaining steps faster. These variables remain populated as long as you don't close the PowerShell session. Be careful to provide accurate information wherever you see angle brackets (< >), and always remove the angle brackets before you run the command. Don't alter the code *outside* of the angle brackets.
+ > [!NOTE]
-> If you have to do any of these configuration steps again later, you should begin by running the following PowerShell commands in this step to repopulate the important variables.
-
+> If you have to do any of these configuration steps again later, you should begin by running the following PowerShell commands in this step to repopulate the important variables.
+ Copy the following variable declarations and paste them into a text editor like Notepad. Set the input values specific to your organization. From the PowerShell command prompt you configured with the online service management tools, run the commands.
-
+ ```powershell $spcn="*.<public_root_domain_name>.com" $spsite=Get-Spsite <principal_web_application_URL>
$spocontextID = (Get-MsolCompanyInformation).ObjectID
$metadataEndpoint = "https://accounts.accesscontrol.windows.net/" + $spocontextID + "/metadata/json/1" ```
-After you populate these variables, you can view their values by entering the variable name in the PowerShell window. For example, entering `$metadataEndpoint` returns a value similar to the following:
-
+After you populate these variables, you can view their values by entering the variable name in the PowerShell window. For example, entering `$metadataEndpoint` returns a value similar to the following:
+ `https://accounts.accesscontrol.windows.net/00fceb75-246c-4ac4-a0ad-7124xxxxxxxx/metadata/json/1`
-
+ #### Step 2: Upload the STS certificate to SharePoint in Microsoft 365 <a name="step4"> </a> In this step, you upload the STS certificate for your SharePoint Server farm to your SharePoint in Microsoft 365 tenant, which enables SharePoint Server and SharePoint in Microsoft 365 to connect to and consume each other's service applications.
-
+ ![The architecture involved when a STS certificate is uploaded to SharePoint in Microsoft 365](../media/TrustSTS.jpg)
-
-The commands in this step add the on-premises STS certificate (public key only) to the SharePoint in Microsoft 365 *principal object* of your Microsoft 365 organization.
-
+
+The commands in this step add the on-premises STS certificate (public key only) to the SharePoint in Microsoft 365 *principal object* of your Microsoft 365 organization.
+ From the PowerShell command prompt, type the following commands.
-
+ ```powershell $stsCert=(Get-SPSecurityTokenServiceConfig).LocalLoginProvider.SigningCertificate $binCert = $stsCert.GetRawCertData()
New-MsolServicePrincipalCredential -AppPrincipalId $spoappid -Type asymmetric -U
#### Step 3: Add an SPN for your public domain name to Azure Active Directory <a name="step5"> </a>
-In this step, you add a service principal name (SPN) to your Azure Active Directory tenant. The SharePoint in Microsoft 365 principal object and your company's public DNS namespace form the SPN.
-
+In this step, you add a service principal name (SPN) to your Azure Active Directory tenant. The SharePoint in Microsoft 365 principal object and your company's public DNS namespace form the SPN.
+ Just like SPNs function in Active Directory, creating this SPN registers an object in Azure Active Directory that is used to support mutual authentication between SharePoint Server and SharePoint in Microsoft 365. The basic syntax for the SPN is:
-
+ **\<service type\>/\<instance name\>**
-
+ Where:
-
-- \<service type\> is the SharePoint in Microsoft 365 principal object, which is the same for all SharePoint in Microsoft 365 tenants.
-
-- \<instance name\> is the URL of your company's public DNS domain namespace, which is always expressed as a wildcard, even if the Secure Channel SSL Certificate is a SAN certificate.
-
+
+- \<service type\> is the SharePoint in Microsoft 365 principal object, which is the same for all SharePoint in Microsoft 365 tenants.
+
+- \<instance name\> is the URL of your company's public DNS domain namespace, which is always expressed as a wildcard, even if the Secure Channel SSL Certificate is a SAN certificate.
+ Here's an example:
-
+ `00000003-0000-0ff1-ce00-000000000000/*.<public domain name>.com`
-
+ If the common name in your certificate is sharepoint.adventureworks.com, the syntax of the SPN will look like this:
-
+ `00000003-0000-0ff1-ce00-000000000000/*.adventureworks.com`
-
-Using a wildcard value lets SharePoint in Microsoft 365 validate connections with *any host* in that domain. This is useful if you ever need to change the host name of the external endpoint (if your topology includes one) or if you want to change your SharePoint Server web application, in the future.
-
+
+Using a wildcard value lets SharePoint in Microsoft 365 validate connections with *any host* in that domain. This is useful if you ever need to change the host name of the external endpoint (if your topology includes one) or if you want to change your SharePoint Server web application, in the future.
+ To add the SPN to Azure Active Directory, enter the following commands in the Azure Active Directory Module for Windows PowerShell command prompt.
-
+ ```powershell $msp = Get-MsolServicePrincipal -AppPrincipalId $spoappid $spns = $msp.ServicePrincipalNames
-$spns.Add("$spoappid/$spcn")
+$spns.Add("$spoappid/$spcn")
Set-MsolServicePrincipal -AppPrincipalId $spoappid -ServicePrincipalNames $spns ``` To validate that the SPN was set, enter the following commands in the Azure Active Directory Module for Windows PowerShell command prompt.
-
+ ```powershell $msp = Get-MsolServicePrincipal -AppPrincipalId $spoappid
-$spns = $msp.ServicePrincipalNames
+$spns = $msp.ServicePrincipalNames
$spns ``` You should see a current list of SPNs for SharePoint in Microsoft 365 in your Microsoft 365 organization, and one of the SPNs should include your public root domain name, prefaced by the SharePoint in Microsoft 365 application principal ID. This registration is a wildcard registration and should look like the following example:
-
+ `00000003-0000-0ff1-ce00-000000000000/*.<public domain name>.com`
-
-This should be the *only* SPN in the list that includes your public root domain name.
-
+
+This should be the *only* SPN in the list that includes your public root domain name.
+ #### Step 4: Register the SharePoint in Microsoft 365 application principal object ID with SharePoint Server <a name="step6"> </a> This step registers the SharePoint in Microsoft 365 application principal object ID with the on-premises SharePoint in Microsoft 365 Application Management Service, which allows SharePoint Server to authenticate to SharePoint in Microsoft 365 using OAuth.
-
+ From the PowerShell command prompt, type the following commands.
-
+ ```powershell $spoappprincipalID = (Get-MsolServicePrincipal -ServicePrincipalName $spoappid).ObjectID $sponameidentifier = "$spoappprincipalID@$spocontextID"
$appPrincipal = Register-SPAppPrincipal -site $site.rootweb -nameIdentifier $spo
``` To validate this step, from the PowerShell command prompt, type the $appPrincipal variable:
-
+ ```powershell $appPrincipal | fl ``` The expected output is a description of the registered application principal with the name **SharePoint Online**, which should look something like this.
-
+ ![Registered application principal for SharePoint in Microsoft 365](../media/ValidateRegister_SPO.jpg)
-
+ #### Step 5: Set the SharePoint in Microsoft 365 authentication realm <a name="step7"> </a> This step sets the authentication realm of your SharePoint Server farm to the context ID of the organization's Microsoft 365 organization.
-
+ From the PowerShell command prompt, enter the following command:
-
+ ```powershell Set-SPAuthenticationRealm -realm $spocontextID ``` To validate this step, from the PowerShell command prompt, enter the following commands:
-
+ ```powershell $spocontextID Get-SPAuthenticationRealm ``` The output of each of these commands is the GUID that represents the context ID of the SharePoint in Microsoft 365 tenancy. These GUIDs should be identical.
-
+ > [!IMPORTANT]
-> If you have configured farm setup scripts that specify the farm authentication realm value, you should update the setup scripts with this new value before you run them again. > For more information about the requirements for realm values in farm setup scripts, see [Plan for server-to-server authentication in SharePoint Server](../security-for-sharepoint-server/plan-server-to-server-authentication.md). Because you have now configured this SharePoint farm to participate in the hybrid configuration, the SharePoint farm authentication realm value must always match the tenant context identifier. If you change this value, the farm will no longer participate in hybrid functionality.
-
+> If you have configured farm setup scripts that specify the farm authentication realm value, you should update the setup scripts with this new value before you run them again. > For more information about the requirements for realm values in farm setup scripts, see [Plan for server-to-server authentication in SharePoint Server](../security-for-sharepoint-server/plan-server-to-server-authentication.md). Because you have now configured this SharePoint farm to participate in the hybrid configuration, the SharePoint farm authentication realm value must always match the tenant context identifier. If you change this value, the farm will no longer participate in hybrid functionality.
+ #### Step 6: Configure an on-premises proxy for Azure Active Directory <a name="step8"> </a>
-In this step, you create an Azure Active Directory proxy service in the SharePoint Server farm. This enables Azure Active Directory as a *trusted token issuer* that SharePoint Server will use to sign and authenticate claims tokens from SharePoint in Microsoft 365.
-
+In this step, you create an Azure Active Directory proxy service in the SharePoint Server farm. This enables Azure Active Directory as a *trusted token issuer* that SharePoint Server will use to sign and authenticate claims tokens from SharePoint in Microsoft 365.
+ From the PowerShell command prompt, enter the following commands.
-
+ ```powershell New-SPAzureAccessControlServiceApplicationProxy -Name "ACS" -MetadataServiceEndpointUri $metadataEndpoint -DefaultProxyGroup New-SPTrustedSecurityTokenIssuer -MetadataEndpoint $metadataEndpoint -IsTrustBroker:$true -Name "ACS" ```
-To validate the **New-SPAzureAccessControlServiceApplicationProxy** command:
-
+To validate the **New-SPAzureAccessControlServiceApplicationProxy** command:
+ 1. Browse the SharePoint 2016 Central Administration website, and select **Security** > **General Security** > **Manage trust**.
-
+ 2. Make sure you have an entry with a name that begins with **ACS**, and the enter **Trusted Service Consumer**.
-
+ To validate this step, from the PowerShell command prompt, enter the following command.
-
+ ```powershell Get-SPTrustedSecurityTokenIssuer ```
-
- The output that's expected is a description of the farm's trusted token issuer, where the value of the **RegisteredIssuerName** property is the following:
-
+
+ The output that's expected is a description of the farm's trusted token issuer, where the value of the **RegisteredIssuerName** property is the following:
+ `00000001-0000-0000-c000-000000000000@<context ID>`
-
+ Where:
-
+ - \<context ID\> is the context ID of your SharePoint in Microsoft 365 tenancy, which is the value in the $spocontextID variable. #### Step 7: Update Hybrid federated search
The script must be run on a server where SharePoint On-Premises is installed (20
``` For more information on the parameter values, run the following command:
-
+ ```powershell Get-Help .\Update-FederatedHybridSearchForM365.ps1 ```
The script must be run on a server where SharePoint On-Premises is installed (20
SharePoint Server 2013 needs a hidden constraint in every federated query. The reverse proxy returns the documents indexed in the reverse proxy site itself, not the internal on-premise search site as expected. To avoid this, you need to execute the following steps in your SharePoint Server 2013 admin site:
-1. Go to <CentralAdminURL>/_layouts/appinv.aspx and Search for **c3959f3a-5ad4-4d2b-b1f0-bc70f9a5d0a1**, where you should find **Greenland Federated Search Bot Skill**.
+1. Go to `<CentralAdminURL>/_layouts/appinv.aspx` and Search for **c3959f3a-5ad4-4d2b-b1f0-bc70f9a5d0a1**, where you should find **Greenland Federated Search Bot Skill**.
2. If there are items in the App Domain field, leave them be, and if it is empty, use localhost.
-
+ 3. In the Redirect URL, use https://localhost.
-
+ 4. In the Permission Request XML field, paste the following XML excerpt:
-
- ```xml
-<AppPermissionRequests>
-<AppPermissionRequest Scope="http://sharepoint/search" Right="QueryAsUserIgnoreAppPrincipal" />
-</AppPermissionRequests>
- ```
+
+ ```xml
+ <AppPermissionRequests>
+ <AppPermissionRequest Scope="http://sharepoint/search" Right="QueryAsUserIgnoreAppPrincipal" />
+ </AppPermissionRequests>
+ ```
+ 5. The configuration page should appear similar to the following screenshot. Finally, select **Create**. ![Give QueryAsUserIgnoreAppPrincipal permission to app](../media/QueryAsUserIgnoreAppPrincipal.png)
-
+ ## Validation and next steps <a name="next"> </a> After finishing the tasks in this topic and its validation steps, you should check your SSO and Directory Synchronization setup.
-
+ So that you have a history of the steps you've taken, you should capture the entire contents of the PowerShell buffer into a file. This will be crucial if you need to reference your configuration history to troubleshoot, or for any other reasons. This will also help you pick up where you left off if the configuration spans multiple days or involves multiple people.
-
+ After you have completed and validated the configuration tasks in this topic, continue with your [configuration roadmap](configuration-roadmaps.md).
-
+ ## See also <a name="next"> </a> [Hybrid for SharePoint Server](hybrid.md)
-
+ [Install and configure SharePoint Server hybrid](install-and-configure-sharepoint-server-hybrid.md)
SharePoint Bestpractices For Sharepointserver Installation https://github.com/MicrosoftDocs/OfficeDocs-SharePoint/commits/public/SharePoint/SharePointServer/install/BestPractices-for-SharePointServer-Installation.md
Installing a new version gives the opportunity to review what you have done in t
As you prepare for your installation, consider the following:
-ΓÇó Are you staying on Server (on-premises) for the foreseeable future?
+- Are you staying on Server (on-premises) for the foreseeable future?
-ΓÇó Do you currently have existing pieces of your system in the cloud?
+- Do you currently have existing pieces of your system in the cloud?
-ΓÇó What customizations or features do you no longer use?
+- What customizations or features do you no longer use?
-ΓÇó Are you ready for a modern approach?
-
- ΓÇó What is working well now, and what isnΓÇÖt?
+- Are you ready for a modern approach?
+- What is working well now, and what isn't?
## Evaluating what features or services are no longer supported
-As you install a new version of SharePoint Server, take time to evaluate any service applications or features that you currently rely on that are no longer supported or listed as ΓÇ£deprecatedΓÇ¥.
+As you install a new version of SharePoint Server, take time to evaluate any service applications or features that you currently rely on that are no longer supported or listed as "deprecated".
If you have a reliance on any of the following, plan what you intend to replace that functionality with or if it is no longer being used actively by your company and it is time to phase it out. Use supported service applications and consider phasing out the use of these deprecated service applications. For any of the SharePoint BI tools, you can use PowerBI as a replacement: - |Deprecated feature or service| |:--| |Access Services and Access Services 2010 |
If you currently have SharePoint Server installed, chances are you have made som
If you already have a portion of your company in the cloud or plan to do so in the future, know that certain customizations will not transfer to SharePoint. Here is a list of few of those:
-ΓÇó Workflows, User Alerts, and custom master pages will not transfer to SharePoint. We recommend you use Power Automate for workflows, reconfigure alerts once migrated, and use the out of the box customization for site look and feel changes.
+- Workflows, User Alerts, and custom master pages will not transfer to SharePoint. We recommend you use Power Automate for workflows, reconfigure alerts once migrated, and use the out of the box customization for site look and feel changes.
-ΓÇó Custom Search schema will not transfer to SharePoint. When content is migrated to SharePoint, you may want to re-implement any custom Search schema configuration necessary.
+- Custom Search schema will not transfer to SharePoint. When content is migrated to SharePoint, you may want to re-implement any custom Search schema configuration necessary.
-ΓÇó Use SharePoint Add-ins with the Low Trust model. To learn more, see [Creating SharePoint add in that use low trust authorization](/sharepoint/dev/sp-add-ins/creating-sharepoint-add-ins-that-use-low-trust-authorization).
+- Use SharePoint Add-ins with the Low Trust model. To learn more, see [Creating SharePoint add in that use low trust authorization](/sharepoint/dev/sp-add-ins/creating-sharepoint-add-ins-that-use-low-trust-authorization).
-ΓÇó Use SharePoint Framework solutions for custom business solutions. To get started, see [SharePoint Framework Overview](/sharepoint/dev/spfx/sharepoint-framework-overview).
+- Use SharePoint Framework solutions for custom business solutions. To get started, see [SharePoint Framework Overview](/sharepoint/dev/spfx/sharepoint-framework-overview).
## Connect your data the modern way Do you use Business Data Connectivity Services (BCS) for any of your data connections? Are your data sources available by using a web service? verify all data sources are available via other means, such as a web service.
-ΓÇó Where is your data? Where will it reside?
+- Where is your data? Where will it reside?
Instead of using BCS to display your data, you could use PowerBI and a Data Management Gateway. ## Adopt the modern features
-If a portion of your sites are already in the cloud, or if you intend on moving online in the future, adopting the modern features now will help ΓÇ£futureproofΓÇ¥ your installation.
+If a portion of your sites are already in the cloud, or if you intend on moving online in the future, adopting the modern features now will help "futureproof" your installation.
-ΓÇó Use Microsoft 365 Groups and Power Automate. Retire the use of email, Site mailboxes, or Mobile Accounts (SMS/Text Messaging)
+- Use Microsoft 365 Groups and Power Automate. Retire the use of email, Site mailboxes, or Mobile Accounts (SMS/Text Messaging)
-ΓÇó Solutions that intercept and/or modify the HTTP pipeline you could use Azure Conditional Access Policies by fronting the farm by using the Azure AD App Proxy. For more information on how to use AD FS, see [Access Control Policies in Windows Server 2016 AD FS](/windows-server/identity/ad-fs/operations/access-control-policies-in-ad-fs).
+- Solutions that intercept and/or modify the HTTP pipeline you could use Azure Conditional Access Policies by fronting the farm by using the Azure AD App Proxy. For more information on how to use AD FS, see [Access Control Policies in Windows Server 2016 AD FS](/windows-server/identity/ad-fs/operations/access-control-policies-in-ad-fs).
-ΓÇó Implement only the necessary Web Application Policies, such as self-service site creation, Object Cache, and Search Crawler accounts, but try to avoid further usage of Web Application Policies as they are not available in SharePoint.
+- Implement only the necessary Web Application Policies, such as self-service site creation, Object Cache, and Search Crawler accounts, but try to avoid further usage of Web Application Policies as they are not available in SharePoint.
-ΓÇó For security purposes, phase out the use of anonymous SharePoint Server sites. Also note that anonymous site access is not available in SharePoint in Microsoft 365.
+- For security purposes, phase out the use of anonymous SharePoint Server sites. Also note that anonymous site access is not available in SharePoint in Microsoft 365.
SharePoint Hardware And Software Requirements https://github.com/MicrosoftDocs/OfficeDocs-SharePoint/commits/public/SharePoint/SharePointServer/install/hardware-and-software-requirements.md
Title: Hardware and software requirements for SharePoint Server 2016-+
- IT_Sharepoint_Server - IT_Sharepoint_Server_Top - Strat_SP_server-+ ms.assetid: 4d88c402-24f2-449b-86a6-6e7afcfec0cd description: Find out the minimum hardware and software requirements you need to install and run SharePoint Server 2016. # Hardware and software requirements for SharePoint Server 2016
-
+ > [!IMPORTANT]
-> If you contact Microsoft Customer Support Services about a production system that does not meet the minimum hardware specifications described in this document, support will be limited until the system is upgraded to the minimum requirements.
-
-
+> If you contact Microsoft Customer Support Services about a production system that does not meet the minimum hardware specifications described in this document, support will be limited until the system is upgraded to the minimum requirements.
+ ## Hardware requirements: Location of physical servers <a name="hwLocServers"> </a>
-Some enterprises have datacenters that are in close proximity to one another and connected by high-bandwidth fiber optic links. In this environment, you can configure the two datacenters as a single farm. This distributed farm topology is called a stretched farm. Stretched farms for SharePoint Server 2016 are supported.
-
+Some enterprises have datacenters that are in close proximity to one another and connected by high-bandwidth fiber optic links. In this environment, you can configure the two datacenters as a single farm. This distributed farm topology is called a stretched farm. Stretched farms for SharePoint Server 2016 are supported.
+ For a stretched farm architecture to work as a supported high-availability solution, the following prerequisites must be met:
-
+ - There is a highly consistent intra-farm latency of \<1 ms one way, 99.9% of the time over a period of ten minutes. (Intra-farm latency is commonly defined as the latency between the front-end web servers and the database servers.)
-
+ - The bandwidth speed must be at least 1 gigabit per second.
-
+ To provide fault tolerance in a stretched farm, use the standard best practice guidance to configure redundant service applications and databases.
-
-> [!NOTE]
+
+> [!NOTE]
> The intra-farm latency of \<1 ms one way, 99.9% of the time over a period of ten minutes is also required for SharePoint environments with servers that are located in the same datacenter. The bandwidth speed should also be in this case at least 1 gigabit per second.
-
+ ## Hardware requirements: SharePoint server installations <a name="hwforwebserver"> </a> The following table lists minimum hardware requirements for installing and running SharePoint Server 2016 in a multiple server farm installation.
-
+ For all installation scenarios, you must have sufficient hard disk space for the base installation and sufficient space for diagnostics such as logging, debugging, creating memory dumps, and so on. For production use, you must also have additional free disk space for day-to-day operations. In addition, maintain two times as much free space as you have RAM for production environments.
-
+ For information about hardware and software requirements for Microsoft SQL Server 2014, see [Hardware and Software Requirements for Installing SQL Server 2014](/sql/sql-server/install/hardware-and-software-requirements-for-installing-sql-server).
-
-|**Installation scenario**|**Deployment type and scale**|**RAM**|**Processor**|**Hard disk space**|
-|:--|:--|:--|:--|:--|
-|Single server role that uses SQL Server <br/> |Development or evaluation installation of SharePoint Server 2016 with the minimum recommended services for development environments. Use the Single-Server farm role that will let you choose which service applications to provision. For additional information on Single-Server farm role, see [Overview of MinRole Server Roles in SharePoint Server 2016](overview-of-minrole-server-roles-in-sharepoint-server.md) <br/> |16 GB <br/> |64-bit, 4 cores <br/> |80 GB for system drive <br/> 100 GB for second drive <br/> |
-|Single server role that uses SQL Server <br/> |Pilot or user acceptance test installation of SharePoint Server 2016 running all available services for development environments. <br/> |24 GB <br/> |64-bit, 4 cores <br/> |80 GB for system drive <br/> 100 GB for second drive and additional drives <br/> |
-|SharePoint server in a multiple server farm <br/> |Development or evaluation installation of SharePoint Server 2016 with a minimum number of services. <br/> |12 GB <br/> |64-bit, 4 cores <br/> |80 GB for system drive <br/> 80 GB for second drive <br/> |
-|SharePoint server in a multiple server farm <br/> |Pilot, user acceptance test, or production deployment of SharePoint Server 2016 running all available services. <br/> |16 GB <br/> |64-bit, 4 cores <br/> |80 GB for system drive <br/> 80 GB for second drive and additional drives <br/> |
-
+
+|Installation scenario|Deployment type and scale|RAM|Processor|Hard disk space|
+||||||
+|Single server role that uses SQL Server|Development or evaluation installation of SharePoint Server 2016 with the minimum recommended services for development environments. Use the Single-Server farm role that will let you choose which service applications to provision. For additional information on Single-Server farm role, see [Overview of MinRole Server Roles in SharePoint Server 2016](overview-of-minrole-server-roles-in-sharepoint-server.md)|16 GB|64-bit, 4 cores|80 GB for system drive <br/> 100 GB for second drive|
+|Single server role that uses SQL Server|Pilot or user acceptance test installation of SharePoint Server 2016 running all available services for development environments.|24 GB|64-bit, 4 cores|80 GB for system drive <br/> 100 GB for second drive and additional drives|
+|SharePoint server in a multiple server farm|Development or evaluation installation of SharePoint Server 2016 with a minimum number of services.|12 GB|64-bit, 4 cores|80 GB for system drive <br/> 80 GB for second drive|
+|SharePoint server in a multiple server farm|Pilot, user acceptance test, or production deployment of SharePoint Server 2016 running all available services.|16 GB|64-bit, 4 cores|80 GB for system drive <br/> 80 GB for second drive and additional drives|
+ ## Deployment requirements: Farm Topology <a name="hwforwebserver"> </a> For information about how to plan for a server deployment, see [Planning for a MinRole server deployment in SharePoint Server 2016](planning-for-a-minrole-server-deployment-in-sharepoint-server.md).
-
+ ## Software requirements for SharePoint Server 2016 <a name="section4"> </a> The requirements in the following section apply to the following installations:
-
+ - Server farm with a single server in the farm
-
+ - Server farm with multiple servers in the farm
-
+ > [!NOTE]
-> Before you run the SharePoint prerequisite installer on Windows Server 2012 R2, you need to install [Windows RT 8.1, Windows 8.1, and Windows Server 2012 R2 update: April 2014](https://support.microsoft.com/kb/2919355). The SharePoint prerequisite installer does not install this update for you.
-
+> Before you run the SharePoint prerequisite installer on Windows Server 2012 R2, you need to install [Windows RT 8.1, Windows 8.1, and Windows Server 2012 R2 update: April 2014](https://support.microsoft.com/kb/2919355). The SharePoint prerequisite installer does not install this update for you.
+ > [!NOTE] > SharePoint Server 2016 supports drives that are formatted with the Resilient File System (ReFS). For additional information about ReFs, see [Resilient File System Overview](/previous-versions/windows/it-pro/windows-server-2012-R2-and-2012/hh831724(v=ws.11)) and [Resilient File System](/windows/win32/w8cookbook/resilient-file-system--refs-) > [!IMPORTANT] > SharePoint Server 2016 requires a minimum Active Directory domain and forest functional level of Windows Server 2003 (native). For more information about Active Directory functional levels, see [Forest and Domain Functional Levels](/windows-server/identity/ad-ds/active-directory-functional-levels).
-
+ > [!IMPORTANT]
-> SharePoint Server 2016 does not support single label domain names. For more information, see [Information about configuring Windows for domains with single-label DNS names](/troubleshoot/windows-server/identity/deployment-operation-ad-domains).
-
+> SharePoint Server 2016 does not support single label domain names. For more information, see [Information about configuring Windows for domains with single-label DNS names](/troubleshoot/windows-server/identity/deployment-operation-ad-domains).
+ The Microsoft SharePoint Products Preparation Tool can assist you in the installation of the software prerequisites for SharePoint Server 2016. Ensure that you have an Internet connection because some prerequisites are installed from the Internet.
-
+ ### Minimum software requirements for SharePoint Server 2016 This section provides minimum software requirements for each server in the farm.
-
+ #### Minimum requirements for a database server in a farm One of the following:
-
+ - A Standard or Enterprise Edition of SQL Server for Windows that supports database compatibility level 110. This includes SQL Server 2012, SQL Server 2014, SQL Server 2016, SQL Server 2017, SQL Server 2019, and any future version of SQL Server for Windows that supports database compatibility level 110. For more information about database compatibility levels, see [Compatibility Certification](/sql/database-engine/install-windows/compatibility-certification) and [ALTER DATABASE (Transact-SQL) Compatibility Level](/sql/t-sql/statements/alter-database-transact-sql-compatibility-level). - Microsoft Azure SQL Managed Instance (MI). This is only supported if your SharePoint Server farm is hosted in Microsoft Azure. For more information, see [Deploy Azure SQL Managed Instance with SharePoint Servers 2016 and 2019](../administration/deploy-azure-sql-managed-instance-with-sharepoint-servers-2016-2019.md).
-
+ > [!NOTE]
-> SQL Server products and all future public updates are supported through the SQL Server product lifecycle.
-
+> SQL Server products and all future public updates are supported through the SQL Server product lifecycle.
+ > [!NOTE] > To take advantage of any BI scenarios, you must have the latest Powerview and PowerPivot add-ins for Microsoft SQL Server 2016 RTM. To download the PowerPivot add-ins see, [Microsoft® SQL Server® 2016 PowerPivot® for Microsoft SharePoint® 2016](https://go.microsoft.com/fwlink/?LinkID=716860)
-
+ > [!NOTE] > SQL Server Express is not supported. Azure SQL Database (the non-Managed Instance DBaaS service) is also not supported for any SharePoint databases.
-
+ One of the following server operating systems:
-
+ - Windows Server 2012 R2 Standard or Datacenter
-
+ - Windows Server 2016 Standard or Datacenter
-
+ - Windows Server 2019 Standard or Datacenter #### Minimum requirements for SharePoint servers in a farm One of the following server operating systems:
-
+ - Windows Server 2012 R2 Standard or Datacenter
-
+ - Windows Server 2016 Standard or Datacenter - Windows Server 2019 Standard or Datacenter
-
+ > [!NOTE] > Installing the Office 2016 client and SharePoint Server 2016 on the same computer is not supported.
-
+ > [!NOTE] > SharePoint Server 2016 only supports the "Server with Desktop Experience" installation option of Windows Server 2016 and Windows Server 2019. For additional information about Windows Server offerings, see [Windows Server Semi-annual Channel Overview](/windows-server/get-started/semi-annual-channel-overview)
One of the following server operating systems:
> SharePoint Server 2016 supports Windows Server 2019 starting with the [Security Update for Microsoft SharePoint Enterprise Server 2016 (KB4011244)](https://support.microsoft.com/help/4011244/descriptionofthesecurityupdateforsharepointserver2016november14-2017), also known as the November 2017 Public Update for SharePoint Server 2016. This update (or a newer Public Update for SharePoint Server 2016) must be installed before you can create a new SharePoint farm or join a server to an existing SharePoint farm using Windows Server 2019. The Microsoft SharePoint Products Preparation Tool installs the following prerequisites on SharePoint servers in a farm:
-
+ - Web Server (IIS) role
-
+ - Application Server role - Microsoft .NET Framework version 3.5
-
+ - Microsoft .NET Framework version 4.6
-
+ - Microsoft SQL Server 2012 Service Pack 1 Native Client - Microsoft WCF Data Services 5.6
-
+ - Microsoft Identity Extensions
-
+ - Microsoft Information Protection and Control Client (MSIPC)
-
+ - Microsoft Sync Framework Runtime v1.0 SP1 (x64)
-
+ - Windows Server AppFabric 1.1
-
+ - Cumulative Update Package 7 for Microsoft AppFabric 1.1 for Windows Server (KB 3092423)
-
+ - Microsoft ODBC Driver 11 for SQL Server
-
+ - Visual C++ Redistributable Package for Visual Studio 2012
-
+ - Visual C++ Redistributable Package for Visual Studio 2015 >[!NOTE] >The required software above will be supported when used by SharePoint via the SharePoint Product Lifecycle.
-
+ #### Minimum requirements for client computers - A supported browser. For more information, see [Plan browser support in SharePoint Server 2016](browser-support-planning-2016-2019.md).
-
+ ## Optional software supported in SharePoint Server 2016 <a name="OptionalSoftware"> </a> The optional software in this section is supported but is not required to install or use SharePoint Server 2016. This software might be required by capabilities such as business intelligence.
-
-|**Environment**|**Optional software**|
-|:--|:--|
-|Single server farm, front-end web servers, and application servers in a farm <br/> | .NET Framework Data Provider for SQL Server (part of Microsoft .NET Framework) <br/> .NET Framework Data Provider for OLE DB (part of Microsoft .NET Framework) <br/> Workflow Manager <br/> You can install Workflow Manager on a dedicated computer. <br/> Microsoft SQL Server 2008 R2 Reporting Services Add-in for Microsoft SharePoint Technologies <br/> This add-in is used by Access Services for SharePoint Server 2016. <br/> Microsoft SQL Server 2012 Data-Tier Application (DAC) Framework 64-bit edition <br/> Microsoft SQL Server 2012 Transact-SQL ScriptDom 64-bit edition <br/> Microsoft System CLR Types for Microsoft SQL Server 2012 64-bit edition <br/> Microsoft SQL Server 2012 with SP1 LocalDB 64-bit edition <br/> Microsoft Data Services for the .NET Framework 4 and Silverlight 4 (formerly ADO.NET Data Services) <br/> Exchange Web Services Managed API, version 1.2 <br/> Microsoft SQL Server 2008 R2 Remote Blob Store which is part of the Microsoft SQL Server 2008 R2 Feature Pack <br/> SQL Server 2008 R2 Analysis Services ADOMD.NET <br/> |
-
+
+|Environment|Optional software|
+|||
+|Single server farm, front-end web servers, and application servers in a farm|.NET Framework Data Provider for SQL Server (part of Microsoft .NET Framework) <br/> .NET Framework Data Provider for OLE DB (part of Microsoft .NET Framework) <br/> Workflow Manager <br/> You can install Workflow Manager on a dedicated computer. <br/> Microsoft SQL Server 2008 R2 Reporting Services Add-in for Microsoft SharePoint Technologies <br/> This add-in is used by Access Services for SharePoint Server 2016. <br/> Microsoft SQL Server 2012 Data-Tier Application (DAC) Framework 64-bit edition <br/> Microsoft SQL Server 2012 Transact-SQL ScriptDom 64-bit edition <br/> Microsoft System CLR Types for Microsoft SQL Server 2012 64-bit edition <br/> Microsoft SQL Server 2012 with SP1 LocalDB 64-bit edition <br/> Microsoft Data Services for the .NET Framework 4 and Silverlight 4 (formerly ADO.NET Data Services) <br/> Exchange Web Services Managed API, version 1.2 <br/> Microsoft SQL Server 2008 R2 Remote Blob Store which is part of the Microsoft SQL Server 2008 R2 Feature Pack <br/> SQL Server 2008 R2 Analysis Services ADOMD.NET|
+ ## Links to applicable software <a name="section5"> </a> To install Windows Server 2012 R2, SQL Server 2014 Service Pack 1 (SP1) , or SharePoint Server 2016, you can go to the websites that are listed in this section. You can install most software prerequisites through the SharePoint Server 2016 Start page. The software prerequisites are also available from websites that are listed in this section. You can enable the Web Server (IIS) role and the Application Server role in Server Manager.
-
+ In scenarios where installing prerequisites directly from the Internet is not possible, you can download the prerequisites and then install them from a network share. For more information, see [Install prerequisites for SharePoint Server from a network share](install-prerequisites-from-network-share.md).
-
+ - [SharePoint Server 2016](https://go.microsoft.com/fwlink/?linkid=851069)
-
+ - [Language Packs for SharePoint Server 2016](https://go.microsoft.com/fwlink/?linkid=851068)
-
+ - [Windows Server 2012 R2](https://go.microsoft.com/fwlink/p/?LinkId=618401)
-
+ - [Windows Server 2016](https://go.microsoft.com/fwlink/?linkid=830779)
-
+ - [Office 365 Enterprise](https://www.microsoft.com/en-us/microsoft-365/enterprise/compare-office-365-plans)
-
+ - [Microsoft SQL Server 2014 Service Pack 1 (SP1)](https://go.microsoft.com/fwlink/p/?LinkId=618406)
-
+ - [Microsoft .NET Framework version 4.6](https://go.microsoft.com/fwlink/?LinkId=722763) - [Microsoft WCF Data Services 5.6](https://go.microsoft.com/fwlink/p/?LinkId=320724)
-
+ - [Microsoft Information Protection and Control Client (MSIPC)](https://go.microsoft.com/fwlink/p/?LinkId=544913)
-
+ - [Microsoft SQL Server 2012 Service Pack 1 (SP1) Native Client (installs with Microsoft SQL Server 2012 Feature Pack)](https://go.microsoft.com/fwlink/p/?LinkId=618409)
-
+ - [Microsoft ODBC Driver 11 for SQL Server](https://go.microsoft.com/fwlink/p/?LinkId=618410)
-
+ - [Microsoft Sync Framework Runtime v1.0 SP1 (x64)](https://go.microsoft.com/fwlink/p/?LinkId=618411)
-
+ - [Windows Server AppFabric 1.1](https://go.microsoft.com/fwlink/p/?LinkId=618412)
-
+ - [Cumulative Update Package 7 for AppFabric 1.1 for Windows Server](https://support.microsoft.com/kb/3092423)
-
+ - [Visual C++ Redistributable Package for Visual Studio 2012](https://go.microsoft.com/fwlink/p/?LinkId=327788)
-
+ - [Visual C++ Redistributable Package for Visual Studio 2015](https://go.microsoft.com/fwlink/p/?LinkId=620071)
-
+ - [Microsoft Silverlight 3](https://go.microsoft.com/fwlink/p/?LinkId=166506)
-
+ - [Exchange Web Services Managed API, version 1.2](https://www.nuget.org/packages/Microsoft.Exchange.WebServices/1.2.0)
-
+ - [Microsoft Identity Extensions](https://go.microsoft.com/fwlink/?LinkId=252368)
-
+ ## Prerequisite installer operations and command-line options <a name="section7"> </a> The SharePoint Server 2016 prerequisite installer (prerequisiteinstaller.exe) installs the following software, if it has not already been installed on the target server, in the following order:
-
+ 1. Application Server Role, Web Server (IIS) Role
-
+ 2. Microsoft SQL Server 2012 SP1 Native Client
-
+ 3. Microsoft ODBC Driver 11 for SQL Server
-
+ 4. Microsoft Sync Framework Runtime v1.0 SP1 (x64)
-
+ 5. Windows Server AppFabric 1.1
-
+ 6. Microsoft Identity Extensions
-
+ 7. Microsoft Information Protection and Control Client 2.1 8. Microsoft WCF Data Services 5.6
-
+ 9. Microsoft .NET Framework 4.6
-
+ 10. Cumulative Update Package 7 for Microsoft AppFabric 1.1 for Windows Server (KB 3092423)
-
+ 11. Visual C++ Redistributable Package for Visual Studio 2012
-
+ 12. Visual C++ Redistributable Package for Visual Studio 2015
-
+ You can run prerequisiteinstaller.exe at a command prompt with the following options. When you run prerequisiteinstaller.exe at a command prompt, you might be asked to restart the server one or more times during the installation process. After restarting, you should continue the prerequisite installation by running prerequisiteinstaller.exe with the `/continue` option.
-
+ - `/?` displays command-line options.
-
+ - `/continue` is used to tell the installer that it is continuing from being restarted.
-
+ - `/unattended` indicates no user interaction.
-
+ The installer installs from the file that you specify in the command-line options described in the following list. In this list, < _file_> signifies the file from which you want to install. If you do not specify the < _file_> option, the installer downloads the file from the Internet and installs it. If the option does not apply to the current operating system, it is ignored.
-
+ - **/SQLNCli:< _file_>** Install Microsoft SQL Server 2012 SP1 Native Client from < _file_>.
-
+ - **/IDFX11:< _file_>** Install Microsoft Identity Extensions from < _file_>.
-
+ - **/Sync:< _file_>** Install Microsoft Sync Framework Runtime SP1 v1.0 (x64) from < _file_>.
-
+ - **/AppFabric:< _file_>** Install Windows Server AppFabric from < _file_> (AppFabric must be installed with the options /i CacheClient,CachingService,CacheAdmin /gac).
-
+ - **/KB3092423:< _file_>** Install Cumulative Update Package 7 for Microsoft AppFabric 1.1 for Windows Server (KB3092423) from < _file_>.
-
+ - **/MSIPCClient:< _file_>** Install Microsoft Information Protection and Control Client from < _file_>. - **/WCFDataServices56:< _file_>** Install Microsoft WCF Data Services 5.6 from < _file_>.
-
+ - **/ODBC:< _file_>** Install Microsoft ODBC Driver 11 for SQL Server from < _file_>.
-
+ - **/DotNetFx:< _file_>** Install Microsoft .NET Framework 4.6 from < _file_>.
-
+ - **/MSVCRT11:< _file_>** Install Visual C++ Redistributable Package for Visual Studio 2012 from < _file_>.
-
+ - **/MSVCRT14:< _file_>** Install Visual C++ Redistributable Package for Visual Studio 2015 from < _file_>.
-
+ ### Installation options Certain prerequisites are installed by the prerequisite installer with specific options. Those prerequisites with specific installation options are listed below with the options that are used by the prerequisite installer.
-
+ - Windows AppFabric
-
+ /i CacheClient,CachingService,CacheAdmin /gac
-
+ - Microsoft WCF Data Services
-
+ /quiet
-
+ The prerequisite installer creates log files at %TEMP%\prerequisiteinstaller.\<date\>.\<time\>.log. You can check these log files for specific details about all changes the installer makes to the target computer.
SharePoint Hardware And Topology Requirements For Sharepoint Server Subscription Editon https://github.com/MicrosoftDocs/OfficeDocs-SharePoint/commits/public/SharePoint/SharePointServer/install/hardware-and-topology-requirements-for-sharepoint-server-subscription-editon.md
description: "Find out the minimum hardware requirements that you need for insta
[!INCLUDE [appliesto-xxx-xxx-xxx-SUB-xxx-md](../includes/appliesto-xxx-xxx-xxx-SUB-xxx-md.md)]
-
> [!IMPORTANT] > If you contact Microsoft Customer Support Services about a production system that does not meet the minimum hardware specifications described in this document, support will be limited until the system is upgraded to the minimum requirements.
-
-
+ ## Hardware requirements for SharePoint servers The values in the following table are minimum values for installations on servers that are running SharePoint Server in a multiple server farm installation.
The values in the following table are minimum values for installations on server
Ensure the following before you proceed with deployment of SharePoint environment: - For all installation scenarios:
- - You have sufficient hard disk space for the base installation.
- - You have sufficient hard disk space for diagnostics such as logging, debugging,
- creating memory dumps, and so on.
+ - You have sufficient hard disk space for the base installation.
+ - You have sufficient hard disk space for diagnostics such as logging, debugging, creating memory dumps, and so on.
- For production environment
- - You have additional free disk space for day-to-day operations.
- - Maintain two times as much as free space as you have RAM
+ - You have additional free disk space for day-to-day operations.
+ - Maintain two times as much as free space as you have RAM
-|**Installation scenario**|**Deployment type and scale**|**Processor**|**RAM**|**Hard disk**|
-|:--|:--|:--|:--|:--|
-|Single server role that uses SQL Server <br/> |Development or evaluation installation with the minimum recommended services for development environments. <br/> |64-bit, 4 cores <br/> |16 GB <br/> |80 GB for system drive <br/> 100 GB for second drive <br/> |
-|Single server role that uses SQL Server <br/> |Pilot or user acceptance test installation running all available services. <br/> |64-bit, 4 cores <br/> |24 GB <br/> |80 GB for system drive <br/> 100 GB for second drive and additional drives <br/> |
-|SharePoint server in a multi-tier farm <br/> |Development or evaluation installation with a minimum number of services. <br/> |64-bit, 4 cores <br/> |12 GB <br/> |80 GB for system drive <br/> 80 GB for second drive <br/> |
-|SharePoint server in a multi-tier farm <br/> |Pilot or user acceptance test installation running all available services. <br/> |64-bit, 4 cores <br/> |16 GB <br/> |80 GB for system drive <br/> 80 GB for second drive and additional drives <br/>
+|Installation scenario|Deployment type and scale|Processor|RAM|Hard disk|
+||||||
+|Single server role that uses SQL Server|Development or evaluation installation with the minimum recommended services for development environments.|64-bit, 4 cores|16 GB|80 GB for system drive <br/> 100 GB for second drive|
+|Single server role that uses SQL Server|Pilot or user acceptance test installation running all available services.|64-bit, 4 cores|24 GB|80 GB for system drive <br/> 100 GB for second drive and additional drives|
+|SharePoint server in a multi-tier farm|Development or evaluation installation with a minimum number of services.|64-bit, 4 cores|12 GB|80 GB for system drive <br/> 80 GB for second drive|
+|SharePoint server in a multi-tier farm|Pilot or user acceptance test installation running all available services.|64-bit, 4 cores|16 GB|80 GB for system drive <br/> 80 GB for second drive and additional drives|
> [!NOTE] > Hard disk space and number of drives depends on the amount of content and the way you choose to distribute data for a SharePoint environment.
To provide fault tolerance in a stretched farm, use the standard best practice g
<a name="hwforwebserver"> </a> SharePoint Server supports the same farm topologies as SharePoint Server 2019. For more information, see [Planning for a MinRole server deployment in SharePoint Server 2019](planning-for-a-minrole-server-deployment-in-sharepoint-server.md).-----
-
SharePoint Install Or Uninstall Language Packs Subscription https://github.com/MicrosoftDocs/OfficeDocs-SharePoint/commits/public/SharePoint/SharePointServer/install/install-or-uninstall-language-packs-subscription.md
Title: "Install or uninstall language packs for SharePoint Servers Subscription Edition"-+
- IT_Sharepoint_Server - IT_Sharepoint_Server_Top - SP2019
+ms.assetid:
description: "Learn how to download, install, and uninstall language packs for SharePoint Server Subscription Edition." # Install or uninstall language packs for SharePoint Servers Subscription Edition [!INCLUDE[appliesto-xxx-xxx-xxx-SUB-xxx-md](../includes/appliesto-xxx-xxx-xxx-SUB-xxx-md.md)]
-
+ Language packs enable site owners and site collection administrators to create SharePoint sites and site collections in multiple languages without requiring separate installations of SharePoint Server. You install language packs, which contain language-specific site templates, on each SharePoint server in your farm. When an administrator creates a site or a site collection that is based on a language-specific site template, the text that appears on the site or the site collection is displayed in the site template's language. Language packs are typically used in multinational deployments where a single server farm supports users in different locations, or when sites and web pages must be duplicated in one or more languages.
-
-Word breakers and stemmers enable you to search efficiently and effectively across content on SharePoint sites and site collections in multiple languages without requiring separate installations of SharePoint Server. Word breakers and stemmers are automatically installed on SharePoint servers by Setup.
-
+
+Word breakers and stemmers enable you to search efficiently and effectively across content on SharePoint sites and site collections in multiple languages without requiring separate installations of SharePoint Server. Word breakers and stemmers are automatically installed on SharePoint servers by Setup.
+ > [!IMPORTANT]
-> If you are uninstalling SharePoint Server, you must uninstall all language packs before you uninstall SharePoint Server.
-
+> If you are uninstalling SharePoint Server, you must uninstall all language packs before you uninstall SharePoint Server.
+ ## About language IDs and language packs <a name="section1"> </a> Site owners or site collection administrators who create sites or site collections can select a language for each site or site collection.
-
-The language that they select has a language identifier (ID). The language ID determines the language that is used to display and interpret text that is on the site or site collection. For example, when a site owner creates a site in French, the site's toolbars, navigation bars, lists, and column headings appear in French. Similarly, if a site owner creates a site in Arabic, the site's toolbars, navigation bars, lists, and column headings appear in Arabic. In addition, the default left-to-right orientation of the site changes to a right-to-left orientation to correctly display Arabic text.
-
+
+The language that they select has a language identifier (ID). The language ID determines the language that is used to display and interpret text that is on the site or site collection. For example, when a site owner creates a site in French, the site's toolbars, navigation bars, lists, and column headings appear in French. Similarly, if a site owner creates a site in Arabic, the site's toolbars, navigation bars, lists, and column headings appear in Arabic. In addition, the default left-to-right orientation of the site changes to a right-to-left orientation to correctly display Arabic text.
+ The language packs that are installed on the SharePoint servers determine the list of available languages that you can use to create a site or site collection. By default, sites and site collections are created in the language in which SharePoint Server was installed. For example, if you install the Spanish version of SharePoint Server, the default language for sites, site collections, and web pages is Spanish. If someone has to create sites, site collections, or web pages in a language other than the default SharePoint Server language, you must install the language pack for that language on the SharePoint servers. For example, if you are running the French version of SharePoint Server, and a site owner wants to create sites in French, English, and Spanish, you must install the English and Spanish language packs on the SharePoint servers.
-
+ By default, when a site owner creates a new web page in a site, the site displays text in the language that is specified by the language ID.
-
+ Language packs are not bundled into multilingual installation packages. You must install a specific language pack for each language that you want to support. Also, language packs must be installed on each SharePoint server to make sure that each SharePoint server can display content in the specified language.
-
+ > [!IMPORTANT]
-> You cannot change an existing site, site collection, or web page from one language to another by applying different language-specific site templates. After you use a language-specific site template for a site or a site collection, the site or site collection always displays content in the language of the original site template. For example, SharePoint can render the same site in multiple languages based on the preferred language of the userΓÇÖs web browser. But for this to work, the SharePoint language pack that matches the userΓÇÖs preferred language must be installed on each server in the SharePoint farm.
-
+> You cannot change an existing site, site collection, or web page from one language to another by applying different language-specific site templates. After you use a language-specific site template for a site or a site collection, the site or site collection always displays content in the language of the original site template. For example, SharePoint can render the same site in multiple languages based on the preferred language of the user's web browser. But for this to work, the SharePoint language pack that matches the user's preferred language must be installed on each server in the SharePoint farm.
+ Although a site owner specifies a language ID for a site, some user interface elements such as error messages, notifications, and dialogs do not display in the language that was specified. This is because SharePoint Server relies on several supporting technologies ΓÇö for example, the Microsoft .NET Framework, Microsoft Windows Workflow Foundation, Microsoft ASP.NET, and SQL Server ΓÇö some of which are localized into only a limited number of languages. If a user interface element is generated by any of the supporting technologies that are not localized into the language that the site owner specified for the site, the user interface element appears in English. For example, if a site owner creates a site in Hebrew, and the .NET Framework component displays a notification message, the notification message will not display in Hebrew because the .NET Framework is not localized into Hebrew. This situation can occur when sites are created in any language except the following: Chinese, French, German, Italian, Japanese, Korean, and Spanish.
-
-Each language pack that you install creates a folder at `%COMMONPROGRAMFILES%\Microsoft Shared\Web Server Extensions\16\TEMPLATE\LAYOUTS\Locale_ID` that contains language-specific data. In each locale_ID folder, you must have only one HTML error file that contains the error information that is used when a file cannot be found. Anytime a file cannot be found for any site in that language, this file will be used. You can specify the file to use by setting the **FileNotFoundPage()** for each web application.
-
+
+Each language pack that you install creates a folder at `%COMMONPROGRAMFILES%\Microsoft Shared\Web Server Extensions\16\TEMPLATE\LAYOUTS\Locale_ID` that contains language-specific data. In each locale_ID folder, you must have only one HTML error file that contains the error information that is used when a file cannot be found. Anytime a file cannot be found for any site in that language, this file will be used. You can specify the file to use by setting the **FileNotFoundPage()** for each web application.
+ In some cases, some text might originate from the original installation language, which can create a mixed-language experience. This kind of mixed-language experience is typically seen only by content creators or site owners and is not seen by site users.
-
+ ## Downloading language packs <a name="section2"> </a> Follow these steps for each language that you want to support. If you decide to download more than one language, please be aware that a unique file that has a common name is downloaded for each language. Therefore, make sure that you download each language pack to a separate folder on the hard disk so that you do not overwrite a language pack of a different language.
-
+ > [!IMPORTANT]
-> By default, the Microsoft PowerShell Help files are installed in English (en-us). To view these files in the same language as the operating system, install the language pack for the same language in which the operating system was installed.
-
-
+> By default, the Microsoft PowerShell Help files are installed in English (en-us). To view these files in the same language as the operating system, install the language pack for the same language in which the operating system was installed.
+ ## Installing language packs on the SharePoint Servers <a name="section4"> </a>
Language packs are available as individual downloads (one download for each supp
When you install language packs, the language-specific site templates are installed in the `%COMMONPROGRAMFILES%\Microsoft Shared\Web Server Extensions\16\TEMPLATE\ _LanguageID_` directory, where,
-`_LanguageID_` is the Language ID number for the language that you are installing.
+`_LanguageID_` is the Language ID number for the language that you are installing.
For example, the United States English language pack installs to the `%COMMONPROGRAMFILES%\Microsoft Shared\Web Server Extensions\16\TEMPLATE\1033` directory. After you install a language pack, site owners and site collection administrators can create sites and site collections based on the language-specific site templates by specifying a language when they are creating a new SharePoint site or site collection.
-
+ > [!IMPORTANT]
-> The language pack is installed in its native language. The procedure that follows is for the English language pack.
-
- ### Install a language pack on Windows Server with Desktop Experience
-
+> The language pack is installed in its native language. The procedure that follows is for the English language pack.
+
+### Install a language pack on Windows Server with Desktop Experience
+ Verify that the user account that is performing this procedure is the Setup user account. For information about the Setup user account, see [Initial deployment administrative and service accounts in SharePoint Server](initial-deployment-administrative-and-service-accounts-in-sharepoint-server.md).
-
+ 1. Mount the **ISO disc image** as a drive on your computer by double-clicking on it, or by specifying it as a virtual drive in your virtual machine manager. 2. Navigate to the mounted drive and run (`setup.exe`) to launch the language pack setup program.
-
+ 3. On the **Read the Microsoft Software License Terms** page, review the terms, select the **I accept the terms of this agreement** check box, and then click **Continue**.
-
+ 4. The Setup wizard runs and installs the language pack.
-
-5. Run the SharePoint Products Configuration Wizard by using the default settings.
-
+
+5. Run the SharePoint Products Configuration Wizard by using the default settings.
+ > [!NOTE] > If you do not run the SharePoint Products Configuration Wizard after you install a language pack, the language pack will not be installed correctly.
-
+ ### Run the SharePoint Products Configuration Wizard
-
+ Verify that the user account that is performing this procedure is the Setup user account. For information about the Setup user account, see [Initial deployment administrative and service accounts in SharePoint Server](initial-deployment-administrative-and-service-accounts-in-sharepoint-server.md).
-
+ 1. Click **Start**, point to **Microsoft SharePoint Products** folder, click **SharePoint Products Configuration Wizard**.
-
+ 2. On the **Welcome to SharePoint Products** page, click **Next**.
-
-3. Click **Yes** in the dialog that alerts you that some services might have to be restarted during configuration.
-
+
+3. Click **Yes** in the dialog that alerts you that some services might have to be restarted during configuration.
+ 4. On the **Modify Server Farm Settings** page, click **Do not disconnect from this server farm**, and then click **Next**.
-
+ 5. If the **Modify SharePoint Central Administration Web Administration Settings** page appears, do not change any of the default settings, and then click **Next**.
-
+ 6. After you complete the **Completing the SharePoint Products Configuration Wizard**, click **Next**.
-
+ 7. On the **Configuration Successful** page, click **Finish**.
-
+ 8. After you install a new language pack and run the **SharePoint Products Configuration Wizard**, you must deactivate and then reactivate any language-specific features before you use the new language pack. ### Install a language pack on Windows Server Core Verify that the user account that is performing this procedure is the Setup user account. For information about the Setup user account, see [Initial deployment administrative and service accounts in SharePoint Server](initial-deployment-administrative-and-service-accounts-in-sharepoint-server.md).
-1. Mount the ISO disc image as a drive on your computer by using the [Mount-DiskImage](/powershell/module/storage/mount-diskimage?view=windowsserver2019-ps) cmdlet, or by specifying it as a virtual drive in your virtual machine manager.
+1. Mount the ISO disc image as a drive on your computer by using the [Mount-DiskImage](/powershell/module/storage/mount-diskimage) cmdlet, or by specifying it as a virtual drive in your virtual machine manager.
2. Run Language Pack for SharePoint and Project Server Subscription Edition Setup (`setup.exe`) on your computer in command line mode. This is done by adding the following command line parameters when launching (`setup.exe`):
Verify that the user account that is performing this procedure is the Setup user
3. Once language pack for SharePoint and Project Server Server Subscription Edition setup has completed, reboot your computer. 4. Run **Install-SPHelpCollection -All**.
-
+ 5. Run **Initialize-SPResourceSecurity**.
-
+ 6. Run **Install-SPService**.
-
+ 7. Run **Install-SPFeature -AllExistingFeatures**.
-
-8. Run **Install-SPApplicationContent**.
+8. Run **Install-SPApplicationContent**.
### Uninstall a language pack on Windows Server with Desktop Experience 1. From the **Start** menu, click **Control Panel**. 2. Click **Uninstall** a program.
-
+ 3. In the list of currently installed programs, select **Language Pack for SharePoint and Project Server Subscription Edition - Language** and then click **Uninstall**.
-
+ 4. Click **Yes** to confirm that you want to remove the program.
-
+ 5. Click **OK** in the dialog-box alerting you that this might result in partial loss of functionality for sites that depends on this language pack.
-
-6. After the language pack has been successfully uninstalled, click **Close**.
+6. After the language pack has been successfully uninstalled, click **Close**.
### Uninstall a language pack on Windows Server Core
Verify that the user account that is performing this procedure is the Setup user
- `/config <config file>` (Where `<config file>` is the path to your `config.xml` file). - `/uninstall OSMUI.<language tag>` (This parameter signifies the language pack to uninstall).
-
+ For example, the following PowerShell command is used to uninstall Japanese language pack: ```powershell
- $env:CommonProgramFiles\Microsoft Shared\SERVER16\Server Setup Controller\setup.exe" /config "$env:CommonProgramFiles\Microsoft Shared\SERVER16\Server Setup Controller\config.xml" /uninstall OSMUI.JA-JP
+ $env:CommonProgramFiles\Microsoft Shared\SERVER16\Server Setup Controller\setup.exe" /config "$env:CommonProgramFiles\Microsoft Shared\SERVER16\Server Setup Controller\config.xml" /uninstall OSMUI.JA-JP
``` ## List of Languages
-Each folder name has a language tag appended to it, in the form ll-cc. That tag identifies the language and culture. For example, U.S. English language folders are identified by the folder name extension en-us.
+Each folder name has a language tag appended to it, in the form ll-cc. That tag identifies the language and culture. For example, U.S. English language folders are identified by the folder name extension en-us.
Folders for the language-specific components are identified by the language tag that is shown in the table. The Windows operating system uses locale identifiers (LCIDs) to identify languages in the Windows registry. SharePoint Servers Subscription Edition, 2019, and 2016 support the following languages: - |Language|Language tag|LCID|
-|:--|:--|:--|
-|Arabic <br/>|ar-sa <br/> | 1025 <br/>|
-|Azerbaijani <br/> |az-latn-az <br/> |1068 <br/>|
-|Basque <br/> |eu-es <br/> |1069 <br/>|
-|Bosnian (Latin) <br/> |bs-latn-ba <br/> |5146 <br/>|
-|Bulgarian <br/> |bg-bg <br/> |1026 <br/>|
-|Catalan <br/> |ca-es <br/> |1027 <br/>|
-|Chinese (Simplified) <br/> |zh-cn <br/> |2052 <br/>|
-|Chinese (Traditional) <br/> |zh-tw <br/> |1028 <br/>|
-|Croatian <br/> |hr-hr <br/> |1050 <br/>|
-|Czech <br/> |cs-cz <br/> |1029 <br/>|
-|Danish <br/> |da-dk <br/> |1030 <br/>|
-|Dutch <br/> |nl-nl <br/> |1043 <br/>|
-|English <br/> |en-us <br/> |1033 <br/>|
-|Estonian <br/> |et-ee <br/> |1061 <br/>|
-|Finnish <br/> |fi-fi <br/> |1035 <br/>|
-|French <br/> |fr-fr <br/> |1036 <br/>|
-|Galician <br/> |gl-es <br/> |1110 <br/>|
-|German <br/> |de-de <br/> |1031 <br/>|
-|Greek <br/> |el-el <br/> |1032 <br/>|
-|Hebrew <br/> |he-il <br/> |1037 <br/>|
-|Hindi <br/> |hi-in <br/> |1081 <br/>|
-|Hungarian <br/> |hu-hu <br/> |1038<br/>|
-|Indonesian <br/> |id-id <br/> |1057 <br/>|
-|Irish <br/> |ga-ie <br/> |2108 <br/>|
-|Italian <br/> |it-it <br/> |1040 <br/>|
-|Japanese <br/> |ja-jp <br/> |1041 <br/>|
-|Kazakh <br/> |kk-kz <br/> |1087 <br/>|
-|Korean <br/> |ko-kr <br/> |1042 <br/>|
-|Latvian <br/> |lv-lv <br/> |1062 <br/>|
-|Lithuanian <br/> |lt-lt <br/> |1063 <br/>|
-|Macedonian (FYROM) <br/> |mk-mk <br/> |1071 <br/>|
-|Malay (Malaysia) <br/> |ms-my <br/> |1086 <br/>|
-|Norwegian (Bokmål) <br/> |nb-no <br/> |1044 <br/>|
-|Polish <br/> |pl-pl <br/> |1045 <br/>|
-|Portuguese (Brazil) <br/> |pt-br <br/> |1046 <br/>|
-|Portuguese (Portugal) <br/> |pt-pt <br/> |2070<br/>|
-|Romanian <br/> |ro-ro <br/> |1048 <br/>|
-|Russian <br/> |ru-ru <br/> |1049 <br/>|
-|Serbian (Cyrillic) <br/> |sr-cyrl-rs <br/> |10266 <br/>|
-|Serbian (Latin) <br/> |sr-latn-rs <br/> |9242 <br/>|
-|Slovak <br/> |sk-sk <br/> |1051 <br/>|
-|Slovenian <br/> |sl-si <br/> |1060 <br/>|
-|Spanish <br/> |es-es <br/> |3082 <br/>|
-|Swedish <br/> |sv-se <br/> |1053 <br/>|
-|Thai <br/> |th-th <br/> |1054 <br/>|
-|Turkish <br/> |tr-tr <br/> |1055 <br/>|
-|Ukrainian <br/> |uk-ua <br/> |1058<br/>|
-|Vietnamese <br/> |vi-vn <br/> |1066 <br/>|
-|Welsh <br/> |cy-gb <br/> |1106 <br/>|
-
+||||
+|Arabic|ar-sa|1025|
+|Azerbaijani|az-latn-az|1068|
+|Basque|eu-es|1069|
+|Bosnian (Latin)|bs-latn-ba|5146|
+|Bulgarian|bg-bg|1026|
+|Catalan|ca-es|1027|
+|Chinese (Simplified)|zh-cn|2052|
+|Chinese (Traditional)|zh-tw|1028|
+|Croatian|hr-hr|1050|
+|Czech|cs-cz|1029|
+|Danish|da-dk|1030|
+|Dutch|nl-nl|1043|
+|English|en-us|1033|
+|Estonian|et-ee|1061|
+|Finnish|fi-fi|1035|
+|French|fr-fr|1036|
+|Galician|gl-es|1110|
+|German|de-de|1031|
+|Greek|el-el|1032|
+|Hebrew|he-il|1037|
+|Hindi|hi-in|1081|
+|Hungarian|hu-hu|1038|
+|Indonesian|id-id|1057|
+|Irish|ga-ie|2108|
+|Italian|it-it|1040|
+|Japanese|ja-jp|1041|
+|Kazakh|kk-kz|1087|
+|Korean|ko-kr|1042|
+|Latvian|lv-lv|1062|
+|Lithuanian|lt-lt|1063|
+|Macedonian (FYROM)|mk-mk|1071|
+|Malay (Malaysia)|ms-my|1086|
+|Norwegian (Bokmål)|nb-no|1044|
+|Polish|pl-pl|1045|
+|Portuguese (Brazil)|pt-br|1046|
+|Portuguese (Portugal)|pt-pt|2070|
+|Romanian|ro-ro|1048|
+|Russian|ru-ru|1049|
+|Serbian (Cyrillic)|sr-cyrl-rs|10266|
+|Serbian (Latin)|sr-latn-rs|9242|
+|Slovak|sk-sk|1051|
+|Slovenian|sl-si|1060|
+|Spanish|es-es|3082|
+|Swedish|sv-se|1053|
+|Thai|th-th|1054|
+|Turkish|tr-tr|1055|
+|Ukrainian|uk-ua|1058|
+|Vietnamese|vi-vn|1066|
+|Welsh|cy-gb|1106|
SharePoint Install Uninstall Language Packs 2019 https://github.com/MicrosoftDocs/OfficeDocs-SharePoint/commits/public/SharePoint/SharePointServer/install/install-uninstall-language-packs-2019.md
Title: "Install or uninstall language packs for SharePoint Servers 2016 and 2019"-+
description: "Learn how to download, install, and uninstall language packs for S
# Install or uninstall language packs for SharePoint Servers 2016 and 2019
-
+ Language packs enable site owners and site collection administrators to create SharePoint sites and site collections in multiple languages without requiring separate installations of SharePoint Server. You install language packs, which contain language-specific site templates, on each SharePoint server in your farm. When an administrator creates a site or a site collection that is based on a language-specific site template, the text that appears on the site or the site collection is displayed in the site template's language. Language packs are typically used in multinational deployments where a single server farm supports users in different locations, or when sites and web pages must be duplicated in one or more languages.
-
-Word breakers and stemmers enable you to search efficiently and effectively across content on SharePoint sites and site collections in multiple languages without requiring separate installations of SharePoint Server. Word breakers and stemmers are automatically installed on SharePoint servers by Setup.
-
+
+Word breakers and stemmers enable you to search efficiently and effectively across content on SharePoint sites and site collections in multiple languages without requiring separate installations of SharePoint Server. Word breakers and stemmers are automatically installed on SharePoint servers by Setup.
+ > [!IMPORTANT]
-> If you are uninstalling SharePoint Server, you must uninstall all language packs before you uninstall SharePoint Server.
-
+> If you are uninstalling SharePoint Server, you must uninstall all language packs before you uninstall SharePoint Server.
+ ## About language IDs and language packs <a name="section1"> </a> Site owners or site collection administrators who create sites or site collections can select a language for each site or site collection.
-
-The language that they select has a language identifier (ID). The language ID determines the language that is used to display and interpret text that is on the site or site collection. For example, when a site owner creates a site in French, the site's toolbars, navigation bars, lists, and column headings appear in French. Similarly, if a site owner creates a site in Arabic, the site's toolbars, navigation bars, lists, and column headings appear in Arabic. In addition, the default left-to-right orientation of the site changes to a right-to-left orientation to correctly display Arabic text.
-
+
+The language that they select has a language identifier (ID). The language ID determines the language that is used to display and interpret text that is on the site or site collection. For example, when a site owner creates a site in French, the site's toolbars, navigation bars, lists, and column headings appear in French. Similarly, if a site owner creates a site in Arabic, the site's toolbars, navigation bars, lists, and column headings appear in Arabic. In addition, the default left-to-right orientation of the site changes to a right-to-left orientation to correctly display Arabic text.
+ The language packs that are installed on the SharePoint servers determine the list of available languages that you can use to create a site or site collection. By default, sites and site collections are created in the language in which SharePoint Server was installed. For example, if you install the Spanish version of SharePoint Server, the default language for sites, site collections, and web pages is Spanish. If someone has to create sites, site collections, or web pages in a language other than the default SharePoint Server language, you must install the language pack for that language on the SharePoint servers. For example, if you are running the French version of SharePoint Server, and a site owner wants to create sites in French, English, and Spanish, you must install the English and Spanish language packs on the SharePoint servers.
-
+ By default, when a site owner creates a new web page in a site, the site displays text in the language that is specified by the language ID.
-
+ Language packs are not bundled into multilingual installation packages. You must install a specific language pack for each language that you want to support. Also, language packs must be installed on each SharePoint server to make sure that each SharePoint server can display content in the specified language.
-
+ > [!IMPORTANT]
-> You cannot change an existing site, site collection, or web page from one language to another by applying different language-specific site templates. After you use a language-specific site template for a site or a site collection, the site or site collection always displays content in the language of the original site template. For example, SharePoint can render the same site in multiple languages based on the preferred language of the userΓÇÖs web browser. But for this to work, the SharePoint language pack that matches the userΓÇÖs preferred language must be installed on each server in the SharePoint farm.
-
+> You cannot change an existing site, site collection, or web page from one language to another by applying different language-specific site templates. After you use a language-specific site template for a site or a site collection, the site or site collection always displays content in the language of the original site template. For example, SharePoint can render the same site in multiple languages based on the preferred language of the user's web browser. But for this to work, the SharePoint language pack that matches the user's preferred language must be installed on each server in the SharePoint farm.
+ Although a site owner specifies a language ID for a site, some user interface elements such as error messages, notifications, and dialogs do not display in the language that was specified. This is because SharePoint Server relies on several supporting technologies ΓÇö for example, the Microsoft .NET Framework, Microsoft Windows Workflow Foundation, Microsoft ASP.NET, and SQL Server ΓÇö some of which are localized into only a limited number of languages. If a user interface element is generated by any of the supporting technologies that are not localized into the language that the site owner specified for the site, the user interface element appears in English. For example, if a site owner creates a site in Hebrew, and the .NET Framework component displays a notification message, the notification message will not display in Hebrew because the .NET Framework is not localized into Hebrew. This situation can occur when sites are created in any language except the following: Chinese, French, German, Italian, Japanese, Korean, and Spanish.
-
-Each language pack that you install creates a folder at %COMMONPROGRAMFILES%\Microsoft Shared\Web Server Extensions\16\TEMPLATE\LAYOUTS\Locale_ID that contains language-specific data. In each locale_ID folder, you must have only one HTML error file that contains the error information that is used when a file cannot be found. Anytime a file cannot be found for any site in that language, this file will be used. You can specify the file to use by setting the **FileNotFoundPage()** for each web application.
-
+
+Each language pack that you install creates a folder at %COMMONPROGRAMFILES%\Microsoft Shared\Web Server Extensions\16\TEMPLATE\LAYOUTS\Locale_ID that contains language-specific data. In each locale_ID folder, you must have only one HTML error file that contains the error information that is used when a file cannot be found. Anytime a file cannot be found for any site in that language, this file will be used. You can specify the file to use by setting the **FileNotFoundPage()** for each web application.
+ In some cases, some text might originate from the original installation language, which can create a mixed-language experience. This kind of mixed-language experience is typically seen only by content creators or site owners and is not seen by site users.
-
+ ## Downloading language packs <a name="section2"> </a> Follow these steps for each language that you want to support. If you decide to download more than one language, please be aware that a unique file that has a common name is downloaded for each language. Therefore, make sure that you download each language pack to a separate folder on the hard disk so that you do not overwrite a language pack of a different language.
-
+ > [!IMPORTANT]
-> By default, the Microsoft PowerShell Help files are installed in English (en-us). To view these files in the same language as the operating system, install the language pack for the same language in which the operating system was installed.
-
+> By default, the Microsoft PowerShell Help files are installed in English (en-us). To view these files in the same language as the operating system, install the language pack for the same language in which the operating system was installed.
+ You can download language packs from the Microsoft Download Center for [SharePoint Server 2016](https://go.microsoft.com/fwlink/?LinkId=746633&amp;clcid=0x409) and [SharePoint Server 2019](https://www.microsoft.com/download/details.aspx?id=57463).
-
+ ## Installing language packs on the SharePoint servers <a name="section4"> </a> Language packs are available as individual downloads (one download for each supported language). If you have a server farm environment and you are installing language packs to support multiple languages, you must install the language packs on each SharePoint server.
-
+ > [!IMPORTANT]
-> The language pack is installed in its native language. The procedure that follows is for the English language pack.
-
- **To install a language pack**
-
+> The language pack is installed in its native language. The procedure that follows is for the English language pack.
+
+### To install a language pack
+ Verify that the user account that is performing this procedure is the Setup user account. For information about the Setup user account, see [Initial deployment administrative and service accounts in SharePoint Server](initial-deployment-administrative-and-service-accounts-in-sharepoint-server.md).
-
+ 1. In the folder where you downloaded the language pack, run serverlanguagepack.exe.
-
+ 2. On the **Read the Microsoft Software License Terms** page, review the terms, select the **I accept the terms of this agreement** check box, and then click **Continue**.
-
+ 3. The Setup wizard runs and installs the language pack.
-
+ 4. Rerun the SharePoint Products Configuration Wizard by using the default settings. If you do not run the SharePoint Products Configuration Wizard after you install a language pack, the language pack will not be installed correctly.
-
+ The SharePoint Products Configuration Wizard runs in the language of the base installation of SharePoint Server, not in the language of the language pack that you just installed.
-
- **To rerun the SharePoint Products Configuration Wizard**
-
+
+### To rerun the SharePoint Products Configuration Wizard
+ Verify that the user account that is performing this procedure is the Setup user account. For information about the Setup user account, see [Initial deployment administrative and service accounts in SharePoint Server](initial-deployment-administrative-and-service-accounts-in-sharepoint-server.md).
-
+ 1. Click **Start**, point to **Microsoft SharePoint 2019 Products** folder, click **SharePoint Products Configuration Wizard**.
-
+ 2. On the **Welcome to SharePoint Products** page, click **Next**.
-
-3. Click **Yes** in the dialog that alerts you that some services might have to be restarted during configuration.
-
+
+3. Click **Yes** in the dialog that alerts you that some services might have to be restarted during configuration.
+ 4. On the **Modify Server Farm Settings** page, click **Do not disconnect from this server farm**, and then click **Next**.
-
+ 5. If the **Modify SharePoint Central Administration Web Administration Settings** page appears, do not change any of the default settings, and then click **Next**.
-
+ 6. After you complete the Completing the **SharePoint Products Configuration Wizard**, click **Next**.
-
+ 7. On the **Configuration Successful** page, click **Finish**.
-
+ 8. After you install a new language pack and rerun the **SharePoint Products Configuration Wizard**, you must deactivate and then reactivate any language-specific features before you use the new language pack.
-
-When you install language packs, the language-specific site templates are installed in the %COMMONPROGRAMFILES%\Microsoft Shared\Web Server Extensions\16\TEMPLATE\ _LanguageID_ directory, where _LanguageID_ is the Language ID number for the language that you are installing. For example, the United States English language pack installs to the %COMMONPROGRAMFILES%\Microsoft Shared\Web Server Extensions\16\TEMPLATE\1033 directory. After you install a language pack, site owners and site collection administrators can create sites and site collections based on the language-specific site templates by specifying a language when they are creating a new SharePoint site or site collection.
-
+
+When you install language packs, the language-specific site templates are installed in the %COMMONPROGRAMFILES%\Microsoft Shared\Web Server Extensions\16\TEMPLATE\ _LanguageID_ directory, where _LanguageID_ is the Language ID number for the language that you are installing. For example, the United States English language pack installs to the %COMMONPROGRAMFILES%\Microsoft Shared\Web Server Extensions\16\TEMPLATE\1033 directory. After you install a language pack, site owners and site collection administrators can create sites and site collections based on the language-specific site templates by specifying a language when they are creating a new SharePoint site or site collection.
+ ## Uninstalling language packs <a name="section5"> </a> If you no longer have to support a language for which you have installed a language pack, you can remove the language pack by using the Control Panel. Removing a language pack removes the language-specific site templates from the computer. All sites that were created that have those language-specific site templates will no longer work (the URL will produce a HTTP 500 - Internal server error page). Reinstalling the language pack will make the site functional again.
-
+ You cannot remove the language pack for the version of SharePoint Server that you have installed on the server. For example, if you are running the Japanese version of SharePoint Server, you cannot uninstall the Japanese language support for SharePoint Server. ## List of Languages
-Each folder name has a language tag appended to it, in the form ll-cc. That tag identifies the language and culture. For example, U.S. English language folders are identified by the folder name extension en-us.
+Each folder name has a language tag appended to it, in the form ll-cc. That tag identifies the language and culture. For example, U.S. English language folders are identified by the folder name extension en-us.
Folders for the language-specific components are identified by the language tag that is shown in the table. The Windows operating system uses locale identifiers (LCIDs) to identify languages in the Windows registry. SharePoint Servers 2016 and 2019 support the following languages: |Language|Language tag|LCID|
-|:--|:--|:--|
-|Arabic <br/>|ar-sa <br/> | 1025 <br/>|
-|Azerbaijani <br/> |az-latn-az <br/> |1068 <br/>|
-|Basque <br/> |eu-es <br/> |1069 <br/>|
-|Bosnian (Latin) <br/> |bs-latn-ba <br/> |5146 <br/>|
-|Bulgarian <br/> |bg-bg <br/> |1026 <br/>|
-|Catalan <br/> |ca-es <br/> |1027 <br/>|
-|Chinese (Simplified) <br/> |zh-cn <br/> |2052 <br/>|
-|Chinese (Traditional) <br/> |zh-tw <br/> |1028 <br/>|
-|Croatian <br/> |hr-hr <br/> |1050 <br/>|
-|Czech <br/> |cs-cz <br/> |1029 <br/>|
-|Danish <br/> |da-dk <br/> |1030 <br/>|
-|Dari <br/> |prs-af <br/> |1164 <br/>|
-|Dutch <br/> |nl-nl <br/> |1043 <br/>|
-|English <br/> |en-us <br/> |1033 <br/>|
-|Estonian <br/> |et-ee <br/> |1061 <br/>|
-|Finnish <br/> |fi-fi <br/> |1035 <br/>|
-|French <br/> |fr-fr <br/> |1036 <br/>|
-|Galician <br/> |gl-es <br/> |1110 <br/>|
-|German <br/> |de-de <br/> |1031 <br/>|
-|Greek <br/> |el-el <br/> |1032 <br/>|
-|Hebrew <br/> |he-il <br/> |1037 <br/>|
-|Hindi <br/> |hi-in <br/> |1081 <br/>|
-|Hungarian <br/> |hu-hu <br/> |1038<br/>|
-|Indonesian <br/> |id-id <br/> |1057 <br/>|
-|Irish <br/> |ga-ie <br/> |2108 <br/>|
-|Italian <br/> |it-it <br/> |1040 <br/>|
-|Japanese <br/> |ja-jp <br/> |1041 <br/>|
-|Kazakh <br/> |kk-kz <br/> |1087 <br/>|
-|Korean <br/> |ko-kr <br/> |1042 <br/>|
-|Latvian <br/> |lv-lv <br/> |1062 <br/>|
-|Lithuanian <br/> |lt-lt <br/> |1063 <br/>|
-|Macedonian (FYROM) <br/> |mk-mk <br/> |1071 <br/>|
-|Malay (Malaysia) <br/> |ms-my <br/> |1086 <br/>|
-|Norwegian (Bokmål) <br/> |nb-no <br/> |1044 <br/>|
-|Polish <br/> |pl-pl <br/> |1045 <br/>|
-|Portuguese (Brazil) <br/> |pt-br <br/> |1046 <br/>|
-|Portuguese (Portugal) <br/> |pt-pt <br/> |2070<br/>|
-|Romanian <br/> |ro-ro <br/> |1048 <br/>|
-|Russian <br/> |ru-ru <br/> |1049 <br/>|
-|Serbian (Cyrillic) <br/> |sr-cyrl-rs <br/> |10266 <br/>|
-|Serbian (Latin) <br/> |sr-latn-rs <br/> |9242 <br/>|
-|Slovak <br/> |sk-sk <br/> |1051 <br/>|
-|Slovenian <br/> |sl-si <br/> |1060 <br/>|
-|Spanish <br/> |es-es <br/> |3082 <br/>|
-|Swedish <br/> |sv-se <br/> |1053 <br/>|
-|Thai <br/> |th-th <br/> |1054 <br/>|
-|Turkish <br/> |tr-tr <br/> |1055 <br/>|
-|Ukrainian <br/> |uk-ua <br/> |1058<br/>|
-|Vietnamese <br/> |vi-vn <br/> |1066 <br/>|
-|Welsh <br/> |cy-gb <br/> |1106 <br/>|
-
+||||
+|Arabic|ar-sa|1025|
+|Azerbaijani|az-latn-az|1068|
+|Basque|eu-es|1069|
+|Bosnian (Latin)|bs-latn-ba|5146|
+|Bulgarian|bg-bg|1026|
+|Catalan|ca-es|1027|
+|Chinese (Simplified)|zh-cn|2052|
+|Chinese (Traditional)|zh-tw|1028|
+|Croatian|hr-hr|1050|
+|Czech|cs-cz|1029|
+|Danish|da-dk|1030|
+|Dari|prs-af|1164|
+|Dutch|nl-nl|1043|
+|English|en-us|1033|
+|Estonian|et-ee|1061|
+|Finnish|fi-fi|1035|
+|French|fr-fr|1036|
+|Galician|gl-es|1110|
+|German|de-de|1031|
+|Greek|el-el|1032|
+|Hebrew|he-il|1037|
+|Hindi|hi-in|1081|
+|Hungarian|hu-hu|1038|
+|Indonesian|id-id|1057|
+|Irish|ga-ie|2108|
+|Italian|it-it|1040|
+|Japanese|ja-jp|1041|
+|Kazakh|kk-kz|1087|
+|Korean|ko-kr|1042|
+|Latvian|lv-lv|1062|
+|Lithuanian|lt-lt|1063|
+|Macedonian (FYROM)|mk-mk|1071|
+|Malay (Malaysia)|ms-my|1086|
+|Norwegian (Bokmål)|nb-no|1044|
+|Polish|pl-pl|1045|
+|Portuguese (Brazil)|pt-br|1046|
+|Portuguese (Portugal)|pt-pt|2070|
+|Romanian|ro-ro|1048|
+|Russian|ru-ru|1049|
+|Serbian (Cyrillic)|sr-cyrl-rs|10266|
+|Serbian (Latin)|sr-latn-rs|9242|
+|Slovak|sk-sk|1051|
+|Slovenian|sl-si|1060|
+|Spanish|es-es|3082|
+|Swedish|sv-se|1053|
+|Thai|th-th|1054|
+|Turkish|tr-tr|1055|
+|Ukrainian|uk-ua|1058|
+|Vietnamese|vi-vn|1066|
+|Welsh|cy-gb|1106|
SharePoint Planning For A Minrole Server Deployment In Sharepoint Server https://github.com/MicrosoftDocs/OfficeDocs-SharePoint/commits/public/SharePoint/SharePointServer/install/planning-for-a-minrole-server-deployment-in-sharepoint-server.md
Title: "Planning for a MinRole server deployment in SharePoint Servers 2016, 2019, and Subscription Edition"-+
f1.keywords:
ms.prod: sharepoint-server-itpro ms.localizationpriority: medium-+ - IT_Sharepoint_Server_Top - Strat_SP_server - SP2019-+ ms.assetid: 9fc3a696-b2cb-435c-8199-7048953ec609 description: "Learn about planning your SharePoint farm deployment using MinRole. MinRole helps administrators select the right server role when provisioning SharePoint Servers."
description: "Learn about planning your SharePoint farm deployment using MinRole
# Planning for a MinRole server deployment in SharePoint Servers 2016, 2019, and Subscription Edition [!INCLUDE[appliesto-xxx-2016-2019-SUB-xxx-md](../includes/appliesto-xxx-2016-2019-SUB-xxx-md.md)]
-
+ ## Server roles in SharePoint Servers 2016, 2019, and Subscription Edition There are eight pre-defined server roles in 3 categories you can choose from in SharePoint Servers 2016, 2019, and Subscription Edition. Read more about the roles and their descriptions in the following tables:
-
-**Dedicated Roles:** Dedicated roles are optimized for performance and scalability and are typically used in large-scale farms. They can also be used in medium scale farms with shared roles.
-
-| Server Role | Description | Notes |
-|:--|:--|:--|
-|Front-end |Service applications, services, and components that serve user requests belong on a Front-end server. These servers are optimized for high performance. |The Application server and the Front-end server roles host a similar set of services. However, each role serves a different purpose. The Front-end role is performance-sensitive and optimized for serving user traffic by running service instances appropriate for user requests on the local server. It's normal for the Front-end server role to run service instances that would have been hosted on the Application server role in previous versions. |
-|Application |Service applications, services, and components that serve back-end requests, such as search crawl requests, belong on an Application server. These servers are optimized for high throughput. |2. From SharePoint 2016, the use of the term "Application server" has a different meaning from the common use of the term in previous versions. In previous versions of SharePoint, the Application server typically hosted service application endpoints that Front-end servers would call while serving user requests. In SharePoint Servers 2016, 2019, and Subscription Edition, the Application server role runs background tasks such as Timer jobs, and can be the target for search crawl requests. |
-|Distributed Cache |Service applications, services, and components that are required for a distributed cache belong on a Distributed Cache server. |Distributed Cache doesn't support High Availability the way that other services do. While you can have multiple Distributed Cache servers in your SharePoint farm to help distribute the load, the data cached on each Distributed Cache server is not replicated to the other Distributed Cache servers. If a Distributed Cache server unexpectedly goes down, the data cached in that server will be lost. |
-|Search |Service applications, services, and components that are required for search belong on a Search server. |Once a server is assigned to the Search role, it must then be configured in Search topology management. For more information about Search topology, see [Manage the search topology in SharePoint Server](../search/manage-the-search-topology.md). |
-
-**Shared Roles:** Shared roles are optimized for fewer servers in a farm by combining dedicated roles together. They can also be used in medium scale farms with dedicated roles. Shared roles may require higher available system resources because they are running more services.
-
-| Server Role | Description | Notes |
-|:--|:--|:--|
-|Front end with Distributed Cache |Shared role that combines the Front-end and Distributed Cache roles on the same server. Make sure the server meets the system requirements for hosting a shared server role. |This shared role was introduced in the November Public Update for SharePoint Server 2016 (Feature Pack 1). |
-|Application with Search |Shared role that combines the Application and Search roles on the same server. Make sure the server meets the system requirements for hosting a shared server role. |This shared role was introduced in November Public Update for SharePoint Server 2016 (Feature Pack 1). |
-
-**Special Roles:** For special case scenarios, testing, development, and services that are not integrated with MinRole.
-
-| Server Role | Description | Notes |
-|:--|:--|:--|
-|Single-Server Farm |Service applications, services, and components required for a single-server farm belong on a server running the Single-Server Farm role. Use this role for development, testing, and limited production tasks. |The Single-Server Farm role replaces the Standalone Install mode available in previous SharePoint Server releases. Unlike Standalone Install, the SharePoint admin must separately install and prepare Microsoft SQL Server. The SharePoint admin must also configure the SharePoint farm services and web applications, either manually or by running the Farm Configuration Wizard. A SharePoint farm with the Single-Server Farm role cannot have more than one SharePoint server in the farm. |
-|Custom |Service applications, services, and components that you want to manage, instead of using MinRole to manage them, belong on a Custom server. |This server role is typically used to run services that do not integrate with MinRole. The farm administrator has full control over which service instances can run on servers assigned to the Custom server role. MinRole will not attempt to manage servers assigned to this role. |
-
+
+**Dedicated Roles:** Dedicated roles are optimized for performance and scalability and are typically used in large-scale farms. They can also be used in medium scale farms with shared roles.
+
+|Server Role|Description|Notes|
+||||
+|Front-end|Service applications, services, and components that serve user requests belong on a Front-end server. These servers are optimized for high performance.|The Application server and the Front-end server roles host a similar set of services. However, each role serves a different purpose. The Front-end role is performance-sensitive and optimized for serving user traffic by running service instances appropriate for user requests on the local server. It's normal for the Front-end server role to run service instances that would have been hosted on the Application server role in previous versions.|
+|Application|Service applications, services, and components that serve back-end requests, such as search crawl requests, belong on an Application server. These servers are optimized for high throughput.|2. From SharePoint 2016, the use of the term "Application server" has a different meaning from the common use of the term in previous versions. In previous versions of SharePoint, the Application server typically hosted service application endpoints that Front-end servers would call while serving user requests. In SharePoint Servers 2016, 2019, and Subscription Edition, the Application server role runs background tasks such as Timer jobs, and can be the target for search crawl requests.|
+|Distributed Cache|Service applications, services, and components that are required for a distributed cache belong on a Distributed Cache server.|Distributed Cache doesn't support High Availability the way that other services do. While you can have multiple Distributed Cache servers in your SharePoint farm to help distribute the load, the data cached on each Distributed Cache server is not replicated to the other Distributed Cache servers. If a Distributed Cache server unexpectedly goes down, the data cached in that server will be lost.|
+|Search|Service applications, services, and components that are required for search belong on a Search server.|Once a server is assigned to the Search role, it must then be configured in Search topology management. For more information about Search topology, see [Manage the search topology in SharePoint Server](../search/manage-the-search-topology.md).|
+
+**Shared Roles:** Shared roles are optimized for fewer servers in a farm by combining dedicated roles together. They can also be used in medium scale farms with dedicated roles. Shared roles may require higher available system resources because they are running more services.
+
+|Server Role|Description|Notes|
+||||
+|Front end with Distributed Cache|Shared role that combines the Front-end and Distributed Cache roles on the same server. Make sure the server meets the system requirements for hosting a shared server role.|This shared role was introduced in the November Public Update for SharePoint Server 2016 (Feature Pack 1).|
+|Application with Search|Shared role that combines the Application and Search roles on the same server. Make sure the server meets the system requirements for hosting a shared server role.|This shared role was introduced in November Public Update for SharePoint Server 2016 (Feature Pack 1).|
+
+**Special Roles:** For special case scenarios, testing, development, and services that are not integrated with MinRole.
+
+|Server Role|Description|Notes|
+||||
+|Single-Server Farm|Service applications, services, and components required for a single-server farm belong on a server running the Single-Server Farm role. Use this role for development, testing, and limited production tasks.|The Single-Server Farm role replaces the Standalone Install mode available in previous SharePoint Server releases. Unlike Standalone Install, the SharePoint admin must separately install and prepare Microsoft SQL Server. The SharePoint admin must also configure the SharePoint farm services and web applications, either manually or by running the Farm Configuration Wizard. A SharePoint farm with the Single-Server Farm role cannot have more than one SharePoint server in the farm.|
+|Custom|Service applications, services, and components that you want to manage, instead of using MinRole to manage them, belong on a Custom server.|This server role is typically used to run services that do not integrate with MinRole. The farm administrator has full control over which service instances can run on servers assigned to the Custom server role. MinRole will not attempt to manage servers assigned to this role.|
+ > [!NOTE] > You must have the November Public Update for SharePoint Server 2016 (Feature Pack 1) installed to use shared roles in your farm topology.
-
## MinRole Topologies There are three different types of SharePoint farms:
-
+ - Content Farms: These farms host sites and service applications, and can optionally consume service applications from other farms.
-
+ - Services Farms: These farms host service applications that are consumed by other farms. Example service applications include: Managed Metadata, Search, and User Profile.
-
+ - Search Farms: These farms are dedicated to hosting Search service applications that are consumed by other farms.
-
-Each type of SharePoint farm requires different MinRole server roles to function properly. Refer to the table below for the list of server roles required for each type of farm.
-
-| Server Role | Required for Content Farm? | Required for Services Farm? | Required for Search Farm? |
-|:--|:--|:--|:--|
-|Front-end |Yes |No |No |
-|Application |Yes |Yes |No |
-|Distributed Cache |Yes |Yes |No |
-|Search |Yes, if hosting Search |Yes, if hosting Search |Yes |
-
+
+Each type of SharePoint farm requires different MinRole server roles to function properly. Refer to the table below for the list of server roles required for each type of farm.
+
+|Server Role|Required for Content Farm?|Required for Services Farm?|Required for Search Farm?|
+|||||
+|Front-end|Yes|No|No|
+|Application|Yes|Yes|No|
+|Distributed Cache|Yes|Yes|No|
+|Search|Yes, if hosting Search|Yes, if hosting Search|Yes|
+ > [!NOTE] > Shared roles can be substituted for their equivalent dedicated roles to reduce the number of servers in a farm. For example, the "Front-end with Distributed Cache" role can be used in place of the separate "Front-end" and "Distributed Cache" roles to meet the requirements of a content farm. > > Dedicated roles, shared roles, and the Custom server role can be used together in the same farm. If you substitute the Custom server role for one or more MinRole-managed server roles, you must ensure that servers assigned to the Custom role are configured properly with the service instances needed in that type of farm. >
-> SQL Server can be running on the same server or a different server as SharePoint, but for better performance we recommend running SQL Server on a separate server.
-
+> SQL Server can be running on the same server or a different server as SharePoint, but for better performance we recommend running SQL Server on a separate server.
+ Refer to the table below for the list of recommended MinRole content farm topologies.
-| Content Farm Topology | Total Servers in Farm | Description |
-|:--|:--|:--|
-|Single-Server Farm |1 | One server with all roles: <br/> Evaluation, development, testing. <br/> Very light and simple production workloads. |
-|Small Non-High Availability MinRole farm |2 | Two servers with two shared roles: <br/> One Front end with Distributed Cache server <br/> One Application with Search server |
-|Small High Availability (HA) MinRole farm |4 | Four servers with two shared roles: <br/> Two Front-ends with Distributed Cache servers <br/> Two Application with Search servers |
-|Medium Non-High Availability MinRole farm |4 | Four servers with four dedicated roles: <br/> One Front-end server <br/> One Distributed Cache server <br/> One Application server <br/> One Search server |
-|Medium High Availability (HA) MinRole farm (Search optimized) |6 | Six servers with both dedicated and shared roles: <br/> Two Front-ends with Distributed Cache servers <br/> Two Application servers <br/> Two Search servers |
-|Medium High Availability (HA) MinRole farm (user optimized) |6 | Six servers with both dedicated and shared roles: <br/> Two Front-end servers <br/> Two Distributed Cache servers <br/> Two Application with Search servers |
-|Large High Availability (HA) MinRole farm |8 | Eight servers with four dedicated roles: <br/> Two Front-end servers <br/> Two Distributed Cache servers <br/> Two Application servers <br/> Two Search servers |
+|Content Farm Topology|Total Servers in Farm|Description|
+||||
+|Single-Server Farm|1|One server with all roles: <br/> Evaluation, development, testing. <br/> Very light and simple production workloads.|
+|Small Non-High Availability MinRole farm|2|Two servers with two shared roles: <br/> One Front end with Distributed Cache server <br/> One Application with Search server|
+|Small High Availability (HA) MinRole farm|4|Four servers with two shared roles: <br/> Two Front-ends with Distributed Cache servers <br/> Two Application with Search servers|
+|Medium Non-High Availability MinRole farm|4|Four servers with four dedicated roles: <br/> One Front-end server <br/> One Distributed Cache server <br/> One Application server <br/> One Search server|
+|Medium High Availability (HA) MinRole farm (Search optimized)|6|Six servers with both dedicated and shared roles: <br/> Two Front-ends with Distributed Cache servers <br/> Two Application servers <br/> Two Search servers|
+|Medium High Availability (HA) MinRole farm (user optimized)|6|Six servers with both dedicated and shared roles: <br/> Two Front-end servers <br/> Two Distributed Cache servers <br/> Two Application with Search servers|
+|Large High Availability (HA) MinRole farm|8|Eight servers with four dedicated roles: <br/> Two Front-end servers <br/> Two Distributed Cache servers <br/> Two Application servers <br/> Two Search servers|
## MinRole Farm deployment ### Deploying servers Use the following methods to create a new farm or join servers to an existing farm with MinRole:
-
+ - SharePoint Products Configuration Wizard (PSConfigUI.exe)
-
+ - PSConfig.exe command-line tool
-
+ - Microsoft PowerShell cmdlets
-
-The MinRole feature introduces two new command-line parameters for PSConfig.exe and PowerShell. The **LocalServerRole** parameter specifies the role of the local server when you create a new farm or join a server to an existing farm. The **LocalServerRole** parameter accepts the following values:
-
+
+The MinRole feature introduces two new command-line parameters for PSConfig.exe and PowerShell. The **LocalServerRole** parameter specifies the role of the local server when you create a new farm or join a server to an existing farm. The **LocalServerRole** parameter accepts the following values:
+ - WebFrontEnd (Front-end server role)
-
+ - Application (Application server role)
-
+ - DistributedCache (Distributed Cache server role)
-
+ - Search (Search server role)
-
+ - WebFrontEndWithDistributedCache (Front end with Distributed Cache server role)
-
+ - ApplicationWithSearch (Application with Search server role)
-
+ - Custom (Custom server role)
-
+ - SingleServerFarm (Single-Server Farm server role)
-
-The **ServerRoleOptional** parameter configures the farm not to require a server role to be specified when creating a farm or adding a server to a farm. It can be used when you create a new server farm. If no server role is specified, the server defaults to the Custom role.
-
+
+The **ServerRoleOptional** parameter configures the farm not to require a server role to be specified when creating a farm or adding a server to a farm. It can be used when you create a new server farm. If no server role is specified, the server defaults to the Custom role.
+ You can deploy your servers in a farm in any order you want. Any server role can be the first server in your farm.
-
+ #### SharePoint Products Configuration Wizard When you create a new farm or join a server to an existing farm by using the SharePoint Products Configuration Wizard, a new form is displayed in the wizard. This form provides a description of each server role, and you can use it to select the role of this server. The server role radio button will be disabled for roles that are not available in this farm.
-
+ ![Displays PSConfig dialog with shared roles in SharePoint Server 2016](../media/dea8528b-e903-4cc9-a698-25d203a91229.png) ![Displays PSConfig dialog with shared roles in SharePoint Server 2019](../media/PSConfigMinRole_2019.png)
-
+ ### Deploying the SharePoint Central Administration web site The first server in the farm will host the SharePoint Central Administration web site by default. Additional servers will not host the Central Administration web site by default. You can start or stop Central Administration on individual servers in the farm regardless of their server role by using any one of these steps:
-
-- From the SharePoint Central Administration web site, go to the **Services on Server** page.
-
-- The **New-SPCentralAdministration** and **Remove-SPCentralAdministration** PowerShell cmdlets.
-
-- The **psconfig.exe -cmd adminvs** command.
-
-- The **SharePoint Products Configuration Wizard** user interface.
-
+
+- From the SharePoint Central Administration web site, go to the **Services on Server** page.
+
+- The **New-SPCentralAdministration** and **Remove-SPCentralAdministration** PowerShell cmdlets.
+
+- The **psconfig.exe -cmd adminvs** command.
+
+- The **SharePoint Products Configuration Wizard** user interface.
+ The state of Central Administration will not affect whether a server is considered compliant with MinRole.
-
+ ### Deploying services Do not attempt to create service applications in a MinRole farm until it has reached the minimum supported MinRole farm topology. For example, if you're deploying a content farm using dedicated server roles, then you shouldn't try to create service applications until at least one of each of the following server roles have been deployed:
-
+ - Front-end
-
+ - Application
-
+ - Distributed Cache
-
+ - Search (if hosting a Search service application)
-
+ > [!NOTE]
-> This guidance does not apply to farms that use the Custom server role.
+> This guidance does not apply to farms that use the Custom server role.
-
### Manually configuring Search to crawl The farm administrator should configure Search to crawl web applications using the Application server role or the Application with Search server role instead of the Front-end server role for optimal performance. This can be done by configuring your load balancer to forward Search crawler requests to the Application or Application with Search servers, or by configuring the SharePoint Request Manager to forward Search crawler requests to the Application or Application with Search servers.
-
+ ### Converting Single-Server Farm into a multiple server farm You can convert a single-server farm into a multiple-server farm. To do this, use the role conversion feature. For more information about how to change a server role, see [Role conversion using MinRole in SharePoint Servers 2016, 2019, and Subscription Edition](../administration/role-conversion-using-minrole-in-sharepoint-server-2016.md).
-
+ ## Opting out of MinRole <a name="opt"> </a> SharePoint Servers 2016, 2019, and Subscription Edition supports the backward compatible behavior of previous SharePoint releases with the Custom server role. SharePoint farm administrators can directly manage service instances on individual servers assigned to the Custom role. MinRole won't attempt to manage servers assigned to the Custom role. You can assign zero, some, or all servers in a farm to the Custom role.
-
-If you have existing deployment scripts that you do not want to modify to support MinRole, you can specify the **ServerRoleOptional** parameter when you create a new SharePoint farm by using the PSConfig.exe command-line tool or PowerShell. This parameter configures the farm to not require a server role to be specified. If no server role is specified, the server defaults to the Custom role.
-
-## See also
+If you have existing deployment scripts that you do not want to modify to support MinRole, you can specify the **ServerRoleOptional** parameter when you create a new SharePoint farm by using the PSConfig.exe command-line tool or PowerShell. This parameter configures the farm to not require a server role to be specified. If no server role is specified, the server defaults to the Custom role.
+
+## See also
#### Concepts [SharePoint Server 2016 zero downtime patching steps](../upgrade-and-update/sharepoint-server-2016-zero-downtime-patching-steps.md)
-
+ [Overview of MinRole Server Roles in SharePoint Servers 2016, 2019, and Subscription Edition](overview-of-minrole-server-roles-in-sharepoint-server.md)
-
+ [Description of MinRole and associated services in SharePoint Servers 2016, 2019, and Subscription Edition](../administration/description-of-minrole-and-associated-services-in-sharepoint-server-2016.md)+ #### Other Resources [Managing a MinRole Server Farm in SharePoint Servers 2016, 2019, and Subscription Edition](../administration/managing-a-minrole-server-farm-in-sharepoint-server-2016.md)
SharePoint Updated Product Servicing Policy For Sharepoint 2019 https://github.com/MicrosoftDocs/OfficeDocs-SharePoint/commits/public/SharePoint/SharePointServer/product-servicing-policy/updated-product-servicing-policy-for-sharepoint-2019.md
Title: "Updated Product Servicing Policy for SharePoint 2019"-+
- IT_Sharepoint_Server - IT_Sharepoint_Server_Top - SP2019
-description: "This article explains the updated product servicing policy of SharePoint Server."
+description: "This article explains the updated product servicing policy of SharePoint Server 2019."
# Updated Product Servicing Policy for SharePoint Server 2019
-
+ During mainstream support, Microsoft releases new Public Update (PU) builds for SharePoint Server 2019 each month that contain the latest functionality, performance, and stability improvements for the product. To ensure that customers have a high-quality experience, Microsoft is adopting the following product servicing policy for SharePoint Server 2019.
-
+ ## Policy overview All SharePoint Server 2019 builds will be supported for at least one year from its release date. Microsoft will update the minimum supported build of SharePoint Server 2019 on each anniversary of General Availability (GA). Customers must be running that build or higher to remain supported. If a customer contacts Microsoft support and their farm is not running the minimum supported build or higher, they will be asked to upgrade to that build before support can be offered.
-
+ The product servicing policy timeline for SharePoint Server 2019 is described in the table below:
-
-|**SharePoint Server 2019**|**Support End Date**|
-|:--|:--|
-|RTM (16.0.10337.12109) - October 2019 Public Update <br/> |10/31/2020 <br/> |
-|November 2019 Public Update - October 2020 Public Update <br/> |10/31/2021 <br/> |
-|November 2020 Public Update - October 2021 Public Update <br/> |10/31/2022 <br/> |
-|November 2021 Public Update - October 2022 Public Update <br/> |10/31/2023 <br/> |
-|November 2022 Public Update - October 2023 Public Update <br/> |10/31/2024 <br/> |
-|November 2023 Public Update - all future Public Updates <br/> |07/14/2026 <br/> |
-
+
+|SharePoint Server 2019|Support End Date|
+|||
+|RTM (16.0.10337.12109) - October 2019 Public Update|10/31/2020|
+|November 2019 Public Update - October 2020 Public Update|10/31/2021|
+|November 2020 Public Update - October 2021 Public Update|10/31/2022|
+|November 2021 Public Update - October 2022 Public Update|10/31/2023|
+|November 2022 Public Update - October 2023 Public Update|10/31/2024|
+|November 2023 Public Update - all future Public Updates|07/14/2026|
+ ## Frequently Asked Question
- ***Question:** Why is Microsoft doing this?
-
- **Answer:** Previously, servicing for SharePoint was tied to specific types of releases - the initial RTM release and service packs. However, Microsoft has no plans to release new service packs for SharePoint and will instead only update SharePoint by way of monthly Public Updates. This new servicing policy ensures that customers are running a build that contains fixes for the most common issues that customers have been reporting to us, even if there are no additional service packs released.
-
- **Question:** Will Microsoft release service packs for SharePoint Server 2019?
-
- **Answer:** No, Microsoft has no plans to release service packs for SharePoint Server 2019. Functionality, performance, and stability improvements for SharePoint Server 2019 will be delivered by way of our monthly Public Updates.
-
- **Question:** Where can I find the Public Updates for SharePoint Server 2019?
-
- **Answer:** The current list of Public Updates for SharePoint Server 2019 can be found in our [SharePoint Updates](/officeupdates/sharepoint-updates) article.
-
- **Question:** Do the monthly Public Updates contain all of the fixes included in the previous Public Updates?
-
- **Answer:** Yes, the monthly Public Updates are cumulative. Each Public Update contains all of the fixes provided in the previous Public Updates.
-
- **Question:** Do I need to install an earlier Public Update before I can install the latest Public Update?
-
- **Answer:** No, you don't need to install an earlier Public Update before you install the latest Public Update. You can install any Public Update directly on an RTM installation, or on top of any previous Public Update.
-
- **Question:** Should I install the monthly Public Updates for SharePoint Server 2019 immediately or should I install them only if they contain a fix for a specific issue I'm having?
-
- **Answer:** Microsoft recommends that all customers install Public Updates for SharePoint Server 2019 as soon as they become available. Microsoft performs rigorous validation of each Public Update, both internally and with a select set of partners and customers before it is released to ensure it has the highest quality.
+ ***Question:** Why is Microsoft doing this?
+
+ **Answer:** Previously, servicing for SharePoint was tied to specific types of releases - the initial RTM release and service packs. However, Microsoft has no plans to release new service packs for SharePoint and will instead only update SharePoint by way of monthly Public Updates. This new servicing policy ensures that customers are running a build that contains fixes for the most common issues that customers have been reporting to us, even if there are no additional service packs released.
+
+ **Question:** Will Microsoft release service packs for SharePoint Server 2019?
+
+ **Answer:** No, Microsoft has no plans to release service packs for SharePoint Server 2019. Functionality, performance, and stability improvements for SharePoint Server 2019 will be delivered by way of our monthly Public Updates.
+
+ **Question:** Where can I find the Public Updates for SharePoint Server 2019?
+
+ **Answer:** The current list of Public Updates for SharePoint Server 2019 can be found in our [SharePoint Updates](/officeupdates/sharepoint-updates) article.
+
+ **Question:** Do the monthly Public Updates contain all of the fixes included in the previous Public Updates?
+
+ **Answer:** Yes, the monthly Public Updates are cumulative. Each Public Update contains all of the fixes provided in the previous Public Updates.
+
+ **Question:** Do I need to install an earlier Public Update before I can install the latest Public Update?
+
+ **Answer:** No, you don't need to install an earlier Public Update before you install the latest Public Update. You can install any Public Update directly on an RTM installation, or on top of any previous Public Update.
+
+ **Question:** Should I install the monthly Public Updates for SharePoint Server 2019 immediately or should I install them only if they contain a fix for a specific issue I'm having?
+
+ **Answer:** Microsoft recommends that all customers install Public Updates for SharePoint Server 2019 as soon as they become available. Microsoft performs rigorous validation of each Public Update, both internally and with a select set of partners and customers before it is released to ensure it has the highest quality.
**Question:** Why is the product lifecycle for SharePoint Server 2019 shorter than 10 years?
-**Answer:** As previously announced in KB article [4086137](https://support.microsoft.com/help/4086137/office-2019-on-premises-release-details-february-1-2018), the Microsoft Office 2019 family of products will provide 5 years of mainstream support, followed by 2 years of extended support. This will allow Microsoft to better support our customers as we rapidly innovate these products and cloud services. SharePoint Server 2016 was released later than the other products in the Microsoft Office 2016 family and therefore has a later extended support end date. To ensure that SharePoint Server 2019 doesn't end support earlier than previous versions of SharePoint Server, SharePoint Server 2019 will align its extended support end date with the SharePoint Server 2016 extended support end date.
+**Answer:** As previously announced in KB article [4086137](https://support.microsoft.com/help/4086137/office-2019-on-premises-release-details-february-1-2018), the Microsoft Office 2019 family of products will provide 5 years of mainstream support, followed by 2 years of extended support. This will allow Microsoft to better support our customers as we rapidly innovate these products and cloud services. SharePoint Server 2016 was released later than the other products in the Microsoft Office 2016 family and therefore has a later extended support end date. To ensure that SharePoint Server 2019 doesn't end support earlier than previous versions of SharePoint Server, SharePoint Server 2019 will align its extended support end date with the SharePoint Server 2016 extended support end date.
SharePoint Updated Product Servicing Policy For Sharepoint Server 2016 https://github.com/MicrosoftDocs/OfficeDocs-SharePoint/commits/public/SharePoint/SharePointServer/product-servicing-policy/updated-product-servicing-policy-for-sharepoint-server-2016.md
Title: "Updated Product Servicing Policy for SharePoint Server 2016"-+
- IT_Sharepoint_Server - IT_Sharepoint_Server_Top ms.assetid: 96af09c3-95c5-4472-b452-0aef8116bd79
-description: "This article explains the updated product servicing policy of SharePoint Server."
+description: "This article explains the updated product servicing policy of SharePoint Server 2016."
# Updated Product Servicing Policy for SharePoint Server 2016 [!INCLUDE[appliesto-xxx-2016-xxx-xxx-xxx-md](../includes/appliesto-xxx-2016-xxx-xxx-xxx-md.md)]
-
+ During mainstream support, Microsoft releases new Public Update (PU) builds for SharePoint Server 2016 each month that contain the latest functionality, performance, and stability improvements for the product. To ensure that customers have a high-quality experience, Microsoft is adopting the following product servicing policy for SharePoint Server 2016.
-
+ ## Policy overview All SharePoint Server 2016 builds will be supported for at least one year from its release date. Microsoft will update the minimum supported build of SharePoint Server 2016 on each anniversary of General Availability (GA). Customers must be running that build or higher to remain supported. If a customer contacts Microsoft support and their farm is not running the minimum supported build or higher, they will be asked to upgrade to that build before support can be offered.
-
+ The product servicing policy timeline for SharePoint Server 2016 is described in the table below:
-
-|**SharePoint Server 2016**|**Support End Date**|
-|:--|:--|
-|RTM (16.0.4351.1000) - April 2017 Public Update <br/> |4/30/2018 <br/> |
-|May 2017 Public Update - April 2018 Public Update <br/> |4/30/2019 <br/> |
-|May 2018 Public Update - April 2019 Public Update <br/> |4/30/2020 <br/> |
-|May 2019 Public Update - April 2020 Public Update <br/> |4/30/2021 <br/> |
-|May 2020 Public Update - April 2021 Public Update <br/> |4/30/2022 <br/> |
-|May 2021 Public Update - all future Public Updates <br/> |7/14/2026 <br/> |
-
+
+|SharePoint Server 2016|Support End Date|
+|||
+|RTM (16.0.4351.1000) - April 2017 Public Update|4/30/2018|
+|May 2017 Public Update - April 2018 Public Update|4/30/2019|
+|May 2018 Public Update - April 2019 Public Update|4/30/2020|
+|May 2019 Public Update - April 2020 Public Update|4/30/2021|
+|May 2020 Public Update - April 2021 Public Update|4/30/2022|
+|May 2021 Public Update - all future Public Updates|7/14/2026|
+ ## Frequently Asked Questions
- **Question:** Why is Microsoft doing this?
-
- **Answer:** Previously, servicing for SharePoint was tied to specific types of releases - the initial RTM release and service packs. However, Microsoft has no plans to release new service packs for SharePoint and will instead only update SharePoint by way of monthly Public Updates. This new servicing policy ensures that customers are running a build that contains fixes for the most common issues that customers have been reporting to us, even if there are no additional service packs released.
-
- **Question:** Will Microsoft release service packs for SharePoint Server 2016?
-
- **Answer:** No, Microsoft has no plans to release service packs for SharePoint Server 2016. Functionality, performance, and stability improvements for SharePoint Server 2016 will be delivered by way of our monthly Public Updates.
-
- **Question:** Where can I find the Public Updates for SharePoint Server 2016?
-
- **Answer:** The current list of Public Updates for SharePoint Server 2016 can be found in our [SharePoint Updates](/officeupdates/sharepoint-updates) article.
-
- **Question:** Do the monthly Public Updates contain all of the fixes included in the previous Public Updates?
-
- **Answer:** Yes, the monthly Public Updates are cumulative. Each Public Update contains all of the fixes provided in the previous Public Updates.
-
- **Question:** Do I need to install an earlier Public Update before I can install the latest Public Update?
-
- **Answer:** No, you don't need to install an earlier Public Update before you install the latest Public Update. You can install any Public Update directly on an RTM installation.
-
- **Question:** Should I install the monthly Public Updates for SharePoint Server 2016 immediately or should I install them only if they contain a fix for a specific issue I'm having?
-
- **Answer:** Microsoft recommends that all customers install Public Updates for SharePoint Server 2016 as soon as they become available. Microsoft performs rigorous validation of each Public Update, both internally and with a select set of partners and customers before it is released to ensure it has the highest quality.
-
+ **Question:** Why is Microsoft doing this?
+
+ **Answer:** Previously, servicing for SharePoint was tied to specific types of releases - the initial RTM release and service packs. However, Microsoft has no plans to release new service packs for SharePoint and will instead only update SharePoint by way of monthly Public Updates. This new servicing policy ensures that customers are running a build that contains fixes for the most common issues that customers have been reporting to us, even if there are no additional service packs released.
+
+ **Question:** Will Microsoft release service packs for SharePoint Server 2016?
+
+ **Answer:** No, Microsoft has no plans to release service packs for SharePoint Server 2016. Functionality, performance, and stability improvements for SharePoint Server 2016 will be delivered by way of our monthly Public Updates.
+
+ **Question:** Where can I find the Public Updates for SharePoint Server 2016?
+
+ **Answer:** The current list of Public Updates for SharePoint Server 2016 can be found in our [SharePoint Updates](/officeupdates/sharepoint-updates) article.
+
+ **Question:** Do the monthly Public Updates contain all of the fixes included in the previous Public Updates?
+
+ **Answer:** Yes, the monthly Public Updates are cumulative. Each Public Update contains all of the fixes provided in the previous Public Updates.
+
+ **Question:** Do I need to install an earlier Public Update before I can install the latest Public Update?
+
+ **Answer:** No, you don't need to install an earlier Public Update before you install the latest Public Update. You can install any Public Update directly on an RTM installation.
+
+ **Question:** Should I install the monthly Public Updates for SharePoint Server 2016 immediately or should I install them only if they contain a fix for a specific issue I'm having?
+ **Answer:** Microsoft recommends that all customers install Public Updates for SharePoint Server 2016 as soon as they become available. Microsoft performs rigorous validation of each Public Update, both internally and with a select set of partners and customers before it is released to ensure it has the highest quality.
SharePoint Configure And Use The Documentum Connector https://github.com/MicrosoftDocs/OfficeDocs-SharePoint/commits/public/SharePoint/SharePointServer/search/configure-and-use-the-documentum-connector.md
Title: "Configure and use the Documentum connector in SharePoint Server"-+
description: "This article describes how to install and configure the Microsoft
[!INCLUDE[appliesto-2013-2016-2019-SUB-xxx-md](../includes/appliesto-2013-2016-2019-SUB-xxx-md.md)] This article describes how to install and configure the Microsoft SharePoint Server Indexing Connector for Documentum.
-
+ The Microsoft SharePoint Server Indexing Connector for Documentum enables you to index content that is stored in the EMC Documentum system. This article describes how to install and configure the Indexing Connector for Documentum for use with SharePoint Server.
-
+ The Indexing Connector for Documentum:
-
+ - Is a 64-bit connector based on the SharePoint Server Search Connector Framework.
-
-- Supports multiple versions of EMC Documentum Content Server.
-
+
+- Supports multiple versions of EMC Documentum Content Server.
+ - Indexes Documentum objects and object metadata. See [Supported and unsupported Documentum object types and properties in SharePoint Server](../technical-reference/supported-and-unsupported-documentum-object-types-and-properties.md).
-
+ - Supports Documentum security definitions and policies.
-
+ - Supports Microsoft PowerShell for automated configuration and administration. See [Using the SPEnterpriseSearchDCTMConnectorConfig cmdlet](configure-and-use-the-documentum-connector.md).
-
+ - Has a configurable search results URL to support multiple Documentum client applications.
-
-- Supports file and folder exclusion for crawling.
-
-
+
+- Supports file and folder exclusion for crawling.
+ ## Before you begin <a name="begin"> </a> Before you begin this operation, review the following system prerequisites and requirements:
-
+ - The supported operating systems are Windows Server 2008 R2, Windows Server 2008 Service Pack 2, and Windows Server 2012.
-
-- One of the following SharePoint 2019, SharePoint 2016, or SharePoint 2013 Products is installed and configured:
-
+
+- One of the following SharePoint 2019, SharePoint 2016, or SharePoint 2013 Products is installed and configured:
+ - Microsoft SharePoint Server Enterprise
-
+ - Microsoft SharePoint Server Standard
-
-- A Search service application is installed and configured.
-
-- A Documentum Foundation Services (DFS) Server with a version that is compatible with DFS Productivity Layer 6.7 SP2 is installed on a Windows host.
-
-- DFS Productivity Layer 6.7 SP2 is installed and you have access to the .NET assemblies that are included in the DFS Productivity Layer 6.7 SP2. The Indexing Connector for Documentum uses DFS as the connectivity API to access Documentum repositories.
-
+
+- A Search service application is installed and configured.
+
+- A Documentum Foundation Services (DFS) Server with a version that is compatible with DFS Productivity Layer 6.7 SP2 is installed on a Windows host.
+
+- DFS Productivity Layer 6.7 SP2 is installed and you have access to the .NET assemblies that are included in the DFS Productivity Layer 6.7 SP2. The Indexing Connector for Documentum uses DFS as the connectivity API to access Documentum repositories.
+ - Documentum Content Server is installed. The supported versions of Documentum Content Server are determined by DFS 6.7 SP2. You can find a detailed list in the DFS Productivity Layer 6.7 SP2 release notes.
-
-- Configure the Indexing Connector for Documentum with *-ACLTranslation "Claims"* if you have to crawl Documentum repositories that have Documentum Trusted Content Services (TCS) enabled. You can also use this connector configuration to enable automatic mapping between Windows Active Directory users and Documentum users, regardless of whether the repository has TCS enabled.
-
+
+- Configure the Indexing Connector for Documentum with _-ACLTranslation "Claims"_ if you have to crawl Documentum repositories that have Documentum Trusted Content Services (TCS) enabled. You can also use this connector configuration to enable automatic mapping between Windows Active Directory users and Documentum users, regardless of whether the repository has TCS enabled.
+ ## Overview <a name="DCTM_Overview"> </a>
-The following steps provide a high-level overview of the tasks that are involved to install and configure the Indexing Connector for Documentum for use with SharePoint Server.
-
+The following steps provide a high-level overview of the tasks that are involved to install and configure the Indexing Connector for Documentum for use with SharePoint Server.
+ ### 1. Preparation 1. Ensure that your system meets the system prerequisites and requirements in the section [Before you begin](configure-and-use-the-documentum-connector.md#begin).
-
+ 2. Download the SharePoint Server 2016 Indexing Connector for Documentum from the [Microsoft Download Center](https://go.microsoft.com/?linkid=9826867).
-
+ 3. [Decide which Documentum content access account to use for crawling](configure-and-use-the-documentum-connector.md#DCTM_ContentAccess).
-
+ 4. [Prepare the SharePoint servers that host a crawl component](configure-and-use-the-documentum-connector.md#DCTM_PrepareCrawlServer). On each server:
-
+ - [Set the DFS Productivity Layer .NET assemblies](configure-and-use-the-documentum-connector.md#DCTM_Assemblies).
-
- - [Edit the machine.config file](configure-and-use-the-documentum-connector.md#DCTM_machineconfig) to set the Documentum bindings.
-
+
+ - [Edit the machine.config file](configure-and-use-the-documentum-connector.md#DCTM_machineconfig) to set the Documentum bindings.
+ ### 2. Install the Indexing Connector for Documentum
-1. [Install the Indexing Connector for Documentum](configure-and-use-the-documentum-connector.md#DCTM_Deployconn) on each SharePoint server in the farm that hosts a crawl component.
-
-2. [Register the Indexing Connector for Documentum to the Search service application](configure-and-use-the-documentum-connector.md#DCTM_Registerconn) by using Microsoft PowerShell.
-
+1. [Install the Indexing Connector for Documentum](configure-and-use-the-documentum-connector.md#DCTM_Deployconn) on each SharePoint server in the farm that hosts a crawl component.
+
+2. [Register the Indexing Connector for Documentum to the Search service application](configure-and-use-the-documentum-connector.md#DCTM_Registerconn) by using Microsoft PowerShell.
+ ### 3. Configure the Indexing Connector for Documentum
-[Configure the Indexing Connector for Documentum](configure-and-use-the-documentum-connector.md#DCTM_ConfigureConn) on each SharePoint server in the farm that hosts a crawl component by using the Indexing Connector for Documentum PowerShell cmdlet. Choose one of the following configurations:
-
-| **Configuration** | **ACL Translation** | **Description** | **See this section** |
-| :-- | : | :- | : |
-| Support crawling EMC Documentum Trusted Content Services (TCS) content or regular Documentum content with automatic user mapping. | Claims | You enable automatic user mapping by configuring a separate Security Trimmer Sync Service and pre- and post-trimmers. | [Configure the Indexing Connector for Documentum to support TCS and automatic user mapping](configure-and-use-the-documentum-connector.md#DCTM_Configure_TCS) |
-| Support crawling Documentum content and use a manually created user mapping table. | UserMappingTable | You manually create a user mapping table in SQL Server to specify how the Documentum users are mapped to Active Directory Domain Services (AD DS) or Active Directory service users. You configure the connector by specifying in which database you have created the user mapping table by using Microsoft PowerShell. | [Configure the Indexing Connector for Documentum using a user mapping table](configure-and-use-the-documentum-connector.md) |
-| Support crawling Documentum content when Documentum and Windows user accounts are the same. | SameAccountName | The Indexing Connector for Documentum assumes that Documentum and SharePoint users share the same account, such as a shared account in Active Directory. Once an account is found that is not valid, the Indexing Connector for Documentum discards the account permission. | [Using the SPEnterpriseSearchDCTMConnectorConfig cmdlet](configure-and-use-the-documentum-connector.md) |
-| Support crawling Documentum content without security trimming the search results. | NoSecurity | All users will be able to see all Documentum search results. This can be useful if you have a public Documentum repository that everyone can access, for example. | [Using the SPEnterpriseSearchDCTMConnectorConfig cmdlet](configure-and-use-the-documentum-connector.md) |
-
+[Configure the Indexing Connector for Documentum](configure-and-use-the-documentum-connector.md#DCTM_ConfigureConn) on each SharePoint server in the farm that hosts a crawl component by using the Indexing Connector for Documentum PowerShell cmdlet. Choose one of the following configurations:
+
+|Configuration|ACL Translation|Description|See this section|
+|||||
+|Support crawling EMC Documentum Trusted Content Services (TCS) content or regular Documentum content with automatic user mapping.|Claims|You enable automatic user mapping by configuring a separate Security Trimmer Sync Service and pre- and post-trimmers.|[Configure the Indexing Connector for Documentum to support TCS and automatic user mapping](configure-and-use-the-documentum-connector.md#DCTM_Configure_TCS)|
+|Support crawling Documentum content and use a manually created user mapping table.|UserMappingTable|You manually create a user mapping table in SQL Server to specify how the Documentum users are mapped to Active Directory Domain Services (AD DS) or Active Directory service users. You configure the connector by specifying in which database you have created the user mapping table by using Microsoft PowerShell.|[Configure the Indexing Connector for Documentum using a user mapping table](configure-and-use-the-documentum-connector.md)|
+|Support crawling Documentum content when Documentum and Windows user accounts are the same.|SameAccountName|The Indexing Connector for Documentum assumes that Documentum and SharePoint users share the same account, such as a shared account in Active Directory. Once an account is found that is not valid, the Indexing Connector for Documentum discards the account permission.|[Using the SPEnterpriseSearchDCTMConnectorConfig cmdlet](configure-and-use-the-documentum-connector.md)|
+|Support crawling Documentum content without security trimming the search results.|NoSecurity|All users will be able to see all Documentum search results. This can be useful if you have a public Documentum repository that everyone can access, for example.|[Using the SPEnterpriseSearchDCTMConnectorConfig cmdlet](configure-and-use-the-documentum-connector.md)|
+ ### 4. Configure a Documentum crawl rule and content source in the Search service application by using Central Administration 1. [Create a crawl rule for Documentum](configure-and-use-the-documentum-connector.md).
-
+ 2. [Create a Documentum content source](configure-and-use-the-documentum-connector.md)
-
-3. Perform a full crawl.
-
+
+3. Perform a full crawl.
+ ## Prepare the SharePoint servers that host a crawl component <a name="DCTM_PrepareCrawlServer"> </a> ### <a name="DCTM_ContentAccess"></a>Decide which Documentum content access account to use for crawling 1. You have to specify the Documentum content access account and the password later in the configuration procedure when you set up crawl rules. The Indexing Connector for Documentum uses the content access account to retrieve content from the Documentum repository. This account must have the following minimum permissions:
-
+ - Read permission to documents that you want to crawl. - Browse permission to cabinets, folders, and records (documents with only metadata) that you want to crawl. ### <a name="DCTM_Assemblies"></a>Set the DFS Productivity Layer .NET assemblies
-1. Locate the following DFS Productivity Layer .NET assemblies and verify that the version number is **6.7.2000.36** for all files. When extracted to the default path, these files are located in the `%local%\emc-dfs-sdk-6.7\emc-dfs-sdk-6.7\lib\dotnet` directory.
+1. Locate the following DFS Productivity Layer .NET assemblies and verify that the version number is **6.7.2000.36** for all files. When extracted to the default path, these files are located in the `%local%\emc-dfs-sdk-6.7\emc-dfs-sdk-6.7\lib\dotnet` directory.
- Emc.Documentum.FS.DataModel.Core.dll - Emc.Documentum.FS.DataModel.Shared.dll
-
+ - Emc.Documentum.FS.runtime.dll - Emc.Documentum.FS.Services.Core.dll
The following steps provide a high-level overview of the tasks that are involved
2. On each server that hosts a crawl component, log on with an account that is a member of the Administrators group on that server and deploy the DFS Productivity Layer .NET assemblies to the global assembly cache `%windir%\assembly`. > [!NOTE]
- > You can drag and drop the four DLLs into the global assembly cache ( `%windir%\assembly`) to deploy them, but you might have to turn off User Account Control to do this.
-
+ > You can drag and drop the four DLLs into the global assembly cache ( `%windir%\assembly`) to deploy them, but you might have to turn off User Account Control to do this.
+ The following procedure explains how to edit the machine.config file on each SharePoint server that hosts a crawl component to include WCF settings for the DFS Productivity Layer. This is done to make sure that the DFS Productivity Layer .NET assemblies function correctly.
-
-The WCF settings that you are about to set in [Edit the machine.config file](configure-and-use-the-documentum-connector.md#DCTM_machineconfig) allow a maximum of 30 megabytes (MB) per Documentum content object (the document file plus its metadata) transferred. The administrator can increase *maxReceivedMessageSize* in *DfsDefaultService* binding for larger content.
-
-
+
+The WCF settings that you are about to set in [Edit the machine.config file](configure-and-use-the-documentum-connector.md#DCTM_machineconfig) allow a maximum of 30 megabytes (MB) per Documentum content object (the document file plus its metadata) transferred. The administrator can increase _maxReceivedMessageSize_ in _DfsDefaultService_ binding for larger content.
+ ### <a name="DCTM_machineconfig"></a>Edit the machine.config file 1. On each server that hosts a crawl component, open the machine.config file. This file is located in the directory `%windir%\Microsoft.NET\Framework64\v4.0.30319\Config`.
-
-2. Copy the following XML snippet to the **\<configuration\>** element:
-
- ```
+
+2. Copy the following XML snippet to the **\<configuration\>** element:
+
+ ```xml
<system.serviceModel> <bindings> <basicHttpBinding>
The WCF settings that you are about to set in [Edit the machine.config file](con
### <a name="DCTM_Deployconn"></a>Install the Indexing Connector for Documentum 1. Download the Indexing Connector for Documentum from the [Microsoft Download Center](https://go.microsoft.com/?linkid=9826867).
-
+ 2. On each server in the farm that hosts a crawl component, install the Indexing Connector for Documentum by running the file `DCTMIndexConn.exe`. Follow the steps in the installation wizard.
-
+ ### Register the Indexing Connector for Documentum to the Search service application <a name="DCTM_Registerconn"></a> 1. Run this procedure on a SharePoint server that hosts a crawl component to register the connector to the Search service application.
-
+ 2. Start a SharePoint Management Shell.
-
+ 3. At the Microsoft PowerShell command prompt, type the following command(s):
-
- ```
+
+ ```powershell
New-SPEnterpriseSearchCrawlCustomConnector -SearchApplication "<name of your Search service application>" -Protocol "dctm" -ModelFilePath "<%CommonProgramFiles%\Microsoft Shared\Web Server Extensions\15\CONFIG\SearchConnectors\Documentum\MODEL.xml>" -Name "Microsoft SharePoint 2016 Indexing Connector for Documentum" ```
- Where:
-
- - _\<name of your Search service application\>_ is the name of the Search service application that you are registering the connector to.
-
- - _\<%CommonProgramFiles%\Microsoft Shared\Web Server Extensions\15\CONFIG\SearchConnectors\Documentum\MODEL.xml\>_ is the path of the Indexing Connector for Documentum model file. The default location is given in this example.
-
+ Where:
+
+ - _\<name of your Search service application\>_ is the name of the Search service application that you are registering the connector to.
+
+ - _\<%CommonProgramFiles%\Microsoft Shared\Web Server Extensions\15\CONFIG\SearchConnectors\Documentum\MODEL.xml\>_ is the path of the Indexing Connector for Documentum model file. The default location is given in this example.
+ ## Configure the Indexing Connector for Documentum <a name="DCTM_ConfigureConn"> </a>
-You configure the connector settings with the Indexing Connector for Documentum PowerShell cmdlet ( `Set-SPEnterpriseSearchDCTMConnectorConfig`). The settings are stored in `%CommonProgramFiles%\Microsoft Shared\Web Server Extensions\15\CONFIG\SearchConnectors\Documentum\DCTMConfig.xml` and must be the same on each SharePoint Server 2016 server that hosts a crawl component.
-
-Which PowerShell cmdlet parameters you use and which additional configuration steps you must perform depends on configuration mode you choose.
-
+You configure the connector settings with the Indexing Connector for Documentum PowerShell cmdlet ( `Set-SPEnterpriseSearchDCTMConnectorConfig`). The settings are stored in `%CommonProgramFiles%\Microsoft Shared\Web Server Extensions\15\CONFIG\SearchConnectors\Documentum\DCTMConfig.xml` and must be the same on each SharePoint Server 2016 server that hosts a crawl component.
+
+Which PowerShell cmdlet parameters you use and which additional configuration steps you must perform depends on configuration mode you choose.
+ ## Configure the Indexing Connector for Documentum to support TCS and automatic user mapping <a name="DCTM_Configure_TCS"> </a> The following procedures explain how to configure the indexing connector for Documentum to support TCS. The procedures also show how to enable automatic user mapping by configuring the Security Trimmer Sync Service and create and deploy custom pre- and post-security trimmers. After completing these procedures, your Documentum user credentials will be automatically synced with Windows Active Directory Domain Services (AD), search results will be trimmed accordingly and users will only be able to retrieve Documentum search results that they have permission to see.
-
-The Security Trimmer Sync Service maps Documentum users to AD users by looking at the Documentum fields **user_os_domain**, **user_login_name**, **user_source** and **user_ldap_dn**. If the **user_ldap_dn** field is populated, the Security Trimmer Sync Service will try to extract a domain from the first DC value. For example, if the **user_ldap_dn** field is populated with " **CN=User Name, OU=Unit,DC=Domain,DC=Department,DC=Company** ", the Security Trimmer Sync Service will extract the domain from **DC=Domain** and will ignore **DC=Department,DC=Company**.
-
+
+The Security Trimmer Sync Service maps Documentum users to AD users by looking at the Documentum fields **user_os_domain**, **user_login_name**, **user_source** and **user_ldap_dn**. If the **user_ldap_dn** field is populated, the Security Trimmer Sync Service will try to extract a domain from the first DC value. For example, if the **user_ldap_dn** field is populated with " **CN=User Name, OU=Unit,DC=Domain,DC=Department,DC=Company** ", the Security Trimmer Sync Service will extract the domain from **DC=Domain** and will ignore **DC=Department,DC=Company**.
+ ### To configure the connector to support TCS and automatic user mapping 1. Start a SharePoint Management Shell on each server that hosts a crawl component.
-
+ 2. At the Microsoft PowerShell command prompt, type the following command(s):
-
- ```
+
+ ```powershell
Set-SPEnterpriseSearchDCTMConnectorConfig -Shared -ACLTranslation "Claims" -DisplayURLPatternForDocument "http://<MyWebTopServer:PortOfMyWebTopServer>/webtop/component/drl?objectId={ObjectId}&amp;format={Format}&amp;RepositoryName={RepositoryName}" -DisplayURLPatternForContainer "http://<MyWebTopServer:PortOfMyWebTopServer>/webtop/component/drl?objectId={ObjectId}&amp;RepositoryName={RepositoryName}" Set-SPEnterpriseSearchDCTMConnectorConfig -Repository -RepositoryName "<MyRepository1>" -DFSWebServiceURL @("http://<DFSWebServices>:<30000>/services"), ("http://<DFSWebServices2>:<30000>/services")
-
+ Set-SPEnterpriseSearchDCTMConnectorConfig -Repository -RepositoryName "<MyRepository2>" -DFSWebServiceURL @("http://<DFSWebServices>:<30000>/services")
-
``` Where:
-
- - _\<MyWebTopServer:PortOfMyWebTopServer\>_ is the name and the port number of the DFS Web Top Server you are using.
-
- - _\<MyRepository n\>_ is the name of Documentum repository that you want to crawl.
-
- - _\<DFSWebServices n\>:\<30000\>_ is the name and the port number of the Documentum Web Services server that hosts the Documentum repository that you want to crawl.
-
+
+ - _\<MyWebTopServer:PortOfMyWebTopServer\>_ is the name and the port number of the DFS Web Top Server you are using.
+
+ - _\<MyRepository n\>_ is the name of Documentum repository that you want to crawl.
+
+ - _\<DFSWebServices n\>:\<30000\>_ is the name and the port number of the Documentum Web Services server that hosts the Documentum repository that you want to crawl.
+ 3. Restart the OSearch15 service. This must be done before you create a content source for Documentum.
-
- **IMPORTANT:** Do not use the Services on Server page on the SharePoint Central Administration website to restart this service. Doing so resets the search index, which requires you to do a full crawl of all content to rebuild the index.
-
- - Verify that the user account that is performing this procedure is an administrator for the server that hosts the crawl component.
-
- - Open a Command Prompt window.
-
- - To stop the OSearch15 service, type this command: **net stop osearch15**
-
- - To start the OSearch15 service, type this command: **net start osearch15**
-
+
+ **IMPORTANT:** Do not use the Services on Server page on the SharePoint Central Administration website to restart this service. Doing so resets the search index, which requires you to do a full crawl of all content to rebuild the index.
+
+ - Verify that the user account that is performing this procedure is an administrator for the server that hosts the crawl component.
+
+ - Open a Command Prompt window.
+
+ - To stop the OSearch15 service, type this command: **net stop osearch15**
+
+ - To start the OSearch15 service, type this command: **net start osearch15**
+ ### To set up the Security Trimming Sync Service 1. Open the file Microsoft.Office.Server.Search.Connector.Documentum.TrimmerSync.exe.config. This file is stored in the folder where you have installed the Indexing Connector for Documentum connector. The default location is `%CommonProgramFiles%\Microsoft Shared\Web Server Extensions\15\CONFIG\SearchConnectors\Documentum`
-
+ 2. Using the same information that you provided when you configured the Indexing Connector for Documentum, edit the configuration file as follows.
-
- - In the **Emc.Documentum** section, in the **ModuleInfo** element, do the following:
-
- - In the **host** attribute, type the host name of the Documentum server.
-
- - In the **port** attribute, type the port number of the Documentum server.
-
- - In the **Data Source: Documentum Settings** section, in the **Repositories** element, do the following:
-
- - In the **repository id** attribute, type the Documentum repository ID.
-
- - In the **name** attribute, type the name of the Documentum repository.
-
- - In the **login** attribute, type the Documentum login name. Use the same login name as the Documentum content access account. This should be a user who has elevated user permissions on the Documentum Content Server.
-
- - In the **dfs** attribute, type the location of the Documentum Foundation Services (DFS) by providing the URI for the DFS.
-
- - (Optional) If your Documentum connection requires SSL/HTTPS, you have to change the security mode.
-
- - In the **Data Source: Documentum Settings** section, subsection **Documentum**, in the **basicHttpBinding** element, set the security mode attribute from _None_ to _Transport_ for the following bindings:
-
- - **DfsAgentService**
-
- - **DfsContextRegistryService**
-
- - **DfsDefaultService**
-
- - In the **Data Source: Documentum Settings** section, subsection **Documentum**, in the **netNamedPipeBinding** element, set the security mode attribute from _None_ to _Transport_ for the following bindings:
-
- - **localNamedPipeBinding**
-
-3. Save and close the file.
-
+
+ - In the **Emc.Documentum** section, in the **ModuleInfo** element, do the following:
+
+ - In the **host** attribute, type the host name of the Documentum server.
+
+ - In the **port** attribute, type the port number of the Documentum server.
+
+ - In the **Data Source: Documentum Settings** section, in the **Repositories** element, do the following:
+
+ - In the **repository id** attribute, type the Documentum repository ID.
+
+ - In the **name** attribute, type the name of the Documentum repository.
+
+ - In the **login** attribute, type the Documentum login name. Use the same login name as the Documentum content access account. This should be a user who has elevated user permissions on the Documentum Content Server.
+
+ - In the **dfs** attribute, type the location of the Documentum Foundation Services (DFS) by providing the URI for the DFS.
+
+ - (Optional) If your Documentum connection requires SSL/HTTPS, you have to change the security mode.
+
+ - In the **Data Source: Documentum Settings** section, subsection **Documentum**, in the **basicHttpBinding** element, set the security mode attribute from _None_ to _Transport_ for the following bindings:
+
+ - **DfsAgentService**
+
+ - **DfsContextRegistryService**
+
+ - **DfsDefaultService**
+
+ - In the **Data Source: Documentum Settings** section, subsection **Documentum**, in the **netNamedPipeBinding** element, set the security mode attribute from _None_ to _Transport_ for the following bindings:
+
+ - **localNamedPipeBinding**
+
+3. Save and close the file.
+ 4. Copy the DFS Productivity Layer .NET assemblies to the server running the Security Trimming Sync Service.
-
- - Locate the following DFS Productivity Layer .NET assemblies and verify that the version number is **6.7.2000.36** for all files. When extracted to the default path, these files are located in the `%local%\emc-dfs-sdk-6.7\emc-dfs-sdk-6.7\lib\dotnet` directory.
-
+
+ - Locate the following DFS Productivity Layer .NET assemblies and verify that the version number is **6.7.2000.36** for all files. When extracted to the default path, these files are located in the `%local%\emc-dfs-sdk-6.7\emc-dfs-sdk-6.7\lib\dotnet` directory.
+ - Emc.Documentum.FS.DataModel.Core.dll
-
- - Emc.Documentum.FS.DataModel.Shared.dll
-
+
+ - Emc.Documentum.FS.DataModel.Shared.dll
+ - Emc.Documentum.FS.runtime.dll
-
+ - Emc.Documentum.FS.Services.Core.dll
-
- - On the server that hosts the Security Trimming Sync Service, log on with an account that is a member of the Administrators group on that server and deploy the DFS Productivity Layer .NET assemblies to the global assembly cache `%windir%\assembly`.
-
+
+ - On the server that hosts the Security Trimming Sync Service, log on with an account that is a member of the Administrators group on that server and deploy the DFS Productivity Layer .NET assemblies to the global assembly cache `%windir%\assembly`.
+ > [!NOTE]
- > You can drag and drop the four DLLs into the global assembly cache ( `%windir%\assembly`) to deploy them, but you might have to turn off User Account Control to do this.
-
-5. Configure authentication for the Security Trimming Sync Service and install the service.
-
+ > You can drag and drop the four DLLs into the global assembly cache ( `%windir%\assembly`) to deploy them, but you might have to turn off User Account Control to do this.
+
+5. Configure authentication for the Security Trimming Sync Service and install the service.
+ - Verify that the user account that is performing this procedure is a member of the Farm Administrators group.
-
- - Open a Command Prompt window on each server that hosts a query processing component.
-
+
+ - Open a Command Prompt window on each server that hosts a query processing component.
+ - Type the following command: **Microsoft.Office.Server.Search.Connector.Documentum.TrimmerSync.exe -p**
-
- When prompted, enter the password for the account that you provided in the **login** attribute. Use the same login name as the Documentum content access account. The password will now automatically be encrypted and added to the Security Trimming Sync Service config file.
-
- - Install the Security Trimming Sync Service. Type the following command: **Microsoft.Office.Server.Search.Connector.Documentum.TrimmerSync.exe -i**
-
-6. Start the Security Trimming Sync Service.
-
+
+ When prompted, enter the password for the account that you provided in the **login** attribute. Use the same login name as the Documentum content access account. The password will now automatically be encrypted and added to the Security Trimming Sync Service config file.
+
+ - Install the Security Trimming Sync Service. Type the following command: **Microsoft.Office.Server.Search.Connector.Documentum.TrimmerSync.exe -i**
+
+6. Start the Security Trimming Sync Service.
+ - Open **Windows Server Manager**.
-
- - Expand the **Configuration** menu and click **Services**.
-
+
+ - Expand the **Configuration** menu and click **Services**.
+ - Right-click the **SharePoint Documentum Security Sync** service and then click **Properties**. In the **LogOn** tab, select **This account** and provide the account details and credentials for the account that runs the SharePoint services. Click **OK**.
-
- - Right-click the **SharePoint Documentum Security Sync** service and then click **Start**.
-
- - Verify that the **Status** column changes to **Started**.
-
-7. Verify that the service is running and that the security sync is completed.
-
- - Run the command **Microsoft.Office.Server.Search.Connector.Documentum.TrimmerSync.exe -d** to write the Security Trimming Sync Service memory to a text file.
-
- - Verify that the Security Trimming Sync Service connects to the Documentum server. Read the file DCTMSecuritySync.log that is located in the directory `<Microsoft Office Server path>\15.0\Data\Office Server\Applications\Search\Nodes`
-
+
+ - Right-click the **SharePoint Documentum Security Sync** service and then click **Start**.
+
+ - Verify that the **Status** column changes to **Started**.
+
+7. Verify that the service is running and that the security sync is completed.
+
+ - Run the command **Microsoft.Office.Server.Search.Connector.Documentum.TrimmerSync.exe -d** to write the Security Trimming Sync Service memory to a text file.
+
+ - Verify that the Security Trimming Sync Service connects to the Documentum server. Read the file DCTMSecuritySync.log that is located in the directory `<Microsoft Office Server path>\15.0\Data\Office Server\Applications\Search\Nodes`
+ - Verify that the membership information from the Documentum server is written to the file DCTMSecuritySync_Dump.txt that is located in the directory `<Microsoft Office Server path>\15.0\Data\Office Server\Applications\Search\Nodes`
-
-Before you can add the pre- and post- security trimmers, you must add one simple crawl rule for Documentum. Later, you can further specify or expand the crawl rules.
-
+
+Before you can add the pre- and post- security trimmers, you must add one simple crawl rule for Documentum. Later, you can further specify or expand the crawl rules.
+ ### Create a simple crawl rule for Documentum
-1. Verify that the user account that is performing this procedure is an administrator for the Search service application.
-
+1. Verify that the user account that is performing this procedure is an administrator for the Search service application.
+ 2. On the SharePoint Central Administration home page, in the **Application Management** section, click **Manage Service Applications**.
-
+ 3. On the Manage Service Applications page, click the Search service application for which you want to create a crawl rule.
-
-4. On the Search Administration page, in the **Crawling** section, click **Crawl Rules**.
-
+
+4. On the Search Administration page, in the **Crawling** section, click **Crawl Rules**.
+ 5. On the Manage Crawl Rules page, click **New Crawl Rule**.
-
+ 6. On the Add Crawl Rule page, specify the following information to create a crawl rule:
-
- - In **Path** box, type **dctm://\***.
-
+
+ - In **Path** box, type **dctm://\***.
+ - In **Crawl Configuration** section, select **Include all items in this path**, and then select **Crawl complex URLs (URLs that contain a question mark - ?)**.
-
+ - In the **Specify Authentication** section, select **Specify a different content access account**, and then type the Documentum content access account and password in the appropriate boxes.
-
- - Make sure that the **Do not allow Basic Authentication** check box is cleared.
-
-7. Click **OK** to add the crawl rule.
-
+
+ - Make sure that the **Do not allow Basic Authentication** check box is cleared.
+
+7. Click **OK** to add the crawl rule.
+ ### To add the Indexing Connector for Documentum pre- and post-security trimmers 1. Start a SharePoint Management Shell on each server that hosts a query processing component.
-
+ 2. At the Microsoft PowerShell command prompt, type the following command(s):
-
- ```
+
+ ```powershell
New-SPEnterpriseSearchSecurityTrimmer -SearchApplication <name of your Search service application> -typeName "Microsoft.Office.Server.Search.Connector.Documentum.Trimmers.DctmTrimPre, Microsoft.Office.Server.Search.Connector.Documentum.Trimmers, Version=15.0.0.0,Culture=neutral, PublicKeyToken=48e046c834625a88, processorArchitecture=MSIL" -id 26 -RulePath dctm:\\* New-SPEnterpriseSearchSecurityTrimmer -SearchApplication <name of your Search service application> -typeName "Microsoft.Office.Server.Search.Connector.Documentum.Trimmers.DctmTrimPost, Microsoft.Office.Server.Search.Connector.Documentum.Trimmers, Version=15.0.0.0,Culture=neutral, PublicKeyToken=48e046c834625a88, processorArchitecture=MSIL" -id 17 -RulePath dctm:\\*
-
``` Where:
-
- - _\<name of your Search service application\>_ is the name of the Search service application.
-
-3. Restart the SharePoint Search Host Controller.
-
- - Open a Command Prompt window.
-
+
+ - _\<name of your Search service application\>_ is the name of the Search service application.
+
+3. Restart the SharePoint Search Host Controller.
+
+ - Open a Command Prompt window.
+ - To stop the SharePoint Search Host Controller, type this command: **net stop spsearchhostcontroller**
-
+ - To start the SharePoint Search Host Controller, type this command: **net start spsearchhostcontroller**
-
+ 4. Continue with [Create a Documentum content source](configure-and-use-the-documentum-connector.md#DCTM_Content_source).
-
+ ## Configure the Indexing Connector for Documentum using a user mapping table <a name="DCTM_UserMapping"> </a> The following procedures explain how to manually create a user mapping table that specifies how the Documentum users are mapped to Active Directory Domain Services (AD DS) or Active Directory service users, and how to configure the connector to support crawling Documentum content and use the user mapping table.
-
+ - The user mapping table must be in a SQL Server 2008 or a later version database.
-
+ - The OSearch15 service account must have at least read permission on the user mapping table data.
-
+ ### To create a user mapping table
-First, create a user mapping table in SQL Server 2008 or a later version. The user mapping table must have the following format:
-
-| **Column name** | **SQL datatype** | **Description** |
-| :-- | :- | :-- |
-| DCTMCredentialDomain | nvarchar(255) NOT NULL | Domain name of a Documentum account. Populate this column when the account comes from the local computer or an LDAP system. The *User Source* property of the Documentum account should equal *None* or *LDAP* . Otherwise, leave the column empty. |
-| DCTMCredentialRepository | nvarchar (32) NOT NULL | Repository name of a Documentum account. Populate this column when the account comes from a Documentum repository. |
-| DCTMCredentialLoginName | nvarchar (80) NOT NULL | Login name of the Documentum account. |
-| NTCredential | nvarchar (255) NOT NULL | Windows domain user account that searches Documentum contents in SharePoint Server 2016. |
-
+First, create a user mapping table in SQL Server 2008 or a later version. The user mapping table must have the following format:
+
+|Column name|SQL datatype|Description|
+||||
+|DCTMCredentialDomain|nvarchar(255) NOT NULL|Domain name of a Documentum account. Populate this column when the account comes from the local computer or an LDAP system. The *User Source* property of the Documentum account should equal *None* or *LDAP* . Otherwise, leave the column empty.|
+|DCTMCredentialRepository|nvarchar (32) NOT NULL|Repository name of a Documentum account. Populate this column when the account comes from a Documentum repository.|
+|DCTMCredentialLoginName|nvarchar (80) NOT NULL|Login name of the Documentum account.|
+|NTCredential|nvarchar (255) NOT NULL|Windows domain user account that searches Documentum contents in SharePoint Server 2016.|
+ Use the following script to create a user mapping table:
-
-```
+
+```sql
CREATE TABLE <replace with your user mapping table name> (
-DCTMCredentialDomain nvarchar (255) NOT NULL ,
-DCTMCredentialRepository nvarchar (32) NOT NULL ,
-DCTMCredentialLoginName nvarchar (80) NOT NULL ,
-NTCredential nvarchar (255) NOT NULL ,
-CONSTRAINT PK_CredentialMapping PRIMARY KEY CLUSTERED
+DCTMCredentialDomain nvarchar (255) NOT NULL ,
+DCTMCredentialRepository nvarchar (32) NOT NULL ,
+DCTMCredentialLoginName nvarchar (80) NOT NULL ,
+NTCredential nvarchar (255) NOT NULL ,
+CONSTRAINT PK_CredentialMapping PRIMARY KEY CLUSTERED
( DCTMCredentialDomain, DCTMCredentialRepository, DCTMCredentialLogonName )
-)
-
+)
``` Alternatively, you can manually create the user mapping table using SQL Server Management Studio or an equivalent tool. If you create the table manually, make sure that you use the same schema as defined in the script.
-
+ Next, populate the user mapping table with Documentum/Windows NT credential pairs. The table in the previous step shows what kind of input is expected.
-
+ Example:
-
+ A Documentum repository user Dan Park has a logon that is linked to the Finance repository. Dan's Windows domain user account is Contoso\dpark. In this case, the user mapping table entry for Dan should be:
-
-| &nbsp; | &nbsp; |
-| :-- | : |
-| DCTMCredentialDomain | '' |
-| DCTMCredentialRepository | Finance |
-| DCTMCredentialLogonName | dpark |
-| NTCredential | Contoso\dpark |
-
+
+|&nbsp;|&nbsp;|
+|||
+|DCTMCredentialDomain|''|
+|DCTMCredentialRepository|Finance|
+|DCTMCredentialLogonName|dpark|
+|NTCredential|Contoso\dpark|
+ > [!NOTE]
-> If any cells have no value assigned, they cannot be **null** or empty. You must assign the following empty string value: `''`. > For each Documentum group there must be a Windows NT group in the user mapping table and they must both contain the same user information.
-
+> If any cells have no value assigned, they cannot be **null** or empty. You must assign the following empty string value: `''`. > For each Documentum group there must be a Windows NT group in the user mapping table and they must both contain the same user information.
+ Finally, grant the OSearch15 account read access to the user mapping table.
-
+ ### To configure the connector using a user mapping table 1. Start a SharePoint Management Shell on each server that hosts a crawl component.
-
+ 2. At the Microsoft PowerShell command prompt, type the following command(s):
-
- ```
+
+ ```powershell
Set-SPEnterpriseSearchDCTMConnectorConfig -Shared -ACLTranslation UserMappingTable -DisplayURLPatternForContainer "http://<MyWebTopServer:PortOfMyWebTopServer>/webtop/component/drl?objectId={ObjectId}&amp;RepositoryName={RepositoryName}" -DisplayURLPatternForDocument "http://<MyWebTopServer:PortOfMyWebTopServer>/webtop/component/drl?objectId={ObjectId}&amp;format={Format}&amp;RepositoryName={RepositoryName}" -UnmappedAccount "DiscardACE" -UserMappingTableSQLServer "<YourDatabaseServerName>" -UserMappingTableSQLInstance "<YourDatabaseInstanceName>" -UserMappingTableDBName "<YourMappingDatabaseName>" -UserMappingTableName "<YourMappingTableName>" Set-SPEnterpriseSearchDCTMConnectorConfig -Repository -RepositoryName "<MyRepository1>" -DFSWebServiceURL @("http://<DFSWebServices>:<30000>/services", "http://<DFSWebServices2>:<30000>/services") Set-SPEnterpriseSearchDCTMConnectorConfig -Repository -RepositoryName "<MyRepository2>" -DFSWebServiceURL @("http://<DFSWebServices>:<30000>/services")
-
```
-
Where:
-
- - _\<MyWebTopServer:PortOfMyWebTopServer\>_ is the name and the port number of the DFS Web Top Server you are using.
-
- - _\<YourDatabaseServerName\>_ is the name of the database server on which you created the user mapping table.
-
- - _\<YourDatabaseInstanceName\>_ is the name of the database instance of the database server on which you created the user mapping table.
-
- - _\<YourMappingDatabaseName\>_ is the name of the database in which you created the user mapping table.
-
- - _\<YourMappingTableName\>_ is the name of the user mapping table that you created.
-
- - _\<MyRepository n\>_ is the name of Documentum repository that you want to crawl.
-
- - _\<DFSWebServices n\>:\<30000\>_ is the name and port number of the Documentum Web Services server that hosts the Documentum repository that you want to crawl.
-
+
+ - _\<MyWebTopServer:PortOfMyWebTopServer\>_ is the name and the port number of the DFS Web Top Server you are using.
+
+ - _\<YourDatabaseServerName\>_ is the name of the database server on which you created the user mapping table.
+
+ - _\<YourDatabaseInstanceName\>_ is the name of the database instance of the database server on which you created the user mapping table.
+
+ - _\<YourMappingDatabaseName\>_ is the name of the database in which you created the user mapping table.
+
+ - _\<YourMappingTableName\>_ is the name of the user mapping table that you created.
+
+ - _\<MyRepository n\>_ is the name of Documentum repository that you want to crawl.
+
+ - _\<DFSWebServices n\>:\<30000\>_ is the name and port number of the Documentum Web Services server that hosts the Documentum repository that you want to crawl.
+ 3. Restart the OSearch15 service. The server administrator of the server that hosts the crawl component must restart the OSearch15 service before a content source can be created for Documentum.
-
+ > [!IMPORTANT]
- > Do not use the Services on Server page on the SharePoint Central Administration website to restart this service. Doing so resets the search index, which requires you to do a full crawl of all content to rebuild the index.
-
- - Verify that the user account that is performing this procedure is an administrator for the server that hosts the crawl component.
-
+ > Do not use the Services on Server page on the SharePoint Central Administration website to restart this service. Doing so resets the search index, which requires you to do a full crawl of all content to rebuild the index.
+
+ - Verify that the user account that is performing this procedure is an administrator for the server that hosts the crawl component.
+ - Open a Command Prompt window.
-
+ - To stop the OSearch15 service, type this command: **net stop osearch15**
-
+ - To start the OSearch15 service, type this command: **net start osearch15**
-
+ Continue with [Create a crawl rule for Documentum](configure-and-use-the-documentum-connector.md#DCTM_Crawl_rule) and then continue with [Create a Documentum content source](configure-and-use-the-documentum-connector.md#DCTM_Content_source).
-
+ ## Create the Documentum crawled properties category <a name="BKMK_CrawledPropertiesCategory"> </a>
-You must create a crawled properties category that will contain the Documentum crawled properties. To do so, you use the [New-SPEnterpriseSearchMetadataCategory](/powershell/module/sharepoint-server/New-SPEnterpriseSearchMetadataCategory?view=sharepoint-ps&preserve-view=true) cmdlet and specify the predefined value 34972762-7E3F-4f4f-AE5C-5ABBA92EC530 for the cmdlet's PropSet parameter. Use the following PowerShell code to create the crawled properties category in this way.
-
-```
+You must create a crawled properties category that will contain the Documentum crawled properties. To do so, you use the [New-SPEnterpriseSearchMetadataCategory](/powershell/module/sharepoint-server/New-SPEnterpriseSearchMetadataCategory?view=sharepoint-ps&preserve-view=true) cmdlet and specify the predefined value 34972762-7E3F-4f4f-AE5C-5ABBA92EC530 for the cmdlet's PropSet parameter. Use the following PowerShell code to create the crawled properties category in this way.
+
+```powershell
$ssa = Get-SPEnterpriseSearchServiceApplication New-SPEnterpriseSearchMetadataCategory -Name "Documentum Connector" -SearchApplication $ssa -PropSet "34972762-7E3F-4f4f-AE5C-5ABBA92EC530" -DiscoverNewProperties $true- ``` ## Create a crawl rule for Documentum <a name="DCTM_Crawl_rule"> </a> Before a crawl, you must create at least one crawl rule to authenticate the crawler with the DFS Server. You can create more than one crawl rule to include or exclude specific content in Documentum.
-
-1. Verify that the user account that is performing this procedure is an administrator for the Search service application.
-
+
+1. Verify that the user account that is performing this procedure is an administrator for the Search service application.
+ 2. On the SharePoint Central Administration home page, in the **Application Management** section, click **Manage Service Applications**.
-
+ 3. On the Manage Service Applications page, click the Search service application for which you want to create a crawl rule.
-
-4. On the Search Administration page, in the **Crawling** section, click **Crawl Rules**.
-
+
+4. On the Search Administration page, in the **Crawling** section, click **Crawl Rules**.
+ 5. On the Manage Crawl Rules page, click **New Crawl Rule**.
-
+ 6. On the Add Crawl Rule page, specify the following information:
-
+ - In the **Path** box, type the path to which the crawl rule will apply. You can use standard wildcard characters. To use regular expressions instead of wildcard characters, select **Use regular expression syntax for matching this rule**. For examples, see [Syntax to refer to a Documentum object](configure-and-use-the-documentum-connector.md#DCTM_Syntax).
-
+ - In **Crawl Configuration** section, select **Include all items in this path**, and then select **Crawl complex URLs (URLs that contain a question mark - ?)**.
-
- - In the **Specify Authentication** section, select **Specify a different content access account**, and then type the Documentum content access account and password in the boxes. See _Determine which Documentum content access account to use_ earlier in this article.
-
- - Make sure that the **Do not allow Basic Authentication** check box is cleared.
-
-7. Click **OK** to add the crawl rule.
-
+
+ - In the **Specify Authentication** section, select **Specify a different content access account**, and then type the Documentum content access account and password in the boxes. See _Determine which Documentum content access account to use_ earlier in this article.
+
+ - Make sure that the **Do not allow Basic Authentication** check box is cleared.
+
+7. Click **OK** to add the crawl rule.
+ > [!NOTE]
- > You can create multiple crawl rules for Documentum to include or exclude Documentum content.
- >
- > You can use different crawl rules to specify different content access accounts for different Documentum content. For example, you have two repositories and two content access accounts for each repository. The Documentum content access account specified in a crawl rule will only be applied to Documentum content covered by the path in that crawl rule. If you use the Security Trimming Sync Service, you must set up this service for each Documentum server.
-
+ > You can create multiple crawl rules for Documentum to include or exclude Documentum content.
+ >
+ > You can use different crawl rules to specify different content access accounts for different Documentum content. For example, you have two repositories and two content access accounts for each repository. The Documentum content access account specified in a crawl rule will only be applied to Documentum content covered by the path in that crawl rule. If you use the Security Trimming Sync Service, you must set up this service for each Documentum server.
+ ## Create a Documentum content source <a name="DCTM_Content_source"> </a>
-You create a content source for Documentum content to specify which Documentum content repositories you want to crawl.
-
+You create a content source for Documentum content to specify which Documentum content repositories you want to crawl.
+ 1. Verify that the user account that is performing this procedure is an administrator for the Search service application.
-
+ 2. On the SharePointSharePoint Central Administration home page, in the **Application Management** section, click **Manage Service Applications**.
-
-3. Click the Search service application in which you want to create a content source.
-
+
+3. Click the Search service application in which you want to create a content source.
+ 4. On the Search Administration Page, in the **Crawling** section, click **Content Sources**.
-
+ 5. On the Manage Content Sources page, click **New Content Source**.
-
+ 6. On the Add Content Source page, do the following:
-
- 1. In the **Name** box, type the name for the new content source.
-
+
+ 1. In the **Name** box, type the name for the new content source.
+ 1. In the **Content Source Type** section, select **Custom Repository**.
-
- 1. In the **Type of Repository** section, select **SharePoint Indexing Connector for Documentum**. Use the name that you specified when you registered the Indexing Connector for Documentum with the Search service application.
-
+
+ 1. In the **Type of Repository** section, select **SharePoint Indexing Connector for Documentum**. Use the name that you specified when you registered the Indexing Connector for Documentum with the Search service application.
+ 1. In the **Start Addresses** section, type the start addresses. The start address format is the same as the path pattern. You can type more than one start address for the content source, one per line. For examples, see [Syntax to refer to a Documentum object](configure-and-use-the-documentum-connector.md#DCTM_Syntax).
-
- 1. In the **Crawl Schedules** section, select schedules from the **Full Crawl** and **Incremental Crawl** drop-down lists, or create schedules for each kind of crawl.
-
- 1. In the **Content Source Priority** section, assign a priority level to the content source according to your business requirements.
-
+
+ 1. In the **Crawl Schedules** section, select schedules from the **Full Crawl** and **Incremental Crawl** drop-down lists, or create schedules for each kind of crawl.
+
+ 1. In the **Content Source Priority** section, assign a priority level to the content source according to your business requirements.
+ 1. Click **OK**.
-
+ 7. On the **Manage Content Sources** page, right-click the content source for Documentum and click **Start Full Crawl**.
-
-The Documentum content source is configured and the system can crawl Documentum content repositories that are specified in the content source.
-
+
+The Documentum content source is configured and the system can crawl Documentum content repositories that are specified in the content source.
+ SharePoint Server supports scalable architecture for performance scale-out. You can deploy more than one server that hosts a crawl component and you can configure multiple crawlers to crawl the EMC Documentum database at the same time.
-
+ ## Syntax to refer to a Documentum object <a name="DCTM_Syntax"> </a> The format to refer to a Documentum object that you use for the path (when you set up a crawl rule) and the start address (when you set up a content source) is defined in the following table:
-
-| **Type of Documentum object** | **Syntax for the path or the start address** |
-| :- | :- |
-| Repository | dctm://\<clientapphostname\>/\<repository name\> |
-| Cabinet | dctm://\<clientapphostname\>/\<repository name\>/\<cabinet name\> |
-| Folder | dctm://\<clientapphostname\>/\<repository name\>/\<cabinet name\>/\<folder name\> |
-| Document | dctm://\<clientapphostname\>/\<repository name\>/\<cabinet name\>/\<folder name\>/…/\<folder name\>?DocSysID=\<r_object_id\> (where r_object_id is the object ID of that document) |
-
- *\<clientapphostname\>* is the host name of your Documentum client application such as Webtop or DA. The *\<clientapphostname\>* configured here must be the same as the one that is used in the content source. *\<repository name\>* , *\<cabinet name\>* , and *\<folder name\>* are case-sensitive.
-
+
+|Type of Documentum object|Syntax for the path or the start address|
+|||
+|Repository|dctm://\<clientapphostname\>/\<repository name\>|
+|Cabinet|dctm://\<clientapphostname\>/\<repository name\>/\<cabinet name\>|
+|Folder|dctm://\<clientapphostname\>/\<repository name\>/\<cabinet name\>/\<folder name\>|
+|Document|dctm://\<clientapphostname\>/\<repository name\>/\<cabinet name\>/\<folder name\>/.../\<folder name\>?DocSysID=\<r_object_id\> (where r_object_id is the object ID of that document)|
+
+ *\<clientapphostname\>* is the host name of your Documentum client application such as Webtop or DA. The *\<clientapphostname\>* configured here must be the same as the one that is used in the content source. *\<repository name\>* , *\<cabinet name\>* , and *\<folder name\>* are case-sensitive.
+ ## Using the SPEnterpriseSearchDCTMConnectorConfig cmdlet <a name="DCTM_cmdlet"> </a> Use the following Microsoft PowerShell commands to display help and examples for the Indexing Connector for Documentum cmdlet:
-
-- `Get-help Set-SPEnterpriseSearchDCTMConnectorConfig -full` shows full help.
-
-- `Get-help Set-SPEnterpriseSearchDCTMConnectorConfig -examples` shows only examples.
-
-The Set-SPEnterpriseSearchDCTMConnectorConfig cmdlet accepts three parameter sets. You use the *Shared* parameter set to change the configuration settings that affect all the Documentum repositories that you crawl. You use the *Repository* parameter set to change the configuration settings that affect only a specific repository. You use the *Remove* parameter set to remove a specific repository from the connector configuration.
-
+
+- `Get-help Set-SPEnterpriseSearchDCTMConnectorConfig -full` shows full help.
+
+- `Get-help Set-SPEnterpriseSearchDCTMConnectorConfig -examples` shows only examples.
+
+The Set-SPEnterpriseSearchDCTMConnectorConfig cmdlet accepts three parameter sets. You use the *Shared* parameter set to change the configuration settings that affect all the Documentum repositories that you crawl. You use the *Repository* parameter set to change the configuration settings that affect only a specific repository. You use the *Remove* parameter set to remove a specific repository from the connector configuration.
+ The following table shows which parameters are mandatory and which are optional.
-
-| **Action** | **Mandatory parameters** | **Optional parameters** |
-| :- | :- | :- |
-| Configure shared repository settings | Shared | DFSURL, UserMappingTableSQLServer, UserMappingTableSQLInstance, UserMappingTableDBName, UserMappingTableName, ACLTranslation, UnmappedAccount, DisplayURLPatternForDocument, DisplayURLPatternForContainer. |
-| Configure settings for a specific repository | Repository, RepositoryName | DFSWebServiceURL, IndexAllVersions, ACLTranslation, UnmappedAccount, DisplayURLPatternForDocument, DisplayURLPatternForContainer. |
-| Remove a repository from configuration | Remove, RepositoryName | |
-
+
+|Action|Mandatory parameters|Optional parameters|
+||||
+|Configure shared repository settings|Shared|DFSURL, UserMappingTableSQLServer, UserMappingTableSQLInstance, UserMappingTableDBName, UserMappingTableName, ACLTranslation, UnmappedAccount, DisplayURLPatternForDocument, DisplayURLPatternForContainer.|
+|Configure settings for a specific repository|Repository, RepositoryName|DFSWebServiceURL, IndexAllVersions, ACLTranslation, UnmappedAccount, DisplayURLPatternForDocument, DisplayURLPatternForContainer.|
+|Remove a repository from configuration|Remove, RepositoryName||
+ ## See also <a name="DCTM_cmdlet"> </a>
SharePoint Configure Properties Of The Search Results Web Part https://github.com/MicrosoftDocs/OfficeDocs-SharePoint/commits/public/SharePoint/SharePointServer/search/configure-properties-of-the-search-results-web-part.md
Stemming means that nouns and adjectives in a query are expanded to different po
2. On the search results page, click the **Settings** menu, and then click **Edit page**.
-3. In the Search Results Web Part, click the **Search Results Web Part Menu** arrow, click **Export…**, and then save the Web Part to your computer.
+3. In the Search Results Web Part, click the **Search Results Web Part Menu** arrow, click **Export...**, and then save the Web Part to your computer.
4. Open the Web Part in a text editor ΓÇö for example, Notepad.
SharePoint Create And Deploy A Thesaurus https://github.com/MicrosoftDocs/OfficeDocs-SharePoint/commits/public/SharePoint/SharePointServer/search/create-and-deploy-a-thesaurus.md
Title: "Create and deploy a thesaurus in SharePoint Server"-+
description: "Learn how to create and deploy a thesaurus to expand queries with
# Create and deploy a thesaurus in SharePoint Server [!INCLUDE[appliesto-2013-2016-2019-SUB-xxx-md](../includes/appliesto-2013-2016-2019-SUB-xxx-md.md)]
-
+ Use a thesaurus file to specify synonyms for a single word or multiple words that occur in queries in the classic search experience. The query is expanded based on the entries in the thesaurus. You create and maintain the thesaurus file in a system external to SharePoint Server before you import it into SharePoint Server to make the synonyms available to the search system.
-
+ > [!NOTE]
-> You can only deploy one thesaurus per SharePoint Server farm.
-
-
+> You can only deploy one thesaurus per SharePoint Server farm.
+ ## Create a thesaurus <a name="proc1"> </a>
-To define the entries in your thesaurus, you enter terms and their corresponding synonyms in a comma separated (.csv) file. Optionally, you can also specify in which language the query should be written for a synonym to apply.
-
-If you want to define more than one synonym for one key, you have to create multiple entries in the thesaurus. Also, if you want the synonym to work both ways, for example, if you want the term "IE" to also return search results for "Internet Explorer" and you want the term "Internet Explorer" to also return results for "IE", you have to create two thesaurus entries.
-
-To create your thesaurus terms, you can use alphabetical Unicode characters such as a, ø, ü, or é. Your terms can also include underscores (_), hyphens (-), and straight apostrophes ('). Your terms can't include non-alphabetical Unicode characters, such as hashtag (#), slash (/), backslash (\\), period (.), or question mark (?). You also can't use abbreviations that include non-alphabetical Unicode characters, such as E.K.G or d\r.
-
+To define the entries in your thesaurus, you enter terms and their corresponding synonyms in a comma separated (.csv) file. Optionally, you can also specify in which language the query should be written for a synonym to apply.
+
+If you want to define more than one synonym for one key, you have to create multiple entries in the thesaurus. Also, if you want the synonym to work both ways, for example, if you want the term "IE" to also return search results for "Internet Explorer" and you want the term "Internet Explorer" to also return results for "IE", you have to create two thesaurus entries.
+
+To create your thesaurus terms, you can use alphabetical Unicode characters such as a, ø, ü, or é. Your terms can also include underscores (_), hyphens (-), and straight apostrophes ('). Your terms can't include non-alphabetical Unicode characters, such as hashtag (#), slash (/), backslash (\\), period (.), or question mark (?). You also can't use abbreviations that include non-alphabetical Unicode characters, such as E.K.G or d\r.
+ The matching between the thesaurus keys and query terms is not case sensitive. When a query term matches a thesaurus key, the query is expanded with the synonym(s) for that key and the search results will contain results for the original query term as well as for the synonym.
-
- **To create a thesaurus**
-
-1. Create a .csv file with the columns **Key**, **Synonym** and **Language**. Make sure you use a comma as the column separator. If the file contains non-ASCII characters such as diacritics, you must encode it in UTF-8. Save the file to a location that is accessible from the server from which you will run the Microsoft PowerShell cmdlet to deploy the thesaurus.
-
- - In the **Key** column, enter the term (single or multiple words) that you want to trigger a synonym for when the term occurs in a query. Make sure there are no leading or trailing spaces around the terms.
-
- - In the **Synonym** column, enter the synonym (single or multiple words) that you want to add to the query if the term specified in the **Key** column occurs in a query. Synonyms consisting of multiple words will be added as phrases to the query.
-
- - In the optional **Language** column, enter the abbreviation for the language for which the synonym should apply. See the table in [Linguistic search features in SharePoint Server](../technical-reference/linguistic-search-features.md) for an overview of available languages and their code. If you leave this column empty, the query is expanded with the synonym regardless of the query language. Make sure there are no leading or trailing spaces around the language codes.
-
+
+**To create a thesaurus**:
+
+1. Create a .csv file with the columns **Key**, **Synonym** and **Language**. Make sure you use a comma as the column separator. If the file contains non-ASCII characters such as diacritics, you must encode it in UTF-8. Save the file to a location that is accessible from the server from which you will run the Microsoft PowerShell cmdlet to deploy the thesaurus.
+
+ - In the **Key** column, enter the term (single or multiple words) that you want to trigger a synonym for when the term occurs in a query. Make sure there are no leading or trailing spaces around the terms.
+
+ - In the **Synonym** column, enter the synonym (single or multiple words) that you want to add to the query if the term specified in the **Key** column occurs in a query. Synonyms consisting of multiple words will be added as phrases to the query.
+
+ - In the optional **Language** column, enter the abbreviation for the language for which the synonym should apply. See the table in [Linguistic search features in SharePoint Server](../technical-reference/linguistic-search-features.md) for an overview of available languages and their code. If you leave this column empty, the query is expanded with the synonym regardless of the query language. Make sure there are no leading or trailing spaces around the language codes.
+ A thesaurus is commonly used to expand acronyms. But you can also use a thesaurus to automatically include variations of a search term into the query for specific terminology used in your organization. An example thesaurus file input could look like this: Key,Synonym,Language IE,Internet Explorer Internet Explorer,IE UN,United Nations,en UN,Vereinte Nationen,de BAM,billing and account management billing and account management,billing and accounts
-
+ ## Deploy a thesaurus <a name="proc2"> </a>
-You create and maintain the thesaurus file in a file external to SharePoint Server before you import it into SharePoint Server to make the synonyms available to the search system. You can't export a thesaurus from SharePoint Server. If you want to make changes to your synonyms, you have to update the thesaurus file and then redeploy it.
-
+You create and maintain the thesaurus file in a file external to SharePoint Server before you import it into SharePoint Server to make the synonyms available to the search system. You can't export a thesaurus from SharePoint Server. If you want to make changes to your synonyms, you have to update the thesaurus file and then redeploy it.
+ > [!NOTE]
-> When you redeploy a thesaurus file, the existing thesaurus will be overwritten with the information from the updated thesaurus file.
-
- **To import a thesaurus file**
-
+> When you redeploy a thesaurus file, the existing thesaurus will be overwritten with the information from the updated thesaurus file.
+
+**To import a thesaurus file**:
+ 1. Verify that the user account that is performing this procedure is an administrator for the Search service application.
-
+ 2. Start the SharePoint Management Shell.
-
+ 3. At the Windows PowerShell command prompt, type the following command:
-
- ```
- $searchApp = Get-SPEnterpriseSearchServiceApplication
+
+ ```powershell
+ $searchApp = Get-SPEnterpriseSearchServiceApplication
Import-SPEnterpriseSearchThesaurus -SearchApplication $searchApp -Filename <Path>
-
``` Where:
-
- - _\<Path\>_ specifies the full UNC path of the .csv file (the thesaurus) to be imported.
-
+
+ - _\<Path\>_ specifies the full UNC path of the .csv file (the thesaurus) to be imported.
+ ## See also <a name="proc2"> </a>
SharePoint How To Change The Way Search Results Are Displayed https://github.com/MicrosoftDocs/OfficeDocs-SharePoint/commits/public/SharePoint/SharePointServer/search/how-to-change-the-way-search-results-are-displayed.md
This series will explain how to customize the way search results are displayed i
As you know, Microsoft publishes thousands of articles across TechNet, MSDN and Office.com. To help in the publishing process, we use several SharePoint lists. Each item in a list represents an article or a media file. To quickly find information about a list item, we've set up a Search Center that searches across all of the lists.
-This series will show how to change the way search results are displayed from this…
+This series will show how to change the way search results are displayed from this...
![Default Search Results](../media/OTCSP_DefaultSearchResults.png)
SharePoint How To Configure The Search Results Web Part To Use A New Result Source https://github.com/MicrosoftDocs/OfficeDocs-SharePoint/commits/public/SharePoint/SharePointServer/search/how-to-configure-the-search-results-web-part-to-use-a-new-result-source.md
To save space, we'll only show you how to create a result source as a Site colle
![Enter Query](../media/OTCSP_TestQuery.png)
- Notice that 52 results were returned. (I will tell you why this is kind of cool in the next section…).
+ Notice that 52 results were returned. (I will tell you why this is kind of cool in the next section...).
7. Click **OK** to close the dialog, and then **Save**.
SharePoint Plan Crawling And Federation https://github.com/MicrosoftDocs/OfficeDocs-SharePoint/commits/public/SharePoint/SharePointServer/search/plan-crawling-and-federation.md
Title: "Plan crawling and federation in SharePoint Server"-+
description: "Plan to crawl or federate for search in SharePoint Server."
# Plan crawling and federation in SharePoint Server [!INCLUDE[appliesto-2013-2016-2019-SUB-xxx-md](../includes/appliesto-2013-2016-2019-SUB-xxx-md.md)]
-
+ Before users can perform searches in SharePoint Server, you must crawl or federate the content that you want them to be able to search. When you crawl content, the Search service builds a search index that users can run queries (search requests) against. You can also configure the Search system to display search results from an external provider (such as Bing) alongside the results from the local search index. The process of getting search results from an external provider and displaying the results locally is called federation.
-
-
+ ## Plan content sources <a name="Section2"> </a>
-A *content source* is a definition of a group of crawl settings such as which hosts to crawl, the type of content that will be crawled (such as SharePoint content or file shares), a crawl schedule, and how deep to crawl.
-
-When you create a Search service application, the service application automatically provides the pre-configured content source **Local SharePoint sites**. You can use this content source to specify how to crawl all SharePoint content in web applications that are associated with the Search service application.
-
+A *content source* is a definition of a group of crawl settings such as which hosts to crawl, the type of content that will be crawled (such as SharePoint content or file shares), a crawl schedule, and how deep to crawl.
+
+When you create a Search service application, the service application automatically provides the pre-configured content source **Local SharePoint sites**. You can use this content source to specify how to crawl all SharePoint content in web applications that are associated with the Search service application.
+ If you have only one type of content (for example, all content is of type SharePoint sites or type file shares), you might need only one content source. However, if you have different types of content or unique requirements per host, you might want to define multiple content sources. Plan to create additional content sources when you have to do the following:
-
+ - Crawl different types of content ΓÇö for example, file shares and data in a line-of-business application
-
+ - Crawl some content on different schedules than other content
-
+ - Limit or increase the quantity of content that is crawled
-
+ - Set different priorities for crawling different sites
-
+ - Keep some types of content fresher than others
-
+ You can create a large number of content sources in each Search service application, but there is overhead associated with each content source. Therefore, we recommend that you create the smallest number of content sources that satisfy your other operational requirements, such as differences in crawl priority and crawl scheduling. Each content source can contain up to 100 start addresses.
-
+ ### Plan to crawl different kinds of content <a name="Section3"> </a> You can crawl only one kind of content per content source. For example, you can create a content source that contains start addresses for SharePoint sites and another content source that contains start addresses for file shares, but you cannot create a single content source that contains start addresses to both SharePoint sites and file shares. The following table lists the kinds of content sources that you can configure.
-
-| **Use this kind of content source** | **For this content** |
-| :- | : |
-| SharePoint sites | SharePoint sites from the same farm or different SharePoint Server farms. <br/><br/> SharePoint sites from the same farm or different SharePoint Server 2019, SharePoint Server 2016, SharePoint Server 2013, SharePoint Server 2010, SharePoint Foundation 2010, or Microsoft Search Server 2010 farms. <br/> <br/>SharePoint sites from the same farm or different Office SharePoint Server 2007, Windows SharePoint Services 3.0, or Search Server 2008 farms. |
-| Web sites | Other web content in your organization that is not located in SharePoint sites. <br/><br/> Content on web sites on the Internet. |
-| File shares | Content on file shares in your organization. <br/> <br/>**Security note:** When the Search service crawls a file share, if the permissions on a file on the share are different from the permissions on folders that contain the file, then the permissions on the file take precedence and are used for security trimming of search results. Therefore, to ensure that only appropriate items appear in search results, make sure that the permissions for files on file shares are appropriate. For cases in which file permissions are not appropriate, you can delete particular items from the search index or from search results. For more information, see [Delete items from the search index or from search results in SharePoint Server](delete-items-from-the-search-index-or-from-search-results.md). |
-| Exchange public folders | Exchange 2007 and Exchange Server 2010 public folders. |
-| Lotus Notes | E-mail messages stored in Lotus Notes databases. <br/> <br/>**Note:** Unlike all other kinds of content sources, the Lotus Notes content source option does not appear in the user interface until you have installed and configured the appropriate prerequisite software. For more information, see [Configure and use the Lotus Notes connector for SharePoint Server](configure-and-use-the-lotus-notes-connector.md) (also applies to SharePoint Server).