This guide contains instructions for installing and configuring Metalogix ControlPoint for Office365 SharePoint Administration (alternatively called ControlPoint Online). ControlPoint Online is a Web-based application that offers a proactive, integrated solution for managing site collections within a hosted SharePoint environment.
On-Premises Server Requirements
·Windows Server 2008 or 2008 R2, 2012 Service Pack 3, 64-bit, or Windows Server 2016, with the IIS role configured.
NOTE: The server can be either dedicated to ControlPoint Online or shared with other functions.
·Microsoft SQL Server: SQL Server 2014 SP1 (64 bit), or 2016 (to host the ControlPoint Services (xcAdmin) database.
NOTE: ControlPoint can use the same SQL Server instance as SharePoint, but it can also use a separate instance or separate server.
·.NET framework version 3.5 (for use by the installer) in addition to the .NET version required for SharePoint, and ASP.NET 4.0 or later.
·PowerShell version 3.0 or later.
NOTE: For Windows Server 2008 and 2008 R2, it may be necessary to install Windows Management Framework 3.0 to run Windows PowerShell 3.0
·The account used to install ControlPoint Online must be:
§a member of the local Administrator's group on the machine where ControlPoint Online is installed
§added to the security server role sysadmin in the SQL server that will be hosting the ControlPoint Services database
§The account used to create the ControlPoint Configuration Site must be a Site Collection Administrator for the Site Collection where the site will be created.
·The account that will be used to run ControlPoint (that is the ControlPoint Service Account) must:
§be a member of the local Administrator's group on the machine where ControlPoint Online is installed
§have a valid login for the SQL server that will be hosting the ControlPoint Services (xcAdmin)database. (sysadim rights are not required for this account)
§be a Site Collection Administrator for each site collection to be managed using ControlPoint.
NOTE: If you will be configuring ControlPoint Services, the account must meet all of the requirements listed above and have permissions to Run as a Service.
ControlPoint User Requirements
ControlPoint users must:
·be members of the Site Collection Administrators group in site collection that will host the ControlPoint Configuration site as well as in every Site Collection they will be managing using ControlPoint Online.
·use a compatible Web browser:
§Microsoft Internet Explorer (IE) version 10 or later
EXCEPTION: When using Internet Explorer build 11.0.9600.18617, report results do not fill the entire results section.
§Mozilla Firefox version 3 or later
§Google Chrome (latest public release)
Note that some browsers may have limitations.
Supported Authentication Methods
Authentication to hosted site collections can be based on either of the following methods:
·Separate accounts that are managed within the hosted environment
When this method is used, credentials are passed to and must be verified in the hosted environment in order for ControlPoint to be accessed.
·Using Active Directory Federated Services (ADFS)
When this method is used, ControlPoint will authenticate with the local ADFS and use that identity to communicate with the hosted environment.
·Active Directory accounts in the client environment
This method assumes that these accounts are valid in the hosted environment.
IIS Configuration Requirements if SharePoint is not Installed
If SharePoint is not installed on the same server as ControlPoint Online, IIS must be configured to allow the ControlPoint Online Configuration Stie to run on the server. See Appendix: Configuring IIS if SharePoint is not Installed for details.
If you want to use ControlPoint to manage multiple farms and/or O365 tenants, a copy of the ControlPoint application must be installed on a server in each environment. Each farm has:
·its own Web application and ControlPoint Configuration site
·its own ControlPoint menus (including any customized menus), and
·its own ControlPoint security model, which determines administrators' access to ControlPoint menu items.
You have the option of installing ControlPoint either:
·as separate, single-farm installations, which means that each farm has:
§its own ControlPoint Service (xcAdmin) databases, and
§its own ControlPoint license activation code
·as a multi-farm installation, which means that farms share:
§the same ControlPoint Service (xcAdmin) database, which allows ControlPoint users to navigate among and operate on other farms and makes it easier to switch from one farm to another from within the ControlPoint application interface, and
§a common ControlPoint license activation code.
You can manage farms running different versions of SharePoint in a multi-farm installation. You cannot, however, copy/move site collections, sites, lists, or list items between farms with different SharePoint versions. Quest offers tools that can help you migrate between SharePoint versions. Contact Quest for more information.
Factors to Consider When Choosing the Appropriate Installation Type for your SharePoint Environment
The optimal installation type depends on a number of factors, including how your SharePoint environment is configured, the size of your farms, and whether there is connectivity between them.
Single-farm installations are preferable if
·farms are in different domains that do not have a two-way trust relationship
·farms are on different WANs or network segments where bandwidth is limited or connectivity between farms is not maintained
·SQL server resources are limited and scalability of the xcAdmin database is a concern, and/or
·different groups of people are responsible for managing different farms.
If you choose this approach, you will need to bookmark each of the farms if you want to easily switch between them. You will still be able to copy and move sites across farms, but you will have to enter the destination site's url instead of selecting it from a list.
Consider a multi-farm installation if:
·you want to be able to:
§navigate through and operate on more than one farm using a single application interface
§run ControlPoint actions and analyses on more than one farm in a single operation, and/or
§quickly switch between farms from the ControlPoint application interface
·farms are in the same domain or in domains with at least a two-way trust relationship
·farms are on the same WAN or network segment (that is, bandwidth is adequate and connectivity between farms is maintained)
·your SQL server is robust enough that scalability of the xcAdmin database is not an issue
·the same group of people is responsible for managing all farms.
For farms that utilize a common instance of SQL server, you will need to perform a multi-farm installation. When installing ControlPoint in this circumstance, be sure to provide a unique name for the content database used by the Web application that hosts the ControlPoint Configuration Site collection for each farm.
You can of course use different installation types to suit the needs of different farms. For example, you may want to use a multi-farm installation for QA and development farms and single farm installations for production farms.
·Contact Quest Support to obtain a license activation code for each additional farm.
·For each farm, complete the entire installation process, which includes:
§specifying the location where you want to create the ControlPoint Service (xcAdmin) database for the farm, and
§activating a separate ControlPoint license for each farm.
a multi-farm installation
·Install ControlPoint in the first farm, which includes:
§specifying the location where you want to create the ControlPoint Service (xcAdmin) database that will be shared by all farms, and
§activating your ControlPoint license.
·For additional farms, perform a complete installation and when you specify the location of the xcAdmin database, be certain to specify the server on which you created the database for the first farm.
NOTE: Make sure that all farms in a multi-farm environment are running the same version of ControlPoint.
Metalogix ControlPoint for Office 365 SharePoint Administration (ControlPoint Online) is installed and runs as a .NET application. During installation:
·a dedicated application pool is created in IIS for the primary ControlPoint Configuration site, which is installed under the root site of a hosted site collection
· the ControlPoint Service database (xcAdmin) is created for configuration information and analysis data
Before You Begin
·The site collection that will host the ControlPoint Configuration Site must exist on the host and be in the English language.
·The machine on which you are installing ControlPoint must meet System Requirements.
·Make sure the machine on which you are installing ControlPoint has access to the Internet if you want to be able to activate your ControlPoint license online.
Have the following information ready (you may wish to record it in the spaces provided):
§The URL for the site collection that will host the primary ControlPoint Configuration Site* and the URL of the SharePoint Administration site hosting the site collection.
ControlPoint Configuration Site Collection URL: ______________________________________
SharePoint Administration Site URL: _____________________________________________
*REMINDER: The ControlPoint Configuration Site must be created in an English-language site collection.
§The name and port number that you want IIS to use to manage the ControlPoint Configuration Site (The default port number is 2828, but you can set it to any available value.)
Web Site Name:______________________________
Port Number: _____________________________
§The account under which you want the application pool for the ControlPoint Configuration Site to run (This is normally a domain account, but if you are running an evaluation version of the productand the database is on the same machine as ControlPointyou may use a local account.)
App Pool Service Account: ____________________________________
§The email credentials that you want to use as the "from" account for correspondence sent on behalf of ControlPoint.
Local SMTP Server: ___________________________________
Email address: ___________________________________
§The name of the SQL server that will host the ControlPoint Service (xcAdmin) database, as well as the authentication method to be used:
(This is where the content database for the ControlPoint application will reside.)
Database Server Name: __________________________
SQL Server ID ___________________________ Password _______________________
§The ControlPoint Online license activation code: ________________________________
§The Site Collection Administrator account that will be used to create the ControlPoint Configuration Site.
Site Collection Administrator Account: _____________________________________
NOTE: If you do not already have a license activation code, contact Quest to obtain one.
First Time Installation and Configuration Process
The ControlPoint Online first time installation and configuration process consists of the following stages:
C.Optionally, configuring ControlPoint Services.