home

MinistryPlatform

RealmRealm AccountingMinistryPlatformGivingPDSACSConnectShepherdGrowth MethodHeadMasterRefresh WebsitesTrust CenterGo MethodMissionInsite
RealmRealm AccountingMinistryPlatformGivingPDSACSConnectShepherdGrowth MethodHeadMasterRefresh WebsitesTrust CenterGo MethodMissionInsite

What would you like to know more about?

Show Contents

thumbnailMinistryPlatform

Writing Custom Reports

Subscribe to a Report

Steps to create a SQL subscription report.

To subscribe to a report in MinistryPlatform, you must first run the report you want to subscribe to.
  1. Run the report. Log in to MinistryPlatform and go to the report you would like to run:
    1. Go to Administration > Users.
    2. Run the Tasks Incomplete report.
    3. In the address bar, your link should look something like this but with different values:
      https://my.domain.tld/ReportServer/Pages/ReportViewer.aspx?%2fMPReports%2fTasks%20Incomplete&rs:Command=Render&DomainID=12345A0B-9R67-4SN9-441W-1645873215DR&UserID=95668457-5578-3364-FGEA-0G3X1E1L9546&PageID=401
  2. Dissect the URL. Keep those variable values handy, you'll need them in just a few steps!
  3. Log in to SQL Server Reporting Services (SSRS).
    Tip: You should be able to get there by changing the previous link slightly. Instead of https://my.domain.tld/ReportServer/, change the link to https://my.domain.tld/Reports/.
  4. Download the report.
    1. In your browser window, you should see a folder called MPReports. Click the folder to open it.
    2. Find the report named Tasks Incomplete. There is a search field in the upper right to narrow your selection.
    3. Click the arrow next to the report title and select Download. (For version 2016, select MANAGE and then download from the manage screen.)
    4. Save as Tasks Incomplete Subscription.
  5. Duplicate stored procedures.
    1. Open the saved report to find all of the stored procedures that make up the report within the datasets.
    2. For each dataset, find the stored procedure and create a new one with the subscription name at the end of the new stored procedure name.
    3. Edit the stored procedure if it uses SelectionID to return the data that a person would normally select.
  6. Edit the saved report. The following steps assume you are using Report Builder installed on the server. You may need to complete additional steps if you aren't using Report Builder.
    1. Link the datasets with Subscription to this new report.
    2. Link the MPSubscriptions data source to the report.
    3. Save the report.
  7. Subscribe to the new report.
    1. Click the arrow next to the report title, and select Subscribe.
    2. Complete the subscription information.
  8. To finish, click OK.

You should now have an active (one-time or recurring) SQL subscription.

As an additional resource, see Microsoft Developer Network: Create and Manage Subscriptions.

Subscription Information

A list of common subscription fields you'll encounter in the Platform and what they mean.

Subscription Fields

Delivered By
The default is email. Alternatively, you can export to a Windows file share.
To
The destination email address of the person receiving the message.
CC
Any carbon copied recipients. These recipients can see they were copied.
BCC
Any blind carbon copied recipients. These recipients can't see they were copied.
Reply-To
The email you want to receive any reply messages.
Subject
The title of the email.
Include Report
Select whether to attach the report to the email and what format.
Include link
Select whether to include the link to the report in the message. You must have Windows rights to get to the reports server through MinistryPlatform.
Priority
The importance of the message (low, normal, high).
Comment
The body of the message.
Select Schedule
Select when and how often (one-time or recurring) you want to run the subscription.

URL Elements

For most reports in MinistryPlatform, you need the following elements from the URL of the report you want to subscribe to. Those elements are:

DomainID
An alphanumeric string representing your MinistryPlatform installation.
UserID
An alphanumeric string that tells you who is running the report. If the report is contextually sensitive to the person that runs it, the report reflects that particular person. If you need to display a different person from the one displayed in the executed report, copy that person's GUID from System Admin > Users and use it for this field.
PageID
The number representing the specific page you requested the report from.
SelectionID
Optional. The number indicating the selection of records to pass the report.

Report-specific Fields

The following values differ depending on the report:

Completed
What type of tasks to look for.
Tasks to include
Which tasks to include.
Tasks starting after
Use this field if you want to specify a firm start date.
MinistryPlatform

Last updated: October 1, 2024