Migrator for Notes to SharePoint 6.16 - User Guide

Standard and advanced reports

Standard and advanced reports

The installation adds several report XML and RDLC files in the Standard Reports folder. Reports shipped with the console are listed as children of the Reports node and cannot be edited or customized within the console.

Each report consists of:

•

Report Definition metadata (.XML) - provides the title, description and data filtering criteria. This is saved as an XML file in the Standard Reports or Custom Reports folder and is essentially what is represented by the report tree nodes. Each XML file contains a reference to an RDLC file (see below).

•

Report Definition file (.RDLC) - supplies the visual formatting, layout of the report and data fields to render. These are created using a third party RDLC editor. By convention the RDLC will have the same file name (except for the extension) as the XML file.This is saved in the Standard Reports or Custom Reports folder.

The following is a list of Standard Reports:

•	All Tasks Report

•	Database ACLs Report

•	Database Aging Report

•	Database Class Report By Server (Chart)

•	Database Design Element Differences Report

•	Database Design Element Report

•	Database Jobs Report

•	Database Migration Target Report

•	Database Replica Access

•	Database Tasks Report

•	Database By Manager

•	Databases By Template

•	Databases Script Scan Report

•	Detailed Database Report

•	Standard Database Report Template

•	User Activity By Database

•	User Activity By Database (All Users)

•	User Activity By User

•	User Activity By User (All Users)

The following is a list of Advanced Reports:

•	ACL Details Chart Only Report

•	ACL Details Report

•	Agent Details Chart Only Report

•	Agent Details Report

•	Business Class By Technical Class Report

•	Database Count by Document Count Group Report

•	Database Count by File Size Group Report

•	DEI By Document Count Group Report

•	Form Details Report

•	Script Library Details Chart Only Report

•	Script Library Details Report

•	Subform Details Chart Only Report

•	Subform Details Report

•	Top 10 Attachments Report

•	Top 10 Databases By Inherited Template Report

•	Top 25 Databases by Count of Uses Report

•	Top 25 Databases by Document Count Report

•	Top 25 Database by File Size Report

Report dataset supports the following tables:

•	DbReportTable - Defines all the reporting fields associated with a database record

•	DbUserActivityReportTable - Joins DbReportTable with user Read/Write/Use Activity information

•	DbDesignElementReportTable - Joins DbReportTable with Design scan information about Design Elements

•	DbDesignElementDifferencesReportTable - Joins DbReportTable with Design scan information about Design Elements compared with a Reference database

•	DbAnalysisByAuthorReportTable - Joins DbReportTable with detailed document Author information.

•	DbAnalysisByFormReportTable - Joins DbReportTable with detailed document Form information.

•	DbJobReportTable - Joins DbReportTable with Database Associated Job information.

•	DbTaskReportTable - Joins DbReportTable with Tasks run on each Database

•	DbUserAclsReportTable - Joins DbReportTable with detailed database User ACL information.

•	TasksReportTable - Provides top level Task execution details

The RDLC report files contain the dataset schema needed to design reports. There is no external XSD schema file provided containing this information. When using the Create New Custom Report feature described below, a starter RDLC is created containing the dataset schema ready for designing the report in a suitable 3rd party tool such as Visual Studio Professional.

Custom reports

Custom reports

In addition to the standard reports that are provided, users can design their own.

All custom reports appear under the Custom Reports scope node under the Reports node. The Custom Reports node has actions to add, edit or delete Reports.

To create a new custom report

1	Select the Reports scope node.

2	Select Create new custom report from the Actions pane or context menu.

The Report Definition dialog box will appear.

Table 48. Custom reports

Property	Description
Report Title	The name of the report
Description	The description of the report
RDLC Template	The report definition file the custom report will be based on. Click the Browse button to search on all available templates. You can use an existing template from any place on the network. The default location is the Standard Report folder since this is where the Migrator for Notes to SharePoint standard report templates are located.
Edit	Click the Edit button to launch the currently installed report editor to design the report. If the template that you have chosen is sufficient, there is no need to use the Edit button NOTE: Microsoft's Visual Studio Report Designer is currently the only report designer supported as the RDLC editor. The Express versions are not supported however. For more information about this report designer and how to build reports using it, refer to http://msdn.microsoft.com/en-us/library/ms157166.aspx. If you do not have a supported report designer installed, clicking Edit will generate an error message indicating this. For detailed information on the available reporting dataset columns that you can use in your custom reports, see Migrator for Notes to SharePoint reporting data tables. NOTE: If you want to modify a standard template that is delivered with Migrator for Notes to SharePoint but for just one particular report, you will need to create a copy of the RDLC file and have the one report refer to that copy. Use the Copy Report function to do this. This copy can then be edited in the Report Designer. By changing one of the standard templates, you will be changing all the reports that use that template.
Database Scope	The database scope node that the custom report will be based on. The custom report will be a filter of this scope node’s result set
Filters	Select one or more check boxes for the data types you want to filter the result set on. The data type button on the right of the check box will activate. Select the button to specify the filter. Check one or more of the check boxes that correlate to the data you want displayed in your report. You can deselect a check box by selecting it again

To edit a custom report

1	Select the report.

2	Select Customize Report in the Action pane or context menu.

To delete a custom report

1	Select the report.

2	Select Delete Report from the Action pane or context menu.

To clone a standard report or custom report

1	Select the report you want to clone.

2	Select Copy Report from the Action pane or context menu.

The Report Definition dialog will appear for the new cloned report. It is pre-filled with the same settings as the source report.

The Copy Report function performs the following actions:

•	Copies the report definition’s referenced RDLC file and places the uniquely named copy in the Custom Reports folder. The new custom report definition (the XML file) will refer to the new RDLC file in the Custom Reports folder.

•	Copies the selected report definition’s XML file and places the uniquely named XML file in the Custom Reports folder. The RDLC reference in the XML file is updated to point to the newly created RDLC file.

Other view properties such as column selection, column ordering and sorting are defined using the View menu item of the Actions pane. Select the submenu item Add/Remove Columns to change the report’s column selection as well as to reorder the columns. The Sort By menu items allow you to change the field that the report is sorted on.

Another way to add a new custom report to the Console is to simply add the report’s RDLC and XML files to the Custom Reports folder. The next time the Console restarts or refreshes, the new report nodes will appear under the Custom Reports node.

To share a report, you can copy the .XML and .RDLC files from your Custom Reports folder to another user’s Custom Reports folder.

With new releases of the Migrator for Notes to SharePoint Console, additional reporting fields and tables may be provided, or existing ones renamed. Older custom reports may need to be updated in order to be compatible with the newer dataset schema.

To support this, the Update Report Definition action is available when a custom report is selected. This action will create a time-stamped backup of the current report RDLC file prior to performing the required upgrade of the report’s dataset definitions. Once the report is updated, new tables and data columns are available for customizing the report.

The Update Report Definition action is only available for reports within the Custom Reports folder and is usually only necessary in the following cases:

•	A previously working custom report generates an error after upgrading to a newer version of Migrator for Notes to SharePoint.

•	New Data tables or columns needed for a particular report are not shown when modifying a report in the third party report designer.

Task history

Task history

All long running tasks are managed using a common task management facility found in the Task History node. When a process is run in the Console, Task Records are created and either dispatched to worker threads that perform the actual work or added to a task management queue, in which case they are performed serially in a predetermined order.

When the Task History node is selected, the Results View of the console shows a list of all tasks (pending + running + recently completed). This view is automatically updated in real time.

The view displays the following information for each task listed:

•	Status Icon

•

Task Name

•	Type of Task

•

Status

•

Summary

•	Start Time

•

Stop Time

Each task record and its details are viewable in the task property sheet. If a running task is being viewed in a property sheet, the information on the property sheet updates as the task status changes.

Certain tasks such as migration jobs, will generate a log file. The log files are saved as part of the Task Record in the Repository. When a log file becomes available, additional tabs are displayed in the task property sheet. These tabs are the summary and detailed versions of the log file similar to the Migrator for Notes to SharePoint Designer log viewer. For more information, see Migration job logging Log files can be exported to the file system by selecting the Export Log task action once the task is selected in the results view. To migrate the failed items for a task, right click on the task, and click Migrate Failed Items. For more information, see Migrating failed items

Additionally, the Task Records that relate to a particular database should be displayed in that database's Migration History tab of the database property sheet.

Any tasks that are tied together to run sequentially, like running multiple migration jobs for a single database, are displayed as separate tasks with a wrapper task, for example "Content Migration Sequence".

One or more tasks can be purged from the Repository by selecting the tasks in the results view and the selecting the Delete action from the Action view.

Importing tasks

Importing tasks

For migration jobs that have been run using Migrator for Notes to SharePoint Designer or the Migrator for Notes to SharePoint Command Line, the logs can be imported into Task History. This allows the jobs to be visible in the database’s migration history.

To import a log file

1	Select the Task History node.

2	Select Import log files from the Action menu.

You can select one or more log files to import. A record in the Task History view will be created to log the results of the import.

Only migration logs generated by Migrator for Notes to SharePoint or Migrator for Notes to SharePointCmd will be imported. Any other log files (including those that may have been exported from the Task History view in the Console) will be ignored. Log files that have already been imported into the Console, we will ignored as well.

The import will attempt to match up the Notes database that was used for the migration with the database reference being held in the Repository. If the database reference is found, the Task History record will be associated with the database, and will show up in the Migration History tab in that database's properties.