Docave 6 Service Pack 2 Cu2 Tools User Guide

Transcript

® DocAve 6 Supplementary Tools User Guide Service Pack 2, Cumulative Update 2 Revision E Issued June 2013 DocAve 6: Archiver 1 Table of Contents Before You Begin........................................................................................................................................... 5 Configuration ............................................................................................................................................ 5 Submitting Documentation Feedback to AvePoint ...................................................................................... 5 AgentToolSP2010ConnectorCreateList & AgentToolSP2013ConnectorCreateList ...................................... 6 Generating an Encrypted Password .......................................................................................................... 6 Configuring AgentToolCreateList.csv ........................................................................................................ 7 Configuring AgentToolCreateWeb.csv .................................................................................................... 11 Configuring AgentToolCreateSite.csv ..................................................................................................... 14 Working with Configuration Files ........................................................................................................... 17 AgentToolConnectorList.config........................................................................................................... 17 AgentToolConnectorWeb.config ........................................................................................................ 18 Configuring Inheritance ...................................................................................................................... 19 Template Parameter Values ................................................................................................................... 20 Running the AgentToolSP2010ConnectorCreateList or the AgentToolSP2013ConnectorCreateList ..... 21 Manager Tool Dell DX Client ....................................................................................................................... 23 Environment Requirements .................................................................................................................... 23 Using the Manager Tool Dell DX Client ................................................................................................... 23 Manager Tool HCP Client ............................................................................................................................ 25 Environment Requirements .................................................................................................................... 25 Using the Manager Tool HCP Client ........................................................................................................ 25 AgentToolSP2010MoveStub ....................................................................................................................... 27 Running the AgentToolSP2010MoveStub Tool....................................................................................... 27 AgentToolSP2010eDiscoveryMapping ........................................................................................................ 30 Running the AgentToolSP2010eDiscoveryMapping tool ........................................................................ 30 AgentToolSP2010Connector Tool & AgentToolSP2013Connector Tool ..................................................... 31 Running the AgentToolSP2010Connector Tool or the AgentToolSP2013Connector Tool ..................... 32 New Command for the AgentToolSP2013Connector tool .................................................................. 33 Checking the Job Status .......................................................................................................................... 34 AgentToolSP2010OrphanStubClean ........................................................................................................... 35 2 DocAve 6: Supplementary Tools Searching for the Orphan Stubs .............................................................................................................. 35 Cleaning up the Orphan Stubs ................................................................................................................ 37 SP2010ReplicatorAnalyzer .......................................................................................................................... 38 Running the SP2010ReplicatorAnalyzer ................................................................................................. 38 DocAve URL Convert Tool for SharePoint 2010 .......................................................................................... 40 How to Use This Tool .............................................................................................................................. 40 Creating the XML File .............................................................................................................................. 41 DocAve Migrator Tool ................................................................................................................................. 43 Accessing DocAve Migrator Tool ............................................................................................................ 43 File System Migration ............................................................................................................................. 43 Net Share Test ..................................................................................................................................... 43 File Explorer ........................................................................................................................................ 44 File Migration Test .............................................................................................................................. 44 Security Mapping ................................................................................................................................ 46 Exchange Public Folder Migration .......................................................................................................... 47 Lotus Notes Migration ............................................................................................................................ 49 Net Share Test ..................................................................................................................................... 49 Lotus Notes ......................................................................................................................................... 50 Analyzing Databases ........................................................................................................................... 55 Report ................................................................................................................................................. 56 eRoom Migration .................................................................................................................................... 56 Configuring Domain/User/Group Mapping ........................................................................................ 57 Scanning .............................................................................................................................................. 58 Livelink Migration ................................................................................................................................... 59 Configuring Domain/User/Group Mapping ........................................................................................ 60 Configuring Filter Settings ................................................................................................................... 62 Scanning .............................................................................................................................................. 63 DocAve Discover Tool ................................................................................................................................. 64 Accessing DocAve Discover Tool ............................................................................................................. 64 User Interface Overview ......................................................................................................................... 64 DocAve Discover Tool Functions ............................................................................................................. 65 Section B ............................................................................................................................................. 66 DocAve 6: Supplementary Tools 3 Section C.............................................................................................................................................. 66 Starting a Job........................................................................................................................................... 73 Reports .................................................................................................................................................... 76 Global Information .............................................................................................................................. 77 Site Basic Information ......................................................................................................................... 77 Custom Information ............................................................................................................................ 79 Compare Information ......................................................................................................................... 80 Summary Information ......................................................................................................................... 80 Index............................................................................................................................................................ 81 Notices and Copyright Information ............................................................................................................ 82 4 DocAve 6: Supplementary Tools Before You Begin Refer to the sections for system and farm requirements that must be in place prior to using any of the DocAve supplementary tools. Configuration In order to use DocAve tools, the DocAve 6 platform and applicable modules must be installed and configured properly on your farm. Some of the tools described in this guide will not function without the DocAve 6 platform and the applicable modules present on the farm. For instructions on installing the DocAve Platform, DocAve Manager, and DocAve Agents, see the DocAve 6 Installation Guide. Submitting Documentation Feedback to AvePoint AvePoint encourages customers to provide feedback regarding our product documentation. You can access the Submit Your Feedback form on our website. DocAve 6: Supplementary Tools 5 AgentToolSP2010ConnectorCreateList & AgentToolSP2013ConnectorCreateList The AgentToolSP2010ConnectorCreateList tool (used for SharePoint 2010 environment) and the AgentToolSP2013ConnectorCreateList tool (used for SharePoint 2013 environment) are used to create Connector lists in bulk. In addition, these tools can be used to create sites or site collections, which are needed in order to create the lists. *Note: If the name of a specified storage folder contains illegal characters that are forbidden by SharePoint, the corresponding list, site, or site collection is not able to be created in SharePoint. The configuration files for this tool support English, German, and Japanese language environments. The corresponding configuration files are stored in three folders under …\AvePoint\DocAve6\Agent\data\SP2010\Connector\ConnectorCreateListTool or …\AvePoint\DocAve6\Agent\data\SP2013\Connector\ConnectorCreateListTool in EN, GE, and JP folders, respectively. Configure the desired configuration files depending on the language of the environment where your Agent is installed. Using the tools involves the following steps: 1. Generating an Encrypted Password. 2. Configuring the .csv file according to your requirements. Only one .csv file is needed to run a command; however, multiple .csv files can be configured to create the site collection, site, etc. • Configuring AgentToolCreateList.csv file to set up a Connector library. • Configuring AgentToolCreateWeb.csv file to set up a site with the specified Net Share path. • Configuring AgentToolCreateSite.csv file to set up a site collection with the specified Net Share path. 3. Working with Configuration Files. 4. Running the AgentToolSP2010ConnectorCreateList tool. Before using this tool, make sure that the BLOB Provider and EBS/RBS settings are properly configured and that the Connector solutions are successfully deployed (only RBS can be enabled in SharePoint 2013.) Generating an Encrypted Password Prior to creating any Connector libraries using the tool, the password used to connect to the file system must be encrypted using the AgentToolConnectorEncryptPassword.exe tool. The encrypted password is entered into the .csv files in order to create the Connector libraries. 6 DocAve 6: Supplementary Tools Refer to the steps below to encrypt your password using the tool. *Note: The account used to run this tool must be the local administrator. 1. By default, this tool is located in the Agent installation path …\AvePoint\DocAve6\Agent\bin. Navigate to this location. 2. Double-click AgentToolConnectorEncryptPassword.exe to run the tool. 3. Enter the password for the file share and confirm the password when prompted. Figure 1: Password confirmation screen. 4. Press Enter. The encrypted password is generated. Figure 2: Generated encrypted password. Configuring AgentToolCreateList.csv Before creating Connector libraries using the AgentToolSP2010ConnectorCreateList.exe tool or the AgentToolSP2013ConnectorCreateList.exe tool, it is necessary to first configure AgentToolCreateList.csv. This file is used to configure Connector libraries (Content Libraries and Media Libraries), and libraries that have been converted to Connector Libraries (Document Libraries, Asset Libraries, Form Libraries, and Picture Libraries). *Note: Asset Libraries cannot be converted to Connector Libraries in SharePoint 2013. Refer to the steps below to configure AgentToolCreateList.csv: 1. By default, AgentToolCreateList.csv is located in the Agent installation path …\AvePoint\ DocAve6\Agent\data\SP2010\Connector\ConnectorCreateListTool for SharePoint 2010 or …\AvePoint\ DocAve6\Agent\data\SP2013\Connector\ConnectorCreateListTool for SharePoint 2013. Navigate to this path and select the corresponding language folder. DocAve 6: Supplementary Tools 7 2. Double-click AgentToolCreateList.csv to open the file. 3. Three example rows are displayed; these are examples used for creating Content Libraries, Media Libraries, Document Libraries, Asset Libraries, Form Libraries, and Picture Libraries. Remove these rows after entering your own information. Figure 3: Example rows in AgentToolCreateList.csv file for English and Japanese Environments. Figure 4: Example rows in AgentToolCreateList.csv file for German Environment. 4. Refer to the following table for information that needs to be configured in this file. Option Description Value Web Url The URL of the site where you want to create the library. http://ServerIP:Port/ Managed Path/XX/XX *Note: The site specified here must be an existing one. If the site does not exist, create it using SharePoint or using this tool. See Configuring AgentToolCreateWeb.csv for more information. FileSystem Path The physical storage path that will be connected to the newly-created library. Relative Url The relative URL of the library you want to create. TestLibrary List Type The type of library you want to create. List Title 8 \\IP\c$\FolderName 0/1/2/3/4/5 • 0 represents Content Library. • 1 represents Media Library. • 2 represents Document Library. • 3 represents Asset Library (only for SharePoint 2010). • 4 represents Form Library. • 5 represents Picture Library. The title of the library you want to create. TestLibrary DocAve 6: Supplementary Tools Option Description Value Load Metadata Specify whether to load metadata from file system to Connector libraries during the first synchronization. 0/1 Load Permission Keep Name Consistent Allow Large File • 0 represents False; does not load the metadata. • 1 represents True; load the metadata. Specify whether to load the files’/folders’ permissions from the file system to Connector libraries during the first synchronization. • 0 represents None; does not load permissions. • 1 only loads the root folder’s permissions to replace the permissions of the Connector library. All files and subfolders under the Connector library inherit the new permissions of the parent node. • 2 loads all of the root folders’ subfolders’, and files’ permissions from the file system and breaks the permission inheritance of each level in the Connector library. Specify whether to keep the filenames and folder names in the Connector library and storage path consistent. • 0 represents False; does not keep name consistent between Connector library and storage path. • 1 represents True; keeps name consistent between Connector library and storage path. 0/1/2 0/1 Specify whether to allow data that is larger than 2 0/1 GB to be linked from the storage device and synchronized between the storage device and SharePoint. • 0 represents False; does not allow user to upload files that are larger than 2GB to Connector library. • 1 represents True; allows users to upload DocAve 6: Supplementary Tools 9 Option Description Value files that are larger than 2 GB to Connector library. Synchronization Mode 10 Select the Synchronization mode that will be used. There are three synchronization modes to be selected. • 1 represents sync changes made in SharePoint to the storage path – It is used if files are only being added, modified, or deleted through the SharePoint interface. Only the changes made in SharePoint will be synchronized to the storage path if 1 is configured. • 2 represents sync changes made in SharePoint to the storage path and load new files from the storage path – It is used if files are being added, modified, or deleted through the SharePoint interface, and files are still regularly being added to the storage location. If the value is set as 2, the changes made in SharePoint will be synchronized to the storage path, and the newly added files in the storage path will be synchronized to SharePoint. • 4 represents sync changes made in both SharePoint and the storage path – It is not recommended to use this sync mode. If you specify this sync mode, all the changes including deletions made in both SharePoint and the storage path will be synchronized. 1/2/4 UserName The account used to set up the access to the specified file system path. DomainName\UserNa me password The encrypted password for the specified username. r/6FHm/ jq1iAwlbaGRRTcstAs6 HL DocAve 6: Supplementary Tools Configuring AgentToolCreateWeb.csv AgentToolCreateWeb.csv is used to configure site information when creating sites with the specified Net Share path. *Note: If any Connector libraries are created while a site is being created using this configuration file, the newly-created Connector libraries inherit the following Connector settings configured on the site level: • Load Metadata • Load Permission • Keep Name Consistent • Allow Large File Refer to the steps below to configure AgentToolCreateWeb.csv. 1. By default, AgentToolCreateWeb.csv is located in the Agent installation path …\AvePoint\ DocAve6\Agent\data\SP2010\Connector\ConnectorCreateListTool for SharePoint 2010 or …\AvePoint\ DocAve6\Agent\data\SP2013\Connector\ConnectorCreateListTool for SharePoint 2013. Navigate to this path and select the corresponding language folder. 2. Double-click AgentToolCreateWeb.csv to open the file. 3. By default, there is an example for each option. Remove the example row after entering your own information. Figure 5: Example rows in AgentToolCreateWeb.csv file for English and Japanese Environments. 4. Refer to the following table for information that needs to be configured in this file. Option Description Value SiteCollection Url The URL of the site collection where you want to create the site. http://ServerIP:Port/M anaged Path/XX *Note: The site collection specified here must be an existing one. If it does not exist, first create it using SharePoint or using this tool. Refer to Configuring AgentToolCreateSite.csv for more information. FileSystem Path The physical storage path that will be connected to the newly-created site. \\IP\c$\FolderName Relative Url The relative URL of the site being created. TestSite DocAve 6: Supplementary Tools 11 Option Description Value Web Template The template of the site you want to create. sts *Note: Site template is the name of the site definition. Site template can be STS, MPS, BLOG, SGS, or the name of a custom type of site. Refer to Template Parameter Values for more information. Web Title The title of the site you want to create. TestSite Load Metadata Specify whether to load metadata from file system to Connector libraries during the first synchronization. 0/1 Load Permission Keep Name Consistent 12 • 0 represents False; does not load the metadata. • 1 represents True; load the metadata. Specify whether to load the files’/folders’ permissions from the file system to Connector libraries during the first synchronization. • 0 represents None; does not load permissions. • 1 only loads the root folder’s permissions to replace the permissions of the Connector library. All files and sub-folders under the Connector library inherit the new permissions of the parent node. • 2 loads all of the root folders’ subfolders’, and files’ permissions from the file system and breaks the permission inheritance of each level in the Connector library. Specify whether to keep the filenames and folder names in the Connector library and storage path consistent. • 0 represents False; does not keep name consistent between Connector library and storage path. • 1 represents True; keeps name consistent between Connector library and storage path. 0/1/2 0/1 DocAve 6: Supplementary Tools Option Description Value Allow Large File Specify whether to allow data that is larger than 2 GB to be linked from the storage device and synchronized between the storage device and SharePoint. 0/1 Synchronization Mode • 0 represents False; does not allow user to upload files that are larger than 2GB to Connector library. • 1 represents True; allows users to upload files that are larger than 2 GB to Connector library. Select the Synchronization mode that will be used. There are three synchronization modes to be selected. DocAve 6: Supplementary Tools • 1 represents sync changes made in SharePoint to the storage path – It is used if files are only being added, modified, or deleted through the SharePoint interface. Only the changes made in SharePoint will be synchronized to the storage path if 1 is configured. • 2 represents sync changes made in SharePoint to the storage path and load new files from the storage path – It is used if files are being added, modified, or deleted through the SharePoint interface, and files are still regularly being added to the storage location. If the value is set as 2, the changes made in SharePoint will be synchronized to the storage path, and the newly added files in the storage path will be synchronized to SharePoint. • 4 represents sync changes made in both SharePoint and the storage path – It is not recommended to use this sync mode. If you specify this sync mode, all the changes including deletions made in both SharePoint and the storage path will be synchronized. 1/2/4 13 Option Description Value UserName The account used to set up the access to the specified file system path. The encrypted password for the specified username. DomainName\UserNa me r/6FHm/ jq1iAwlbaGRRTcstAs6H L password Configuring AgentToolCreateSite.csv AgentToolCreateSite.csv is used to configure site collection information when creating site collections with the specified Net Share path. *Note: If any Connector libraries are created while a site is being created using this configuration file, the newly-created Connector libraries inherit the following Connector settings configured on the site level: • Load Metadata • Load Permission • Keep Name Consistent • Allow Large File Refer to the steps below to configure AgentToolCreateSite.csv. 1. By default, AgentToolCreateSite.csv is located in the Agent installation path …\AvePoint\ DocAve6\Agent\data\SP2010\Connector\ConnectorCreateListTool for SharePonit 2010 or …\AvePoint\ DocAve6\Agent\data\SP2013\Connector\ConnectorCreateListTool for SharePonit 2013. Navigate to this path and select the corresponding language folder. 2. Double-click AgentToolCreateSite.csv to open the file. 3. By default, there is an example for each option. Remove the example row after entering your own information. Figure 6: Example rows in AgentToolCreateSite.csv file for English and Japanese Environments. 4. Refer to the following table for the information that needs to be configured in this file. Option Description Value WebApp Url The URL of the web application where you want to create the site collection. http://ServerIP:Port/ *Note: The web application specified here 14 DocAve 6: Supplementary Tools Option Description Value must be an existing one. If it does not exist, you must first create it using SharePoint. FileSystem Path The physical storage path that will be connected to the newly-created site collection. \\IP\c$\FolderName Relative Url The relative URL of the site collection you want to create. Managed Path/TestSiteCollection *Note: The managed path must be added in front of the relative URL of the site collection. Web Template The template of the top-level site of the site collection you want to create. sts *Note: Site template is the name of the site definition. Site template can be STS, MPS, BLOG, SGS, or the name of a custom type of site. Refer to Template Parameter Values for more information. Site Title The title of the site collection. TestSiteCollection Load Metadata Specify whether to load metadata from file system to Connector libraries during the first synchronization. 0/1 Load Permission • 0 represents False; does not load the metadata. • 1 represents True; load the metadata. Specify whether to load the files’/folders’ permissions from the file system to Connector libraries during the first synchronization. DocAve 6: Supplementary Tools • 0 represents None; does not load permissions. • 1 only loads the root folder’s permissions to replace the permissions of the Connector library. All files and sub-folders under the Connector library inherit the new permissions of the parent node. • 2 loads all of the root folders’ subfolders’, and files’ permissions from the file system and breaks the 0/1/2 15 Option Description Value permission inheritance of each level in the Connector library. Keep Name Consistent Allow Large File Synchronization Mode 16 Specify whether to keep the filenames and folder names in the Connector library and storage path consistent. • 0 represents False; does not keep name consistent between Connector library and storage path. • 1 represents True; keeps name consistent between Connector library and storage path. Specify whether to allow data that is larger than 2 GB to be linked from the storage device and synchronized between the storage device and SharePoint. • 0 represents False; does not allow user to upload files that are larger than 2GB to Connector library. • 1 represents True; allows users to upload files that are larger than 2 GB to Connector library. Select the Synchronization mode that will be used. There are three synchronization modes to be selected. • 1 represents sync changes made in SharePoint to the storage path – It is used if files are only being added, modified, or deleted through the SharePoint interface. Only the changes made in SharePoint will be synchronized to the storage path if 1 is configured. • 2 represents sync changes made in SharePoint to the storage path and load new files from the storage path – It is used if files are being added, modified, or deleted through the SharePoint interface, and files are still regularly being added to the storage location. If the value is set as 2, the changes made in SharePoint will be 0/1 0/1 1/2/4 DocAve 6: Supplementary Tools Option Description Value synchronized to the storage path, and the newly added files in the storage path will be synchronized to SharePoint. • 4 represents sync changes made in both SharePoint and the storage path – It is not recommended to use this sync mode. If you specify this sync mode, all the changes including deletions made in both SharePoint and the storage path will be synchronized. SiteAdmin The account used to create and manage the site collection. DomainName\UserNa me UserName The account used to set up the access to the specified file system path. DomainName\UserNa me password The encrypted password for the specified username. r/6FHm/jq1iAwlbaGRR TcstAs6HL Working with Configuration Files When creating site collections or sites using the AgentToolSP2010ConnectorCreateList tool (for SharePoint 2010) or the AgentToolSP2013ConnectorCreateList tool (for SharePoint 2013), the file system path must be provided in the corresponding .csv files. If there are sub-folders under the specified file system path, by default, the sub-folders are created as Content Libraries in SharePoint. However, the sub-folder can also be converted to other types of libraries or sites by editing the two configuration files, AgentToolConnectorList.config and AgentToolConnectorWeb.config. The two configuration files, AgentToolConnectorList.config and AgentToolConnectorWeb.config, are located in …\AvePoint\DocAve6\Agent\data\SP2010\Connector\ConnectorCreateListTool. To edit these files, see the appropriate section below. AgentToolConnectorList.config To create a sub-folder to use as a Connector library (Content Library/Media Library), Document Library, Asset Library, Form Library, or Picture Library, modify the AgentToolConnectorList.config file as described below. 1. By default, AgentToolConnectorList.config is located in the Agent installation path …\AvePoint\ DocAve6\Agent\data\SP2010\Connector\ConnectorCreateListTool. Navigate to this path. DocAve 6: Supplementary Tools 17 2. Right-click AgentToolConnectorList.config and choose to open the file with Notepad. Figure 7: Values to modify in AgentToolConnectorList.config file. 3. In the node, modify the Title Value, Template Value, and Url Value according to your requirements. Property Title Value Template Value Url Value Description Value The name of the library you want to create. test The template of the library you want to create. 0/1/2/3/4/5 • 0 represents Content Library. • 1 represents Media Library. • 2 represents Document Library. • 3 represents Asset Library (only for SharePoint 2010). • 4 represents Form Library. • 5 represents Picture Library. The relative URL of the library you want to create. test 4. When finished, copy the modified AgentToolConnectorList.config file to the target sub-folder. AgentToolConnectorWeb.config To create the sub-folder as a site, modify the AgentToolConnectorWeb.config file as described below: 1. By default, AgentToolConnectorWeb.config is located in the Agent installation path …\AvePoint\ DocAve6\Agent\data\SP2010\Connector\ConnectorCreateListTool or …\AvePoint\ 18 DocAve 6: Supplementary Tools DocAve6\Agent\data\SP2013\Connector\ConnectorCreateListTool. Navigate to the corresponding path according to your SharePoint versions. 2. Right-click AgentToolConnectorWeb.config and choose to open the file with Notepad. Figure 8: Values to modify in AgentToolConnectorWeb.config file. 3. In the node, modify the Title Value, Template Value, and Url Value according to your requirements. Property Title Value Template Value Url Value Description The title of the site you want to create. The template of the site you want to create. *Note: Site template is the name of the site definition. Site template can be STS, MPS, BLOG, SGS, or the name of a custom type of site. Refer to Template Parameter Values for more information. The relative URL of the site you want to create. Value test sts test 4. When finished, copy the modified AgentToolConnectorWeb.config file to the target sub folder. Configuring Inheritance Use the files AgentToolConnectorList.config and AgentToolConnectorWeb.config to configure the URL of the current folder (the folder that will house the configuration file) to inherit the folder name from file system or break the inheritance. DocAve 6: Supplementary Tools 19 • If the node in the configuration file is set to “null” or the name of the current folder, the URL inherits the name of the current folder from the file system. • If the node in the configuration file is set to other values instead of the name of the current folder, the URL breaks the inheritance and creates a relative URL using the URL value you provide. Template Parameter Values Refer to the following table for the parameter value of each top-level site template. Template Name Team Site Blank Site Document Workspace Blog Group Work Site Visio Process Repository Basic Meeting Workspace Blank Meeting Workspace Decision Meeting Workspace Social Meeting Workspace Multipage Meeting Workspace Document Center Records Center Business Intelligence Center Enterprise Search Center My Site Host Basic Search Center FAST Search Center Publishing Portal Enterprise Wiki Parameter Value STS#0 STS#1 STS#2 BLOG#0 SGS#0 visprus#0 MPS#0 MPS#1 MPS#2 MPS#3 MPS#4 BDR#0 OFFILE#1 BICenterSite#0 SRCHCEN#0 SPSMSITEHOST#0 SRCHCENTERLITE#0/SRCHCENTERLITE#1 SRCHCENTERFAST#0 BLANKINTERNETCONT ENTERWIKI#0 Refer to the following table for the parameter value of each site template. Template Name Team Site Blank Site Document Workspace Blog Group Work Site Visio Process Repository Basic Meeting Workspace Blank Meeting Workspace Decision Meeting Workspace Social Meeting Workspace 20 Parameter Value STS#0 STS#1 STS#2 BLOG#0 SGS#0 visprus#0 MPS#0 MPS#1 MPS#2 MPS#3 DocAve 6: Supplementary Tools Template Name Multipage Meeting Workspace Document Center Records Center Basic Search Center Assets Web Database Charitable Contributions Web Database Contacts Web Database Issues Web Database Personalization Site Projects Web Database Parameter Value MPS#4 BDR#0 OFFILE#1 SRCHCENTERLITE#1 ACCSRV#1 ACCSRV#3 ACCSRV#4 ACCSRV#6 SPSMSITE#0 ACCSRV#5 Running the AgentToolSP2010ConnectorCreateList or the AgentToolSP2013ConnectorCreateList After completing the necessary configurations, refer to the steps below to create Connector libraries using the AgentToolSP2010ConnectorCreateList.exe tool or the AgentToolSP2013ConnectorCreateList.exe tool. *Note: The account used to run this tool must be the Farm administrator. 1. Navigate to the tool location; by default, this tool is located in the Agent installation path …\AvePoint\DocAve6\Agent\bin. 2. In the Command Line Window, enter the command including the path of the tool AgentToolSP2010ConnectorCreateList.exe or AgentToolSP2013ConnectorCreateList.exe, the path of the .csv file AgentToolCreateList.csv, the path where you want to store the report file generated by this tool, and the thread number that specifies how many libraries you want to create concurrently. The thread number cannot be more than 5. For example, “X:\…\AvePoint\DocAve6\Agent\bin\AgentToolSP2010ConnectorCreateList.exe” "X:\…\AvePoint\DocAve6\Agent\data\SP2010\Connector\ConnectorCreateList Tool\AgentToolCreateList.csv" “X:\...\report” X Figure 9: Example of running the AgentToolSP2010ConnectorCreateList.exe. DocAve 6: Supplementary Tools 21 *Note: The command for creating the site/site collection that is connected to the specified path is similar to the command for creating the Connector library. However, ensure that you change the .csv file to AgentToolCreateWeb.csv or AgentToolCreateSite.csv accordingly and remove the thread number, as only one site/site collection can be created concurrently. 22 DocAve 6: Supplementary Tools Manager Tool Dell DX Client Use the ManagerToolDELLDXClient tool to display and update the retention time, compression type, and the date of deferred compression of DocAve Archiver data that is saved on a Dell DX Storage server. *Note: Only Finished jobs can be loaded in the farm tree and processed by this tool. The data of Finished with Exception jobs or Failed jobs will not be loaded nor processed. Environment Requirements • .Net Framework 3.5 or above. • The machine on which you run this tool must be within the same subnet as the Dell DX Storage server. Using the Manager Tool Dell DX Client Refer to the steps below to use the tool. 1. Navigate to …\AvePoint\DocAve6\Manager\Shared\Tools\DELLDXClient\ and locate the ManagerToolDELLDXClient.exe file. 2. Right-click ManagerToolDELLDXClient.exe and select Run as administrator to run the tool. 3. Enter the hostname or IP address of the DocAve Control Service in the DocAve Control Service Host field. 4. Enter the DocAve Control Service port into the DocAve Control Service Port field. By default, DocAve uses 14000 as the Control Service port. 5. Enter the username and the password that are used to log into DocAve into the Username and Password fields, respectively. 6. Select a DocAve module from the Component drop-down box. By default, Archiver is selected. 7. Click Load to load the jobs’ information of the specified module. The information for all of the completed jobs is shown on the left side of the screen. Click Reset to clear or reset all of the information in the two areas to their default values. 8. Double-click one job on the tree; the Original Retention Date, Original Compression Type, and the Original Defer Compression date of the specified job is shown in the corresponding area on the right. 9. Select one or several jobs on the tree. You can modify the retention date, compression type, and the date that the compression is deferred to in the right area of the interface. *Note: You can select several jobs to run at the same time, but only the jobs that meet the conditions will be processed by this tool. Refer to the report to view the job status. • Month to Extend – Enter a positive integer in the field and click Update Retention Date to postpone the original retention date for the specified number of months. DocAve 6: Supplementary Tools 23 For example, enter 3 in the Month to Extend textbox. If the Original Retention Date displayed in the tool is Sat, 13 Aug 2011 02:28:32 GMT, after clicking the Update Retention Date button, the original retention date will be postponed for 3 months. The new retention date is Sun, 13 Nov 2011 02:28:32 GMT. *Note: If no retention time was set initially, no action will be performed by the tool. • New Compression Type – Select the new compression type from the drop-down box and click Update Compression Type. The original compression type is replaced with the new one. o No means that the data will not be compressed. o Fast means that the compression time is shorter, but the size of the data will not be reduced too much because the compress rate is low. o Best means the size of the data will be greatly reduced; however, the compression time is longer. *Note: If the new compression type you selected is the same as the old one, no action will be performed by the tool. • Delay Compression Until – Enter a positive integer in the field and click Update Defer Compression. The original date that the compression is deferred to will be postponed for the specified days. For example, enter 3 in the Delay Compression Until text box. o If the compression setting is not enabled or the file is already compressed, no action will be performed by the tool. o If the compression setting is enabled and the file is not compressed, the compression time will be reset to three days later from the current time. 10. The progress of the update job is shown in the progress bar at the bottom of the tool. 11. After all of the update jobs finish, click Exit to exit the tool. You can view the logs and detailed reports of the jobs in the logs.txt and reports.txt files, accordingly. The files reside in the same folder as the ManagerToolDELLDXClient.exe file. 24 DocAve 6: Supplementary Tools Manager Tool HCP Client This tool is used to display and update the properties (Retention time, Hold, Shred, and Index) of DocAve Archiver data that is saved on an HDS Hitachi Content Platform server. Environment Requirements • .Net Framework 3.5 or above. Using the Manager Tool HCP Client Refer to the steps below to use the tool. 1. Navigate to …\AvePoint\DocAve6\Manager\Shared\Tools\HCPClient on the DocAve Control server to locate the ManagerToolHCPClient.exe file. 2. Right-click ManagerToolHCPClient.exe and select Run as administrator to run the tool. 3. Enter the hostname or IP address of the DocAve Control server in DocAve Control Service Host text box. 4. Enter the DocAve Control service port into the DocAve Control Service Port text box. By default, DocAve uses 14000 as the Control service port. 5. Enter the username and the password that are used to login DocAve into the Username and Password text boxes. 6. Select a module in the Component drop-down box. By default, Archiver is selected. 7. Click Load to load the jobs’ information of the specified module. The information of all the completed jobs will be shown in the left area. Click Reset to and all the information displayed in the tool will be cleared or reset to the default value. 8. Double-click one job on the tree; detailed information on the selected job will be shown in the corresponding area on the right. 9. Select one or several jobs on the tree. You can modify the following settings in the right area. • Index – Select whether to enable the index feature on the HDS Hitachi Content Platform server. If this value is set to true, the detailed metadata of archived data can be searched using the index. By default, this feature is enabled. Select true to enable this feature and select false to disable it. • Shred – Select whether to enable the shred feature of the HDS Hitachi Content Platform server. By default, this feature is not enabled. o If you configure this vaue as true and run the update, archived data will be deleted thoroughly when the retention time is reached. The deleted data cannot not be restored. DocAve 6: Supplementary Tools 25 o If you configure this value as true and run the update, the value cannot be configured as false in later jobs. Select true to enable this feature and select false to disable it. • Month/Day/Hour to Extend – Enter a positive integer in the text box and click Update. The original retention date will be postponed for the specified time. If the original retention date (Retention column) displayed in the tool is Thursday, 19 Jan 2012 02:28:32 GMT and you enter 3 in the Month to Extend text box, after clicking the Update button, the original retention date will be postponed for 3 months. The new retention date is Thursday, 19 Apr 2012 02:28:32 GMT. *Note: If no retention time has been set in the past, no action will be performed by the tool. • Hold – Enable the Hold feature to protect the data from being deleted. Once the data is held, it cannot be deleted by end-users, and any retention job will affect the held data. You cannot expand the retention date of the held data. Select true to enable this feature and select false to disable it. 10. Click Update to run the update job. The status of the update job will be shown at the bottom of the tool. After all update jobs finish, click the Report button to view the summary report of the job or click Show Details button to view details of the job in the tool. Click to exit the tool. 26 DocAve 6: Supplementary Tools AgentToolSP2010MoveStub The AgentToolSP2010MoveStub tool can be used for the following three purposes: • MoveSPSite ─ Move one site collection from the original content database where it resides to another content database. Then, move the stub information stored in the original stub database to the stub database configured for the destination content database. • MoveStub ─ Move stub information stored in the original stub database to the stub database of the specified content database where the corresponding site collection resides. Use this command after you have moved a site collection to another content database using the WindowsSharePoint 2010 Management Shell cmdlet Move-SPSite. • ChangeStubDB ─ Change the stub database of the specified SharePoint objects and move all related stub information from the old stub database to the new stub database. Running the AgentToolSP2010MoveStub Tool The AgentToolSP2010MoveStub tool directly accesses databases. As a result, only an account with sufficient permissions should be used to run the tool. Refer to the following for detailed information on the permissions required: • Local System Permissions: Member of the local Administrators group. • SharePoint Permissions: • o User is a member of the Farm Administrators group. Since Administrator works across farms and on all SharePoint settings and configurations, this account is needed in order to provide the best and most complete quality of service. o Full control to all zones of all Web applications via User Policy for Web Applications SQL Permissions: o Database Role of db_owner for all the databases related with SharePoint, including content databases, stub databases, SharePoint configuration database and Central Administration content database. o Database Role of dbcreator to the corresponding SQL Server, this permission is only required when you use the ChangeStubDB command and the entered new stub database does not exist on the specified SQL server. Refer to the steps below to run this tool. 1. Navigate to …\AvePoint\DocAve6\Agent\bin and locate AgentToolSP2010MoveStub.exe. 2. Double-click the tool to run it. A command-line interface (CLI) appears. 3. From within the CLI, enter a command applicable to you requirements: • ─MoveSPSite ─ Enter this command to move one site collection from the original content database where it resides to another content database, and then move the stub DocAve 6: Supplementary Tools 27 information stored in the original stub database to the stub database configured for the destination content database. This is done so that all stubs can be accessed from SharePoint and operated in DocAve and SharePoint normally after the corresponding site collection is moved to the specified content database. Enter the ─MoveSPSite command and press Enter. Then enter the following command according to the prompt message appears on the tool interface: -MoveSPSite [Site Collection URL] [DestinationDatabaseName] [SourceRbsProvider] [DestinationRbsProvider] Such as, -MoveSPSite http://avepoint/sites/docave DestinationStubDB, or -MoveSPSite http://avepoint/sites/docave DestinationStubDB SP2010RBSProvider SP2010RBSProvider • • 28 o Site Collection URL ─ The complete URL of the site collection that you want to move to the specified content database. o DestinationDatabaseName ─ The name of the destination database that you want to move the specified site collection to. o SourceRbsProvider (Optional) ─ If the original content database where the specified site collection has RBS enabled and contains the stubs, enter the RBS Provider used by the original database here for keeping the stubs after moving them to the specified database. If not keeping the stubs after moving to the specified database, there is no need to enter the RBS Provider used by the original database. Only SP2010RBSProvider can be entered here, and the value is case sensitive. o DestinationRbsProvider (Optional) ─ If the destination content database where the specified site collection will be moved to has enabled RBS, enter the RBS Provider used by the destination database here. Only SP2010RBSProvider can be entered here and the value is case sensitive. ─MoveStub ─ Enter this command to move the stub information stored in the original stub database to the stub database of the specified content database where the corresponding site collection resides. This action is done so that all of the old stubs can be accessed from SharePoint and operated in DocAve and SharePoint normally after the corresponding site collection is moved to a new content database. Enter the ─MoveStub command and press Enter. Then, configure the following parameters according to the prompt messages that appear on the tool interface: o Site Collection URL ─ Enter the complete URL of the site collection that has been moved to another content database. o Original Content Database Name ─ Enter the name of the original content database where this site collection resided. ─ChangeStubDB ─ Enter this command to change the stub database of the specified SharePoint objects and move all related stub information from the old stub database to the new stub database.. All of the old stubs can be accessed from SharePoint and operated in DocAve and SharePoint normally after the stub database of the corresponding SharePoint objects is changed. Enter the ─ChangeStubDB command and DocAve 6: Supplementary Tools press Enter. Then, configure the following parameters according to the prompt messages that appear on the tool interface: *Note: You must make sure the Control Service is started before running the tool. o Change stub database mode ─ Enter the mode used to change the stub database. Entering 0 changes the stub database without copying the existing data in the old stub database to the new one; entering 1 changes the stub database and then copies the existing data in the old stub database to the new one. A value of 1 is required if you wish for all of the old stubs to remain accessible and operational after changing the stub database. o WebApplication URLs ─ Enter the complete URL of the Web application where you want to change the content database’s stub database. Multiple Web application URLs can be entered here when separated by spaces. An asterisk (*) represents all of the web applications in the specified farm. If you enter *, the stub database of all of the Web applications’ content databases and the stub database of the selected Web application will be changed to the specified stub database. o Content database names ─ Enter the names of the content databases associated with the Web applications that you specified using the Content database names command. The stub databases of these content databases will be changed. Multiple names can be entered here when separated by spaces. An asterisk (*) represents all of the content databases in the specified Web applications. o Destination SQL Server instance ─ Enter the name/IP address of the SQL Server instance where the new stub database will reside. o SQL Server authentication mode ─ Specify the authentication mode used to access the SQL Server instance. The value 0 represents Windows Authentication mode, and the value 1 represents SQL Authentication mode. If the SQL Authentication mode is used, you will be asked to enter the username and password used to access the SQL instance. *Note: If using the Windows Authentication mode, the user who runs the AgentToolSP2010MoveStub tool must have the Database Creator permission to log on the SQL server. o Stub database name ─ Enter the name of the new stub database. If the specified stub database does not exist, it will be automatically created on the specified SQL Server instance when the move operation takes place. *Note: The database name is not case sensitive. 4. Once all of the necessary parameters have been configured, press Enter to run the command. 5. To exit the tool when finished, follow the instructions on the interface. You can also enter exit and press Enter to exit the tool. To continue using the tool, press any key (other than Enter or Q) to enter another command. DocAve 6: Supplementary Tools 29 AgentToolSP2010eDiscoveryMapping The AgentToolSP2010eDiscoveryMapping tool is used to map the crawl property to the managed property of a specified column, and save the property mapping to the Compliance database in order to enable the customized metadata filter rule in the advanced SharePoint search conditions. *Note: This tool only supports SharePoint 2010. Running the AgentToolSP2010eDiscoveryMapping tool Refer to the steps below to run the AgentToolSP2010eDiscoveryMapping tool. 1. Navigate to …\AvePoint\DocAve6\Agent\bin and locate AgentToolSP2010eDiscoveryMapping.exe. 2. Right-click on the tool and click Run as administrator. The AgentToolSP2010eDiscoveryMapping interface appears. 3. Configure the following settings in the AgentToolSP2010eDiscoveryMapping interface: a. Select a column: Refer to the steps below to locate the column that you want to map. • Web Application ─ Select a web application from the web application drop-down list. All of the site collections under the specified web application will be loaded in the site collection drop-down list for selection. • Site Collection ─ Select a site collection from the site collection drop-down list. All of the sites under the specified site collection will be loaded in the site drop-down list for selection. • Site ─ Select a site from the site drop-down list. All of the site columns under the specified site will be loaded in the column title drop-down list for selection. • Column Title ─ Select a column from the column title drop-down list. b. Choose to map the current version’s crawl property or the history version’s crawl property for the selected column by checking the corresponding checkbox at the right corner of the interface. c. Click Enable to start the mapping. The mapping status is displayed in the Colum Mapping field. • Yes indicates that the corresponding crawl property of the specified column’s current version or history version has been mapped successfully and saved in the Compliance database. • No indicates that the corresponding crawl property of the specified column’s current version or history version has not been mapped, or not saved in the Compliance database. *Note: A full crawl of the web application where the mapped column resides must be performed after running this tool to make the customized metadata filter rule effective. 30 DocAve 6: Supplementary Tools AgentToolSP2010Connector Tool & AgentToolSP2013Connector Tool The AgentToolSP2010Connector tool (for SharePoint 2010) is used to upgrade Connector document versions from DocAve 6.0 (including DocAve 6.0, 6.0.1 and 6.0.2) to DocAve 6 Service Pack 1 or later versions. The AgentToolSP2013Connector tool (for SharePoint 2013) is used to upgrade Connector document versions from DocAve 6.0 (including DocAve 6.0, 6.0.1 and 6.0.2) to DocAve 6 Service Pack 1 or later versions for upgrading EventHandler when upgrading SharePoint 2010 to SharePoint 2013. For documents that reside in Connector libraries, the real files of the document versions are stored in a hidden folder named .fsdl in the connected storage path. The AgentToolSP2010Connector tool (for SharePoint 2010) or the AgentToolSP2013Connector tool (for SharePoint 2013) only upgrades the real files of the document versions, but does not upgrade the version links in Connector libraries. If the documents stored in your Connector libraries have history versions, you must run this tool to upgrade document versions because the following changes are made to the stub database of DocAve 6 Service Pack 1 and later versions. Before DocAve 6 Service Pack 1 (and later versions), one document version in the storage path may have several records in the stub database. However, from DocAve 6 Service Pack 1 on, one document version in the storage path can only have one record in the stub database. This tool makes copies of the document versions in the storage path, and makes sure the relationship between the document version and the stub database record is a one-to-one mapping. After the upgrade from DocAve 6.0 to DocAve 6 Service Pack 1 or later versions, you will then be able to open the old document versions successfully. If the documents stored in your Connector libraries do not have any history versions, there is no need to run this tool. Before using this tool, make sure that the BLOB Provider and the EBS/RBS settings are properly configured and that the Connector solutions are successfully deployed. *Note: The account used to run this tool must have the same permissions as the Agent Account. DocAve 6: Supplementary Tools 31 Running the AgentToolSP2010Connector Tool or the AgentToolSP2013Connector Tool By default, the AgentToolSP2010Connector.exe file or the AgentToolSP2013Connector.exe file is located in the Agent installation path: …\AvePoint\DocAve6\Agent\bin. Follow the steps below to run this tool: 1. Right-click the AgentToolSP2010Connector.exe file (for SharePoint 2010) or the AgentToolSP2013Connector.exe file (for SharePoint 2013), and select Run as Administrator. 2. In the Command Line Interface, enter the command with the location of the AgentToolSP2010Connector.exe file or the AgentToolSP2013Connector.exe file as follows, and press Enter. Figure 10: Location of the AgentToolSP2010Connector tool. 3. Enter one of the following commands according to your SharePoint versions to get the help information of the AgentToolSP2010Connector tool or the AgentToolSP2013Connector tool. AgentToolSP2010Connector.exe –help (this command is used for SharePoint 2010) AgentToolSP2013Connector.exe –help (this command is used for SharePoint 2013) After entering the command above, the commands provided by this tool, the command parameters, and some examples are displayed in the Command Line Interface. Figure 11: Help information of the AgentToolSP2010Connector tool. 4. Use the following command to upgrade the document versions: AgentToolSP2010Connector.exe –o [] or AgentToolSP2013Connector.exe –o [] 32 DocAve 6: Supplementary Tools • Change the in the command to UpgradeVersion and do not enter any other parameter to upgrade the document versions in all Connector libraries in the SharePoint farm from DocAve 6.0 to DocAve 6 Service Pack 1 or later versions. The command is: AgentToolSP2010Connector.exe –o UpgradeVersion or AgentToolSP2013Connector.exe –o UpgradeVersion • You can add a parameter in this command to specify a SharePoint scope. If this is done, only the document versions of the Connector libraries within the specified scope will be upgraded. The supported SharePoint scopes are Web applications, site collections, sites, and libraries. Enter the absolute URL of the supported scope as the parameter value. For example: AgentToolSP2010Connector.exe –o UpgradeVersion –url http://hostname/sites/test AgentToolSP2013Connector.exe –o UpgradeVersion –url http://hostname/sites/test *Note: Quote the parameter value with double quotation marks if there are spaces in the parameter value. New Command for the AgentToolSP2013Connector tool After you have upgraded your Connector from SharePoint 2010 to SharePoint 2013 environment with connected libraries, the command NativeUpgradeConnector for the AgentToolSP2013Connector tool must be run to make these connected libraries available before you use these connected libraries in SharePoint 2013. (The basic function of this new command for AgentToolSP2013Connector Tool is to update the Connector EventHandler to the Version of SharePoint 2013, and to update the List Image URL of Connector libraries.) Prerequisites for the New Command for the AgentToolSP2013Connector Tool The prerequisites for using this new command are as follows: • DocAve 6 SP 2 was used in your SharePoint 2010 environment. • After mounting the database with Connector to the farm of SharePoint 2013 from SharePoint 2010 environment, you have upgraded the site style to the SharePoint 2013 site style. • The Connector solutions for SharePoint 2013(SP2013ConnectorContentLibrary.wsp and SP2013ConnectorMediaLibrary.wsp) must have been deployed to your SharePoint 2013 farm. • The DocAve agents both in SharePoint 2010 and SharePoint 2013 point to the same DocAve Manager. Steps for Using the New Command for the AgentToolSP2013Connector Tool Find the AgentToolSP2013Connector.exe file in the Agent installation path: …\AvePoint\DocAve6\Agent\bin. Follow the steps below to run this tool: 1. Navigate to Start > Run, and input cmd to open the cmd.exe interface. DocAve 6: Supplementary Tools 33 2. Enter cd /d “…\AvePoint\DocAve6\Agent\bin”. Press Enter. 3. Enter the following command: AgentToolSP2013Connector.exe -o NativeUpgradeConnector url http://server/site. Examples: AgentToolSP2013Connector.exe -o NativeUpgradeConnector AgentToolSP2013Connector.exe -o NativeUpgradeConnector -url http://server/site The table below contains the detailed information of the parameters: Parameter -NativeUpgradeConnector Type Required -url Optional Description This command is used to upgrade the connected libraries which have been upgraded from SharePoint 2010. Import the specified URL of the site that you want to upgrade. After running the upgrade job using this tool, you can check the job status in the Reports that are generated in the Agent installation path, which is …\AvePoint\DocAve6\Agent\Logs\Connector by default. If there are some versions that the tool failed to upgrade, you can check the detailed reasons in the Report or in the Log file. You can re-run the job according to the prompt information in the Log file. Checking the Job Status After running the upgrade job using this tool, you can check the job status in the Summary Report and Detail Report that are generated in the Agent installation path, which is …\AvePoint\DocAve6\Agent\Logs\Connector by default. If there are some versions that the tool failed to upgrade, you can check the detailed reasons in the Detail Report. Figure 12: Job reports. 34 DocAve 6: Supplementary Tools AgentToolSP2010OrphanStubClean The AgentToolSP2010OrphanStubClean tool is used to search for and clean up orphan stubs that exist in the SharePoint2010 environment. Orphan stubs are stubs whose real content have been deleted or stubs that are not able to connect to their real content. You can perform the following two functions using this tool: • Search for orphan stubs in your SharePoint 2010 environment and generate an Orphan Stub report for your environment. • Clean up orphan stubs according to the orphan stub report generated in the function above. *Note: The account used to run this tool must have the same permissions as the Agent Account. Searching for the Orphan Stubs Follow the steps below to search for orphan stubs in your SharePoint environment: 1. By default, the AgentToolSP2010OrphanStubClean.exe file is located in the Agent installation path: …\AvePoint\DocAve6\Agent\bin. Navigate to this location. 2. Double-click the AgentToolSP2010OrphanStubClean.exe file to run this tool. 3. Input the following commands to search for the orphan stubs in your SharePoint environment and generate the orphan stub report: • Use the RBSOrphanCleanUp command if you enabled RBS for your environment in order to use DocAve Storage Optimization modules. RBSOrphanCleanUp -WebApp http://hostname/ -ContentDB WSS_Content SiteCollection http://hostname/sites/test -Action Report -File C:\OrphanStubReport.csv -AfterTime 2012-1-1 • Use the EBSOrphanCleanUp command if you enabled EBS for the farm in order to use DocAve Storage Optimization modules. EBSOrphanCleanUp -WebApp http://hostname/ -ContentDB WSS Content SiteCollection http://hostname/sites/test -Action Report -File C:\OrphanStubReport.csv -AfterTime 2012-1-1 This table below contains detailed information on each of the parameters: Parameter Type Description -WebApp Required The URL of the Web application where you want to search for or delete the orphan stubs. DocAve 6: Supplementary Tools 35 Parameter Type Description -ContentDB Optional The name of the content database where the orphan stubs reside. This is an optional parameter. If you use this parameter, only the specified content database is searched. If you do not use this parameter, the entire Web application is searched. -SiteCollection Optional The URL of the site collection where you want to search for or delete the orphan stubs. This is an optional parameter. If you use this parameter, only the specified site collection is searched. If you do not use this parameter, the entire Web application is searched. -Action Required This action generates an orphan stub report that displays the orphan stubs discovered by this command. The value of this parameter is Report. -File Required The full path where you want to save the orphan stub report. The path must be detailed to the name of the report file. For example, C:\OrphanStubReport.csv. The report file is generated automatically if it does not exist. If there is already a file with the same name existing in the specified location, the newly-generated report file will overwrite the existing one. *Note: This command only supports generation of report files in .csv format. -AfterTime Required Only the orphan stubs generated after the specified date searched for. The date must be in the format of YYYY-MM-DD. Y stands for year, M stands for month, and D stands for day. 4. Press Enter to run the tool. 5. After the search job completes, you can check the orphan stub report under the location specified in the command. 36 DocAve 6: Supplementary Tools Cleaning up the Orphan Stubs To clean up the orphan stubs discovered in the Searching for the Orphan Stubs section, complete the following steps: 1. Enter the following Command to clean up the EBS or RBS orphan stubs: • For cleaning up the EBS orphan stubs, enter the command like EBSOrphanCleanUp Action Clean -File C:\OrphanStubReport.csv. • For cleaning up the RBS orphan stubs, enter the command like RBSOrphanCleanUp Action Clean -File C:\OrphanStubReport.csv. 2. This table contains the detailed information for each of the parameters: Parameter Type Description -Action Required This action is used to clean up the orphan stubs. The value of this parameter is Clean. -File Required The full path where the orphan stub report resides. The path must be detailed to the name of the report file. For example, C:\OrphanStubReport.csv. 3. Press Enter to run the tool. After the job completes, the orphan stubs recorded in the specified orphan stub report are deleted from your SharePoint environment. DocAve 6: Supplementary Tools 37 SP2010ReplicatorAnalyzer The SP2010ReplicatorAnalyzer tool deletes failed jobs’ Profile Settings configuration from the DocAve6_ReplicatorDatabase. After deleting the Profile Settings configuration, incremental replication can be performed successfully. Regardless of whether a Replicator job is finished or failed, Profile Setting mappings are generated in the DocAve6_ReplicatorDatabase during the job process. When performing an incremental replication after a failed replication job, the Profile Settings configuration of this incremental replication is compared with the Profile Settings configuration of the former failed replication. Since all settings, content types, columns, and other configurations are the same this incremental replication is skipped and the contents are not replicated. However, the corresponding contents do not exist in the destination since the former job failed. This tool is used to delete the useless Profile Settings configuration from failed jobs, thus ensuring that the incremental replication completes successfully. Running the SP2010ReplicatorAnalyzer By default, the SP2010ReplicatorAnalyzer.exe file is located in the Agent installation path: …\AvePoint\DocAve6\Agent\bin. Follow the steps below to run this tool: 1. Use a DocAve Agent Account to run this tool. Right-click SP2010ReplicatorAnalyzer.exe file, and select Run as Administrator. 2. In the Command Line Interface, enter the command to browse to the SP2010ReplicatorAnalyzer.exe file, and press Enter. Figure 13: Location of the SP2010ReplicatorAnalyzer Tool 3. Input the following command to delete the configuration according to the specified condition. The format of the command is SP2010ReplicatorAnalyzer –type CMD –data DeleteDirtyDesign –mappingid [MappingID] –itemid [ItemID] –designType [DesignType] 38 • SP2010ReplicatorAnalyzer – Execute the SP2010ReplicatorAnalyzer tool. • -type CMD – Run the tool by CMD command. • -data DeleteDirtyDesign – Enable the function of deleting configuration. DocAve 6: Supplementary Tools • -mappingid[MappingID] – Get configuration according to specified Mapping ID. [MappingID] is required to be entered. The following steps describe how to find the Mapping ID of your desired job. a. In DocAve Manager, click Job Monitor to enter the interface. b. In the Job Monitor interface, select your desired job, and then click View Mappings on the ribbon. The View Mappings tab appears. c. In the Job ID column, the character strings after _ is the Mapping ID. For example, the Job ID is RP20120830041514729574_2db64471-d275-4746-88c489d17bec612a. The Mapping ID is 2db64471-d275-4746-88c4-89d17bec612a. • -itemid[ItemID] (Optional) – Filter configuration according to specified Item ID. Item ID is the ID of a SharePoint object and it can be found in SharePoint Content Database. • -designType[DesignType] (Optional)– Further filter configuration according to specified Design Type. Design Type is the type of configuration. It is strongly recommended contacting with our technical staff to help you gain Design Type if you need to delete configuration of a specified Design Type in a Mapping. Figure 14: Example of running the SP2010ReplicatorAnalyzer.exe *Note: If you only set Mapping ID as the condition, enter the command like this SP2010ReplicatorAnalyzer –type CMD –data DeleteDirtyDesign –mappingid 2db64471-d2754746-88c4-89d17bec612a 4. Press Enter to run the tool and delete the failed job’s configuration. DocAve 6: Supplementary Tools 39 DocAve URL Convert Tool for SharePoint 2010 This tool allows you to convert any URLs to the specified ones in the selected scope (Web Application, Site Collection, Site, or List). How to Use This Tool Refer to the steps below to use this tool: 1. Navigate to …\Program Files\AvePoint\DocAve6\Agent\bin in the machine where the DocAve Agent is installed. 2. Run the AgentToolSP2010ConvertURL.exe found in the bin folder. The DocAve URL Convert Tool For 2010 interface appears. 3. Select the Scope of the URLs you want to convert from the Scope drop-down list. Four scopes are available: WebApplication, Site (site collection level), SubSite (site level), and List. 4. Enter the URL of the specified scope where you want to change the links in the Look in(URL) field. 5. Two URL converting modes are available: Single Mapping and Bulk Mapping. Single Mapping enables to you to convert the selected URL to another one in the specified scope; Bulk Mapping enables you to convert the selected URLs to the corresponding ones in bulk in the specified scope. a. Single Mapping ─ Click the Single Mapping radio button to enable the Single Mapping. • Enter the URL that you want to convert in the Find(URL) field. • Enter the URL that the specified URL will be converted to in the Replace with(URL) field. b. Bulk Mapping ─ Click the Bulk Mapping radio button to enable the Bulk Mapping. • Click Load Mapping to upload the previously created xml file that contains the URL mappings. For more information about creating an xml file, refer to the Creating the XML File section. 6. After configuring the URL replacing settings, you can Click Option<< to configure the advanced settings if necessary. The specified URLs will be converted using the default advanced settings if you do not change it. Refer to the instructions below to configure the advanced settings. a. Conversion Option ─ Two options are available: Case Sensitive and Replace Relative URL. 40 • Case Sensitive ─ The URLs you entered are case sensitive with this option selected. • Replace Relative URL ─ Only the relative URL of the specified URL will be replaced with this option selected. For example, set the value of Find(URL) as DocAve 6: Supplementary Tools http://AvePoint2/sites/siteB and the value of Replace with(URL) as http://AvePoint/sites/siteA. With this option selected, the URL http://AvePoint2/sites/siteB will be changed to http://AvePoint2/sites/siteA after converting. If this option is not selected, the URL will be changed to http://AvePoint/sites/siteA after converting. b. Replace URL in ─ You can also convert the specified URLs to the corresponding ones in the following scopes by selecting the corresponding checkbox. By default, the URLs will not be changed in these scopes if the corresponding checkboxes are not selected. • Item ─ Replace the URL if it exists in the item’s properties. *Note: This option works only when the Single Mapping mode is selected. • Web Part ─ Replace the URL if it exists in the content editor web part, the image web part, the summary link web part, and the customized web part page. • Article Page ─ Replace the URL for the properties (Page Content and Page Image and Summary Link Field Control) of Article Page/Welcome Page in the Pages list. • Document ─ Replace the URL that exists in the Word or Excel in the document library including the uploaded Word or Excel. *Note: This option works only on the machine that has Office 2007 installed. c. Report Location ─ Click Change to select a location to store the job reports. By default, the location is the desktop. 7. You can click Test Run to simulate the URL converting as you configured, or click Replace to start converting the URLs as you have defined above. After clicking Test Run or Replace, a Detail Report will be generated in the specified report location, and an Error Report will be generated only when errors occurred during the URL converting. You can view the URL replacing details in the corresponding job report. 8. Click Exit to exit this tool. Creating the XML File Create an xml file as the screenshot below for Bulk Mapping mode. Change the values of the Mapping find attribute and the replaceWith attribute to the URLs you want to convert and to be converted to respectively. Figure 15: The xml file for the DocAve URL Convert Tool. DocAve 6: Supplementary Tools 41 Refer to the steps below to create an xml file: 1. Create a txt document. 2. Enter a MappingPairs node in the created txt document. 3. Enter the Mapping find and replace with attributes under this node. • Mapping find ─ Enter the URL that you want to convert. • replaceWith ─ Enter the URL that you want the specified URL to be converted to. Enter more groups of mapping attributes to add more mappings. 4. Save this txt document in the xml format after setting up the URL replacing mappings. *Note: If you set up several replaced policies for one URL, only the deepest URL can be replaced. Take the mapping XML file above as an example. After running the tool, the URL http://avepoint/sites/TestSite/link1/link2 will be changed to http://avepoint/sites/TestSite/link3/link4 other than http://avepoint/sites/TestSite/link5/link2. 42 DocAve 6: Supplementary Tools DocAve Migrator Tool The DocAve Migrator Tool is mainly designed to scan the source data for migration, generate the scan report for your reference, and set up security mapping (except the Exchange Public Folder Migrator Tool) that can be used when performing a DocAve migration job. You can use the Migrator Tool to scan source data from Lotus Notes, eRoom, File System, Exchange Public Folder, and Livelink. For different sources, refer to the different sections for details of how to use the tool. Accessing DocAve Migrator Tool To access the DocAve Migrator Tool and leverage its functionalities, follow the steps below: 1. Go to the installation directory of DocAve Agent, and browse to …\AvePoint\DocAve6\Agent\bin. 2. Double-click MigratorTool.exe to start this tool. The main interface appears. File System Migration On the Migrator Tool main interface, select the File Migration checkbox and then click Next to start. For File System migration, use the Migrator Tool to perform the following operations: • Net Share Test – Tests the connection to the Net Share path. • File Explorer – Explores the file information of permissions and properties. • File Migration Test – Runs a test migration job to scan the source data. • Security Mapping – Configures the domain mapping, group mapping, and user mapping and then generate the XML file. Net Share Test Follow the steps below to test the connection to the Net Share path. 1. Navigate to Migrator Tool > File Migration > Net Share Test. 2. Configure the following settings: a. Username and Network Password – Enter the username and the corresponding password for the connection. b. Path – Enter the Net Share path. 3. Click Open Connection to open the connection with the path you specified. 4. After the test is successful, click Dispose Connection to close the connection. DocAve 6: Supplementary Tools 43 File Explorer Follow the steps below to explore the file information of permissions and properties. 1. Navigate to Migrator Tool > File Migration > File Explorer. 2. The disks on the local machine are listed on the left pane. Click the node to expand the data tree and locate the specific folder. The files contained in the folder are displayed on the right pane, including the information of name, size, data modified, and location. 3. Select the file you want to view. The information of permissions and properties are displayed in the Permissions and Details area. File Migration Test Follow the steps below to run a test migration job for the specified source contents. The File Migration Test function is the same as the Test Run function in DocAve. 1. Navigate to Migrator Tool > File Migration > File Migration Test. 2. Click Job in the menu bar and select New Job to create a new test job. 3. Click Contents in the menu bar to specify the source contents. • Click Browse Folder to select a single folder and the files in it are the source contents. • Click Browse Multiple Folders to select multiple folders and the files in them are the source contents. • Click Net Work Drive to specify the location by entering the information of location, domain, username, and the corresponding password. After specifying the source contents, the folder path or the Net Share path you selected is displayed in the message area. 4. If you want to test whether the file/folder name exceeds the limitation of SharePoint URL length, configure the settings as follows. Otherwise, skip this step and go the next step. • SharePoint URL – Enter the destination URL where the source contents will be migrated. • Configure the maximum length of the SharePoint URL, the file name, and the folder name. 5. If you want to filter the specified source contents to be included in the test job, configure the filter settings as follows. Otherwise, skip this step and go to the next step. • 44 File Filter – Filter the files according to the file name and the extension name by the entered file filter rule in the text box. o is used to include the files which match the file filter rule, and is used to exclude the files which match the file filter rule. Click the icon to change it. o The examples of the file filter rule: file.* represents the files whose file name is file; *.doc represents the files whose extension name is doc; file.doc represents the specific file. DocAve 6: Supplementary Tools • • File Size – Filter the files according to the file size. Select the File Size checkbox to use the file size filter. o Select a condition. The greater than condition represents to include the files whose size is greater than the specified size. The less than condition represents to include the files whose size is less than the specified size. o Specify the file size and the unit. Enter the file size in the test box and then select a unit from KB, MB, and GB. File Time Range – Filter the files according to the last modified time. Select the File Time Range checkbox to use the file time range filter. o • Select a condition. Before means to include the files whose last modified time is before the specified time. From…To… means to include the files whose last modified time is within the specified time range. Later than means to include the files whose last modified time is later than the specified time. Customized Metadata – Filter the files according to the metadata. Select the Customized Metadata checkbox to use the customized metadata filter. a. Enter the property name in the Field text box. b. Select the property type from the Type drop-down list. For different types, there are respective conditions to be used. c. Specify the condition that you want to use. If you select Contains, the file whose property value contains the entered value matches the filter rule, and it will be included; If you select Is(exactly), the file whose property value is exactly the entered value matches the filter rule, and it will be included; If you select Word Starts With, the file whose property value starts with the entered value matches the filter rule, and it will be included; If you select Ends With, the file whose property value ends with the entered value matches the filter rule, and it will be included. d. Enter the value in the Value text box. After configuring the filter settings, click Set to save the settings and the filter settings are displayed in the message area. You can click Reset to clear the settings, or click Cancel to cancel the filter settings. 6. Click Job in the menu bar and select Run Job to run the test job immediately. You can also click Save Job to save the test job and open it by clicking Open Existing Job. 7. After clicking Run Job, the test job starts. The detailed information is displayed in the message area. To save the job report, click Report in the menu bar and select Save Report to save the report to your local disk. DocAve 6: Supplementary Tools 45 Security Mapping Follow the steps below to configure the domain mapping, group mapping, and user mapping. You can generate the XML file for the mapping settings. 1. Navigate to Migrator Tool > File Migration > Security Mapping. The Mapping Config window appears. 2. In order to use domain/group/ user mapping, configure the LDAP (Lightweight Directory Access Protocol) settings. Click LDAP Settings on the top and the LDAP Setting window appears. 3. In the LDAP Config area, select the Source Domain/ Destination Domain option and configure the following settings. • LDAP Path – Enter the IP address or host name where the domain controller is installed. • LDAP UserName and LDAP PassWord – Specify the credentials. 4. Click Submit to submit the LDAP settings. The domain information is displayed in the Destination/Source Domains list. 5. After configuring the LDAP settings for source domain and destination domain, click Save and Close to save the settings and return to the Mapping Config window. 6. The domains you specified are listed in the Source/Destination Domains field. Configure the mappings as follows. a. Domain Mapping – Select a source domain from the Source Domains list and a destination domain from the Destination Domains list, then click to add the domain mapping to the Domain Mapping list. You can click to cancel the selected domain mapping. b. Group Mapping – Select a source domain and then click Source Group Filter tab to filter the groups to be displayed in the Source Groups list. Select a destination domain and then click Destination Group Filter tab to filter the groups to be displayed in the Destination Groups list. • Source/Destination Group Filter – You can filter the groups by the group name. All represents to display all groups; Start With represents to display the groups whose name starts with the entered value; Contains represents to display the groups whose name contains the entered value; By Regex represents to display the groups whose name matches the regular expression. Select a source group from the Source Groups list and a destination group from the Destination Groups list, then click then click to add the group mapping to the Group Mapping list. You can click to cancel the selected group mapping. c. User Mapping – Select a source domain and then click Source Users Filter tab to filter the users to be displayed in the Source Users list. Select a destination domain and then click Destination Users Filter tab to filter the users to be displayed in the Destination Users list. 46 DocAve 6: Supplementary Tools • Source/Destination Users Filter – You can filter the users by the user’s login/first/last/display name. All represents to display all users; Start With represents to display the users whose name starts with the entered value; Contains represents to display the users whose name contains the entered value; By Regex represents to display the users whose name matches the regular expression. Select a source user from the Source Users list and a destination user from the Destination Users list, then click then click to add the user mapping to the User Mapping list. You can click to cancel the selected user mapping. 7. After configuring the mappings, click Save Mapping to XML File and the mapping settings are saved to the SecurityMapping.xml file in the …\AvePoint\DocAve6\Agent\data directory. Exchange Public Folder Migration On the Migrator Tool main interface, select the Public Folder Migration checkbox and then click Next to start. For Exchange public folder migration, you can use the EPF Scan Tool to scan source contents selected for migration and generate the customized report to view the corresponding information. Follow the steps below to configure the Exchange public folder connection, customize the information to be displayed in the report, scan the specific source contents, and view the report. 1. Navigate to Migrator Tool > Public Folder Migration > EPF Scan Tool. The EPF Analyzer window appears. 2. Configure the Exchange Public Folder connection. • Access Method – Select the access method according to the Exchange Server. o Select WebDAV if using Exchange Server 2000/2003/2007. o Select Web Services if using Exchange Server 2007/2010. For Exchange Server 2007, both WebDAV and Web Services are applicable. • Username and Password – Enter the username (domain\username) and the password for accessing Exchange Public Folder. It is recommended to specify an administrator here in order to have the required permission to load all data, perform the operations on the data. • Exchange URL – Enter the URL of the Exchange Public Folder that the agent accesses to. You can click Save as profile and enter a profile name to save the connection configurations. 3. After configuring the connection, click Load to load the source contents. The Public Folders node appears on the data tree. DocAve 6: Supplementary Tools 47 4. Click Options to customize the information to be displayed in the report. For folder level, configure the following conditions: • If you want to display the information of the folder whose contained items are more than the specified number, select the Having more than … items checkbox and set the number. By default, the number is 2000. • If you want to display the information of the folder whose folder structure exceeds the specified levels in full path, select the Having more than … in full path checkbox and set the number. By default, the number is 15. • If you want to display the information of the folder whose full path exceeds the specified characters, select the Having more than … characters in full path and set the number. By default, the number is 200. • If you want to display the information of the folder whose folder path contains the invalid characters, select the Having invalid characters in path. The invalid characters are /, :, ?, <, >, |, &, ~, #, %, {, }, *, ., “, ‘, and \. For item level, configure the following conditions. The information of the item which matches the condition you set will be displayed in the report. • Larger than … KB – The item whose size is larger than the specified size. The default value is 40000. • Having more than … characters in subject – The item whose subject exceeds the specified characters. The default value is 100. • Having attachment(s) larger than … KB – The item whose attachment is larger than the specified size. The default value is 40000. This option is greyed out, and you must select the Load attachment information checkbox first. *Note: Scanning the attachment information, leads to more time cost. • Having more than … attachments – The item whose attachments are more than the specified number. The default value 20. This option is greyed out, and you must select the Load attachment information checkbox first. When scanning the attachment information, the related item must be open which leads to more time cost. • Having invalid characters in name – The item whose name contains the invalid characters. The invalid characters are /, :, ?, <, >, |, &, ~, #, %, {, }, *, ., “, ‘, and \. • Scan hidden items – The items that are hidden. 5. Expand the data tree to select the source contents. 6. Click OK to save the settings and return to the EPF Analyzer window. You can click Default to use the default settings. 7. Click Scan to start scanning. 48 DocAve 6: Supplementary Tools 8. After the scanning completes, the results are displayed in the Scan Result area: • Contains – Display the number of the folders and items contained in the selected data. • Total Size – Display the total size of the selected data in the source. • Folder – In the Folder tab, the folder type information is displayed, including the folder type contained in the selected source data, the number of folders for each folder type, and the total size of each folder type. • Items – In the Items tab, the item type information is displayed, including the item type contained in the selected source data, the number of items for item type, and the total size of each item type. • Exceptions – In the Exceptions tab, display the information of the folders and files that match the conditions you set in the Options settings. 9. Click Save to save the report to the specified location. The report directory is named as the following format: INFO_PFSCAN_TOOL_Serial_Number, for example, INFO_PFSCAN_TOOL_20120730173320. 10. In the report directory, you can find three files, BasicInfoReprot.csv, FoldersInfoReport.csv, and ItemsInfoReport.csv. • BasicInfoReport.csv – In this file, the basic information of the scan is displayed, including the information of the Exchange connection, the folders you scanned, the scan results, the folder details, and so on. • FoldersInfoReport.csv – In this file, the folder that matches the conditions you set in the Options settings will be displayed, including the information of the condition name, the folder name, the number of items contained in the folder, the folder type, the folder size, and the folder full URL. • ItemsInfoReport.csv – In this file, the item that matches the conditions you set in the Options settings will be displayed, including the information of the condition name, the item name, the item type, the item size, and the item full URL. Lotus Notes Migration On the Migrator Tool main interface, select the Lotus Notes Migration checkbox and then click Next to start. For Lotus Notes migration, use the Migrator Tool to perform the following operations: • Net Share Test – Test the Net Share path. • Lotus Notes – Configure the Lotus Notes connection, the content type mapping, the user mapping, and the InfoPath mapping. Besides, analyze the database and generate the report. Net Share Test Follow the steps below to test the Net Share path. 1. Click Net Share Test to start using the Net Share test function. DocAve 6: Supplementary Tools 49 2. Configure the following settings: a. Path – Enter the Net Share path for connection. b. Username and Network Password – Enter the username and the corresponding password for the connection. 3. Click Test Connection to open the connection you specified. 4. After the test is successful, click Dispose Connection to close the connection. Lotus Notes Follow the steps below to configure the Lotus Notes connection, the content type mapping, the user mapping, and the InfoPath mapping. Besides, analyze the database and generate the report. Configuring Connections Follow the steps below to configure the Lotus Notes connection. 1. Navigate to Migrator Tool > Lotus Notes Migration > Lotus Notes, and the DocAve Notes Prescan Tool window appears. 2. Click File in the menu bar and select New Database Connection. The New Database Connection window appears. 3. Configure the settings as follows: • INI File – The .ini file can be found in the path where the valid users of Lotus Notes are saved. By default, the path is C:\Program Files\lotus\notes\notes.ini. You can click the icon to set a new path. After you specify the .ini file, the User ID files will be loaded in the Notes User ID drop-down list. • Notes User ID – Select a User ID file from the drop-down list. You can click the icon to select another User ID file. • Notes Password – Enter the password of the user that you have selected in User ID file. • Domino Server – Click Load to select the Domino server. • Language – Select the language the Lotus Notes uses. • Browse .nsf from local device – Browse the specific .nsf file from your local device. 4. Click Test to verity the connection configurations and then click Connect to connect and load the databases. 5. On the DocAve Notes Pre-scan Tool window, the Lotus Notes databases are displayed and grouped by Category and Template. The following information of each database is displayed: the title, the server where it is, the created time, the last modified time, the number of the documents in it, the total size, the template, the category, and the database file name. 50 DocAve 6: Supplementary Tools Configuring Content Mapping Settings Follow the steps below to configure the content type mapping. 1. Select a database and then click Mapping > Notes-SharePoint Content Type Mapping > New Mapping. The Notes-SharePoint Content Type Mapping window appears. You can also click Edit an Existing Mapping to edit the existing mapping settings. 2. In the left Notes Forms list, all forms are selected by default, which means each form will be mapped to corresponding SharePoint content type. You can click Uncheck All to clear the selection. If you want to map the specified forms to the destination, only select the checkbox before the form name. 3. Double-click a form and the default mapping settings are displayed. View the information below: • • On the top pane, view the following information. o SharePoint Content Type – The name of the SharePoint content type that the form maps to. You can change the name by entering the customized name. o Specified Title – Use the value of a specified field as the title of an item in SharePoint. You can select a field from the drop-down list. o Exclude/Include All – If you want to exclude/include all the column mappings for the selected form, click Exclude/Include All. o Use Default – If you want to use the content type mapping as the default one, select the Use Default checkbox. On the right pane, all fields contained in the selected form and the column mapping for each field are displayed o For each column mapping, the following information is displayed: the field name, the field type, the name of the SharePoint column that the field maps to, the SharePoint column type, and the order of the column. You can double-click the column name to edit it, select another column type from the drop-down list, and adjust the order by selecting the new order from the drop-down list. o For each column mapping, configure whether to use the column mapping by checking/unchecking the Included checkbox; configure whether to hide the column in the destination by checking/unchecking the Hidden checkbox; configure whether to show the column in the default view by checking/unchecking the Show In Default View checkbox. 4. If you want to add a new column mapping, click Add Column to set up a new column mapping. Enter the field title, the filed type, the column name, specify the column type and the order, and configure the Hidden, Included, Show In Default View settings. If you want to delete a column mapping, select the mapping and click Delete Column to delete a column mapping. If you want to display the Response To column in the default view, select the Show “Response To” checkbox. 5. Click Save to save the current mapping settings to the default LotusNotesContentType.Domino web access.xml file (Domino web access is the database name). This file is saved in DocAve 6: Supplementary Tools 51 the …\AvePoint\DocAve6\Agent\data\Migrator\LotusNotesMigratorMappings directory. Note that only when the file is in this directory, it will take effect. 6. After saving the modifications, click Close to return to the DocAve Notes Pre-scan Tool window. 7. If you want to create mappings for multiple databases, refer to the following instructions: a. Select multiple databases and then click Mapping > Notes-SharePoint Content Type Mapping > Create Mapping for Multiple Databases. The pop-up window appears. b. You can change the databases you selected on the data tree. c. Select Overwrite existing mappings to overwrite the existing mapping files in the …\AvePoint\DocAve6\Agent\data\Migrator\LotusNotesMigratorMappings directory or select Not overwrite existing mappings to not overwrite the existing mapping files. d. Specify the directory to save the mapping files. Only the mapping files in the default path, C:\Program Files\AvePoint\DocAve6\Agent\data\Migrator\LotusNotesMigratorMappings, can be used when performing the Lotus Notes migration job. e. Click Generate to generate the mapping files for the selected databases. f. After generating, click Close to return to the DocAve Notes Pre-scan Tool window. Configuring User Mapping Settings There are two kinds of user mappings: one is the mapping for domain users, and the other is the mapping for FBA users. Only when the source database type is Address Book (for example, the default name.nsf database), you are able to configure the user mapping. Domain User Mapping Follow the steps below to configure the domain user mapping. 1. Click Mapping > Notes-SharePoint User Mapping > Configure LDAP. 2. On the LDAP Configuration window, enter the information as follows: • LDAP Path – Enter the IP address or host name where the domain controller is installed. • UserName and PassWord – Specify the credentials. 3. Click Test Connection to verify the connection configurations. And then click OK to save the settings. 4. Select the name.nsf database and then click Mapping > Notes-SharePoint User Mapping > New Mapping. The Notes-SharePoint User Mapping window appears. You can also click Edit an Existing Mapping to edit the existing mapping settings. 5. On the Domain Users list, the domain user information is displayed. The Notes users are displayed in the right pane. 52 DocAve 6: Supplementary Tools 6. You can set up the mapping manually or automatically: • Manually – Select a Notes user and then double-click the domain user to create the mapping. The domain user appears in the SharePoint User column, and display name of the selected SharePoint user is updated in the User DisplayName column. o Click Change Mapping Condition to use the user filter. A pop-up window appears. In the Notes User Filter area, you can filter the users by the user’s first name, the last name, and the e-mail address. Select the Enable checkbox to activate the corresponding filter. All represents to display all users; Start With represents to filter the users whose name starts with the entered value; Range represents to filter the users whose name’s first character is within the specified range; By Regex represents to filter the users whose name matches the regular expression. • o For each mapping you created, you can select whether to use it by checking/unchecking the Include checkbox. If you want to exclude/include all the user mappings, click Exclude/Include All. o Click Add Column to add a new user mapping. Enter the Notes username and then double-click a domain user to create the mapping. o If you want to delete a user mapping, select the mapping and click Delete Column to delete a user mapping. Automatically – Click Change Mapping Condition to set the conditions for matching the domain user and the Notes user automatically. There are three conditions: o Matched by First Name is used to automatically create the user mapping for the domain user and the Notes user who have the same first name; Matched by Last Name is used to automatically create the user mapping for the domain user and the Notes user who have the same last name; Matched by Email Address is used to automatically create the user mapping for the domain user and the Notes user who have the same e-mail address. o Match Mode – If selecting Combine, the user mapping will be automatically created when all selected conditions are matched; if selecting Union, the user mapping will be automatically created for the uses that matches one of the conditions. 7. If you want to set the user mapping as the default user mapping, select the Use Default checkbox on the top. 8. After configuring the user mapping, click Save to save the modifications to the XML file. You can select on the pop-up window to decide whether to save the user mapping settings to an XML file or to multiple XML files (which is convenient for editing). • Yes – Save the user mapping settings to multiple XML files. o Files – The number of XML files that you want to get. o Records – The number of user mapping records in one XML file. DocAve 6: Supplementary Tools 53 • No – Save the user mapping settings to the default LotusNotesUserInfo.default.xml file, which is located in the …\AvePoint\DocAve6\Agent\data\Migrator\LotusNotesMigratorMappings directory. FBA User Mapping Follow the steps below to configure the FBA user mapping. 1. Click Mapping > Notes-SharePoint User Mapping > Configure FBA. 2. On the FBA Configuration window, enter the information as follows: • Membership Provider Name – Enter the name of the membership provider. • Server – The IP address or the host name of the SQL server. • Protocols – Select a protocol from the drop-down list, you can select TCP/IP or Named Pipes. If you select TCP/IP, enter the port number of the SQL server. • Database – The FBA database name. • Username and Password – Specify the credentials to the FBA database. 3. Click Test Connection to verify the connection configurations. And then click OK to save the settings. 4. Select the name.nsf database and then click Mapping > Notes-SharePoint User Mapping > New FBA User Mapping. The Notes-SharePoint FBA User Mapping window appears. 5. On the FBA User list, the FBA user information is displayed. The Notes users are displayed in the right pane. 6. Select a Notes user and then double-click the FBA user to create the mapping. The FBA user appears in the SharePoint User column. For each mapping you created, you can select whether to use it by checking/unchecking the Include checkbox. If you want to exclude/include all the user mappings, click Exclude/Include All. InfoPath Mapping Follow the steps below to configure the InfoPath mapping. 1. Select a database and then click Mapping > Notes-InfoPath Template and Mapping Generation. The Notes-InfoPath Mapping window appears. 2. Double-click a Notes form and the columns contained in it are displayed on the right pane, including the information of the column name and the column type. For each column, configure the column mapping as follows: a. Double-click the InfoPath column name to edit it. b. Specify the InfoPath column type from the drop-down list. c. If you want to use the column mapping, select the AddToInfoPath checkbox. Otherwise, do not select this checkbox. 54 DocAve 6: Supplementary Tools 3. Enter the SharePoint URL in SharePoint URL text box by using the format below: http://win-k8d12dge094:24222/sites/0718/test11212/Forms/template.xsn http://win-k8d12dge094:24222/sites/0718/test11212 is the URL of the destination form library. The site collection where the form library resides is the destination site collection that you want to migrate the source contents to. 4. Click Generate to generate two files: • Generate the InfoPath file in the the …\AvePoint\DocAve6\Agent\data\Migrator\LotusNotesMigratorMappings directory. The file name is the same as the Notes form you selected. • Generate the XML file including the mapping settings. The XML file is located in the …\AvePoint\DocAve6\Agent\data\Migrator\LotusNotesMigratorMappings directory. The name of the XML file is LotusNotesInfoPathMapping.DB2.xml. DB2 is the name of the database you selected. 5. Public the InfoPath file to SharePoint and update the template of the destination form library. Then use DocAve to run the migration job to convert the source documents to InfoPath format. Analyzing Databases By analyzing the database, you can get the following kinds of information: Database Basic, Design Statistics, ACL, Content Statistics, Complexity, and Replica Comparison. Besides, you can select whether to set the filter to include the information of the documents matching the filter rule, and specify the formula to find the desired documents in the specified databases. Setting Up Filters Use the following filters to include the information of the documents matching the filter rule. The information in the Document field in the Content Statistics tab in the result of analyzing database is affected by the filter. The database information after analyzing will not include the information of the documents that are filtered out. Navigate to Analyzer > Filter Configuration to set up the following filters. • Size Filter – Specify the minimum and the maximum size from the drop-down list. You can select Default to restore the default setting. If you do not want to use this filter, select Disable. • Time Filter – Specify the range of the created time and the modified time. If you do not want to use this filter, select Disable. • Form Filter – Enter the form name and click Add. You can select an added form and click Remove to remove it. If you do not want to use this filter, select Disable. DocAve 6: Supplementary Tools 55 Analyzing Database To analyze the databases, complete the following steps: 1. Select the databases and then click Analyzer > Analyze Database(s) to analyze the selected databases. The Analyze Database window appears. You can also right-click the selected databases and click Analyze Database(s) to analyze the selected databases. 2. On the Analyze Database window, choose Database Summary Info to view the summary information of the selected databases. 3. Choose one database from the drop-down list to show the information of the selected database. Then you can view the different kinds of information on the different tabs. Using Formula Follow the steps below to search the desired documents by using the formula. 1. Select the databases where the desired documents is in. 2. Click Analyzer > Search Documents > New Search Formula. The Search Rule window appears. 3. Enter the formula and select the databases that the formula applies to. 4. Click OK to search the documents. The Notes Documents window appears to display the search result. *Note: The filters you set up will affect the result of searching by formula. Report After analyzing the database, you can check the report for the analyzed database. Click Report in the menu bar, and you can view the following reports: Database Summary Report, Database ACLs Report, Database Data Element Report, Database Design Element Report, Database Replicas Comparison Report, and Database Design Element Comparison Report. 1. Select one report and the Reports window appears. 2. Select the database to view the report. 3. Click the icon to save the report. You can export the report to be PDF file or XLS file by clicking the icon next to . eRoom Migration On the Migrator Tool main interface, select the eRoom Migration checkbox and then click Next to start. For eRoom migration, you can use the eRoom Migration Tool to scan the source contents in eRoom. And generate the report to view the information of the scanned contents. Besides, you can configure the domain/user/group mapping and save the mapping settings to XML file. 56 DocAve 6: Supplementary Tools To load the eRoom data, follow the steps: 1. Navigate to Migrator Tool > eRoom Migration > eRoom Migration Tool. The eRoom Migration Tool interface appears. 2. Specify a local eRoom user in the eRoom Local System Account text box and enter the corresponding password. 3. Click Load eRoom Structure to load the eRoom data. 4. Expand the data tree and select the node. The selected node is displayed in the You choose to scan text box in the Content Scan area. If you want to display the eRoom template, select the Show eRoom Templates checkbox. For the selected node, refer to the following sections for details of how to configure the domain/user/group mapping and perform the scan. Configuring Domain/User/Group Mapping If you want to configure the domain/user/group mapping, follow the steps below to configure the LDAP settings first. 1. On the eRoom Migration Tool interface, click LDAP Settings. The LDAP Settings window appears. 2. On the LDAP Setting window, select SharePoint Domain to add the SharePoint domain, uncheck SharePoint Domain to add the trust domain. You must add a SharePoint domain to create the mapping. Enter the information as follows: • LDAP Path – Enter the IP address or host name where the domain controller is installed. • LDAP UserName and Password – Specify the credentials. 3. Click Submit to submit the settings. The added domain is displayed on the left. 4. Click Save and Close to return to eRoom Migration Tool interface. 5. On the data tree, select a node that you want to set up the mapping. 6. Click User Mapping and the Mapping Config window appears. You can click the User Mapping tab to configure the user mapping and the domain mapping, and click Group Mapping to configure the group mapping. 7. To configure the User Mapping settings, follow the steps below. a. On the User Mapping tab, select Show Default Matched User to view the user mapping that is created automatically, which is hidden by default. The created user mapping is for the eRoom user and the SharePoint user that have the same username. You can double-click the user mapping to cancel the mapping. b. For other users, create the mapping manually. Select a user from the eRoom Users list. c. Double-click a SharePoint user from the SharePoint Users list. The mapping between the two selected users are created and displayed on the user mapping list. When selecting users from the SharePoint Users list, you can use the following filters: Domain, Login DocAve 6: Supplementary Tools 57 Name, First Name, Last Name, Mail Address, and Display Name. For each filter, you can use the following conditions: By eRoom User, All, Start With, Range, By Regex. For example, if you use Login Name filter, then, configure the conditions as follows: • By eRoom User represents to display the SharePoint user that has the same login name as the selected eRoom user. • All represents to display all users. • Start With represents to display the users whose login name starts with the entered value. • Range represents to display the users whose login name’s first character is within the specified range. • By Regex represents to display the users whose login name matches the regular expression. After the settings, click Apply to apply the filter, and then the users who match the filter are displayed. 8. To configure the Domain Mapping settings, follow the steps below. a. In the Domain Mapping area, the source domains which are related to the source users are displayed. Click a domain and enter the destination domain name in the pop-up window. b. Click OK to create domain mapping. And then click Apply Domain Mapping. The domain users that have the same name will be mapped automatically. Select or deselect Show Domain Matched Users to select whether to display the user mappings in the User Mapping list. 9. On the Group Mapping tab, the eRoom groups are displayed in the eRoom group list. To create the group mapping, enter the SharePoint group name in the SharePoint Group list. If you want to delete the group mapping, delete the group name. 10. After the mapping settings, select Merge to DocAve Config File to merge the mapping settings to the XML file which is configured in Mapping Options for eRoom migration, or select Save Mappings to XML file to save the mapping settings to an XML file. Scanning Follow the instructions below to scan the selected node. 1. Expand the data tree and select the node that you want to scan. The node you selected is displayed in the You choose to scan text box in the Content Scan field. 2. In the Content Scan Config area, enter the file type in the text box to specify the file types that are blocked in SharePoint. The blocked file type cannot be migrated to SharePoint. 3. Specify the URL length of the destination SharePoint site. You can enter the destination SharePoint site URL in the SharePoint Site URL text box or select the SharePoint Site URL Length option to enter the value of the length. 58 DocAve 6: Supplementary Tools *Note: The length of the SharePoint URL is calculated from the first character of the managed path, that is “/”. 4. Configure the settings of Maximum length of the file name, Maximum length of the folder name, and Maximum length of the SharePoint URL. If the name/URL exceeds the limitation you set, the information will be displayed in the report when you select All Content and Users in the Scan Config area. • Maximum Length of the folder name – The default value is 60, and the scale you can set is from 1 to 128. • Maximum Length of the file name – The default value is 80, and the scale you can set is from 1 to 128. • Maximum Length of the SharePoint URL – The default value is 255, and the scale you can set is from 1 to 260.The length of the SharePoint URL is calculated from the first character of the managed path. 5. In the Scan Config area, you can select four kinds of information to be scanned, Unsupported Content, Check-Out Files, All Content and Users, and User Mappings. Select one or multiple, and you will get the information accordingly. 6. Click Start Scan to start scanning. The contents being scanned are displayed on the Current Item field. 7. After the scan completes, the Scan Result window appears. Select the Community and the Facility to view the scan report on the right pane. 8. Double-click the value in Unsupported Content, Check-Out Files, AD Users, Local Users, All Content to view the corresponding details. You can click Save Detail to XML File to save the details to an XML file. Livelink Migration On the Migrator Tool main interface, select the Livelink Migration checkbox and then click Next to start. For Livelink migration, you can use the Livelink Migration Tool to scan the source data to view the data information. Besides, you can configure the domain/user mapping and save the mapping settings to XML file. To load the Livelink data, follow the steps: 1. Navigate to Migrator Tool > Livelink Migration > Livelink Migration Tool. The Livelink Migration Tool interface appears. 2. Click Livelink Connection Config to configure the Livelink connection. The Livelink Connection window appears. 3. On the Livelink Connection window, the existing connection profiles are listed in the Connection Profile list. Double-click one to view and edit it. To create a new connection, enter the name for the connection file in the Connection Profile Name text box. You can also click Connection Profile Browse to select one from your local disk. DocAve 6: Supplementary Tools 59 4. Select Use HTTP Tunneling to use the Http Tunneling connection mode, or not select to use the default connection mode. • Http Tunneling o Proxy Option – Select to use Proxy server or Web server to access to Livelink.  Web Server – If you select Web Server, specify the hostname or IP address of the Web server in the Web Server text box.  Proxy Server – If you select Proxy Server, specify the hostname or IP address of the Proxy server in the Proxy Server text box. o Port – Specify the port the server is using. By default, the port number is 80. o Livelink CGI URL – Enter the Livelink CGI URL. o Livelink Username – Enter a Livelink username for accessing Livelink. o Livelink Password – Enter the corresponding password. o Livelink Domain – Enter the Livelink domain name. If the specified Livelink user is in the Livelink system domain, leave this option blank. o HTTP Username – Enter the HTTP username and the password to set up access to the Web server.  o • My Workspace – My Workspace will be displayed, if you select My Workspace. If you do not select this option, Enterprise Workspace will be displayed. HTTP Password – Enter the corresponding password. Default o Livelink Server – Enter the hostname of the Livelink server. o Port – Specify the port the server is using. By default, the port number is 2099. o Livelink Username – Enter the Livelink username for accessing Livelink.. o Livelink Password – Enter the corresponding password. o Livelink Domain – Enter the Livelink domain name. If the specified Livelink user is in the Livelink system domain, leave this value blank. 5. Click Save and Apply to save the configurations and return to the Livelink Migration Tool interface. The source data is loaded on the data tree. If you want to add other connections, click Save to save the configurations and continue to add a new connection. The connection profile will be displayed in the Connection Profile list. You can also select a connection profile and delete it by clicking Delete. Configuring Domain/User/Group Mapping If you want to configure the domain/user/group mapping, follow the steps below: 1. On the Livelink Migration Tool interface, click LDAP Settings. The LDAP Settings window appears. 60 DocAve 6: Supplementary Tools 2. On the LDAP Setting window, select SharePoint Domain to add the SharePoint domain, uncheck SharePoint Domain to add the optional trust domain. Enter the information as follows: • LDAP Path – Enter the IP address or host name where the domain controller is installed. • LDAP UserName and Password – Specify the credentials. 3. Click Submit to submit the settings. The added domain is displayed on the left. 4. Click Save and Close to save the settings and return to Livelink Migration Tool interface. 5. On the data tree, select the nodes where you want to set up the mapping. 6. Click User Mapping and the Mapping Config window appears. 7. To configure the User Mapping settings, follow the steps below. a. If you want to view the user mapping that is created automatically, select Show Default Matched User to view the user mapping, which is hidden by default. The created user mapping is for the Livelink user and the SharePoint user that have the same username. You can double-click the user mapping to cancel the mapping. b. For other users, create the mapping manually. Select a user from the Livelink Users list. c. Double-click a SharePoint user from the SharePoint Users list. The mapping between the two selected users are created and displayed on the User Mapping list. When selecting users from the SharePoint Users list, you can use the following filters: Domain, Login Name, First Name, Last Name, Mail Address, and Display Name. For each filter, you can use the following conditions: By Livelink User, All, Start With, Range, and By Regex. For example, if you use Login Name filter, then, select the condition and configure it as follows: • By Livelink User represents to display the SharePoint user that has the same login name as the selected Livelink user. • All represents to display all users. • Start With represents to display the users whose login name starts with the entered value. • Range represents to display the users whose login name’s first character is within the specified range. • By Regex represents to display the users whose login name matches the regular expression. After the settings, click Apply to apply the filter, and then the users who match the filter condition are displayed. 8. To configure the Domain Mapping settings, follow the steps below. a. In the Domain Mapping area, the source domains which are related to the source users are displayed. Click a domain and enter the destination domain name in the pop-up window. b. Click OK to create domain mapping, and then click Apply Domain Mapping. The domain users that have the same name will be mapped automatically. Select or deselect Show DocAve 6: Supplementary Tools 61 Domain Matched Users to select whether to display the user mappings in the User Mapping list. 9. After the mapping settings, select Merge to DocAve Config File to merge the mapping settings to the XML file which is configured in Mapping Options in Livelink Migration, or select Save Mappings to XML file to save the mapping settings to an XML file. Configuring Filter Settings If you want to filter the source contents to be included in the scan, click Filter Settings to configure the filter settings. 1. Enter the name of the filter profile in the Filter Profile Name text box. 2. Configure the following filter settings. The source data that matches the filter rule will be displayed in the scan report. • • File Size – Filter the files according to the file size. Select the File Size checkbox to use the file size filter. o Select a condition. The greater than condition represents to include the files whose size is greater than the specified size. The less than condition represents to include the files whose size is less than the specified size. o Specify the file size and the unit. Enter the file size in the test box and then select a unit from KB, MB, and GB. Time Range – Filter the files according to the last modified time. Select the File Time Range checkbox to use the file time range filter. o • Select a condition. Before means to include the files whose last modified time is before the specified time. From…To… means to include the files whose last modified time is within the specified time range. Later than means to include the files whose last modified time is later than the specified time. Customized Metadata – Filter the files according to the metadata. Select the Customized Metadata checkbox to use the customized metadata filter. a. Enter the property name in the Field text box. b. Select the property type from the Type drop-down list. For different types, there are respective conditions to be used. c. Specify the condition that you want to use. If you select Contains, the file whose property value contains the entered value matches the filter rule and will be included; If you select Is(exactly), the file whose property value is exactly the entered value matches the filter rule and will be included; If you select Word Starts With, the file whose property value starts with the entered value matches the filter rule and will be included; 62 DocAve 6: Supplementary Tools If you select Ends With, the file whose property value ends with the entered value matches the filter rule and will be included. d. Enter the value in the Value text box. 3. After configuring the filter settings, click Save to save the settings and the filter profile are displayed in the Filter Profile list. You can click Delete to delete the selected filter profile. Scanning By performing the scan, you can view the following information: the users in source, the supported and unsupported content for migration, the checked-out files, the mapped and unmapped users, and the content size. Follow the instructions below to scan the selected nodes. 1. Select the nodes on the source data tree. 2. If you want to scan the user mapping information of the selected nodes, select Include User Mapping. 3. If you want to use the filter profile, select Include Filter Profile and select a profile from the drop-down list. • Select whether to show all metadata information in the scan results by checking/unchecking Show All Metadata in Scan Results. 4. Select the log level from Info and Debug. When selecting Debug level, the log is more detailed than the Info level. 5. Click Start Scan to start scanning the source selected nodes. 6. After scanning, the Scan Results window appears to display the scan results. 7. Double-click the value in the scan results to view the details in the Details area. You can click Save Detail to XML File to save the details to an XML file. By default, the scan report is saved in the …\AvePoint\DocAve6\Agent\bin directory and it is named as ScanResult[Serial_Number].xml, for example, ScanResult[20120801084334].xml. DocAve 6: Supplementary Tools 63 DocAve Discover Tool DocAve Discover Tool is used to scan your SharePoint 2007/2010 environment and then generate a report. DocAve Discover Tool can scan different levels from the farm level to the item level and the generated report contains various kinds of information that can help you have better understanding of your SharePoint environment, and optimize your management of your SharePoint contents. You can also compare the generated report to find out the differences between different sites. Accessing DocAve Discover Tool To access the DocAve Discover Tool and leverage its functionalities, follow the steps below: 1. Go to the installation directory of DocAve Agent, and browse to …\AvePoint\DocAve6\Agent\bin. 2. Double-click AgentToolSP2007Discover.exe or AgentToolSP2010Discover.exe according to your SharePoint environment to start this tool. User Interface Overview When you launch DocAve Discover Tool, you will see the following in the panel. 1. Section A ‒ The data tree of the SharePoint farm. 2. Section B ‒ The basic functions of this tool. 3. Section C ‒ The main functions of this tool. You can select the corresponding checkbox to scan the required information, use the filter to filter out the undesired data, use the Compare Information feature to generate a report for comparison, and use the Warning Level feature to help you realize the warning information. 4. Section D ‒ The progress bar of generating the report. 5. Section E ‒ The processing information of the actions performed. 64 DocAve 6: Supplementary Tools Figure 16: The Discover Tool launch window. DocAve Discover Tool Functions • Section A – Displays the data tree of the SharePoint farm • Section B – Used to perform control and manipulation functions for a Discover Tool job, including loading the tree, generating the report, the shortcut of selecting all kinds of options. • Section C – Designed to have what information displayed within a job report by selecting corresponding checkboxes as well as applying filter rules. • Section D – Describes the progress of generating the report • Section E – Shows the processing information of the actions performed. Refer to the following for more detailed information of Section B and Section C. DocAve 6: Supplementary Tools 65 Section B Buttons in Section B perform the basic functions. See the following table for details: Button Load Tree Generate Report Pause Resume Stop Select All Unselect All Migration STSADM Function Load the data structure of the SharePoint farm as a data tree. Generate the report for the selected nodes on the data tree. Hit pause on the generating of a report. Continue generating the report. Stop generating the report. Select all checkboxes in Section C except for the Metadata Settings checkbox. Clear all selected checkboxes in Section C. Run the preupgradecheck command by calling the stsadm.exe automatically. Section C In section C, you can select which kind of information you wish to display in the report for the selected nodes, including three kinds of information: • Global Information • Site Basic Information • Custom Information You can also configure a filter to include the data you want to scan. Refer to Filter Modified Date and Filter Created Date for details. As well, you can enable the Compare Information feature to generate reports for nodes and then compare the reports to find out the differences of the contents within the nodes. Besides, you can use the Warning Level feature to help you realize the existing warning information. The following content introduces the details. Global, Site Basic, and Custom Information Through the selection of the checkboxes, the desired information will be displayed in the report. For each checkbox you selected, after generating a report, a .csv file having the same name will be generated in the report folder. Global Information Refer to the following table for detailed information of the checkboxes in the Global Information field and the related functions. Checkbox Global 66 Function Display the version of the SharePoint Server, the information of the SharePoint Server’s Language Packs, the information of the SQL Server, and the information of the web applications, site collections, sites, and lists in the farm. DocAve 6: Supplementary Tools Checkbox Farm Topology Solution IIS Ghosted File Function Display the server name, the services on server, and the status of the services. Display the information of the deployed solutions in the SharePoint farm. Display the information of the used ports for the web applications. Display the information of the ghosted files, including the file URL and the file’s physical path. Site Basic Information Through the selection of the checkboxes in this field, the site basic information will be displayed in the report. Refer to the following table for detailed information of the checkboxes in the Site Basic Information field and the related functions. All checkboxes in this field are used to display the different types of information within the selected nodes. Checkbox User\Group Count Document Count Site Collection Information Size Information Site Information Structure Detail List Information Lookup Field Checkout Data Workflow Alert Data Function Display the number of the users and groups of the site collection that the selected nodes belong to. Display the number of the documents within the selected nodes. Display the information of the site collections, such as the ID, the template, the theme, etc. Display the size of the documents and items of each site within the selected nodes. Display the information of the sites, such as the ID, the template, the theme, etc. Display the URL and the size of the site collections, the sites, the lists, the folders, and the items. Display the information of the lists, including the list URL, the ID, the base template, and the template feature ID. Display the information of the Lookup columns, such as the name and field information. Display the information of the documents which are checked out, including the file URL, the user who checks out this file and the UI version. Display the information of the workflow, such as the name, the template, etc. Display the information of the alerts, such as the URL, the type, etc. Custom Information Through the selection of the checkboxes in this field, the information of features, configurations, settings and contents customized by customers will be displayed in the report. Refer to the following table for detailed information of the checkboxes and the related functions in the Custom Information field. Checkbox Feature Information Web Part Information Field Information Master Page Function Display the information of the customized features, such as the scope, the ID, etc. Display the information of the customized web parts, such as the URL, the type, etc. Display the information of the customized fields, such as the scope, the ID, etc. Display the URL of the customized master page. DocAve 6: Supplementary Tools 67 Checkbox Site Template List Template Content Type Event Receiver List View Function Display the information of the customized site templates, such as the name, the template ID, etc. Display the information of the customized list templates, such as the name, the template ID, etc. Display the information of the customized content types, such as the name, the content type ID, etc. Display the information of the customized event receivers, such as the type, the ID, etc. Display the information of the customized list views, such as the title, the view URL, etc. Filter Modified Date and Filter Created Date Use these two filters to sort out the data in the specified time range, and generate the report for only the data sorted out. Set the value of the Modified Date to sort out the data modified in the specified time range. Set the value of the Created Date to sort out the data created in the specified time range. Figure 17: Set the value for Modified Date and Created Date Compare Information The Compare Information feature is designed particularly to compare whether the information of site collections, lists, and items is the same or not between different selected nodes. Enable the Compare Information feature to generate reports for nodes and then compare the reports to find out the differences of the contents within the nodes. After you run a replication job, use the Compare Information feature to generate the Compare Information.txt files, whose format is fixed, for both the source node and the destination node. Before generating the file, you can use the Metadata Settings feature for the items of the selected node so that the metadata information of the items can be included in this file. Also, before generating the file, you can use the List Information Settings feature for the lists contained in the selected node so that the information of the lists can be included in this file. 68 DocAve 6: Supplementary Tools After the file generated, compare the information from the two files by using a third-party comparison tool to verify whether the source data has been replicated successfully to the destination. Compare Information The Compare Information feature is used to make sure whether the source data has been replicated successfully to the destination after you ran a replication job. You can check that by using this feature to generate the Compare Information.txt files for both the source node and the destination node, and then compare the information from the two files by using a comparison tool. The source node is the node which you select as the source when performing a replication job. The destination node is the node which you select as the destination when performing a replication job. Configuring the Report Settings Before generating the reports, you can select whether to modify the AgentToolSP2010/2007Discover.exe.config file to configure the settings of the compare information report. 1. Go to the same directory as this tool to find the .config file and open it. 2. Find the node to configure the report settings. Figure 18: Find the node. • reportType – It is used to specify the report format, including TXT, XML, and CSV. By default, its value is TXT. • filterList – It is used to select whether to filter specified lists in the report or exclude them from the report. If the value of the filterList attribute is TRUE, the following lists’ information will be excluded from the report. If its value is FALSE, the following lists’ information will be included in the report. DocAve 6: Supplementary Tools 69 Figure 19: The lists under node. *Note: The content in the FilterList node cannot be modified. • getCustomFields – Choose whether to include the built-in columns in the report or exclude them from the report. o TRUE - Enter TRUE to obtain the custom column value and display them in the report. The value of the built-in columns (listed in the node) will be excluded from the report. o FALSE - Enter FALSE to obtain all columns values including the custom column and the built-in column(listed in the node). *Note: The contents in the BuiltInFields node cannot be modified. 3. Save the modifications to this .config file and close it. Metadata Settings The Metadata Settings feature is used to include the metadata information for the specified columns when generating the comparison information. By default, when you select the Compare Information checkbox, only the Modified Time, Created Time, Modified By, and Created By properties will be included in the Item Information section in the Compare Information report. If you want to compare more information of the items, you can add the column names of the items into the AgentToolSP2010/2007Discover.exe.config file. Follow the steps below to configure the settings: 1. To get the .config file, refer to the following two methods. • One is to select the Metadata Settings checkbox in the Compare Information field. Then the .config file will be displayed on the screen. • The other is to find the .config file in the same directory as this tool. 2. Find the node. • If you want to compare all column information of the items, modify the value of the value attribute to True. o • If you want to compare the specified metadata, modify the value of the value attribute to False. o 70 True represents to output all the column values. False represents to output the values only for the columns under the node. DocAve 6: Supplementary Tools o To add more columns, add the node under the node. Then enter the column name as the value of the value property as shown below. Figure 20: Add more columns. 3. Save the modifications made to this .config file. After the configuration completes, generate a report and find the report in the Compare Information folder in the report folders. The added columns’ metadata will be displayed in the Item Information section in the generated report. List Information Settings The List Information Settings feature is used to include the information for the specified lists when generating the comparison information. 1. Find the AgentToolSP2010/2007Discover.exe.config file in the same directory as this tool or select the Metadata Settings checkbox to open this file. 2. Modify the value of the AllDataOutPut attribute in the node. • If you set it as true, all lists within the selected node will be displayed in the Compare Information.txt file. • If you set it as false, specify the desired lists in the node. Enter either the list title or the list URL as the value of the value property in the node. Figure 21: Specify the desired lists. 3. Save the modifications made to this .config file. After the configuration completes, generate a report and find the report in the Compare Information folder in the report folders. The information of the specified lists will be displayed in the List Information section in the generated report. DocAve 6: Supplementary Tools 71 Comparing the Reports After configuring the settings, select the source/destination node and select the Compare Information checkbox to generate the compare information in the reports for both the source node and the destination node. After the Compare Information.txt files are generated, find them in the Compare Information folder in the report folders. You can compare the information from the two files by using a third-party file comparison tool, for example, WinMerge, to find the differences as shown below. Figure 22: Use a third-party file comparison tool. Last Access Information Use this feature to scan the data whose last accessed date is later than the specified date and generate the report for the data. You must enable the Audit feature for the site collection in SharePoint first. Figure 23: Set the value for Last Access Date. Warning Level Use this feature to record the detailed information in the Warning Information.csv file when the actual value of different objects in SharePoint is greater than the value configured in the Warning Level field. 72 DocAve 6: Supplementary Tools Select Structure Detail in the Site Basic Information field to enable the use of this Warning Level feature. Item count greater than – If the number of the items in one list is greater than the configured value, the list’s information will be recorded in the Warning Information.csv file. The default value is 2,000. Version count greater than – If the number of versions for one item is greater than the configured value, the item’s information will be recorded in the Warning Information.csv file. The default value is 100. URL length greater than – If the URL length of the file is greater than the configured value, the file’s information will be recorded in the Warning Information.csv file. The default value is 200. Figure 24: Set the value for Warning Level. Starting a Job To start a Discover Tool job, follow the instructions below: 1. Click Load Tree to load the data tree of the SharePoint farm. DocAve 6: Supplementary Tools 73 Figure 25: Click Load Tree. 2. Select the nodes on the data tree that you wish to scan and then select which kinds of information you wish to scan and display in the report. Figure 26: Select the nodes and the information you want to scan. *Note: If you select the Site Cascade checkbox, the sub site nodes underneath the selected site nodes will be selected automatically for the scanning job. If the Site Cascade checkbox is unchecked, only the selected site node will be included in the scanning job and the sub site nodes that have not been selected will not be included for the scanning job. 3. Configure the filter settings, enable the Compare Information feature, and set the value using the Warning Level feature according to your requirements. 74 DocAve 6: Supplementary Tools Figure 27: Configure the filter settings and use the provided features. 4. Click Generate Report. Figure 28: Click Generate Report. 5. After the job completes, there will be a prompt as shown below. Figure 29: View the processing information. 6. Go to the directory of this tool to find the folder of the job report, for example, Job20121127150101. DocAve 6: Supplementary Tools 75 Figure 30: Find the job report folder. 7. Check the reports in this folder. Reports The reports will be generated in the same directory as this tool. The folder name of the reports is Job_Serial_Number, for example, Job20121127150101. Figure 31: The folder name of the job report. In the report folder, there are four folders to store different kinds of information: the Compare Information folder, the Custom Information folder, the Global Information folder, and the Site Basic Information folder. And there is a SummaryInformation.txt report. Refer to the following tables for detailed information inside each folder. 76 DocAve 6: Supplementary Tools Global Information In the Global Information folder, the following reports listed in the File Name column in the table can be generated depending on the checkboxes you selected in the panel. For each checkbox you selected, a .csv file having the same name will be generated. File Name Content (Column Name) BuildVersion, Server, Services, Status Farm Topology.csv BuildVersion – Microsoft SharePoint Foundation build version of the server farm Status – The status of the services on server, Started or Stopped Ghosted File Information.csv FileInfo, FilePath SharePoint Global Information, SharePoint Farm Information, Global Information.txt SharePoint WebApplication Information, SharePoint Site Collection Information, SharePoint Site Information FolderName, Bin_DLL, SafeControls_DLL FolderName – The name of the folder which contains IIS files. IIS Information.csv Bin_DLL – The files in the IIS bin directory. SafeControls_DLL – The information of the SafeControl node in the web.config. Solution Information.csv Info, DisplayName, Deployed, Status Site Basic Information In the Site Basic Information folder, the following reports listed in the File Name column in the table can be generated depending on the checkboxes you selected in the panel. For each checkbox you selected, a .csv file will be generated. DocAve 6: Supplementary Tools 77 File Name Content(Column Name) Alert Information.csv URL, Title, Item Name, Alert Type, Status, User Name, Alert Template Name CheckOut Data Information.csv URL, Checkout User, UIVersion Document Count.csv Web Full URL, Document Count(not include deletion) Filter Date Information.csv Virtual Server, Site Count, Site URL, Web Count, Web URL, CreatedDate, ModifiedDate, List Count, List, Item Count, Item Size (Bytes) UIVersion – The version number of the file. Virtual Server – The same concept as web application. ListInfo, ID, BaseTemplate, TemplateFeatureID List Information.csv BaseTemplate – The template on which the list is based. TemplateFeatureID – The ID of the feature associated with the list template. Long Path Information.csv Virtual Server, Path, Length Lookup Field Information.csv FieldInfo, WebURL, ListURL, FieldURL Site Collection Information.csv Full URL, Type (S/W), ID, Template, Theme Type (S/W) – S represents site collection, W represents site. Site Information.csv WebInfo, ID, Template, Theme Size Information.csv Web Full URL, DocSize (M Bytes), DocSizeIncludeRecycleBin (M Bytes), VersionSize (M Bytes), VersionSizeIncludeRecycleBin (M Bytes), ItemSize (M Bytes), ItemSizeIncludeRecycleBin (M Bytes), TotalSize (M Bytes), TotalSizeIncludeRecycleBin (M Bytes) Structure Details.csv Full URL, Type (S/W/L/I/F), Item Count, Version Count, Item Size (M Bytes) User Group Count.csv Site Full URL, Users Count, Groups Count Warning Information.csv info 78 DocAve 6: Supplementary Tools File Name Content(Column Name) URL, Workflow Name, Workflow Template, Instance Count, Content Type, Assembly, Customized WorkFlow Information.csv Assembly – The information of the assembly. Customized – Whether the workflow is customized or not. Custom Information In the Custom Information folder, the following reports listed in the File Name column in the table can be generated depending on the checkboxes you selected in the panel. For each checkbox you selected, a .csv file will be generated. File Name Content( Column Name) Custom ContentType Information.csv URL, ContentType Name, ContentType ID Custom List View Information.csv URL, View Title, Base View ID Base View ID – The value that specifies the base view identifier of the list view. Custom Site Template Information.csv URL, TemplateID, TemplateTitle, TemplateName, TemplateLocation Custom Web Template Information.csv URL, Template ID, Template Title, Description Info, HostType, Type, ID, Class Event Receiver Informatiion.csv HostType – The object type that is hosting the event. Class – The class that is used for event receiving. Feature Information.csv Field Information.csv Info, Scope, Status, ID, DisplayName, RootDirectory, SolutionID, DependencyID DependencyID – The ID of the feature on which the custom feature relies. FieldInfo, Title, ID, Scope, FieldTypeClass FieldTypeClass – The full name of the class that defines the logic of the DocAve 6: Supplementary Tools 79 File Name Content( Column Name) field type. Master Page Information.csv CustomMasterPage WebPartInfo, Type Name, Assembly, Location, Zone, Base Class Web Part Information.csv Base Class – System.Web.UI.WebControls.WebParts.WebPart or Microsoft.SharePoint.WebPartPages.WebPart which the custom web part inherited from. Compare Information In the Compare Information folder, the following report listed in the File Name column in the table can be generated when selecting the Compare Information checkbox in the panel. File Name Content( Column Name) Compare Information.txt Site Collection Information, Sub Site Information, List Information, Item Information Summary Information In the SummaryInformation.txt report, the following information will be listed: The custom field count, the deployed solution count, the custom feature count, the custom web part count, the custom event receiver count, the custom master page count, the custom template count, number of Custom Web Templates, number of Custom List Templates, number of Checkout Documents, number of Alerts, number of Workflows, number of the last access documents and items, size of the last access data. 80 DocAve 6: Supplementary Tools Index AgentToolConnectorEncryptPassword.exe, 6 AgentToolConnectorList.config, 17 AgentToolConnectorWeb.config, 17 AgentToolCreateList.csv, 7 AgentToolCreateSite.csv, 14 AgentToolCreateWeb.csv, 11 AgentToolSP2010ConnectorCreateList, 6 AgentToolSP2010ConnectorCreateList.exe, 7 ManagerToolDellDXClient.exe, 23 DocAve 6: Supplementary Tools 81 Notices and Copyright Information Notice The materials contained in this publication are owned or provided by AvePoint, Inc. and are the property of AvePoint or its licensors, and are protected by copyright, trademark and other intellectual property laws. No trademark or copyright notice in this publication may be removed or altered in any way. Copyright Copyright © 2012-2013 AvePoint, Inc. All rights reserved. All materials contained in this publication are protected by United States copyright law and no part of this publication may be reproduced, modified, displayed, stored in a retrieval system, or transmitted in any form or by any means, electronic, mechanical, photocopying, recording or otherwise, without the prior written consent of AvePoint, 3 Second Street, Jersey City, NJ 07311, USA or, in the case of materials in this publication owned by third parties, without such third party’s consent. Trademarks ® ® AvePoint , DocAve , the AvePoint logo, and the AvePoint Pyramid logo are registered trademarks of AvePoint, Inc. with the United States Patent and Trademark Office. These registered trademarks, along with all other trademarks of AvePoint used in this publication are the exclusive property of AvePoint and may not be used without prior written consent. Microsoft, MS-DOS, Internet Explorer, Microsoft Office SharePoint Servers 2007/2010/2013, SharePoint Portal Server 2003, Windows SharePoint Services, Windows SQL server, and Windows are either registered trademarks or trademarks of Microsoft Corporation. Adobe Acrobat and Acrobat Reader are trademarks of Adobe Systems, Inc. All other trademarks contained in this publication are the property of their respective owners and may not be used such party’s consent. Changes The material in this publication is for information purposes only and is subject to change without notice. While reasonable efforts have been made in the preparation of this publication to ensure its accuracy, AvePoint makes no representation or warranty, expressed or implied, as to its completeness, accuracy, or suitability, and assumes no liability resulting from errors or omissions in this publication or from the use of the information contained herein. AvePoint reserves the right to make changes in the Graphical User Interface of the AvePoint software without reservation and without notification to its users. AvePoint, Inc. 3 Second Street Jersey City, NJ 07311 USA 82 DocAve 6: Supplementary Tools