Welcome to rsNeatPublish.com
Quick Start...
Install rsNeatPublish & rsNeatPublish.XmlGenerator, open rsNeaPublish.XmlGenerator
Then import and/or enter configuration, and simply Publish!

 

Welcome to the rsNeatPublish Quick Start

 

The technical reference can be found here.  It is intended to complement the video below and the instructions that follow.

 

Below is a short "getting started" demonstration video. It shows how to access to the Visual Studio SSRS project file (.rptproj) relevant to the objects to be published on the server and will be used to import configuration and source/target locations into rsNeatPublish.XmlGenerator ready for deployment (if you don't have access to the SSRS project file you can follow the steps in this video which shows how to manually enter the required information).

 

  (If you have trouble viewing the video, download/view via this link)

 

If you haven't already, download the rsNeatPublish and rsNeatPublish.XmlGenerator fully functional trial installers (.msi files). The two files are as follows

  • rsNeatPublish.msi : this contains the automated SSRS object publisher/deployer (rsNeatPublish).
  • rsNeatPublish.XmlGenerator.msi : this contains a user interface (UI) that allows the user to enter SSRS object source and target information, generate an (XML) input file for the automated SSRS object publisher/deployer (rsNeatPublish). Note that along with the executable there will be Start menu item and desktop shortcut deployed.

 

rsNeatPublish is executed from the command line with an rsNeatPublish XML file (which is generated via rsNeatPublish.XmlGenerator).  The rsNeatPublish XML file specifies the configuration for all of the artefacts to be published (execution settings, source and target locations, etc)

 

 To setup how and what is published, follow the steps below:-

  • open rsNeatPublish.XmlGenerator (can be done via the desktop shortcut)
  • choose the File | Import menu item, and select the desired SSRS project file (.rptproj) that contains the SSRS objects (i.e. reports, data sets, data sources and report part information) you would like to publish/deploy to the server, and then choose the desired configuration from the drop-down (this list is read from the SSRS project file selected - each has associated config [target server name, as well as report, data set, data source target folder names, etc] - they are set to defaults which are changeable within BIDS - see here for more information - pick 'Debug' if you're not sure). Note that this approach (i.e. via the import workflow) will get you started quicker, as you will then (after the import) have the source and target file-names/configuration available for edit within rsNeatPublish.XmlGenerator - you can then modify accordingly and add any subscription(s), linked report(s), etc, and if your target is SharePoint, configuration for SharePoint (the alternative, which the Demo video above shows is to enter all of the source and target information from scratch.
  • make sure the Web Service URL is as expected - if you've imported, this is taken from the SSRS project file config - it is mandatory and points to the target SSRS webservice
    • for a normal (vanilla) deployment (i.e. if you are not publishing to SharePoint) this will look something like:-
      • (for default instance) http://MyServerName/ReportServer/ReportService2010.asmx
        • where MyServerName is the target server name
      • (for named instance) http://MyServerName/ReportServer_MyInstanceName/ReportService2010.asmx
        • where MyServerName is the target server name, and MyInstanceName is the SQL Server instance name
    • for a SharePoint deployment this will look something like:-
      • (for default instance) http://MyServerName/MySiteCollection/MyWebsite/_vti_bin/ReportServer/ReportService2010.asmx
        • where MyServerName is the target SharePoint server name, MySiteCollection is the SharePoint site collection name, and MyWebsite is the website name
      • (for named instance) http://MyServerName/MySiteCollection/MyWebsite/_vti_bin/ReportServer_MyInstanceName/ReportService2010.asmx
        • where MyServerName is the target SharePoint server name, MySiteCollection is the SharePoint site collection name, MyWebsite is the website name, and MyInstanceName is the SQL Server instance name
    Note that it is recommended to test the location of the entered web service URL via the adjacent 'Test' button - this will open a browser and should (if correct) display an XML representation of the SSRS Report service (note that sometimes the screen takes a short while to appear as the SSRS service is being brought back into memory)
  • make sure the source base folder location (Source Path) is as expected - if you've imported, this will default to where your SSRS project file is located (i.e. base source folder location). It will look something like:-
    • C:\Projects\MySsrsProject
    Note that all source field locations for will be relative to this directory
  • choose whether you would like to deploy to SharePoint. If so tick the SharePoint deploy checkbox then enter the SharePoint website URL. This will look something like:-
    • http://MyServerName/MySiteCollection/MyWebsite
      • where MyServerName is the target SharePoint server name, MySiteCollection is the SharePoint site collection name, and MyWebsite is the website name
    Note that to deploy to a SharePoint the corresponding SSRS instance must be in SharePoint Integrated mode. For instructions on how to deploy SSRS so that it is in SharePoint Integrated mode see here for step by step instructions
  • if you chose not to deploy to SharePoint (i.e. the SharePoint deploy checkbox is unchecked) then you will be able to modify the target base folder locations (TargetRootFolder and TargetSubFolder) folder locations - both are optional - it will generally be the application name and environment and will look something like:-
    • TargetRootFolder:   MyApplicationName    (will be entered if there are multiple applications on the target SSRS instance)
    • TargetSubFolder:   MyTargetEnvironment    (eg. Prod or Staging - will be entered if there are multiple environments on the target SSRS instance)
    Note that all target field locations will be relative to the concatination of these fields
  • when this is done it is simply a matter of making sure the rest of the imported configuration is as expected - also add any subscriptions, linked reports, etc if required. Note that for Data Sources it is highly recommended to 'Test' each connection (via the 'Test' button on the far right of the grid on the Data Sources tab) before saving/submitting. Also note that credentials for data sources that store usernames and passwords within the project will need to be re-entered (check the User name and Password fields in the Data Source tab). As well, you may enter or fetch embedded data sources that are associated to a given report (the Embedded Data Source dialog is accessible via the Reports tab) - this is useful if you wish to modify the data source information against a report that is deployed to multiple environments. As a guide for general entry of all source/target information, please view the Demo video at the top of the page. As well, there are examples on the Examples and Further Information page
  • it is assumed at this stage all required services are started on the target SSRS instance. Services include (the name of the services depend on the target SSRS instance name):-
    • SQL Server
    • SQL Server Reporting Services
    • SQL Server Agent (if deploying subscriptions)
  • then when all is entered, to test the deployment, save and publish as per the configuration (Publish! | Save and Publish to Server).  This will do the following:-
    • save the current configuration file
    • creates a batch file that can be used to submit the configuration to the server (note that the statement generated within the batch file assumes a default installation of rsNeatPublish [i.e. with a location of  "C:\Program Files\rsNeatPublish\rsNeatPublish\rsNeatPublish.exe"] - if this file is not found the batch file will still be generated but will have the statement commented out [REM'd])
    • submits the batch file
    • Note that if the saving of any of the files (Xml configuration file or batch file) or publish to the server fails as a result of permissions, it may be that you need to run rsNeatPublish.XmlGenerator as an Administrator (simply Shift-right-click the rsNeatPublish desktop icon | Run as administrator)
    • Note also that if you receive an error regarding the webservice requires a secure connection, modify the Web Service URL on the Globals tab to use https (as opposed to http) then retry
  • to validate, the target server location where the structure and SSRS objects now reside can be viewed
    • for a normal (vanilla) deployment (i.e. if you are not publishing to SharePoint) this will look something like:-
      • (for default instance) http://MyServerName/Reports
        • where MyServerName is the target server name
      • (for named instance) http://MyServerName/Reports_MyInstanceName
        • where MyServerName is the target server name, and MyInstanceName is the SQL Server instance name
    • for a SharePoint deployment this will look something like:-
      • http://MyServerName/MySiteCollection/MyWebsite/Pages/Default.aspx
        • where MyServerName is the target SharePoint server name, MySiteCollection is the SharePoint site collection name, and MyWebsite is the website name