How do I use Data-Driven Package Schedules for SSRS in SQL-RD?

Unlike a Data Driven Schedule, a Data Driven Package will determine the data driver further into the schedule. A Data-Driven Package allows you to send a package of reports to an individual or group from one schedule.

How to Create a Data-Driven Package Schedule Report for SSRS?

  • Go to Data-Driven Package.
SSRS. SQL-RD Home Menu.

SSRS. General Wizard in Data Driven Package in SQL-RD.

General Wizard

  • Package Name: The name of the package.
  • Create In: The SQL-RD folder where the package is stored.
  • Description: A short description to help other users identify exactly what this schedule is and what it is expected to do.
  • Keyword: Enter some keywords which can be used later by Smart Folders to identify this schedule.

Click Next to continue to the next wizard section.

Schedule Wizard

SSRS. Schedule Wizard in Data Driven Package in SQL-RD.

In this section, you will decide when the report will execute. There are a variety of options:

  • Daily: Run a report every day or at a frequency of days.
    • Sub options: Repeat every X Days.
Example: Run the schedule every 3 days.
SSRS. Schedule Wizard in Data Driven Package in SQL-RD.
  • Weekly: Run a report on a weekly time frame.
    • Sub options: Repeat every X weeks.
Example: Run the schedule every 2 Weeks.
  • On: Select the specific days of the week the schedule will run. If only once a week,select only the day of the week it will run.
Example: Run every Monday, Wednesday, and Friday.
SSRS. Schedule Wizard in Data Driven Package in SQL-RD.
  • Week Days: Run the schedule Monday through Friday.
SSRS. Schedule Wizard in Data Driven Package in SQL-RD.
  • Working Day: Run the schedule starting on a specific day of the month. Indicate which day of the month the schedule will run. E.G. run the schedule on the 4th working day of the month.
SSRS. Schedule Wizard in Data Driven Package in SQL-RD.
  • Monthly: Run the schedule on a monthly time frame.
    • Use the following options: Checking this box will enable you to select frequency options such as the “last Thursday of the month.” Also you can include or exclude specific months from the schedule.
SSRS. Schedule Wizard in Data Driven Package in SQL-RD.
  • Annual: Run the schedule every year at a specified time.
SSRS. Schedule Wizard in Data Driven Package in SQL-RD.
  • Custom Calendar: Select the custom Calendar you wish to use. You can create a new custom calendar from the menu as well. Please see Custom Calendars for more information.
SSRS. Schedule Wizard in Data Driven Package in SQL-RD.
  • Other: Other scheduling options.
    • Run Schedule every X Minutes, hours, days, weeks, months, years.
SSRS. Schedule Wizard in Data Driven Package in SQL-RD.
  • None: No scheduling is required for this item.
SSRS. Schedule Wizard in Data Driven Package in SQL-RD.
  • Start Date: Enter the desired starting date for the schedule. This section can be the current date (providing schedule time has not already passed) or a date in the future.
  • End Date: If the schedule is due to end after a certain date enter that here. If the schedule is to run indefinitely, then leave it blank.
  • Schedule time: On the Next Run date, the package will run at this time.
  • Exception Calendar: Choose a calendar that will instruct the schedule to NOT run on those specified days. Please see Custom Calendars for more information.
  • Next to run on: The package will next run on this date.
  • Repeat Every: Rerun the package every x minutes from the scheduled time until your specified time.
For example, you can set up a daily package to run every day at 8 am, and to run every hour until 5 pm.
  • Until: After this date, there will be no automated scheduling of this package.
  • Enable this Schedule: Uncheck this option to Disable the package. Disabled packages are not deleted, but they do not execute automatically. You can re-start the automatic scheduling at a later date by checking this option again. Or right-clicking this schedule from the main screen and selecting Enable.

Click Next to continue to the next wizard section.

Building a Data Driver Wizard

SSRS. Get values from database interface in SQL-RD.
  • The Data Driver is where you set up the source for data for your data driven reports. If your data source or data selection criteria changes this is where you will need to make any required changes.
  • ODBC DSN Name: Drop down and select a DSN.
We strongly recommend System DSNs so that the DSN is visible to SQL-RD even when the user associated with the DSN is logged off.
All communication to databases (including Access databases) is done through ODBC, so you must setup a system DSN to the database before you can use this facility.
When setting up DSNs we recommend (if possible) that you use Windows Authentication (Trusted Connection). This ensures that your username and password are not required to be stored in SQL-RD (more secure) and overcomes a large number of security restrictions which Windows places on DSNs. When using Windows Authentication, make sure that the SQL-RD NT service user (or background application service user) has full rights to the database otherwise, though you will connect when you are logged in, automated scheduling will fail if the Service user has not got rights to the database.
When setting up a DSN to a SQL server, you must ensure that the "Default Database" setting is set to the database you are connecting to (Windows defaults this to "Master").
  • UserID: Enter the User ID SQL-RD should use to log on to the database
  • Password: Enter the password associated with the above user.
  • Connect: Click Connect to connect to the Database.
  • Select the table from the database that holds the required data. You can refine your selection query by using the simple or advanced tabs.
  • Click Parse.
  • For more information of "Get Values From Database" interface, click here.
  • Click OK.
SSRS. Data Driver Wizard in Data Driven Package in SQL-RD.

Data-Driver Wizard

  • Click Build to specify the data selection criteria. This will return you to the Build Data Driver tool.
  • Key Column: Select the key column for the data that is returned for the reports. The information that drives the schedule is required to have a key column so that each row in the table is uniquely identified by the value in this column. The key column is there as an identifier which is used to troubleshoot in cases where there is a problem with one of the records.
  • Group reports by email address: You can instruct SQL-RD to group reports that are sent to the same email address. Please note that enabling this option disables the ability to embed the reports in the email body for email destinations.
    • Merging Multiple Reports: Where the reports are grouped you can also instruct SQL-RD to optionally merge the output of the grouped reports into a single file (PDF and MS Excel formats only). Selecting each option will bring up the options for the output format that you can further customize.

Destination Wizard

In this section, you will decide where your schedule will be delivered. The list in the center will display the list of destinations you have added to the schedule. You can organize the various destinations’ order by clicking on the green up and down arrows.

SSRS. Destinations Wizard in Data Driven Package in SQL-RD.
  • Add: Click here to add a destination. You have several options which are: Email, Disk, Fax, FTP, ODBC, Printer, Sharepoint, SMS, and Dropbox.
SSRS. Destinations Wizard in Data Driven Package in SQL-RD.
  • Edit: Select a destination and click to edit it's properties. Or simply double-click on the destination.
  • Delete: Select a destination and click this button to delete it.
  • Import: click here to import from the list of default destinations.
  • For more information about Type of Destinations, click here.

Customizing the Destination

With the Data Driven Schedule, you can determine the delivery method of your report based on your data. In your table, specify the delivery method by creating a column for each delivery type (FTP, SharePoint, Email etc.). For each record specify their email, fax number, and so on.

SSRS. Data Driven Example in SQL-RD

Tip: For email destinations, simply add a semicolon after an email address to send the same instance of the report to another email address.
  • Data driving the Report's Distribution
  • As mentioned above, SQL-RD will pull delivery data from your database.
  • In this example, we will be using email addresses found in the table.
  • With Data Driven inserts, simply drag and drop the field that indicates your desired destination (email in this case).
SSRS. Using Data Driven Inserts in Email Destinations in SQL-RD
  • Now SQL-RD will deliver a unique report based base on a corresponding email address.

Customize Recipient Messaging

  • You can also customize the messaging the recipient receives. Using Data Driven Inserts, SQL-RD will automatically pull data from your table and use it to customize the subject, body or report format.
SSRS. Using Data Driven Inserts in Email Destination in SQL-RD
  • Simply drag and drop fields from your table to the desired position.
For example, to customize an email greeting, type the greeting, and add the recipients name as shown above.

Click Next to continue to the next wizard section.

Reports Wizard

SSRS. Reports Wizard in Data Driven Package in SQL-RD.

A package may be created with no constituent reports and then the reports can be added later. However, you may also add reports at this stage in the wizard - and amend, delete or add some more later.

  • Merge all PDF Files: Merge PDF outputs into a single PDF file. The reports will appear in the merged PDF in the order they are displayed in the package schedule. Checking this box will bring up additional PDF Options.
SSRS. Reports Wizard in Data Driven Package in SQL-RD.
  • Merge all Excel Files: SQL-RD will then merge all excel outputs in the package into a single excel file.
SSRS. Reports Wizard in Data Driven Package in SQL-RD.
HINT: Add Password Protection to this section in this option window rather than the individual report in the package. This will password protect the entire merged workbook.
  • Click Add.
  • Package Report Properties will appear on.

Package Report Properties

Report Wizard

SSRS. Package Report Properties Wizard in SQL-RD.
  • Use SSRS Account: Select the SSRS Account where your report server is located, or create one by clicking on (...) button next in Report Location.
Hint: SQL Azure Reporting Services- when writing your report, make sure you have enabled Forms Authentication. You should use the 2010 .asmx address for your reporting service URL.
SSRS. Report Server Browser in SQL-RD.
  • Select the SSRS Account or create one by writing the name into the combo box.
  • SSRS Server URL: Enter the address of your reporting services server and click Connect.
  • Select the report and click OK.
SSRS. Creating New SSRS Account in SQL-RD.
  • Click OK.

SSRS Account is now added in SQL-RD.

  • Report Service URL: Enter the address of your reporting services server.
  • Report Location: Browse through the report server browser to select the desired report. Authenticate to the reports server if necessary.
Hint: SQL Azure Reporting Services- when writing your report, make sure you have enabled Forms Authentication. You should use the 2010 .asmx address for your reporting service URL.
SSRS. Report Server Browser in SQL-RD.
  • Report Name: Write in the name of the package.
  • Format: Select the output format for the report.

Datasources Wizard

SSRS. Package Report Properties Wizard in SQL-RD.
  • In this section you will authenticate to the database the report runs against, set snapshots, and other options.
  • Login Required: Set the authentication information for the report.
SSRS. Package Report Properties Wizard in SQL-RD.
  • Preview: View the report prior to execution.

Parameters Wizard

SSRS. Package Report Properties Wizard in SQL-RD.
  • In this section, you will determine the parameters for your report (if any). If your report has no parameters, you may skip this section by clicking next.
  • There are 3 requirements in order for SQL-RD to detect your SSRS Report parameters and their parameter values:
    • The parameter must be in use in the report.
    • The parameter must be visible.
    • The parameter must be set to be prompted at run time.
  • If these three requirements are achieved, you should see the parameters in your report listed in this screen.
  • For each parameter, select from the drop down list the value the report must use. You can type a value into the field as well.
  • SQL-RD can handle SSRS Reports with Cascading parameters, or reports where you can select multiple parameter values.
  • Select All: Selecting All Available Values will run the report given all the values.
  • Specified Value: Select the value you want in your report.
  • Null Value: Set no value for this parameter.
  • Default Value: It will select the default value.
  • All Values (at run time): Any new values will automatically will be included at run time.

Naming (Optional) Wizard

SSRS. Package Report Properties Wizard in SQL-RD.
  • Default Naming Convention: SQL-RD will name the output file in the following format: reportname.format extension, e.g. Catalog Report.pdf.
  • Customize the output file name: Choose your own filename or right-click and use the Insert Function to insert a value.
  • Customize output extension: Choose your own extension. This is useful for system integration. For example, the default extension for a character separated file is "CSV," but you can give your export an extension of "txt" so that the file can be read by another already existing system you may have. You may also right-click and use the Insert Function to insert a value.
  • Append date/time: This is useful for the following reasons:
    • If the filename is the same each time, and it is being exported to the same folder each time, then it will be overwritten by the latest one each time. By appending date and time to the filename, each file remains unique, and no files are overwritten.
    • You can track which reports ran and when they ran by looking at what the report is named.

Exception Handling Wizard

SSRS. Package Report Properties Wizard in SQL-RD.
  • Check if the Report is Blank: If a report is blank because it genuinely returned no data, recipients can misconstrue this as an error with the scheduler. This option allows you to identify genuine empty reports and instruct SQL-RD on what to do with them.
  • Ignore the report and subsequent tasks: if the report is blank, do not send the report. The report will not be delivered to the destination. No custom tasks will be run.

Method

SSRS. Package Report Properties Wizard in SQL-RD.
  • Select the Method that will determine whether a report is blank.
  • SQL Query: Select this option to use a user made query that will determine if the report is blank. If the query returns no results, the report is blank.
  • Click Build.
  • Get values from a database window will appear. For more information about Get values from database, click here.
SSRS. Get values from database interface in SQL-RD.
  • File size check: Assume reports is blank if size is under "X" bytes.
SSRS. Package Report Properties Wizard in SQL-RD.

Actions

SSRS. Package Report Properties Wizard in SQL-RD.
  • Select an action from the task list. This task will be executed in the event that a schedule is blank.
  • For more information about tasks, click here.
Tip: You can send a notification if a report is considered blank instead of sending the report. Simply select “check if a report is blank” then select “Ignore the report.” In the actions tab, select “Send Email” from the list. Compose your email and save.
  • Click OK.

Exception Handling Wizard

SSRS. Exception Handling Wizard in Data Driven Package in SQL-RD.
  • Treat as “error” if not completed in X minutes: If a report takes longer than the specified amount of time to run, this option will treat the schedule as an error and follow the appropriate action. The “Auto-calculate” option instructs SQL-RD automatically determine how long a schedule should take to run the report. If it takes longer than the calculated amount of time, then it is an error.
If manually determining the error timing, please double check the run time of the report in order to get the correct time estimate.
  • On error, retry executing schedule every: If set to 0, SQL-RD will deem the schedule as "Failed" the first time it encounters an error. The schedule will not run again until its next scheduled time. Change the value to tell SQL-RD how many times you want it to retry running the report before declaring it as "Failed."
  • Check if the Report is Blank: If a report is blank because it genuinely returned no data, recipients can misconstrue this as an error with the scheduler. This option allows you to identify genuine empty reports and instruct SQL-RD on what to do with them.
  • Ignore the report and subsequent tasks: if the report is blank, do not send the report. The report will not be delivered to the destination. No custom tasks will be run.

Method

SSRS. Exception Handling Wizard in Data Driven Package in SQL-RD.
  • Select the Method that will determine whether a report is blank.
  • SQL Query: Select this option to use a user made query that will determine if the report is blank. If the query returns no results, the report is blank.
  • Click Build.
  • Get values from a database window will appear. For more information about Get values from database, click here.
SSRS. Get Values from database interface in SQL-RD.
  • File size check: Assume reports is blank if size is under "X" bytes.
SSRS. Exception Handling Wizard in Data Driven Package in SQL-RD.

Actions

SSRS. Exception Handling Wizard in Data Driven Package in SQL-RD.
  • Select an action from the task list. This task will be executed in the event that a schedule is blank.
  • For more information about tasks, click here.
Tip: You can send a notification if a report is considered blank instead of sending the report. Simply select “check if a report is blank” then select “Ignore the report.” In the actions tab, select “Send Email” from the list. Compose your email and save.

Custom Task Wizard

SSRS. Exception Handling Wizard in Data Driven Package in SQL-RD.
  • In the section you have the option of setting up custom tasks. Custom tasks are business process automation tools that can be auto triggered before or after a report runs.
  • For more information on Custom Tasks, click here.
  • If you have no desire to add a Custom Task, you can click finish to complete the schedule.

Data-Driven Package Report Schedule Context Menu

SSRS. Data Driven Package Report Schedule Context Menu in SQL-RD.

Right-Click on a schedule to see the following actions:

  • Properties: Edit the schedule from here. Or you can just double click on the schedule.
  • Open: This will open the package and show its constituent reports.
SSRS. Data Driven Package Report Schedule Context Menu in SQL-RD.
  • You can right-click on each of the constituent reports to see the context-sensitive menu shown in the picture above.
    • Enabled: Use this to enable or disable the constituent report.
    • Refresh: Pulls through changes to just that report which were made outside SQL-RD.
    • Rename: Renames the selected report.
    • Preview: Generates a preview of the selected report.
    • Delete: Deletes the selected report from package.
    • Properties: Displays the configuration properties of just that report.
  • Add Report: Use this to add one or more reports to an existing package.
  • Copy: Use this to copy the schedule. Right-click in the "white space" of the folder you wish to copy it to and select Paste button.
  • Rename: Rename the package.
  • Enabled: Schedules are enabled when there is a check icon beside this option. To stop a schedule from running, or to "pause" it for a while, select this option to remove the check icon. Disabled schedules will not run until they are enabled again.
  • Move: Use this option to move the report into an existing package.
  • Execute: This button will execute the schedule immediately. Note that the next run date and time is not moved on as a result of a manual execution. They only move on if the schedule is run automatically by one of the schedulers .
  • Delete: Selecting this option will delete the schedule.
  • Test Package: Use this option to test the schedule and export it to selected "test" destinations.
  • Split into Single Schedules: This will split all the constituent reports in the package into Single Report Schedules.
This process will automatically delete the package once the splitting process is completed.
  • Ad-Hoc Email to Recipients: Select this option to send an ad-hoc email to all recipients of this package. You can use this to alert recipients to a planned system outage, or any other useful information.
  • Create Shortcut: Use this option to create a shortcut you can save in any location on your PC. Execute the shortcut to execute the schedule in SQL-RD.

Data-Driven Package Properties

SSRS. Data Driven Package Report Schedule Context Menu in SQL-RD.
  • To access your schedule properties, right click on a schedule and select properties.
  • Similar to the schedule wizard, you adjust settings to your schedule such as timing, error handling, or custom tasks.
  • General
SSRS. Data Driven Packages Properties Wizard in SQL-RD.
  • Schedule
SSRS. Data Driven Packages Properties Wizard in SQL-RD.
  • Reports
SSRS. Data Driven Packages Properties Wizard in SQL-RD.
  • Destinations
SSRS. Data Driven Packages Properties Wizard in SQL-RD.
  • Exception Handling
SSRS. Data Driven Packages Properties Wizard in SQL-RD.
  • History: Review the schedules history. Successes, failures, and other data is located here.
SSRS. Data Driven Packages Properties Wizard in SQL-RD.
  • Tasks
SSRS. Data Driven Packages Properties Wizard in SQL-RD.
  • Data-Driver
SSRS. Data Driven Packages Properties Wizard in SQL-RD.