Articles in this section

Create a custom report and modify a built-in report

Updated
Follow

Reports can provide you with crucial information to plan a migration or manage your SharePoint environment.

Though ShareGate provides a number of useful built-in reports, you can also customize most of these reports or create new ones if you need to get more specific information about your environment.

Index

How-to

Create a new custom report

  1. Select All Reports from the menu. 
  2. Click Create custom report
  3. In the report settings screen Select the Object type, Filters, and Columns as needed.
  4. Click Continue without Saving if the report is for one-time use.
  5. Click Save and Continue if you will need the report again, or if you would like to automate the report with scheduling. 
  6. Select the target of your report.
  7. Click Next.
  8. Set your options.
  9. Click Schedule (available if you saved your report) or Run now.

Tip: You can edit the objects in your report once they load.

Modify a built-in report and save it as a custom report

  1. Select All Reports from the menu. 
  2. Hover your mouse over the report you want to modify.
  3. Click mceclip0.png to edit the report.
  4. In the report settings screen, modify the Object type, Filters, and Columns as needed.
  5. Click Continue without Saving if the report is for one-time use.
  6. Click Save and Continue to preserve the new report, or if you would like to automate the report with scheduling.
  7. Enter a new name for your report if you chose to save it, and click Save.
  8. Select the target of your report.
  9. Click Next.
  10. Set your options.
  11. Click Schedule (available if you saved your report) or Run now.

Tip: You can edit the objects in your report once they load.

Report settings

In the report settings screen, you can select the Object type you want to report on, for example, you can report on teams, sites, OneDrive for Business, and more. You can then apply filters to find specific objects and add columns that provide you with more information on these objects.

Object type

Click on the Object type dropdown to select the object types you want to report on. Once selected, you will get access to filters and columns specific to that object type (explained below).

Tip: The OneDrive for Business object type will also work to find MySites in older environments. Lists and libraries are both found under the Lists object type, you can use the Base type filter to specify which one you want in your report.

Filters

Filters are used to pinpoint specific objects of the object type you are reporting on. For example, you can use a Site template filter on the object type Site to find all your team sites.

You can add new filters with the mceclip1.png icon or remove unwanted filters with the mceclip2.png icon.

Note: When you add multiple filters, the condition between each filter is AND. For instance, if you create a report on the List object type and add two different List template filters, the report will return no results because a list cannot have two different list templates.

Columns

Columns can be added to your report to provide you with more information about the objects in your report. For example, you can add the Guests column to a report on the Microsoft Teams object type to get a list of all the guests of each one of your teams.

  • To add new columns, select them in the All columns section and click the mceclip0.png icon.
  • To remove unwanted columns, select them in the Selected columns section and click the mceclip1.png icon.

Note: The default columns for each object type are grayed out and cannot be removed.

Tip: Columns provide you with the same parameters you can filter. Since you can export the results to Excel, you can add columns to your report instead of filters and leverage Excel's expanded capabilities to filter and sort your results.

Reporting options

To learn how to get more out of your reports, see our Reporting options section.

Related articles