Welcome to rsNeatPublish.com
Examples and Further Information...
Screen-shots and examples
with detailed step by step instructions, usage, scenarios and user guide

 

Examples and Further Information

 

The technical reference can be found here.  It is intended to complement the video on the Quick Start page and the instructions that follow.

 

Below contain screenshots of the rsNeatPublish.XmlGenerator application with the corresponding sample XML files open. The sample files (found at C:\Program Files\rsNeatPublish\rsNeatPublish\SampleXml) can be copied over or cut/pasted into the rsNeatPublish.xml. As mentioned these vary in complexity from simple through to a more comprehensive scenario.  Each sample outlines the scenario and also exposes a link to the actual sample XML configuration file that provides rsNeatPublish with the information it needs to publish the report objects up to the server.

Sample 1

The first sample below is a very basic scenario where reports are simply linked to a single shared data source.  In this example, all reports in the project's root folder are published to a folder named "Reports" on the server and the shared data source is configured to access a SQL Server database via a service account and is created in a folder called "Data Sources".  Note:-

View rsNeatPublish_Sample1.xml
Sample1 rsNeatPublish.XmlGenerator Globals tab

Globals tab - the WebServiceUrl is the only mandatory field. The above indicates all source folders specified in other tabs will be relative to C:\MyProjects\MySsrsProject (note that as mentioned if this was left blank the source folder would be the same location as where the executeable resides), and all target folders will be relative to MyServerName/MyApplicationName/UAT


Sample1 rsNeatPublish.XmlGenerator Data Sources tab

Data Sources tab - the target folder will be MyServerName/MyApplicationName/UAT/Data Sources


Sample1 rsNeatPublish.XmlGenerator Reports tab

Reports tab - the source folder is C:\MyProjects\MySsrsProject (as there is none specified it is simply the SourcePath on the Globals tab) and target folder is MyServerName/MyApplicationName/UAT/Reports

Sample 2

Extending the first sample, the second sample has three data sources, the first uses a service account, and the second uses the Windows Authenticated user (Connection Type of "Integrated") to access an OLAP database (Extension of "OLEDB-MD") and is setup to overwrite the data source on the server if it doesn't already exists (Overwrite data source of "Overwrite if not exist").  The third, (Overwrite data source of "Never overwrite - exists on server") indicates the data source already exists on the server in the Data Sources folder (this will be linked up with the appropriate reports at deployment time).  Note that in this example, all shared data sources are stored in the same target folder ("Data Sources"), however they don't have to be.  Note just as in the first example any references to shared data source from the report will be linked via detection of the source reference name within the report definition (file)

View rsNeatPublish_Sample2.xml
Sample2 rsNeatPublish.XmlGenerator Data Sources tab

Data Sources tab - for all data sources, the target folder will be MyServerName/MyApplicationName/UAT/Data Sources

Sample 3

Extending the prior samples, the third sample has several source locations and target folder locations for both the reports and data sets.  Note that the tool will as always automatically link reports, data sets and data sources via the reference within the SSRS object definition

View rsNeatPublish_Sample3.xml
Sample3 rsNeatPublish.XmlGenerator Data Sets tab

Data Sets tab - the first record has a source folder of C:\MyProjects\MySsrsProject\MySourceDataSetsFolderName1 and target folder is MyServerName/MyApplicationName/UAT/MyTargetDataSetsFolderName1. The second record has a source folder of C:\MyProjects\MySsrsProject\MySourceDataSetsFolderName2 and target folder is MyServerName/MyApplicationName/UAT/MyTargetDataSetsFolderName2


Sample3 rsNeatPublish.XmlGenerator Reports tab

Reports tab - the first record has a source folder of C:\MyProjects\MySsrsProject\MySourceReportsFolderName1 and target folder is MyServerName/MyApplicationName/UAT/MyTargetReportsFolderName1. The second record has a source folder of C:\MyProjects\MySsrsProject\MySourceReportsFolderName2 and target folder is MyServerName/MyApplicationName/UAT/MyTargetReportsFolderName2

Sample 4

Extending the prior samples, the forth sample supports the uploading of a single report or from a wildcard, accommodates nested folders (note that if the target folder structure doesn't exist they will be created), and optionally encrypts passwords entered within the data sources tab

View rsNeatPublish_Sample4.xml
Sample4 rsNeatPublish.XmlGenerator Globals tab

Globals tab - note the Encrypt Passwords fields is set to true. This indicates that the password will be stored within the generated XML file as encrypted. When rsNeatPublish runs against this file it will automatically decrypt the password and configure the data source accordingly


Sample4 rsNeatPublish.XmlGenerator Reports tab

Reports tab - the first record has a source file wildcard of C:\MyProjects\MySsrsProject\MySourceReportsFolderName1\MyReports*.rdl and target folder is MyServerName/MyApplicationName/UAT/MyTargetReportsFolderName. The second record has a source file of C:\MyProjects\MySsrsProject\MySourceReportsFolderName1\ReportX.rdl and target folder is MyServerName/MyApplicationName/UAT/MyFolder/MySubFolder/MyTargetReportsFolderNameX

Sample 5

Extending the prior samples, the fifth sample supports the uploading of the other SSRS object types such as models, images, resources, report parts, linked reports, and subscriptions (normal and data driven).  Notes:-

  • Both normal and data driven subscriptions are supported (note the DataDrivenParameters [image] dialog below appears when the subscription row's DataDrivenParameters Edit button is clicked)
  • For subscriptions, dialogs for SubscriptionParameters and ReportParameters are available by clicking the subscription row's Edit button
  • For models, the data source view is required by the SSRS engine - it is automatically merged in at the time of the model publishing (runtime of rsNeatPublish)
  • Most tabs also allow a Property to be associated to the object(s) - eg. a Description could be assigned to a Report
View rsNeatPublish_Sample5.xml
Sample5 rsNeatPublish.XmlGenerator Reports tab

Reports tab - in this example shown for the purposes of ikkustrating the Embedded Data Sources button.


Sample5 rsNeatPublish.XmlGenerator Reports tab, Embedded Data Sources dialog

Embedded Data Sources dialog - the first and only record (with data source name 'MyEmbeddedDataSource') shows an embedded data source that can either be manually entered or determined/generated via the 'Fetch Embedded Data Sources' button.


Sample5 rsNeatPublish.XmlGenerator Linked Reports tab

Linked Reports tab - the first record has a parent report folder of MyServerName/MyApplicationName/UAT/MyReportsFolderName1 which contains report Report1A and creates a linked report from this named Report1A_LinkedReport in MyServerName/MyApplicationName/UAT/MyTargetLinkedReportsFolderName. The second record (similarly) has a parent report folder of MyServerName/MyApplicationName/UAT/MyReportsFolderName1 which contains report Report1B and creates a linked report from this named Report1B_LinkedReport in MyServerName/MyApplicationName/UAT/MyTargetLinkedReportsFolderName.


Sample5 rsNeatPublish.XmlGenerator Models tab

Models tab - the source folder is C:\MyProjects\MySsrsProject (as there is none specified it is simply the SourcePath on the Globals tab) and target folder is MyServerName/MyApplicationName/UAT/Models>. Note the DataSourceViewName column value, MyDataSourceDsv - it will merge the models to be published with this data source view file at publishing time to produce the model file required


Sample5 rsNeatPublish.XmlGenerator Images tab

Images tab - the source folder is C:\MyProjects\MySsrsProject\Images and the target folder is MyServerName/MyApplicationName/UAT/Images. Note only known image types (.jpg, .jpeg, .gif, .bmp, .png) can be published in this way. For other image types publish via the Resource tab (see below).


Sample5 rsNeatPublish.XmlGenerator Resources tab

Resources tab - the source folder is C:\MyProjects\MySsrsProject (as there is none specified it is simply the SourcePath on the Globals tab) and target folder is MyServerName/MyApplicationName/UAT/Resources.


Sample5 rsNeatPublish.XmlGenerator Report Parts tab

Report Parts tab - the source folder is C:\MyProjects\MySsrsProject (as there is none specified it is simply the SourcePath on the Globals tab) and target folder is MyServerName/MyApplicationName/UAT/Report Parts.


Sample5 rsNeatPublish.XmlGenerator Subscriptions tab

Subscriptions tab - the first record has a source report folder is C:\MyProjects\MySsrsProject\MyTargetReportsFolderNameX which contains report ReportX which has a standard (non data driven) subscription setup against it. Note that just like all standard and data driven subscriptions, there are Description and MatchData (schedule) fields as well as, if you scroll right, there is further details that can be supplied such as Subscription Parameters and Report Parameters. The second record (similarly) has a source report folder is C:\MyProjects\MySsrsProject\MyTargetReportsFolderNameY which contains report ReportY however if you click the Edit button under the DataDrivenParameters column a dialog appears showing data source details for data driven subscriptions


Sample5 rsNeatPublish.XmlGenerator Subscriptions tab, Match Data dialog

Subscriptions tab, Match Data dialog shows schedule details that caters for all recurrence types (hourly, daily, weekly, monthly, etc) as per SSRS upload subscription wizard


Sample5 rsNeatPublish.XmlGenerator Subscriptions tab, Data Driven Parameters dialog

Subscriptions tab, Data Driven Parameters dialog shows data source details for data driven subscriptions


Sample5 rsNeatPublish.XmlGenerator Subscriptions tab, Subscription Parameters dialog

Subscriptions tab, Subscription Parameters dialog shows report delivery options (note that one parameter is shown that is data driven and hence shows a column reference for one of the values)


Sample5 rsNeatPublish.XmlGenerator Subscriptions tab, Report Parameters dialog

Subscriptions tab, Report Parameters dialog shows report parameter names with associated values (note that one parameter is that shown is data driven and hence shows a column reference for one of the values)

Sample 6

The last sample below shows a typical SharePoint Integrated mode setup.  Note:-

  • the Globals tab captures values for fields as outlined in sample 1 however this sample has one important difference - it shows the settings for a SharePoint deployment
  • a SharePoint deployment is indicated by the SharePoint deploy checkbox being ticked
  • by choosing to deploy to SharePoint it requires the SSRS instance to be run in SharePoint Integrated mode
  • when SSRS is in SharePoint Integrated mode, the URL for the ReportService2010.asmx web service (field Web Service URL) is formatted differently (including the "_vti_bin" folder in the path)
  • the website URL is the URL where the SharePoint document libraries are (will be) located
  • note the Target Root Folder and Target Sub Folder Fields are not editable for a SharePoint deployment
  • the target folders specified in the data sources, data sets, reports, etc tabs will be created as document libraries with the SSRS content types automatically registered
  • if the target folders are nested (eg. MyDataSourcesDocumentLibrary/MyDataSourcesFolder/MyDataSourcesSubFolder) the first level will be created as a document library as per stated above and subsequent levels will be created as SharePoint folders
View rsNeatPublish_Sample6.xml
Sample6 rsNeatPublish.XmlGenerator Globals tab

Globals tab

  • note the format of the Web Service URL
  • also note the SharePoint deploy checkbox is ticked
  • the above indicates all source folders specified in the other tabs will reside under the C:\MyProjects\MySsrsProject
  • the above indicates all target folders specified in the other tabs will reside under the site http://MyUatServerName/sites/MyReports

Sample6 rsNeatPublish.XmlGenerator Data Sources tab

Data Sources tab - the target for both data source records will be a Document Library at http://MyUatServerName/sites/MyReports/MyTargetDataSourcesDocumentLibraryName.


Sample6 rsNeatPublish.XmlGenerator DataSets tab

Data Sets tab

  • the above record points to a source folder of C:\MyProjects\MySsrsProject\MySourceDataSetsFolderName (all data sets in this folder - if you would like to take data sets from the SSRS project's root path simply enter '*' [no quotes] in this source field).
  • the above record points to a target which will be a Document Library at http://MyUatServerName/sites/MyReports/MyTargetDataSetsDocumentLibraryName.

Sample6 rsNeatPublish.XmlGenerator Reports tab

Reports tab

  • the first record points to a source folder of C:\MyProjects\MySsrsProject\MySourceReportsFolderName1 (all reports in this folder - if you would like to take reports from the SSRS project's root path simply enter '*' [no quotes] in this source field).
  • the first record points to a target which will be a Document Library at http://MyUatServerName/sites/MyReports/MyTargetReportsDocumentLibraryName1.
  • the second record points to a source file of C:\MyProjects\MySsrsProject\ReportX.rdl.
  • the second record points to a target which will be a Document Library at http://MyUatServerName/sites/MyReports/MyTargetReportsDocumentLibraryNameX.