How can we help?

Table of Contents

Pro Reports extension overview

The MainWP Pro Reports Extension combines the power of the free MainWP Child Reports plugin with a fully customizable reporting engine that allows you to create the type of report you are proud to send to your clients.

The MainWP Child Reports plugin, installed on your Child Sites, will track and monitor every change made on your child site, and then the Pro Reports Extension on your Dashboard will gather that information and convert it to a PDF Report you can show your clients.

  • Generate professional reports in seconds
  • Pre-made professional templates to get you started
  • Send PDF reports automatically attached to the email
  • Quickly include/exclude certain content from reports
  • Highly customizable templates system
  • Set custom branding for reports
  • Can be run simultaneously with the original Client Reports Extension

Pro Reports extension overview 1

 

 

Get Started with MainWP Pro Reports Extension

    1. Install the MainWP Child Reports plugin on all your child sites. It is available for free on wordpress.org. (if you already use the Client Reports extension and have the Child Reports plugin installed on your sites, skip this step). Once the plugin is installed, it will start recording certain actions that you will be able to include in the reports.
    2. Install the MainWP Pro Reports Extension on your MainWP Dashboard
    3. Sync your site (it’s important to sync your sites so your Dashboard can pick up all the sites that have the MainWP Child Reports plugin installed)
    4. Once the extension is properly installed, start entering basic client info for your child sites. To do that,
      1. Go to the MainWP > Sites > Manage Sites page
      2. Locate the first site and click the Edit action to edit site settings
      3. On the Edit page for the site, locate the Pro Reports Tokens sectionPro Reports extension overview 2
      4. By default, Pro Report templates uses [client.email] and [client.name] tokens for Send email to fields, so if you intend to use those tokens in the report, set their values here
        Pro Reports extension overview 3
      5. Enter the rest of desired token values and save updates
    5. If you are a new user and you haven’t had the MainWP Child Reports plugin installed on your sites, you may need to wait for a couple of days before the MainWP Child Reports records some activity.
    6. Go to the MainWP Dashboard > Extensions > Pro Reports and go to the Create Report tab
    7. In the Report Settings section
      Pro Reports extension overview 4
  1. Enter the Report title
  2. Choose a Report type (If you want to send a report right away, select One-time report, if you want to schedule automated reports, select Recurring)
  3. Set the Report date range
  • In the Report Template Selection section, select a template for your report
    Pro Reports extension overview 5
  • In the Report Content & Design Customization section,Pro Reports extension overview 6
    1. on the Custom Content tab, set Report heading, introduction message, and closing message.
    2. on the Report Data tab, select what you want to show in the report
    3. on the Personal Branding tab, upload your logo and custom image for the first page of the report (if left blank, the default image will be used)
    4. on the Custom Report Colors tab, set preferred colors to reflect your brand
  • In the Email Settings section,Pro Reports extension overview 7
    1. Enter the Send email from data (in most cases, your email address and name).  
    2. Enter the Send email to data (in most cases, your client email address and name. Tokens are allowed here and can be left at their default values if they have been set in Site settings)
    3. Enter the Email subject (Tokens are allowed here)
    4. Enter the Email message (Tokens are allowed here)
    5. Select Email template
    6. Optionally, enter the BCC email address
    7. Optionally, attach additional email attachments
  1. Select wanted site(s) in the Metabox on the right
  2. Preview report or Download PDF for review, and once you are sure that the report is ready, click the Send Report button

 

 

MainWP Pro Reports Extension Dashboard

 

Pro Reports extension overview 8

From the MainWP > Extensions > Pro Reports > Child Reports Dashboard page, you can monitor all of your child sites where you have the MainWP Child Reports plugin installed. In the sites list, you will be notified if the plugin has an update available or if the plugin is deactivated.

  • If the plugin is not activated, the plugin row will appear red, and the Activate action will appear in the actions menu.
  • If there is a new version of the plugin, the plugin row will appear yellow, and the Update action will appear in the actions menu.
  • If the plugin is not hidden at the moment, the Hide action will be available in the actions menu.
  • If the plugin is hidden at the moment, the Unhide action will be available in the actions menu.

All these actions are also available in the bulk actions menu at the top of the page.

Important Notes

If you know that you have the plugin installed on a child site, but the child site doesn’t appear in the list, try to re-sync your sites.

 

 

MainWP Child Reports Plugin

The MainWP Child Reports plugin communicates changes collected on your Child sites to the MainWP Pro Reports Extension to create the reports. It has been designed to record certain actions performed on WordPress sites. It is available for free on wordpress.org.

Note: This plugin requires PHP 5.6 or higher to be activated and is only useful if you are using MainWP and the MainWP Pro Reports Extension.

Credit to the Stream Plugin, which the MainWP Child Reports plugin is built on.

Child Reports Records

If  you want to see what has been recorded by the MainWP Child Reports plugin,

  1. Go to your child site.
  2. Go to the WP Admin > Settings > MainWP Child > MainWP Child Reports page
Pro Reports extension overview 9
The provided table will show you all recorded action

 

 

MainWP Child Reports Settings

Pro Reports extension overview 10

Settings page can be found on the WP Admin > Settings > MainWP Child > MainWP Child Reports Settings page.

  1. Hide MainWP Child Reports from reports – If selected, the MainWP Child Reports plugin will be left out from reports for this site.
  2. Keep Records Indefinitely (Not recommended) – Purging old records helps keep your WordPress installation running optimally.
  3. Keep Records for – The Maximum number of days to keep activity records.
  4. Akismet Tracking – Akismet already keeps statistics for comment attempts that it blocks as SPAM. By default, MainWP Child Reports does not track these attempts unless you opt-in here. Enabling this is not necessary or recommended for most sites.
  5. Comment Flood Tracking – WordPress will automatically prevent duplicate comments from flooding the database. By default, MainWP Child Reports does not track these attempts unless you opt-in here. Enabling this is not necessary or recommended for most sites.
  6. WP-Cron Tracking – By default, MainWP Child Reports does not track activity performed by WordPress cron events unless you opt-in here. Enabling this is not necessary or recommended for most sites.
  7. Reset MainWP Child Reports Database – Use this option to delete all activity reports from the database.

 

 

Create Custom Report Templates

Introduction

The Pro Reports Extension uses PHP templates that allow you to design and create professional reports with the information you want to show to your clients.

The Pro Reports Extension also allows you to add custom content, including contact info, images, additional text, or any other content you want to include in your report.

Creating a custom report consists of two steps. The first step is to create the actual PHP file representing the template, and the second is to edit and customize that PHP file.

Customizing the template by adding or removing Pro Reports Tokens should be easy and straightforward for most readers. However, advanced customization of the report requires some knowledge of HTML.

Creating a PHP file for the Custom report

We will be using one of the built-in templates as a starting point for the custom report. We will do so by downloading MainWP Pro Reports Extension in ZIP file format and copying one of the PHP template files.
  1. Download the MainWP Pro Reports Extension from your MainWP Account
  2. Extract the plugin files to your computer
  3. Locate one of the default PHP templates in the /mainwp-pro-reports-extension/templates/reports/ directory
  4. Copy a PHP file, rename the file to a new desired title, and use your favorite code editor to make customizations (see the following chapter for instructions on customization)
  5. Once you are finished with the customization and the template is ready, upload the PHP file the /wp-content/uploads/mainwp/report-templates/ directory on your Dashboard site
  6. Once uploaded, the template will be available in the Report template dropdown
    Pro Reports extension overview 11

 

How to Use Tokens

Tokens offer an easy way to customize your Pro Report. They can be added directly to the PHP file of your custom report or in the existing Reports through the visual editor on MainWP Dashboard.

The MainWP Client Reports extension uses three different types of tokens:

  • Client Tokens
  • Section Tokens
  • Data Tokens

A list of all available tokens for the Pro Reports extension is available here: https://kb.mainwp.com/docs/available-pro-reports-tokens/

 

Client Tokens

These tokens will allow you to display data you have set in the Edit tab of the Individual Child site overview. If you plan to use one of the Client tokens in a report for a certain Child site, a value for it must be set.

Pro Reports extension overview 12

For example, by setting the value for [client.email], that token can be used in the Send email to field in order to send a report for multiple websites and multiple clients.

Pro Reports extension overview 13

You can easily see available Client Tokens and insert them into a field by clicking on the Insert tokens link.

Pro Reports extension overview 14

 

Section Tokens

Section tokens require both opening and closing tags. They can easily be recognized by the starting part section.

For example, [section.plugins.installed] is an Opening tag and [/section.plugins.installed] is a Closing tag for that Section token.

Section token loops through the database and searches for the relevant data during the selected date range.

Example: [section.plugins.installed]
The following code would loop through all selected Child sites and, within the selected Date range, list all instances of plugin installations.

[section.plugins.installed]
[plugin.name]
[plugin.installed.date]
[/section.plugins.installed]

Pro Reports extension overview 15

 

Data Tokens

Data tokens have only one tag; they have to be used inside section tokens and have to be added between an opening and closing tag of a section token.

From the example above for the Section Tokens, the [plugin.name] and [plugin.installed.date] are Data Tokens.

[section.plugins.installed]
[plugin.name]
[plugin.installed.date]
[/section.plugins.installed]

In our help article, you can find all available Data Tokens and the respective Section tokens into which they can be inserted.
Pro Reports extension overview 16

 

Counter Tokens

Counter Tokens are a special type of Data tokens.

You will be able to recognize these tokens by the first word. They end with “.count.” For example [plugin.installed.count]

These tokens won’t work inside of the section tokens. You need to use them outside of section tokens.
Example: [plugin.installed.count]
The counter token will display the number of Installed Plugins, but it must be placed outside of the opening and closing tag of the section token.

[section.plugins.installed]
[plugin.name]
[plugin.installed.date]
[/section.plugins.installed]

Total number of plugin installations: [plugin.installed.count]

Pro Reports extension overview 17

 

 

Schedule Reports

To schedule your reports,

Pro Reports extension overview 18

  1. In the Report Settings option box, locate the Report type option
  2. Select the Recurring option
  3. New options will show up, where you can set schedule frequency
  4. Select if you want to send reports Daily, Weekly or Monthly 
  5. Review rest of the report settings and its content
  6. Once everything is set, click the Schedule Report button at the bottom of the page

Schedule Options

  • Daily – the extension will send the report every day with report data for the previous day. For example, if you set the daily report today, the first report will be sent tomorrow with report data for today.
  • Weekly – the extension will send the report once a week for the previous week. You can set the day for sending the report. For example, if you set a weekly report and Monday as a day when the report will be sent, each Monday, the extension will send the report for the previous week. 
  • Monthly – the extension will send reports once a month for the previous month. You can set a day for sending the report. For example, if you set monthly reports and the 2nd day of the month for sending the report, each month, on the second day of the month, the extension will send the report for the previous month.

 

 

Send Report

To create and send reports to your clients,

  1. Go to the MainWP > Extensions > Pro Reports > Create Report page
  2. Under the Report Settings section,Pro Reports extension overview 4
    1. Enter a Report title
    2. Select Report type (If you want to send a report right away, select One-time report, if you want to schedule automated reports, select Recurring)
    3. Select Report date range
  3. Under the Report Template Selection section,Pro Reports extension overview 5
    1. Select a template for your report
  4. Under the Report Content & Design Customization section,Pro Reports extension overview 6
    1. on the Custom Content tab, set the Report heading, introduction message, and closing message.
    2. on the Report Data tab, select what you want to show in the report
    3. on the Personal Branding tab, upload your logo and custom image for the first page of the report (if left blank, the default image will be used)
    4. on the Custom Report Colors tab, set preferred colors to reflect your brand
  5. Under the Email Settings section,Pro Reports extension overview 7
    1. Enter the Send email from data (in most cases, your email address and name)
    2. Enter the Send email to data (in most cases, your client email address and name. Tokens are allowed here)
    3. Enter the Email subject (Tokens are allowed here)
    4. Enter the Email message (Tokens are allowed here)
    5. Select Email template
    6. Optionally, enter the BCC email address
    7. Optionally, attach additional email attachments
  6. Select wanted site(s) from the Metabox on the right, either by individually selecting them or by selecting a Site Group
    Please note: A separate email will be sent for each site that has been selected either individually or through a Site Group
  7. Preview report or Download PDF for review, and once you are sure that the report is ready, click the Send Report button

 

 

Delete Reports

To delete reports,

Delete Reports

  1. Go to the MainWP > Extensions > Pro Reports > Reports page
  2. Locate the report that you want to delete
  3. Click on the Actions Menu
  4. Click the Delete action
  5. Confirm deletion

 

 

Duplicate Reports

To duplicate reports,

Duplicate Report

  1. Go to the MainWP > Extensions > Pro Reports > Reports page
  2. Locate the report that you want to Duplicate
  3. Click on the Actions Menu
  4. Click the Duplicate action
  5. Enter a new Report Title
  6. Enter the Send To and Send From fields
  7. Click the Save Draft button
Still Have a Questions?
Search for additional solutions in the MainWP Community or start your own discussion