Migrator for Notes to SharePoint 6.16 - User Guide

SharePoint tab

SharePoint tab

The SharePoint tab is where you can define your target SharePoint sites and how you want Migrator for Notes to SharePoint to connect to them. Migrator for Notes to SharePoint is capable of migrating to local (same machine) or remote SharePoint servers.

 

Table 7. SharePoint tab

Item	Description
Name	The Name field is used to distinguish between defined SharePoint environments if you have enabled and defined more than one environment. To define more than the standard default, select the Enable multiple SharePoint environments check box.
Type	Use the Type dropdown to control the mode of operation. The Type dropdown has the following options: • SharePoint servers using Quest Import Service - Use this option for migrations to a remote SharePoint server that is running the Quest Import Service. • SharePoint web services (Classic Mode Authentication) - Use this option for migrations to a remote SharePoint 2010, 2013, 2016 or 2019 server using Microsoft Web Services rather than the Quest Import Service. • SharePoint web services (Forms-Based Authentication)- Use this option for migrations to a remote SharePoint 2010, 2013, 2016 or 2019 server using Microsoft Web Services using forms based authentication. • SharePoint web services (Office 365 Authentication) - Use this option to migrate to Office 365 SharePoint sites using Microsoft's Windows Identity Foundation. Microsoft's Windows Identity Foundation must be installed on the client in order to use the Office 365 Authentication environment type. NOTE: You can use the Forms-Based Authentication environment type to access Office 365 SharePoint sites. The advantage of using the Office 365 Authentication environment type is that Migrator for Notes to SharePoint can authenticate with SharePoint without user intervention. NOTE: If you are using Quest Import Service, the version of Quest Import Service should be the same as or greater than the version of the Migrator for Notes to SharePoint client. NOTE: If you are using Microsoft Web Services, you must use the client for User and Group Mapping. For more information, see User Mapping tab, and Group Mapping tab.
Settings	Click this button to define options for your SharePoint environment. The general options are: • Use TLS 1.2 - Select this check box to connect to SharePoint sites using the TLS 1.2 protocol. • Enable the Quest Link Tracking Service - Select this check box to use the Link Tracking Service. The options for environments using the Microsoft Web Services are: • SharePoint Online throttling - Specify a value in Incremental back off uses x seconds between retries to avoid getting throttled to set the time waited after receiving a 429 web exception from SharePoint, before retrying the migration. Specify a value in Retries x times before reporting throttled error to set the number of times the migration will be retried. The delay time doubles with each retry. For example, if you set 30 seconds and 5 retries, the delay between retries will be 30, 60, 120, 240, and 480 seconds. If migration is not successful after the last retry, throttling is reported. • Refresh cookies x minutes before they are due to expire - Connections to SharePoint sites using Forms Based Authentication will automatically renew cookies as needed during long migration jobs and other operations. The tool will routinely check the expiration time of the authentication tokens that it holds for the client and, if a token is due expire within this specified time limit, it will force a new authentication. The time limit defaults to 30 minutes. Depending on your particular authentication system, this may appear to the user as a browser prompt forcing the user to re-authenticate. In other cases, it may appear as a browser that opens briefly and then closes again. • Force cookies to expire x minutes after they are acquired - For SharePoint sites using Forms Based Authentication where the cookies are issued by authentication providers other than SharePoint, Migrator for Notes to SharePoint is unable to determine the expiration of the cookies. This option allows Migrator for Notes to SharePoint to manage the expiration. • Cache authentication cookies in configuration file - Select this check box to cache the authentication cookies in the configuration file. If you choose to not cache the authentication cookies, Migrator for Notes to SharePoint will re-authenticate to get new cookies every time Migrator for Notes to SharePoint is restarted. If you are using forms-based authentication, you will have to manually sign in each time. • Azure Storage Account Settings - Check Enable Azure Turbo Mode to use the SharePoint Online Migration API to perform migrations to Office 365. Azure Turbo mode significantly improves migration speed for large migrations. You must supply an Azure Storage Account name and Access Key, where migrated data is stored temporarily. If you are migrating confidential information, check Encrypt Content for extra protection at a small performance cost. You can also set a timeout interval for the migration job by the option Stop migration import job after …. Leaving the field empty means no timeout. The Azure option is available for Office 365, and SharePoint Online using Form Based Authentication. The options for environments using the Quest Import Service are: • Perform user/group mapping operations on the client - To have the client (Console or Designer) rather than the Import Service perform the user and group mapping operations, select this check box. When selected, the options configured in the User Mapping tab and Group Mapping tab will be used rather than the options found on the Migrator for Notes to SharePoint Services configuration page on the SharePoint server.
Settings (continued)	• Use shared folder for transferring data - If you do not wish to use the shared folder as a means of transferring data even though a shared folder has been configured on the server, do not select this check box. For more information on the shared folder, see the Configuring Migrator for Notes to SharePoint Services section of the Migrator for Notes to SharePoint Installation Guide. This check box is only enabled if Remote SharePoint connections are enabled. Unchecking this check box will force the client to transmit the data as encrypted bits. Checking this check box will have no effect if a shared folder has not been configured on the server. • Update managed metadata field using web service - Select this checkbox if you get an “Access is denied” error while migrating to a SharePoint List with Managed Metadata field using Import Service, and the Import Service and SharePoint are running under different accounts. NOTE: You do not have to select this check box if your migration to the Managed Metadata field is successful. • Perform direct writes to the Link Tracking database from clients - To have the client rather than the Import Service perform the updates to the Link Tracking database, select this check box. When this is selected, the options configured in the Link Tracking tab will be used rather than the options found on the Migrator for Notes to SharePoint Services configuration page on the SharePoint server.
Credentials	Click the Credentials link to enter your SharePoint user name and password. NOTE: For the Forms Based authentication Type, the Credentials link is not active until you click Add to add the SharePoint site URL to the SharePoint Site Collections list. For all other Types, the Credentials link is active right away. If you are using single sign-on and want to use Windows authentication in Migrator for Notes to SharePoint to be able to authenticate with Office 365, select the Use Windows authentication radio button. • Home Realm - Enter the Active Directory Federation Services (ADFS) Federation Service endpoint URL. This should be the same host name that you are using in the "whr" parameter in your single sign-on SharePoint URLs. • STS application pool identity - Enter the name of the identity that is being used by the ADFS application pool. It should be in the form of “domain\username”. • Internal Site - To migrate to the public facing website, enter one of your internal site collection URLs in this field.
Configure SharePoint Site Collections	Click the Add button to add your particular SharePoint site URL to the SharePoint Site Collections list and test connectivity to those sites. Note that you do not need to specify each sub-site here; Migrator for Notes to SharePoint can discover those automatically. To add a site, enter the site URL, including "http://" or "https://", and click OK in the Add SharePoint Site dialog box. To add your login credentials, click the ‘Credentials’ link. If you are authenticating using Forms Based Authentication, the credentials link works a little differently. Click the ‘Not authenticated’ link to display the sites configured login screen. Migrator for Notes to SharePoint saves the resulting authentication as long as possible and then re-prompt the user when appropriate. To test a site, select it and click the Test Connections link. • Can you access the site with the address and credentials you supplied? If this test fails, correct your address and credentials and try again. • Is the site you specified enabled to allow remote import of documents? This requires that Migrator for Notes to SharePoint’s Import Service is installed on the remote server and is enabled and configured for that particular site. • Can you connect to the Migrator for Notes to SharePoint Import Service? If this test fails, make sure that the Import Service is running and that the service address and endpoint are correctly configured for that particular site. Also, check that the host name and port number being used by the Import Service is not being blocked by a firewall on the client or server. NOTE: There are valid cases where only test #1 above will succeed. In particular, your organization may have selected the "Install on separate Import and Export machines" deployment option (see the Installation Requirements section of the Migrator for Notes to SharePoint Installation Guide) and would not have installed Migrator for Notes to SharePoint Import Services on the target SharePoint server. In this case, tests #2 and #3 will fail, as shown below. You will still be able to connect to the SharePoint server while designing your migration jobs and you will be able to export extracted data to intermediate files.
Enable multiple SharePoint environments	In order to maintain multiple SharePoint environments in Migrator for Notes to SharePoint, select this check box. If this is checked, then the options on the tab are replaced with an Environment list that allows you to define more than one environment, each one having its own above set of options. To add an environment click Add. An environment is a set of options particular to a SharePoint site, or set of sites. It is the following subset of options: • Connection type • Authentication method and credentials • List of top level site connections • Options for client-side user mapping and link tracking If you have multiple SharePoint servers that need different options, using this feature allows you to save these options and use them as needed. At migration/provisioning time, the appropriate environment should be selected (and logged) automatically for that target site.
Blocked Files	Click the Blocked Files button to configure the maximum allowed file size property and define the list of disallowed file extensions. These settings will be used at Analysis time to report on which databases have blocked files and oversized attachments. They will also be used at migration time to improve performance and memory utilization by not extracting such files from the Notes databases and not sending them to SharePoint. From the Configure Blocked Files dialog box, you can add your own blocked file extension list or use the list from SharePoint by clicking the Set to SharePoint defaults link.

SQL Server tab

SQL Server tab

Migration of data directly to a SQL Server database can be turned on and configured from this tab.

Table 8. SQL Server tab

Item	Description
Preferred Servers List	This button opens the Preferred SQL Server Instances dialog box where you add the SQL Server instances that you want available in the migration target server list. The migration target server list will display the instances in the same order as they appear in this dialog box. Make sure that the server you will be migrating to the most often appears at the top. The number on the button shows how many servers are defined. To add a server click Add and enter the server name. To edit, select an entry and click Edit. To delete, select and entry and click Delete. Click OK to save changes. To add several servers at once, copy them to your clipboard using a coma, semi colon, or a new line to separate each server name. Click the Paste button to copy them to the list.
Enable migration directly to SQL Server tables	Select this check box to enable migration directly to your SQL Servers. When you select this check box from Designer, SQL Server becomes available in the Type dropdown.
SQL Server Authentication Options	Enter the credentials for your primary SQL Server database. At the time of migration, this information can be changed depending on which SQL Server database you have selected as the migration target.
Link Tracking Options	To use link tracking for your migrated SQL Server data, check the Enable Link Tracking for SQL Server records check box. Enter the Link Redirector Url you want to use with the content being migrated to SQL Server. The Database Settings link will take you to the Link Tracking tab where you can edit the Link Tracking database information.
User/Group Mapping Options	To perform mappings using the client rather than the server, select this check box. The Mapping Options link will take you to the User Mapping tab where you can edit the user mapping information.

Folder tab

Folder tab

This tab allows you to enter a root folder to which to migrate data.

Table 9. Folder tab

Item	Description
Link Tracking Options	To use link tracking for your migrated data, check the Enable Link Tracking for files check box. Enter the root folder you want to use with the migrated content. The Database Settings link will take you to the Link Tracking tab where you can edit the Link Tracking database information.

User Mapping tab

User Mapping tab

The information on this tab is used only when user mapping is performed on the client. If the mapping is to be performed remotely by the Import Service, the user mapping settings defined on the Migrator for Notes to SharePoint configuration page of the SharePoint Server will be used.

SharePoint tracks "users" as numeric indexes into the SharePoint Site Collection Users list. When using the "Preserve Created/Modified Identities" option in your Job Definition, or when migrating a Notes name field to a SharePoint User field, Migrator for Notes to SharePoint maps Notes names to Site Collection User identities based on the configured rules.

 

Table 10. User Mapping tab

Item	Description
Input Translation	Allows you to specify a translation option if your input data (from Notes) is in one format and your XML mapping file or ADSI query is using a different format.
Mapping Notes Names to Site Collection Users	• Treat input as Login Name - The input data provided must equate to a valid Windows login name. Simple name translations are provided (for example, reformat the Notes name “Joe Cool/NMSP” to “NMSP\Joe Cool". • Use Domino Directory Lookup - This option performs a directory search on the designated Domino server and includes all address book databases that are configured to be part of the server’s directory. Server Name: The Domino server to search. Leave blank to search the local address book. View Name: The view to search in each configured directory database, which should be indexed such that it is sorted by the Notes user name. (The $Users view in standard address book databases do this by default, but you may also specify a customized view to use.) Item Name: The item that stores the Domain name (typically an Active Directory name) that is used for logging into SharePoint. • Use Notes Database Lookup - This option performs a lookup in the selected Notes database. Server Name: The Domino server to search. Leave blank to search a local database book. Database Name: The database to search. View Name: The view to search in the database, which should be indexed such that it is sorted by the Notes user name. Item Name: The item that stores the Domain name (typically an Active Directory name) used for logging into SharePoint. • Use ADSI/LDAP Lookup - Use the input data (most likely the Notes Name) as the basis for an Active Directory (or other LDAP) lookup to find the correct Windows login name. ADSI path: Specify the path to the Active Directory (or other LDAP) server that contains the user mappings. You can actually use any ADSI path here including "GC://" for the global catalog and "WinNT://" for the local metabase. Query String: Specify a valid query string for finding the user based on the Notes Name. For example, if your policy is to store the Notes Name in the Description field of Person records in Active Directory, you might specify "(&(ObjectClass=Person)(description={0}))" as the Query String. The {0} part is replaced with a formatted version of the Notes Name and the entire Query issent to the directory server. For example, if the Person has a field called "distinguishedName" and was formatted as Windows names (like "PROD\Joe Smith"), then you would use a query like: (&(ObjectClass=Person)(distinguishedName={0})) Field to use: Indicates the field to use in the directory lookup. By default, the ‘distinguishedName’ property is used. This should work in most cases, especially when the directory you are querying is the same one SharePoint uses. In rare cases, this name will not work. If there is a different directory property (other than ‘distinguishedName’) that contains a more useful version of the name that would work in SharePoint, use this field to indicate the different property. ADSI login name and ADSI password: Specify authentication credentials.
	• Use Text File Lookup - Use the input data (most likely the Notes Name) as the basis for a lookup in an XML or comma-delimited text file to find the correct Windows login name. In practice, most organizations that have both Notes and Active directory will have the mapping of names stored somewhere and it is usually a simple matter to write a script to generate a simple mapping file. You can use the Extract database users tool to automatically generate this lookup file for your users in one or more Notes databases. Format: The mapping file can be formatted as an XML file or a Comma Delimited file. An example of each format is shown below: <?xml version="1.0" encoding="utf-8"?> <identityMappings> <userMappings> <user notes="Joe Cool/NMSP" sharePoint="NMSP\jcool"/> <user notes="Mike Mulligan/NMSPTest" sharePoint="BUNTING\mike"/> </userMappings> <groupMappings> <group notes="QuickPlaceAdministratorsSUGroup" sharePoint="BUILTIN\Administrators"/> <group notes="Authorized Users" sharePoint="NMSP\Team 101"/> </groupMappings> </identityMappings> Joe Cool/NMSP, NMSP\jcool Max Smart/NMSP, BUNTING\mike Path: The location of the mapping file. NOTE: If you have non-ascii characters in your user data, you need to specify the encoding in your XML declaration and save the user mapping file with that encoding, for example UTF-8.
Output Translation	Allows you to define a string to format the output of the user mapping. In the string, "{0}" represents the output of the user mapping. If you want to add "prod\" to each of the mapped names, enter prod\{0} as the format string. For example, you have a test domain and a production domain in which all of the user logins are the same (except for the domain name). You want to create one XML mapping file that contains just the user logins, and add in the appropriate domain name (depending on which domain they were currently migrating to) using their user mapping options. To test each of the mapping modes, click the Test User Mapping link. Type in a test Notes name and click Lookup. The resulting mapped user name appears in the After Name Translation and After Name Lookup fields. Click Validate in SharePoint to resolve the name that your configured mapping process produces. This capability is only available when using client-side user mapping and not when configuring server-side mapping in the Import Service. NOTE: If connecting to remote SharePoint servers, the User Mapping functions are controlled at the server and the options are disabled at the client. NOTE: A good way to understand the steps that Migrator for Notes to SharePoint goes through when mapping user names is to turn on Verbose logging and see what happens.